Method: properties.audienceLists.list

Liste toutes les listes d'audience d'une propriété. Vous pouvez utiliser cette méthode pour rechercher et réutiliser des listes d'audience existantes, au lieu de créer de nouvelles listes d'audience inutiles. Une même audience peut disposer de plusieurs listes d'audience représentant les utilisateurs de l'audience à différents jours.

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

Cette méthode est disponible en version bêta sur audienceExports.list. Pour nous faire part de vos commentaires sur cette API, remplissez le formulaire Commentaires sur l'API Audience Export Google Analytics.

Requête HTTP

GET https://analyticsdata.googleapis.com/v1alpha/{parent=properties/*}/audienceLists

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Toutes les listes d'audience de cette propriété seront listées dans la réponse. Format : properties/{property}

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal de listes d'audience à afficher. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, un maximum de 200 listes d'audience sera renvoyé. La valeur maximale est 1 000 (les valeurs plus élevées sont forcées à atteindre le maximum).

pageToken

string

Facultatif. Jeton de page reçu d'un appel audienceLists.list précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à audienceLists.list doivent correspondre à l'appel ayant fourni le jeton de page.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Liste de toutes les listes d'audience d'une propriété.

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

Représentation JSON
{
  "audienceLists": [
    {
      object (AudienceList)
    }
  ],
  "nextPageToken": string
}
Champs
audienceLists[]

object (AudienceList)

Chaque liste d'audience d'une propriété.

nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

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