REST Resource: properties.audienceLists

Risorsa: AudienceList

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

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

string

Obbligatorio. Il nome della risorsa del segmento di 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 numero totale di token di quota addebitati durante la creazione di AudienceList. Poiché questo conteggio dei token si basa sull'attività dello stato CREATING, i token addebitati verranno corretti una volta che AudienceList entra negli stati ACTIVE o FAILED.
state

enum (State)

Solo output. Lo stato attuale di questo AudienceList.
beginCreatingTime

string (Timestamp format)

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

string

Solo output. Il messaggio di errore viene compilato quando la creazione di un elenco del segmento di pubblico non riesce. Un motivo comune di questo errore è l'esaurimento della quota.
percentageCompleted

number

Solo output. La percentuale di completamento per questa 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 del segmento di pubblico. Gli elenchi dei segmenti di pubblico ricorrenti creano elenchi dei segmenti di pubblico ogni giorno.

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

object (WebhookNotification)

Facoltativo. Configura le notifiche webhook da inviare dall'API Google Analytics Data 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. I webhook consentono di inviare una notifica ai tuoi server ed evitare la necessità di eseguire il polling.

Al webhook verranno inviate una o due richieste POST. La prima richiesta POST verrà inviata immediatamente e mostrerà l'elenco del segmento 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 i successivi elenchi dei segmenti di pubblico 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, al webhook verrà inviata una sola richiesta POST.

Stato

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

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

Metodi

create

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

get

 Recupera i metadati di configurazione di 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.