airflow.providers.google.marketing_platform.operators.search_ads¶

This module contains Google Search Ads operators.

Classes¶

`GoogleSearchAdsSearchOperator`	Search a report by query.
`GoogleSearchAdsGetFieldOperator`	Retrieve metadata for a resource or a field.
`GoogleSearchAdsSearchFieldsOperator`	Retrieve metadata for resource(s) or field(s) by the query syntax.
`GoogleSearchAdsGetCustomColumnOperator`	Retrieve details of a custom column for the given customer_id and campaign_id.
`GoogleSearchAdsListCustomColumnsOperator`	List all custom columns.

Module Contents¶

class airflow.providers.google.marketing_platform.operators.search_ads.GoogleSearchAdsSearchOperator(*, customer_id, query, page_token=None, page_size=10000, return_total_results_count=False, summary_row_setting=None, validate_only=False, **kwargs)[source]¶

Bases: _GoogleSearchAdsBaseOperator

Search a report by query.

See also

For more information on how to use this operator, take a look at the guide: Querying a report

Parameters:

customer_id (str) – The ID of the customer being queried.
query (str) – The query to execute.
page_token (str | None) – Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from next_page_token in the previous response in order to request the next page of results.
page_size (int) – Number of elements to retrieve in a single page. When too large a page is requested, the server may decide to further limit the number of returned resources. Default is 10000.
return_total_results_count (bool) – If true, the total number of results that match the query ignoring the LIMIT clause will be included in the response. Default is false.
summary_row_setting (str | None) – Determines whether a summary row will be returned. By default, summary row is not returned. If requested, the summary row will be sent in a response by itself after all others query results are returned.
validate_only (bool) – If true, the request is validated but not executed. Default is false.
gcp_conn_id – The connection ID to use when fetching connection info.
api_version – The version of the API that will be requested for example ‘v0’.

template_fields: collections.abc.Sequence[str] = ('api_version', 'gcp_conn_id', 'page_token', 'page_size')[source]¶

customer_id[source]¶

query[source]¶

page_token = None[source]¶

page_size = 10000[source]¶

return_total_results_count = False[source]¶

summary_row_setting = None[source]¶

validate_only = False[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.marketing_platform.operators.search_ads.GoogleSearchAdsGetFieldOperator(*, field_name, **kwargs)[source]¶

Bases: _GoogleSearchAdsBaseOperator

Retrieve metadata for a resource or a field.

See also

For more information on how to use this operator, take a look at the guide: Retrieve a field metadata

Parameters:

field_name (str) – The name of the field.
gcp_conn_id – The connection ID to use when fetching connection info.
api_version – The version of the API that will be requested for example ‘v0’.

field_name[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.marketing_platform.operators.search_ads.GoogleSearchAdsSearchFieldsOperator(*, query, page_token=None, page_size=10000, **kwargs)[source]¶

Bases: _GoogleSearchAdsBaseOperator

Retrieve metadata for resource(s) or field(s) by the query syntax.

See also

For more information on how to use this operator, take a look at the guide: Retrieve metadata for multiple fields

Parameters:

query (str) – The query string to execute.
page_token (str | None) – Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from next_page_token in the previous response in order to request the next page of results.
page_size (int) – Number of elements to retrieve in a single page. When too large a page is requested, the server may decide to further limit the number of returned resources. Default 10000.
gcp_conn_id – The connection ID to use when fetching connection info.
api_version – The version of the API that will be requested for example ‘v0’.

template_fields: collections.abc.Sequence[str] = ('api_version', 'gcp_conn_id', 'page_token', 'page_size')[source]¶

query[source]¶

page_token = None[source]¶

page_size = 10000[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.marketing_platform.operators.search_ads.GoogleSearchAdsGetCustomColumnOperator(*, customer_id, custom_column_id, **kwargs)[source]¶

Bases: _GoogleSearchAdsBaseOperator

Retrieve details of a custom column for the given customer_id and campaign_id.

See also

For more information on how to use this operator, take a look at the guide: Retrieve a custom column details

Parameters:

customer_id (str) – The customer ID for the custom column.
custom_column_id (str) – The ID for the custom column.
gcp_conn_id – The connection ID to use when fetching connection info.
api_version – The version of the API that will be requested for example ‘v0’.

customer_id[source]¶

custom_column_id[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.marketing_platform.operators.search_ads.GoogleSearchAdsListCustomColumnsOperator(*, customer_id, **kwargs)[source]¶

Bases: _GoogleSearchAdsBaseOperator

List all custom columns.

See also

For more information on how to use this operator, take a look at the guide: Retrieve a custom column details

Parameters:

customer_id (str) – The customer ID for the custom column.
gcp_conn_id – The connection ID to use when fetching connection info.
api_version – The version of the API that will be requested for example ‘v0’.

customer_id[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.