REST Resource: properties.audienceLists

Ressource: AudienceList

Une liste d'audience désigne les utilisateurs d'une audience au moment de sa création. Une même audience peut comporter plusieurs listes d'audience créées pour des jours différents.

Représentation JSON 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
Champs
name

string

Uniquement en sortie. Identifiant. Nom de la ressource de liste d'audience attribué lors de la création. Ce nom de ressource identifie ce AudienceList.

Format : properties/{property}/audienceLists/{audienceList}
audience

string

Obligatoire. Nom de ressource de l'audience. Ce nom de ressource identifie l'audience répertoriée. Il est partagé entre les données Analytics et API Admin.

Format : properties/{property}/audiences/{audience}
audienceDisplayName

string

Uniquement en sortie. Nom descriptif à afficher pour cette audience. Par exemple, "Acheteurs".
dimensions[]

object (AudienceDimension)

Obligatoire. Dimensions demandées et affichées dans la réponse à la requête.
creationQuotaTokensCharged

integer

Uniquement en sortie. Nombre total de jetons facturés lors de la création de l'AudienceList. Comme ce nombre de jetons est basé sur l'activité à partir de l'état CREATING, ces jetons facturés ne seront plus facturés dès qu'une liste d'audience passera à l'état ACTIVE ou FAILED.
state

enum (State)

Uniquement en sortie. État actuel de cette liste d'audience.
beginCreatingTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle audienceLists.create a été appelée et que AudienceList a commencé à l'état CREATING.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
rowCount

integer

Uniquement en sortie. Nombre total de lignes dans le résultat AudienceList.
errorMessage

string

Uniquement en sortie. Un message d'erreur s'affiche lorsqu'une liste d'audience échoue lors de sa création. Un tel échec est souvent dû à l'épuisement du quota.
percentageCompleted

number

Uniquement en sortie. Pourcentage terminé pour cette exportation d'audience, compris entre 0 et 100.
recurringAudienceList

string

Uniquement en sortie. Liste d'audience récurrente à l'origine de cette liste d'audience. Les listes d'audience récurrentes créent des listes d'audience tous les jours.

Si les listes d'audience sont créées directement, elles ne seront associées à aucune liste d'audience récurrente, et ce champ restera vide.
webhookNotification

object (WebhookNotification)

Facultatif. Configure les notifications webhook à envoyer depuis l'API Data de Google Analytics vers votre serveur de webhooks. L'utilisation de webhooks est facultative. Si elle n'est pas utilisée, vous devez interroger cette API pour déterminer quand une liste d'audience est prête à être utilisée. Les webhooks permettent d'envoyer une notification à vos serveurs et d'éviter d'avoir à interroger les données.

Une ou deux requêtes POST sont envoyées au webhook. La première demande POST est envoyée immédiatement. La liste d'audience que vous venez de créer apparaît alors à l'état "CREATING" (CRÉATION). La seconde demande POST est envoyée une fois que la liste d'audience a été créée (état ACTIVE ou FAILED).

Si des listes d'audience identiques sont demandées à la suite, les deux les listes d'audience suivantes peuvent être diffusées à partir du cache. Dans ce cas, la méthode de création de liste d'audience peut renvoyer une liste d'audience déjà active. Dans ce scénario, une seule requête POST est envoyée au webhook.

État

Cet état existe actuellement pour l'élément AudienceList.

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 "AudienceList" est entièrement créée et prête à être interrogée. Une liste d'audience devient active de manière asynchrone à partir d'une demande. Cela se produit quelque temps (par exemple, 15 minutes) après l'appel de création initial.
FAILED Échec de la création de l'élément AudienceList. Il est possible que la demande de cette liste d'audience aboutisse.

Méthodes

create

 Crée une liste d'audience en vue de la récupérer ultérieurement.

exportSheet

 Exporte une liste d'audience d'utilisateurs vers une feuille de calcul Google Sheets.

get

 Récupère les métadonnées de configuration concernant une liste d'audience spécifique.

list

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

query

 Récupère une liste d'audience d'utilisateurs.