REST Resource: properties.audienceLists

Risorsa: AudienceList

Un elenco del segmento di pubblico è un elenco degli utenti di un segmento di pubblico al momento della creazione dell'elenco. Un segmento di pubblico potrebbe 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. Il nome di questa risorsa identifica questo AudienceList.

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

string

Obbligatoria. Il nome della risorsa pubblico. Questo nome risorsa identifica il segmento di pubblico elencato ed è condiviso tra le API Analytics e di dati di Analytics.

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

string

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

object (AudienceDimension)

Obbligatoria. 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à dello stato CREATING, i token addebitati verranno corretti una volta che un elenco dei segmenti di pubblico entra negli stati ACTIVE o FAILED.
state

enum (State)

Solo output. Lo stato attuale di questo AudienceList.
beginCreatingTime

string (Timestamp format)

Solo output. La data e l'ora in cui AudienceLists.create è stato chiamato e AudienceList ha avviato lo stato CREATING.

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

number

Solo output. La percentuale completata per l'esportazione di questo 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 vengono creati direttamente, gli elenchi dei segmenti di pubblico non avranno un elenco del segmento di pubblico ricorrente e il campo sarà vuoto.
webhookNotification

object (WebhookNotification)

Campo facoltativo. Configura le notifiche webhook da inviare dall'API di dati di Google Analytics al server webhook. L'utilizzo dei webhook è facoltativo. Se non utilizzi, dovrai eseguire un sondaggio in questa API per determinare quando è pronto per essere utilizzato un elenco del segmento di pubblico. I webhook consentono di inviare notifiche ai server ed evitano di dover eseguire il polling.

Una o due richieste POST verranno inviate al webhook. La prima richiesta POST verrà inviata immediatamente mostrando l'elenco del segmento di pubblico appena creato nello stato CREAZIONE. La seconda richiesta POST verrà inviata al termine della creazione dell'elenco del segmento di pubblico (stato ATTIVO o NON RIUSCITO).

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

Stato

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

Enum
STATE_UNSPECIFIED Lo stato non specificato non verrà mai utilizzato.
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 L'elenco dei segmenti di pubblico è completamente creato ed è pronto per l'esecuzione di query. Un AudienceList viene aggiornato in modo da essere attivo in modo asincrono da una richiesta; ciò si verifica un po' di tempo (ad esempio 15 minuti) dopo la chiamata di creazione iniziale.
FAILED Impossibile creare l'elenco di segmenti di pubblico. È 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 degli 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 relativi a una proprietà.

query

 Recupera un elenco del segmento di pubblico di utenti.