Google Display & Video 360 API Configuration
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "google_display_and_video_360",
"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",
"config": {
"query_id": "123456789",
"config_method": "REUSE_EXISTING | CREATE_NEW",
"partners": [
"string"
],
"update_config_on_each_sync": true,
"advertisers": [
"string"
],
"timeframe_months": "THREE | SIX | TWELVE | TWENTY_FOUR | ALL_TIME",
"metrics": "METRIC_CLICKS",
"report_type": "REPORT_TYPE_UNSPECIFIED | STANDARD | INVENTORY_AVAILABILITY | AUDIENCE_COMPOSITION | FLOODLIGHT | YOUTUBE | GRP | YOUTUBE_PROGRAMMATIC_GUARANTEED | REACH | UNIQUE_REACH_AUDIENCE | FULL_PATH | PATH_ATTRIBUTION",
"dimensions": "FILTER_ADVERTISER",
"schema": "schema_name",
"table": "table_name"
},
"auth": {
"refresh_token": "my_refresh_token",
"client_access": {
"client_secret": "my_client_secret",
"client_id": "my_client_id"
}
}
}
Config parameters
Name | Description |
---|---|
query_id | The ID of the query whose configuration you want to reuse. This is a required parameter when config_method is set to REUSE_EXISTING . |
config_method | The report configuration method. Specifies whether a new configuration is defined manually or an existing configuration is reused. The default value is CREATE_NEW . |
partners | The list of partners to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW . |
update_config_on_each_sync | Specifies whether the configuration is updated before each sync or only when the connector settings are saved. This parameter only takes effect when config_method is set to REUSE_EXISTING . The default value is true . |
advertisers | The list of advertisers to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW . |
timeframe_months | 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 reports during the next connector sync. NOTE: The more months of reporting data you sync, the longer your initial sync will take. |
metrics | The report metrics to include into a sync. The metric names are provided in the API format. This is a required parameter when config_method is set to CREATE_NEW . |
report_type | The type of the report to create. This is a required parameter when config_method is set to CREATE_NEW . |
dimensions | The report dimensions (filters) to include into a sync. The dimension names are provided in the API format. This is a required parameter when config_method is set to CREATE_NEW . |
schema | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
table | Destination table. Table 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
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connections
{ "service": "google_display_and_video_360", "group_id": "group_id", "auth": { "client_access": { "client_secret": "my_client_secret", "client_id": "my_client_id" }, "refresh_token": "my_refresh_token" } }
Auth Parameters
Name Description refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.client_access
client_access.client_secret
Client Secret
of your Google Display & Video 360 client application.client_access.client_id
Client ID
of your Google Display & Video 360 client application.By using the Connect Card or the Fivetran dashboard.