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/v3/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 でない場合、少なくとも 1 つの 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 は、CreateSdfDownloadTaskRequest で指定された Advertiser または Partner に属する広告掲載オーダー ID である必要があります。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 は、CreateSdfDownloadTaskRequest で指定された Advertiser または Partner に属する広告申込情報 ID である必要があります。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)

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

string (int64 format)

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

string (int64 format)

省略可。QA 形式でダウンロードする広告申込情報（ID 別）。すべての ID は、CreateSdfDownloadTaskRequest で指定された同じ Advertiser または Partner に属している必要があります。
adGroupQaIds[]

string (int64 format)

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

InventorySourceFilter

広告在庫ソースのエンティティをフィルタするためのフィルタ オプション。

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

string (int64 format)

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