REST Resource: properties.audienceLists

Ressource : AudienceList

Une liste d'audience est une liste d'utilisateurs d'une audience au moment de sa création. Une audience peut avoir plusieurs listes d'audience créées pour différents jours.

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 ressource de la liste d'audience attribué lors de la création. Ce nom de ressource identifie cette AudienceList.

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

string

Obligatoire. Nom de ressource de l'audience. Ce nom de ressource identifie l'audience listée et est partagé entre les API Analytics Data et Admin.

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

string

Uniquement en sortie. Nom à afficher descriptif de 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 de quota facturés lors de la création de l'AudienceList. Étant donné que ce nombre de jetons est basé sur l'activité de l'état CREATING, les jetons facturés seront fixes une fois qu'une AudienceList passe à l'état ACTIVE ou FAILED.
state

enum (State)

Uniquement en sortie. État actuel de cette AudienceList.
beginCreatingTime

string (Timestamp format)

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

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
rowCount

integer

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

string

Uniquement en sortie. Le message d'erreur s'affiche lorsqu'une liste d'audience échoue lors de la création. L'épuisement du quota est une cause fréquente de cet échec.
percentageCompleted

number

Uniquement en sortie. Pourcentage d'exécution de cette exportation d'audience, compris entre 0 et 100.
recurringAudienceList

string

Uniquement en sortie. Liste d'audience récurrente qui a créé cette liste d'audience. Les listes d'audience récurrentes créent des listes d'audience quotidiennement.

Si les listes d'audience sont créées directement, elles n'auront aucune liste d'audience récurrente associée, et ce champ sera vide.
webhookNotification

object (WebhookNotification)

Facultatif. Configure les notifications de webhook à envoyer de l'API Google Analytics Data à votre serveur de webhook. L'utilisation de webhooks est facultative. Si vous ne l'utilisez pas, vous devrez 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 l'API.

Une ou deux requêtes POST seront envoyées au webhook. La première requête POST sera envoyée immédiatement, affichant la liste d'audience nouvellement créée dans son état CREATING. La deuxième requête POST sera 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 la liste d'audience peut renvoyer une liste d'audience déjà ACTIVE. Dans ce scénario, une seule requête POST sera envoyée au webhook.

État

L'AudienceList existe actuellement dans cet état.

Enums
STATE_UNSPECIFIED L'état non spécifié ne sera jamais utilisé.
CREATING L'AudienceList est en cours de création et sera disponible à l'avenir. La création a lieu immédiatement après l'appel audienceLists.create.
ACTIVE L'AudienceList est entièrement créée et prête à être interrogée. Une AudienceList est mise à jour de manière asynchrone à partir d'une requête. Cela se produit un certain temps (par exemple, 15 minutes) après l'appel de création initial.
FAILED La création de l'AudienceList a échoué. Il est possible que la nouvelle demande de cette liste d'audience aboutisse.

Méthodes

create

 Crée une liste d'audience pour une récupération ultérieure.

get

 Obtient les métadonnées de configuration d'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.