如需本資源的方法清單,請見本頁結尾。
資源表示法
代表報表。
{ "key": { "queryId": long, "reportId": long }, "metadata": { "status": { "state": string, "failure": { "errorCode": string }, "finishTimeMs": long, "format": string }, "reportDataStartTimeMs": long, "reportDataEndTimeMs": long, "googleCloudStoragePath": string }, "params": { "type": string, "groupBys": [ string ], "filters": [ { "type": string, "value": string } ], "metrics": [ string ], "includeInviteData": boolean } }
屬性名稱 | 值 | 說明 | 附註 |
---|---|---|---|
key |
nested object |
用於識別報表的鍵。 | |
key.queryId |
long |
查詢 ID。 | |
key.reportId |
long |
報表 ID。 | |
metadata |
nested object |
報表中繼資料。 | |
metadata.googleCloudStoragePath |
string |
Google Cloud Storage 儲存報表位置的路徑。 | |
metadata.reportDataEndTimeMs |
long |
報表所顯示資料的結束時間。 | |
metadata.reportDataStartTimeMs |
long |
報表所顯示資料的開始時間。 | |
metadata.status |
nested object |
報表狀態。 | |
metadata.status.failure |
nested object |
如果檢舉失敗,這裡會記錄原因。 | |
metadata.status.failure.errorCode |
string |
錯誤代碼,用於顯示未建立報表的原因。
可接受的值為:
|
|
metadata.status.finishTimeMs |
long |
報表順利完成或失敗的時間。 | |
metadata.status.format |
string |
報表的檔案類型。
可接受的值為:
|
|
metadata.status.state |
string |
報表的狀態。
可接受的值為:
|
|
params |
nested object |
報表參數。 | |
params.filters[] |
list |
用來比對報表流量資料的篩選器。 | |
params.filters[].type |
string |
篩選器類型。
可接受的值為:
|
|
params.filters[].value |
string |
篩選條件值。 | |
params.groupBys[] |
list |
系統會按照這個欄位中列出的篩選器將資料分組。 | |
params.includeInviteData |
boolean |
已淘汰,這個欄位已無法使用。 | |
params.metrics[] |
list |
要以欄形式納入報表的指標。 | |
params.type |
string |
報表類型。 特定類型限制:
可接受的值為:
|
方法
- listreports
- 擷取已儲存的報表。