Method: properties.audienceLists.exportSheet

Exporte une liste d'audience d'utilisateurs vers une feuille de calcul Google Sheets. Une fois l'audience créée, les utilisateurs ne sont pas immédiatement disponibles pour la fiche. Vous devez d'abord envoyer une demande à audienceLists.create pour créer une liste d'audience d'utilisateurs. Ensuite, cette méthode permet d'exporter ces utilisateurs de la liste d'audience vers une feuille de calcul Google Sheets.

Pour obtenir une présentation des listes d'audience avec des exemples, consultez l'article Créer une liste d'audience.

Dans Google Analytics 4, les audiences vous permettent de segmenter les utilisateurs afin de dégager les données importantes pour votre entreprise. Pour en savoir plus, consultez https://support.google.com/analytics/answer/9267572.

Cette méthode a été introduite en version alpha afin de recueillir des commentaires sur la syntaxe et les fonctionnalités avant le passage à la version bêta. Pour nous faire part de vos commentaires sur cette API, remplissez le formulaire Google Analytics Audience Export API Feedback.

Requête HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:exportSheet

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de la liste d'audience dont vous souhaitez extraire les utilisateurs. Format : properties/{property}/audienceLists/{audienceList}

Corps de la requête

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

Représentation JSON 
{
  "offset": string,
  "limit": string
}
Champs
offset

string (int64 format)

Facultatif. Nombre de lignes de la première ligne. La première ligne est comptabilisée comme la ligne 0.

Lors de la pagination, la première requête ne spécifie pas de décalage ; ou une valeur équivalente, définit le décalage sur 0. la première requête renvoie les limit premières lignes. La deuxième requête définit un décalage par rapport à la valeur limit de la première requête. la deuxième requête renvoie la deuxième valeur limit de lignes.

Pour en savoir plus sur ce paramètre de pagination, consultez la section Pagination.
limit

string (int64 format)

Facultatif. Nombre de lignes à afficher. Si aucune valeur n'est spécifiée, 10 000 lignes sont renvoyées. L'API renvoie un maximum de 250 000 lignes par requête, quel que soit le nombre demandé. La valeur de limit doit être positive.

L'API peut également renvoyer moins de lignes que la valeur limit demandée s'il n'y a pas autant de valeurs de dimension que limit.

Pour en savoir plus sur ce paramètre de pagination, consultez la section Pagination.

Corps de la réponse

Feuille de calcul Google Sheets créée contenant la liste des utilisateurs d'une liste d'audience.

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

Représentation JSON 
{
  "spreadsheetUri": string,
  "spreadsheetId": string,
  "rowCount": integer,
  "audienceList": {
    object (AudienceList)
  }
}
Champs
spreadsheetUri

string

URI à consulter dans votre navigateur pour afficher la feuille de calcul Google Sheets.
spreadsheetId

string

ID qui identifie la ressource Google Sheets créée.
rowCount

integer

Nombre total de lignes dans le résultat AudienceList. rowCount est indépendant du nombre de lignes renvoyées dans la réponse, du paramètre de requête limit et du paramètre de requête offset. Par exemple, si une requête renvoie 175 lignes et inclut un limit de 50 dans la requête API, la réponse contiendra rowCount sur 175, mais seulement 50 lignes.

Pour en savoir plus sur ce paramètre de pagination, consultez la section Pagination.
audienceList

object (AudienceList)

Données de configuration concernant AudienceList en cours d'exportation. Est renvoyé pour vous aider à interpréter l'AudienceList dans la feuille Google Sheets de cette réponse.

Par exemple, l'AudienceList peut comporter plus de lignes que celles présentes dans la feuille de calcul Google Sheets. Dans ce cas, vous pouvez envoyer une demande d'exportation de feuille supplémentaire avec une valeur offset différente pour récupérer la page de lignes suivante dans une feuille Google Sheets supplémentaire.

Champs d'application des autorisations

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

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets