Reports: list

レポートのリストを取得します。実習をご覧ください。

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名 説明
パスパラメータ
profileId long キャンペーン マネージャー 360 ユーザー プロフィール ID。
省略可能なクエリ パラメータ
maxResults integer 表示する結果の最大数。設定可能な値は 010 です。(デフォルト: 10)。
pageToken string 前の結果ページの nextToken の値。
scope string 表示する結果を定義するスコープ。

設定可能な値は次のとおりです。
  • "ALL": アカウント内のすべてのレポート。
  • "MINE": 自分のレポート(デフォルト)。
sortField string 結果の並べ替え基準として使用するフィールド。

設定可能な値は次のとおりです。
  • "ID": レポート ID で並べ替え。
  • "LAST_MODIFIED_TIME": 「lastModifiedTime」フィールドで並べ替え (デフォルト)。
  • "NAME": レポートの名前で並べ替え。
sortOrder string 結果の並べ替え順序。

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

認証

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

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

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

リクエストの本体

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

レスポンス

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

{
  "kind": "dfareporting#reportList",
  "etag": etag,
  "nextPageToken": string,
  "items": [
    reports Resource
  ]
}
プロパティ名 説明 メモ
kind string リストの種類。この場合は dfareporting#reportList です。
etag etag キャッシュ保存用のこのレスポンスの ETag。
nextPageToken string レポートのページ スルーに使用する連続トークン。次の結果ページを取得するには、次のリクエストの「pageToken」をこのフィールドの値に設定します。ページ トークンは、時間が限定され永続ではない場合にのみ有効です。
items[] list このレスポンスで返されたレポート。

実習

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