REST Resource: properties.audienceExports

Risorsa: AudienceExport

Un'esportazione del segmento di pubblico è un elenco di utenti in un segmento di pubblico al momento della creazione dell'elenco. Per un segmento di pubblico possono essere create più esportazioni per giorni diversi.

Rappresentazione JSON 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number
}
Campi
name

string

Solo output. Identificatore. Il nome della risorsa di esportazione del segmento di pubblico assegnato durante la creazione. Questo nome della risorsa identifica questo AudienceExport.

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

string

Obbligatorio. Nome risorsa del segmento di pubblico. Questo nome della risorsa identifica il segmento di pubblico elencato ed è condiviso tra le API Analytics Data & Admin.

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

string

Solo output. Il nome visualizzato descrittivo per questo segmento di pubblico. Ad esempio, "Acquirenti".
dimensions[]

object (AudienceDimension)

Obbligatorio. Le dimensioni richieste e visualizzate nella risposta alla query.
creationQuotaTokensCharged

integer

Solo output. Il numero totale di token di quota addebitati durante la creazione di AudienceExport. Poiché questo conteggio dei token si basa sull'attività dello stato CREATING, i token addebitati verranno fissati una volta che un AudienceExport entra negli stati ACTIVE o FAILED.
state

enum (State)

Solo output. Lo stato attuale di questo AudienceExport.
beginCreatingTime

string (Timestamp format)

Solo output. L'ora in cui è stato chiamato audienceExports.create e AudienceExport ha iniziato lo stato CREATING.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
rowCount

integer

Solo output. Il numero totale di righe nel risultato AudienceExport.
errorMessage

string

Solo output. Il messaggio di errore viene visualizzato quando l'esportazione di un pubblico non riesce durante la creazione. Un motivo comune di questo errore è l'esaurimento della quota.
percentageCompleted

number

Solo output. La percentuale di completamento di questa esportazione del pubblico, compresa tra 0 e 100.

AudienceDimension

Una dimensione segmento di pubblico è un attributo utente. Vengono richiesti attributi specifici dell'utente, che vengono poi restituiti in QueryAudienceExportResponse.

Rappresentazione JSON 
{
  "dimensionName": string
}
Campi
dimensionName

string

Facoltativo. Il nome API della dimensione. Consulta la sezione Dimensioni API per l'elenco dei nomi delle dimensioni.

Stato

L'esportazione del segmento di pubblico esiste attualmente in questo stato.

Enum
STATE_UNSPECIFIED Lo stato Non specificato non verrà mai utilizzato.
CREATING AudienceExport è attualmente in fase di creazione e sarà disponibile in futuro. La creazione avviene immediatamente dopo la chiamata audienceExports.create.
ACTIVE AudienceExport è stato creato completamente ed è pronto per le query. Un AudienceExport viene aggiornato ad attivo in modo asincrono da una richiesta. Ciò si verifica dopo un po' di tempo (ad esempio 15 minuti) dalla chiamata di creazione iniziale.
FAILED Impossibile creare AudienceExport. È possibile che la nuova richiesta di esportazione del segmento di pubblico vada a buon fine.

Metodi

create

 Crea un'esportazione del segmento di pubblico per il recupero successivo.

get

 Recupera i metadati di configurazione relativi a un'esportazione di segmenti di pubblico specifica.

list

 Elenca tutte le esportazioni di segmenti di pubblico per una proprietà.

query

 Recupera un'esportazione del segmento di pubblico di utenti.