Method: organizations.reportPropertyUsage

取得指定月份內機構中資源的用量和帳單資料。

如要查看帳單和用量資料，使用者必須是機構的機構管理員/帳單管理員。

如要查看帳單和用量資料，使用者必須是銷售合作夥伴機構的機構管理員/帳單管理員；如要只查看用量資料，使用者必須是銷售合作夥伴客戶機構的機構管理員/帳單管理員。

HTTP 要求

POST https://marketingplatformadmin.googleapis.com/v1alpha/{organization=organizations/*}:reportPropertyUsage

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
organization

string

必要欄位。指定要列出屬性用量的機構。

格式：organizations/{org_id}

要求主體

要求主體會包含結構如下的資料：

JSON 表示法 
{
  "month": string
}
欄位
month

string

必要欄位。列出房源使用情況的目標月份。

格式：YYYY-MM，例如「2025-05」

回應主體

機構專用的 organizations.reportPropertyUsage RPC 回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "propertyUsages": [
    {
      object (PropertyUsage)
    }
  ],
  "billInfo": {
    object (BillInfo)
  }
}
欄位
propertyUsages[]

object (PropertyUsage)

指定機構和月份的所有資源使用資料。
billInfo

object (BillInfo)

指定機構和月份的帳單金額。

如果使用者只能存取用量資料，這個欄位會是空白。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
  • https://www.googleapis.com/auth/marketingplatformadmin.analytics.update

PropertyUsage

包含資源收到的事件計數，以及影響 billable 事件量的中繼資料。

JSON 表示法 
{
  "property": string,
  "displayName": string,
  "accountId": string,
  "serviceLevel": enum (AnalyticsServiceLevel),
  "propertyType": enum (AnalyticsPropertyType),
  "totalEventCount": string,
  "billableEventCount": string
}
欄位
property

string

Google Analytics Admin API 資源的名稱。

格式：analyticsadmin.googleapis.com/properties/{property_id}
displayName

string

屬性的顯示名稱。
accountId

string (int64 format)

資源上層帳戶的 ID。
serviceLevel

enum (AnalyticsServiceLevel)

資源的服務層級。
propertyType

enum (AnalyticsPropertyType)

分析資源的子類型。這會影響可計費事件數。
totalEventCount

string (int64 format)

資源在要求月份收到的事件總數。
billableEventCount

string (int64 format)

系統在要求月份向資源收費的事件數。

AnalyticsPropertyType

Google Analytics 資源類型。

列舉
ANALYTICS_PROPERTY_TYPE_UNSPECIFIED 不明或未指定的房源類型
ANALYTICS_PROPERTY_TYPE_ORDINARY 一般 Google Analytics 資源
ANALYTICS_PROPERTY_TYPE_SUBPROPERTY Google Analytics 子資源
ANALYTICS_PROPERTY_TYPE_ROLLUP Google Analytics 匯總資源

BillInfo

包含帳單金額。

JSON 表示法 
{
  "baseFee": {
    object (Money)
  },
  "eventFee": {
    object (Money)
  },
  "priceProtectionCredit": {
    object (Money)
  },
  "total": {
    object (Money)
  }
}
欄位
baseFee

object (Money)

每月基本費用金額。
eventFee

object (Money)

活動費用金額。
priceProtectionCredit

object (Money)

價格保障抵免金額，僅適用於符合資格的消費者。
total

object (Money)

帳單總金額。

金額

代表金額與其貨幣類型。

JSON 表示法 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
欄位
currencyCode

string

ISO 4217 定義的貨幣代碼，由 3 個字母組成。
units

string (int64 format)

金額的整數單位。舉例來說，如果 currencyCode 為 "USD"，則 1 個單位為 1 美元。
nanos

integer

金額的奈米 (10^-9) 單位數量。這個值必須介於 -999,999,999 和 +999,999,999 (含) 之間。如果 units 為正值，nanos 必須為正值或零。如果 units 為零，則 nanos 可為正值、零或負值。如果 units 為負值，nanos 就必須為負值或零。例如，$-1.75 美元的表式方式為 units=-1 和 nanos=-750,000,000。