Method: sdfdownloadtasks.create

SDF ダウンロード タスクを作成します。Operation を返します。

SDF ダウンロード タスクは、長時間実行される非同期処理です。このオペレーションの metadata 型は SdfDownloadTaskMetadata です。リクエストが成功した場合、オペレーションの response タイプは SdfDownloadTask です。レスポンスにはダウンロード ファイルは含まれません。ダウンロード ファイルは media.download で取得する必要があります。オペレーションの状態は sdfdownloadtask.operations.get で取得できます。

エラーは error.message で確認できます。error.details は空であることが想定されています。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

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 によってダウンロード リクエストのコンテキストが決まります。フィールドを 1 つだけ設定する必要があります。root_id は次のいずれかになります。
partnerId

string (int64 format)

SDF をダウンロードするパートナーの ID。
advertiserId

string (int64 format)

SDF をダウンロードする広告主の ID。
共用体フィールド filtering_option。必須。ダウンロードするエンティティのタイプと範囲を指定するオプション。フィールドを 1 つだけ設定する必要があります。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 の概要をご覧ください。

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 を少なくとも 1 つ指定する必要があります。

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 オンにすると、ダウンロードにフィルタは適用されません。Advertiser が CreateSdfDownloadTaskRequest で指定されている場合にのみ使用できます。
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[]

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)

ID でダウンロードする YouTube 広告グループ。すべての ID は、CreateSdfDownloadTaskRequest で指定された同じ Advertiser または Partner に属している必要があります。
adGroupAdIds[]

string (int64 format)

ID でダウンロードする YouTube 広告。すべての ID は、CreateSdfDownloadTaskRequest で指定された同じ Advertiser または Partner に属している必要があります。

InventorySourceFilter

広告枠ソース エンティティをフィルタするフィルタ オプション。

JSON 表現 
{
  "inventorySourceIds": [
    string
  ]
}
フィールド
inventorySourceIds[]

string (int64 format)

ID でダウンロードする広告枠ソース。すべての ID は、CreateSdfDownloadTaskRequest で指定された同じ Advertiser または Partner に属している必要があります。選択した広告主またはパートナーのすべての広告枠ソースをダウンロードするには、空白のままにします。