Introduzione
L'API Linking fornisce un'interfaccia affidabile per configurare e inoltrare gli utenti direttamente a un report di Looker Studio tramite un URL. Quando gli utenti seguono un URL dell'API Linking, possono visualizzare e interagire rapidamente con i propri dati in modo semplificato.
Questo documento descrive il formato richiesto degli URL dell'API Linking e i parametri disponibili.
Caso d'uso e vantaggi
L'API Linking può essere utilizzata per fornire report preconfigurati per consentire ai tuoi clienti di visualizzare e interagire con i loro dati. Di seguito sono riportati i principali vantaggi dell'API Linking:
- Un'esperienza di creazione di report con un solo clic per i tuoi clienti.
- La configurazione dei dati è fornita nell'URL, quindi gli utenti non devono configurare il report per i loro dati.
- Gli utenti possono salvare il report con un solo clic e consultarlo in qualsiasi momento.
- Crea report su larga scala. L'API Linking riduce il tempo necessario per duplicare o creare nuovi report.
- Abilita le integrazioni dei prodotti. L'interfaccia stabile consente di integrare Looker Studio nel flusso di lavoro di un prodotto.
Come funziona
Di seguito viene descritto il modo in cui sviluppatori e utenti interagiscono con l'API Linking.
Flusso di lavoro per sviluppatori dell'API Linking
Lo sviluppatore prepara i report dei modelli, le origini dati e il formato di un URL dell'API Linking. Il flusso di lavoro tipico per gli sviluppatori è il seguente:
- Decidi se utilizzare un report vuoto, il modello di report predefinito fornito da Looker Studio o creare un report di Looker Studio che fungerà da modello. Ciò include la configurazione delle origini dati del modello.
- Formatta un URL dell'API Linking per il tuo caso d'uso specifico. Se applicabile, specifica il modello di report e altri parametri, tra cui il nome del report, il nome dell'origine dati e le configurazioni dell'origine dati.
- Utilizza l'URL dell'API Linking per indirizzare gli utenti al report.
Esperienza utente dell'API Linking
L'utente segue un URL dell'API Linking che, se configurato correttamente dallo sviluppatore, lo indirizzerà a un report di Looker Studio che consente di visualizzare e interagire con i dati a cui ha accesso. Un'esperienza utente tipica può essere la seguente:
- In un browser, l'utente visita un servizio integrato con l'API Linking.
- Un invito all'azione invita l'utente a fare clic su un link per visualizzare i propri dati in Looker Studio.
- L'utente segue il link e viene indirizzato a un report di Looker Studio. Il report viene caricato e l'utente è in grado di visualizzare e interagire con i propri dati.
- L'utente fa clic su "Modifica e condividi". Il report viene salvato nel suo account Looker Studio.
- L'utente ha ora accesso e controllo completi sulla propria copia del report. Possono visualizzare, modificare e condividere contenuti in qualsiasi momento.
Requisiti
Per garantire che l'URL dell'API Linking funzioni come previsto, è necessario quanto segue:
- Un report da usare come modello. Se non viene fornito, è possibile utilizzare un report vuoto o predefinito da Looker Studio.
- Gli utenti di un URL dell'API Linking devono avere almeno l'accesso in visualizzazione al report del modello. A seconda del tipo di origini dati utilizzate nel report e della configurazione fornita tramite l'API Linking, gli utenti possono anche richiedere l'accesso in visualizzazione alle origini dati. Consulta Autorizzazioni per i modelli per i dettagli.
- Il tipo di connettore di ogni origine dati deve supportare la configurazione tramite l'API Linking. Consulta la documentazione di riferimento sui connettori per un elenco dei connettori supportati.
- Gli utenti dell'URL dell'API Linking devono avere accesso ai dati configurati nell'URL dell'API Linking. Se l'utente non ha accesso ai dati sottostanti, tutti i componenti dei report dipendenti mostreranno un errore.
Parametri URL
L'URL dell'API Linking deve avere il seguente formato:
https://lookerstudio.google.com/reporting/create?parameters
Si prevede che l'URL venga utilizzato nel contesto di un browser web, in genere quando un utente fa clic su un link o viene reindirizzato all'URL. Può essere utilizzata anche per incorporare un report.
URL di esempio
Di seguito è riportato un esempio di URL dell'API Linking. Il nome del report è impostato e viene configurata una singola origine dati BigQuery:
https://lookerstudio.google.com/reporting/create?
c.reportId=12345
&r.reportName=MyNewReport
&ds.ds0.connector=bigQuery
&ds.ds0.datasourceName=MyNewDataSource
&ds.ds0.projectId=project-1234
&ds.ds0.type=TABLE
&ds.ds0.datasetId=456
&ds.ds0.tableId=789
Alcuni parametri URL sono obbligatori, mentre altri sono facoltativi. Di seguito è riportato un elenco di parametri utilizzati per definire un URL dell'API Linking:
Parametri di controllo
I parametri di controllo determinano lo stato del report quando viene visualizzato tramite l'URL dell'API Linking.
Nome del parametro | Descrizione |
---|---|
Campo facoltativo. L'ID report del modello. Looker Studio aprirà e configurerà il report specificato. Per informazioni dettagliate su come trovare l'ID, consulta ID report. Se non specificati, vengono utilizzati un modello di report vuoto o un modello di report predefinito, consulta Utilizzare un report vuoto o predefinito per i dettagli. | |
Campo facoltativo. L'ID della pagina iniziale da caricare nel report. Se non specificato, il valore predefinito è la prima pagina del report. | |
Campo facoltativo. La modalità di report iniziale. Uno tra
view o
edit . Se non specificato, il valore predefinito è view .
|
|
Campo facoltativo. La visibilità della finestra di dialogo info/debug. Imposta su true per mostrare il pulsante della finestra di dialogo. Se non specificato, il valore predefinito è
false . Per saperne di più, consulta la sezione
Risoluzione dei problemi di configurazione.
|
Esempio
https://lookerstudio.google.com/reporting/create?
c.reportId=12345
&c.pageId=g7u8s9
&c.mode=edit
&r.reportName=MyNewReport
&ds.ds0.datasourceName=MyNewDataSource
&ds.ds0.connector=bigQuery
&ds.ds0.projectId=project-1234
&ds.ds0.type=TABLE
&ds.ds0.datasetId=456
&ds.ds0.tableId=789
Parametri del report
I parametri del report sostituiscono le proprietà del report.
Nome del parametro | Descrizione |
---|---|
Campo facoltativo. Imposta il nome del report. Se non specificati, il valore predefinito è il nome del report del modello. | |
Campo facoltativo. Imposta ID misurazione di Google Analytics su Misurare l'utilizzo dei report. Utilizza una virgola per separare più ID. Se |
|
Campo facoltativo. Imposta su Se |
Esempio
https://lookerstudio.google.com/reporting/create?
c.reportId=12345
&r.reportName=MyNewReport
&r.measurementId=G-XXXXXXXXXX
&ds.ds0.datasourceName=MyNewDataSource
&ds.ds0.connector=bigQuery
&ds.ds0.projectId=project-1234
&ds.ds0.type=TABLE
&ds.ds0.datasetId=456
&ds.ds0.tableId=789
Parametri delle origini dati
I parametri delle origini dati consentono di definire una configurazione dell'origine dati e i dati a cui accedere per le origini dati nel report del modello.
Un alias
viene utilizzato per fare riferimento a un'origine dati in un report esistente. L'utilizzo di un alias consente la compatibilità con le versioni precedenti se un'origine dati viene aggiunta/rimossa dal report del modello.
Per maggiori dettagli su come trovare un'origine dati alias
, vedi Alias origine dati.
Parametri delle origini dati
I seguenti parametri sono comuni a tutti i tipi di connettori:
Nome | Descrizione |
---|---|
Campo facoltativo. Imposta il nome dell'origine dati. Se |
|
Campo facoltativo. Impostalo su Se |
|
Campo facoltativo.
Il tipo di connettore dell'origine dati. Per ulteriori informazioni sui tipi di connettori supportati, consulta le informazioni di riferimento sui connettori. Se impostato, tutti i parametri del connettore richiesti per il tipo di connettore devono essere specificati nell'URL dell'API Linking e la configurazione dell'origine dati del modello verrà sostituita completamente. Se non viene specificato, non è possibile specificare nessuno o più parametri del connettore per il tipo di connettore nell'URL dell'API Linking. La configurazione dell'origine dati del modello verrà utilizzata per specificare tutti i parametri non forniti nell'URL dell'API Linking. Per maggiori dettagli su come identificare il tipo di connettore dell'origine dati del modello, consulta Tipo di connettore. Per scoprire di più su come il parametro |
|
Campo facoltativo.
Imposta il valore Imposta su Se non specificati, i valori predefiniti variano in base al tipo di connettore. Consulta il riferimento del connettore per conoscere i valori predefiniti specifici del connettore, se vuoi eseguire l'override del comportamento predefinito. Considerazioni per l'utilizzo di
refreshFields :
|
|
Obbligatorio. La configurazione dell'origine dati per il tipo di connettore. Per maggiori dettagli su come identificare il connettore utilizzato per creare un'origine dati, consulta Tipo di connettore. Per maggiori dettagli sui parametri dell'origine dati disponibili per ogni tipo di connettore, consulta la documentazione di riferimento sul connettore. |
Sostituisci e aggiorna: configurazioni dell'origine dati
Quando imposti i parametri dell'origine dati, la presenza o l'omissione del parametro ds.connector
nell'URL dell'API Linking indica l'intenzione di sostituire o aggiornare rispettivamente la configurazione dell'origine dati del modello.
La seguente tabella descrive in che modo il parametro ds.connector
influisce sulla sostituzione completa della configurazione di un'origine dati del modello o sull'utilizzo di quest'ultimo per aggiornare i parametri non specificati:
ds.connector è impostato? |
Configurazione e comportamento previsti | Utilizzo tipico |
---|---|---|
Sì |
Sostituisci. La configurazione dell'origine dati del modello viene sostituita nella sua interezza, utilizzando i parametri dell'origine dati specificati nell'URL dell'API Linking. Devi specificare tutti i parametri obbligatori per il tipo di connettore. Consulta Parametri obbligatori quando
è impostato ds.connector .
|
|
No | Aggiorna. La configurazione dell'origine dati del modello verrà utilizzata per specificare tutti i parametri non forniti nell'URL dell'API Linking. Tutti i parametri per il tipo di connettore sono facoltativi, se non diversamente indicato.
Questa operazione semplifica l'URL dell'API Linking ed è generalmente consigliata quando hai familiarità con la configurazione dell'origine dati del modello e vuoi eseguire solo l'override di un sottoinsieme di parametri. |
|
Parametri obbligatori quando è impostato ds.connector
Se viene specificato il parametro ds.connector
di un'origine dati, è necessario specificare tutti i parametri del connettore designati come obbligatori per l'origine dati. Se il parametro ds.connector
dell'origine dati non è specificato, tutti i parametri del connettore, anche quelli designati come obbligatori, possono essere trattati come facoltativi, se non diversamente indicato.
Esempi
Configura un report con una singola origine dati BigQuery (ds0
) e sostituisce completamente la configurazione dell'origine dati:
https://lookerstudio.google.com/reporting/create?
c.reportId=12345
&r.reportName=MyNewReport
&ds.ds0.datasourceName=MyNewDataSource
&ds.ds0.connector=bigQuery
&ds.ds0.type=TABLE
&ds.ds0.projectId=bigquery-public-data
&ds.ds0.datasetId=samples
&ds.ds0.tableId=shakespeare
L'alias origine dati può essere omesso quando il report ha una singola origine dati. L'URL sopra può essere semplificato come segue:
https://lookerstudio.google.com/reporting/create?
c.reportId=12345
&r.reportName=MyNewReport
&ds.datasourceName=MyNewDataSource
&ds.connector=bigQuery
&ds.type=TABLE
&ds.projectId=bigquery-public-data
&ds.datasetId=samples
&ds.tableId=shakespeare
Configura un report con una singola origine dati BigQuery (ds0
) e aggiorna solo l'ID progetto di fatturazione dell'origine dati:
https://lookerstudio.google.com/reporting/create?
c.reportId=12345
&r.reportName=MyNewReport
&ds.ds0.billingProjectId=my-billing-project
Configura un report con due origini dati, un'origine dati BigQuery (ds0
) e un'origine dati Google Analytics (ds1
). La configurazione dell'origine dati BigQuery viene sostituita nella sua interezza, mentre la configurazione di Google Analytics aggiorna un singolo parametro e si basa sull'origine dati del modello ds1
per eventuali parametri del connettore non specificati:
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&r.reportName=MyNewReportWithMultipleDataSources
&ds.ds0.datasourceName=MyNewDataSource
&ds.ds0.connector=bigQuery
&ds.ds0.type=TABLE
&ds.ds0.projectId=bigquery-public-data
&ds.ds0.datasetId=samples
&ds.ds0.tableId=shakespeare
&ds.ds1.viewId=92320289
Crea e Aggiungi
A volte può essere utile avere la stessa origine dati in più report, in modo che gli aggiornamenti dell'origine dati influiscano su tutti i report insieme. Quando crei un report con l'API Linking, puoi aggiungere nuovamente un'origine dati dal report del modello assicurandoti che siano soddisfatte tutte le seguenti condizioni:
- L'origine dati è riutilizzabile (consulta la sezione Confronto tra origini dati incorporate e riutilizzabili)
- L'URL non fa riferimento all'origine dati tramite alias
- L'URL non utilizza un alias carattere jolly (vedi Carattere jolly alias origine dati)
Quando viene creata una nuova origine dati con l'API Linking, questa utilizza le credenziali dell'utente che ha fatto clic sull'URL. Ciò significa che l'utente deve avere accesso ai dati sottostanti, altrimenti la connessione non funzionerà. Se aggiungi di nuovo l'origine dati al report appena generato, puoi conservarne le credenziali in modo che gli utenti possano continuare ad accedere ai dati nei nuovi report.
Carattere jolly alias origine dati
Per applicare un parametro dell'API Linking a più origini dati, è possibile utilizzare l'alias con caratteri jolly
ds.*
al posto dell'alias dell'origine dati.
Questo può essere utile per rimuovere i parametri ripetitivi dall'URL. Ad esempio, se hai un modello con tre origini dati BigQuery allegate e vuoi sostituire projectId
e datasetId
in ognuna, ma conservare il valore tableId
, puoi scriverlo come:
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&ds.ds1.projectId=client-project
&ds.ds1.datasetId=client-dataset
&ds.ds2.projectId=client-project
&ds.ds2.datasetId=client-dataset
&ds.ds3.projectId=client-project
&ds.ds3.datasetId=client-dataset
In alternativa, con il carattere jolly ds.*
, puoi utilizzare questo URL equivalente:
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&ds.*.projectId=client-project
&ds.*.datasetId=client-dataset
I parametri forniti all'API Linking che non utilizzano il carattere jolly ds.*
hanno la precedenza sui parametri esistenti. Nell'esempio precedente puoi aggiungere un alias di origine dati specifico per sostituire il valore dal carattere jolly.
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&ds.*.projectId=client-project
&ds.*.datasetId=client-dataset
&ds.ds1.datasetId=client-dataset
Più in generale, l'ordine di precedenza dei parametri è:
- Un parametro specificato con un alias specifico (
ds.ds1.datasetId
) - Un parametro fornito utilizzando il carattere jolly (
ds.*.datasetId
) - Un valore derivato dall'origine dati del modello, se ds.connector non è fornito (consulta la sezione Sostituire e aggiornare)
- Il valore predefinito del parametro, se è facoltativo.
Riferimento per i connettori
L'API Linking supporta i seguenti connettori e configurazioni. Per ogni connettore viene fornito l'elenco dei parametri dell'origine dati disponibili.
BigQuery
Il connettore BigQuery supporta due tipi di query: una query TABLE
, in cui devi fornire l'ID tabella della tabella su cui eseguire la query e un CUSTOM_QUERY
, in cui devi fornire un'istruzione SQL per eseguire query su una tabella.
Query TABLE
I seguenti parametri sono applicabili quando il criterio type
è impostato su TABLE
e fornisci l'ID della tabella su cui eseguire la query.
Nome del parametro | Descrizione |
---|---|
Campo facoltativo. Imposta il valore bigQuery per il connettore BigQuery.Se impostato, sostituisce l'origine dati con la configurazione BigQuery fornita. Consulta la sezione Sostituire e aggiornare. |
|
Obbligatorio** Il tipo di query. Imposta su
TABLE . |
|
Obbligatorio** L'ID progetto della tabella su cui eseguire la query. | |
Obbligatorio** L'ID del set di dati della tabella su cui eseguire la query. | |
Obbligatorio** L'ID tabella della tabella su cui eseguire la query. Tabelle con sharding delle date: Il suffisso * (carattere carattere jolly) o YYYYMMDD è supportato
durante l'esecuzione di query sulle tabelle con sharding delle date.Se una tabella è identificata come Google Analytics, Firebase Analytics o Firebase Crashlytics, viene selezionato un modello di campi predefinito, a meno che non ne venga specificato uno. Consulta i parametri relativi alla tabella fields template. |
|
Campo facoltativo. L'ID del progetto da utilizzare per la fatturazione. Se non viene configurato, verrà utilizzato
projectId . |
|
Campo facoltativo. Impostalo su true se la tabella è partizionata e vuoi utilizzare la colonna di partizionamento come dimensione dell'intervallo di date. Si applica solo al partizionamento basato sul tempo (ad esempio, utilizzando una colonna di partizionamento basato sul tempo o la pseudocolonna _PARTITIONTIME ) e non funziona per le tabelle partizionate con intervallo di numeri interi. Se non specificato, il valore predefinito è
false . Per saperne di più, consulta
Introduzione alle tabelle partizionate. |
|
Campo facoltativo. Se non specificato, il valore predefinito è true . Per i dettagli, consulta
refreshFields. |
Modello di campi per Google Analytics, Firebase Analytics e Crashlytics
Per le tabelle identificate come Google Analytics, Firebase Analytics o Firebase Crashlytics, sono disponibili parametri aggiuntivi per impostare il modello dei campi. Se non specificato, verrà selezionato un modello predefinito.
Nome | Descrizione |
---|---|
Campo facoltativo. Il modello di campi di Google Analytics da utilizzare. Applicabile solo quando viene eseguita una query su un'esportazione BigQuery per una tabella Google Analytics. Uno di ALL , SESSION , HITS . Per le tabelle di Google Analytics, il valore predefinito è ALL , se non specificato. |
|
Campo facoltativo. Il modello di campi di Firebase Analytics da utilizzare. Applicabile solo quando viene eseguita una query su una tabella BigQuery Export per Firebase Analytics.
Può essere impostato solo su EVENTS . Per le tabelle Firebase Analytics,
il valore predefinito è EVENTS se non specificato. |
|
Il modello di campi di Firebase Crashlytics da utilizzare. Può essere impostato solo su
DEFAULT . Applicabile solo quando viene eseguita una query su una tabella BigQuery Export per Firebase Crashlytics. Se non specificato, il valore predefinito per le tabelle Firebase Crashlytics è DEFAULT . |
Query CUSTOM
I seguenti parametri sono applicabili quando type
è impostato su CUSTOM_QUERY
e
fornisci un'istruzione SQL per eseguire query su una tabella.
Nome del parametro | Descrizione |
---|---|
Campo facoltativo. Imposta il valore bigQuery per il connettore BigQuery.Se impostato, sostituisce l'origine dati con la configurazione BigQuery fornita. Consulta la sezione Sostituire e aggiornare. |
|
Obbligatorio** Il tipo di query. Imposta su
CUSTOM_QUERY . |
|
Obbligatorio** La query SQL da eseguire. | |
Campo facoltativo. L'ID del progetto da utilizzare per la fatturazione. Se non viene configurato, verrà utilizzato
projectId . Se projectId non è impostato, verrà utilizzato il progetto della tabella sottoposta a query. |
|
Campo facoltativo. Un elenco delimitato da virgole di stringhe di pattern e sostituzione da applicare alla query SQL. La sostituzione delle stringhe viene applicata solo se esiste una corrispondenza di schema. Utilizza una virgola per separare le coppie di stringhe
di pattern e di sostituzione. Ad esempio, |
|
Campo facoltativo. Se non specificato, il valore predefinito è true . Per i dettagli, consulta
refreshFields. |
Esempi
Una configurazione di tipo TABLE
in cui la query viene definita con un ID tabella:
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.connector=bigQuery
&ds.ds0.type=TABLE
&ds.ds0.projectId=bigquery-public-data
&ds.ds0.datasetId=samples
&ds.ds0.tableId=shakespeare
&ds.ds0.billingProjectId=myProject
Una configurazione di tipo TABLE
per eseguire query su una tabella con sharding di data utilizzando il suffisso di caratteri jolly:
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.connector=bigQuery
&ds.ds0.type=TABLE
&ds.ds0.projectId=price-data
&ds.ds0.datasetId=samples
&ds.ds0.tableId=stock_*
Una configurazione di tipo TABLE
per eseguire query su una tabella con sharding in data utilizzando il suffisso YYYYMMDD
:
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.connector=bigQuery
&ds.ds0.type=TABLE
&ds.ds0.projectId=price-data
&ds.ds0.datasetId=samples
&ds.ds0.tableId=stock_YYYYMMDD
Una configurazione di tipo TABLE
per eseguire query su una tabella BigQuery Export per Google Analytics, utilizzando il modello di campi SESSION
:
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.connector=bigQuery
&ds.ds0.type=TABLE
&ds.ds0.projectId=my-gabq-project
&ds.ds0.datasetId=1234567
&ds.ds0.tableId=ga_sessions_YYYYMMDD
&ds.ds0.gaTemplateLevel=SESSION
Una configurazione di tipo TABLE
per eseguire query su una tabella partizionata per data di importazione e utilizzare la colonna di partizionamento come dimensione dell'intervallo di date:
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.connector=bigQuery
&ds.ds0.type=TABLE
&ds.ds0.projectId=acme-co-logs
&ds.ds0.datasetId=logs
&ds.ds0.tableId=logs_table
&ds.ds0.isPartitioned=true
Una configurazione di tipo CUSTOM_QUERY
in cui la query viene definita con un'istruzione SQL:
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.connector=bigQuery
&ds.ds0.type=CUSTOM_QUERY
&ds.ds0.projectId=bigquery-public-data
&ds.ds0.sql=SELECT%20word%2C%20word_count%20FROM%20%60bigquery-public-data.samples.shakespeare%60
&ds.ds0.billingProjectId=myProject
Una configurazione di tipo CUSTOM_QUERY
in cui viene aggiornata solo l'istruzione SQL e l'origine dati del modello viene utilizzata per il resto della configurazione:
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.sql=SELECT%20corpus%20FROM%20%60bigquery-public-data.samples.shakespeare%60
Una configurazione di tipo CUSTOM_QUERY
in cui l'istruzione SQL dell'origine dati del modello viene aggiornata utilizzando sqlReplace
:
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.sqlReplace=bigquery-public-data,new-project,samples,new-dataset
# The following shows a template query before and after sqlReplace is applied.
#
# Template data source custom query:
# SELECT word, word_count FROM big-query-public-data.samples.shakespeare
# INNER JOIN
# SELECT word, word_count FROM big-query-public-data.samples.raleigh
#
# New data source custom query with sqlReplace applied:
# SELECT word, word_count FROM new-project.new-dataset.shakespeare
# INNER JOIN
# SELECT word, word_count FROM new-project.new-dataset.raleigh
Cloud Spanner
Nome del parametro | Descrizione |
---|---|
Campo facoltativo. Impostalo su cloudSpanner per il connettore Cloud Spanner.Se impostato, sostituisce l'origine dati con la configurazione Cloud Spanner fornita. Consulta la sezione Sostituire e aggiornare. |
|
Obbligatorio** L'ID progetto. | |
Obbligatorio** L'ID istanza. | |
Obbligatorio** L'ID del database. | |
Obbligatorio** La query SQL da eseguire. | |
Campo facoltativo. Se non specificato, il valore predefinito è true .
Per informazioni dettagliate, consulta refreshFields. |
Esempio
Una configurazione Cloud Spanner con un'istruzione SQL:
https://lookerstudio.google.com/reporting/create?
c.reportId=456def
&ds.ds1.connector=cloudSpanner
&ds.ds1.projectId=myProject
&ds.ds1.instanceId=production
&ds.ds1.datasetId=transactions
&ds.ds1.sql=SELECT%20accountId%2C%20date%2C%20revenue%20FROM%20sales%3B
Connettori della community
Nome del parametro | Descrizione |
---|---|
Campo facoltativo. Impostalo su community per un
connettore della community.Se impostato, sostituisce l'origine dati con la configurazione del connettore della community fornita. Consulta la sezione Sostituire e aggiornare. |
|
Obbligatorio** Il connettore della community connectorId (noto anche come deploymentId ).
| |
Campo facoltativo. Parametri aggiuntivi specifici del connettore, come definiti dalla configurazione del connettore del connettore della community. | |
Campo facoltativo. Se non specificato, il valore predefinito è true . Per i dettagli, consulta
refreshFields. |
Esempio
Connettiti a un connettore della community con i parametri di configurazione state
e city
:
https://lookerstudio.google.com/reporting/create?
c.reportId=161718pqr
&ds.ds5.connector=community
&ds.ds5.connectorId=AqwqXxQshl94nJa0E0-1MsZXQL0DfCsJIMWk7dnx
&ds.ds5.state=CA
&ds.ds5.city=Sacramento
Google Analytics
Nome del parametro | Descrizione |
---|---|
Campo facoltativo. Imposta il valore googleAnalytics per il connettore Google Analytics.Se impostato, sostituisce l'origine dati con la configurazione di Google Analytics fornita. Consulta la sezione Sostituire e aggiornare. |
|
Obbligatorio** L'ID account. | |
Obbligatorio** L'ID proprietà. | |
L'ID vista. Obbligatorio** per le proprietà Universal Analytics. Non impostarlo per le proprietà Google Analytics 4. |
|
Campo facoltativo. Se non specificato, il valore predefinito è false . Per i dettagli, consulta
refreshFields. |
Esempi
Una configurazione di Google Analytics per una proprietà Universal Analytics:
https://lookerstudio.google.com/reporting/create?
c.reportId=789ghi
&ds.ds2.connector=googleAnalytics
&ds.ds2.accountId=54516992
&ds.ds2.propertyId=UA-54516992-1
&ds.ds2.viewId=92320289
Una configurazione di Google Analytics per una proprietà Google Analytics 4:
https://lookerstudio.google.com/reporting/create?
c.reportId=789ghi
&ds.ds2.connector=googleAnalytics
&ds.ds2.accountId=54516992
&ds.ds2.propertyId=213025502
Google Cloud Storage
Nome del parametro | Descrizione |
---|---|
Campo facoltativo. Impostalo su googleCloudStorage
Connettore
Google Cloud Storage.Se impostato, sostituisce l'origine dati con la configurazione di Google Cloud Storage fornita. Consulta la sezione Sostituire e aggiornare. |
|
Obbligatorio** Il tipo di percorso. Utilizza FILE per selezionare un singolo file o FOLDER per selezionare tutti i file per il percorso specificato. |
|
Obbligatorio** Il percorso del file (ad es. MyBucket/MyData/MyFile.csv) se pathType è FILE o il percorso della cartella (ad es. *MyBucket/MyData) se pathType è FOLDER . |
|
Campo facoltativo. Se non specificato, il valore predefinito è true .
Per informazioni dettagliate, consulta refreshFields. |
Esempio
Configurazione di Google Cloud Storage per un singolo file:
https://lookerstudio.google.com/reporting/create?
c.reportId=231908kpf
&ds.ds50.connector=googleCloudStorage
&ds.ds50.pathType=FILE
&ds.ds50.path=MyBucket%2FMyData%2FMyFile.csv
Una configurazione di Google Cloud Storage per tutti i file nel percorso:
https://lookerstudio.google.com/reporting/create?
c.reportId=231908kpf
&ds.ds50.connector=googleCloudStorage
&ds.ds50.pathType=FOLDER
&ds.ds50.path=MyBucket%2FMyData
Fogli Google
Nome del parametro | Descrizione |
---|---|
Campo facoltativo. Imposta il valore googleSheets per il connettore Fogli Google.Se impostato, sostituisce l'origine dati con la configurazione di Fogli Google fornita. Consulta la sezione Sostituire e aggiornare. |
|
Obbligatorio** L'ID del foglio di lavoro. | |
Obbligatorio** L'ID del foglio di lavoro. | |
Campo facoltativo. Imposta su true per utilizzare la prima riga per le intestazioni.
Se non specificato, il valore predefinito è true . Le intestazioni di colonna devono essere univoche. Le colonne con intestazioni vuote non verranno aggiunte all'origine dati.
|
|
Campo facoltativo. Imposta su true per includere le celle nascoste.
Se non specificato, il valore predefinito è true . |
|
Campo facoltativo. Imposta su true per includere le celle filtrate.
Se non specificato, il valore predefinito è true . |
|
Campo facoltativo. Intervallo, ad es. A1:B52. | |
Campo facoltativo. Se non specificato, il valore predefinito è true . Per i dettagli, consulta
refreshFields. |
Esempi
Una configurazione di Fogli Google:
https://lookerstudio.google.com/reporting/create?
c.reportId=101112jkl
&ds.ds3.connector=googleSheets
&ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
&ds.ds3.worksheetId=903806437
Una configurazione di Fogli Google con la prima riga utilizzata come intestazioni e celle nascoste e filtrate incluse:
https://lookerstudio.google.com/reporting/create?
c.reportId=101112jkl
&ds.ds3.connector=googleSheets
&ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
&ds.ds3.worksheetId=903806437
&ds.ds3.hasHeader=true
&ds.ds3.includeHiddenCells=true
&ds.ds3.includeFilteredCells=true
Una configurazione di Fogli Google con un intervallo (A1:D20):
https://lookerstudio.google.com/reporting/create?
c.reportId=101112jkl
&ds.ds3.connector=googleSheets
&ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
&ds.ds3.worksheetId=903806437
&ds.ds3.range=A1%3AD20
Looker
Nome del parametro | Descrizione |
---|---|
Campo facoltativo. Impostalo su looker per il
connettore Looker.Se impostato, sostituisce l'origine dati con la configurazione Looker fornita. Consulta la sezione Sostituire e aggiornare. |
|
Obbligatorio** L'URL dell'istanza di Looker. | |
Obbligatorio** Il modello Looker. | |
Obbligatorio** L'esplorazione di Looker. | |
Campo facoltativo. Se non specificato, il valore predefinito è false . Per i dettagli, consulta
refreshFields. |
Esempio
Connettersi a un'esplorazione di Looker:
https://lookerstudio.google.com/reporting/create?
c.reportId=161718pqr
&ds.ds5.connector=looker
&ds.ds5.instanceUrl=my.looker.com
&ds.ds5.model=thelook
&ds.ds5.explore=orders
Search Console
Nome del parametro | Descrizione |
---|---|
Campo facoltativo. Imposta il valore searchConsole per il connettore Search Console.Se impostato, sostituisce l'origine dati con la configurazione di Search Console fornita. Consulta la sezione Sostituire e aggiornare. |
|
Obbligatorio** L'URL del sito. Per una proprietà Dominio, aggiungi il prefisso sc-domain\: . |
|
Obbligatorio** Imposta il tipo di tabella. Può essere
SITE_IMPRESSION o URL_IMPRESSION . |
|
Obbligatorio** Imposta il tipo di ricerca. Può essere
uno dei seguenti valori: WEB , IMAGE , VIDEO o
NEWS . |
|
Campo facoltativo. Se non specificato, il valore predefinito è false . Per i dettagli, consulta
refreshFields. |
Esempio
Una configurazione di Search Console per una proprietà del prefisso URL:
https://lookerstudio.google.com/reporting/create?
c.reportId=161718pqr
&ds.ds5.connector=searchConsole
&ds.ds5.siteUrl=https%3A%2F%2Fwww.example.com%2Fwelcome
&ds.ds5.tableType=SITE_IMPRESSION
&ds.ds5.searchType=WEB
Una configurazione di Search Console per una proprietà Dominio:
https://lookerstudio.google.com/reporting/create?
c.reportId=161718pqr
ds.ds5.connector=searchConsole
&ds.ds5.siteUrl=sc-domain%3Aexample.com
&ds.ds5.tableType=SITE_IMPRESSION
&ds.ds5.searchType=WEB
Autorizzazioni modello
Per garantire la migliore esperienza utente agli utenti, è importante impostare correttamente le autorizzazioni di accesso ai report per il report del modello e le origini dati associate. Le autorizzazioni richieste dipendono dal fatto che il modello di report utilizzi origini dati incorporate o riutilizzabili e che la configurazione dell'API Linking sia impostata per sostituire o aggiornare la configurazione di un'origine dati.
La tabella seguente fornisce l'accesso all'origine dati consigliato per un'esperienza utente ottimale in base alle origini dati del modello e alla configurazione dell'API Linking:
Tipo di origine dati | Configurazione dell'API Linking per l'origine dati | Suggerimento per le autorizzazioni per le origini dati | Note |
---|---|---|---|
Incorporato | Sostituisci | N/D: l'accesso in visualizzazione verrà ereditato dal report. | Se l'utente ha accesso in visualizzazione al report del modello, avrà automaticamente accesso in visualizzazione a qualsiasi origine dati incorporata. |
Incorporato | Aggiorna | N/D: l'accesso in visualizzazione verrà ereditato dal report. | Se l'utente ha accesso in visualizzazione al report del modello, avrà automaticamente accesso in visualizzazione a qualsiasi origine dati incorporata. |
Riutilizzabile | Sostituisci | Gli utenti non hanno bisogno dell'accesso in visualizzazione. | Poiché la configurazione dell'origine dati viene sostituita nella sua interezza tramite l'API Linking, l'accesso in visualizzazione non è necessario. |
Riutilizzabile | Aggiorna | Gli utenti richiedono l'accesso in visualizzazione. | L'accesso in visualizzazione all'origine dati è necessario affinché l'API Linking possa leggere e utilizzare la configurazione dall'origine dati del modello. Se gli utenti non hanno accesso in visualizzazione, riceveranno un errore durante il caricamento del report. |
Utilizza un report vuoto o predefinito
Per utilizzare un report vuoto o il report predefinito, configura l'API Linking come indicato di seguito:
Tipo di rapporto | Imposta il parametro di controllo reportId |
Imposta i parametri dell'origine dati ( ). |
Note |
---|---|---|---|
Report vuoto | No | No | |
Report predefinito | No | Sì | Il report predefinito è fornito da Looker Studio. Non è necessario utilizzare un alias di origine dati quando specifichi i parametri dell'origine dati per il report predefinito, poiché quest'ultimo ha una singola origine dati incorporata. |
I seguenti esempi mostrano vari URL dell'API Linking che utilizzano un report vuoto o predefinito.
Avvia il flusso di lavoro di creazione dei report con un report vuoto:
https://lookerstudio.google.com/reporting/create
Avvia il flusso di lavoro di creazione dei report con un report vuoto e imposta il nome del report:
https://lookerstudio.google.com/reporting/create?r.reportName=MyNewReport
Utilizza il modello di report predefinito con la configurazione di un connettore Fogli Google:
https://lookerstudio.google.com/reporting/create?
ds.connector=googleSheets
&ds.spreadsheetId=1Q-w7KeeJj1jk3wFcFm4NsPlppNscs0CtHf_EP9fsYOo
&ds.worksheetId=0
Incorporare un report
Per incorporare un report creato con l'API Linking, imposta i parametri URL e includi il percorso /embed/
. L'URL di incorporamento dell'API Linking deve essere nel seguente formato:
https://lookerstudio.google.com/embed/reporting/create?parameters
Trovare ID e alias
ID segnalazione
Per trovare l'ID report:
- Apri il report che vuoi utilizzare come modello. Controlla l'URL del
report. La parte compresa tra
reporting/
e/page
rappresenta l'ID report. Ad esempio, nel seguente URL,0B_U5RNpwhcE6SF85TENURnc4UjA
è l'ID report:
https://lookerstudio.google.com/reporting/0B_U5RNpwhcE6SF85TENURnc4UjA/page/1M
![Barra degli indirizzi del browser che mostra l'URL di un report di Looker Studio.
L'ID report è evidenziato.](https://developers.google.cn/static/looker-studio/integrate/images/reportId-parameter.png?authuser=5&hl=it)
Alias origine dati
Un report può avere più origini dati. Il suo alias dovrebbe fare riferimento a un'origine dati.
Per trovare l'alias di un'origine dati:
- Modifica il report.
- Dalla barra degli strumenti, seleziona Risorsa > Gestisci origini dati aggiunte.
- Esamina la colonna Alias per trovare informazioni sull'alias per ogni origine dati.
Puoi modificare i nomi degli alias per garantire la compatibilità con le versioni precedenti quando viene aggiunta o rimossa un'origine dati.
![Un elenco di origini dati nella pagina di gestione delle risorse delle origini dati.
La colonna Alias è evidenziata.](https://developers.google.cn/static/looker-studio/integrate/images/data-source-alias.png?authuser=5&hl=it)
Tipo di connettore
Un report può avere più origini dati, ciascuna creata configurando un connettore. Per trovare il tipo di connettore utilizzato per creare un'origine dati:
- Modifica il report.
- Dalla barra degli strumenti, seleziona Risorsa > Gestisci origini dati aggiunte.
- Esamina la colonna Tipo connettore per identificare il connettore utilizzato per creare un'origine dati.
![Un elenco di origini dati nella pagina di gestione delle risorse delle origini dati.
La colonna Tipo di connettore è evidenziata.](https://developers.google.cn/static/looker-studio/integrate/images/data-source-connector.png?authuser=5&hl=it)
Suggerimenti e risoluzione dei problemi
Se hai difficoltà, esamina i dettagli riportati di seguito per identificare potenziali problemi e configurazioni errate comuni.
Finestra di dialogo di debug
Utilizza la finestra di dialogo di debug per esaminare la configurazione dell'API Linking come interpretata da Looker Studio. Può essere utile per eseguire il debug dei problemi relativi all'API.
- Quando si verifica un errore durante l'analisi dell'URL dell'API Linking, viene visualizzata automaticamente una finestra di dialogo con i dettagli dell'errore.
- Quando si verifica un errore e non viene visualizzata automaticamente alcuna finestra di dialogo, cerca il pulsante delle informazioni in alto a destra del report. Fai clic per
ulteriori informazioni di debug.
- Se non è disponibile alcun pulsante informazioni, puoi abilitare il pulsante aggiungendo il parametro
&c.explain=true
alla fine di qualsiasi URL dell'API Linking.
Autorizzazioni
Assicurati di avere impostato le autorizzazioni del modello corrette per i tipi di origini dati e la configurazione dell'API Linking. Consulta Autorizzazioni per i modelli per i dettagli.
Aggiorna e sostituisci
Se aggiorni la configurazione di un'origine dati da un modello di origine dati, esamina la configurazione dell'origine dati del modello e la configurazione dell'API Linking per assicurarti che siano compatibili. Conferma che i campi generati dalla nuova configurazione siano compatibili con i componenti e la configurazione del report.
Quando esegui un aggiornamento rispetto a una sostituzione, è possibile impostare una configurazione non valida con un comportamento non definito. Per maggiori dettagli, consulta la sezione Sostituire e aggiornare.
Aggiorna campi
Se hai configurato nomi, tipi o aggregazioni dei campi per un'origine dati del modello, queste modifiche verranno trasferite a un'origine dati configurata nell'API Linking solo se il parametro ds.refreshFields
è impostato su false
.
Esamina il parametro dell'origine dati ds.refreshFields
dell'URL dell'API Linking. Se omesso, conferma che il valore predefinito del parametro per ogni tipo di connettore sia corretto per il tuo caso d'uso.
In genere, se hai configurato i campi nell'origine dati del modello e hai la certezza che le nuove configurazioni delle origini dati tramite l'API Linking rendano sempre gli stessi campi, ti consigliamo di impostare refreshFields
su false
.
Ad esempio, se durante la creazione di un modello di report Looker Studio identifica un determinato campo di origine dati come tipo Numero e lo modifichi in Anno, questa modifica alla configurazione del campo ora fa parte dell'origine dati del modello. Qualsiasi grafico nel modello di report che utilizza il campo corretto dovrebbe prevedere un valore Anno e, se il grafico è basato sul tempo, potrebbe non essere visualizzato negli altri casi. Se
l'API Linking viene utilizzata per fornire una nuova configurazione di origine dati che genera
gli stessi campi, esistono due risultati in base al valore del
parametro refreshFields
:
Se è impostato su
true
, la configurazione dei campi dell'origine dati del modello non verrà trasferita e i grafici potrebbero non essere caricati se dipendono dalla stessa configurazione dei campi (ad es. è previsto un campo di tipo Anno).Se è impostata su
false
, la configurazione dei campi dell'origine dati del modello verrà trasferita alla nuova origine dati e i grafici dei report riceveranno gli stessi campi con la stessa configurazione e verranno caricati correttamente.
Feedback e assistenza
Utilizza lo strumento Issue Tracker per segnalare problemi relativi all'API Linking o per fornire un feedback. Consulta la pagina Assistenza per risorse generali su come richiedere assistenza e porre domande.
Log delle modifiche
2023-06-06
- Sono stati aggiunti i parametri dei report
r.measurementId
er.keepMeasurementId
per configurare l'impostazione del report ID misurazione di Google Analytics. - Aggiunto
ds.keepDatasourceName
per controllare il riutilizzo del nome dell'origine dati del modello. - È stata aggiunta una sezione Incorpora report.
- Connettore BigQuery
- Aggiunto:
sqlReplace
. Consente di specificare stringhe di pattern e sostituzione per aggiornare la query SQL dell'origine dati del modello.
- Aggiunto:
2023-05-22
- Aggiunto il supporto per il connettore Looker.
- Aggiunto il supporto per i connettori della community.
2022-11-21
- Aggiunta la possibilità di utilizzare un report vuoto. Consulta Utilizzare un report vuoto o predefinito
- È stata aggiunta una sezione
refreshFields
a Suggerimenti e risoluzione dei problemi.
2022-11-14
- Il riferimento al connettore Surveys è stato rimosso a causa del ritiro di Google Surveys.
2022-06-15
- Fuori dalla fase beta.
- L'API Integration è stata rinominata API Linking.
- L'API Linking non è più in versione beta.
- Aggiunto il parametro di controllo
pageId
per consentire il collegamento a una pagina del report specifica. - È stato aggiunto il parametro di controllo
mode
per impostare lo stato del report in modalità Visualizzazione o Modifica al caricamento. - Le configurazioni delle origini dati ora possono essere sostituite completamente o parzialmente aggiornate. Questo comportamento è determinato dall'impostazione o meno del parametro
ds.connector
. Per maggiori dettagli, consulta la sezione Sostituire e aggiornare. - Se non viene fornito un modello di report con il parametro
c.reportId
, viene ora utilizzato un modello predefinito. - Parametro dell'origine dati
ds.refreshFields
aggiunto. In questo modo, puoi controllare se i campi dell'origine dati vengono aggiornati durante il caricamento della configurazione di un'origine dati. - Connettore BigQuery
projectId
non è necessario quandotype
è impostato suCUSTOM_QUERY
.- Se
billingProjectId
non è impostato, il progetto di fatturazione verrà di riserva aprojectId
o al progetto della tabella sottoposta a query. - Aggiunto il supporto per le tabelle partizionate in base alle date. Imposta il parametro
isPartitioned
sutrue
per utilizzare il campo di partizione come dimensione dell'intervallo di date. - È stato aggiunto il supporto per eseguire query sulle tabelle partizionate in base alle date utilizzando il carattere jolly o il suffisso della tabella
YYYYMMDD
. - È stato aggiunto il supporto per eseguire query sulle tabelle di Google Analytics, Firebase Analytics o Crashlytics e per selezionare un modello di campi.
- Fogli Google
- Il valore predefinito di
hasHeader
ètrue
, in linea con l'impostazione predefinita dell'interfaccia utente web. includeHiddenAndFilteredCell
suddiviso inincludeHiddenCells
eincludeFilteredCells
. Entrambi ora sono impostati in modo predefinito sutrue
, in linea con l'impostazione predefinita della UI web.
- Il valore predefinito di
- Connettore Search Console.
- Parametro
propertyType
rinominato insearchType
.
- Parametro
- Connettore Surveys
surveyId
ora accetta un singolo ID sondaggio o un elenco separato da virgole di ID sondaggio.
2021-12-16
- Versione iniziale dell'API Integration.
- Supporta il collegamento a un report esistente e l'impostazione del nome del report.
- È possibile configurare più origini dati e impostare il nome di ogni origine dati.
- Supporto per i seguenti tipi di connettori: BigQuery, Cloud Spanner, Google Analytics, Google Cloud Storage, Fogli Google, Google Surveys e Search Console.