Method: organizations.reportPropertyUsage

Получите данные об использовании и выставлении счетов по объектам недвижимости в пределах организации за указанный месяц.

Для просмотра данных по выставлению счетов и использованию данных в организации прямого клиента пользователю необходимо иметь права OrgAdmin/BillingAdmin в этой организации.

Для просмотра данных по выставлению счетов и использованию в организации клиента-партнера по продажам пользователю необходимо иметь права OrgAdmin/BillingAdmin в организации клиента-партнера по продажам или права OrgAdmin/BillingAdmin в организации клиента-партнера по продажам, чтобы просматривать только данные об использовании.

HTTP-запрос

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

URL использует синтаксис перекодировки gRPC .

Параметры пути

Параметры
organization

string

Обязательно. Указывает организацию, использование имущества которой будет указано.

Формат: организации/{org_id}

Текст запроса

Тело запроса содержит данные со следующей структурой:

JSON-представление 
{
  "month": string
}
Поля
month

string

Обязательно. Целевой месяц для составления списка использования недвижимости.

Формат: ГГГГ-ММ. Например, «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

Имя ресурса свойства API администратора Google Analytics.

Формат: 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)

Количество событий, за которые объекту недвижимости выставляется счет в запрашиваемом месяце.

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 )

Общая сумма счета.

Деньги

Представляет собой сумму денег с указанным типом валюты.

JSON-представление 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Поля
currencyCode

string

Трехбуквенный код валюты, определенный в ISO 4217.

units

string ( int64 format)

Целые единицы суммы. Например, если currencyCode — "USD" , то 1 единица равна одному доллару США.

nanos

integer

Количество единиц нано (10^-9) от суммы. Значение должно быть в диапазоне от -999 999 999 до +999 999 999 включительно. Если units положительная, nanos должно быть положительным или нулевым. Если units равна нулю, nanos может быть положительным, нулевым или отрицательным. Если units отрицательная, nanos должно быть отрицательным или нулевым. Например, $-1,75 представляется как units = -1, а nanos = -750 000 000.