- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- AudienceRow
- AudienceDimensionValue
- Essayer
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, vous devez envoyer une demande à audienceLists.create
pour créer une liste d'audience d'utilisateurs. Ensuite, cette méthode permet de récupérer les utilisateurs de la liste.
Pour obtenir une présentation des listes d'audience et des exemples, consultez l'article Créer une liste d'audience.
Les audiences dans Google Analytics 4 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 la page 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 |
Obligatoire. Nom de la liste d'audience à partir de laquelle extraire les utilisateurs. Format : |
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 |
Facultatif. Nombre de lignes de la première ligne. La première ligne correspond à 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 un décalage sur 0. La première requête renvoie les Pour en savoir plus sur ce paramètre de pagination, consultez la section Pagination. |
limit |
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é. L'API peut également renvoyer moins de lignes que le Pour en savoir plus sur ce paramètre de pagination, consultez la section Pagination. |
Corps de la réponse
Liste d'utilisateurs 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 ( |
Champs | |
---|---|
audienceRows[] |
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 requête. |
audienceList |
Données de configuration concernant AudienceList interrogée. Renvoyée pour aider à interpréter les lignes d'audience dans cette réponse. Par exemple, les dimensions de l'élément "AudienceList" correspondent aux colonnes des "AudienceRows". |
rowCount |
Nombre total de lignes dans le résultat AudienceList. 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 valeurs de dimension pour la ligne de l'utilisateur de l'audience.
Représentation JSON |
---|
{
"dimensionValues": [
{
object ( |
Champs | |
---|---|
dimensionValues[] |
Chaque attribut de valeur de dimension pour un utilisateur de l'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 |
Champs | |
---|---|
Champ d'union one_value . Un type de valeur de dimension. one_value ne peut être qu'un des éléments suivants : |
|
value |
Valeur en tant que chaîne si le type de dimension est une chaîne. |