Method: organizations.reportPropertyUsage

Obtenez les données d'utilisation et de facturation des propriétés de l'organisation pour le mois spécifié.

Pour chaque organisation cliente directe, l'utilisateur doit être administrateur de l'organisation ou administrateur de la facturation pour pouvoir afficher les données de facturation et d'utilisation.

Pour chaque organisation cliente d'un partenaire commercial, l'utilisateur doit être administrateur de l'organisation ou administrateur de la facturation de l'organisation du partenaire commercial pour afficher les données de facturation et d'utilisation, ou administrateur de l'organisation ou administrateur de la facturation de l'organisation cliente du partenaire commercial pour afficher uniquement les données d'utilisation.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
organization

string

Obligatoire. Spécifie l'organisation dont l'utilisation des propriétés sera listée.

Format : organizations/{org_id}

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON
{
  "month": string
}
Champs
month

string

Obligatoire. Mois cible pour lister les utilisations de la propriété.

Format : AAAA-MM (par exemple, "2025-05")

Corps de la réponse

Message de réponse pour l'appel RPC organizations.reportPropertyUsage.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "propertyUsages": [
    {
      object (PropertyUsage)
    }
  ],
  "billInfo": {
    object (BillInfo)
  }
}
Champs
propertyUsages[]

object (PropertyUsage)

Données d'utilisation pour toutes les propriétés de l'organisation et du mois spécifiés.

billInfo

object (BillInfo)

Montant de la facture pour l'organisation et le mois spécifiés.

Ce champ sera vide si l'utilisateur n'a accès qu'aux données d'utilisation.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

PropertyUsage

Contient le nombre d'événements reçus par la propriété, ainsi que les métadonnées qui influencent le volume d'événements billable.

Représentation JSON
{
  "property": string,
  "displayName": string,
  "accountId": string,
  "serviceLevel": enum (AnalyticsServiceLevel),
  "propertyType": enum (AnalyticsPropertyType),
  "totalEventCount": string,
  "billableEventCount": string
}
Champs
property

string

Nom de la ressource de propriété de l'API Admin Google Analytics.

Format : analyticsadmin.googleapis.com/properties/{property_id}

displayName

string

Nom à afficher de la propriété.

accountId

string (int64 format)

ID du compte parent de la propriété.

serviceLevel

enum (AnalyticsServiceLevel)

Niveau de service de la propriété.

propertyType

enum (AnalyticsPropertyType)

Sous-type de la propriété Analytics. Cela a une incidence sur le nombre d'événements facturables.

totalEventCount

string (int64 format)

Nombre total d'événements reçus par la propriété au cours du mois demandé.

billableEventCount

string (int64 format)

Nombre d'événements pour lesquels la propriété est facturée au cours du mois demandé.

AnalyticsPropertyType

Types de propriété Google Analytics.

Enums
ANALYTICS_PROPERTY_TYPE_UNSPECIFIED Type de propriété inconnu ou non spécifié
ANALYTICS_PROPERTY_TYPE_ORDINARY Propriété Google Analytics ordinaire
ANALYTICS_PROPERTY_TYPE_SUBPROPERTY Sous-propriété Google Analytics
ANALYTICS_PROPERTY_TYPE_ROLLUP Propriété Roll-up Google Analytics

BillInfo

Contient le montant de la facture.

Représentation JSON
{
  "baseFee": {
    object (Money)
  },
  "eventFee": {
    object (Money)
  },
  "priceProtectionCredit": {
    object (Money)
  },
  "total": {
    object (Money)
  }
}
Champs
baseFee

object (Money)

Montant des frais de base mensuels.

eventFee

object (Money)

Montant des frais de l'événement.

priceProtectionCredit

object (Money)

Montant du crédit de protection du prix. Cette option n'est disponible que pour les clients éligibles.

total

object (Money)

Montant total de la facture.

Valeur monétaire

Représente un montant associé à un type de devise.

Représentation JSON
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Champs
currencyCode

string

Code de devise à trois lettres défini par la norme ISO 4217.

units

string (int64 format)

Unités entières du montant. Par exemple, si currencyCode est défini sur "USD", une unité correspond à un dollar américain.

nanos

integer

Nombre de nano-unités (10^-9) du montant. La valeur doit être comprise entre -999 999 999 et +999 999 999 inclus. Si units est positif, nanos doit être positif ou nul. Si units est égal à zéro, nanos peut être positif, nul ou négatif. Si units est négatif, nanos doit être négatif ou nul. Par exemple, -1,75 $ est représenté par units=-1 et nanos=-750 000 000.