REST Resource: properties.audienceLists

Risorsa: AudienceList

Un elenco del segmento di pubblico è un elenco di utenti di un segmento di pubblico al momento della sua creazione. Per un segmento di pubblico possono essere creati più elenchi 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,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
Campi
name

string

Solo output. Identificatore. Il nome della risorsa dell'elenco del segmento di pubblico assegnato durante la creazione. Questo nome della risorsa identifica questo AudienceList.

Formato: properties/{property}/audienceLists/{audienceList}
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 dell'elenco del segmento di pubblico. Poiché questo conteggio dei token si basa sull'attività dello stato CREATING, questi token addebitati verranno corretti quando un AudienceList entra negli stati ACTIVE o FAILED.
state

enum (State)

Solo output. Lo stato attuale di questo elenco del segmento di pubblico.
beginCreatingTime

string (Timestamp format)

Solo output. L'ora in cui è stato chiamato audienceLists.create e AudienceList 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 AudienceList.
errorMessage

string

Solo output. Il messaggio di errore viene visualizzato quando la creazione di un elenco del segmento di pubblico non va a buon fine. 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.
recurringAudienceList

string

Solo output. L'elenco del segmento di pubblico ricorrente che ha creato questo elenco. Gli elenchi dei segmenti di pubblico ricorrenti vengono creati ogni giorno.

Se gli elenchi dei segmenti di pubblico vengono creati direttamente, non avranno un elenco dei segmenti di pubblico ricorrenti associato e questo campo sarà vuoto.
webhookNotification

object (WebhookNotification)

Facoltativo. Configura le notifiche webhook da inviare dall'API di dati di Google Analytics al tuo server webhook. L'utilizzo dei webhook è facoltativo. Se non viene utilizzato, dovrai eseguire il polling di questa API per determinare quando un elenco del segmento di pubblico è pronto per essere utilizzato. Gli webhook consentono di inviare una notifica ai tuoi server ed evitano la necessità di eseguire polling.

All'webhook verranno inviate una o due richieste POST. La prima richiesta POST verrà inviata immediatamente mostrando l'elenco dei segmenti di pubblico appena creato nello stato CREATING. La seconda richiesta POST verrà inviata al termine della creazione dell'elenco del segmento di pubblico (stato ACTIVE o FAILED).

Se vengono richiesti elenchi dei segmenti di pubblico identici in rapida successione, il secondo e gli elenchi dei segmenti di pubblico successivi possono essere pubblicati dalla cache. In questo caso, il metodo di creazione dell'elenco del segmento di pubblico può restituire un elenco del segmento di pubblico già ATTIVO. In questo scenario, all'webhook verrà inviata una sola richiesta POST.

Stato

Al momento, AudienceList esiste in questo stato.

Enum
STATE_UNSPECIFIED Lo stato non specificato non verrà mai utilizzato.
CREATING Al momento, AudienceList è in fase di creazione e sarà disponibile in futuro. La creazione avviene immediatamente dopo la chiamata audienceLists.create.
ACTIVE L'elenco di segmenti di pubblico è completamente creato e pronto per le query. Un elenco di segmenti di pubblico viene aggiornato 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 l'elenco del segmento di pubblico. È possibile che la richiesta di questo elenco del segmento di pubblico vada a buon fine.

Metodi

create

 Crea un elenco del segmento di pubblico per il recupero successivo.

exportSheet

 Esporta un elenco del segmento di pubblico di utenti in un foglio Google.

get

 Recupera i metadati di configurazione relativi a un elenco del segmento di pubblico specifico.

list

 Elenca tutti gli elenchi dei segmenti di pubblico per una proprietà.

query

 Recupera un elenco del segmento di pubblico di utenti.