Package google.ads.dai.v1

索引

PartnerDiscoveryService

管理广告素材的 DAI 提取和 YouTube 上传。

CreateCreative

rpc CreateCreative(CreateCreativeRequest) returns (Operation)

创建广告素材。成功完成时,会在 response 字段中返回广告素材;失败时,会返回 google.rpc.Code。返回 CreateCreativeOperationMetadata,其中包含 metadata 字段中的提取状态。

DeleteCreative

rpc DeleteCreative(DeleteCreativeRequest) returns (Empty)

删除广告素材。

GetCreative

rpc GetCreative(GetCreativeRequest) returns (Creative)

获取广告素材。

CreateCreativeOperationMetadata

CreateCreative 返回的长时间运行操作的元数据。以 metadata 的身份展示。

字段
creative_url

string

用于提取的广告素材的网址。这是所选的中继层网址或媒体呈现网址,系统会根据请求中提供的媒体资源选择此网址。

gv_registry_id

string

视频广告素材的唯一标识符(如果提取成功)。广告素材资源的名称为 creatives/gv_registry_id

create_time

Timestamp

提取请求的创建时间。

youtube_status

IngestionStatus

当前的 YouTube 提取状态。

CreateCreativeRequest

PartnerDiscoveryService.CreateCreative 的请求。

字段
creative

Creative

要提取的广告素材。

dynamic_creative_info

DynamicCreativeInfo

动态广告素材的相关信息。如果要提取的广告素材是动态广告素材,则必填。

广告素材

广告素材资源。在完成 PartnerDiscoveryService.CreateCreative 后显示为 response

字段
name

string

仅限输出。广告素材资源的唯一名称(Google 视频 ID),格式为 creatives/id

advertiser

string

此广告素材中展示的广告客户的名称。

ad_system

string

必需。生成提取请求的广告系统的名称。

ad_title

string

广告的标题。

ad_description

string

广告的说明。

mezzanines[]

MediaFile

广告的中间文件网址及其属性。必须至少提供 mezannines 或 media_files 中的一种。

media_files[]

MediaFile

广告的媒体文件网址及其属性。必须至少提供 mezannines 或 media_files 中的一种。

network_code

string

可选。广告素材的目标发布商的 Google Ad Manager 广告资源网代码。如果广告素材是动态广告素材,并且 CreateCreativeRequest 中填充了 DynamicCreativeInfo,则必填。

DeleteCreativeRequest

PartnerDiscoveryService.DeleteCreative 的请求。

字段
name

string

要删除的广告素材的 Google 视频 ID。

DynamicCreativeInfo

动态广告素材执行 VCL 处理所需的信息。

字段
dynamic_group_id

string

表示广告素材核心视频广告的 ID。同一动态组 ID 下的所有动态广告素材都可以视为内容相同,但广告素材的动态方面不同。

active_duration

Duration

此广告素材被视为有效且正在使用的时长。在此时间过后,系统会安排在视频广告素材代码库中删除相应广告素材。时长上限为 180 天。如果未指定此字段,系统将应用 30 天的默认时长。

FailureReason

广告素材提取失败的原因。

字段
reason

Reason

广告素材提取失败的说明。

code

int32

如果原因为 DOWNLOAD_ERROR,则为失败的 HTTP 状态代码。

原因

广告素材提取失败的可能原因。

枚举
REASON_UNSPECIFIED 默认值。
DOWNLOAD_ERROR HTTP 下载失败。
INTERNAL_ERROR 内部错误。
INVALID_MEDIA 媒体无效。

GetCreativeRequest

PartnerDiscoveryService.GetCreative 的请求。

字段
name

string

广告素材的 Google 视频 ID。

IngestionStatus

“Create Creative”请求的提取状态。

字段
state

State

视频广告素材的当前提取状态。

failure_reason

FailureReason

广告素材提取失败的原因(如果提取失败)。

update_time

Timestamp

提取作业的上次更新时间。

提取状态。

枚举
STATE_UNSPECIFIED 默认值。
PROCESSING 视频广告素材仍在处理中。
SUCCESS 视频广告素材已成功处理完毕。
FAILURE 未能提取视频广告素材,请参阅 FailureReason。

MediaFile

与给定媒体文件相关的属性。

字段
uri

string

必需。指向广告素材媒体文件的唯一网址。

delivery

Delivery

必需。广告素材的提交类型。

height

int32

视频文件的原始高度(以像素为单位)。

width

int32

视频文件的原始宽度(以像素为单位)。

mime_type

string

必需。文件容器的 MIME 类型。热门 MIME 类型包括适用于 Flash 视频的“video/x-flv”和适用于 MP4 的“video/mp4”。

min_bitrate

int32

媒体文件的最小比特率。对于渐进式加载视频,此值应为平均比特率。

max_bitrate

int32

媒体文件的最大比特率。对于渐进式加载视频,此值应为平均比特率。

送餐

传送类型。

枚举
DELIVERY_UNSPECIFIED 默认传送值。
DELIVERY_PROGRESSIVE 渐进式视频传送。
DELIVERY_STREAMING 流式视频传送。