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

影片廣告素材的專屬 ID (如果擷取成功)。廣告素材資源的名稱為 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

建立廣告素材要求的擷取狀態。

欄位
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 串流影片提交。