Method: properties.audienceLists.query

Recupera un elenco del segmento di pubblico di utenti. Dopo aver creato un segmento di pubblico, gli utenti non sono immediatamente disponibili per l'inserimento nell'elenco. Innanzitutto, è necessaria una richiesta a audienceLists.create per creare un elenco del segmento di pubblico degli utenti e, in secondo luogo, questo metodo viene utilizzato per recuperare gli utenti nell'elenco del segmento di pubblico.

Consulta Creare un elenco del segmento di pubblico per un'introduzione agli elenchi dei segmenti di pubblico con esempi.

I segmenti di pubblico in Google Analytics 4 ti permettono di suddividere gli utenti in base agli aspetti più importanti per la tua attività. Per scoprire di più, consulta https://support.google.com/analytics/answer/9267572.

Questo metodo è disponibile in versione beta stabile in audienceExports.query. Per inviare il tuo feedback su questa API, compila il modulo Feedback sull'API Audience Export di Google Analytics.

Richiesta HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatorio. Il nome dell'elenco del segmento di pubblico da cui recuperare gli utenti. Formato: properties/{property}/audienceLists/{audienceList}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "offset": string,
  "limit": string
}
Campi
offset

string (int64 format)

(Facoltativo) Il conteggio delle righe della riga iniziale. La prima riga viene conteggiata come riga 0.

Quando viene utilizzata la paginazione, la prima richiesta non specifica l'offset; in alternativa, imposta l'offset su 0; la prima richiesta restituisce le prime limit righe. La seconda richiesta imposta l'offset sul limit della prima richiesta; la seconda richiesta restituisce il secondo limit di righe.

Per scoprire di più su questo parametro di paginazione, consulta la sezione Paginazione.
limit

string (int64 format)

(Facoltativo) Il numero di righe da restituire. Se non specificato, vengono restituite 10.000 righe. L'API restituisce un massimo di 250.000 righe per richiesta, indipendentemente da quante ne richiedi. limit deve essere positivo.

L'API può anche restituire meno righe rispetto al limit richiesto, se non sono presenti gli stessi valori delle dimensioni del limit.

Per scoprire di più su questo parametro di paginazione, consulta la sezione Paginazione.

Corpo della risposta

Un elenco di utenti in un elenco del segmento di pubblico.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
Campi
audienceRows[]

object (AudienceRow)

Righe per ogni utente in un elenco del segmento di pubblico. Il numero di righe in questa risposta sarà inferiore o uguale alle dimensioni della pagina della richiesta.
audienceList

object (AudienceList)

Dati di configurazione relativi all'elenco di segmenti di pubblico su cui viene eseguita la query. Restituito per aiutare a interpretare le righe del segmento di pubblico in questa risposta. Ad esempio, le dimensioni in questo AudienceList corrispondono alle colonne in AudienceRows.
rowCount

integer

Il numero totale di righe nel risultato AudienceList. rowCount è indipendente dal numero di righe restituite nella risposta, dal parametro di richiesta limit e dal parametro di richiesta offset. Ad esempio, se una query restituisce 175 righe e include limit di 50 nella richiesta API, la risposta conterrà rowCount di 175, ma solo 50 righe.

Per scoprire di più su questo parametro di paginazione, consulta la sezione Paginazione.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

AudienceRow

Attributi dei valori delle dimensioni per la riga utente del segmento di pubblico.

Rappresentazione JSON 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
Campi
dimensionValues[]

object (AudienceDimensionValue)

Ogni attributo del valore della dimensione per un utente del segmento di pubblico. Verrà aggiunto un valore di dimensione per ogni colonna di dimensione richiesta.

AudienceDimensionValue

Il valore di una dimensione.

Rappresentazione JSON 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
Campi
Campo unione one_value. Un tipo di valore della dimensione. one_value può essere solo uno dei seguenti:
value

string

Valore come stringa se il tipo di dimensione è una stringa.