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 表示する結果の最大数。有効な値は 0 以上 1000 以下です(デフォルト: 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 を使用し、ライブデータに対してこのメソッドを呼び出して、レスポンスを確認してみましょう。