REST Resource: properties.audienceLists

Risorsa: AudienceList

Un elenco del segmento di pubblico è l'elenco degli utenti di un segmento di pubblico al momento della sua creazione. Un segmento di pubblico può avere più elenchi dei segmenti di pubblico creati 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 risorsa identifica questo AudienceList.

Formato: properties/{property}/audienceLists/{audienceList}
audience

string

Obbligatorio. Il nome della risorsa pubblico. Questo nome risorsa identifica il segmento di pubblico elencato e viene condiviso tra i dati di Analytics e API amministrative.

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

string

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

object (AudienceDimension)

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

integer

Solo output. I token di quota totali addebitati durante la creazione di AudienceList. Poiché questo conteggio dei token si basa sull'attività nello stato CREATING, questi token addebitati verranno corretti una volta che un elenco di segmenti di pubblico entra nello stato ACTIVE o FAILED.
state

enum (State)

Solo output. Lo stato attuale di questo elenco di segmenti di pubblico.
beginCreatingTime

string (Timestamp format)

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

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi 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. Un messaggio di errore viene compilato quando un elenco del segmento di pubblico non funziona durante la creazione. Un motivo comune di questo errore è l'esaurimento della quota.
percentageCompleted

number

Solo output. La percentuale di completamento per questa esportazione dei segmenti di pubblico compresa tra 0 e 100.
recurringAudienceList

string

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

Se vengono creati direttamente, gli elenchi dei segmenti di pubblico non saranno associati a un elenco del segmento di pubblico ricorrente e questo campo sarà vuoto.
webhookNotification

object (WebhookNotification)

(Facoltativo) Configura le notifiche webhook da inviare dall'API di dati di Google Analytics al server webhook. L'uso dei webhook è facoltativo. Se non viene utilizzata, dovrai eseguire il polling di questa API per determinare quando un elenco del segmento di pubblico è pronto per essere utilizzato. I webhook consentono l'invio di notifiche ai tuoi server e evitando di ricorrere ai sondaggi.

Al webhook verranno inviate una o due richieste POST. La prima richiesta POST verrà inviata immediatamente, mostrando l'elenco del segmento di pubblico appena creato nello stato IN FASE DI CREAZIONE. La seconda richiesta POST verrà inviata al termine della creazione dell'elenco del segmento di pubblico (in stato ATTIVO o NON RIUSCITA).

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

Stato

Attualmente l'elenco dei segmenti di pubblico esiste in questo stato.

Enum
STATE_UNSPECIFIED Non verrà mai utilizzato lo stato non specificato.
CREATING L'elenco dei segmenti di pubblico è attualmente in fase di creazione e sarà disponibile in futuro. La creazione avviene immediatamente dopo la chiamata audienceLists.create.
ACTIVE AudienceList è stato completamente creato ed è pronto per l'esecuzione di query. Un elenco di segmenti di pubblico viene aggiornato in modo che sia attivo in modo asincrono da una richiesta. Questo avviene un po' di tempo (ad esempio 15 minuti) dopo la chiamata iniziale di creazione.
FAILED Impossibile creare AudienceList. È possibile che la nuova richiesta di questo elenco del segmento di pubblico vada a buon fine.

Metodi

create

 Crea un elenco del segmento di pubblico da recuperare in un secondo momento.

exportSheet

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

get

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

list

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

query

 Recupera un elenco del segmento di pubblico di utenti.