Method: organizations.reportPropertyUsage

获取组织内媒体资源在指定月份的使用情况和结算数据。

对于直接客户组织，用户需要是相应组织的组织管理员/结算管理员，才能查看结算和使用情况数据。

对于每个销售合作伙伴客户组织，用户需要是销售合作伙伴组织的 OrgAdmin/BillingAdmin，才能查看结算和使用情况数据；或者需要是销售合作伙伴客户组织的 OrgAdmin/BillingAdmin，才能仅查看使用情况数据。

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)

Google Analytics 资源的子类型。这会影响可结算的事件数量。
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)

账单总金额。

Money

表示含有货币类型的金额。

JSON 表示法 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
字段
currencyCode

string

ISO 4217 中定义的由 3 个字母组成的货币代码。
units

string (int64 format)

金额的整数单位。例如，如果 currencyCode 是 "USD"，则 1 单位就是一美元。
nanos

integer

金额的纳诺 (10^-9) 单位数。这个值必须在 -999999999（含）和 +999999999（含）之间。如果 units 是正数，nanos 必须是正数或零。如果 units 为零，nanos 可以是正数、零或负数。如果 units 是负数，nanos 必须是负数或零。例如，$-1.75 表示为 units=-1 和 nanos=-750000000。