Method: properties.runReport
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
傳回 Google Analytics 事件資料的自訂報表。報表內含 Google Analytics 追蹤程式碼所收集的資料,API 傳回的資料是表格,當中含有所要求維度和指標的欄。指標是資源中使用者活動的個別評估數據,例如活躍使用者或事件計數。維度會按照部分常見條件 (例如國家/地區或事件名稱) 細分指標。
如需建構要求的指南,請參閱建立報表的相關說明。
HTTP 要求
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 |
property |
string
要追蹤事件的 Google Analytics GA4 資源 ID。指定在網址路徑,而不是內文。詳情請參閱「如何查看資源 ID」一文。在批次要求中,這個屬性應未指定或與批次層級屬性一致。 範例:properties/1234
|
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
{
"dimensions": [
{
object (Dimension )
}
],
"metrics": [
{
object (Metric )
}
],
"dateRanges": [
{
object (DateRange )
}
],
"dimensionFilter": {
object (FilterExpression )
},
"metricFilter": {
object (FilterExpression )
},
"offset": string,
"limit": string,
"metricAggregations": [
enum (MetricAggregation )
],
"orderBys": [
{
object (OrderBy )
}
],
"currencyCode": string,
"cohortSpec": {
object (CohortSpec )
},
"keepEmptyRows": boolean,
"returnPropertyQuota": boolean,
"comparisons": [
{
object (Comparison )
}
]
} |
欄位 |
dimensions[] |
object (Dimension )
要求和顯示的維度。
|
metrics[] |
object (Metric )
要求和顯示的指標。
|
dateRanges[] |
object (DateRange )
要讀取資料的日期範圍。如果要求多個日期範圍,則每個回應列都會包含以零為基準的日期範圍索引。如果兩個日期範圍重疊,這兩個日期範圍的回應列就會包含重疊日期的事件資料。在同類群組要求中,您必須指定這個dateRanges 。
|
dimensionFilter |
object (FilterExpression )
維度篩選器,在報表中篩選出特定維度值。詳情請參閱「維度篩選器的基本知識」一文。無法在這個篩選器中使用指標。
|
metricFilter |
object (FilterExpression )
指標的篩選器子句。系統匯總報表的資料列後套用,與 SQL 包含子句類似。無法在這個篩選器中使用維度。
|
offset |
string (int64 format)
起始資料列的列數。第一列會計為第 0 列。 分頁時,第一個要求不會指定位移;或等於,將偏移值設為 0;第一個要求會傳回前 limit 列。第二個要求將偏移值設為第一個要求的 limit ;第二個要求會傳回第二列的 limit 列。 如要進一步瞭解這個分頁參數,請參閱「分頁」。
|
limit |
string (int64 format)
要傳回的列數。如未指定,系統會傳回 10,000 列。無論您要求多少列,API 在每個要求最多只能傳回 250,000 列。limit 必須為正數。 如果維度值數量不如 limit ,API 也可以傳回少於要求的 limit 列。舉例來說,country 維度的可能值少於 300 個,因此在只產生 country 報表時,即使將 limit 設為較高的值,也無法取得超過 300 列。 如要進一步瞭解這個分頁參數,請參閱「分頁」。
|
metricAggregations[] |
enum (MetricAggregation )
指標匯總。匯總指標值會顯示在 dimensionValues 設為「RESERVED_(MetricAggregation)」的資料列中。
|
orderBys[] |
object (OrderBy )
指定在回應中資料列的排序方式。
|
currencyCode |
string
採用 ISO4217 格式的貨幣代碼,例如「AED」、「USD」、「JPY」。如果該欄位空白,報表就會採用資源的預設貨幣。
|
cohortSpec |
object (CohortSpec )
與這項要求相關聯的同類群組。如果要求中已有同類群組群組維度。
|
keepEmptyRows |
boolean
如果為 false 或未指定,系統不會傳回所有指標都等於 0 的資料列。在設為 true 的情況下,如果篩選器沒有個別移除這些資料列,系統就會傳回這些資料列。 無論這項keepEmptyRows 設定為何,只有 Google Analytics (GA4) 資源記錄的資料才會顯示在報表中。 舉例來說,如果資源從未記錄 purchase 事件,則查詢 eventName 維度和 eventCount 指標就不會有資料列 eventName:「purchase」和 eventCount:0。
|
returnPropertyQuota |
boolean
切換是否要傳回這項 Analytics 資源的配額目前狀態。配額會在 PropertyQuota 中傳回。
|
comparisons[] |
object (Comparison )
選用設定。要求及顯示的比較設定。這項要求只需要比較欄位,即可在回應中接收比較資料欄。
|
回應主體
如果成功,回應主體會包含 RunReportResponse
的執行例項。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2024-09-08 (世界標準時間)。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"缺少我需要的資訊"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"過於複雜/步驟過多"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"過時"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻譯問題"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"示例/程式碼問題"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"其他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"容易理解"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"確實解決了我的問題"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"其他"
}]
{"lastModified": "\u4e0a\u6b21\u66f4\u65b0\u6642\u9593\uff1a2024-09-08 (\u4e16\u754c\u6a19\u6e96\u6642\u9593)\u3002"}
[[["容易理解","easyToUnderstand","thumb-up"],["確實解決了我的問題","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["缺少我需要的資訊","missingTheInformationINeed","thumb-down"],["過於複雜/步驟過多","tooComplicatedTooManySteps","thumb-down"],["過時","outOfDate","thumb-down"],["翻譯問題","translationIssue","thumb-down"],["示例/程式碼問題","samplesCodeIssue","thumb-down"],["其他","otherDown","thumb-down"]],["上次更新時間:2024-09-08 (世界標準時間)。"]]