1
0
mirror of synced 2025-12-19 18:14:56 -05:00
Files
airbyte/airbyte-integrations/connectors/source-google-ads/source_google_ads/manifest.yaml

7110 lines
219 KiB
YAML

version: 6.44.0
type: DeclarativeSource
check:
type: CheckStream
stream_names:
- customer
definitions:
# Authenticator Definitions
authenticator:
type: OAuthAuthenticator
refresh_request_body: {}
token_refresh_endpoint: https://www.googleapis.com/oauth2/v3/token
grant_type: refresh_token
client_id: '{{ config["credentials"]["client_id"] }}'
client_secret: '{{ config["credentials"]["client_secret"] }}'
refresh_token: '{{ config["credentials"]["refresh_token"] }}'
base_requester:
type: HttpRequester
authenticator:
$ref: "#/definitions/authenticator"
http_method: GET
request_headers:
Content-Type: application/json
developer-token: '{{ config["credentials"]["developer_token"] }}'
error_handler:
$ref: "#/definitions/base_error_handler"
stream_requester:
type: CustomRequester
class_name: "source_google_ads.components.GoogleAdsHttpRequester"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas"
authenticator:
$ref: "#/definitions/authenticator"
url_base: "https://googleads.googleapis.com/v20/{{ stream_partition['customer_id'] }}/googleAds:searchStream"
http_method: POST
error_handler:
$ref: "#/definitions/base_error_handler"
base_error_handler:
type: DefaultErrorHandler
response_filters:
- type: HttpResponseFilter
action: FAIL
http_codes:
- 500
error_message: >-
Unable to fetch data from Google Ads API due to temporal error on the Google Ads server. Please retry again later.
- type: HttpResponseFilter
action: IGNORE
http_codes:
- 403
# error_message_contains: "The customer account can\\'t be accessed because it is not yet enabled or has been deactivated."
base_selector:
type: RecordSelector
extractor:
type: DpathExtractor
field_path:
- results
base_retriever:
type: SimpleRetriever
requester:
$ref: "#/definitions/stream_requester"
record_selector:
$ref: "#/definitions/base_selector"
decoder:
type: CustomDecoder
class_name: "source_google_ads.components.GoogleAdsStreamingDecoder"
stream_base:
type: DeclarativeStream
primary_key:
- id
retriever:
$ref: "#/definitions/base_retriever"
full_refresh_stream_base:
type: DeclarativeStream
retriever:
$ref: "#/definitions/base_retriever"
requester:
$ref: "#/definitions/stream_requester"
record_selector:
extractor:
type: DpathExtractor
field_path:
- results
schema_normalization:
type: CustomSchemaNormalization
class_name: source_google_ads.components.DoubleQuotedDictTypeTransformer
partition_router:
type: SubstreamPartitionRouter
parent_stream_configs:
- type: ParentStreamConfig
stream: "#/definitions/customer_client"
parent_key: "clientCustomer"
partition_field: "customer_id"
transformations:
- type: CustomTransformation
class_name: "source_google_ads.components.KeysToSnakeCaseGoogleAdsTransformation"
- type: CustomTransformation
class_name: "source_google_ads.components.FlattenNestedDictsTransformation"
state_migrations:
- type: CustomStateMigration
class_name: source_google_ads.components.GoogleAdsPerPartitionStateMigration
customer_client_stream: "#/definitions/customer_client"
incremental_stream_base:
type: DeclarativeStream
retriever:
$ref: "#/definitions/base_retriever"
requester:
$ref: "#/definitions/stream_requester"
record_selector:
extractor:
type: DpathExtractor
field_path:
- results
schema_normalization:
type: CustomSchemaNormalization
class_name: source_google_ads.components.DoubleQuotedDictTypeTransformer
partition_router:
type: SubstreamPartitionRouter
parent_stream_configs:
- type: ParentStreamConfig
stream: "#/definitions/customer_client"
parent_key: "clientCustomer"
partition_field: "customer_id"
extra_fields: [["manager"]]
transformations:
- type: CustomTransformation
class_name: "source_google_ads.components.KeysToSnakeCaseGoogleAdsTransformation"
- type: CustomTransformation
class_name: "source_google_ads.components.FlattenNestedDictsTransformation"
incremental_sync:
type: DatetimeBasedCursor
cursor_field: segments.date
datetime_format: "%Y-%m-%d"
lookback_window: P{{ config.get('conversion_window_days', 14) }}D
cursor_granularity: P1D
step: P14D
start_datetime:
type: MinMaxDatetime
datetime: "{{ config.get('start_date', day_delta(-365 * 2, format='%Y-%m-%d')) }}"
datetime_format: "%Y-%m-%d"
end_datetime:
type: MinMaxDatetime
datetime: "{{ config.get('end_date', today_utc()) }}"
datetime_format: "%Y-%m-%d"
state_migrations:
- type: CustomStateMigration
class_name: source_google_ads.components.GoogleAdsPerPartitionStateMigration
customer_client_stream: "#/definitions/customer_client"
incremental_non_manager_stream_base:
$ref: "#/definitions/incremental_stream_base"
retriever:
$ref: "#/definitions/incremental_stream_base/retriever"
partition_router:
type: SubstreamPartitionRouter
parent_stream_configs:
- type: ParentStreamConfig
stream: "#/definitions/customer_client_non_manager"
parent_key: "clientCustomer"
partition_field: "customer_id"
template_criterion_stream:
type: StateDelegatingStream
full_refresh_stream:
$ref: "#/definitions/incremental_stream_base"
retriever:
$ref: "#/definitions/incremental_stream_base/retriever"
requester:
type: CustomRequester
class_name: "source_google_ads.components.CriterionFullRefreshRequester"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas"
authenticator:
$ref: "#/definitions/authenticator"
url_base: "https://googleads.googleapis.com/v20/{{ stream_partition['customer_id'] }}/googleAds:searchStream"
http_method: POST
error_handler:
$ref: "#/definitions/base_error_handler"
incremental_sync:
type: DatetimeBasedCursor
cursor_field: change_status.last_change_date_time
datetime_format: "%Y-%m-%d %H:%M:%S.%f"
start_datetime:
type: MinMaxDatetime
datetime: "{{ config.get('start_date', day_delta(-365 * 2, format='%Y-%m-%d')) }}"
datetime_format: "%Y-%m-%d"
transformations:
- type: CustomTransformation
class_name: "source_google_ads.components.KeysToSnakeCaseGoogleAdsTransformation"
- type: CustomTransformation
class_name: "source_google_ads.components.FlattenNestedDictsTransformation"
- type: AddFields
fields:
- type: AddedFieldDefinition
path: ["change_status.last_change_date_time"]
value: "{{ today_utc().strftime('%Y-%m-%d %H:%M:%S.%f') }}"
incremental_stream:
$ref: "#/definitions/incremental_stream_base"
$parameters:
url_base: "https://googleads.googleapis.com/v20/{{ stream_partition['parent_slice']['customer_id'] }}/googleAds:searchStream"
retriever:
type: CustomRetriever
class_name: "source_google_ads.components.CriterionRetriever"
requester:
type: CustomRequester
class_name: "source_google_ads.components.CriterionIncrementalRequester"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas"
authenticator:
$ref: "#/definitions/authenticator"
http_method: POST
error_handler:
$ref: "#/definitions/base_error_handler"
record_selector:
type: RecordSelector
extractor:
type: DpathExtractor
field_path:
- results
schema_normalization:
type: CustomSchemaNormalization
class_name: source_google_ads.components.DoubleQuotedDictTypeTransformer
partition_router:
type: GroupingPartitionRouter
group_size: 10000
deduplicate: true
underlying_partition_router:
type: SubstreamPartitionRouter
parent_stream_configs:
- type: ParentStreamConfig
stream:
$ref: "#/definitions/change_status_stream"
parent_key: "change_status.{{ parameters['resource_name'] }}"
partition_field: "{{ parameters['resource_name'] }}.resource_name"
extra_fields:
[
["change_status.last_change_date_time"],
["change_status.resource_status"],
]
incremental_dependency: true
transformations:
- type: CustomTransformation
class_name: "source_google_ads.components.KeysToSnakeCaseGoogleAdsTransformation"
- type: CustomTransformation
class_name: "source_google_ads.components.FlattenNestedDictsTransformation"
incremental_sync:
type: DatetimeBasedCursor
cursor_field: change_status.last_change_date_time
datetime_format: "%Y-%m-%d %H:%M:%S.%f"
start_datetime:
type: MinMaxDatetime
datetime: "{{ config.get('start_date', day_delta(-365 * 2, format='%Y-%m-%d')) }}"
datetime_format: "%Y-%m-%d"
state_migrations:
- type: CustomStateMigration
class_name: source_google_ads.components.GoogleAdsCriterionParentStateMigration
- type: CustomStateMigration
class_name: source_google_ads.components.GoogleAdsGlobalStateMigration
accessible_accounts:
$ref: "#/definitions/stream_base"
name: accessible_accounts
retriever:
$ref: "#/definitions/base_retriever"
requester:
$ref: "#/definitions/base_requester"
url_base: "https://googleads.googleapis.com/v20/customers:listAccessibleCustomers"
http_method: GET
record_selector:
extractor:
type: CustomRecordExtractor
class_name: "source_google_ads.components.AccessibleAccountsExtractor"
customer_client:
$ref: "#/definitions/stream_base"
name: customer_client
retriever:
$ref: "#/definitions/base_retriever"
requester:
$ref: "#/definitions/base_requester"
url_base: "https://googleads.googleapis.com/v20/customers/{{ stream_partition['customer_id'] }}/googleAds:searchStream"
http_method: POST
request_body:
type: RequestBodyJsonObject
value:
query: >
SELECT
customer_client.client_customer,
customer_client.level,
customer_client.id,
customer_client.manager,
customer_client.time_zone,
customer_client.status
FROM
customer_client
record_selector:
extractor:
type: DpathExtractor
field_path: ["results", "*", "customerClient"]
record_filter:
type: CustomRecordFilter
class_name: "source_google_ads.components.CustomerClientFilter"
partition_router:
type: SubstreamPartitionRouter
parent_stream_configs:
- type: ParentStreamConfig
stream: "#/definitions/accessible_accounts"
parent_key: "accessible_customer_id"
partition_field: "customer_id"
customer_client_non_manager:
$ref: "#/definitions/stream_base"
name: customer_client_non_manager
retriever:
$ref: "#/definitions/base_retriever"
requester:
$ref: "#/definitions/base_requester"
url_base: "https://googleads.googleapis.com/v20/customers/{{ stream_partition['customer_id'] }}/googleAds:searchStream"
http_method: POST
request_body:
type: RequestBodyJsonObject
value:
query: >
SELECT
customer_client.client_customer,
customer_client.level,
customer_client.id,
customer_client.manager,
customer_client.time_zone,
customer_client.status
FROM
customer_client
WHERE
customer_client.manager = FALSE
record_selector:
extractor:
type: DpathExtractor
field_path: ["results", "*", "customerClient"]
record_filter:
type: CustomRecordFilter
class_name: "source_google_ads.components.CustomerClientFilter"
partition_router:
type: SubstreamPartitionRouter
parent_stream_configs:
- type: ParentStreamConfig
stream: "#/definitions/accessible_accounts"
parent_key: "accessible_customer_id"
partition_field: "customer_id"
transformations:
transform_metrics_interaction_event_types:
- type: AddedFieldDefinition
path: ["metrics.interaction_event_types"]
value: >-
{{ record['metrics.interaction_event_types']
| map('replace','UNSPECIFIED','0')
| map('replace','UNKNOWN','1')
| map('replace','CLICK','2')
| map('replace','ENGAGEMENT','3')
| map('replace','VIDEO_VIEW','4')
| map('replace','NONE','5')
| list }}
dynamic_stream_template:
type: DeclarativeStream
retriever:
$ref: "#/definitions/base_retriever"
requester:
type: CustomRequester
class_name: "source_google_ads.components.CustomGAQueryHttpRequester"
authenticator:
$ref: "#/definitions/authenticator"
url_base: "https://googleads.googleapis.com/v20/{{ stream_partition['customer_id'] }}/googleAds:searchStream"
http_method: POST
error_handler:
$ref: "#/definitions/base_error_handler"
record_selector:
extractor:
type: DpathExtractor
field_path:
- results
schema_normalization:
type: CustomSchemaNormalization
class_name: source_google_ads.components.DoubleQuotedDictTypeTransformer
partition_router:
type: SubstreamPartitionRouter
parent_stream_configs:
- type: ParentStreamConfig
parent_key: "clientCustomer"
partition_field: "customer_id"
stream: "#/definitions/customer_client"
transformations:
- type: CustomTransformation
class_name: "source_google_ads.components.KeysToSnakeCaseGoogleAdsTransformation"
- type: CustomTransformation
class_name: "source_google_ads.components.FlattenNestedDictsTransformation"
- type: AddFields
fields:
$ref: "#/definitions/transformations/transform_metrics_interaction_event_types"
condition: "{{ record.get('metrics.interaction_event_types', False) }}"
state_migrations:
- type: CustomStateMigration
class_name: source_google_ads.components.GoogleAdsPerPartitionStateMigration
customer_client_stream: "#/definitions/customer_client"
schema_loader:
type: CustomSchemaLoader
class_name: "source_google_ads.components.CustomGAQuerySchemaLoader"
requester:
$ref: "#/definitions/base_requester"
url: "https://googleads.googleapis.com/v20/googleAdsFields"
http_method: GET
error_handler:
$ref: "#/definitions/base_error_handler"
$parameters:
name: dynamic_schema_loader_requester
# Stream Definitions
account_performance_report_stream:
$ref: "#/definitions/incremental_non_manager_stream_base"
name: account_performance_report
primary_key:
- customer.id
- segments.date
- segments.ad_network_type
- segments.device
transformations:
- type: CustomTransformation
class_name: "source_google_ads.components.KeysToSnakeCaseGoogleAdsTransformation"
- type: CustomTransformation
class_name: "source_google_ads.components.FlattenNestedDictsTransformation"
- type: AddFields
fields:
$ref: "#/definitions/transformations/transform_metrics_interaction_event_types"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/account_performance_report"
ad_group_stream:
$ref: "#/definitions/incremental_stream_base"
name: ad_group
primary_key:
- ad_group.id
- segments.date
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/ad_group"
ad_group_ad_stream:
$ref: "#/definitions/incremental_stream_base"
name: ad_group_ad
primary_key:
- ad_group.id
- ad_group_ad.ad.id
- segments.date
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/ad_group_ad"
ad_group_ad_label_stream:
$ref: "#/definitions/full_refresh_stream_base"
name: ad_group_ad_label
primary_key:
- ad_group.id
- ad_group_ad.ad.id
- label.id
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/ad_group_ad_label"
ad_group_ad_legacy_stream:
$ref: "#/definitions/incremental_non_manager_stream_base"
name: ad_group_ad_legacy
primary_key:
- ad_group.id
- ad_group_ad.ad.id
- segments.date
- segments.ad_network_type
transformations:
- type: CustomTransformation
class_name: "source_google_ads.components.KeysToSnakeCaseGoogleAdsTransformation"
- type: CustomTransformation
class_name: "source_google_ads.components.FlattenNestedDictsTransformation"
- type: AddFields
fields:
$ref: "#/definitions/transformations/transform_metrics_interaction_event_types"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/ad_group_ad_legacy"
ad_group_bidding_strategy_stream:
$ref: "#/definitions/incremental_stream_base"
name: ad_group_bidding_strategy
primary_key:
- ad_group.id
- bidding_strategy.id
- segments.date
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/ad_group_bidding_strategy"
ad_group_label_stream:
$ref: "#/definitions/full_refresh_stream_base"
name: ad_group_label
primary_key:
- ad_group.id
- label.id
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/ad_group_label"
ad_group_criterion_label_stream:
$ref: "#/definitions/full_refresh_stream_base"
name: ad_group_criterion_label
primary_key:
- ad_group_criterion_label.resource_name
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/ad_group_criterion_label"
audience_stream:
$ref: "#/definitions/full_refresh_stream_base"
name: audience
primary_key:
- customer.id
- audience.id
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/audience"
campaign_stream:
$ref: "#/definitions/incremental_non_manager_stream_base"
name: campaign
primary_key:
- campaign.id
- segments.date
- segments.hour
- segments.ad_network_type
transformations:
- type: CustomTransformation
class_name: "source_google_ads.components.KeysToSnakeCaseGoogleAdsTransformation"
- type: CustomTransformation
class_name: "source_google_ads.components.FlattenNestedDictsTransformation"
- type: AddFields
fields:
$ref: "#/definitions/transformations/transform_metrics_interaction_event_types"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/campaign"
campaign_bidding_strategy_stream:
$ref: "#/definitions/incremental_stream_base"
name: campaign_bidding_strategy
primary_key:
- campaign.id
- bidding_strategy.id
- segments.date
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/campaign_bidding_strategy"
campaign_budget_stream:
$ref: "#/definitions/incremental_stream_base"
name: campaign_budget
primary_key:
- customer.id
- campaign_budget.id
- segments.date
- segments.budget_campaign_association_status.campaign
- segments.budget_campaign_association_status.status
transformations:
- type: CustomTransformation
class_name: "source_google_ads.components.KeysToSnakeCaseGoogleAdsTransformation"
- type: CustomTransformation
class_name: "source_google_ads.components.FlattenNestedDictsTransformation"
- type: AddFields
fields:
$ref: "#/definitions/transformations/transform_metrics_interaction_event_types"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/campaign_budget"
campaign_label_stream:
$ref: "#/definitions/full_refresh_stream_base"
name: campaign_label
primary_key:
- campaign.id
- label.id
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/campaign_label"
click_view_stream:
$ref: "#/definitions/incremental_stream_base"
name: click_view
primary_key:
- "click_view.gclid"
- "segments.date"
- "segments.ad_network_type"
retriever:
$ref: "#/definitions/incremental_stream_base/retriever"
requester:
type: CustomRequester
class_name: "source_google_ads.components.ClickViewHttpRequester"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/click_view"
authenticator:
$ref: "#/definitions/authenticator"
url_base: "https://googleads.googleapis.com/v20/{{ stream_partition['customer_id'] }}/googleAds:searchStream"
http_method: POST
error_handler:
$ref: "#/definitions/base_error_handler"
incremental_sync:
type: DatetimeBasedCursor
cursor_field: segments.date
datetime_format: "%Y-%m-%d"
cursor_granularity: P1D
lookback_window: "P{{ max(config.get('conversion_window_days', 1), 1) }}D"
step: P1D
start_datetime:
type: MinMaxDatetime
datetime: "{{ max(config.get('start_date', day_delta(-90, format='%Y-%m-%d')), day_delta(-90, format='%Y-%m-%d')) }}"
datetime_format: "%Y-%m-%d"
end_datetime:
type: MinMaxDatetime
datetime: "{{ format_datetime((str_to_datetime(config.get('end_date')) if config.get('end_date') else now_utc()) + duration('P1D'), '%Y-%m-%d') }}"
datetime_format: "%Y-%m-%d"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/click_view"
customer_stream:
$ref: "#/definitions/incremental_stream_base"
name: customer
primary_key:
- customer.id
- segments.date
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/customer"
customer_label_stream:
$ref: "#/definitions/full_refresh_stream_base"
name: customer_label
primary_key:
- customer_label.resource_name
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/customer_label"
label_stream:
$ref: "#/definitions/full_refresh_stream_base"
name: label
primary_key:
- label.id
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/label"
user_interest_stream:
$ref: "#/definitions/full_refresh_stream_base"
name: user_interest
primary_key:
- user_interest.user_interest_id
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/user_interest"
display_keyword_view_stream:
$ref: "#/definitions/incremental_non_manager_stream_base"
name: display_keyword_view
primary_key:
- ad_group.id
- ad_group_criterion.criterion_id
- segments.date
- segments.ad_network_type
- segments.device
transformations:
- type: CustomTransformation
class_name: "source_google_ads.components.KeysToSnakeCaseGoogleAdsTransformation"
- type: CustomTransformation
class_name: "source_google_ads.components.FlattenNestedDictsTransformation"
- type: AddFields
fields:
$ref: "#/definitions/transformations/transform_metrics_interaction_event_types"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/display_keyword_view"
geographic_view_stream:
$ref: "#/definitions/incremental_non_manager_stream_base"
name: geographic_view
primary_key:
- customer.id
- geographic_view.country_criterion_id
- geographic_view.location_type
- segments.date
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/geographic_view"
keyword_view_stream:
$ref: "#/definitions/incremental_non_manager_stream_base"
name: keyword_view
primary_key:
- ad_group.id
- ad_group_criterion.criterion_id
- segments.date
transformations:
- type: CustomTransformation
class_name: "source_google_ads.components.KeysToSnakeCaseGoogleAdsTransformation"
- type: CustomTransformation
class_name: "source_google_ads.components.FlattenNestedDictsTransformation"
- type: AddFields
fields:
$ref: "#/definitions/transformations/transform_metrics_interaction_event_types"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/keyword_view"
shopping_performance_view_stream:
$ref: "#/definitions/incremental_non_manager_stream_base"
name: shopping_performance_view
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/shopping_performance_view"
topic_view_stream:
$ref: "#/definitions/incremental_non_manager_stream_base"
name: topic_view
primary_key:
- ad_group.id
- ad_group_criterion.criterion_id
- segments.date
- segments.ad_network_type
- segments.device
transformations:
- type: CustomTransformation
class_name: "source_google_ads.components.KeysToSnakeCaseGoogleAdsTransformation"
- type: CustomTransformation
class_name: "source_google_ads.components.FlattenNestedDictsTransformation"
- type: AddFields
fields:
$ref: "#/definitions/transformations/transform_metrics_interaction_event_types"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/topic_view"
user_location_view_stream:
$ref: "#/definitions/incremental_non_manager_stream_base"
name: user_location_view
primary_key:
- customer.id
- user_location_view.country_criterion_id
- user_location_view.targeting_location
- segments.date
- segments.ad_network_type
transformations:
- type: CustomTransformation
class_name: "source_google_ads.components.KeysToSnakeCaseGoogleAdsTransformation"
- type: CustomTransformation
class_name: "source_google_ads.components.FlattenNestedDictsTransformation"
- type: AddFields
fields:
$ref: "#/definitions/transformations/transform_metrics_interaction_event_types"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/user_location_view"
change_status_stream:
$ref: "#/definitions/incremental_stream_base"
name: change_status
$parameters:
url_base: "https://googleads.googleapis.com/v20/{{ stream_partition['customer_id'] }}/googleAds:search"
retriever:
type: SimpleRetriever
requester:
type: CustomRequester
class_name: "source_google_ads.components.ChangeStatusRequester"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas"
authenticator:
$ref: "#/definitions/authenticator"
http_method: POST
error_handler:
$ref: "#/definitions/base_error_handler"
name: change_status
pagination_reset:
type: PaginationReset
action: SPLIT_USING_CURSOR
limits:
type: PaginationResetLimits
number_of_records: 10000
record_selector:
type: RecordSelector
$parameters:
name: "change_status"
extractor:
type: DpathExtractor
field_path:
- results
schema_normalization:
type: CustomSchemaNormalization
class_name: source_google_ads.components.DoubleQuotedDictTypeTransformer
partition_router:
type: SubstreamPartitionRouter
parent_stream_configs:
- type: ParentStreamConfig
stream: "#/definitions/customer_client"
parent_key: "clientCustomer"
partition_field: "customer_id"
extra_fields: [["manager"]]
transformations:
- type: CustomTransformation
class_name: "source_google_ads.components.KeysToSnakeCaseGoogleAdsTransformation"
- type: CustomTransformation
class_name: "source_google_ads.components.FlattenNestedDictsTransformation"
incremental_sync:
type: DatetimeBasedCursor
cursor_field: change_status.last_change_date_time
datetime_format: "%Y-%m-%d %H:%M:%S.%f"
cursor_granularity: PT0.000001S
step: P14D
start_datetime:
type: MinMaxDatetime
datetime: "{{ day_delta(-90, format='%Y-%m-%d %H:%M:%S.%f') }}"
datetime_format: "%Y-%m-%d %H:%M:%S.%f"
end_datetime:
type: MinMaxDatetime
datetime: "{{ now_utc().strftime('%Y-%m-%d %H:%M:%S.%f') }}"
datetime_format: "%Y-%m-%d %H:%M:%S.%f"
state_migrations:
- type: CustomStateMigration
class_name: source_google_ads.components.GoogleAdsPerPartitionStateMigration
customer_client_stream: "#/definitions/customer_client"
cursor_field: change_status.last_change_date_time
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/change_status"
ad_group_criterion_stream:
type: StateDelegatingStream
$parameters:
name: "ad_group_criterion"
resource_name: "ad_group_criterion"
primary_key:
- ad_group_criterion.resource_name
resource_type: AD_GROUP_CRITERION
full_refresh_stream:
$ref: "#/definitions/template_criterion_stream/full_refresh_stream"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/ad_group_criterion"
incremental_stream:
$ref: "#/definitions/template_criterion_stream/incremental_stream"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/ad_group_criterion"
ad_listing_group_criterion_stream:
type: StateDelegatingStream
$parameters:
name: "ad_listing_group_criterion"
resource_name: "ad_group_criterion"
primary_key:
- ad_group_criterion.resource_name
resource_type: AD_GROUP_CRITERION
full_refresh_stream:
$ref: "#/definitions/template_criterion_stream/full_refresh_stream"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/ad_listing_group_criterion"
incremental_stream:
$ref: "#/definitions/template_criterion_stream/incremental_stream"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/ad_listing_group_criterion"
campaign_criterion_stream:
type: StateDelegatingStream
$parameters:
name: "campaign_criterion"
resource_name: "campaign_criterion"
primary_key:
- campaign_criterion.resource_name
resource_type: CAMPAIGN_CRITERION
full_refresh_stream:
$ref: "#/definitions/template_criterion_stream/full_refresh_stream"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/campaign_criterion"
incremental_stream:
$ref: "#/definitions/template_criterion_stream/incremental_stream"
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/campaign_criterion"
custom_ga_query_stream:
type: DynamicDeclarativeStream
stream_template:
$ref: "#/definitions/dynamic_stream_template"
components_resolver:
type: ConfigComponentsResolver
stream_config:
- type: StreamConfig
configs_pointer:
- custom_queries_array
components_mapping:
- type: ComponentMappingDefinition
field_path:
- name
value: "{{ components_values['table_name'] }}"
create_or_update: true
- type: ComponentMappingDefinition
field_path:
- incremental_sync
value: >-
{
"type": "DatetimeBasedCursor",
"cursor_field": "segments.date",
"datetime_format": "%Y-%m-%d",
"lookback_window": "P{{ config.get('conversion_window_days', 14) }}D",
"cursor_granularity": "P1D",
"step": "P14D",
"start_datetime": {
"type": "MinMaxDatetime",
"datetime": "{{ config.get('start_date', day_delta(-365 * 2, format='%Y-%m-%d')) }}",
"datetime_format": "%Y-%m-%d"
},
"end_datetime": {
"type": "MinMaxDatetime",
"datetime": "{{ config.get('end_date', today_utc()) }}",
"datetime_format": "%Y-%m-%d"
}
}
condition: >-
{{
(
components_values.get('query', '').count('segments.date') == 1
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
)
or
(
components_values.get('query', '').count('segments.date') == 2
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
and (components_values.get('query') | regex_search('(?i)(\\bORDER\\s+BY\\b[\\s\\S]*?segments\\.date)'))
)
}}
create_or_update: true
- type: ComponentMappingDefinition
field_path:
- retriever
- requester
- $parameters
- cursor_field
value: "segments.date"
condition: >-
{{
(
components_values.get('query', '').count('segments.date') == 1
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
)
or
(
components_values.get('query', '').count('segments.date') == 2
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
and (components_values.get('query') | regex_search('(?i)(\\bORDER\\s+BY\\b[\\s\\S]*?segments\\.date)'))
)
}}
create_or_update: true
- type: ComponentMappingDefinition
field_path:
- schema_loader
- query
value: "{{ components_values.get('query', None) }}"
condition: "{{ components_values.get('query', False) }}"
create_or_update: true
- type: ComponentMappingDefinition
field_path:
- schema_loader
- cursor_field
value: "segments.date"
condition: >-
{{
(
components_values.get('query', '').count('segments.date') == 1
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
)
or
(
components_values.get('query', '').count('segments.date') == 2
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
and (components_values.get('query') | regex_search('(?i)(\\bORDER\\s+BY\\b[\\s\\S]*?segments\\.date)'))
)
}}
create_or_update: true
- type: ComponentMappingDefinition
field_path:
- incremental_sync
- step
value: "P1D"
condition: >-
{{
(
(
components_values.get('query', '').count('segments.date') == 1
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
)
or
(
components_values.get('query', '').count('segments.date') == 2
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
and (components_values.get('query') | regex_search('(?i)(\\bORDER\\s+BY\\b[\\s\\S]*?segments\\.date)'))
)
) and components_values.get('query', '') | regex_search('(?i)(\\bFROM\\s+click_view\\b)')
}}
create_or_update: true
- type: ComponentMappingDefinition
field_path:
- incremental_sync
- start_datetime
value: >-
{
"type": "MinMaxDatetime",
"datetime": "{{ max(config.get('start_date', day_delta(-90, format='%Y-%m-%d')), day_delta(-90, format='%Y-%m-%d')) }}",
"datetime_format": "%Y-%m-%d"
}
condition: >-
{{
(
(
components_values.get('query', '').count('segments.date') == 1
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
)
or
(
components_values.get('query', '').count('segments.date') == 2
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
and (components_values.get('query') | regex_search('(?i)(\\bORDER\\s+BY\\b[\\s\\S]*?segments\\.date)'))
)
) and components_values.get('query', '') | regex_search('(?i)(\\bFROM\\s+click_view\\b)')
}}
create_or_update: true
- type: ComponentMappingDefinition
field_path:
- incremental_sync
- end_datetime
value: >-
{
"type": "MinMaxDatetime",
"datetime": "{{ format_datetime((str_to_datetime(config.get('end_date')) if config.get('end_date') else now_utc()) + duration('P1D'), '%Y-%m-%d') }}",
"datetime_format": "%Y-%m-%d"
}
condition: >-
{{
(
(
components_values.get('query', '').count('segments.date') == 1
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
)
or
(
components_values.get('query', '').count('segments.date') == 2
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
and (components_values.get('query') | regex_search('(?i)(\\bORDER\\s+BY\\b[\\s\\S]*?segments\\.date)'))
)
) and components_values.get('query', '') | regex_search('(?i)(\\bFROM\\s+click_view\\b)')
}}
create_or_update: true
- type: ComponentMappingDefinition
field_path:
- incremental_sync
- cursor_granularity
value: P1D
condition: >-
{{
(
(
components_values.get('query', '').count('segments.date') == 1
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
)
or
(
components_values.get('query', '').count('segments.date') == 2
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
and (components_values.get('query') | regex_search('(?i)(\\bORDER\\s+BY\\b[\\s\\S]*?segments\\.date)'))
)
) and components_values.get('query', '') | regex_search('(?i)(\\bFROM\\s+click_view\\b)')
}}
create_or_update: true
- type: ComponentMappingDefinition
field_path:
- retriever
- requester
- class_name
value: "source_google_ads.components.CustomGAQueryClickViewHttpRequester"
condition: >-
{{
(
(
components_values.get('query', '').count('segments.date') == 1
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
)
or
(
components_values.get('query', '').count('segments.date') == 2
and (components_values.get('query') | regex_search('(?i)(\\bSELECT\\b[\\s\\S]*?segments\\.date[\\s\\S]*?\\bFROM\\b)'))
and (components_values.get('query') | regex_search('(?i)(\\bORDER\\s+BY\\b[\\s\\S]*?segments\\.date)'))
)
) and components_values.get('query', '') | regex_search('(?i)(\\bFROM\\s+click_view\\b)')
}}
create_or_update: true
- type: ComponentMappingDefinition
field_path:
- retriever
- requester
- $parameters
- query
value: "{{ components_values.get('query', None) }}"
create_or_update: true
- type: ComponentMappingDefinition
field_path:
- retriever
- partition_router
- parent_stream_configs
- "0"
- stream
- name
value: customer_client_non_manager
condition: "{{ 'metrics' in components_values.get('query', False) }}"
create_or_update: true
- type: ComponentMappingDefinition
field_path:
- retriever
- partition_router
- parent_stream_configs
- "0"
- stream
- retriever
- requester
- request_body
- value
- query
value: >
SELECT
customer_client.client_customer,
customer_client.level,
customer_client.id,
customer_client.manager,
customer_client.time_zone,
customer_client.status
FROM
customer_client
WHERE
customer_client.manager = FALSE
condition: "{{ 'metrics' in components_values.get('query', False) }}"
create_or_update: true
streams:
- "#/definitions/account_performance_report_stream"
- "#/definitions/ad_group_stream"
- "#/definitions/ad_group_ad_stream"
- "#/definitions/ad_group_ad_label_stream"
- "#/definitions/ad_group_ad_legacy_stream"
- "#/definitions/ad_group_bidding_strategy_stream"
- "#/definitions/ad_group_criterion_stream"
- "#/definitions/ad_group_label_stream"
- "#/definitions/ad_group_criterion_label_stream"
- "#/definitions/ad_listing_group_criterion_stream"
- "#/definitions/audience_stream"
- "#/definitions/campaign_stream"
- "#/definitions/campaign_bidding_strategy_stream"
- "#/definitions/campaign_budget_stream"
- "#/definitions/campaign_criterion_stream"
- "#/definitions/campaign_label_stream"
- "#/definitions/customer_stream"
- "#/definitions/click_view_stream"
- "#/definitions/customer_label_stream"
- "#/definitions/display_keyword_view_stream"
- "#/definitions/geographic_view_stream"
- "#/definitions/keyword_view_stream"
- "#/definitions/label_stream"
- "#/definitions/shopping_performance_view_stream"
- "#/definitions/topic_view_stream"
- "#/definitions/user_interest_stream"
- "#/definitions/user_location_view_stream"
dynamic_streams:
- "#/definitions/custom_ga_query_stream"
concurrency_level:
type: ConcurrencyLevel
default_concurrency: "{{ config.get('num_workers', 3) }}"
max_concurrency: 40
schemas:
ad_group:
$schema: http://json-schema.org/schema#
type: object
properties:
campaign.id:
description: The unique identifier of the campaign to which the ad group belongs.
type:
- "null"
- integer
ad_group.ad_rotation_mode:
description: The rotation mode for ads within the ad group.
type:
- "null"
- string
ad_group.base_ad_group:
description: The base ad group associated with this ad group.
type:
- "null"
- string
ad_group.campaign:
description: The campaign to which the ad group belongs.
type:
- "null"
- string
metrics.cost_micros:
description: The cost in micros for the ad group.
type:
- "null"
- integer
ad_group.cpc_bid_micros:
description: The cost-per-click bid for the ad group in micros.
type:
- "null"
- integer
ad_group.cpm_bid_micros:
description: The cost-per-thousand impressions bid for the ad group in micros.
type:
- "null"
- integer
ad_group.cpv_bid_micros:
description: The cost-per-view bid for the ad group in micros.
type:
- "null"
- integer
ad_group.display_custom_bid_dimension:
description: Custom bid dimension settings for the display network.
type:
- "null"
- string
ad_group.effective_target_cpa_micros:
description: The effective target cost-per-acquisition bid in micros.
type:
- "null"
- integer
ad_group.effective_target_cpa_source:
description: The source of the effective target CPA bid.
type:
- "null"
- string
ad_group.effective_target_roas:
description: The effective target return on ad spend bid.
type:
- "null"
- number
ad_group.effective_target_roas_source:
description: The source of the effective target ROAS bid.
type:
- "null"
- string
ad_group.excluded_parent_asset_field_types:
description:
Field types excluded from being used as asset fields in the ad
group.
type:
- "null"
- array
items:
type: string
ad_group.optimized_targeting_enabled:
description: Indicates whether optimized targeting is enabled for the ad group.
type:
- "null"
- boolean
ad_group.final_url_suffix:
description: The final URL suffix for the ad group.
type:
- "null"
- string
ad_group.id:
description: The unique identifier for the ad group.
type:
- "null"
- integer
ad_group.labels:
description: Labels associated with the ad group.
type:
- "null"
- array
items:
type: string
ad_group.name:
description: The name of the ad group.
type:
- "null"
- string
ad_group.percent_cpc_bid_micros:
description:
The percentage of the cost-per-click bid that is paid for the
ad group.
type:
- "null"
- integer
ad_group.resource_name:
description: The resource name of the ad group.
type:
- "null"
- string
ad_group.status:
description: The status of the ad group.
type:
- "null"
- string
ad_group.target_cpa_micros:
description: The target cost-per-acquisition bid in micros for the ad group.
type:
- "null"
- integer
ad_group.target_cpm_micros:
description:
The target cost-per-thousand impressions bid in micros for the
ad group.
type:
- "null"
- integer
ad_group.target_roas:
description: The target return on ad spend bid for the ad group.
type:
- "null"
- number
ad_group.targeting_setting.target_restrictions:
description: Targeting restrictions defined for the ad group.
type:
- "null"
- array
items:
type: string
ad_group.tracking_url_template:
description: The tracking URL template for the ad group.
type:
- "null"
- string
ad_group.type:
description: The type of the ad group.
type:
- "null"
- string
ad_group.url_custom_parameters:
description: Custom parameters for the ad group's URLs.
type:
- "null"
- array
items:
type: string
segments.date:
description: The date segment for the data.
type:
- "null"
- string
format: date
additionalProperties: true
ad_group_criterion:
$schema: http://json-schema.org/schema#
type: object
properties:
deleted_at:
description: The date when the ad group criterion was deleted.
type:
- "null"
- string
change_status.last_change_date_time:
description: The date and time of the last change made to the ad group criterion.
type:
- "null"
- string
ad_group.id:
description: The ID of the ad group associated with the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.ad_group:
description: The ad group to which the ad group criterion belongs.
type:
- "null"
- string
ad_group_criterion.age_range.type:
description: The age range targeting type for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.app_payment_model.type:
description: The app payment model type for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.approval_status:
description: The approval status of the ad group criterion.
type:
- "null"
- string
ad_group_criterion.audience.audience:
description: The audience targeting for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.bid_modifier:
description: The bid modifier for the ad group criterion.
type:
- "null"
- number
ad_group_criterion.combined_audience.combined_audience:
description: The combined audience targeting for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.cpc_bid_micros:
description: The CPC bid amount in micros for the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.cpm_bid_micros:
description: The CPM bid amount in micros for the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.cpv_bid_micros:
description: The CPV bid amount in micros for the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.criterion_id:
description: The ID of the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.custom_affinity.custom_affinity:
description: The custom affinity targeting for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.custom_audience.custom_audience:
description: The custom audience targeting for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.custom_intent.custom_intent:
description: The custom intent targeting for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.disapproval_reasons:
description: The reasons for disapproval of the ad group criterion.
type:
- "null"
- array
items:
type:
- "null"
- string
ad_group_criterion.display_name:
description: The display name of the ad group criterion.
type:
- "null"
- string
ad_group_criterion.effective_cpc_bid_micros:
description: The effective CPC bid amount in micros for the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.effective_cpc_bid_source:
description: The source of the effective CPC bid for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.effective_cpm_bid_micros:
description: The effective CPM bid amount in micros for the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.effective_cpm_bid_source:
description: The source of the effective CPM bid for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.effective_cpv_bid_micros:
description: The effective CPV bid amount in micros for the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.effective_cpv_bid_source:
description: The source of the effective CPV bid for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.effective_percent_cpc_bid_micros:
description:
The effective percent CPC bid amount in micros for the ad group
criterion.
type:
- "null"
- integer
ad_group_criterion.effective_percent_cpc_bid_source:
description:
The source of the effective percent CPC bid for the ad group
criterion.
type:
- "null"
- string
ad_group_criterion.final_mobile_urls:
description: The final mobile URLs for the ad group criterion.
type:
- "null"
- array
items:
type:
- "null"
- string
ad_group_criterion.final_url_suffix:
description: The final URL suffix for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.final_urls:
description: The final URLs for the ad group criterion.
type:
- "null"
- array
items:
type:
- "null"
- string
ad_group_criterion.gender.type:
description: The gender targeting type for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.income_range.type:
description: The income range targeting type for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.keyword.match_type:
description: The match type of the keyword for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.keyword.text:
description: The text of the keyword for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.labels:
description: The labels associated with the ad group criterion.
type:
- "null"
- array
items:
type:
- "null"
- string
ad_group_criterion.mobile_app_category.mobile_app_category_constant:
description: The mobile app category constant for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.mobile_application.app_id:
description: The application ID for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.mobile_application.name:
description: The name of the mobile application for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.negative:
description: Indicates if the ad group criterion is negative or not.
type:
- "null"
- boolean
ad_group_criterion.parental_status.type:
description: The parental status targeting type for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.percent_cpc_bid_micros:
description: The percent CPC bid amount in micros for the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.placement.url:
description: The URL placement for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.position_estimates.estimated_add_clicks_at_first_position_cpc:
description:
The estimated additional clicks at the first position CPC for
the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.position_estimates.estimated_add_cost_at_first_position_cpc:
description:
The estimated additional cost at the first position CPC for the
ad group criterion.
type:
- "null"
- integer
ad_group_criterion.position_estimates.first_page_cpc_micros:
description: The first page CPC bid amount in micros for the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.position_estimates.first_position_cpc_micros:
description:
The first position CPC bid amount in micros for the ad group
criterion.
type:
- "null"
- integer
ad_group_criterion.position_estimates.top_of_page_cpc_micros:
description: The top of page CPC bid amount in micros for the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.quality_info.creative_quality_score:
description: The creative quality score for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.quality_info.post_click_quality_score:
description: The post-click quality score for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.quality_info.quality_score:
description: The quality score for the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.quality_info.search_predicted_ctr:
description: The predicted click-through rate for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.resource_name:
description: The resource name of the ad group criterion.
type:
- "null"
- string
ad_group_criterion.status:
description: The status of the ad group criterion.
type:
- "null"
- string
ad_group_criterion.system_serving_status:
description: The serving status of the ad group criterion.
type:
- "null"
- string
ad_group_criterion.topic.path:
description: The path of the topic targeting for the ad group criterion.
type:
- "null"
- array
items:
type:
- "null"
- string
ad_group_criterion.topic.topic_constant:
description: The topic constant for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.tracking_url_template:
description: The tracking URL template for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.type:
description: The type of the ad group criterion.
type:
- "null"
- string
ad_group_criterion.url_custom_parameters:
description: The custom parameters for the URLs of the ad group criterion.
type:
- "null"
- array
items:
type:
- "null"
- string
ad_group_criterion.user_interest.user_interest_category:
description: The user interest category for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.user_list.user_list:
description: The user list targeting for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.webpage.conditions:
description: The conditions set for webpage targeting of the ad group criterion.
type:
- "null"
- array
items:
type:
- "null"
- string
ad_group_criterion.webpage.coverage_percentage:
description:
The coverage percentage for the webpage targeting of the ad group
criterion.
type:
- "null"
- number
ad_group_criterion.webpage.criterion_name:
description:
The criterion name for the webpage targeting of the ad group
criterion.
type:
- "null"
- string
ad_group_criterion.webpage.sample.sample_urls:
description: The sample URLs for webpage targeting of the ad group criterion.
type:
- "null"
- array
items:
type:
- "null"
- string
ad_group_criterion.youtube_channel.channel_id:
description:
The channel ID for YouTube channel targeting of the ad group
criterion.
type:
- "null"
- string
ad_group_criterion.youtube_video.video_id:
description: The video ID for YouTube video targeting of the ad group criterion.
type:
- "null"
- string
additionalProperties: true
ad_listing_group_criterion:
$schema: http://json-schema.org/schema#
type: object
properties:
deleted_at:
description:
The timestamp indicating when the ad group criterion was deleted,
if applicable.
type:
- "null"
- string
change_status.last_change_date_time:
description: The date and time of the last change made to the ad group criterion.
type:
- "null"
- string
ad_group_criterion.resource_name:
description: The resource name of the ad group criterion.
type:
- "null"
- string
ad_group.id:
description: The ID of the ad group associated with the criterion.
type:
- "null"
- integer
ad_group_criterion.criterion_id:
description: The ID of the criterion defining the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.listing_group.case_value.activity_country.value:
description:
The country where the activity related to the ad group criterion
takes place.
type:
- "null"
- string
ad_group_criterion.listing_group.case_value.activity_id.value:
description: The ID of the activity related to the ad group criterion.
type:
- "null"
- string
ad_group_criterion.listing_group.case_value.activity_rating.value:
description: The rating of the activity related to the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.listing_group.case_value.hotel_city.city_criterion:
description:
The city where the hotel related to the ad group criterion is
located.
type:
- "null"
- string
ad_group_criterion.listing_group.case_value.hotel_class.value:
description: The class of the hotel related to the ad group criterion.
type:
- "null"
- integer
ad_group_criterion.listing_group.case_value.hotel_country_region.country_region_criterion:
description:
The country region where the hotel related to the ad group criterion
is located.
type:
- "null"
- string
ad_group_criterion.listing_group.case_value.hotel_id.value:
description: The ID of the hotel related to the ad group criterion.
type:
- "null"
- string
ad_group_criterion.listing_group.case_value.hotel_state.state_criterion:
description:
The state where the hotel related to the ad group criterion is
located.
type:
- "null"
- string
ad_group_criterion.listing_group.case_value.product_category.category_id:
description:
The ID of the category to which the product related to the ad
group criterion belongs.
type:
- "null"
- integer
ad_group_criterion.listing_group.case_value.product_category.level:
description: The category level of the product related to the ad group criterion.
type:
- "null"
- string
ad_group_criterion.listing_group.case_value.product_brand.value:
description: The brand of the product related to the ad group criterion.
type:
- "null"
- string
ad_group_criterion.listing_group.case_value.product_channel.channel:
description:
The channel where the product related to the ad group criterion
is sold.
type:
- "null"
- string
ad_group_criterion.listing_group.case_value.product_channel_exclusivity.channel_exclusivity:
description:
The exclusivity level of the product on its distribution channel
related to the ad group criterion.
type:
- "null"
- string
ad_group_criterion.listing_group.case_value.product_condition.condition:
description: The condition of the product related to the ad group criterion.
type:
- "null"
- string
ad_group_criterion.listing_group.case_value.product_custom_attribute.index:
description:
The custom attribute index of the product related to the ad group
criterion.
type:
- "null"
- string
ad_group_criterion.listing_group.case_value.product_custom_attribute.value:
description:
The custom attribute value of the product related to the ad group
criterion.
type:
- "null"
- string
ad_group_criterion.listing_group.case_value.product_item_id.value:
description: The ID of the product item related to the ad group criterion.
type:
- "null"
- string
ad_group_criterion.listing_group.case_value.product_type.level:
description: The level of product type related to the ad group criterion.
type:
- "null"
- string
ad_group_criterion.listing_group.case_value.product_type.value:
description: The value of the product type related to the ad group criterion.
type:
- "null"
- string
ad_group_criterion.listing_group.parent_ad_group_criterion:
description: The parent ad group criterion of the current ad group criterion.
type:
- "null"
- string
ad_group_criterion.listing_group.type:
description: The type of the listing group associated with the ad group criterion.
type:
- "null"
- string
additionalProperties: true
campaign:
$schema: http://json-schema.org/schema#
type: object
properties:
campaign.accessible_bidding_strategy:
description: The accessible bidding strategy of the campaign.
type:
- "null"
- string
campaign.ad_serving_optimization_status:
description: The optimization status for serving ads within the campaign.
type:
- "null"
- string
campaign.advertising_channel_sub_type:
description: The sub-type of advertising channel for the campaign.
type:
- "null"
- string
campaign.advertising_channel_type:
description: The type of advertising channel for the campaign.
type:
- "null"
- string
campaign.app_campaign_setting.app_id:
description: The ID of the app associated with the app campaign setting.
type:
- "null"
- string
campaign.app_campaign_setting.app_store:
description:
The app store for the mobile app associated with the app campaign
setting.
type:
- "null"
- string
campaign.app_campaign_setting.bidding_strategy_goal_type:
description: The goal type for the app campaign's bidding strategy.
type:
- "null"
- string
campaign.base_campaign:
description: The base campaign linked to the current campaign.
type:
- "null"
- string
campaign.bidding_strategy:
description: The bidding strategy used for the campaign.
type:
- "null"
- string
campaign.bidding_strategy_type:
description: The type of bidding strategy employed for the campaign.
type:
- "null"
- string
campaign.campaign_budget:
description: The budget allocated for the campaign.
type:
- "null"
- string
campaign_budget.amount_micros:
description: The budget amount in micros allocated for the campaign.
type:
- "null"
- integer
campaign.commission.commission_rate_micros:
description: The commission rate in micros for the campaign.
type:
- "null"
- integer
campaign.dynamic_search_ads_setting.domain_name:
description: The domain name set for dynamic search ads within the campaign.
type:
- "null"
- string
campaign.dynamic_search_ads_setting.language_code:
description: The language code associated with dynamic search ads.
type:
- "null"
- string
campaign.dynamic_search_ads_setting.use_supplied_urls_only:
description:
Flag indicating whether only supplied URLs are used for dynamic
search ads.
type:
- "null"
- boolean
campaign.end_date:
description: The end date of the campaign.
type:
- "null"
- string
campaign.excluded_parent_asset_field_types:
description: Types of parent asset fields excluded from the campaign.
type:
- "null"
- array
items:
type: string
campaign.experiment_type:
description: The type of experiment conducted for the campaign.
type:
- "null"
- string
campaign.final_url_suffix:
description: The final URL suffix used for tracking in the campaign.
type:
- "null"
- string
campaign.frequency_caps:
description: Caps on ad serving frequency for the campaign.
type:
- "null"
- array
items:
type: string
campaign.geo_target_type_setting.negative_geo_target_type:
description: The negative geo target type settings for the campaign.
type:
- "null"
- string
campaign.geo_target_type_setting.positive_geo_target_type:
description: The positive geo target type settings for the campaign.
type:
- "null"
- string
campaign.hotel_setting.hotel_center_id:
description: The hotel center ID associated with hotel campaigns.
type:
- "null"
- integer
campaign.id:
description: The unique identifier of the campaign.
type:
- "null"
- integer
campaign.labels:
description: Labels associated with the campaign.
type:
- "null"
- array
items:
type: string
campaign.local_campaign_setting.location_source_type:
description: The source type for location targeting in local campaigns.
type:
- "null"
- string
campaign.manual_cpc.enhanced_cpc_enabled:
description:
Indication of whether Enhanced CPC is enabled for manual CPC
campaigns.
type:
- "null"
- boolean
campaign.manual_cpm:
description: Manual CPM bidding used in the campaign.
type:
- "null"
- string
campaign.manual_cpv:
description: Manual CPV bidding used in the campaign.
type:
- "null"
- string
campaign.maximize_conversion_value.target_roas:
description: Target ROAS set for maximizing conversion value in the campaign.
type:
- "null"
- number
campaign.maximize_conversions.target_cpa_micros:
description: Target CPA in micros set for maximizing conversions in the campaign.
type:
- "null"
- integer
campaign.name:
description: The name of the campaign.
type:
- "null"
- string
campaign.network_settings.target_content_network:
description: Indication of targeting the content network in network settings.
type:
- "null"
- boolean
campaign.network_settings.target_google_search:
description: Indication of targeting Google Search in network settings.
type:
- "null"
- boolean
campaign.network_settings.target_partner_search_network:
description: Indication of targeting partner search network in network settings.
type:
- "null"
- boolean
campaign.network_settings.target_search_network:
description: Indication of targeting search network in network settings.
type:
- "null"
- boolean
campaign.optimization_goal_setting.optimization_goal_types:
description: Types of optimization goals set for the campaign.
type:
- "null"
- array
items:
type: string
campaign.optimization_score:
description: The optimization score of the campaign.
type:
- "null"
- number
campaign.payment_mode:
description: The payment mode chosen for the campaign.
type:
- "null"
- string
campaign.percent_cpc.cpc_bid_ceiling_micros:
description: The CPC bid ceiling in micros for percent CPC bidding.
type:
- "null"
- integer
campaign.percent_cpc.enhanced_cpc_enabled:
description: Indication of Enhanced CPC enabled for percent CPC bidding.
type:
- "null"
- boolean
campaign.real_time_bidding_setting.opt_in:
description: Opt-in status for real-time bidding within the campaign.
type:
- "null"
- boolean
campaign.resource_name:
description: The resource name of the campaign.
type:
- "null"
- string
campaign.selective_optimization.conversion_actions:
description:
Conversion actions selected for selective optimization within
the campaign.
type:
- "null"
- array
items:
type: string
campaign.serving_status:
description: The serving status of the campaign.
type:
- "null"
- string
campaign.shopping_setting.campaign_priority:
description: Campaign priority set for shopping campaigns.
type:
- "null"
- integer
campaign.shopping_setting.enable_local:
description: Flag indicating whether local shopping is enabled for the campaign.
type:
- "null"
- boolean
campaign.shopping_setting.merchant_id:
description: The merchant ID associated with shopping campaigns.
type:
- "null"
- integer
campaign.start_date:
description: The start date of the campaign.
type:
- "null"
- string
campaign.status:
description: The status of the campaign.
type:
- "null"
- string
campaign.target_cpa.cpc_bid_ceiling_micros:
description: The CPC bid ceiling in micros for target CPA bidding.
type:
- "null"
- integer
campaign.target_cpa.cpc_bid_floor_micros:
description: The CPC bid floor in micros for target CPA bidding.
type:
- "null"
- integer
campaign.target_cpa.target_cpa_micros:
description: The target CPA in micros for target CPA bidding.
type:
- "null"
- integer
campaign.target_cpm.target_frequency_goal.target_count:
description:
The target count set for target frequency goal in target CPM
bidding.
type:
- "null"
- integer
campaign.target_cpm.target_frequency_goal.time_unit:
description: The time unit set for target frequency goal in target CPM bidding.
type:
- "null"
- string
campaign.target_impression_share.cpc_bid_ceiling_micros:
description: The CPC bid ceiling in micros for target impression share bidding.
type:
- "null"
- integer
campaign.target_impression_share.location:
description: The location targeted for target impression share bidding.
type:
- "null"
- string
campaign.target_impression_share.location_fraction_micros:
description: The location fraction in micros for target impression share bidding.
type:
- "null"
- integer
campaign.target_roas.cpc_bid_ceiling_micros:
description: The CPC bid ceiling in micros for target ROAS bidding.
type:
- "null"
- integer
campaign.target_roas.cpc_bid_floor_micros:
description: The CPC bid floor in micros for target ROAS bidding.
type:
- "null"
- integer
campaign.target_roas.target_roas:
description: The target ROAS set for target ROAS bidding.
type:
- "null"
- number
campaign.target_spend.cpc_bid_ceiling_micros:
description: The CPC bid ceiling in micros for target spend bidding.
type:
- "null"
- integer
campaign.target_spend.target_spend_micros:
description: The target spend in micros for target spend bidding.
type:
- "null"
- integer
campaign.targeting_setting.target_restrictions:
description: Restrictions applied to targeting within the campaign.
type:
- "null"
- array
items:
type: string
campaign.tracking_setting.tracking_url:
description: The tracking URL set for campaign tracking.
type:
- "null"
- string
campaign.tracking_url_template:
description: The template for tracking URLs in the campaign.
type:
- "null"
- string
campaign.url_custom_parameters:
description: Custom parameters added to campaign URLs.
type:
- "null"
- array
items:
type: string
campaign.vanity_pharma.vanity_pharma_display_url_mode:
description: The display URL mode set for vanity pharma in the campaign.
type:
- "null"
- string
campaign.vanity_pharma.vanity_pharma_text:
description: The text used for vanity pharma in the campaign.
type:
- "null"
- string
campaign.video_brand_safety_suitability:
description:
The brand safety suitability settings for video ads within the
campaign.
type:
- "null"
- string
metrics.clicks:
description: Total number of clicks in the campaign.
type:
- "null"
- integer
metrics.ctr:
description: Click-through rate (CTR) metric for the campaign.
type:
- "null"
- number
metrics.conversions:
description: Total number of conversions in the campaign.
type:
- "null"
- number
metrics.conversions_value:
description: Total value of conversions in the campaign.
type:
- "null"
- number
metrics.cost_micros:
description: Total cost in micros incurred for the campaign.
type:
- "null"
- integer
metrics.impressions:
description: Total number of impressions for the campaign.
type:
- "null"
- integer
metrics.video_views:
description: Total number of video views in the campaign.
type:
- "null"
- integer
metrics.video_quartile_p100_rate:
description: Rate of viewers reaching the 100% quartile in video ads.
type:
- "null"
- number
metrics.active_view_cpm:
description: Active View CPM metric for the campaign.
type:
- "null"
- number
metrics.active_view_ctr:
description: Active View CTR metric for the campaign.
type:
- "null"
- number
metrics.active_view_impressions:
description: Number of active view impressions for the campaign.
type:
- "null"
- integer
metrics.active_view_measurability:
description: Active view measurability metric for the campaign.
type:
- "null"
- number
metrics.active_view_measurable_cost_micros:
description: Cost in micros for measurable active view impressions.
type:
- "null"
- integer
metrics.active_view_measurable_impressions:
description: Number of measurable active view impressions.
type:
- "null"
- integer
metrics.active_view_viewability:
description: Active view viewability metric for the campaign.
type:
- "null"
- number
metrics.average_cost:
description: Average cost metric for the campaign.
type:
- "null"
- number
metrics.average_cpc:
description: Average CPC metric for the campaign.
type:
- "null"
- number
metrics.average_cpm:
description: Average CPM metric for the campaign.
type:
- "null"
- number
metrics.interactions:
description: Total number of interactions in the campaign.
type:
- "null"
- integer
metrics.interaction_event_types:
description: Types of interaction events recorded in the campaign metrics.
type:
- "null"
- array
items:
type:
- "null"
- string
metrics.value_per_conversion:
description: Average value per conversion in the campaign.
type:
- "null"
- number
metrics.cost_per_conversion:
description: Cost per conversion metric for the campaign.
type:
- "null"
- number
segments.date:
description: Date segment used for campaign data.
type:
- "null"
- string
format: date
segments.hour:
description: Hour segment used for campaign data.
type:
- "null"
- integer
segments.ad_network_type:
description: The type of ad network used for segmentation.
type:
- "null"
- string
additionalProperties: true
campaign_criterion:
$schema: http://json-schema.org/schema#
type: object
properties:
deleted_at:
description: Timestamp indicating when the criterion was deleted.
type:
- "null"
- string
change_status.last_change_date_time:
description: The date and time of the last change made to the criterion.
type:
- "null"
- string
campaign.id:
description: The unique identifier for the campaign associated with the criterion.
type:
- "null"
- integer
campaign_criterion.resource_name:
description: The resource name of the criterion.
type:
- "null"
- string
campaign_criterion.campaign:
description: The specific campaign this criterion is targeting.
type:
- "null"
- string
campaign_criterion.age_range.type:
description: The age range targeting type for the criterion.
type:
- "null"
- string
campaign_criterion.mobile_application.name:
description: The name of the mobile application targeted by the criterion.
type:
- "null"
- string
campaign_criterion.negative:
description: Indicates whether the criterion is a negative targeting criterion.
type:
- "null"
- boolean
campaign_criterion.youtube_channel.channel_id:
description: The YouTube channel ID targeted by the criterion.
type:
- "null"
- string
campaign_criterion.youtube_video.video_id:
description: The YouTube video ID targeted by the criterion.
type:
- "null"
- string
additionalProperties: true
change_status:
$schema: http://json-schema.org/schema#
type: object
properties:
change_status.last_change_date_time:
description: The date and time when the last change was made.
type:
- "null"
- string
change_status.resource_type:
description: The type of the resource that was changed.
type:
- "null"
- string
change_status.resource_status:
description: The status of the resource after the change.
type:
- "null"
- string
change_status.resource_name:
description: The name of the resource that was changed.
type:
- "null"
- string
change_status.ad_group_criterion:
description: The status of the ad group criterion that was changed.
type:
- "null"
- string
change_status.campaign_criterion:
description: The status of the campaign criterion that was changed.
type:
- "null"
- string
additionalProperties: true
display_keyword_view:
$schema: http://json-schema.org/schema#
type: object
properties:
customer.currency_code:
description: The currency code of the customer
type:
- "null"
- string
customer.descriptive_name:
description: The descriptive name of the customer
type:
- "null"
- string
customer.time_zone:
description: The time zone of the customer
type:
- "null"
- string
metrics.active_view_cpm:
description: The active view CPM metric
type:
- "null"
- number
metrics.active_view_ctr:
description: The active view CTR metric
type:
- "null"
- number
metrics.active_view_impressions:
description: The number of active view impressions
type:
- "null"
- integer
metrics.active_view_measurability:
description: The measurability of active view impressions
type:
- "null"
- number
metrics.active_view_measurable_cost_micros:
description: The cost of meausurable active view impressions in micros
type:
- "null"
- integer
metrics.active_view_measurable_impressions:
description: The number of measurable active view impressions
type:
- "null"
- integer
metrics.active_view_viewability:
description: The viewability of active view impressions
type:
- "null"
- number
ad_group.id:
description: The ID of the ad group
type:
- "null"
- integer
ad_group.name:
description: The name of the ad group
type:
- "null"
- string
ad_group.status:
description: The status of the ad group
type:
- "null"
- string
segments.ad_network_type:
description: The type of ad network
type:
- "null"
- string
metrics.all_conversions_from_interactions_rate:
description: The rate of conversions from interactions
type:
- "null"
- number
metrics.all_conversions_value:
description: The total value of all conversions
type:
- "null"
- number
metrics.all_conversions:
description: The total number of conversions
type:
- "null"
- number
metrics.average_cost:
description: The average cost per click
type:
- "null"
- number
metrics.average_cpc:
description: The average cost per click
type:
- "null"
- number
metrics.average_cpe:
description: The average cost per engagement
type:
- "null"
- number
metrics.average_cpm:
description: The average cost per thousand impressions
type:
- "null"
- number
metrics.average_cpv:
description: The average cost per view
type:
- "null"
- number
ad_group.base_ad_group:
description: The base ad group associated with the keyword
type:
- "null"
- string
campaign.base_campaign:
description: The base campaign associated with the ad group
type:
- "null"
- string
campaign.bidding_strategy:
description: The bidding strategy of the campaign
type:
- "null"
- string
campaign.bidding_strategy_type:
description: The type of bidding strategy used for the campaign
type:
- "null"
- string
campaign.id:
description: The ID of the campaign
type:
- "null"
- integer
campaign.name:
description: The name of the campaign
type:
- "null"
- string
campaign.status:
description: The status of the campaign
type:
- "null"
- string
metrics.clicks:
description: The total number of clicks
type:
- "null"
- integer
metrics.conversions_from_interactions_rate:
description: The rate of conversions from interactions
type:
- "null"
- number
metrics.conversions_value:
description: The total value of conversions
type:
- "null"
- number
metrics.conversions:
description: The number of conversions
type:
- "null"
- number
metrics.cost_micros:
description: The total cost in micros
type:
- "null"
- integer
metrics.cost_per_all_conversions:
description: The cost per all conversions
type:
- "null"
- number
metrics.cost_per_conversion:
description: The cost per conversion
type:
- "null"
- number
ad_group_criterion.effective_cpc_bid_micros:
description: The effective CPC bid in micros for the criterion
type:
- "null"
- integer
ad_group_criterion.effective_cpc_bid_source:
description: The source of the effective CPC bid
type:
- "null"
- string
ad_group_criterion.effective_cpm_bid_micros:
description: The effective CPM bid in micros for the criterion
type:
- "null"
- integer
ad_group_criterion.effective_cpm_bid_source:
description: The source of the effective CPM bid
type:
- "null"
- string
ad_group_criterion.effective_cpv_bid_micros:
description: The effective CPV bid in micros for the criterion
type:
- "null"
- integer
ad_group_criterion.effective_cpv_bid_source:
description: The source of the effective CPV bid
type:
- "null"
- string
ad_group_criterion.keyword.text:
description: The text of the keyword
type:
- "null"
- string
metrics.cross_device_conversions:
description: The number of cross-device conversions
type:
- "null"
- number
metrics.ctr:
description: The click-through rate
type:
- "null"
- number
segments.day_of_week:
description: The day of the week segment
type:
- "null"
- string
segments.device:
description: The device segment
type:
- "null"
- string
metrics.engagement_rate:
description: The engagement rate
type:
- "null"
- number
metrics.engagements:
description: The total number of engagements
type:
- "null"
- integer
customer.id:
description: The ID of the customer
type:
- "null"
- integer
ad_group_criterion.final_mobile_urls:
description: The final mobile URLs for the criterion
type:
- "null"
- array
items:
type:
- "null"
- string
ad_group_criterion.final_urls:
description: The final URLs for the criterion
type:
- "null"
- array
items:
type:
- "null"
- string
metrics.gmail_forwards:
description: The number of Gmail forwards
type:
- "null"
- integer
metrics.gmail_saves:
description: The number of Gmail saves
type:
- "null"
- integer
metrics.gmail_secondary_clicks:
description: The number of secondary clicks on Gmail ads
type:
- "null"
- integer
ad_group_criterion.criterion_id:
description: The ID of the criterion
type:
- "null"
- integer
metrics.impressions:
description: The total number of impressions
type:
- "null"
- integer
metrics.interaction_rate:
description: The interaction rate
type:
- "null"
- number
metrics.interaction_event_types:
description: The types of interaction events
type:
- "null"
- array
items:
type: string
metrics.interactions:
description: The total number of interactions
type:
- "null"
- integer
ad_group_criterion.negative:
description: Indicates if the criterion is a negative keyword
type:
- "null"
- boolean
ad_group.targeting_setting.target_restrictions:
description: The target restrictions applied to the ad group
type:
- "null"
- array
items:
type: string
segments.month:
description: The month segment
type:
- "null"
- string
segments.quarter:
description: The quarter segment
type:
- "null"
- string
ad_group_criterion.status:
description: The status of the criterion
type:
- "null"
- string
ad_group_criterion.tracking_url_template:
description: The tracking URL template for the criterion
type:
- "null"
- string
ad_group_criterion.keyword.match_type:
description: The match type of the keyword
type:
- "null"
- string
ad_group_criterion.url_custom_parameters:
description: The custom parameters for the criterion
type:
- "null"
- array
items:
type: string
metrics.value_per_all_conversions:
description: The value per all conversions
type:
- "null"
- number
metrics.value_per_conversion:
description: The value per conversion
type:
- "null"
- number
metrics.video_quartile_p100_rate:
description: The quartile p100 rate for video views
type:
- "null"
- number
metrics.video_quartile_p25_rate:
description: The quartile p25 rate for video views
type:
- "null"
- number
metrics.video_quartile_p50_rate:
description: The quartile p50 rate for video views
type:
- "null"
- number
metrics.video_quartile_p75_rate:
description: The quartile p75 rate for video views
type:
- "null"
- number
metrics.video_view_rate:
description: The video view rate
type:
- "null"
- number
metrics.video_views:
description: The total number of video views
type:
- "null"
- integer
metrics.view_through_conversions:
description: The number of view-through conversions
type:
- "null"
- integer
segments.week:
description: The week segment
type:
- "null"
- string
segments.year:
description: The year segment
type:
- "null"
- integer
segments.date:
description: The date segment
type:
- "null"
- string
format: date
additionalProperties: true
geographic_view:
$schema: http://json-schema.org/schema#
type: object
properties:
customer.id:
description: The ID of the customer associated with the geographic view data
type:
- "null"
- integer
customer.descriptive_name:
description:
The descriptive name of the customer associated with the geographic
view data
type:
- "null"
- string
geographic_view.country_criterion_id:
description: The criterion ID for the country in the geographic view data
type:
- "null"
- integer
geographic_view.location_type:
description:
The type of location (such as city or region) in the geographic
view data
type:
- "null"
- string
ad_group.id:
description: The ID of the ad group associated with the geographic view data
type:
- "null"
- integer
segments.date:
description: The date segment within the geographic view data
type:
- "null"
- string
format: date
additionalProperties: true
keyword_view:
$schema: http://json-schema.org/schema#
type: object
properties:
customer.id:
description: The unique ID of the customer.
type:
- "null"
- integer
customer.descriptive_name:
description: The name or description of the customer.
type:
- "null"
- string
campaign.id:
description: The ID of the campaign the keyword belongs to.
type:
- "null"
- integer
ad_group.id:
description: The ID of the ad group the keyword belongs to.
type:
- "null"
- integer
ad_group_criterion.type:
description: The type of the ad group criterion (e.g., keyword, placement).
type:
- "null"
- string
ad_group_criterion.keyword.text:
description: The actual text of the keyword.
type:
- "null"
- string
ad_group_criterion.negative:
description: Specifies whether the keyword is a negative keyword.
type:
- "null"
- boolean
ad_group_criterion.keyword.match_type:
description: The match type of the keyword (e.g., exact, broad, phrase).
type:
- "null"
- string
metrics.historical_quality_score:
description: The historical quality score of the keyword.
type:
- "null"
- integer
metrics.ctr:
description:
The click-through rate (clicks divided by impressions) for the
keyword.
type:
- "null"
- number
segments.date:
description: The date when the data was recorded.
type:
- "null"
- string
format: date
campaign.bidding_strategy_type:
description: The type of bidding strategy used for the campaign.
type:
- "null"
- string
metrics.clicks:
description: The number of clicks on the keyword.
type:
- "null"
- integer
metrics.cost_micros:
description: The cost of the keyword advertising in micros.
type:
- "null"
- integer
metrics.impressions:
description: The number of times the keyword was displayed.
type:
- "null"
- integer
metrics.active_view_impressions:
description: The number of viewable impressions.
type:
- "null"
- integer
metrics.active_view_measurability:
description:
The ratio of viewable impressions to the number of measurable
impressions.
type:
- "null"
- number
metrics.active_view_measurable_cost_micros:
description: The cost for measurable viewable impressions in micros.
type:
- "null"
- integer
metrics.active_view_measurable_impressions:
description: The number of impressions that were measurable for viewability.
type:
- "null"
- integer
metrics.active_view_viewability:
description: The ratio of viewable impressions to measurable impressions.
type:
- "null"
- number
metrics.conversions:
description: The number of conversions attributed to the keyword.
type:
- "null"
- number
metrics.conversions_value:
description: The total value of conversions attributed to the keyword.
type:
- "null"
- number
metrics.interactions:
description:
The total number of interactions (clicks, video views, etc.)
on the keyword.
type:
- "null"
- integer
metrics.interaction_event_types:
description: The types of interactions that occurred (e.g., click, video view).
type:
- "null"
- array
items:
description: A specific type of interaction (e.g., click).
type:
- "null"
- string
metrics.view_through_conversions:
description:
The number of conversions that occurred after a view of the ad
without a click.
type:
- "null"
- integer
ad_group_criterion.criterion_id:
description: The unique ID of the ad group criterion.
type:
- "null"
- integer
additionalProperties: true
shopping_performance_view:
$schema: http://json-schema.org/schema#
type: object
properties:
customer.descriptive_name:
description: The descriptive name of the customer account.
type:
- "null"
- string
ad_group.id:
description: The ID of the ad group associated with the data.
type:
- "null"
- integer
ad_group.name:
description: The name of the ad group associated with the data.
type:
- "null"
- string
ad_group.status:
description: The status of the ad group.
type:
- "null"
- string
segments.ad_network_type:
description: The type of ad network.
type:
- "null"
- string
segments.product_aggregator_id:
description: The ID of the product aggregator.
type:
- "null"
- integer
metrics.all_conversions_from_interactions_rate:
description: The rate of conversions from interactions.
type:
- "null"
- number
metrics.all_conversions_value:
description: The total value of all conversions.
type:
- "null"
- number
metrics.all_conversions:
description: The total number of conversions.
type:
- "null"
- number
metrics.average_cpc:
description: The average cost per click.
type:
- "null"
- number
segments.product_brand:
description: The brand of the product.
type:
- "null"
- string
campaign.id:
description: The ID of the campaign associated with the data.
type:
- "null"
- integer
campaign.name:
description: The name of the campaign associated with the data.
type:
- "null"
- string
campaign.status:
description: The status of the campaign.
type:
- "null"
- string
segments.product_category_level1:
description: The first level product category.
type:
- "null"
- string
segments.product_category_level2:
description: The second level product category.
type:
- "null"
- string
segments.product_category_level3:
description: The third level product category.
type:
- "null"
- string
segments.product_category_level4:
description: The fourth level product category.
type:
- "null"
- string
segments.product_category_level5:
description: The fifth level product category.
type:
- "null"
- string
segments.product_channel:
description: The product channel.
type:
- "null"
- string
segments.product_channel_exclusivity:
description: The product channel exclusivity.
type:
- "null"
- string
segments.click_type:
description: The type of click.
type:
- "null"
- string
metrics.clicks:
description: The total number of clicks.
type:
- "null"
- integer
metrics.conversions_from_interactions_rate:
description: The rate of conversions from interactions.
type:
- "null"
- number
metrics.conversions_value:
description: The total value of conversions.
type:
- "null"
- number
metrics.conversions:
description: The total number of conversions.
type:
- "null"
- number
metrics.cost_micros:
description: The cost in micros.
type:
- "null"
- integer
metrics.cost_per_all_conversions:
description: The cost per all conversions.
type:
- "null"
- number
metrics.cost_per_conversion:
description: The cost per conversion.
type:
- "null"
- number
segments.product_country:
description: The country of the product.
type:
- "null"
- string
metrics.cross_device_conversions:
description: The number of cross-device conversions.
type:
- "null"
- number
metrics.ctr:
description: The click-through rate.
type:
- "null"
- number
segments.product_custom_attribute0:
description: Custom attribute 0 of the product.
type:
- "null"
- string
segments.product_custom_attribute1:
description: Custom attribute 1 of the product.
type:
- "null"
- string
segments.product_custom_attribute2:
description: Custom attribute 2 of the product.
type:
- "null"
- string
segments.product_custom_attribute3:
description: Custom attribute 3 of the product.
type:
- "null"
- string
segments.product_custom_attribute4:
description: Custom attribute 4 of the product.
type:
- "null"
- string
segments.date:
description: The date of the data entry.
type:
- "null"
- string
format: date
segments.day_of_week:
description: The day of the week.
type:
- "null"
- string
segments.device:
description: The type of device.
type:
- "null"
- string
customer.id:
description: The ID of the customer account.
type:
- "null"
- integer
metrics.impressions:
description: The total number of impressions.
type:
- "null"
- integer
segments.product_language:
description: The language of the product.
type:
- "null"
- string
segments.product_merchant_id:
description: The ID of the product merchant.
type:
- "null"
- integer
segments.month:
description: The month.
type:
- "null"
- string
segments.product_item_id:
description: The ID of the product item.
type:
- "null"
- string
segments.product_condition:
description: The condition of the product.
type:
- "null"
- string
segments.product_title:
description: The title of the product.
type:
- "null"
- string
segments.product_type_l1:
description: Product type level 1.
type:
- "null"
- string
segments.product_type_l2:
description: Product type level 2.
type:
- "null"
- string
segments.product_type_l3:
description: Product type level 3.
type:
- "null"
- string
segments.product_type_l4:
description: Product type level 4.
type:
- "null"
- string
segments.product_type_l5:
description: Product type level 5.
type:
- "null"
- string
segments.quarter:
description: The quarter.
type:
- "null"
- string
segments.product_store_id:
description: The ID of the product store.
type:
- "null"
- string
metrics.value_per_all_conversions:
description: The value per all conversions.
type:
- "null"
- number
metrics.value_per_conversion:
description: The value per conversion.
type:
- "null"
- number
segments.week:
description: The week.
type:
- "null"
- string
segments.year:
description: The year.
type:
- "null"
- integer
additionalProperties: true
topic_view:
$schema: http://json-schema.org/schema#
type: object
properties:
topic_view.resource_name:
description: The resource name of the topic view.
type:
- "null"
- string
customer.currency_code:
description: The currency code of the customer associated with the topic view.
type:
- "null"
- string
customer.descriptive_name:
description:
The descriptive name of the customer associated with the topic
view.
type:
- "null"
- string
customer.time_zone:
description: The time zone of the customer associated with the topic view.
type:
- "null"
- string
metrics.active_view_cpm:
description: The active view CPM metric.
type:
- "null"
- number
metrics.active_view_ctr:
description: The active view click-through rate metric.
type:
- "null"
- number
metrics.active_view_impressions:
description: The number of active view impressions metric.
type:
- "null"
- integer
metrics.active_view_measurability:
description: The active view measurability metric.
type:
- "null"
- number
metrics.active_view_measurable_cost_micros:
description: The cost of measurable active view impressions in micros.
type:
- "null"
- integer
metrics.active_view_measurable_impressions:
description: The number of measurable active view impressions metric.
type:
- "null"
- integer
metrics.active_view_viewability:
description: The active view viewability metric.
type:
- "null"
- number
ad_group.id:
description: The ID of the ad group associated with the topic view.
type:
- "null"
- integer
ad_group.name:
description: The name of the ad group associated with the topic view.
type:
- "null"
- string
ad_group.status:
description: The status of the ad group associated with the topic view.
type:
- "null"
- string
segments.ad_network_type:
description: The type of ad network segment.
type:
- "null"
- string
metrics.all_conversions_from_interactions_rate:
description: The rate of all conversions from interactions metric.
type:
- "null"
- number
metrics.all_conversions_value:
description: The value of all conversions metric.
type:
- "null"
- number
metrics.all_conversions:
description: The total number of all conversions metric.
type:
- "null"
- number
metrics.average_cost:
description: The average cost metric.
type:
- "null"
- number
metrics.average_cpc:
description: The average CPC (Cost Per Click) metric.
type:
- "null"
- number
metrics.average_cpe:
description: The average CPE (Cost Per Engagement) metric.
type:
- "null"
- number
metrics.average_cpm:
description: The average CPM (Cost Per Thousand Impressions) metric.
type:
- "null"
- number
metrics.average_cpv:
description: The average CPV (Cost Per View) metric.
type:
- "null"
- number
ad_group.base_ad_group:
description: The base ad group associated with the topic view.
type:
- "null"
- string
campaign.base_campaign:
description: The base campaign associated with the topic view.
type:
- "null"
- string
ad_group_criterion.bid_modifier:
description: The bid modifier for the ad group criterion in the topic view.
type:
- "null"
- number
campaign.bidding_strategy:
description: The bidding strategy set for the campaign in the topic view.
type:
- "null"
- string
campaign.bidding_strategy_type:
description:
The type of bidding strategy used for the campaign in the topic
view.
type:
- "null"
- string
campaign.id:
description: The ID of the campaign associated with the topic view.
type:
- "null"
- integer
campaign.name:
description: The name of the campaign associated with the topic view.
type:
- "null"
- string
campaign.status:
description: The status of the campaign associated with the topic view.
type:
- "null"
- string
metrics.clicks:
description: The total number of clicks metric.
type:
- "null"
- integer
metrics.conversions_from_interactions_rate:
description: The rate of conversions from interactions metric.
type:
- "null"
- number
metrics.conversions_value:
description: The value of conversions metric.
type:
- "null"
- number
metrics.conversions:
description: The total number of conversions metric.
type:
- "null"
- number
metrics.cost_micros:
description: The total cost in micros metric.
type:
- "null"
- integer
metrics.cost_per_all_conversions:
description: The cost per all conversions metric.
type:
- "null"
- number
metrics.cost_per_conversion:
description: The cost per conversion metric.
type:
- "null"
- number
ad_group_criterion.effective_cpc_bid_micros:
description: The effective CPC bid amount for the ad group criterion in micros.
type:
- "null"
- integer
ad_group_criterion.effective_cpc_bid_source:
description: The source of the effective CPC bid for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.effective_cpm_bid_micros:
description: The effective CPM bid amount for the ad group criterion in micros.
type:
- "null"
- integer
ad_group_criterion.effective_cpm_bid_source:
description: The source of the effective CPM bid for the ad group criterion.
type:
- "null"
- string
ad_group_criterion.topic.path:
description: The path of the topic targeted in the ad group criterion.
type:
- "null"
- array
items:
type: string
metrics.cross_device_conversions:
description: The number of cross-device conversions metric.
type:
- "null"
- number
metrics.ctr:
description: The click-through rate metric.
type:
- "null"
- number
segments.date:
description: The date segment.
type:
- "null"
- string
format: date
segments.day_of_week:
description: The day of the week segment.
type:
- "null"
- string
segments.device:
description: The device segment.
type:
- "null"
- string
metrics.engagement_rate:
description: The engagement rate metric.
type:
- "null"
- number
metrics.engagements:
description: The total number of engagements metric.
type:
- "null"
- integer
customer.id:
description: The ID of the customer associated with the topic view.
type:
- "null"
- integer
ad_group_criterion.final_mobile_urls:
description:
The final mobile URLs set for the ad group criterion in the topic
view.
type:
- "null"
- array
items:
type: string
ad_group_criterion.final_urls:
description: The final URLs set for the ad group criterion in the topic view.
type:
- "null"
- array
items:
type:
- "null"
- string
metrics.gmail_forwards:
description: The number of Gmail forwards metric.
type:
- "null"
- integer
metrics.gmail_saves:
description: The number of Gmail saves metric.
type:
- "null"
- integer
metrics.gmail_secondary_clicks:
description: The number of Gmail secondary clicks metric.
type:
- "null"
- integer
ad_group_criterion.criterion_id:
description: The criterion ID of the ad group criterion in the topic view.
type:
- "null"
- integer
metrics.impressions:
description: The total number of impressions metric.
type:
- "null"
- integer
metrics.interaction_rate:
description: The interaction rate metric.
type:
- "null"
- number
metrics.interaction_event_types:
description: The types of interaction events that occurred.
type:
- "null"
- array
items:
type: string
metrics.interactions:
description: The total number of interactions metric.
type:
- "null"
- integer
ad_group_criterion.negative:
description: Indicates if the ad group criterion is a negative target or not.
type:
- "null"
- boolean
ad_group.targeting_setting.target_restrictions:
description:
The target restrictions set for the ad group associated with
the topic view.
type:
- "null"
- array
items:
type: string
segments.month:
description: The month segment.
type:
- "null"
- string
segments.quarter:
description: The quarter segment.
type:
- "null"
- string
ad_group_criterion.status:
description: The status of the ad group criterion in the topic view.
type:
- "null"
- string
ad_group_criterion.tracking_url_template:
description:
The tracking URL template set for the ad group criterion in the
topic view.
type:
- "null"
- string
ad_group_criterion.url_custom_parameters:
description:
The custom parameters set for the ad group criterion in the topic
view.
type:
- "null"
- array
items:
type: string
metrics.value_per_all_conversions:
description: The value per all conversions metric.
type:
- "null"
- number
metrics.value_per_conversion:
description: The value per conversion metric.
type:
- "null"
- number
ad_group_criterion.topic.topic_constant:
description:
The constant representing the targeted topic in the ad group
criterion.
type:
- "null"
- string
metrics.video_quartile_p100_rate:
description: The quartile P100 rate for video metrics.
type:
- "null"
- number
metrics.video_quartile_p25_rate:
description: The quartile P25 rate for video metrics.
type:
- "null"
- number
metrics.video_quartile_p50_rate:
description: The quartile P50 rate for video metrics.
type:
- "null"
- number
metrics.video_quartile_p75_rate:
description: The quartile P75 rate for video metrics.
type:
- "null"
- number
metrics.video_view_rate:
description: The video view rate metric.
type:
- "null"
- number
metrics.video_views:
description: The total number of video views metric.
type:
- "null"
- integer
metrics.view_through_conversions:
description: The number of view-through conversions metric.
type:
- "null"
- integer
segments.week:
description: The week segment.
type:
- "null"
- string
segments.year:
description: The year segment.
type:
- "null"
- integer
additionalProperties: true
user_location_view:
$schema: http://json-schema.org/schema#
type: object
properties:
segments.date:
description: The date related to the user location view data.
type:
- "null"
- string
format: date
segments.day_of_week:
description: The day of the week.
type:
- "null"
- string
segments.month:
description: The month.
type:
- "null"
- string
segments.week:
description: The week of the year.
type:
- "null"
- string
segments.quarter:
description: The quarter of the year.
type:
- "null"
- string
segments.year:
description: The year.
type:
- "null"
- integer
segments.ad_network_type:
description: The type of ad network.
type:
- "null"
- string
customer.currency_code:
description: The currency code used by the customer.
type:
- "null"
- string
customer.id:
description: The ID of the customer.
type:
- "null"
- integer
customer.descriptive_name:
description: The descriptive name of the customer.
type:
- "null"
- string
customer.time_zone:
description: The time zone set for the customer.
type:
- "null"
- string
user_location_view.country_criterion_id:
description: The country criterion ID for the user location.
type:
- "null"
- integer
user_location_view.targeting_location:
description: The targeted location for the user location view.
type:
- "null"
- boolean
user_location_view.resource_name:
description: The resource name associated with the user location view.
type:
- "null"
- string
campaign.base_campaign:
description:
The base campaign information tied to the user location view
data.
type:
- "null"
- string
campaign.id:
description: The ID of the campaign linked to the user location view data.
type:
- "null"
- integer
campaign.name:
description:
The name of the campaign associated with the user location view
data.
type:
- "null"
- string
campaign.status:
description:
The status of the campaign related to the user location view
data.
type:
- "null"
- string
ad_group.name:
description:
The name of the ad group associated with the user location view
data.
type:
- "null"
- string
ad_group.status:
description:
The status of the ad group related to the user location view
data.
type:
- "null"
- string
ad_group.base_ad_group:
description:
The base ad group information related to the user location view
data.
type:
- "null"
- string
metrics.all_conversions:
description: Total number of conversions for all actions.
type:
- "null"
- number
metrics.all_conversions_from_interactions_rate:
description: The rate of all conversions from interactions.
type:
- "null"
- number
metrics.all_conversions_value:
description: The total value of all conversions.
type:
- "null"
- number
metrics.average_cost:
description: The average cost of all clicks.
type:
- "null"
- number
metrics.average_cpc:
description: The average cost per click.
type:
- "null"
- number
metrics.average_cpm:
description: The average cost per thousand impressions.
type:
- "null"
- number
metrics.average_cpv:
description: The average cost per view.
type:
- "null"
- number
metrics.clicks:
description: Total number of clicks.
type:
- "null"
- integer
metrics.conversions:
description: Total number of conversions.
type:
- "null"
- number
metrics.conversions_from_interactions_rate:
description: The rate of conversions from interactions.
type:
- "null"
- number
metrics.conversions_value:
description: The total value of conversions.
type:
- "null"
- number
metrics.cost_micros:
description: The cost in micros (millionths of the currency).
type:
- "null"
- integer
metrics.cost_per_all_conversions:
description: Cost per all conversions.
type:
- "null"
- number
metrics.cost_per_conversion:
description: Cost per conversion.
type:
- "null"
- number
metrics.cross_device_conversions:
description: Total number of cross-device conversions.
type:
- "null"
- number
metrics.ctr:
description: Click-through rate.
type:
- "null"
- number
metrics.impressions:
description: Total number of times the ad was shown.
type:
- "null"
- integer
metrics.interaction_event_types:
description: Types of interaction events.
type:
- "null"
- array
items:
description: Specific interaction event type.
type:
- "null"
- string
metrics.interaction_rate:
description: The rate of interactions.
type:
- "null"
- number
metrics.interactions:
description: Total number of interactions.
type:
- "null"
- integer
metrics.value_per_all_conversions:
description: Value per all conversions.
type:
- "null"
- number
metrics.value_per_conversion:
description: Value per conversion.
type:
- "null"
- number
metrics.video_view_rate:
description: The rate of video views.
type:
- "null"
- number
metrics.video_views:
description: Total number of video views.
type:
- "null"
- integer
metrics.view_through_conversions:
description: Total number of view-through conversions.
type:
- "null"
- integer
additionalProperties: true
customer:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
customer.auto_tagging_enabled:
description: Indicates whether auto-tagging is enabled for the customer
type:
- "null"
- boolean
customer.call_reporting_setting.call_conversion_action:
description:
The call conversion action associated with the customer's call reporting
setting
type:
- "null"
- string
customer.call_reporting_setting.call_conversion_reporting_enabled:
description: Indicates whether call conversion reporting is enabled
type:
- "null"
- boolean
customer.call_reporting_setting.call_reporting_enabled:
description: Indicates whether call reporting is enabled for the customer
type:
- "null"
- boolean
customer.conversion_tracking_setting.conversion_tracking_id:
description: The conversion tracking ID set for the customer
type:
- "null"
- integer
customer.conversion_tracking_setting.cross_account_conversion_tracking_id:
description: The cross-account conversion tracking ID set for the customer
type:
- "null"
- integer
customer.currency_code:
description: The currency code used for the customer
type:
- "null"
- string
customer.descriptive_name:
description: The descriptive name of the customer account
type:
- "null"
- string
customer.final_url_suffix:
description: The final URL suffix for the customer
type:
- "null"
- string
customer.has_partners_badge:
description: Indicates whether the customer has a partners badge
type:
- "null"
- boolean
customer.id:
description: The unique identifier of the customer
type:
- "null"
- integer
customer.manager:
description: The manager associated with the customer
type:
- "null"
- boolean
customer.optimization_score:
description: The optimization score of the customer
type:
- "null"
- number
customer.optimization_score_weight:
description: The weight of the optimization score for the customer
type:
- "null"
- number
customer.pay_per_conversion_eligibility_failure_reasons:
description: The reasons for pay per conversion eligibility failure
type:
- "null"
- array
items:
description: Reason for pay per conversion eligibility failure
type: string
customer.remarketing_setting.google_global_site_tag:
description: The Google global site tag set for customer's remarketing
type:
- "null"
- string
customer.resource_name:
description: The resource name of the customer
type:
- "null"
- string
customer.test_account:
description: Indicates whether the customer account is a test account
type:
- "null"
- boolean
customer.time_zone:
description: The time zone set for the customer account
type:
- "null"
- string
customer.tracking_url_template:
description: The tracking URL template for the customer
type:
- "null"
- string
segments.date:
description: The date segment format
type:
- "null"
- string
format: date
campaign_budget:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
customer.id:
description: The ID of the customer associated with the campaign budget.
type:
- "null"
- integer
campaign.id:
description: The ID of the campaign associated with the campaign budget.
type:
- "null"
- integer
campaign_budget.aligned_bidding_strategy_id:
description: The ID of the bidding strategy aligned with the campaign budget.
type:
- "null"
- integer
campaign_budget.amount_micros:
description:
The amount in micros (millionths of the currency unit) for the campaign
budget.
type:
- "null"
- integer
campaign_budget.delivery_method:
description: The delivery method of the campaign budget (ACCELERATED or STANDARD).
type:
- "null"
- string
campaign_budget.explicitly_shared:
description:
Indicates whether the budget is explicitly shared among multiple
campaigns.
type:
- "null"
- boolean
campaign_budget.has_recommended_budget:
description: Indicates if there is a recommended budget for the campaign budget.
type:
- "null"
- boolean
campaign_budget.id:
description: The ID of the campaign budget.
type:
- "null"
- integer
campaign_budget.name:
description: The name of the campaign budget.
type:
- "null"
- string
campaign_budget.period:
description: The time period covered by the campaign budget.
type:
- "null"
- string
campaign_budget.recommended_budget_amount_micros:
description: The recommended amount in micros for the campaign budget.
type:
- "null"
- integer
campaign_budget.recommended_budget_estimated_change_weekly_clicks:
description: Estimated change in weekly clicks if recommended budget is applied.
type:
- "null"
- integer
campaign_budget.recommended_budget_estimated_change_weekly_cost_micros:
description:
Estimated change in weekly cost in micros if recommended budget is
applied.
type:
- "null"
- integer
campaign_budget.recommended_budget_estimated_change_weekly_interactions:
description:
Estimated change in weekly interactions if recommended budget is
applied.
type:
- "null"
- integer
campaign_budget.recommended_budget_estimated_change_weekly_views:
description: Estimated change in weekly views if recommended budget is applied.
type:
- "null"
- integer
campaign_budget.reference_count:
description: The count of references to the campaign budget.
type:
- "null"
- integer
campaign_budget.resource_name:
description: The resource name of the campaign budget.
type:
- "null"
- string
campaign_budget.status:
description: The status of the campaign budget.
type:
- "null"
- string
campaign_budget.total_amount_micros:
description: The total amount in micros of the campaign budget.
type:
- "null"
- integer
campaign_budget.type:
description: The type of the campaign budget.
type:
- "null"
- string
segments.date:
description: Date segment used for filtering data.
type:
- "null"
- string
format: date
segments.budget_campaign_association_status.campaign:
description: The campaign associated with the budget and its status.
type:
- "null"
- string
segments.budget_campaign_association_status.status:
description: The status of the budget association with the campaign.
type:
- "null"
- string
metrics.all_conversions:
description: The total number of conversions for all conversion actions.
type:
- "null"
- number
metrics.all_conversions_from_interactions_rate:
description: The rate of conversions from interactions out of all interactions.
type:
- "null"
- number
metrics.all_conversions_value:
description: The total value of all conversions.
type:
- "null"
- number
metrics.average_cost:
description: The average cost of interactions for the campaign.
type:
- "null"
- number
metrics.average_cpc:
description: The average cost per click for the campaign.
type:
- "null"
- number
metrics.average_cpe:
description: The average cost per engagement for the campaign.
type:
- "null"
- number
metrics.average_cpm:
description: The average cost per thousand impressions for the campaign.
type:
- "null"
- number
metrics.average_cpv:
description: The average cost per view for the campaign.
type:
- "null"
- number
metrics.clicks:
description: The total number of clicks on the campaign.
type:
- "null"
- integer
metrics.conversions:
description: The total number of conversions for the campaign.
type:
- "null"
- number
metrics.conversions_from_interactions_rate:
description: The rate of conversions out of all interactions.
type:
- "null"
- number
metrics.conversions_value:
description: The total value of conversions for the campaign.
type:
- "null"
- number
metrics.cost_micros:
description: The total cost in micros for the campaign.
type:
- "null"
- integer
metrics.cost_per_all_conversions:
description: The cost per all conversions for the campaign.
type:
- "null"
- number
metrics.cost_per_conversion:
description: The cost per conversion for the campaign.
type:
- "null"
- number
metrics.cross_device_conversions:
description: The total number of cross-device conversions for the campaign.
type:
- "null"
- number
metrics.ctr:
description: The click-through rate for the campaign.
type:
- "null"
- number
metrics.engagement_rate:
description: The engagement rate for the campaign.
type:
- "null"
- number
metrics.engagements:
description: The total number of engagements for the campaign.
type:
- "null"
- integer
metrics.impressions:
description: The total number of impressions for the campaign.
type:
- "null"
- integer
metrics.interaction_event_types:
description: Types of interactions tracked for the campaign.
type:
- "null"
- array
items:
type:
- "null"
- string
metrics.interaction_rate:
description: The interaction rate for the campaign.
type:
- "null"
- number
metrics.interactions:
description: The total number of interactions for the campaign.
type:
- "null"
- integer
metrics.value_per_all_conversions:
description: The value per all conversions for the campaign.
type:
- "null"
- number
metrics.value_per_conversion:
description: The value per conversion for the campaign.
type:
- "null"
- number
metrics.video_view_rate:
description: The view rate for video ads in the campaign.
type:
- "null"
- number
metrics.video_views:
description: The total number of video views for the campaign.
type:
- "null"
- integer
metrics.view_through_conversions:
description: The total number of view-through conversions for the campaign.
type:
- "null"
- integer
account_performance_report:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
customer.currency_code:
description: The currency code used for the customer's account
type:
- "null"
- string
customer.descriptive_name:
description: The descriptive name assigned to the customer account
type:
- "null"
- string
customer.time_zone:
description: The time zone setting for the customer account
type:
- "null"
- string
metrics.active_view_cpm:
description: Cost per thousand active viewable impressions
type:
- "null"
- number
metrics.active_view_ctr:
description: Active view click-through rate
type:
- "null"
- number
metrics.active_view_impressions:
description: Number of active view viewable impressions
type:
- "null"
- integer
metrics.active_view_measurability:
description: Active view measurability percentage
type:
- "null"
- number
metrics.active_view_measurable_cost_micros:
description: Cost for active view measurable impressions
type:
- "null"
- integer
metrics.active_view_measurable_impressions:
description: Number of active view measurable impressions
type:
- "null"
- integer
metrics.active_view_viewability:
description: Active view viewability percentage
type:
- "null"
- number
segments.ad_network_type:
description: Type of ad network
type:
- "null"
- string
metrics.all_conversions_from_interactions_rate:
description: Rate of conversions from interactions
type:
- "null"
- number
metrics.all_conversions_value:
description: Total value of all conversions
type:
- "null"
- number
metrics.all_conversions:
description: Total number of conversions
type:
- "null"
- number
metrics.average_cost:
description: Average cost per click
type:
- "null"
- number
metrics.average_cpc:
description: Average cost per click
type:
- "null"
- number
metrics.average_cpe:
description: Average cost per engagement
type:
- "null"
- number
metrics.average_cpm:
description: Average cost per thousand impressions
type:
- "null"
- number
metrics.average_cpv:
description: Average cost per view
type:
- "null"
- number
customer.manager:
description: The manager assigned to the customer account
type:
- "null"
- boolean
metrics.clicks:
description: Total number of clicks
type:
- "null"
- integer
metrics.content_budget_lost_impression_share:
description: Percentage of budget lost due to content network impressions
type:
- "null"
- number
metrics.content_impression_share:
description: Impression share on the content network
type:
- "null"
- number
metrics.content_rank_lost_impression_share:
description: Percentage of rank lost due to content network impressions
type:
- "null"
- number
metrics.conversions_from_interactions_rate:
description: Rate of conversions from interactions
type:
- "null"
- number
metrics.conversions_value:
description: Total value of conversions
type:
- "null"
- number
metrics.conversions:
description: Total number of conversions
type:
- "null"
- number
metrics.cost_micros:
description: Total cost in micros
type:
- "null"
- integer
metrics.cost_per_all_conversions:
description: Cost per all conversions
type:
- "null"
- number
metrics.cost_per_conversion:
description: Cost per conversion
type:
- "null"
- number
metrics.cross_device_conversions:
description: Conversions that involve more than one device
type:
- "null"
- number
metrics.ctr:
description: Click-through rate
type:
- "null"
- number
segments.date:
description: Date of the data entry
type:
- "null"
- string
format: date
segments.day_of_week:
description: Day of the week
type:
- "null"
- string
segments.device:
description: Type of device
type:
- "null"
- string
metrics.engagement_rate:
description: Rate of engagements
type:
- "null"
- number
metrics.engagements:
description: Total number of engagements
type:
- "null"
- integer
customer.id:
description: The unique identifier for the customer account
type:
- "null"
- integer
metrics.impressions:
description: Total number of impressions
type:
- "null"
- integer
metrics.interaction_rate:
description: Rate of interactions
type:
- "null"
- number
metrics.interaction_event_types:
description: Types of interaction events
type:
- "null"
- array
items:
description: Specific interaction event type
type: string
metrics.interactions:
description: Total number of interactions
type:
- "null"
- integer
customer.auto_tagging_enabled:
description: Indicates whether auto tagging is enabled for the customer
type:
- "null"
- boolean
customer.test_account:
description: Specifies whether the account is a test account
type:
- "null"
- boolean
segments.month:
description: Month of the year
type:
- "null"
- string
segments.quarter:
description: Quarter of the year
type:
- "null"
- string
metrics.search_budget_lost_impression_share:
description: Percentage of budget lost due to search network impressions
type:
- "null"
- number
metrics.search_exact_match_impression_share:
description: Exact match impression share on the search network
type:
- "null"
- number
metrics.search_impression_share:
description: Impression share on the search network
type:
- "null"
- number
metrics.search_rank_lost_impression_share:
description: Percentage of rank lost due to search network impressions
type:
- "null"
- number
metrics.value_per_all_conversions:
description: Value per all conversions
type:
- "null"
- number
metrics.value_per_conversion:
description: Value per conversion
type:
- "null"
- number
metrics.video_view_rate:
description: Rate of video views
type:
- "null"
- number
metrics.video_views:
description: Total number of video views
type:
- "null"
- integer
metrics.view_through_conversions:
description: Conversions where the display ad was shown but not clicked
type:
- "null"
- integer
segments.week:
description: Week of the year
type:
- "null"
- string
segments.year:
description: Year
type:
- "null"
- integer
ad_group_ad:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
ad_group.id:
description: The ID of the ad group this ad belongs to.
type:
- "null"
- integer
ad_group_ad.ad.added_by_google_ads:
description: Specifies whether the ad was created by Google Ads.
type:
- "null"
- boolean
ad_group_ad.ad.app_ad.descriptions:
description: Array of descriptions for App ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.app_ad.headlines:
description: Array of headlines for App ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.app_ad.html5_media_bundles:
description: Array of HTML5 media bundles for App ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.app_ad.images:
description: Array of images for App ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.app_ad.mandatory_ad_text:
description: Mandatory text for App ads.
type:
- "null"
- string
ad_group_ad.ad.app_ad.youtube_videos:
description: Array of YouTube videos for App ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.app_engagement_ad.descriptions:
description: Array of descriptions for App engagement ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.app_engagement_ad.headlines:
description: Array of headlines for App engagement ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.app_engagement_ad.images:
description: Array of images for App engagement ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.app_engagement_ad.videos:
description: Array of videos for App engagement ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.call_ad.business_name:
description: The business name for Call ads.
type:
- "null"
- string
ad_group_ad.ad.call_ad.call_tracked:
description: Indicates if calls are being tracked for Call ads.
type:
- "null"
- boolean
ad_group_ad.ad.call_ad.conversion_action:
description: The conversion action for Call ads.
type:
- "null"
- string
ad_group_ad.ad.call_ad.conversion_reporting_state:
description: The state of conversion reporting for Call ads.
type:
- "null"
- string
ad_group_ad.ad.call_ad.country_code:
description: The country code for Call ads.
type:
- "null"
- string
ad_group_ad.ad.call_ad.description1:
description: Description line 1 for Call ads.
type:
- "null"
- string
ad_group_ad.ad.call_ad.description2:
description: Description line 2 for Call ads.
type:
- "null"
- string
ad_group_ad.ad.call_ad.disable_call_conversion:
description: Indicates if call conversions are disabled for Call ads.
type:
- "null"
- boolean
ad_group_ad.ad.call_ad.headline1:
description: Headline 1 for Call ads.
type:
- "null"
- string
ad_group_ad.ad.call_ad.headline2:
description: Headline 2 for Call ads.
type:
- "null"
- string
ad_group_ad.ad.call_ad.path1:
description: Path field 1 for Call ads.
type:
- "null"
- string
ad_group_ad.ad.call_ad.path2:
description: Path field 2 for Call ads.
type:
- "null"
- string
ad_group_ad.ad.call_ad.phone_number:
description: The phone number for Call ads.
type:
- "null"
- string
ad_group_ad.ad.call_ad.phone_number_verification_url:
description: The phone number verification URL for Call ads.
type:
- "null"
- string
ad_group_ad.ad.device_preference:
description: The device preference for the ad.
type:
- "null"
- string
ad_group_ad.ad.display_upload_ad.display_upload_product_type:
description: The product type for display upload ads.
type:
- "null"
- string
ad_group_ad.ad.display_upload_ad.media_bundle:
description: The media bundle for display upload ads.
type:
- "null"
- string
ad_group_ad.ad.display_url:
description: The display URL for the ad.
type:
- "null"
- string
ad_group_ad.ad.expanded_dynamic_search_ad.description:
description: Description for Expanded Dynamic Search ads.
type:
- "null"
- string
ad_group_ad.ad.expanded_dynamic_search_ad.description2:
description: Additional description for Expanded Dynamic Search ads.
type:
- "null"
- string
ad_group_ad.ad.expanded_text_ad.description:
description: Description for Expanded Text ads.
type:
- "null"
- string
ad_group_ad.ad.expanded_text_ad.description2:
description: Additional description for Expanded Text ads.
type:
- "null"
- string
ad_group_ad.ad.expanded_text_ad.headline_part1:
description: Headline part 1 for Expanded Text ads.
type:
- "null"
- string
ad_group_ad.ad.expanded_text_ad.headline_part2:
description: Headline part 2 for Expanded Text ads.
type:
- "null"
- string
ad_group_ad.ad.expanded_text_ad.headline_part3:
description: Headline part 3 for Expanded Text ads.
type:
- "null"
- string
ad_group_ad.ad.expanded_text_ad.path1:
description: Path field 1 for Expanded Text ads.
type:
- "null"
- string
ad_group_ad.ad.expanded_text_ad.path2:
description: Path field 2 for Expanded Text ads.
type:
- "null"
- string
ad_group_ad.ad.final_app_urls:
description: Array of final app URLs.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.final_mobile_urls:
description: Array of final mobile URLs.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.final_url_suffix:
description: The final URL suffix for the ad.
type:
- "null"
- string
ad_group_ad.ad.final_urls:
description: Array of final URLs.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.hotel_ad:
description: Representation of a hotel ad.
type:
- "null"
- string
ad_group_ad.ad.id:
description: The ID of the ad.
type:
- "null"
- integer
ad_group_ad.ad.image_ad.image_url:
description: The URL of the image for Image ads.
type:
- "null"
- string
ad_group_ad.ad.image_ad.mime_type:
description: The MIME type of the image for Image ads.
type:
- "null"
- string
ad_group_ad.ad.image_ad.name:
description: The name of the image for Image ads.
type:
- "null"
- string
ad_group_ad.ad.image_ad.pixel_height:
description: The pixel height of the image for Image ads.
type:
- "null"
- integer
ad_group_ad.ad.image_ad.pixel_width:
description: The pixel width of the image for Image ads.
type:
- "null"
- integer
ad_group_ad.ad.image_ad.preview_image_url:
description: The preview image URL for Image ads.
type:
- "null"
- string
ad_group_ad.ad.image_ad.preview_pixel_height:
description: The preview pixel height of the image for Image ads.
type:
- "null"
- integer
ad_group_ad.ad.image_ad.preview_pixel_width:
description: The preview pixel width of the image for Image ads.
type:
- "null"
- integer
ad_group_ad.ad.legacy_app_install_ad:
description: Representation of a legacy app install ad.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.accent_color:
description: The accent color for Legacy Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.allow_flexible_color:
description:
Indicates if flexible colors are allowed for Legacy Responsive Display
ads.
type:
- "null"
- boolean
ad_group_ad.ad.legacy_responsive_display_ad.business_name:
description: The business name for Legacy Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.call_to_action_text:
description: The call to action text for Legacy Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.description:
description: Description for Legacy Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.format_setting:
description: Format setting for Legacy Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.logo_image:
description: The logo image for Legacy Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.long_headline:
description: Long headline for Legacy Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.main_color:
description: The main color for Legacy Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.marketing_image:
description: The marketing image for Legacy Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.price_prefix:
description: The price prefix for Legacy Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.promo_text:
description: The promo text for Legacy Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.short_headline:
description: Short headline for Legacy Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.square_logo_image:
description: The square logo image for Legacy Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.square_marketing_image:
description: The square marketing image for Legacy Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.local_ad.call_to_actions:
description: Array of call to actions for Local ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.local_ad.descriptions:
description: Array of descriptions for Local ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.local_ad.headlines:
description: Array of headlines for Local ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.local_ad.logo_images:
description: Array of logo images for Local ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.local_ad.marketing_images:
description: Array of marketing images for Local ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.local_ad.path1:
description: Path field 1 for Local ads.
type:
- "null"
- string
ad_group_ad.ad.local_ad.path2:
description: Path field 2 for Local ads.
type:
- "null"
- string
ad_group_ad.ad.local_ad.videos:
description: Array of videos for Local ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.name:
description: The name of the ad.
type:
- "null"
- string
ad_group_ad.ad.resource_name:
description: The resource name of the ad.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.accent_color:
description: The accent color for Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.allow_flexible_color:
description: Indicates if flexible colors are allowed for Responsive Display ads.
type:
- "null"
- boolean
ad_group_ad.ad.responsive_display_ad.business_name:
description: The business name for Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.call_to_action_text:
description: The call to action text for Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.control_spec.enable_asset_enhancements:
description:
Indicates if asset enhancements are enabled for Responsive Display
ads.
type:
- "null"
- boolean
ad_group_ad.ad.responsive_display_ad.control_spec.enable_autogen_video:
description: Indicates if autogen video is enabled for Responsive Display ads.
type:
- "null"
- boolean
ad_group_ad.ad.responsive_display_ad.descriptions:
description: Array of descriptions for Responsive Display ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_display_ad.format_setting:
description: The format setting for Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.headlines:
description: Array of headlines for Responsive Display ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_display_ad.logo_images:
description: Array of logo images for Responsive Display ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_display_ad.long_headline:
description: Long headline for Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.main_color:
description: The main color for Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.marketing_images:
description: Array of marketing images for Responsive Display ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_display_ad.price_prefix:
description: The price prefix for Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.promo_text:
description: The promo text for Responsive Display ads.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.square_logo_images:
description: Array of square logo images for Responsive Display ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_display_ad.square_marketing_images:
description: Array of square marketing images for Responsive Display ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_display_ad.youtube_videos:
description: Array of YouTube videos for Responsive Display ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_search_ad.descriptions:
description: Array of descriptions for Responsive Search ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_search_ad.headlines:
description: Array of headlines for Responsive Search ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_search_ad.path1:
description: Path field 1 for Responsive Search ads.
type:
- "null"
- string
ad_group_ad.ad.responsive_search_ad.path2:
description: Path field 2 for Responsive Search ads.
type:
- "null"
- string
ad_group_ad.ad.shopping_comparison_listing_ad.headline:
description: The headline for Shopping Comparison Listing ads.
type:
- "null"
- string
ad_group_ad.ad.shopping_product_ad:
description: Representation of a shopping product ad.
type:
- "null"
- string
ad_group_ad.ad.shopping_smart_ad:
description: Representation of a shopping smart ad.
type:
- "null"
- string
ad_group_ad.ad.smart_campaign_ad.descriptions:
description: Array of descriptions for Smart Campaign ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.smart_campaign_ad.headlines:
description: Array of headlines for Smart Campaign ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.system_managed_resource_source:
description: The source of the system-managed resource.
type:
- "null"
- string
ad_group_ad.ad.text_ad.description1:
description: Description line 1 for Text ads.
type:
- "null"
- string
ad_group_ad.ad.text_ad.description2:
description: Description line 2 for Text ads.
type:
- "null"
- string
ad_group_ad.ad.text_ad.headline:
description: Headline for Text ads.
type:
- "null"
- string
ad_group_ad.ad.tracking_url_template:
description: The tracking URL template for the ad.
type:
- "null"
- string
ad_group_ad.ad.type:
description: The type of ad.
type:
- "null"
- string
ad_group_ad.ad.url_collections:
description: Array of URL collections for the ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.url_custom_parameters:
description: Array of custom parameters for final URLs.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.video_ad.in_feed.description1:
description: Description line 1 for In-Feed video ads.
type:
- "null"
- string
ad_group_ad.ad.video_ad.in_feed.description2:
description: Description line 2 for In-Feed video ads.
type:
- "null"
- string
ad_group_ad.ad.video_ad.in_feed.headline:
description: Headline for In-Feed video ads.
type:
- "null"
- string
ad_group_ad.ad.video_ad.in_stream.action_button_label:
description: Action button label for In-Stream video ads.
type:
- "null"
- string
ad_group_ad.ad.video_ad.in_stream.action_headline:
description: Action headline for In-Stream video ads.
type:
- "null"
- string
ad_group_ad.ad.video_ad.out_stream.description:
description: Description for Out-Stream video ads.
type:
- "null"
- string
ad_group_ad.ad.video_ad.out_stream.headline:
description: Headline for Out-Stream video ads.
type:
- "null"
- string
ad_group_ad.ad.video_responsive_ad.call_to_actions:
description: Array of call to actions for Video Responsive ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.video_responsive_ad.companion_banners:
description: Array of companion banners for Video Responsive ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.video_responsive_ad.descriptions:
description: Array of descriptions for Video Responsive ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.video_responsive_ad.headlines:
description: Array of headlines for Video Responsive ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.video_responsive_ad.long_headlines:
description: Array of long headlines for Video Responsive ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.video_responsive_ad.videos:
description: Array of videos for Video Responsive ads.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad_group:
description: The ad group this ad belongs to.
type:
- "null"
- string
ad_group_ad.ad_strength:
description: The strength of the ad.
type:
- "null"
- string
ad_group_ad.labels:
description: Array of labels associated with the ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.policy_summary.approval_status:
description: The approval status of the ad based on policies.
type:
- "null"
- string
ad_group_ad.policy_summary.policy_topic_entries:
description: Array of policy topic entries for the ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.policy_summary.review_status:
description: The review status of the ad based on policies.
type:
- "null"
- string
ad_group_ad.resource_name:
description: The resource name of the ad group ad.
type:
- "null"
- string
ad_group_ad.status:
description: The status of the ad group ad.
type:
- "null"
- string
segments.date:
description: The date segment for the ad group ad data.
type:
- "null"
- string
format: date
ad_group_ad_legacy:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
ad_group_ad.ad.legacy_responsive_display_ad.accent_color:
description: Accent color for the legacy responsive display ad.
type:
- "null"
- string
ad_group.id:
description: The ID of the ad group.
type:
- "null"
- integer
customer.currency_code:
description: The currency code of the customer.
type:
- "null"
- string
customer.descriptive_name:
description: The descriptive name of the customer.
type:
- "null"
- string
customer.time_zone:
description: The time zone of the customer.
type:
- "null"
- string
metrics.active_view_cpm:
description: Cost per thousand active viewable impressions.
type:
- "null"
- number
metrics.active_view_ctr:
description: Active view click-through rate.
type:
- "null"
- number
metrics.active_view_impressions:
description: Number of active viewable impressions.
type:
- "null"
- integer
metrics.active_view_measurability:
description: Measurability of active view impressions.
type:
- "null"
- number
metrics.active_view_measurable_cost_micros:
description: Cost of measurable active viewable impressions.
type:
- "null"
- integer
metrics.active_view_measurable_impressions:
description: Number of measurable active viewable impressions.
type:
- "null"
- integer
metrics.active_view_viewability:
description: Viewability of active view impressions.
type:
- "null"
- number
ad_group_ad.ad_group:
description: The ad group associated with the ad group ad data.
type:
- "null"
- string
ad_group.name:
description: The name of the ad group.
type:
- "null"
- string
ad_group.status:
description: The status of the ad group.
type:
- "null"
- string
segments.ad_network_type:
description: Type of ad network where the ad was displayed.
type:
- "null"
- string
ad_group_ad.ad_strength:
description: Strength of the ad.
type:
- "null"
- string
ad_group_ad.ad.type:
description: The type of the ad.
type:
- "null"
- string
metrics.all_conversions_from_interactions_rate:
description: Rate of all conversions from interactions.
type:
- "null"
- number
metrics.all_conversions_value:
description: Total value of all conversions.
type:
- "null"
- number
metrics.all_conversions:
description: Total number of all conversions.
type:
- "null"
- number
ad_group_ad.ad.legacy_responsive_display_ad.allow_flexible_color:
description:
Flag indicating if flexible color is allowed for the legacy responsive
display ad.
type:
- "null"
- boolean
ad_group_ad.ad.added_by_google_ads:
description: Flag indicating if the ad was added by Google Ads.
type:
- "null"
- boolean
metrics.average_cost:
description: Average cost per click.
type:
- "null"
- number
metrics.average_cpc:
description: Average cost per click.
type:
- "null"
- number
metrics.average_cpe:
description: Average cost per engagement.
type:
- "null"
- number
metrics.average_cpm:
description: Average cost per thousand impressions.
type:
- "null"
- number
metrics.average_cpv:
description: Average cost per view.
type:
- "null"
- number
metrics.average_page_views:
description: Average number of pages viewed.
type:
- "null"
- number
metrics.average_time_on_site:
description: Average time spent on the site.
type:
- "null"
- number
ad_group.base_ad_group:
description: The base ad group associated with the ad group ad legacy data.
type:
- "null"
- string
campaign.base_campaign:
description: The base campaign associated with the ad group ad data.
type:
- "null"
- string
metrics.bounce_rate:
description: Bounce rate of the ad.
type:
- "null"
- number
ad_group_ad.ad.legacy_responsive_display_ad.business_name:
description: Business name for the legacy responsive display ad.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.call_to_action_text:
description: Call to action text for the legacy responsive display ad.
type:
- "null"
- string
campaign.id:
description: The ID of the campaign.
type:
- "null"
- integer
campaign.name:
description: The name of the campaign.
type:
- "null"
- string
campaign.status:
description: The status of the campaign.
type:
- "null"
- string
metrics.clicks:
description: Number of clicks on the ad.
type:
- "null"
- integer
ad_group_ad.policy_summary.approval_status:
description: Approval status of the ad according to policies.
type:
- "null"
- string
metrics.conversions_from_interactions_rate:
description: Rate of conversions from interactions.
type:
- "null"
- number
metrics.conversions_value:
description: Total value of conversions.
type:
- "null"
- number
metrics.conversions:
description: Total number of conversions.
type:
- "null"
- number
metrics.cost_micros:
description: Cost in micros for the ad.
type:
- "null"
- integer
metrics.cost_per_all_conversions:
description: Cost per all conversions.
type:
- "null"
- number
metrics.cost_per_conversion:
description: Cost per conversion.
type:
- "null"
- number
metrics.cost_per_current_model_attributed_conversion:
description: Cost per currently attributed model conversion.
type:
- "null"
- number
ad_group_ad.ad.final_mobile_urls:
description: Final mobile URLs for the ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.final_urls:
description: Final URLs for the ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.tracking_url_template:
description: Custom tracking URL template for the ad.
type:
- "null"
- string
ad_group_ad.ad.url_custom_parameters:
description: Custom parameters for the ad URL.
type:
- "null"
- array
items:
type: string
metrics.cross_device_conversions:
description: Conversions that happen across multiple devices.
type:
- "null"
- number
metrics.ctr:
description: Click-through rate of the ad.
type:
- "null"
- number
metrics.current_model_attributed_conversions_value:
description: Value of currently attributed model conversions.
type:
- "null"
- number
metrics.current_model_attributed_conversions:
description: Number of currently attributed model conversions.
type:
- "null"
- number
segments.date:
description: Date segment for the data.
type:
- "null"
- string
format: date
segments.day_of_week:
description: Day of the week for the data segment.
type:
- "null"
- string
ad_group_ad.ad.expanded_text_ad.description:
description: Description for the expanded text ad.
type:
- "null"
- string
ad_group_ad.ad.text_ad.description1:
description: First description line for the text ad.
type:
- "null"
- string
ad_group_ad.ad.text_ad.description2:
description: Second description line for the text ad.
type:
- "null"
- string
ad_group_ad.ad.device_preference:
description: Device preference for the ad.
type:
- "null"
- string
ad_group_ad.ad.display_url:
description: Display URL of the ad.
type:
- "null"
- string
metrics.engagement_rate:
description: Rate of engagements with the ad.
type:
- "null"
- number
metrics.engagements:
description: Number of engagements with the ad.
type:
- "null"
- integer
ad_group_ad.ad.legacy_responsive_display_ad.logo_image:
description: Logo image for the legacy responsive display ad.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.square_logo_image:
description: Square logo image for the legacy responsive display ad.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.marketing_image:
description: Marketing image for the legacy responsive display ad.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.square_marketing_image:
description: Square marketing image for the legacy responsive display ad.
type:
- "null"
- string
ad_group_ad.ad.expanded_dynamic_search_ad.description:
description: Description for the expanded dynamic search ad.
type:
- "null"
- string
ad_group_ad.ad.expanded_text_ad.description2:
description: Additional description for the expanded text ad.
type:
- "null"
- string
ad_group_ad.ad.expanded_text_ad.headline_part3:
description: Third part of the headline for the expanded text ad.
type:
- "null"
- string
customer.id:
description: The ID of the customer.
type:
- "null"
- integer
ad_group_ad.ad.legacy_responsive_display_ad.format_setting:
description: Format setting for the legacy responsive display ad.
type:
- "null"
- string
metrics.gmail_forwards:
description: Number of Gmail forwards for the ad.
type:
- "null"
- integer
metrics.gmail_saves:
description: Number of times the ad was saved on Gmail.
type:
- "null"
- integer
metrics.gmail_secondary_clicks:
description: Number of secondary clicks on Gmail for the ad.
type:
- "null"
- integer
ad_group_ad.ad.text_ad.headline:
description: Headline for the text ad.
type:
- "null"
- string
ad_group_ad.ad.expanded_text_ad.headline_part1:
description: First part of the headline for the expanded text ad.
type:
- "null"
- string
ad_group_ad.ad.expanded_text_ad.headline_part2:
description: Second part of the headline for the expanded text ad.
type:
- "null"
- string
ad_group_ad.ad.id:
description: The ID of the ad.
type:
- "null"
- integer
ad_group_ad.ad.image_ad.image_url:
description: URL of the image for the image ad.
type:
- "null"
- string
ad_group_ad.ad.image_ad.pixel_height:
description: Pixel height of the image for the image ad.
type:
- "null"
- integer
ad_group_ad.ad.image_ad.pixel_width:
description: Pixel width of the image for the image ad.
type:
- "null"
- integer
ad_group_ad.ad.image_ad.mime_type:
description: MIME type of the image for the image ad.
type:
- "null"
- string
ad_group_ad.ad.image_ad.name:
description: Name of the image for the image ad.
type:
- "null"
- string
metrics.impressions:
description: Number of ad impressions.
type:
- "null"
- integer
metrics.interaction_rate:
description: Rate of interactions with the ad.
type:
- "null"
- number
metrics.interaction_event_types:
description: Types of interaction events with the ad.
type:
- "null"
- array
items:
type: string
metrics.interactions:
description: Total number of interactions with the ad.
type:
- "null"
- integer
ad_group_ad.ad.legacy_responsive_display_ad.long_headline:
description: Long headline for the legacy responsive display ad.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.main_color:
description: Main color for the legacy responsive display ad.
type:
- "null"
- string
segments.month:
description: Month for the data segment.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.accent_color:
description: Accent color for the responsive display ad.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.allow_flexible_color:
description:
Flag indicating if flexible color is allowed for the responsive display
ad.
type:
- "null"
- boolean
ad_group_ad.ad.responsive_display_ad.business_name:
description: Business name for the responsive display ad.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.call_to_action_text:
description: Call to action text for the responsive display ad.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.descriptions:
description: Descriptions for the responsive display ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_display_ad.price_prefix:
description: Price prefix for the responsive display ad.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.promo_text:
description: Promotional text for the responsive display ad.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.format_setting:
description: Format setting for the responsive display ad.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.headlines:
description: Headlines for the responsive display ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_display_ad.logo_images:
description: Logo images for the responsive display ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_display_ad.square_logo_images:
description: Square logo images for the responsive display ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_display_ad.long_headline:
description: Long headline for the responsive display ad.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.main_color:
description: Main color for the responsive display ad.
type:
- "null"
- string
ad_group_ad.ad.responsive_display_ad.marketing_images:
description: Marketing images for the responsive display ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_display_ad.square_marketing_images:
description: Square marketing images for the responsive display ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_display_ad.youtube_videos:
description: YouTube videos for the responsive display ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.expanded_text_ad.path1:
description: Path 1 for the expanded text ad.
type:
- "null"
- string
ad_group_ad.ad.expanded_text_ad.path2:
description: Path 2 for the expanded text ad.
type:
- "null"
- string
metrics.percent_new_visitors:
description: Percentage of new visitors interacted with the ad.
type:
- "null"
- number
ad_group_ad.ad.legacy_responsive_display_ad.price_prefix:
description: Price prefix for the legacy responsive display ad.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.promo_text:
description: Promotional text for the legacy responsive display ad.
type:
- "null"
- string
segments.quarter:
description: Quarter for the data segment.
type:
- "null"
- string
ad_group_ad.ad.responsive_search_ad.descriptions:
description: Descriptions for the responsive search ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_search_ad.headlines:
description: Headlines for the responsive search ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.responsive_search_ad.path1:
description: Path 1 for the responsive search ad.
type:
- "null"
- string
ad_group_ad.ad.responsive_search_ad.path2:
description: Path 2 for the responsive search ad.
type:
- "null"
- string
ad_group_ad.ad.legacy_responsive_display_ad.short_headline:
description: Short headline for the legacy responsive display ad.
type:
- "null"
- string
ad_group_ad.status:
description: Status of the ad group ad.
type:
- "null"
- string
ad_group_ad.ad.system_managed_resource_source:
description: Source of the system-managed resource for the ad.
type:
- "null"
- string
metrics.top_impression_percentage:
description: Percentage of top ad impressions.
type:
- "null"
- number
ad_group_ad.ad.app_ad.descriptions:
description: Descriptions for the app ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.app_ad.headlines:
description: Headlines for the app ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.app_ad.html5_media_bundles:
description: HTML5 media bundles for the app ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.app_ad.images:
description: Images for the app ad.
type:
- "null"
- array
items:
type: string
ad_group_ad.ad.app_ad.mandatory_ad_text:
description: Mandatory text for the app ad.
type:
- "null"
- string
ad_group_ad.ad.app_ad.youtube_videos:
description: YouTube videos for the app ad.
type:
- "null"
- array
items:
type: string
metrics.value_per_all_conversions:
description: Value per all conversions.
type:
- "null"
- number
metrics.value_per_conversion:
description: Value per conversion.
type:
- "null"
- number
metrics.value_per_current_model_attributed_conversion:
description: Value per currently attributed model conversion.
type:
- "null"
- number
metrics.video_quartile_p100_rate:
description: Rate of viewers reaching the 100th quartile of the video.
type:
- "null"
- number
metrics.video_quartile_p25_rate:
description: Rate of viewers reaching the 25th quartile of the video.
type:
- "null"
- number
metrics.video_quartile_p50_rate:
description: Rate of viewers reaching the 50th quartile of the video.
type:
- "null"
- number
metrics.video_quartile_p75_rate:
description: Rate of viewers reaching the 75th quartile of the video.
type:
- "null"
- number
metrics.video_view_rate:
description: Rate of video views.
type:
- "null"
- number
metrics.video_views:
description: Number of video views.
type:
- "null"
- integer
metrics.view_through_conversions:
description: Conversions that occur without a click but after a view.
type:
- "null"
- integer
segments.week:
description: Week for the data segment.
type:
- "null"
- string
segments.year:
description: Year for the data segment.
type:
- "null"
- integer
audience:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
customer.id:
description: Unique identifier for the customer associated with the audience segment.
type:
- "null"
- integer
audience.description:
description:
Description of the audience segment, providing more details about
the specific audience group.
type:
- "null"
- string
audience.dimensions:
description: Dimensions or attributes associated with the audience segment.
type:
- "null"
- array
items:
description: An individual dimension or attribute within the audience segment.
type: string
audience.exclusion_dimension:
description: Dimension used to exclude specific criteria from targeting this audience.
type:
- "null"
- string
audience.id:
description: Unique identifier for the audience segment.
type:
- "null"
- integer
audience.name:
description: Name or title given to the audience segment.
type:
- "null"
- string
audience.resource_name:
description: Resource name associated with the audience segment.
type:
- "null"
- string
audience.status:
description: Status of the audience segment indicating if it is active or inactive.
type:
- "null"
- string
user_interest:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
user_interest.availabilities:
description: List of availabilities for the user interest.
type:
- "null"
- array
items:
type:
- "null"
- string
user_interest.launched_to_all:
description: Indicates if this user interest is launched to all users.
type:
- "null"
- boolean
user_interest.name:
description: Name of the user interest.
type:
- "null"
- string
user_interest.resource_name:
description: Resource name of the user interest.
type:
- "null"
- string
user_interest.taxonomy_type:
description: Type of taxonomy associated with the user interest.
type:
- "null"
- string
user_interest.user_interest_id:
description: Unique identifier for the user interest.
type:
- "null"
- integer
user_interest.user_interest_parent:
description: Parent user interest if this interest is a subcategory.
type:
- "null"
- string
ad_group_label:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
ad_group.id:
description: The unique identifier of the ad group.
type:
- "null"
- integer
label.id:
description: The unique identifier of the label.
type:
- "null"
- integer
ad_group.resource_name:
description: The resource name of the ad group.
type:
- "null"
- string
ad_group_label.resource_name:
description: The resource name of the ad group label.
type:
- "null"
- string
label.name:
description: The name of the label.
type:
- "null"
- string
label.resource_name:
description: The resource name of the label.
type:
- "null"
- string
ad_group_ad_label:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
ad_group.id:
description: The ID of the Ad Group to which the ad belongs.
type:
- "null"
- integer
ad_group_ad.ad.id:
description: The ID of the Ad associated with the Ad Group Ad.
type:
- "null"
- integer
ad_group_ad.ad.resource_name:
description: The resource name of the Ad associated with the Ad Group Ad.
type:
- "null"
- string
ad_group_ad_label.resource_name:
description: The resource name of the Ad Group Ad Label.
type:
- "null"
- string
label.name:
description: The name of the label associated with the Ad Group Ad.
type:
- "null"
- string
label.resource_name:
description: The resource name of the label associated with the Ad Group Ad.
type:
- "null"
- string
label.id:
description: The ID of the label associated with the Ad Group Ad.
type:
- "null"
- integer
campaign_label:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
campaign.id:
description: The unique identifier for the campaign.
type:
- "null"
- integer
label.id:
description: The unique identifier for the label.
type:
- "null"
- integer
campaign.resource_name:
description: The resource name of the campaign.
type:
- "null"
- string
campaign_label.resource_name:
description: The resource name of the relationship between a campaign and a label.
type:
- "null"
- string
label.name:
description: The name of the label.
type:
- "null"
- string
label.resource_name:
description: The resource name of the label.
type:
- "null"
- string
label:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
customer.id:
description: The unique identifier of the customer associated with the label.
type:
- "null"
- integer
label.id:
description: The unique identifier of the label.
type:
- "null"
- integer
label.name:
description: The name associated with the label.
type:
- "null"
- string
label.resource_name:
description: The resource name of the label.
type:
- "null"
- string
label.status:
description: The status of the label.
type:
- "null"
- string
label.text_label.background_color:
description: The background color of the text label.
type:
- "null"
- string
label.text_label.description:
description: The description associated with the text label.
type:
- "null"
- string
ad_group_criterion_label:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
ad_group.id:
description: The ID of the ad group to which the criterion label belongs.
type:
- "null"
- integer
label.id:
description: The ID of the label assigned to the ad group criterion.
type:
- "null"
- integer
ad_group_criterion_label.ad_group_criterion:
description: The ad group criterion to which the label is applied.
type:
- "null"
- string
ad_group_criterion_label.label:
description: The label assigned to the ad group criterion.
type:
- "null"
- string
ad_group_criterion_label.resource_name:
description: The resource name of the ad group criterion label.
type:
- "null"
- string
ad_group_criterion.criterion_id:
description: The ID of the criterion associated with the ad group.
type:
- "null"
- integer
customer_label:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
customer_label.resource_name:
description:
The resource name that uniquely identifies the customer label in
the system.
type:
- "null"
- string
customer_label.customer:
description:
The name or details of the customer that the label is associated
with.
type:
- "null"
- string
customer.id:
description: The unique identifier of the customer associated with the label.
type:
- "null"
- integer
customer_label.label:
description:
The category or tag applied to the customer for specific identification
or grouping.
type:
- "null"
- string
click_view:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
ad_group.name:
description: The name of the ad group.
type:
- "null"
- string
click_view.gclid:
description: The Google Click Identifier for tracking purposes.
type:
- "null"
- string
click_view.ad_group_ad:
description: Details of the ad in the ad group that was clicked.
type:
- "null"
- string
click_view.keyword:
description: The keyword that triggered the ad click.
type:
- "null"
- string
click_view.keyword_info.match_type:
description: The match type of the keyword triggering the ad click.
type:
- "null"
- string
click_view.keyword_info.text:
description: The text of the keyword that triggered the ad click.
type:
- "null"
- string
campaign.id:
description: The unique identifier for the campaign.
type:
- "null"
- integer
ad_group.id:
description: The unique identifier for the ad group.
type:
- "null"
- integer
segments.date:
description: The date when the click occurred.
type:
- "null"
- string
format: date
customer.id:
description: The unique identifier for the customer account.
type:
- "null"
- integer
campaign.name:
description: The name of the campaign.
type:
- "null"
- string
segments.ad_network_type:
description: Type of ad network where the click originated.
type:
- "null"
- string
campaign.network_settings.target_content_network:
description: Boolean indicating if the campaign is targeting the content network.
type:
- "null"
- boolean
campaign.network_settings.target_google_search:
description: Boolean indicating if the campaign is targeting Google search.
type:
- "null"
- boolean
campaign.network_settings.target_partner_search_network:
description: Boolean indicating if the campaign is targeting partner search network.
type:
- "null"
- boolean
campaign.network_settings.target_search_network:
description: Boolean indicating if the campaign is targeting search network.
type:
- "null"
- boolean
campaign_bidding_strategy:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
customer.id:
description: The ID of the customer associated with the bidding strategy.
type:
- "null"
- integer
campaign.id:
description: The ID of the campaign associated with the bidding strategy.
type:
- "null"
- integer
bidding_strategy.aligned_campaign_budget_id:
description:
The ID of the campaign budget that this bidding strategy is aligned
with.
type:
- "null"
- integer
bidding_strategy.campaign_count:
description: The total count of campaigns that are using this bidding strategy.
type:
- "null"
- integer
bidding_strategy.currency_code:
description: The currency code used by the bidding strategy.
type:
- "null"
- string
bidding_strategy.effective_currency_code:
description:
The effective currency code applied by the bidding strategy across
campaigns.
type:
- "null"
- string
bidding_strategy.enhanced_cpc:
description: Indicates if Enhanced CPC (ECPC) is enabled for this bidding strategy.
type:
- "null"
- string
bidding_strategy.id:
description: The unique ID of the bidding strategy.
type:
- "null"
- integer
bidding_strategy.maximize_conversion_value.cpc_bid_ceiling_micros:
description:
The maximum CPC bid ceiling in micros for Maximize Conversion Value
strategy.
type:
- "null"
- integer
bidding_strategy.maximize_conversion_value.cpc_bid_floor_micros:
description:
The minimum CPC bid floor in micros for Maximize Conversion Value
strategy.
type:
- "null"
- integer
bidding_strategy.maximize_conversion_value.target_roas:
description:
The target Return on Ad Spend (ROAS) for Maximize Conversion Value
strategy.
type:
- "null"
- number
bidding_strategy.maximize_conversions.cpc_bid_ceiling_micros:
description: The maximum CPC bid ceiling in micros for Maximize Conversions strategy.
type:
- "null"
- integer
bidding_strategy.maximize_conversions.cpc_bid_floor_micros:
description: The minimum CPC bid floor in micros for Maximize Conversions strategy.
type:
- "null"
- integer
bidding_strategy.maximize_conversions.target_cpa_micros:
description:
The target Cost per Acquisition (CPA) in micros for Maximize Conversions
strategy.
type:
- "null"
- integer
bidding_strategy.name:
description: The name of the bidding strategy.
type:
- "null"
- string
bidding_strategy.non_removed_campaign_count:
description: The count of active campaigns that are using this bidding strategy.
type:
- "null"
- integer
bidding_strategy.resource_name:
description: The resource name of the bidding strategy.
type:
- "null"
- string
bidding_strategy.status:
description: The status of the bidding strategy.
type:
- "null"
- string
bidding_strategy.target_cpa.cpc_bid_ceiling_micros:
description: The maximum CPC bid ceiling in micros for Target CPA strategy.
type:
- "null"
- integer
bidding_strategy.target_cpa.cpc_bid_floor_micros:
description: The minimum CPC bid floor in micros for Target CPA strategy.
type:
- "null"
- integer
bidding_strategy.target_cpa.target_cpa_micros:
description: The target Cost per Acquisition (CPA) in micros for Target CPA strategy.
type:
- "null"
- integer
bidding_strategy.target_impression_share.cpc_bid_ceiling_micros:
description:
The maximum CPC bid ceiling in micros for Target Impression Share
strategy.
type:
- "null"
- integer
bidding_strategy.target_impression_share.location:
description:
The targeted location for Impression Share in Target Impression Share
strategy.
type:
- "null"
- string
bidding_strategy.target_impression_share.location_fraction_micros:
description:
The fraction of requested location's impressions targeted by Target
Impression Share.
type:
- "null"
- integer
bidding_strategy.target_roas.cpc_bid_ceiling_micros:
description: The maximum CPC bid ceiling in micros for Target ROAS strategy.
type:
- "null"
- integer
bidding_strategy.target_roas.cpc_bid_floor_micros:
description: The minimum CPC bid floor in micros for Target ROAS strategy.
type:
- "null"
- integer
bidding_strategy.target_roas.target_roas:
description: The target Return on Ad Spend (ROAS) for Target ROAS strategy.
type:
- "null"
- number
bidding_strategy.target_spend.cpc_bid_ceiling_micros:
description: The maximum CPC bid ceiling in micros for Target Spend strategy.
type:
- "null"
- integer
bidding_strategy.target_spend.target_spend_micros:
description: The target spend in micros for Target Spend strategy.
type:
- "null"
- integer
bidding_strategy.type:
description: The type of bidding strategy used.
type:
- "null"
- string
segments.date:
description: The date segment for the data.
type:
- "null"
- string
format: date
ad_group_bidding_strategy:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
ad_group.id:
description: The ID of the ad group to which the bidding strategy belongs.
type:
- "null"
- integer
bidding_strategy.aligned_campaign_budget_id:
description: The ID of the campaign budget aligned with the bidding strategy.
type:
- "null"
- integer
bidding_strategy.campaign_count:
description: The count of campaigns using this bidding strategy.
type:
- "null"
- integer
bidding_strategy.currency_code:
description: The currency code used for the bidding strategy.
type:
- "null"
- string
bidding_strategy.effective_currency_code:
description: The effective currency code for the bidding strategy.
type:
- "null"
- string
bidding_strategy.enhanced_cpc:
description: Flag indicating if Enhanced CPC is enabled for the bidding strategy.
type:
- "null"
- string
bidding_strategy.id:
description: The ID of the bidding strategy.
type:
- "null"
- integer
bidding_strategy.maximize_conversion_value.cpc_bid_ceiling_micros:
description:
The maximum CPC bid ceiling in micros for maximize conversion value
strategy.
type:
- "null"
- integer
bidding_strategy.maximize_conversion_value.cpc_bid_floor_micros:
description:
The minimum CPC bid floor in micros for maximize conversion value
strategy.
type:
- "null"
- integer
bidding_strategy.maximize_conversion_value.target_roas:
description: The target return on ad spend for maximize conversion value strategy.
type:
- "null"
- number
bidding_strategy.maximize_conversions.cpc_bid_ceiling_micros:
description: The maximum CPC bid ceiling in micros for maximize conversions strategy.
type:
- "null"
- integer
bidding_strategy.maximize_conversions.cpc_bid_floor_micros:
description: The minimum CPC bid floor in micros for maximize conversions strategy.
type:
- "null"
- integer
bidding_strategy.maximize_conversions.target_cpa_micros:
description:
The target cost per acquisition in micros for maximize conversions
strategy.
type:
- "null"
- integer
bidding_strategy.name:
description: The name of the bidding strategy.
type:
- "null"
- string
bidding_strategy.non_removed_campaign_count:
description: The count of non-removed campaigns using this bidding strategy.
type:
- "null"
- integer
bidding_strategy.resource_name:
description: The resource name of the bidding strategy.
type:
- "null"
- string
bidding_strategy.status:
description: The status of the bidding strategy (e.g., enabled or paused).
type:
- "null"
- string
bidding_strategy.target_cpa.cpc_bid_ceiling_micros:
description: The maximum CPC bid ceiling in micros for target CPA strategy.
type:
- "null"
- integer
bidding_strategy.target_cpa.cpc_bid_floor_micros:
description: The minimum CPC bid floor in micros for target CPA strategy.
type:
- "null"
- integer
bidding_strategy.target_cpa.target_cpa_micros:
description: The target cost per acquisition in micros for target CPA strategy.
type:
- "null"
- integer
bidding_strategy.target_impression_share.cpc_bid_ceiling_micros:
description:
The maximum CPC bid ceiling in micros for target impression share
strategy.
type:
- "null"
- integer
bidding_strategy.target_impression_share.location:
description: The targeted location for the impression share strategy.
type:
- "null"
- string
bidding_strategy.target_impression_share.location_fraction_micros:
description: The targeted impression share fraction in micros.
type:
- "null"
- integer
bidding_strategy.target_roas.cpc_bid_ceiling_micros:
description: The maximum CPC bid ceiling in micros for target ROAS strategy.
type:
- "null"
- integer
bidding_strategy.target_roas.cpc_bid_floor_micros:
description: The minimum CPC bid floor in micros for target ROAS strategy.
type:
- "null"
- integer
bidding_strategy.target_roas.target_roas:
description: The target return on ad spend for target ROAS strategy.
type:
- "null"
- number
bidding_strategy.target_spend.cpc_bid_ceiling_micros:
description: The maximum CPC bid ceiling in micros for target spend strategy.
type:
- "null"
- integer
bidding_strategy.target_spend.target_spend_micros:
description: The target spend in micros for target spend strategy.
type:
- "null"
- integer
bidding_strategy.type:
description: The type of bidding strategy (e.g., target CPA, target ROAS).
type:
- "null"
- string
segments.date:
description: The date for which the data is segmented.
type:
- "null"
- string
format: date