airflow.providers.google.marketing_platform.operators.display_video

This module contains Google DisplayVideo operators.

Module Contents

Classes

GoogleDisplayVideo360CreateReportOperator

Creates a query.

GoogleDisplayVideo360DeleteReportOperator

Deletes a stored query as well as the associated stored reports.

GoogleDisplayVideo360DownloadReportOperator

Retrieves a stored query.

GoogleDisplayVideo360RunReportOperator

Runs a stored query to generate a report.

GoogleDisplayVideo360DownloadLineItemsOperator

Retrieves line items in CSV format.

GoogleDisplayVideo360UploadLineItemsOperator

Uploads line items in CSV format.

GoogleDisplayVideo360CreateSDFDownloadTaskOperator

Creates SDF operation task.

GoogleDisplayVideo360SDFtoGCSOperator

Download SDF media and save it in the Google Cloud Storage.
class airflow.providers.google.marketing_platform.operators.display_video.GoogleDisplayVideo360CreateReportOperator(*, body, api_version='v1', gcp_conn_id='google_cloud_default', delegate_to=None, impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Creates a query.

See also

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

See also

Check also the official API docs: https://developers.google.com/bid-manager/v1/queries/createquery

Parameters

  • body (Dict[str, Any]) -- Report object passed to the request's body as described here: https://developers.google.com/bid-manager/v1/queries#resource

  • api_version (str) -- The version of the api that will be requested for example 'v3'.

  • gcp_conn_id (str) -- The connection ID to use when fetching connection info.

  • delegate_to (Optional[str]) -- The account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.

  • impersonation_chain (Optional[Union[str, Sequence[str]]]) -- Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['body', 'impersonation_chain'][source]
template_ext :Sequence[str] = ['.json'][source]
prepare_template(self)[source]

Hook triggered after the templated fields get replaced by their content.

If you need your operator to alter the content of the file before the template is rendered, it should override this method to do so.

execute(self, context)[source]

This is the main method to 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.display_video.GoogleDisplayVideo360DeleteReportOperator(*, report_id=None, report_name=None, api_version='v1', gcp_conn_id='google_cloud_default', delegate_to=None, impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Deletes a stored query as well as the associated stored reports.

See also

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

See also

Check also the official API docs: https://developers.google.com/bid-manager/v1/queries/deletequery

Parameters

  • report_id (Optional[str]) -- Report ID to delete.

  • report_name (Optional[str]) -- Name of the report to delete.

  • api_version (str) -- The version of the api that will be requested for example 'v3'.

  • gcp_conn_id (str) -- The connection ID to use when fetching connection info.

  • delegate_to (Optional[str]) -- The account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.

  • impersonation_chain (Optional[Union[str, Sequence[str]]]) -- Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['report_id', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.display_video.GoogleDisplayVideo360DownloadReportOperator(*, report_id, bucket_name, report_name=None, gzip=True, chunk_size=10 * 1024 * 1024, api_version='v1', gcp_conn_id='google_cloud_default', delegate_to=None, impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Retrieves a stored query.

See also

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

See also

Check also the official API docs: https://developers.google.com/bid-manager/v1/queries/getquery

Parameters

  • report_id (str) -- Report ID to retrieve.

  • bucket_name (str) -- The bucket to upload to.

  • report_name (Optional[str]) -- The report name to set when uploading the local file.

  • chunk_size (int) -- File will be downloaded in chunks of this many bytes.

  • gzip (bool) -- Option to compress local file or file data for upload

  • api_version (str) -- The version of the api that will be requested for example 'v3'.

  • gcp_conn_id (str) -- The connection ID to use when fetching connection info.

  • delegate_to (Optional[str]) -- The account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.

  • impersonation_chain (Optional[Union[str, Sequence[str]]]) -- Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['report_id', 'bucket_name', 'report_name', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.display_video.GoogleDisplayVideo360RunReportOperator(*, report_id, parameters=None, api_version='v1', gcp_conn_id='google_cloud_default', delegate_to=None, impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Runs a stored query to generate a report.

See also

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

See also

Check also the official API docs: https://developers.google.com/bid-manager/v1/queries/runquery

Parameters

  • report_id (str) -- Report ID to run.

  • parameters (Optional[Dict[str, Any]]) -- Parameters for running a report as described here: https://developers.google.com/bid-manager/v1/queries/runquery

  • api_version (str) -- The version of the api that will be requested for example 'v3'.

  • gcp_conn_id (str) -- The connection ID to use when fetching connection info.

  • delegate_to (Optional[str]) -- The account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.

  • impersonation_chain (Optional[Union[str, Sequence[str]]]) -- Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['report_id', 'parameters', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.display_video.GoogleDisplayVideo360DownloadLineItemsOperator(*, request_body, bucket_name, object_name, gzip=False, api_version='v1.1', gcp_conn_id='google_cloud_default', delegate_to=None, impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Retrieves line items in CSV format.

See also

For more information on how to use this operator, take a look at the guide: Downloading Line Items

See also

Check also the official API docs: https://developers.google.com/bid-manager/v1.1/lineitems/downloadlineitems

Parameters

request_body (Dict[str, Any]) -- dictionary with parameters that should be passed into. More information about it can be found here: https://developers.google.com/bid-manager/v1.1/lineitems/downloadlineitems

template_fields :Sequence[str] = ['request_body', 'bucket_name', 'object_name', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.display_video.GoogleDisplayVideo360UploadLineItemsOperator(*, bucket_name, object_name, api_version='v1.1', gcp_conn_id='google_cloud_default', delegate_to=None, impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Uploads line items in CSV format.

See also

For more information on how to use this operator, take a look at the guide: Upload line items

See also

Check also the official API docs: https://developers.google.com/bid-manager/v1.1/lineitems/uploadlineitems

Parameters

  • request_body -- request to upload line items.

  • bucket_name (str) -- The bucket form data is downloaded.

  • object_name (str) -- The object to fetch.

  • filename -- The filename to fetch.

  • dry_run -- Upload status without actually persisting the line items.

template_fields :Sequence[str] = ['bucket_name', 'object_name', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.display_video.GoogleDisplayVideo360CreateSDFDownloadTaskOperator(*, body_request, api_version='v1', gcp_conn_id='google_cloud_default', delegate_to=None, impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Creates SDF operation task.

See also

For more information on how to use this operator, take a look at the guide: Create SDF download task

See also

Check also the official API docs: https://developers.google.com/display-video/api/reference/rest

Parameters

  • version -- The SDF version of the downloaded file.

  • partner_id -- The ID of the partner to download SDF for.

  • advertiser_id -- The ID of the advertiser to download SDF for.

  • parent_entity_filter -- Filters on selected file types.

  • id_filter -- Filters on entities by their entity IDs.

  • inventory_source_filter -- Filters on Inventory Sources by their IDs.

  • gcp_conn_id (str) -- The connection ID to use when fetching connection info.

  • delegate_to (Optional[str]) -- The account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.

  • impersonation_chain (Optional[Union[str, Sequence[str]]]) -- Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['body_request', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.display_video.GoogleDisplayVideo360SDFtoGCSOperator(*, operation_name, bucket_name, object_name, gzip=False, api_version='v1', gcp_conn_id='google_cloud_default', delegate_to=None, impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Download SDF media and save it in the Google Cloud Storage.

See also

For more information on how to use this operator, take a look at the guide: Save SDF files in the Google Cloud Storage

See also

Check also the official API docs: https://developers.google.com/display-video/api/reference/rest

Parameters

  • version -- The SDF version of the downloaded file.

  • partner_id -- The ID of the partner to download SDF for.

  • advertiser_id -- The ID of the advertiser to download SDF for.

  • parent_entity_filter -- Filters on selected file types.

  • id_filter -- Filters on entities by their entity IDs.

  • inventory_source_filter -- Filters on Inventory Sources by their IDs.

  • gcp_conn_id (str) -- The connection ID to use when fetching connection info.

  • delegate_to (Optional[str]) -- The account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.

  • impersonation_chain (Optional[Union[str, Sequence[str]]]) -- Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['operation_name', 'bucket_name', 'object_name', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

Was this entry helpful?