Reports: run

レポートを実行します。実習をご覧ください。

レポートはデフォルトでは非同期で実行されます。小規模のレポートであれば同期でも実行できます。レポートの同期実行が時間内に終了しなかった場合も、レポート ファイルは返され、レポートは非同期で処理されます。

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/reports/reportId/run

パラメータ

パラメータ名 説明
パスパラメータ
profileId long キャンペーン マネージャー 360 ユーザー プロフィール ID。
reportId long レポートの ID。
省略可能なクエリ パラメータ
synchronous boolean true に設定すると、レポートの同期実行が試行されます(デフォルト: false)。

認証

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

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

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

リクエストの本体

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

レスポンス

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

{
  "kind": "dfareporting#file",
  "etag": etag,
  "reportId": long,
  "id": long,
  "lastModifiedTime": long,
  "status": string,
  "fileName": string,
  "format": string,
  "dateRange": {
    "kind": "dfareporting#dateRange",
    "startDate": date,
    "endDate": date,
    "relativeDateRange": string
  },
  "urls": {
    "browserUrl": string,
    "apiUrl": string
  }
}
プロパティ名 説明 メモ
kind string リソースの種類を識別します。値: 固定文字列 "dfareporting#file"
etag etag このリソースの ETag。
reportId long このファイルの生成元であるレポートの ID。
id long このレポート ファイルの一意の ID。
lastModifiedTime long このファイルの最終変更のタイムスタンプ(エポックからのミリ秒単位の経過時間)。
status string レポート ファイルのステータス。

設定可能な値は次のとおりです。
  • "CANCELLED"
  • "FAILED"
  • "PROCESSING"
  • "REPORT_AVAILABLE"
fileName string ファイルのファイル名。
format string レポートの出力形式。ファイルが入手可能な場合のみ使用できます。

設定可能な値は次のとおりです。
  • "CSV"
  • "EXCEL"
dateRange nested object ファイル内のレポートデータの期間。この期間は常にレポートが実行される絶対期間です。
dateRange.kind string リソースの種類。この場合は dfareporting#dateRange です。
dateRange.startDate date 期間の開始日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
dateRange.endDate date 期間の終了日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
dateRange.relativeDateRange string レポートの実行日を基準とする期間。

設定可能な値は次のとおりです。
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
書き込み可能
urls object 完了したレポート ファイルをダウンロードできる URL。
urls.browserUrl string ブラウザからレポートデータをダウンロードする場合の URL。
urls.apiUrl string API でレポートデータをダウンロードする場合の URL。

実習

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