Method: organizations.reportPropertyUsage

Recebe os dados de uso e faturamento das propriedades na organização para o mês especificado.

Por organização de cliente direto, o usuário precisa ser administrador da organização/administrador de faturamento para acessar os dados de faturamento e uso.

Por organização de cliente do parceiro de vendas, o usuário precisa ser administrador da organização/administrador de faturamento na organização do parceiro de vendas para ver os dados de faturamento e uso ou administrador da organização/administrador de faturamento na organização de cliente do parceiro de vendas para ver apenas os dados de uso.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
organization

string

Obrigatório. Especifica a organização cujo uso de propriedades será listado.

Formato: organizations/{org_id}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "month": string
}
Campos
month

string

Obrigatório. O mês de destino para listar os usos da propriedade.

Formato: AAAA-MM. Por exemplo, "2025-05"

Corpo da resposta

Mensagem de resposta para organizations.reportPropertyUsage RPC.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "propertyUsages": [
    {
      object (PropertyUsage)
    }
  ],
  "billInfo": {
    object (BillInfo)
  }
}
Campos
propertyUsages[]

object (PropertyUsage)

Dados de uso de todas as propriedades na organização e no mês especificados.
billInfo

object (BillInfo)

Valor da fatura na organização e no mês especificados.

Ficará vazio se o usuário tiver acesso apenas aos dados de uso.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
  • https://www.googleapis.com/auth/marketingplatformadmin.analytics.update

PropertyUsage

Contém a contagem de eventos recebidos pela propriedade, além de metadados que influenciam o volume de eventos billable.

Representação JSON 
{
  "property": string,
  "displayName": string,
  "accountId": string,
  "serviceLevel": enum (AnalyticsServiceLevel),
  "propertyType": enum (AnalyticsPropertyType),
  "totalEventCount": string,
  "billableEventCount": string
}
Campos
property

string

O nome do recurso de propriedade da API Google Analytics Admin.

Formato: analyticsadmin.googleapis.com/properties/{property_id}
displayName

string

O nome de exibição da propriedade.
accountId

string (int64 format)

O ID da conta principal da propriedade.
serviceLevel

enum (AnalyticsServiceLevel)

O nível de serviço da propriedade.
propertyType

enum (AnalyticsPropertyType)

O subtipo da propriedade do Google Analytics. Isso afeta a contagem de eventos faturáveis.
totalEventCount

string (int64 format)

Contagem total de eventos que a propriedade recebeu durante o mês solicitado.
billableEventCount

string (int64 format)

O número de eventos faturados para a propriedade no mês solicitado.

AnalyticsPropertyType

Tipos de propriedade do Google Analytics.

Tipos enumerados
ANALYTICS_PROPERTY_TYPE_UNSPECIFIED Tipo de propriedade desconhecido ou não especificado
ANALYTICS_PROPERTY_TYPE_ORDINARY Propriedade comum do Google Analytics
ANALYTICS_PROPERTY_TYPE_SUBPROPERTY Subpropriedade do Google Analytics
ANALYTICS_PROPERTY_TYPE_ROLLUP Propriedade de agregação do Google Analytics

BillInfo

Contém o valor da conta.

Representação JSON 
{
  "baseFee": {
    object (Money)
  },
  "eventFee": {
    object (Money)
  },
  "priceProtectionCredit": {
    object (Money)
  },
  "total": {
    object (Money)
  }
}
Campos
baseFee

object (Money)

O valor da taxa básica mensal.
eventFee

object (Money)

O valor da taxa do evento.
priceProtectionCredit

object (Money)

O valor do crédito de proteção de preço, disponível apenas para clientes qualificados.
total

object (Money)

O valor total da conta.

Dinheiro

Representa um montante em dinheiro com o respectivo tipo de moeda.

Representação JSON 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Campos
currencyCode

string

O código de moeda de três letras definido no ISO 4217.
units

string (int64 format)

As unidades inteiras do montante. Por exemplo, se currencyCode for "USD", então 1 unidade equivalerá a um dólar americano.
nanos

integer

Número de unidades nano (10^-9) do montante. É necessário que o valor fique entre -999.999.999 e +999.999.999 (inclusive os dois limites). Se units for positivo, nanos será positivo ou zero. Se units for zero, nanos poderá ser positivo, zero ou negativo. Se units for negativo, nanos será negativo ou zero. Por exemplo,US $-1,75 é representado como units=-1 e nanos=-750.000.000.