Placements: list

プレースメントの一覧を取得します。結果をフィルタできます。このメソッドはページングをサポートします。実習をご覧ください。

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/placements

パラメータ

パラメータ名 説明
パスパラメータ
profileId long このリクエストに関連付けられるユーザー プロフィール ID。
省略可能なクエリ パラメータ
advertiserIds long これらの広告主に属するプレースメントのみを選択します。
archived boolean アーカイブ済みのプレースメントのみを選択します。このフィールドの設定で、アーカイブ済みのプレースメントとアーカイブされていないプレースメントの両方を選択することはできません。
campaignIds long これらのキャンペーンに属するプレースメントのみを選択します。
compatibilities string これらの互換性に関連付けられているプレースメントのみを選択します。DISPLAYDISPLAY_INTERSTITIAL は、パソコンまたはモバイル デバイスにおける通常の広告のレンダリングとインタースティシャル広告のレンダリングをそれぞれ表します。APPAPP_INTERSTITIAL は、モバイルアプリでのレンダリングを表します。IN_STREAM_VIDEO は、VAST 規格で開発されたインストリーム動画広告でのレンダリングを表します。

有効な値は次のとおりです。
  • APP
  • APP_INTERSTITIAL
  • DISPLAY
  • DISPLAY_INTERSTITIAL
  • IN_STREAM_AUDIO
  • IN_STREAM_VIDEO
contentCategoryIds long これらのコンテンツ カテゴリに関連付けられているプレースメントのみを選択します。
directorySiteIds long これらのディレクトリ サイトに関連付けられているプレースメントのみを選択します。
groupIds long これらのプレースメント グループに属するプレースメントのみを選択します。
ids long これらの ID を持つプレースメントのみを選択します。
maxEndDate string 指定した maxEndDate 以前の終了日を持つプレースメントまたはプレースメント グループのみを選択します。「yyyy-MM-dd」形式の日付を指定する必要があります。
maxResults integer 表示する結果の最大数。有効な値は 0 以上 1000 以下です(デフォルト: 1000)。
maxStartDate string 指定した maxStartDate 以前の開始日を持つプレースメントまたはプレースメント グループのみを選択します。「yyyy-MM-dd」形式の日付を指定する必要があります。
minEndDate string 指定した minEndDate 以後の終了日を持つプレースメントまたはプレースメント グループのみを選択します。「yyyy-MM-dd」形式の日付を指定する必要があります。
minStartDate string 指定した minStartDate 以後の開始日を持つプレースメントまたはプレースメント グループのみを選択します。「yyyy-MM-dd」形式の日付を指定する必要があります。
pageToken string 前の結果ページの nextPageToken の値。
paymentSource string この支払い元を持つプレースメントのみを選択します。

有効な値は次のとおりです。
  • PLACEMENT_AGENCY_PAID
  • PLACEMENT_PUBLISHER_PAID
placementStrategyIds long これらのプレースメント戦略に関連付けられているプレースメントのみを選択します。
pricingTypes string これらの料金タイプを持つプレースメントのみを選択します。

有効な値は次のとおりです。
  • PRICING_TYPE_CPA
  • PRICING_TYPE_CPC
  • PRICING_TYPE_CPM
  • PRICING_TYPE_CPM_ACTIVEVIEW
  • PRICING_TYPE_FLAT_RATE_CLICKS
  • PRICING_TYPE_FLAT_RATE_IMPRESSIONS
searchString string 名前または ID により、プレースメントを検索できます。ワイルドカード(*)を使用できます。たとえば、"placement*2015" を検索すると、"placement June 2015""placement May 2015"、または単に "placements 2015" のような名前を持つプレースメントが返されます。また、ほとんどの検索では、検索文字列の先頭と末尾にワイルドカードが暗黙的に付加されます。たとえば、"placement" という検索文字列は、"my placement""placement 2015"、または単に "placement" という名前を持つプレースメントに一致します。
siteIds long これらのサイトに関連付けられているプレースメントのみを選択します。
sizeIds long これらのサイズに関連付けられているプレースメントのみを選択します。
sortField string 結果の並べ替え基準として使用するフィールド。

有効な値は次のとおりです。
  • ID」(デフォルト)
  • NAME
sortOrder string 結果の並べ替え順序。

有効な値は次のとおりです。
  • ASCENDING」(デフォルト)
  • DESCENDING

認証

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

スコープ
https://www.googleapis.com/auth/dfatrafficking

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

リクエストの本文

このメソッドでは、リクエストの本体を指定しません。

レスポンス

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

{
  "kind": "dfareporting#placementsListResponse",
  "nextPageToken": string,
  "placements": [
    placements Resource
  ]
}
プロパティ名 説明 メモ
kind string リソースの種類を示します。値は固定文字列 "dfareporting#placementsListResponse" です。
placements[] list プレースメントのコレクション。
nextPageToken string 次のリストに移動する操作に使用されるページ分けトークン。

試してみる

以下の API Explorer を使用し、ライブデータに対してこのメソッドを呼び出して、レスポンスを確認してみましょう。