Créer une exportation d'audience

Les audiences dans Google Analytics vous permettent de segmenter les utilisateurs afin de dégager les données importantes pour votre entreprise. Les audiences vous permettent de regrouper les utilisateurs de votre site ou de votre application en fonction d'attributs communs.

Vous pouvez exporter vos audiences, y compris un instantané de leurs utilisateurs, à l'aide de l'API Data.

Consultez le guide Attentes concernant les données d'exportation d'audience pour obtenir des informations importantes sur les données que vous voyez dans les exportations d'audience.

Présentation

Envoyez les requêtes Data API suivantes pour créer et interroger une exportation d'audience :

  1. Appelez la méthode audienceExports.create pour créer une exportation d'audience.
  2. La méthode audienceExports.query permet de récupérer les utilisateurs de l'audience.

Pour en savoir plus, vous pouvez appeler audienceExports.get afin de récupérer les métadonnées de configuration d'une exportation d'audience spécifique, et audienceExports.list pour lister toutes vos exportations d'audience pour une propriété spécifique.

Sélectionnez une entité de référence

Tous les méthodes de l'API Data nécessitent que l'identifiant de la propriété Google Analytics soit spécifié dans un chemin d'accès à la requête URL, sous la forme properties/GA_PROPERTY_ID. Exemple :

  POST  https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/audienceExports

Le rapport est généré en fonction des données d'événement Google Analytics collectées dans la propriété Google Analytics spécifiée.

Si vous utilisez l'une des bibliothèques clientes de l'API Data, vous n'avez pas besoin de modifier le chemin d'accès à l'URL de la requête. La plupart des clients API fournissent un paramètre property qui attend une chaîne au format properties/GA_PROPERTY_ID. Consultez le guide de démarrage rapide pour obtenir des exemples d'utilisation des bibliothèques clientes.

Créer une exportation d'audience

Pour créer une exportation d'audience, appelez la méthode audienceExports.create à l'aide de l'objet AudienceExport dans votre requête. Les paramètres suivants sont requis :

  • Nom d'audience valide dans le champ audience, au format properties/{propertyId}/audiences/{audienceId}. Vous pouvez utiliser la méthode audiences.list de l'API Google Analytics Admin v1 pour obtenir cette valeur. Le champ Audience.name de la réponse audiences.list contient le nom de l'audience.
  • Liste valide de dimensions dans le champ dimensions. La liste des dimensions compatibles avec cette méthode est disponible dans la documentation sur le schéma d'exportation d'audience. Seules les données des dimensions mentionnées dans ce champ sont incluses dans une exportation d'audience.

Voici un exemple de requête permettant de créer une exportation d'audience :

Requête HTTP

POST https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports
{
  "audience": "properties/1234567/audiences/12345",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ]
}

Une réponse de la méthode audienceExports.create contient le nom de l'exportation d'audience dans le champ name, par exemple properties/1234567/audienceExports/123. Voici un exemple de réponse :

Réponse HTTP

{
  "response": {
    "@type": "type.googleapis.com/google.analytics.data.v1alpha.AudienceExport",
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "CREATING",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  }
}

Vous pouvez utiliser name pour interroger les utilisateurs à partir de l'exportation d'audience.

Interroger l'état de préparation de l'exportation d'audience

La génération de l'exportation d'audience peut prendre plusieurs minutes après l'appel audienceExports.create.

Vous pouvez vérifier l'état de préparation d'une exportation d'audience en appelant la méthode audienceExports.get.

Utilisez le nom d'exportation d'audience d'une réponse audienceExports.create pour spécifier l'exportation d'audience dans votre requête.

Voici un exemple de requête :

Requête HTTP

GET https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports/123

L'état de préparation d'une exportation d'audience est renvoyé dans le champ state de la réponse. Une fois la génération de l'exportation d'audience terminée, son état passe de CREATING à ACTIVE.

Voici un exemple de réponse :

Réponse HTTP

{
  "name": "properties/1234567/audienceExports/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "state": "CREATING",
  "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
}

Vous pouvez obtenir l'état de toutes les exportations d'audience en appelant la méthode audienceExports.list.

Récupérer des utilisateurs à partir d'une exportation d'audience

Une fois l'exportation d'audience générée, appelez la méthode audienceExports.query et spécifiez le name de l'exportation d'audience dans la requête.

Voici un exemple de requête :

Requête HTTP

POST https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports/123:query

Si l'exportation d'audience est prête, cet appel renvoie la liste des utilisateurs de l'audience.

Voici un exemple de réponse :

Réponse HTTP

{
  "audienceExport": {
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "ACTIVE",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  },
  "audienceRows": [
    {
      "dimensionValues": [
        {
          "value": "1000276123.1681742376"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000374452.1668627377"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000391956.1652750758"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000410539.1682018694"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000703969.1666725875"
        }
      ]
    }
  ],
  "rowCount": 5
}