REST Resource: properties.audienceLists

{
  "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)
  }
}

string

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

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

string

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 : properties/{property}/audiences/{audience}

string

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

object (AudienceDimension)

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

integer

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 CREATING, le problème des jetons facturés est corrigé lorsqu'une liste d'audience passe à l'état ACTIVE ou FAILED.

enum (State)

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

string (Timestamp format)

Uniquement en sortie. Heure à laquelle audienceLists.create a été appelée et où l'état CREATING a été lancé pour AudienceList.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

integer

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

string

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.

number

Uniquement en sortie. Pourcentage d'achèvement pour cette exportation d'audience, compris entre 0 et 100.

string

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.

object (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.