180 lines
7.4 KiB
JSON
180 lines
7.4 KiB
JSON
{
|
|
"documentationUrl": "https://docs.airbyte.com/integrations/sources/google-ads",
|
|
"connectionSpecification": {
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"title": "Google Ads Spec",
|
|
"type": "object",
|
|
"required": ["credentials", "start_date", "customer_id"],
|
|
"additionalProperties": true,
|
|
"properties": {
|
|
"credentials": {
|
|
"type": "object",
|
|
"description": "",
|
|
"title": "Google Credentials",
|
|
"order": 0,
|
|
"required": [
|
|
"developer_token",
|
|
"client_id",
|
|
"client_secret",
|
|
"refresh_token"
|
|
],
|
|
"properties": {
|
|
"developer_token": {
|
|
"type": "string",
|
|
"title": "Developer Token",
|
|
"order": 0,
|
|
"description": "Developer token granted by Google to use their APIs. More instruction on how to find this value in our <a href=\"https://docs.airbyte.com/integrations/sources/google-ads#setup-guide\">docs</a>",
|
|
"airbyte_secret": true
|
|
},
|
|
"client_id": {
|
|
"type": "string",
|
|
"title": "Client ID",
|
|
"order": 1,
|
|
"description": "The Client ID of your Google Ads developer application. More instruction on how to find this value in our <a href=\"https://docs.airbyte.com/integrations/sources/google-ads#setup-guide\">docs</a>"
|
|
},
|
|
"client_secret": {
|
|
"type": "string",
|
|
"title": "Client Secret",
|
|
"order": 2,
|
|
"description": "The Client Secret of your Google Ads developer application. More instruction on how to find this value in our <a href=\"https://docs.airbyte.com/integrations/sources/google-ads#setup-guide\">docs</a>",
|
|
"airbyte_secret": true
|
|
},
|
|
"refresh_token": {
|
|
"type": "string",
|
|
"title": "Refresh Token",
|
|
"order": 3,
|
|
"description": "The token for obtaining a new access token. More instruction on how to find this value in our <a href=\"https://docs.airbyte.com/integrations/sources/google-ads#setup-guide\">docs</a>",
|
|
"airbyte_secret": true
|
|
},
|
|
"access_token": {
|
|
"type": "string",
|
|
"title": "Access Token",
|
|
"order": 4,
|
|
"description": "Access Token for making authenticated requests. More instruction on how to find this value in our <a href=\"https://docs.airbyte.com/integrations/sources/google-ads#setup-guide\">docs</a>",
|
|
"airbyte_secret": true
|
|
}
|
|
}
|
|
},
|
|
"customer_id": {
|
|
"title": "Customer ID(s)",
|
|
"type": "string",
|
|
"description": "Comma separated list of (client) customer IDs. Each customer ID must be specified as a 10-digit number without dashes. More instruction on how to find this value in our <a href=\"https://docs.airbyte.com/integrations/sources/google-ads#setup-guide\">docs</a>. Metrics streams like AdGroupAdReport cannot be requested for a manager account.",
|
|
"pattern": "^[0-9]{10}(,[0-9]{10})*$",
|
|
"pattern_descriptor": "The customer ID must be 10 digits. Separate multiple customer IDs using commas.",
|
|
"examples": ["6783948572,5839201945"],
|
|
"order": 1
|
|
},
|
|
"start_date": {
|
|
"type": "string",
|
|
"title": "Start Date",
|
|
"description": "UTC date and time in the format 2017-01-25. Any data before this date will not be replicated.",
|
|
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
|
"pattern_descriptor": "YYYY-MM-DD",
|
|
"examples": ["2017-01-25"],
|
|
"order": 2,
|
|
"format": "date"
|
|
},
|
|
"end_date": {
|
|
"type": "string",
|
|
"title": "End Date",
|
|
"description": "UTC date and time in the format 2017-01-25. Any data after this date will not be replicated.",
|
|
"pattern": "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
|
"pattern_descriptor": "YYYY-MM-DD",
|
|
"examples": ["2017-01-30"],
|
|
"order": 6,
|
|
"format": "date"
|
|
},
|
|
"custom_queries": {
|
|
"type": "array",
|
|
"title": "Custom GAQL Queries",
|
|
"description": "",
|
|
"order": 3,
|
|
"items": {
|
|
"type": "object",
|
|
"required": ["query", "table_name"],
|
|
"properties": {
|
|
"query": {
|
|
"type": "string",
|
|
"multiline": true,
|
|
"title": "Custom Query",
|
|
"description": "A custom defined GAQL query for building the report. Should not contain segments.date expression because it is used by incremental streams. See Google's <a href=\"https://developers.google.com/google-ads/api/fields/v11/overview_query_builder\">query builder</a> for more information.",
|
|
"examples": [
|
|
"SELECT segments.ad_destination_type, campaign.advertising_channel_sub_type FROM campaign WHERE campaign.status = 'PAUSED'"
|
|
]
|
|
},
|
|
"table_name": {
|
|
"type": "string",
|
|
"title": "Destination Table Name",
|
|
"description": "The table name in your destination database for choosen query."
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"login_customer_id": {
|
|
"type": "string",
|
|
"title": "Login Customer ID for Managed Accounts",
|
|
"description": "If your access to the customer account is through a manager account, this field is required and must be set to the customer ID of the manager account (10-digit number without dashes). More information about this field you can see <a href=\"https://developers.google.com/google-ads/api/docs/concepts/call-structure#cid\">here</a>",
|
|
"pattern": "^([0-9]{10})?$",
|
|
"examples": ["7349206847"],
|
|
"order": 4
|
|
},
|
|
"conversion_window_days": {
|
|
"title": "Conversion Window",
|
|
"type": "integer",
|
|
"description": "A conversion window is the period of time after an ad interaction (such as an ad click or video view) during which a conversion, such as a purchase, is recorded in Google Ads. For more information, see Google's <a href=\"https://support.google.com/google-ads/answer/3123169?hl=en\">documentation</a>.",
|
|
"minimum": 0,
|
|
"maximum": 1095,
|
|
"default": 14,
|
|
"examples": [14],
|
|
"order": 5
|
|
}
|
|
}
|
|
},
|
|
"advanced_auth": {
|
|
"auth_flow_type": "oauth2.0",
|
|
"oauth_config_specification": {
|
|
"complete_oauth_output_specification": {
|
|
"type": "object",
|
|
"properties": {
|
|
"access_token": {
|
|
"type": "string",
|
|
"path_in_connector_config": ["credentials", "access_token"]
|
|
},
|
|
"refresh_token": {
|
|
"type": "string",
|
|
"path_in_connector_config": ["credentials", "refresh_token"]
|
|
}
|
|
}
|
|
},
|
|
"complete_oauth_server_input_specification": {
|
|
"type": "object",
|
|
"properties": {
|
|
"client_id": {
|
|
"type": "string"
|
|
},
|
|
"client_secret": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"complete_oauth_server_output_specification": {
|
|
"type": "object",
|
|
"properties": {
|
|
"client_id": {
|
|
"type": "string",
|
|
"path_in_connector_config": ["credentials", "client_id"]
|
|
},
|
|
"client_secret": {
|
|
"type": "string",
|
|
"path_in_connector_config": ["credentials", "client_secret"]
|
|
},
|
|
"developer_token": {
|
|
"type": "string",
|
|
"path_in_connector_config": ["credentials", "developer_token"]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|