- HTTP 要求
- 路徑參數
- 要求主體
- 回應主體
- 授權範圍
- ResponseMetaData
- SchemaRestrictionResponse
- ActiveMetricRestriction
- RestrictedMetricType
- 試試看!
擷取報表工作的內容。要求 reportTasks.create
後,您可以在報表啟用後擷取報表內容。如果報表工作的狀態不是 ACTIVE
,這個方法就會傳回錯誤。查詢回應會傳回表格列,資料欄中的值。
HTTP 要求
POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
name |
必要欄位。報表來源名稱。格式: |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "offset": string, "limit": string } |
欄位 | |
---|---|
offset |
選用設定。報表中起始列的列數。第一列會計為第 0 列。 分頁時,第一個要求不會指定位移;或等於,將偏移值設為 0;第一個要求會傳回前 如要進一步瞭解這個分頁參數,請參閱「分頁」。 |
limit |
選用設定。報表中要傳回的列數。如未指定,系統會傳回 10,000 列。無論您要求多少列,API 在每個要求最多只能傳回 250,000 列。 如果維度值數量不如 如要進一步瞭解這個分頁參數,請參閱「分頁」。 |
回應主體
與報表工作對應的報表內容。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
---|
{ "dimensionHeaders": [ { object ( |
欄位 | |
---|---|
dimensionHeaders[] |
說明維度欄。DimensionsHeaders 的數量和順序與資料列中的維度相符。 |
metricHeaders[] |
說明指標欄。MetricHeaders 的數量和排序與資料列中顯示的指標相符。 |
rows[] |
報表中的維度值組合和指標值。 |
totals[] |
如有要求,則指標總值。 |
maximums[] |
如有要求,則指標的最大值。 |
minimums[] |
視需要提供指標的最小值。 |
rowCount |
查詢結果中的資料列總數。 |
metadata |
報表的中繼資料。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
ResponseMetaData
回應的中繼資料,內含報表內容的其他資訊。
JSON 表示法 |
---|
{
"dataLossFromOtherRow": boolean,
"schemaRestrictionResponse": {
object ( |
欄位 | |
---|---|
dataLossFromOtherRow |
若為 true,代表某些維度組合區間會彙整至「(other)」項目列。高基數報表可能就會發生這種情況。 中繼資料參數 dataLossFromOtherRow 會根據報表中使用的匯總資料表填入。無論報表中的篩選器和限制為何,系統都會準確填入這個參數。 舉例來說,由於請求含有 sessionSource = google 的篩選器,因此報表可能遭到捨棄「(other)」列。如果用來產生這份報表的輸入匯總資料中,有其他資料列的資料遺失,系統仍會填入這個參數。 詳情請參閱關於「(other)」列和資料取樣。 |
schemaRestrictionResponse |
說明建立這份報表時主動執行的結構定義限制。詳情請參閱「存取權和資料限制管理」。 |
currencyCode |
這份報表中使用的貨幣代碼。適用於為 貨幣代碼是 ISO 4217 標準貨幣類型的字串編碼 (https://en.wikipedia.org/wiki/ISO_4217);例如「USD」、「EUR」、「JPY」。詳情請參閱:https://support.google.com/analytics/answer/9796179。 |
timeZone |
資源目前的時區。適用於解讀以時間為準的維度,例如 |
emptyReason |
如果指定空白原因,這個原因會導致報表空白。 |
subjectToThresholding |
如果 |
SchemaRestrictionResponse
建立這份報表時主動強制執行的結構定義限制。詳情請參閱「存取權和資料限制管理」。
JSON 表示法 |
---|
{
"activeMetricRestrictions": [
{
object ( |
欄位 | |
---|---|
activeMetricRestrictions[] |
我們在建立報表時積極強制執行的所有限制。舉例來說, |
ActiveMetricRestriction
用來建立報表的指標。
JSON 表示法 |
---|
{
"restrictedMetricTypes": [
enum ( |
欄位 | |
---|---|
restrictedMetricTypes[] |
這項指標限制的原因。 |
metricName |
受限制指標的名稱。 |
RestrictedMetricType
您可能會禁止在某些 GA4 資源中查看的資料類別。
列舉 | |
---|---|
RESTRICTED_METRIC_TYPE_UNSPECIFIED |
未指定類型。 |
COST_DATA |
費用指標,例如 adCost 。 |
REVENUE_DATA |
收益指標,例如 purchaseRevenue 。 |