blob: ebc231ef4dfb39bda8eda946dc400c77a9cf527c [file] [log] [blame]
:py:mod:`airflow.providers.google.marketing_platform.sensors.campaign_manager`
==============================================================================
.. py:module:: airflow.providers.google.marketing_platform.sensors.campaign_manager
.. autoapi-nested-parse::
This module contains Google Campaign Manager sensor.
Module Contents
---------------
Classes
~~~~~~~
.. autoapisummary::
airflow.providers.google.marketing_platform.sensors.campaign_manager.GoogleCampaignManagerReportSensor
.. py:class:: GoogleCampaignManagerReportSensor(*, profile_id, report_id, file_id, api_version = 'v3.3', gcp_conn_id = 'google_cloud_default', delegate_to = None, mode = 'reschedule', poke_interval = 60 * 5, impersonation_chain = None, **kwargs)
Bases: :py:obj:`airflow.sensors.base.BaseSensorOperator`
Check if report is ready.
.. seealso::
Check official API docs:
https://developers.google.com/doubleclick-advertisers/v3.3/reports/get
.. seealso::
For more information on how to use this operator, take a look at the guide:
:ref:`howto/operator:GoogleCampaignManagerReportSensor`
:param profile_id: The DFA user profile ID.
:param report_id: The ID of the report.
:param file_id: The ID of the report file.
:param api_version: The version of the api that will be requested for example 'v3'.
:param gcp_conn_id: The connection ID to use when fetching connection info.
:param delegate_to: 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.
:param impersonation_chain: 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).
.. py:attribute:: template_fields
:annotation: :Sequence[str] = ['profile_id', 'report_id', 'file_id', 'impersonation_chain']
.. py:method:: poke(context)
Function that the sensors defined while deriving this class should
override.