建立 SDF 下載工作。傳回 Operation
。
SDF 下載工作是一項長時間執行的非同步作業。這項作業的 metadata
類型為 SdfDownloadTaskMetadata
。如果要求成功,作業的 response
類型為 SdfDownloadTask
。回應中不會包含下載檔案,必須使用 media.download
擷取。您可以使用 sdfdownloadtask.operations.get
擷取作業狀態。
你可以在error.message
中找到所有錯誤。請注意,error.details
應為空白。
HTTP 要求
POST https://displayvideo.googleapis.com/v1/sdfdownloadtasks
這個網址使用 gRPC 轉碼語法。
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "version": enum ( |
欄位 | |
---|---|
version |
必要欄位。下載檔案的 SDF 版本。如果設為 |
聯集欄位 root_id 。必要欄位。根 ID 會決定下載要求的內容。只能設定一個欄位。root_id 只能是下列其中一項: |
|
partnerId |
合作夥伴 ID,用於下載 SDF 的資料。 |
advertiserId |
要下載 SDF 的廣告客戶 ID。 |
聯集欄位 filtering_option 。必要欄位。選項可用於指定要下載的實體類型和範圍。只能設定一個欄位。filtering_option 只能是下列其中一項: |
|
parentEntityFilter |
所選檔案類型的篩選條件。每個檔案中的實體都是以一組指定的篩選器實體進行篩選。篩選器實體的類型必須與所選檔案類型相同,或是父項類型。 |
idFilter |
按照實體 ID 篩選實體。 |
inventorySourceFilter |
依 ID 篩選廣告空間來源。 |
回應主體
如果成功,回應主體會包含新建立的 Operation
例項。
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/display-video
詳情請參閱 OAuth 2.0 總覽。
ParentEntityFilter
篩選選項,可篩選所選篩選器實體中的所選檔案類型。
JSON 表示法 |
---|
{ "fileType": [ enum ( |
欄位 | |
---|---|
fileType[] |
必要欄位。要傳回的檔案類型。 |
filterType |
必要欄位。用於篩選已擷取實體的篩選器類型。 |
filterIds[] |
指定篩選器類型的 ID。可用於篩選要擷取的實體。如果篩選條件類型不是「 |
FileType
可以下載的檔案類型。
列舉 | |
---|---|
FILE_TYPE_UNSPECIFIED |
未指定類型,或這個版本中不明時的預設值。 |
FILE_TYPE_CAMPAIGN |
廣告活動。 |
FILE_TYPE_MEDIA_PRODUCT |
媒體產品。 |
FILE_TYPE_INSERTION_ORDER |
廣告訂單。 |
FILE_TYPE_LINE_ITEM |
委刊項。 |
FILE_TYPE_AD_GROUP |
YouTube 廣告群組。 |
FILE_TYPE_AD |
YouTube 廣告。 |
FilterType
可以篩除的類型。
列舉 | |
---|---|
FILTER_TYPE_UNSPECIFIED |
未指定類型,或這個版本中不明時的預設值。 |
FILTER_TYPE_NONE |
如未選取,則下載內容不會套用任何篩選條件。只有在 CreateSdfDownloadTaskRequest 中指定了 Advertiser 時,才能使用。 |
FILTER_TYPE_ADVERTISER_ID |
廣告主 ID。如果選取這個選項,所有篩選器 ID 都必須屬於 CreateSdfDownloadTaskRequest 所指定 Partner 的廣告主 ID。 |
FILTER_TYPE_CAMPAIGN_ID |
廣告活動 ID。如果選取這個選項,所有篩選器 ID 都必須屬於 CreateSdfDownloadTaskRequest 中指定的 Advertiser 或 Partner 的廣告活動 ID。 |
FILTER_TYPE_MEDIA_PRODUCT_ID |
媒體產品 ID。如果選取這個選項,所有篩選器 ID 都必須屬於 CreateSdfDownloadTaskRequest 中指定的 Advertiser 或 Partner 的媒體產品 ID。只能用於下載「FILE_TYPE_MEDIA_PRODUCT 」。 |
FILTER_TYPE_INSERTION_ORDER_ID |
廣告訂單 ID。如果選取這個選項,所有篩選器 ID 都必須屬於 CreateSdfDownloadTaskRequest 中指定的 Advertiser 或 Partner 的廣告訂單 ID。只能用於下載 FILE_TYPE_INSERTION_ORDER 、FILE_TYPE_LINE_ITEM 、FILE_TYPE_AD_GROUP 和 FILE_TYPE_AD 。 |
FILTER_TYPE_LINE_ITEM_ID |
委刊項 ID。如果選取這個選項,所有篩選器 ID 都必須屬於 CreateSdfDownloadTaskRequest 中指定的 Advertiser 或 Partner 的委刊項 ID。只能用於下載 FILE_TYPE_LINE_ITEM 、FILE_TYPE_AD_GROUP 和 FILE_TYPE_AD 。 |
IdFilter
篩選選項,可根據實體 ID 篩選實體。
JSON 表示法 |
---|
{ "campaignIds": [ string ], "mediaProductIds": [ string ], "insertionOrderIds": [ string ], "lineItemIds": [ string ], "adGroupIds": [ string ], "adGroupAdIds": [ string ] } |
欄位 | |
---|---|
campaignIds[] |
要按 ID 下載的廣告活動。所有 ID 都必須屬於 |
mediaProductIds[] |
要依 ID 下載的媒體產品。所有 ID 都必須屬於 |
insertionOrderIds[] |
要依 ID 下載的廣告訂單。所有 ID 都必須屬於 |
lineItemIds[] |
依 ID 下載的委刊項。所有 ID 都必須屬於 |
adGroupIds[] |
要依 ID 下載的 YouTube 廣告群組。所有 ID 都必須屬於 |
adGroupAdIds[] |
要按 ID 下載的 YouTube 廣告。所有 ID 都必須屬於 |
InventorySourceFilter
篩選廣告空間來源實體的篩選選項。
JSON 表示法 |
---|
{ "inventorySourceIds": [ string ] } |
欄位 | |
---|---|
inventorySourceIds[] |
要下載的廣告空間來源 (按 ID 劃分)。所有 ID 都必須屬於 |