REST Resource: properties.audienceLists

Ressource: AudienceList

Une liste d'audience est une liste d'utilisateurs appartenant à 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 la ressource de 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 la ressource d'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'audience. Étant donné que ce nombre de jetons est basé sur l'activité de l'état CREATING, les jetons facturés seront corrigés une fois qu'une AudienceList passera aux états 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'état CREATING a commencé pour AudienceList.

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 ne peut pas être créée. L'épuisement des quotas est une cause courante de cet échec.
percentageCompleted

number

Uniquement en sortie. Pourcentage d'avancement de l'exportation de cette audience, compris entre 0 et 100.
recurringAudienceList

string

Uniquement en sortie. Liste d'audience récurrente à partir de laquelle cette liste d'audience a été créée. Les listes d'audience récurrentes créent des listes d'audience tous les jours.

Si vous créez directement des listes d'audience, aucune liste d'audience récurrente ne leur sera associée, et ce champ sera vide.
webhookNotification

object (WebhookNotification)

Facultatif. Configure les notifications webhook à envoyer depuis l'API Google Analytics Data vers votre serveur webhook. L'utilisation de webhooks est facultative. Si elle n'est pas utilisée, 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 les requêtes actives.

Une ou deux requêtes POST sont envoyées au webhook. La première requête POST est envoyée immédiatement et affiche la liste d'audience nouvellement créée à l'état "CREATING". La deuxième 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 l'une après l'autre, 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'état actuel de l'audienceList est le suivant.

Enums
STATE_UNSPECIFIED L'état non spécifié n'est jamais utilisé.
CREATING La liste d'audience est actuellement en cours de création et sera disponible à l'avenir. 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 AudienceList est mise à jour de manière asynchrone en tant qu'élément actif à partir d'une requête. Cela se produit un certain temps (par exemple, 15 minutes) après l'appel de création initial.
FAILED Échec de la création de l'audience. Il est possible que la demande de cette liste d'audience aboutisse.

Méthodes

create

 Crée une liste d'audience à 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 d'une liste d'audience spécifique.

list

 Répertorie toutes les listes d'audience d'une propriété.

query

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