Enable the APIs

Follow this step-by-step guide to enable the Cloud Functions API, the Cloud Build API, and the Secret Manager API.

Overview

To get started with Function Store, you need to start with the required setup tasks before installing and deploying the Marketplace functions. This section is for guiding you through the process of enabling the Cloud Functions API, the Cloud Build API, and the Secret Manager API. Also, you may need to enable the Firebase Authentication, in case you want to install functions like sendSignUpWelcomeEmail.

1. Create a Firebase project

  1. In the Firebase console, click Add project, then select or enter a Project name.

    If you have an existing Google Cloud project, you can select the project from the dropdown menu to add Firebase resources to that project.

  2. (Optional) If you are creating a new project, you can edit the Project ID.

    Firebase automatically assigns a unique ID to your Firebase project.

  3. Accept the Firebase terms.

  4. Click Continue.

  5. (Optional) Set up Google Analytics for your project and click Continue.

  6. Click Create project (or Add Firebase, if you're using an existing Google Cloud project).

  7. Click Continue when the system says that your new project is ready.

When the process completes, you'll be taken to the overview page for your Firebase project in the Firebase console.

Note that when you create a new Firebase project in the Firebase console, you're actually creating a Google Cloud project behind the scenes.

2. Enable the Cloud Functions API

  1. In the Google Cloud Console, on the project selector page, select the project you already created.

  2. Type "Cloud Functions API" in the search engine, and click on the section when appears in the Marketplace list. You'll be taken to the Cloud Functions API page.

  3. Click on Enable to enable the API.

When the process completes, you'll be taken to the overview page for the Cloud Functions API of your GCP project.

3. Enable the Cloud Build API

  1. In the Google Cloud Console, on the project selector page, select the project you already created.

  2. Type "Cloud Build API" in the search engine, and click on the section when appears in the Marketplace list. You'll be taken to the Cloud Build API page.

  3. Click on Enable to enable the API.

When the process completes, you'll be taken to the overview page for the Cloud Build API of your GCP project.

4. Enable the Secret Manager API

  1. In the Google Cloud Console, on the project selector page, select the project you already created.

  2. Type "Secret Manager API" in the search engine, and click on the section when appears in the Marketplace list. You'll be taken to the Secret Manager API page.

  3. Click on Enable to enable the API.

This API gives you the following permissions:

  • secretmanager.secrets.list

  • secretmanager.versions.get

  • secretmanager.versions.access.

These permissions are necessary to use Secrets. You can find more information about it here:

5. Enable the Firebase Authentication (Optional)

Firebase Authentication allows you to authenticate users in your app using several methods such as passwords, phone numbers, and popular federated providers like Google, Facebook, and more. Enabling this Firebase functionality will allow you to successfully install and use functions of our Marketplace that are related to user registration, for example, sendSignUpWelcomeEmail.

  1. In the Firebase Console, select the project you already created.

  2. Click Authentication in the vertical menu that appears on the left. Make sure that the project name you selected, appears in the selectable menu at the upper left corner.

  3. Click on the Get started button.

This action will instantly enable Firebase Authentication for your project.

Last updated