Method: organizations.reportPropertyUsage

الحصول على بيانات الاستخدام والفوترة للخدمات داخل المؤسسة للشهر المحدّد

لكل مؤسسة عميل مباشرةً، يجب أن يكون المستخدم OrgAdmin/BillingAdmin في المؤسسة من أجل عرض بيانات الفوترة والاستخدام.

بالنسبة إلى مؤسسة عميل شريك المبيعات، يجب أن يكون المستخدم OrgAdmin/BillingAdmin في مؤسسة شريك المبيعات من أجل الاطّلاع على بيانات الفوترة والاستخدام، أو OrgAdmin/BillingAdmin في مؤسسة عميل شريك المبيعات من أجل الاطّلاع على بيانات الاستخدام فقط.

طلب HTTP

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

يستخدم عنوان URL بنية تحويل الترميز إلى 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)

معرّف الحساب الرئيسي للموقع.
serviceLevel

enum (AnalyticsServiceLevel)

مستوى الخدمة للموقع
propertyType

enum (AnalyticsPropertyType)

النوع الفرعي لموقع "إحصاءات Google". يؤثّر ذلك في عدد الأحداث القابلة للفوترة.
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.
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.