Method: properties.audienceLists.exportSheet

Esporta un elenco del segmento di pubblico degli utenti in un foglio Google. Dopo aver creato un segmento di pubblico, gli utenti non saranno immediatamente disponibili per la scheda. Innanzitutto, per creare un elenco del segmento di pubblico di utenti è necessaria una richiesta a audienceLists.create e, in secondo luogo, questo metodo viene utilizzato per esportare questi utenti nell'elenco del segmento di pubblico in un foglio Google.

Consulta la sezione Creare un elenco dei segmenti di pubblico per un'introduzione agli elenchi dei segmenti di pubblico completa di esempi.

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.

Questo metodo è stato introdotto nella fase di stabilità alfa allo scopo di raccogliere feedback sulla sintassi e sulle funzionalità prima del passaggio alla versione beta. Per inviare il tuo feedback su questa API, compila il modulo di feedback sull'API Audience Export di Google Analytics.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatoria. 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)

Campo facoltativo. Il conteggio delle righe della riga iniziale. La prima riga viene conteggiata come riga 0.

Durante il paging, la prima richiesta non specifica l'offset o, equivalente, imposta l'offset su 0. La prima richiesta restituisce il primo limit delle righe. La seconda richiesta imposta l'offset al valore limit della prima richiesta, mentre la seconda restituisce il secondo valore limit delle righe.

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

string (int64 format)

Campo facoltativo. Il numero di righe da restituire. Se non specificati, vengono restituite 10.000 righe. L'API restituisce un massimo di 250.000 righe per richiesta, indipendentemente da quante ne chiedi. limit deve essere un numero positivo.

L'API può anche restituire meno righe rispetto al valore limit richiesto, se il numero di valori della dimensione è inferiore a limit.

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

Corpo della risposta

Il foglio Google creato con l'elenco degli 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 
{
  "spreadsheetUri": string,
  "spreadsheetId": string,
  "rowCount": integer,
  "audienceList": {
    object (AudienceList)
  }
}
Campi
spreadsheetUri

string

Un URI da visitare nel browser per visualizzare il foglio Google.
spreadsheetId

string

Un ID che identifica la risorsa di Fogli Google creata.
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 impaginazione, consulta Impaginazione.
audienceList

object (AudienceList)

Dati di configurazione relativi all'esportazione di AudienceList. Tornato per aiutarti a interpretare l'elenco di segmenti di pubblico nel foglio Google di questa risposta.

Ad esempio, AudienceList potrebbe avere più righe di quelle presenti nel foglio Google e, in questo caso, potresti voler inviare un'ulteriore richiesta di esportazione del foglio con un valore offset diverso per recuperare la pagina successiva di righe in un altro foglio Google.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets