Google Cloud Functions Setup Guide

Follow our setup guide to connect Google Cloud Functions to Fivetran.

Prerequisiteslink

To connect Google Cloud Functions to Fivetran, you need a Cloud Function implementation.

Setup instructionslink

Develop function codelink

1. Using an IDE or any other tool, develop the code that you want to run in the Google Cloud Functions.

2. In the response header, add Content-Type with the value application/json.

For more information about Google Cloud Function implementation, see our Sample Google Cloud Function.

Create cloud functionlink

1. Open the Google Cloud Functions console and click the projects drop-down list.

   

2. Select the project in which you want to create the function.

3. Click Create Function.

   

4. In the Name field, enter the function name.

5. Select the memory allocation size for the function in the Memory allocated drop-down menu.

6. Select HTTP in the Trigger drop-down menu.

7. Uncheck the Allow unauthenticated invocations checkbox (if selected).

   

8. Select the Source code type.

   We have used the Inline editor option to illustrate.

9. Select your runtime environment in the Runtime drop-down menu.

10. Enter the code to execute in the cloud function (Copy the code and package.json content in the inline editor provided by Google Cloud Functions).

11. Enter the function name to execute when the cloud function is invoked. This is the entry point for your function code execution.

    

12. Configure the following Advanced options:

    • Select the region in the Region drop-down menu
    • Enter the Timeout time frame
    • Enter the maximum number of function instances
    • In Networking > Ingress settings, select Allow all traffic

    

13. Click Create to create the function.

Test cloud functionlink

1. Open the cloud function you created in Step 2.

   

2. Click Testing. Add one example request and click Test the function.

   

You can view the execution result in the Output field.

Get trigger namelink

1. Open the cloud function.

   

2. Click Trigger.

   

3. Make a note of the URL. You will need it to configure Google Cloud Functions to connect with Fivetran.

Begin Fivetran Configurationlink

1. In your connector setup form, enter the Destination schema name of your choice.

2. Enter the Function Trigger you found in Step 4.

3. (Optional) Enter your Secrets. Use the following JSON format to enter your secrets:

   {
   "consumerKey": "",
   "consumerSecret": "",
   "apiKey": "yourApiKey"
   }
   

   For more information on secrets, see our Function request and response documentation.

4. Make a note of the service account email address. You will need it to grant invoker permissions to your function.

Grant function invoker permissionlink

1. In Google Cloud Functions, select the cloud function and click Show Info Panel.

   

2. In the Info Panel, click Add Member.

   

3. Add the service account email ID displayed in the connector setup form.

4. Select Cloud Functions Invoker in the Role drop-down menu.

   

5. Click Save to save the permissions.

Finish Fivetran Configurationlink

In your connector setup form, click Save & Test.

Fivetran tests and validates the Google Clould Functions connection. On successful completion of the setup tests, you can sync the data returned by the Google Cloud function to your destination.

Setup testslink

Fivetran performs the following Google Cloud Functions connection tests:

• The Validate Secrets test checks if you have entered the secrets in a valid JSON format.
• The Function Connection test checks if we can connect to your Google Cloud Function and if the function’s response format is correct.

IMPORTANT: The setup tests may timeout if your function’s response size is more than 500 megabytes (MB). In the setup tests request, Fivetran passes the setup_test node as true; and your function must return a lightweight JSON object that doesn’t exceed 500 MB in size. The 500 MB size limitation is only applicable to the setup tests and not for your syncs.

Related Contentlink

description Connector Overview

assignment Release Notes

settings API Connector Configuration

home Documentation Home