Method: properties.audienceLists.query

Récupère une liste d'audience d'utilisateurs. Une fois l'audience créée, les utilisateurs ne sont pas immédiatement disponibles pour la fiche. Tout d'abord, une requête envoyée à audienceLists.create est nécessaire pour créer une liste d'audience d'utilisateurs. Ensuite, cette méthode permet de récupérer les utilisateurs de la liste d'audience.

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 est disponible en version bêta sur audienceExports.query. 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/*}:query

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

Liste d'utilisateurs figurant dans 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 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
Champs
audienceRows[]

object (AudienceRow)

Lignes pour chaque utilisateur d'une liste d'audience. Le nombre de lignes de cette réponse sera inférieur ou égal à la taille de la page de la demande.
audienceList

object (AudienceList)

Données de configuration concernant l'élément AudienceList qui est interrogé. Est renvoyé pour faciliter l'interprétation des lignes d'audience dans cette réponse. Par exemple, les dimensions de cette AudienceList correspondent aux colonnes des lignes AudienceRow.
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.

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

AudienceRow

Attributs de valeur de dimension pour la ligne utilisateur de l'audience.

Représentation JSON 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
Champs
dimensionValues[]

object (AudienceDimensionValue)

Chaque attribut de valeur de dimension pour un utilisateur d'audience. Une valeur de dimension sera ajoutée pour chaque colonne de dimension demandée.

AudienceDimensionValue

Valeur d'une dimension.

Représentation JSON 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
Champs
Champ d'union one_value. Un type de valeur de dimension. one_value ne peut être qu'un des éléments suivants :
value

string

Valeur en tant que chaîne si le type de dimension est une chaîne.