ContentCategories: list

コンテンツ カテゴリのリストを取得します。結果をフィルタできます。このメソッドはページ分けをサポートしています。実習をご覧ください。

リクエスト

HTTP リクエスト

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

パラメータ

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

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

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

認証

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

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

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

リクエストの本体

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

レスポンス

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

{
  "kind": "dfareporting#contentCategoriesListResponse",
  "nextPageToken": string,
  "contentCategories": [
    contentCategories Resource
  ]
}
プロパティ名 説明 メモ
kind string リソースの種類を識別します。値: 固定文字列 "dfareporting#contentCategoriesListResponse"
contentCategories[] list コンテンツ カテゴリのコレクション。
nextPageToken string 次回のリスト操作に使用するページ分けトークン。

実習

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