Method: properties.audienceExports.query

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

Per un'introduzione alle esportazioni di segmenti di pubblico con esempi, consulta Creare un'esportazione di segmenti di pubblico.

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

Le API Audience Export hanno alcuni metodi in versione alpha e altri in versione beta. L'intenzione è di portare i metodi alla stabilità beta dopo aver raccolto feedback e averli adottati. 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/v1beta/{name=properties/*/audienceExports/*}:query

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatorio. Il nome dell'esportazione del segmento di pubblico da cui recuperare gli utenti. Formato: properties/{property}/audienceExports/{audienceExport}

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.

Durante la paginazione, la prima richiesta non specifica l'offset o, in modo equivalente, lo imposta su 0; la prima richiesta restituisce le prime limit righe. La seconda richiesta imposta l'offset sul valore limit della prima richiesta; la seconda richiesta restituisce il secondo limit di righe.

Per scoprire di più su questo parametro di impaginazione, vedi Impaginazione.
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 dal numero di righe richieste. limit deve essere positivo.

L'API può anche restituire meno righe del limit richiesto, se non sono presenti tanti valori di dimensione quanti sono i limit.

Per scoprire di più su questo parametro di impaginazione, vedi Impaginazione.

Corpo della risposta

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

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

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

object (AudienceRow)

Righe per ogni utente in un'esportazione di segmenti di pubblico. Il numero di righe in questa risposta sarà inferiore o uguale alle dimensioni della pagina della richiesta.
audienceExport

object (AudienceExport)

Dati di configurazione relativi alla query di AudienceExport. Restituiti per facilitare l'interpretazione delle righe del pubblico in questa risposta. Ad esempio, le dimensioni in questo AudienceExport corrispondono alle colonne in AudienceRows.
rowCount

integer

Il numero totale di righe nel risultato AudienceExport. 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 impaginazione, vedi Impaginazione.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

AudienceRow

Attributi del valore della dimensione per la riga utente del 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 della dimensione per ogni colonna della dimensione richiesta.

AudienceDimensionValue

Il valore di una dimensione.

Rappresentazione JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string
  // End of mutually exclusive fields.
}
Campi
Un tipo di valore della dimensione. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
value

string

Valore come stringa se il tipo di dimensione è una stringa.
Fine dei campi che si escludono a vicenda.