Ressource: AudienceList
Une liste d'audience est une liste d'utilisateurs d'une audience au moment de sa création. Une même audience peut être associée à plusieurs listes d'audience créées pour différents jours.
Représentation JSON |
---|
{ "name": string, "audience": string, "audienceDisplayName": string, "dimensions": [ { object ( |
Champs | |
---|---|
name |
Uniquement en sortie. Identifiant. Nom de la ressource de liste d'audience attribué lors de la création. Ce nom de ressource identifie cette Format : |
audience |
Obligatoire. Nom de la ressource d'audience. Ce nom de ressource identifie l'audience répertoriée et est partagé entre les API Data et Admin Analytics. Format : |
audienceDisplayName |
Uniquement en sortie. Nom à afficher descriptif pour cette audience. Par exemple, "Acheteurs". |
dimensions[] |
Obligatoire. Dimensions demandées et affichées dans la réponse à la requête. |
creationQuotaTokensCharged |
Uniquement en sortie. Le quota total de jetons facturés lors de la création de l'AudienceList. Étant donné que le nombre de jetons est basé sur l'activité à l'état |
state |
Uniquement en sortie. État actuel de cette liste d'audience. |
beginCreatingTime |
Uniquement en sortie. Heure à laquelle audienceLists.create a été appelée et où l'état Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: |
rowCount |
Uniquement en sortie. Nombre total de lignes dans le résultat AudienceList. |
errorMessage |
Uniquement en sortie. Un message d'erreur s'affiche en cas d'échec de la création d'une liste d'audience. L'épuisement des quotas est une cause fréquente d'un tel échec. |
percentageCompleted |
Uniquement en sortie. Pourcentage d'achèvement pour cette exportation d'audience, compris entre 0 et 100. |
recurringAudienceList |
Uniquement en sortie. Liste d'audience récurrente à l'origine de la création de cette liste d'audience. Les listes d'audience récurrentes permettent de créer des listes d'audience quotidiennement. Les listes d'audience créées directement ne sont associées à aucune liste d'audience récurrente, et ce champ reste vide. |
webhookNotification |
Facultatif. Configure des notifications de webhook à envoyer depuis l'API Data de Google Analytics vers votre serveur de webhook. L'utilisation de webhooks est facultative. Si vous ne l'utilisez pas, vous devrez interroger cette API pour déterminer à quel moment une liste d'audience est prête à être utilisée. Les webhooks permettent d'envoyer une notification à vos serveurs et évitent d'avoir à interroger vos serveurs. Une ou deux requêtes POST seront envoyées au webhook. La première demande POST est immédiatement envoyée. La liste d'audience que vous venez de créer est alors affichée à l'état "CREATING". La seconde requête POST est envoyée une fois la création de la liste d'audience terminée (état ACTIVE ou FAILED). Si des listes d'audience identiques sont demandées rapidement, la deuxième liste d'audience et les suivantes peuvent être diffusées à partir du cache. Dans ce cas, la méthode de création de liste d'audience peut indiquer qu'une liste d'audience est déjà ACTIVE. Dans ce scénario, une seule requête POST sera envoyée au webhook. |
État
La liste d'audience existe actuellement avec cet état.
Enums | |
---|---|
STATE_UNSPECIFIED |
L'état non spécifié ne sera jamais utilisé. |
CREATING |
La liste d'audience est en cours de création et sera disponible prochainement. La création a lieu immédiatement après l'appel audienceLists.create. |
ACTIVE |
La liste d'audience est entièrement créée et prête à être interrogée. Une liste d'audience devient active de manière asynchrone à partir d'une requête. Cela se produit quelque temps (par exemple, 15 minutes) après l'appel de création initial. |
FAILED |
Échec de la création de la liste d'audience. Il est possible qu'une nouvelle demande de cette liste d'audience aboutisse. |
Méthodes |
|
---|---|
|
Crée une liste d'audience pour une récupération ultérieure. |
|
Exporte une liste d'audience d'utilisateurs vers une feuille de calcul Google Sheets. |
|
Récupère les métadonnées de configuration concernant une liste d'audience spécifique. |
|
Liste toutes les listes d'audience d'une propriété. |
|
Récupère une liste d'audience d'utilisateurs. |