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/v5/sdfdownloadtasks

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

リクエストの本文

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

JSON 表現 
{
  "version": enum (SdfVersion),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "parentEntityFilter": {
    object (ParentEntityFilter)
  },
  "idFilter": {
    object (IdFilter)
  },
  "inventorySourceFilter": {
    object (InventorySourceFilter)
  }
  // End of mutually exclusive fields.
}
フィールド
version

enum (SdfVersion)

必須。ダウンロードしたファイルの SDF バージョン。SDF_VERSION_UNSPECIFIED に設定すると、デフォルトで root_id で識別される広告主またはパートナーが指定したバージョンになります。広告主は、特に設定されていない限り、パートナーから SDF バージョンを継承します。
必須。ルート ID によって、ダウンロード リクエストのコンテキストが決まります。1 つのフィールドだけを設定する必要があります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
partnerId

string (int64 format)

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

string (int64 format)

SDF をダウンロードする広告主の ID。
相互に排他的なフィールドの終了。
必須。ダウンロードするエンティティ タイプと範囲を指定するオプション。1 つのフィールドだけを設定する必要があります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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 でない場合は、少なくとも 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 形式でダウンロードする YouTube 広告グループ（ID 別）。すべての ID は、CreateSdfDownloadTaskRequest で指定された同じ Advertiser または Partner に属している必要があります。

InventorySourceFilter

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

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

string (int64 format)

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