Google Ads API Configuration

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "google_ads",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "config": {
    "sync_mode": "ManagerAccounts | AllAccounts | SpecificAccounts",
    "reports": [
      {
        "report_type": "campaign",
        "fields": [
          "string"
        ],
        "table": "table_2"
      }
    ],
    "skip_empty_reports": true,
    "manager_accounts": [
      "string"
    ],
    "timeframe_months": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE",
    "accounts": [
      "string"
    ],
    "customer_id": "xxx-xxx-xxxx",
    "conversion_window_size": 30,
    "schema": "schema_name"
  },
  "auth": {
    "refresh_token": "my_refresh_token",
    "client_access": {
      "developer_token": "string",
      "client_secret": "my_client_secret",
      "client_id": "my_client_id",
      "user_agent": "my_company_name"
    }
  }
}

Config parameters

Name	Description
`sync_mode`	Whether to sync all accounts or specific accounts.
`reports`	The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
`reports[0].report_type`	The name of the Google Ads report from which the connector will sync the data. Possible report_type values.
`reports[0].fields`	A list of the fields to sync. Must be populated if `config_type` is set to `Custom`.
`reports[0].table`	The table name within the schema to which connector will sync the data of the specific report.
`skip_empty_reports`	Toggles the "Skip empty reports" feature. Enabled by default
`manager_accounts`	The list of the Manager Account IDs whose clients will be synced. Must be populated if `sync_mode` is set to `ManagerAccounts`.
`timeframe_months`	The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled custom and prebuilt reports during the next connector sync. Default value: `TWELVE`.
`accounts`	The list of Account IDs to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
`customer_id`	ID of the customer, can be retrieved from your AdWords dashboard.
`conversion_window_size`	A period of time in days during which a conversion is recorded.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the client_access and refresh_token parameters in the auth section.

POST https://api.fivetran.com/v1/connections

{
  "service": "google_ads",
  "group_id": "group_id",
  "auth": {
    "client_access": {
      "developer_token": "string",
      "client_secret": "my_client_secret",
      "client_id": "my_client_id",
      "user_agent": "my_company_name"
    },
    "refresh_token": "my_refresh_token"
  }
}

Auth Parameters

Name	Description
`refresh_token`	The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
`client_access`	We use a Fivetran developer token to access the Google Ads API. If this is your first Google Ads connector with custom authorization, you should create a new Google API Console project. Each Google API Console project can be associated with the developer token from only one manager account. Once you make a Google Ads API request, the developer token is permanently paired to the Google API Console project. Otherwise, we can't bind the Fivetran developer token to your client. You can reuse the same project to create other Google Ads connectors.
`client_access.developer_token`	Not required and ignored for new connectors. Used for backward compatibility for old connectors, see client_access section description.
`client_access.client_secret`	`Client Secret` of your Google Ads client application.
`client_access.client_id`	`Client ID` of your Google Ads client application.
`client_access.user_agent`	Your company's name in your Google Ads client application.

By using the Connect Card or the Fivetran dashboard.