REST Resource: properties.audienceExports

Ressource: AudienceExport

Une audience exportée est une liste d'utilisateurs appartenant à une audience au moment de sa création. 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 la 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 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 d'AudienceExport. É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'un AudienceExport passera aux états ACTIVE ou FAILED.
state

enum (State)

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

string (Timestamp format)

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

string

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

AudienceDimension

Une dimension d'audience est un attribut utilisateur. Les attributions utilisateur spécifiques sont demandées, puis renvoyées dans QueryAudienceExportResponse.

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

string

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

État

L'état actuel de l'audienceExport est le suivant.

Enums
STATE_UNSPECIFIED L'état non spécifié n'est jamais utilisé.
CREATING AudienceExport est actuellement en cours de création et sera disponible à l'avenir. La création a lieu immédiatement après l'appel audienceExports.create.
ACTIVE AudienceExport est entièrement créé et prêt à être interrogé. Une AudienceExport 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'audienceExport. Il est possible que la demande d'exportation de cette audience aboutisse.

Méthodes

create

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

get

 Récupère les métadonnées de configuration d'une exportation d'audience spécifique.

list

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

query

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