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", "destination_configuration": { "virtual_warehouse": "virtual_warehouse" }, "destination_schema_names": "SOURCE_NAMING", "config": { "reports": [ { "query_id": "123456789", "config_method": "CREATE_NEW", "partners": [ "string" ], "update_config_on_each_sync": true, "advertisers": [ "string" ], "metrics": "METRIC_CLICKS", "report_type": "REACH | FLOODLIGHT | FULL_PATH | INVENTORY_AVAILABILITY | REPORT_TYPE_UNSPECIFIED | GRP | PATH_ATTRIBUTION | UNIQUE_REACH_AUDIENCE | YOUTUBE_PROGRAMMATIC_GUARANTEED | YOUTUBE | STANDARD | AUDIENCE_COMPOSITION", "table_name": "table_2", "dimensions": "FILTER_ADVERTISER" } ], "timeframe_months": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "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 |
|---|---|
reports | The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. |
reports[0].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. |
reports[0].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. |
reports[0].partners | The list of partners to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW. |
reports[0].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. |
reports[0].advertisers | The list of advertisers to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW. |
reports[0].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. |
reports[0].report_type | The type of the report to create. This is a required parameter when config_method is set to CREATE_NEW. |
reports[0].table_name | The table name within the schema to which connector will sync the data of the specific report. |
reports[0].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. |
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. |
schema (required) | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
table (required) | 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_accessandrefresh_tokenparameters in theauthsection.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_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.client_accessclient_access.client_secretClient Secretof your Google Display & Video 360 client application.client_access.client_idClient IDof your Google Display & Video 360 client application. By using the Connect Card or the Fivetran dashboard.