REST Resource: properties.audienceLists

Ressource : AudienceList

Une liste d'audience est une liste d'utilisateurs d'une audience au moment de la création de la liste. 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 ce 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 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 de quota facturés lors de la création de la liste d'audiences. É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 passera à 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 AudienceList est passé à 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 ne peut pas être créée. L'une des raisons courantes de cet échec est l'épuisement du quota.
percentageCompleted

number

Uniquement en sortie. Pourcentage d'exécution de l'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 des 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 depuis l'API Google Analytics Data vers votre serveur de 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 l'interrogation.

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 à l'état "CREATING" (EN COURS DE CRÉATION). La deuxième requête POST sera envoyée une fois la liste d'audience créé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 renvoyer une liste d'audience déjà ACTIVE. Dans ce scénario, une seule requête POST sera envoyée au webhook.

État

La liste d'audience existe actuellement dans 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 ultérieurement. 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 et activée 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 Échec de la création de la liste d'audience. 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.