Method: organizations.reportPropertyUsage

داده‌های مربوط به میزان استفاده و صورتحساب املاک درون سازمان را برای ماه مشخص شده دریافت کنید.

برای مشاهده داده‌های صورتحساب و میزان استفاده، به ازای هر سازمان مشتری مستقیم، کاربر باید در سازمان دارای مجوز OrgAdmin/BillingAdmin باشد.

برای مشاهده داده‌های صورتحساب و میزان مصرف، به ازای هر شریک فروش در سایت مشتری، کاربر باید در سایت شریک فروش، OrgAdmin/BillingAdmin باشد، یا برای مشاهده فقط داده‌های مصرف، در سایت مشتری شریک فروش، OrgAdmin/BillingAdmin باشد.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
organization

string

الزامی. سازمانی را که نحوه‌ی استفاده از ملک آن فهرست خواهد شد، مشخص می‌کند.

قالب: organizations/{org_id}

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "month": string
}
فیلدها
month

string

الزامی. ماه مورد نظر برای فهرست کردن موارد استفاده از ملک.

قالب: YYYY-MM. برای مثال، "2025-05"

بدنه پاسخ

پیام پاسخ برای پروتکل 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

کاربرد ملک

شامل تعداد رویدادهای دریافت شده توسط ملک، به همراه فراداده‌هایی است که بر حجم رویدادهای billable تأثیر می‌گذارند.

نمایش JSON 
{
  "property": string,
  "displayName": string,
  "accountId": string,
  "serviceLevel": enum (AnalyticsServiceLevel),
  "propertyType": enum (AnalyticsPropertyType),
  "totalEventCount": string,
  "billableEventCount": string
}
فیلدها
property

string

نام منبع ویژگی API مدیریت گوگل آنالیتیکس.

قالب: analyticsadmin.googleapis.com/properties/{property_id}

displayName

string

نام نمایشی ملک.

accountId

string ( int64 format)

شناسه حساب اصلی ملک.

serviceLevel

enum ( AnalyticsServiceLevel )

سطح خدمات ملک.

propertyType

enum ( AnalyticsPropertyType )

زیرنوع ویژگی تحلیلی. این مورد بر تعداد رویدادهای قابل پرداخت تأثیر می‌گذارد.

totalEventCount

string ( int64 format)

تعداد کل رویدادهایی که ملک در طول ماه درخواستی دریافت کرده است.

billableEventCount

string ( int64 format)

تعداد رویدادهایی که در ماه مورد درخواست، صورتحساب ملک برای آنها صادر شده است.

نوع ویژگی تحلیلی

انواع ویژگی‌های گوگل آنالیتیکس

انوم‌ها
ANALYTICS_PROPERTY_TYPE_UNSPECIFIED نوع ملک ناشناخته یا نامشخص
ANALYTICS_PROPERTY_TYPE_ORDINARY ویژگی معمولی گوگل آنالیتیکس
ANALYTICS_PROPERTY_TYPE_SUBPROPERTY زیرمجموعه گوگل آنالیتیکس
ANALYTICS_PROPERTY_TYPE_ROLLUP ویژگی رول‌آپ گوگل آنالیتیکس

بیل‌اینفو

حاوی مبلغ صورتحساب.

نمایش 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 تعریف شده است.

units

string ( int64 format)

کل واحدهای مبلغ. برای مثال اگر currencyCode برابر با "USD" باشد، هر واحد برابر با یک دلار آمریکا است.

nanos

integer

تعداد نانو (10^-9) واحد از مبلغ. مقدار باید بین -999,999,999 و +999,999,999 باشد. اگر units مثبت باشد، nanos باید مثبت یا صفر باشد. اگر units صفر باشد، nanos می‌تواند مثبت، صفر یا منفی باشد. اگر units منفی باشد، nanos باید منفی یا صفر باشد. به عنوان مثال، -1.75 دلار به صورت units = -1 و nanos = -750,000,000 نمایش داده می‌شود.