Sdf: download

SDF 形式のエンティティを取得します。実習をご覧ください。

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/doubleclickbidmanager/v1.1/sdf/download

承認

このリクエストには、次のスコープによる認証が必要です。

範囲
https://www.googleapis.com/auth/doubleclickbidmanager

詳細については、認証と承認のページをご覧ください。

リクエスト本文

リクエストの本文には、以下の構造を使用してデータを指定してください。

{
  "fileTypes": [
    string
  ],
  "filterType": string,
  "filterIds": [
    long
  ],
  "version": string
}
プロパティ名 説明 備考
fileTypes[] list 返されるファイル形式。INVENTORY_SOURCE がリクエストされた場合、他のファイル形式はリクエストできません。

有効な値は次のとおりです。
  • AD
  • AD_GROUP
  • CAMPAIGN
  • INSERTION_ORDER
  • INVENTORY_SOURCE
  • LINE_ITEM
filterType string 取得するエンティティをフィルタするために使用されるフィルタタイプ。PARTNER_ID と INVENTORY_SOURCE_ID は、広告枠ソースをダウンロードする際にのみ使用できます。

有効な値は次のとおりです。
  • ADVERTISER_ID
  • CAMPAIGN_ID
  • INSERTION_ORDER_ID
  • INVENTORY_SOURCE_ID
  • LINE_ITEM_ID
  • PARTNER_ID
filterIds[] list 指定したフィルタタイプの ID。これは、取得するエンティティをフィルタするために使用されます。少なくとも 1 つの ID を指定する必要があります。ADVERTISER_ID フィルタタイプに使用できる ID は 1 つのみです。INSERTION_ORDER_ID または LINE_ITEM_ID のフィルタタイプの場合、すべての ID を同じ広告主のものにする必要があります。
version string エンティティが返される SDF バージョン(列名、型、順序)。デフォルトは 5.3 です。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "campaigns": string,
  "insertionOrders": string,
  "lineItems": string,
  "adGroups": string,
  "ads": string,
  "inventorySources": string
}
プロパティ名 説明 備考
insertionOrders string 広告掲載オーダーを SDF 形式で取得しました。
lineItems string SDF 形式で広告申込情報を取得しました。
adGroups string SDF 形式の広告グループを取得しました。
ads string SDF 形式の広告を取得しました。
campaigns string SDF 形式で取得されたキャンペーン。
inventorySources string

実習

以下の API Explorer を使用して、ライブデータでこのメソッドを呼び出し、レスポンスを確認します。 または、スタンドアロンの Explorer をお試しください。