Method: properties.audienceLists.query

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

Pour découvrir les listes d'audience et obtenir des exemples, consultez Créer une liste d'audience.

Les audiences dans Google Analytics 4 vous permettent de segmenter les utilisateurs selon les critères importants pour votre entreprise. Pour en savoir plus, consultez https://support.google.com/analytics/answer/9267572.

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

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 à partir de laquelle récupérer 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 ligne de départ. La première ligne est considérée comme la ligne 0.

Lors de la pagination, la première requête ne spécifie pas de décalage ou, de manière é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 le décalage sur le limit de la première requête. La deuxième requête renvoie le deuxième limit de lignes.

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

string (int64 format)

Facultatif. Nombre de lignes à renvoyer. 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 de lignes demandé. limit doit être positif.

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

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

Corps de la réponse

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 
{
  "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 page de la requête.
audienceList

object (AudienceList)

Données de configuration concernant la AudienceList interrogée. Retourné pour aider à interpréter les lignes d'audience dans cette réponse. Par exemple, les dimensions de cette AudienceList correspondent aux colonnes d'AudienceRows.
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, des paramètres de requête limit et offset. Par exemple, si une requête renvoie 175 lignes et inclut limit de 50 dans la requête API, la réponse contiendra rowCount de 175, mais seulement 50 lignes.

Pour en savoir plus sur ce paramètre de pagination, consultez 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 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string
  // End of mutually exclusive fields.
}
Champs
Type de valeur de dimension. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
value

string

Valeur sous forme de chaîne si le type de dimension est une chaîne.
Fin des champs qui s'excluent mutuellement.