ResponseMetaData

回應的中繼資料,內含報表內容的其他資訊。

JSON 表示法
{
  "dataLossFromOtherRow": boolean,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
欄位
dataLossFromOtherRow

boolean

若為 true,代表某些維度組合區間會彙整至「(other)」項目列。高基數報表可能就會發生這種情況。

中繼資料參數 dataLossFromOtherRow 會根據報表中使用的匯總資料表填入。無論報表中的篩選器和限制為何,系統都會準確填入這個參數。

舉例來說,由於請求含有 sessionSource = google 的篩選器,因此報表可能遭到捨棄「(other)」列。如果用來產生這份報表的輸入匯總資料中,有其他資料列的資料遺失,系統仍會填入這個參數。

詳情請參閱關於「(other)」列和資料取樣

samplingMetadatas[]

object (SamplingMetadata)

如果這份報表結果是取樣,則是指這份報表中使用的事件百分比。每個日期範圍都會填入一個 samplingMetadatas。每個 samplingMetadatas 都會按照要求中所指定日期範圍的順序對應到日期範圍。

不過,如果結果並未經過取樣,就不會定義這個欄位。

schemaRestrictionResponse

object (SchemaRestrictionResponse)

說明建立這份報表時主動執行的結構定義限制。詳情請參閱「存取權和資料限制管理」。

currencyCode

string

這份報表中使用的貨幣代碼。適用於為 purchaseRevenue 等貨幣指標設定格式,以便呈現視覺化結果。如果請求中已指定貨幣代碼,則此回應參數會回應請求參數。否則,這個回應參數就是屬性目前的 currencyCode。

貨幣代碼是 ISO 4217 標準貨幣類型的字串編碼 (https://en.wikipedia.org/wiki/ISO_4217);例如「USD」、「EUR」、「JPY」。詳情請參閱:https://support.google.com/analytics/answer/9796179

timeZone

string

資源目前的時區。適用於解讀以時間為準的維度,例如 hourminute。採用 IANA 時區資料庫 (https://www.iana.org/time-zones) 的字串;例如「America/New_York」或「亞洲/東京」

emptyReason

string

如果指定空白原因,這個原因會導致報表空白。

subjectToThresholding

boolean

如果 subjectToThresholding 為 true,這份報表就會發生閾值,且只會傳回達到最低匯總閾值的資料。某要求可能設有閾值,因此報表中沒有任何資料,只要所有資料超過閾值,就有可能發生這種情況。詳情請參閱「資料閾值」一文。

SchemaRestrictionResponse

建立這份報表時主動強制執行的結構定義限制。詳情請參閱「存取權和資料限制管理」。

JSON 表示法
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
欄位
activeMetricRestrictions[]

object (ActiveMetricRestriction)

我們在建立報表時積極強制執行的所有限制。舉例來說,purchaseRevenue 一律採用 REVENUE_DATA 限制類型。不過,只有在使用者的自訂角色不允許存取 REVENUE_DATA 時,系統才會填入這項有效回應限制。

ActiveMetricRestriction

用來建立報表的指標。

JSON 表示法
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
欄位
restrictedMetricTypes[]

enum (RestrictedMetricType)

這項指標限制的原因。

metricName

string

受限制指標的名稱。

RestrictedMetricType

您可能會禁止在某些 GA4 資源中查看的資料類別。

列舉
RESTRICTED_METRIC_TYPE_UNSPECIFIED 未指定類型。
COST_DATA 費用指標,例如 adCost
REVENUE_DATA 收益指標,例如 purchaseRevenue

SamplingMetadata

如果這份報表結果是取樣,則是指這份報表中使用的事件百分比。取樣是指藉由分析整體資料中的部分資料,從龐大的資料集中發掘出實用資訊。

JSON 表示法
{
  "samplesReadCount": string,
  "samplingSpaceSize": string
}
欄位
samplesReadCount

string (int64 format)

這份取樣報表在特定日期範圍內讀取的事件總數。這是指系統在此報表中分析的這項資源所含資料子集大小。

samplingSpaceSize

string (int64 format)

這項資源的資料中,在特定日期範圍內可供分析的事件總數。取樣能夠揭露較大的資料集相關實用資訊,這也是大型資料集的大小。

如要計算這份報表中使用的可用資料百分比,請計算 samplesReadCount/samplingSpaceSize