Campaign Manager 360 API v3.4 はサポートが終了し、2022 年 1 月 10 日に廃止されます。この日までに、すべてのユーザーが新しいバージョンの API に移行する必要があります。

TargetingTemplates: list

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

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名 説明
パス パラメータ
profileId long このリクエストに関連付けられるユーザー プロフィール ID。
省略可能なクエリ パラメータ
advertiserId long この広告主 ID を持つターゲティング テンプレートのみを選択します。
ids long これらの ID を持つターゲティング テンプレートのみを選択します。
maxResults integer 表示する結果の最大数。設定可能な値は 01000 です。デフォルトは 1000 です。
pageToken string 前回の結果ページの nextPageToken の値。
searchString string 名前または ID でオブジェクトを検索できます。ワイルドカード(*)を使用できます。たとえば、"template*2015" を検索すると、"template June 2015""template April 2015"、または単に "template 2015" のような名前を持つオブジェクトが返されます。また、ほとんどの検索では、検索文字列の先頭と末尾にワイルドカードが暗黙的に付加されます。たとえば、"template" という検索文字列は、"my template""template 2015"、または単に "template" という名前のオブジェクトに一致します。
sortField string リストの並べ替え基準として使用するフィールド。

設定可能な値は次のとおりです。
  • "ID"(デフォルト)
  • "NAME"
sortOrder string 結果の並べ替え順序。

設定可能な値は次のとおりです。
  • "ASCENDING"(デフォルト)
  • "DESCENDING"

認証

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

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

詳しくは、認証と認可のページをご覧ください。

リクエストの本文

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

レスポンス

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

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

実習

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