REST Resource: properties.audienceExports

Risorsa: AudienceExport

Un'esportazione del segmento di pubblico è un elenco di utenti di 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 dei segmenti di pubblico assegnato durante la creazione. Questo nome della risorsa identifica questo AudienceExport.

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

audience

string

Obbligatorio. Il nome della risorsa pubblico. Questo nome della risorsa identifica il segmento di pubblico elencato ed è condiviso tra le API Analytics Data e 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 totale dei token quota addebitati durante la creazione di AudienceExport. Poiché questo conteggio dei token si basa sull'attività dello stato CREATING, questi token addebitati verranno corretti quando un'esportazione del segmento di pubblico entra negli stati ACTIVE o FAILED.

state

enum (State)

Solo output. Lo stato attuale di questa esportazione del segmento di pubblico.

beginCreatingTime

string (Timestamp format)

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

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

rowCount

integer

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

errorMessage

string

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

percentageCompleted

number

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

AudienceDimension

Una dimensione del segmento di pubblico è un attributo utente. Gli attributi utente specifici vengono richiesti e poi restituiti in QueryAudienceExportResponse.

Rappresentazione JSON
{
  "dimensionName": string
}
Campi
dimensionName

string

Facoltativo. Il nome dell'API della dimensione. Consulta le dimensioni dell'API per l'elenco dei nomi delle dimensioni.

Stato

Al momento, AudienceExport esiste in questo stato.

Enum
STATE_UNSPECIFIED Lo stato non specificato non verrà mai utilizzato.
CREATING Al momento AudienceExport è in fase di creazione e sarà disponibile in futuro. La creazione avviene immediatamente dopo la chiamata audienceExports.create.
ACTIVE AudienceExport è completamente creato e pronto per le query. Un'esportazione dei segmenti di pubblico viene aggiornata in stato attivo in modo asincrono da una richiesta; questo avviene un po' di tempo (ad esempio 15 minuti) dopo la chiamata di creazione iniziale.
FAILED Impossibile creare AudienceExport. È possibile che la 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 del segmento di pubblico specifico.

list

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

query

Recupera un'esportazione del segmento di pubblico degli utenti.