Reports.files

Files リソースはレポートの実行に関連付けられたメタデータです。各ファイルは親レポートに関連付けられ、レポート実行のステータスと、実行の日時、実際のレポートデータの URL に関する情報が含まれます。

このリソースのメソッドの一覧は、このページの最後に掲載されています。

リソース表現

Files リソースは次のように表されます。ファイルには、レポート実行のメタデータが含まれます。実行のステータスが示され、実行の終了時にステータスが "REPORT_AVAILABLE" の場合に生成されるレポートデータの URL が保持されます。

{
  "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
  }
}
プロパティ名 説明 メモ
dateRange nested object ファイル内のレポートデータの期間。この期間は常にレポートが実行される絶対期間です。
dateRange.endDate date 期間の終了日(その日付を含む)。形式 "yyyy-MM-dd" の文字列。 書き込み可能
dateRange.kind string リソースの種類。この場合は dfareporting#dateRange です。
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"
書き込み可能
dateRange.startDate date 期間の開始日(その日付を含む)。形式 "yyyy-MM-dd" の文字列。 書き込み可能
etag etag このリソースの Etag。
fileName string ファイルのファイル名。
format string レポートの出力形式。ファイルが入手可能な場合のみ使用できます。

設定可能な値は次のとおりです。
  • "CSV"
  • "EXCEL"
id long このレポート ファイルの一意の ID。
kind string リソースの種類を識別します。値: 固定文字列 "dfareporting#file"
lastModifiedTime long このファイルの最終変更のタイムスタンプ(エポックからのミリ秒)。
reportId long このファイルの生成元であるレポートの ID。
status string レポート ファイルのステータス。

設定可能な値は次のとおりです。
  • "CANCELLED"
  • "FAILED"
  • "PROCESSING"
  • "REPORT_AVAILABLE"
urls object 完了したレポート ファイルをダウンロードできる URL。
urls.apiUrl string API からレポートデータをダウンロードする場合の URL。
urls.browserUrl string ブラウザからレポートデータをダウンロードする場合の URL。

メソッド

レポートの全ファイルのリストを取得できます。また、ファイルの ID または親レポートの ID でファイルを 1 つ取得することもできます。

get
レポート ID とファイル ID でレポート ファイルを取得します。このメソッドは、メディア ダウンロードをサポートしています。
list
レポートのファイルのリストを取得します。