Method: organizations.reportPropertyUsage

• HTTP リクエスト
• パスパラメータ
• リクエストの本文
  • JSON 表現
• レスポンスの本文
  • JSON 表現
• 認可スコープ
• PropertyUsage
  • JSON 表現
• AnalyticsPropertyType
• BillInfo
  • JSON 表現
• Money
  • JSON 表現
• 試してみる

指定した月の組織内のプロパティの使用状況と請求データを取得します。

直接のクライアント組織ごとに、請求データと使用状況データを表示するには、組織の組織管理者/請求管理者である必要があります。

販売パートナーのクライアント組織ごとに、請求データと使用状況データを表示するには、販売パートナー組織の組織管理者または請求管理者である必要があります。使用状況データのみを表示するには、販売パートナーのクライアント組織の組織管理者または請求管理者である必要があります。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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_PROPERTY_TYPE_UNSPECIFIED	不明または未指定のプロパティ タイプ
ANALYTICS_PROPERTY_TYPE_ORDINARY	通常の Google アナリティクスのプロパティ
ANALYTICS_PROPERTY_TYPE_SUBPROPERTY	Google アナリティクスのサブプロパティ
ANALYTICS_PROPERTY_TYPE_ROLLUP	Google アナリティクスのロールアップ プロパティ

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 には正数または 0 を指定します。units がゼロの場合、nanos には正数、0、または負数を指定できます。units が負の場合、nanos は負数または 0 を指定します。たとえば、$-1.75 は units = -1、nanos = -750,000,000 と表されます。