airflow.providers.google.marketing_platform.operators.display_video¶

此模块包含 Google DisplayVideo 运算符。

类¶

`GoogleDisplayVideo360CreateQueryOperator`	创建一个查询。
`GoogleDisplayVideo360DeleteReportOperator`	删除存储的查询以及相关的存储报告。
`GoogleDisplayVideo360DownloadReportV2Operator`	检索存储的查询。
`GoogleDisplayVideo360RunQueryOperator`	运行存储的查询以生成报告。
`GoogleDisplayVideo360DownloadLineItemsOperator`	检索 CSV 格式的行项目。
`GoogleDisplayVideo360UploadLineItemsOperator`	上传 CSV 格式的行项目。
`GoogleDisplayVideo360CreateSDFDownloadTaskOperator`	创建 SDF 操作任务。
`GoogleDisplayVideo360SDFtoGCSOperator`	下载 SDF 媒体文件并将其保存到 Google Cloud Storage。

模块内容¶

class airflow.providers.google.marketing_platform.operators.display_video.GoogleDisplayVideo360CreateQueryOperator(*, body, api_version='v2', gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基类：airflow.models.BaseOperator

创建一个查询。

另请参阅

有关如何使用此运算符的更多信息，请参阅指南：GoogleDisplayVideo360CreateQueryOperator

另请参阅

另请查阅官方 API 文档：https://developers.google.com/bid-manager/v2/queries/create

参数：:

body (dict[str, Any]) – 传递给请求主体的报告对象，详情如下：https://developers.google.com/bid-manager/v2/queries#Query
api_version (str) – 将要请求的 API 版本，例如 ‘v3’。
gcp_conn_id (str) – 检索连接信息时使用的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号，用于使用短期凭据进行模拟；或者一个账号链列表，用于获取列表中最后一个账号的访问令牌，该账号将在请求中被模拟。如果设置为字符串，则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列，列表中的身份必须将 Service Account Token Creator IAM 角色授予直接前一个身份，列表中第一个账号将此角色授予发起账号（模板化）。

template_fields: collections.abc.Sequence[str] = ('body', 'impersonation_chain')[source]¶

template_ext: collections.abc.Sequence[str] = ('.json',)[source]¶

body[source]¶

api_version = 'v2'[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

prepare_template()[source]¶

在模板字段被其内容替换后执行。

如果您需要对象在模板渲染之前更改文件的内容，它应该重写此方法来实现。

execute(context)[source]¶

创建运算符时继承。

上下文是与渲染 Jinja 模板时使用的一样的字典。

请参阅 get_template_context 以获取更多上下文。

class airflow.providers.google.marketing_platform.operators.display_video.GoogleDisplayVideo360DeleteReportOperator(*, report_id=None, report_name=None, api_version='v2', gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基类：airflow.models.BaseOperator

删除存储的查询以及相关的存储报告。

另请参阅

有关如何使用此运算符的更多信息，请参阅指南：删除报告

另请参阅

另请查阅官方 API 文档：https://developers.google.com/bid-manager/v2/queries/delete

参数：:

report_id (str | None) – 要删除的报告 ID。
report_name (str | None) – 要删除的报告名称。
api_version (str) – 将要请求的 API 版本，例如 ‘v3’。
gcp_conn_id (str) – 检索连接信息时使用的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号，用于使用短期凭据进行模拟；或者一个账号链列表，用于获取列表中最后一个账号的访问令牌，该账号将在请求中被模拟。如果设置为字符串，则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列，列表中的身份必须将 Service Account Token Creator IAM 角色授予直接前一个身份，列表中第一个账号将此角色授予发起账号（模板化）。

template_fields: collections.abc.Sequence[str] = ('report_id', 'impersonation_chain')[source]¶

report_id = None[source]¶

report_name = None[source]¶

api_version = 'v2'[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

创建运算符时继承。

上下文是与渲染 Jinja 模板时使用的一样的字典。

请参阅 get_template_context 以获取更多上下文。

class airflow.providers.google.marketing_platform.operators.display_video.GoogleDisplayVideo360DownloadReportV2Operator(*, query_id, report_id, bucket_name, report_name=None, gzip=True, chunk_size=10 * 1024 * 1024, api_version='v2', gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基类：airflow.models.BaseOperator

检索存储的查询。

另请参阅

有关如何使用此运算符的更多信息，请参阅指南：下载报告

另请参阅

另请查阅官方 API 文档：https://developers.google.com/bid-manager/v2/queries/get

参数：:

report_id (str) – 要检索的报告 ID。
bucket_name (str) – 要上传到的存储桶。
report_name (str | None) – 上传本地文件时要设置的报告名称。
chunk_size (int) – 文件将以指定字节大小的分块下载。
gzip (bool) – 用于压缩本地文件或文件数据以供上传的选项
api_version (str) – 将要请求的 API 版本，例如 ‘v3’。
gcp_conn_id (str) – 检索连接信息时使用的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号，用于使用短期凭据进行模拟；或者一个账号链列表，用于获取列表中最后一个账号的访问令牌，该账号将在请求中被模拟。如果设置为字符串，则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列，列表中的身份必须将 Service Account Token Creator IAM 角色授予直接前一个身份，列表中第一个账号将此角色授予发起账号（模板化）。

template_fields: collections.abc.Sequence[str] = ('query_id', 'report_id', 'bucket_name', 'report_name', 'impersonation_chain')[source]¶

query_id[source]¶

report_id[source]¶

chunk_size = 10485760[source]¶

gzip = True[source]¶

bucket_name[source]¶

report_name = None[source]¶

api_version = 'v2'[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

创建运算符时继承。

上下文是与渲染 Jinja 模板时使用的一样的字典。

请参阅 get_template_context 以获取更多上下文。

class airflow.providers.google.marketing_platform.operators.display_video.GoogleDisplayVideo360RunQueryOperator(*, query_id, parameters=None, api_version='v2', gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基类：airflow.models.BaseOperator

运行存储的查询以生成报告。

另请参阅

有关如何使用此运算符的更多信息，请参阅指南：运行查询

另请参阅

另请查阅官方 API 文档：https://developers.google.com/bid-manager/v2/queries/run

参数：:

report_id – 要运行的报告 ID。
parameters (dict[str, Any] | None) – 运行报告的参数，详情如下：https://developers.google.com/bid-manager/v2/queries/run
api_version (str) – 将要请求的 API 版本，例如 ‘v3’。
gcp_conn_id (str) – 检索连接信息时使用的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号，用于使用短期凭据进行模拟；或者一个账号链列表，用于获取列表中最后一个账号的访问令牌，该账号将在请求中被模拟。如果设置为字符串，则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列，列表中的身份必须将 Service Account Token Creator IAM 角色授予直接前一个身份，列表中第一个账号将此角色授予发起账号（模板化）。

template_fields: collections.abc.Sequence[str] = ('query_id', 'parameters', 'impersonation_chain')[source]¶

query_id[source]¶

api_version = 'v2'[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

parameters = None[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

创建运算符时继承。

上下文是与渲染 Jinja 模板时使用的一样的字典。

请参阅 get_template_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', impersonation_chain=None, **kwargs)[source]¶

基类：airflow.models.BaseOperator

检索 CSV 格式的行项目。

另请参阅

有关如何使用此运算符的更多信息，请参阅指南：下载行项目

另请参阅

另请查阅官方 API 文档：https://developers.google.com/bid-manager/v1.1/lineitems/downloadlineitems

参数：:: request_body (dict[str, Any]) – 包含应传入的参数的字典。更多信息请参阅此处：https://developers.google.com/bid-manager/v1.1/lineitems/downloadlineitems

template_fields: collections.abc.Sequence[str] = ('request_body', 'bucket_name', 'object_name', 'impersonation_chain')[source]¶

request_body[source]¶

object_name[source]¶

bucket_name[source]¶

gzip = False[source]¶

api_version = 'v1.1'[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

创建运算符时继承。

上下文是与渲染 Jinja 模板时使用的一样的字典。

请参阅 get_template_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', impersonation_chain=None, **kwargs)[source]¶

基类：airflow.models.BaseOperator

上传 CSV 格式的行项目。

另请参阅

关于如何使用此 Operator 的更多信息，请参阅指南：上传订单项

另请参阅

另请查看官方 API 文档：https://developers.google.com/bid-manager/v1.1/lineitems/uploadlineitems

参数：:

request_body – 上传订单项的请求。
bucket_name (str) – 下载表单数据的存储桶。
object_name (str) – 要获取的对象。
filename – 要获取的文件名。
dry_run – 上传状态，不实际持久化订单项。

template_fields: collections.abc.Sequence[str] = ('bucket_name', 'object_name', 'impersonation_chain')[source]¶

bucket_name[source]¶

object_name[source]¶

api_version = 'v1.1'[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

创建运算符时继承。

上下文是与渲染 Jinja 模板时使用的一样的字典。

请参阅 get_template_context 以获取更多上下文。

class airflow.providers.google.marketing_platform.operators.display_video.GoogleDisplayVideo360CreateSDFDownloadTaskOperator(*, body_request, api_version='v1', gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基类：airflow.models.BaseOperator

创建 SDF 操作任务。

另请参阅

关于如何使用此 Operator 的更多信息，请参阅指南：创建 SDF 下载任务

另请参阅

另请查看官方 API 文档：https://developers.google.com/display-video/api/reference/rest

参数：:

version – 下载文件的 SDF 版本。
partner_id – 要下载 SDF 的合作伙伴 ID。
advertiser_id – 要下载 SDF 的广告商 ID。
parent_entity_filter – 基于选定的文件类型进行筛选。
id_filter – 基于实体 ID 对实体进行筛选。
inventory_source_filter – 基于其 ID 对库存来源进行筛选。
gcp_conn_id (str) – 检索连接信息时使用的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号，用于使用短期凭据进行模拟；或者一个账号链列表，用于获取列表中最后一个账号的访问令牌，该账号将在请求中被模拟。如果设置为字符串，则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列，列表中的身份必须将 Service Account Token Creator IAM 角色授予直接前一个身份，列表中第一个账号将此角色授予发起账号（模板化）。

template_fields: collections.abc.Sequence[str] = ('body_request', 'impersonation_chain')[source]¶

body_request[source]¶

api_version = 'v1'[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

创建运算符时继承。

上下文是与渲染 Jinja 模板时使用的一样的字典。

请参阅 get_template_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', impersonation_chain=None, **kwargs)[source]¶

基类：airflow.models.BaseOperator

下载 SDF 媒体文件并将其保存到 Google Cloud Storage。

另请参阅

关于如何使用此 Operator 的更多信息，请参阅指南：将 SDF 文件保存到 Google Cloud Storage

另请参阅

另请查看官方 API 文档：https://developers.google.com/display-video/api/reference/rest

参数：:

version – 下载文件的 SDF 版本。
partner_id – 要下载 SDF 的合作伙伴 ID。
advertiser_id – 要下载 SDF 的广告商 ID。
parent_entity_filter – 基于选定的文件类型进行筛选。
id_filter – 基于实体 ID 对实体进行筛选。
inventory_source_filter – 基于其 ID 对库存来源进行筛选。
gcp_conn_id (str) – 检索连接信息时使用的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号，用于使用短期凭据进行模拟；或者一个账号链列表，用于获取列表中最后一个账号的访问令牌，该账号将在请求中被模拟。如果设置为字符串，则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列，列表中的身份必须将 Service Account Token Creator IAM 角色授予直接前一个身份，列表中第一个账号将此角色授予发起账号（模板化）。

template_fields: collections.abc.Sequence[str] = ('operation_name', 'bucket_name', 'object_name', 'impersonation_chain')[source]¶

operation_name[source]¶

bucket_name[source]¶

object_name[source]¶

gzip = False[source]¶

api_version = 'v1'[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

创建运算符时继承。

上下文是与渲染 Jinja 模板时使用的一样的字典。

请参阅 get_template_context 以获取更多上下文。