REST Resource: properties.audienceExports

Ressource: AudienceExport

Une exportation d'audience est une liste d'utilisateurs d'une audience au moment de la création de la liste. Une même audience peut avoir plusieurs exportations d'audiences 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 répertoriée et est partagé entre les API Data et Admin Analytics.

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. Le quota total de jetons facturés lors de la création d'AudienceExport. Comme le nombre de jetons est basé sur l'activité à l'état CREATING, le problème des jetons facturés sera corrigé lorsqu'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. Date et heure de l'appel d'audienceExports.create et du lancement de l'état CREATING par AudienceExport.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. 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 fréquente d'un tel échec.
percentageCompleted

number

Uniquement en sortie. Pourcentage d'achèvement pour cette exportation d'audience, compris entre 0 et 100.

AudienceDimension

Une dimension d'audience est un attribut utilisateur. Les données attribuées à un utilisateur spécifique sont demandées, puis renvoyées dans QueryAudienceExportResponse.

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

string

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

État

L'AudienceExport existe actuellement dans cet état.

Enums
STATE_UNSPECIFIED L'état non spécifié ne sera jamais utilisé.
CREATING L'API AudienceExport est en cours de création et sera disponible prochainement. 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. Un objet AudienceExport est mis à jour 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 qu'une nouvelle demande d'exportation d'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 concernant 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.