Method: organizations.reportPropertyUsage

קבלת נתוני השימוש והחיוב של נכסים בארגון בחודש שצוין.

כדי לצפות בנתוני החיוב והשימוש של ארגון לקוח ישיר, המשתמש צריך להיות אדמין ארגוני או אדמין לענייני חיוב בארגון.

כדי לראות את נתוני החיוב והשימוש בארגון לקוח של שותף מכירות, המשתמש צריך להיות אדמין בארגון או אדמין לענייני חיוב בארגון של שותף המכירות. כדי לראות רק את נתוני השימוש בארגון לקוח של שותף מכירות, המשתמש צריך להיות אדמין בארגון או אדמין לענייני חיוב בארגון הלקוח של שותף המכירות.

בקשת 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

גוף התשובה

הודעת התגובה לקריאה לשירות מרוחק (RPC) של organizations.reportPropertyUsage.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-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)

סוג המשנה של נכס Analytics. השינוי הזה משפיע על מספר האירועים שניתנים לחיוב.
totalEventCount

string (int64 format)

המספר הכולל של האירועים שהתקבלו בנכס במהלך החודש שצוין בבקשה.
billableEventCount

string (int64 format)

מספר האירועים שחויבו בחשבון של הנכס בחודש המבוקש.

AnalyticsPropertyType

סוג הנכס ב-Google Analytics.

טיפוסים בני מנייה (enum)
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.
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.