REST Resource: properties.audienceExports

Ressource: AudienceExport

Une exportation d'audience correspond à la liste des utilisateurs d'une audience au moment de sa création. Une même audience peut avoir plusieurs exportations d'audiences créées pour des jours différents.

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 ce AudienceExport.

Format : properties/{property}/audienceExports/{audienceExport}
audience

string

Obligatoire. Nom de ressource de l'audience. Ce nom de ressource identifie l'audience répertoriée. Il est partagé entre les données Analytics et API Admin.

Format : properties/{property}/audiences/{audience}
audienceDisplayName

string

Uniquement en sortie. Nom descriptif à afficher 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 l'AudienceExport. Comme ce nombre de jetons est basé sur l'activité à l'état CREATING, ces jetons facturés ne seront plus facturés dès qu'une AudienceExport passera à l'état 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 que 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. Un tel échec est souvent dû à l'épuisement du quota.
percentageCompleted

number

Uniquement en sortie. Pourcentage terminé pour cette exportation d'audience, compris entre 0 et 100.

AudienceDimension

Une dimension d'audience est un attribut utilisateur. Des utilisateurs spécifiques attribués sont demandés, puis renvoyés dans l'QueryAudienceExportResponse.

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

string

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

État

Cet état existe actuellement pour l'élément AudienceExport.

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 à l'avenir. La création a lieu immédiatement après l'appel audienceExports.create.
ACTIVE L'API AudienceExport est entièrement créée et prête à être interrogée. Une AudienceExport devient active de manière asynchrone à partir d'une requête. Cela se produit quelque temps (par exemple, 15 minutes) après l'appel de création initial.
FAILED Échec de la création de l'élément 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

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

list

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

query

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