Method: sdfdownloadtasks.create

建立 SDF 下載工作。傳回 Operation。

SDF 下載工作是長時間執行的非同步作業。這項作業的 metadata 類型為 SdfDownloadTaskMetadata。如果要求成功，作業的 response 類型會是 SdfDownloadTask。回應不會包含下載檔案，必須使用 media.download 擷取。

您可以使用 sdfdownloadtasks.operations.get 擷取作業狀態。

您可以在 error.message 中找到任何錯誤。請注意，error.details 應為空白。

HTTP 要求

POST https://displayvideo.googleapis.com/v4/sdfdownloadtasks

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "version": enum (SdfVersion),

  // Union field root_id can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field root_id.

  // Union field filtering_option can be only one of the following:
  "parentEntityFilter": {
    object (ParentEntityFilter)
  },
  "idFilter": {
    object (IdFilter)
  },
  "inventorySourceFilter": {
    object (InventorySourceFilter)
  }
  // End of list of possible types for union field filtering_option.
}
欄位
version

enum (SdfVersion)

必要欄位。下載檔案的 SDF 版本。如果設為 SDF_VERSION_UNSPECIFIED，則預設會使用由廣告主或 root_id 所識別的合作夥伴指定的版本。除非另有設定，否則廣告主會沿用夥伴的 SDF 版本。
聯集欄位 root_id。必要欄位。根 ID 會決定下載要求的背景資訊。必須設定一個欄位。root_id 只能是下列其中一項：
partnerId

string (int64 format)

要下載 SDF 的合作夥伴 ID。
advertiserId

string (int64 format)

要下載 SDF 的廣告主 ID。
聯集欄位 filtering_option。必要欄位。指定要下載的實體類型和範圍的選項。必須設定一個欄位。filtering_option 只能是下列其中一項：
parentEntityFilter

object (ParentEntityFilter)

篩選所選檔案類型。每個檔案中的實體都會根據所選的篩選實體進行篩選。篩選器實體的類型必須與所選檔案類型的類型相同，或為其上層類型。
idFilter

object (IdFilter)

根據實體 ID 篩選實體。
inventorySourceFilter

object (InventorySourceFilter)

依 ID 篩選廣告空間來源。

回應主體

如果成功，回應主體會包含新建立的 Operation 例項。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/display-video

詳情請參閱 OAuth 2.0 Overview。

ParentEntityFilter

篩選選項，可篩選所選檔案類型，這些檔案類型屬於所選的篩選實體組合。

JSON 表示法 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
欄位
fileType[]

enum (FileType)

必要欄位。系統會傳回的檔案類型。
filterType

enum (FilterType)

必要欄位。用於篩選擷取實體的篩選器類型。
filterIds[]

string (int64 format)

指定篩選器類型的 ID。用於篩選要擷取的實體。如果篩選器類型不是 FILTER_TYPE_NONE，則必須指定至少一個 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 廣告。
FILE_TYPE_LINE_ITEM_QA 委刊項 - QA 格式。
FILE_TYPE_AD_GROUP_QA YouTube 廣告群組 - QA 格式。

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 都必須是廣告訂單 ID，且屬於 CreateSdfDownloadTaskRequest 中指定的 Advertiser 或 Partner。只能用於下載 FILE_TYPE_INSERTION_ORDER、FILE_TYPE_LINE_ITEM、FILE_TYPE_LINE_ITEM_QA、FILE_TYPE_AD_GROUP、FILE_TYPE_AD_GROUP_QA 和 FILE_TYPE_AD。
FILTER_TYPE_LINE_ITEM_ID 委刊項 ID。如果選取這個選項，所有篩選器 ID 都必須是委刊項 ID，且屬於 CreateSdfDownloadTaskRequest 中指定的 Advertiser 或 Partner。只能用於下載 FILE_TYPE_LINE_ITEM、FILE_TYPE_LINE_ITEM_QA、FILE_TYPE_AD_GROUP、FILE_TYPE_AD_GROUP_QA 和 FILE_TYPE_AD。

IdFilter

篩選選項，可依實體 ID 篩選實體。

JSON 表示法 
{
  "campaignIds": [
    string
  ],
  "mediaProductIds": [
    string
  ],
  "insertionOrderIds": [
    string
  ],
  "lineItemIds": [
    string
  ],
  "adGroupIds": [
    string
  ],
  "adGroupAdIds": [
    string
  ],
  "lineItemQaIds": [
    string
  ],
  "adGroupQaIds": [
    string
  ]
}
欄位
campaignIds[]

string (int64 format)

要下載的廣告活動 ID。所有 ID 都必須屬於 CreateSdfDownloadTaskRequest 中指定的 Advertiser 或 Partner。
mediaProductIds[]

string (int64 format)

要下載的媒體產品 ID。所有 ID 都必須屬於 CreateSdfDownloadTaskRequest 中指定的 Advertiser 或 Partner。
insertionOrderIds[]

string (int64 format)

要下載的廣告訂單 ID。所有 ID 都必須屬於 CreateSdfDownloadTaskRequest 中指定的 Advertiser 或 Partner。
lineItemIds[]

string (int64 format)

依 ID 下載的委刊項。所有 ID 都必須屬於 CreateSdfDownloadTaskRequest 中指定的 Advertiser 或 Partner。
adGroupIds[]

string (int64 format)

要下載的 YouTube 廣告群組 ID。所有 ID 都必須屬於 CreateSdfDownloadTaskRequest 中指定的 Advertiser 或 Partner。
adGroupAdIds[]

string (int64 format)

要下載的 YouTube 廣告 ID。所有 ID 都必須屬於 CreateSdfDownloadTaskRequest 中指定的 Advertiser 或 Partner。
lineItemQaIds[]

string (int64 format)

選用設定。以 ID 為依據的委刊項，以便以 QA 格式下載。所有 ID 都必須屬於 CreateSdfDownloadTaskRequest 中指定的 Advertiser 或 Partner。
adGroupQaIds[]

string (int64 format)

選用設定。以 ID 為單位，下載 YouTube 廣告群組的 QA 格式。所有 ID 都必須屬於 CreateSdfDownloadTaskRequest 中指定的 Advertiser 或 Partner。

InventorySourceFilter

用於篩選廣告空間來源實體的篩選器選項。

JSON 表示法 
{
  "inventorySourceIds": [
    string
  ]
}
欄位
inventorySourceIds[]

string (int64 format)

要下載的廣告空間來源 ID。所有 ID 都必須屬於 CreateSdfDownloadTaskRequest 中指定的 Advertiser 或 Partner。如要下載所選廣告主或合作夥伴的所有廣告空間來源，請留空白。