REST Resource: properties.audienceExports

Ressource : AudienceExport

Une exportation d'audience est une liste des utilisateurs d'une audience au moment de la création de la liste. Une même audience peut avoir plusieurs exportations 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
}
Champs
name

string

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

Format : properties/{property}/audienceExports/{audienceExport}
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'AudienceExport. É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'un AudienceExport passera à l'état ACTIVE ou FAILED.
state

enum (State)

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

string (Timestamp format)

Uniquement en sortie. Heure à laquelle audienceExports.create a été appelé et à laquelle AudienceExport est passé à 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 AudienceExport.
errorMessage

string

Uniquement en sortie. Un message d'erreur s'affiche lorsqu'une exportation d'audience échoue lors de la création. 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.

AudienceDimension

Une dimension d'audience est un attribut utilisateur. Des attributs utilisateur spécifiques sont demandés, puis renvoyés ultérieurement dans QueryAudienceExportResponse.

Représentation JSON 
{
  "dimensionName": string
}
Champs
dimensionName

string

Facultatif. Nom de l'API de la dimension. Consultez Dimensions de l'API pour obtenir la liste des noms de dimensions.

État

L'exportation d'audience existe actuellement dans cet état.

Enums
STATE_UNSPECIFIED L'état "Non spécifié" ne sera jamais utilisé.
CREATING L'exportation d'audience est en cours de création et sera disponible ultérieurement. La création a lieu immédiatement après l'appel audienceExports.create.
ACTIVE L'exportation d'audience est entièrement créée et prête à être interrogée. Une exportation d'audience est définie sur "active" 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 l'AudienceExport. Il est possible que la nouvelle demande d'exportation de cette audience aboutisse.

Méthodes

create

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

get

 Obtient les métadonnées de configuration d'une exportation d'audience spécifique.

list

 Liste toutes les exportations d'audience pour une propriété.

query

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