Introduzione
L'API Linking fornisce un'interfaccia affidabile per configurare un report Looker Studio e indirizzarvi gli utenti direttamente tramite un URL. Seguendo un URL dell'API Linking, è più semplice per gli utenti visualizzare e interagire rapidamente con i propri dati.
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 ai tuoi clienti per visualizzare e interagire con i loro dati. I vantaggi principali dell'API Linking sono i seguenti:
- Un'esperienza di creazione di report con un solo clic per i tuoi clienti.
- La configurazione dei dati viene fornita nell'URL, in modo che gli utenti non debbano configurare il report per i propri dati.
- Gli utenti possono salvare il report con un solo clic e rivisitarlo in qualsiasi momento.
- Crea report su larga scala. L'API Linking riduce il tempo necessario per duplicare o creare nuovi report.
- Attiva le integrazioni dei prodotti. L'interfaccia stabile ti consente di integrare Looker Studio in un flusso di lavoro del prodotto.
Come funziona
Di seguito viene descritto come sviluppatori e utenti interagiscono con l'API Linking.
Flusso di lavoro per sviluppatori dell'API Linking
Lo sviluppatore prepara i report modello, le origini dati e formatta un URL dell'API Linking. Il workflow 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 gli consente di visualizzare e interagire con i dati a cui ha accesso. Una tipica esperienza utente potrebbe essere la seguente:
- In un browser, l'utente visita un servizio integrato con l'API Linking.
- Una call to action 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 può 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 ora ha accesso e controllo completi della propria copia del report. Possono visualizzare, modificare e condividere in qualsiasi momento.
Requisiti
Per garantire che un URL dell'API Linking funzioni come previsto, è necessario quanto segue:
- Un report, da utilizzare come modello. Se non viene fornito, è possibile utilizzare un report vuoto o un report predefinito fornito da Looker Studio.
- Gli utenti di un URL dell'API Linking devono disporre, come minimo, dell'accesso in visualizzazione al report modello. A seconda del tipo di origini dati utilizzate nel report e della configurazione fornita tramite l'API Linking, gli utenti potrebbero richiedere anche l'accesso in visualizzazione alle origini dati. Per maggiori dettagli, consulta Autorizzazioni dei modelli.
- Il Tipo di connettore di ogni origine dati deve supportare la configurazione tramite l'API Linking. Consulta il riferimento ai 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 del report dipendenti mostreranno un errore.
Parametri URL
Un URL dell'API Linking deve avere il seguente formato:
https://lookerstudio.google.com/reporting/create?parameters
L'URL deve essere utilizzato nel contesto di un browser web, in genere da un utente che fa clic su un link o viene reindirizzato all'URL. Può essere utilizzato 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 parametro | Descrizione |
|---|---|
| Facoltativo. L'ID report del modello. Looker Studio si aprirà e configurerà il report specificato. Per informazioni dettagliate su come trovare l'ID, vedi ID della segnalazione. Se non viene specificato, viene utilizzato un report vuoto o un modello di report predefinito. Per maggiori dettagli, vedi Utilizzare un report vuoto o predefinito. | |
| Facoltativo. L'ID della pagina iniziale da caricare nel report. Se non specificato, il valore predefinito è la prima pagina del report. | |
Facoltativo. La modalità di report iniziale. Uno dei valori
view o
edit. Se non specificato, il valore predefinito è view.
|
|
Facoltativo. La visibilità della finestra di dialogo Informazioni/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 ignorano le proprietà del report.
| Nome parametro | Descrizione |
|---|---|
| Facoltativo. Imposta il nome del report. Se non specificato, il valore predefinito è il nome del report del modello. | |
|
Facoltativo. Imposta gli ID misurazione di Google Analytics su Misura l'utilizzo dei report. Utilizza una virgola per separare più ID. Se |
|
|
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 dell'origine dati consentono di definire una configurazione dell'origine dati e i dati a cui accedere per le origini dati nel report 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 modello.
Per informazioni dettagliate su come trovare un'origine dati alias, vedi Alias dell'origine dati.
Parametri delle origini dati
I seguenti parametri sono comuni a tutti i tipi di connettori:
| Nome | Descrizione |
|---|---|
|
Facoltativo. Imposta il nome dell'origine dati. Se |
|
|
Facoltativo. Imposta Se |
|
|
Facoltativo.
Il tipo di connettore dell'origine dati. Per ulteriori informazioni sui tipi di connettori supportati, consulta il riferimento ai connettori. Se impostati, 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 interamente. Se non specificato, è possibile specificare zero 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 i parametri non forniti nell'URL dell'API Linking. Per informazioni dettagliate su come identificare il tipo di connettore dell'origine dati del modello, vedi Tipo di connettore. Per scoprire di più su come il parametro |
|
|
Facoltativo.
Imposta Imposta Se non specificati, i valori predefiniti variano in base al tipo di connettore. Consulta il riferimento al connettore per i valori predefiniti specifici del connettore nel caso in cui tu voglia ignorare il comportamento predefinito. Considerazioni sull'utilizzo di
refreshFields:
|
|
| Required. La configurazione dell'origine dati per il tipo di connettore. Per informazioni dettagliate su come identificare il connettore utilizzato per creare un'origine dati, vedi Tipo di connettore. Per informazioni dettagliate sui parametri dell'origine dati disponibili per ogni tipo di connettore, consulta il riferimento al connettore. |
Sostituzione e aggiornamento: configurazioni delle origini 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 la configurazione dell'origine dati del modello,
rispettivamente.
La seguente tabella mostra in dettaglio in che modo il parametro ds.connector influisce sulla sostituzione completa di una configurazione dell'origine dati del modello o sul suo utilizzo 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 interamente utilizzando i parametri dell'origine dati specificati nell'URL dell'API Linking. Devi specificare tutti i parametri richiesti per il tipo di connettore. Consulta Parametri obbligatori quando
ds.connector è impostato.
|
|
| No | Aggiornamento. La configurazione dell'origine dati del modello verrà utilizzata per
specificare i parametri non forniti nell'URL dell'API Linking. Tutti i parametri
del connettore per il tipo di connettore sono facoltativi, se non diversamente indicato.
In questo modo, l'URL dell'API Linking viene semplificato ed è generalmente consigliato quando hai familiarità con la configurazione dell'origine dati del modello e vuoi solo ignorare un sottoinsieme di parametri. |
|
Parametri obbligatori quando ds.connector è impostato
Se viene specificato il parametro ds.connector di un'origine dati, tutti i parametri del connettore designati come obbligatori devono essere specificati 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
l'intera 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 dell'origine dati può essere omesso quando il report ha una sola origine dati. L'URL precedente può essere semplificato nel seguente modo:
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 interamente, mentre la configurazione di Google Analytics aggiorna un singolo parametro e si basa sull'origine dati modello ds1 per tutti i 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
Creare e aggiungere
A volte può essere utile avere la stessa origine dati in più report in modo che gli aggiornamenti all'origine dati influiscano su tutti i report contemporaneamente. Quando crei un report con l'API Linking, puoi aggiungere di nuovo un'origine dati dal report modello assicurandoti che siano soddisfatte tutte le seguenti condizioni:
- L'origine dati è riutilizzabile (vedi Origini dati incorporate e riutilizzabili)
- L'URL non fa riferimento all'origine dati per alias
- L'URL non utilizza un alias con caratteri jolly (vedi Carattere jolly alias origine dati)
Quando viene creata una nuova origine dati con l'API Linking, vengono utilizzate 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 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 collegate e vuoi sostituire projectId e datasetId in ciascuna, ma conservare tableId, puoi scriverlo come segue:
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 su quelli che lo utilizzano. Nell'esempio precedente, puoi aggiungere un alias dell'origine dati specifico per sostituire il valore del carattere jolly.
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&ds.*.projectId=client-project
&ds.*.datasetId=client-dataset
&ds.ds1.datasetId=client-dataset
In termini più generali, l'ordine di precedenza dei parametri è:
- Un parametro fornito 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 (vedi Sostituzione e aggiornamento)
- Il valore predefinito del parametro, se è facoltativo.
Riferimento connettore
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
fornisci l'ID tabella della tabella su cui eseguire la query, e una query CUSTOM_QUERY, in cui
fornisci un'istruzione SQL per eseguire una query su una tabella.
Query TABLE
I seguenti parametri sono applicabili quando type è impostato su TABLE e fornisci l'ID della tabella da interrogare.
| Nome parametro | Descrizione |
|---|---|
Facoltativo. Imposta bigQuery per il
connettore
BigQuery.Se impostata, sostituisce l'origine dati con la configurazione BigQuery fornita. Consulta Sostituzione e aggiornamento. |
|
Obbligatorio** Il tipo di query. Imposta su
TABLE. |
|
| Obbligatorio** L'ID progetto della tabella da interrogare. | |
| Obbligatorio** L'ID set di dati della tabella da interrogare. | |
| Obbligatorio** L'ID tabella della tabella da
interrogare. Tabelle suddivise per data: il suffisso * (carattere jolly) o YYYYMMDD è supportato
quando si interrogano tabelle suddivise per data.Se una tabella viene 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 correlati alla tabella modello di campi. |
|
Facoltativo. L'ID del progetto da utilizzare per la fatturazione. Se non è impostato,
verrà utilizzato projectId. |
|
Facoltativo. Imposta su true se la tabella è partizionata e vuoi utilizzare la colonna di partizionamento come dimensione dell'intervallo di date. Questo
è applicabile solo al partizionamento basato sul tempo (ad es. utilizzando una colonna di partizionamento basata sul tempo o la pseudocolonna _PARTITIONTIME) e
non funziona per le tabelle partizionate in base a un intervallo di numeri interi. Se non specificato, il valore predefinito è
false. Per saperne di più, consulta la pagina
Introduzione alle tabelle partizionate. |
|
Facoltativo. Se non specificato, il valore predefinito è true. Per informazioni dettagliate, vedi
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 |
|---|---|
Facoltativo. Il modello di campi di Google Analytics da utilizzare. Applicabile solo
quando viene eseguita una query su una tabella di BigQuery Export per Google Analytics. Uno
dei valori ALL, SESSION, HITS. Per le tabelle di Google
Analytics, il valore predefinito è ALL se non specificato. |
|
Facoltativo. Il modello dei campi di Firebase Analytics da utilizzare. Applicabile
solo quando viene eseguita una query su una tabella di esportazione BigQuery per Firebase Analytics.
Può essere impostato solo su EVENTS. Per le tabelle Firebase Analytics,
se non specificato, il valore predefinito è EVENTS. |
|
Il modello di campi Firebase Crashlytics da utilizzare. Può essere impostato solo su
DEFAULT. Applicabile solo quando viene eseguita una query su una tabella di esportazione in BigQuery per Firebase
Crashlytics. Per le tabelle Firebase Crashlytics,
il valore predefinito è DEFAULT se non specificato. |
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 parametro | Descrizione |
|---|---|
Facoltativo. Imposta bigQuery per il
connettore
BigQuery.Se impostata, sostituisce l'origine dati con la configurazione BigQuery fornita. Consulta Sostituzione e aggiornamento. |
|
Obbligatorio** Il tipo di query. Imposta su
CUSTOM_QUERY. |
|
| Obbligatorio** La query SQL da eseguire. | |
Facoltativo. L'ID del progetto da utilizzare per la fatturazione. Se non è impostato,
verrà utilizzato projectId. Se projectId non è impostato,
viene utilizzato il progetto della tabella sottoposta a query. |
|
|
Facoltativo. Un elenco separato da virgole di stringhe di pattern e sostituzione da applicare alla query SQL. La sostituzione della stringa viene applicata solo se
corrisponde a un pattern. Utilizza una virgola per separare le coppie di stringhe di pattern e sostituzione. Ad esempio, |
|
Facoltativo. Se non specificato, il valore predefinito è true. Per informazioni dettagliate, vedi
refreshFields. |
Esempi
Una configurazione di tipo TABLE in cui la query è 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 partizionata per data utilizzando il suffisso con carattere 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 partizionata per 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 è 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 parametro | Descrizione |
|---|---|
Facoltativo. Imposta cloudSpanner per il
connettore
Cloud Spanner.Se impostato, sostituisce l'origine dati con la configurazione Cloud Spanner fornita. Consulta Sostituzione e aggiornamento. |
|
| Obbligatorio** L'ID progetto. | |
| Obbligatorio** L'ID istanza. | |
| Obbligatorio** L'ID database. | |
| Obbligatorio** La query SQL da eseguire. | |
Facoltativo. Se non specificato, il valore predefinito è true.
Per informazioni dettagliate, vedi refreshFields. |
Esempio
Una configurazione di 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 parametro | Descrizione |
|---|---|
Facoltativo. Imposta su community per un
connettore della community.Se impostato, sostituisce l'origine dati con la configurazione del connettore della community fornita. Consulta Sostituzione e aggiornamento. |
|
Obbligatorio** Il connettore della community
connectorId (noto anche come deploymentId).
| |
| Facoltativo. Parametri aggiuntivi specifici del connettore, come definiti dalla configurazione del connettore del connettore della community. | |
Facoltativo. Se non specificato, il valore predefinito è true. Per informazioni dettagliate, vedi
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 parametro | Descrizione |
|---|---|
Facoltativo. Imposta googleAnalytics per il
connettore
Google Analytics.Se impostata, sostituisce l'origine dati con la configurazione di Google Analytics fornita. Consulta Sostituzione e aggiornamento. |
|
| Obbligatorio** L'ID account. | |
| Obbligatorio** L'ID proprietà. | |
| L'ID vista. Obbligatorio** per le proprietà Universal Analytics. Non impostare per le proprietà Google Analytics 4. |
|
Facoltativo. Se non specificato, il valore predefinito è false. Per informazioni dettagliate, vedi
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 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 parametro | Descrizione |
|---|---|
Facoltativo. Imposta su googleCloudStorage
Google
Cloud Storage connector.Se impostata, sostituisce l'origine dati con la configurazione di Google Cloud Storage fornita. Consulta Sostituzione e aggiornamento. |
|
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. |
|
Facoltativo. Se non specificato, il valore predefinito è true.
Per informazioni dettagliate, vedi refreshFields. |
Esempio
Una 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 parametro | Descrizione |
|---|---|
Facoltativo. Imposta googleSheets per il
connettore
Fogli Google.Se impostato, sostituisce l'origine dati con la configurazione di Fogli Google fornita. Consulta Sostituzione e aggiornamento. |
|
| Obbligatorio** L'ID del foglio di lavoro. | |
| Obbligatorio** L'ID del foglio di lavoro. | |
Facoltativo. Imposta su true per utilizzare la prima riga come intestazioni.
Se non specificato, il valore predefinito è true. Le intestazioni delle colonne devono essere
univoche. Le colonne con intestazioni vuote non verranno aggiunte all'origine dati.
|
|
Facoltativo. Imposta su true per includere le celle nascoste.
Se non specificato, il valore predefinito è true. |
|
Facoltativo. Imposta su true per includere le celle filtrate.
Se non specificato, il valore predefinito è true. |
|
| Facoltativo. Intervallo, ad esempio A1:B52. | |
Facoltativo. Se non specificato, il valore predefinito è true. Per informazioni dettagliate, vedi
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 le 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 parametro | Descrizione |
|---|---|
Facoltativo. Imposta looker per il
connettore Looker.Se impostato, sostituisce l'origine dati con la configurazione di Looker fornita. Consulta Sostituzione e aggiornamento. |
|
| Obbligatorio** L'URL dell'istanza di Looker. | |
| Obbligatorio** Il modello di Looker. | |
| Obbligatorio** L'esplorazione di Looker. | |
Facoltativo. Se non specificato, il valore predefinito è false. Per informazioni dettagliate, vedi
refreshFields. |
Esempio
Connettiti 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 parametro | Descrizione |
|---|---|
Facoltativo. Imposta searchConsole per il
connettore
Search Console.Se impostato, sostituisce l'origine dati con la configurazione di Search Console fornita. Consulta Sostituzione e aggiornamento. |
|
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 valori WEB, IMAGE, VIDEO o
NEWS. |
|
Facoltativo. Se non specificato, il valore predefinito è false. Per informazioni dettagliate, vedi
refreshFields. |
Esempio
Una configurazione di Search Console per una proprietà con 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 del modello
Per garantire la migliore esperienza utente, è importante impostare correttamente le autorizzazioni di accesso ai report per il report modello e le origini dati associate. Le autorizzazioni richieste dipendono dal fatto che il modello di report utilizzi origini dati incorporate o riutilizzabili e se la configurazione dell'API Linking sia impostata per sostituire o aggiornare una configurazione dell'origine dati.
La seguente tabella fornisce l'accesso consigliato alle origini dati 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 dell'origine dati | Note |
|---|---|---|---|
| Strato | Sostituisci | N/A - L'accesso in visualizzazione verrà ereditato dal report. | Se un utente ha accesso in visualizzazione al report modello, avrà automaticamente accesso in visualizzazione a qualsiasi origine dati incorporata. |
| Strato | Aggiorna | N/A - L'accesso in visualizzazione verrà ereditato dal report. | Se un utente ha accesso in visualizzazione al report modello, avrà automaticamente accesso in visualizzazione a qualsiasi origine dati incorporata. |
| Riutilizzabili | Sostituisci | Gli utenti non hanno bisogno dell'accesso in visualizzazione. | Poiché la configurazione dell'origine dati viene sostituita interamente tramite l'API Linking, l'accesso in visualizzazione non è necessario. |
| Riutilizzabili | Aggiorna | Gli utenti richiedono l'accesso in visualizzazione. | Per consentire all'API Linking di leggere e utilizzare la configurazione dell'origine dati del modello, è necessario l'accesso in visualizzazione all'origine dati. Se gli utenti non dispongono dell'accesso in visualizzazione, riceveranno un errore durante il caricamento del report. |
Utilizzare un report vuoto o predefinito
Per utilizzare un report vuoto o quello predefinito, configura l'API Linking come segue:
| 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 dell'origine dati quando si specificano i parametri dell'origine dati per il report predefinito, poiché il report predefinito ha una singola origine dati incorporata. |
Gli esempi seguenti mostrano vari URL dell'API Linking che utilizzano un report vuoto o predefinito.
Avvia il flusso di lavoro di creazione del report con un report vuoto:
https://lookerstudio.google.com/reporting/create
Avvia il flusso di lavoro di creazione del 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 una configurazione del 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/. Un URL di incorporamento dell'API Linking
deve avere il seguente formato:
https://lookerstudio.google.com/embed/reporting/create?parameters
Trovare ID e alias
ID report
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è l'ID report. Ad esempio, nel seguente URL,0B_U5RNpwhcE6SF85TENURnc4UjAè l'ID del report:
https://lookerstudio.google.com/reporting/0B_U5RNpwhcE6SF85TENURnc4UjA/page/1M
Alias origine dati
Un report può avere più origini dati. A un'origine dati deve essere fatto riferimento tramite il suo alias.
Per trovare un alias origine dati:
- Modifica il report.
- Nella barra degli strumenti, seleziona Risorsa > Gestisci origini dati aggiunte.
- Esamina la colonna Alias per trovare le informazioni sugli alias per ogni origine dati.
Puoi modificare i nomi degli alias per garantire la compatibilità con le versioni precedenti quando un'origine dati viene aggiunta o rimossa.
Tipo di connettore
Un report può avere più origini dati, ognuna creata configurando un connettore. Per trovare il tipo di connettore utilizzato per creare un'origine dati:
- Modifica il report.
- Nella barra degli strumenti, seleziona Risorsa > Gestisci origini dati aggiunte.
- Esamina la colonna Tipo di connettore per identificare il connettore utilizzato per creare un'origine dati.
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ò aiutarti a 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 Informazioni in alto a destra del report. Fai clic per
ulteriori informazioni di debug.
- Se non è disponibile alcun pulsante Informazioni, puoi abilitarlo
aggiungendo il parametro
&c.explain=truealla fine di qualsiasi URL dell'API Linking.
Autorizzazioni
Assicurati di aver impostato le autorizzazioni corrette per i tipi di origini dati e la configurazione dell'API Linking. Per maggiori dettagli, consulta Autorizzazioni dei modelli.
Aggiornamento e sostituzione
Se aggiorni una configurazione dell'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. Verifica che i campi generati dalla nuova configurazione siano compatibili con i componenti e la configurazione del report.
Quando esegui un aggiornamento anziché una sostituzione, è possibile impostare una configurazione non valida con un comportamento indefinito. Per maggiori dettagli, vedi Sostituzione e aggiornamento.
Aggiorna campi
Se hai configurato nomi, tipi o aggregazioni di campi per un'origine dati modello, queste modifiche verranno riportate in un'origine dati configurata con l'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, verifica 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 dell'origine dati tramite l'API Linking produrranno 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 particolare campo dell'origine dati come tipo Numero e lo modifichi in
tipo Anno, questa modifica della configurazione del campo ora fa parte dell'origine dati del modello. Qualsiasi grafico nel modello di report che utilizza il campo corretto
si aspetterà un anno e, se il grafico è basato sul tempo, potrebbe non essere visualizzato altrimenti. Se
l'API Linking viene utilizzata per fornire una nuova configurazione dell'origine dati che produce
gli stessi campi, ci sono 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 Issue Tracker per segnalare problemi relativi all'API Linking o per fornire feedback. Consulta la sezione Assistenza per risorse generali su come ricevere aiuto e porre domande.
Log delle modifiche
2023-06-06
- Sono stati aggiunti i parametri dei report
r.measurementIder.keepMeasurementIdper configurare l'impostazione del report ID misurazione Google Analytics. - È stato aggiunto
ds.keepDatasourceNameper controllare il riutilizzo del nome dell'origine dati del modello. - È stata aggiunta una sezione Incorpora report.
- Connettore BigQuery
- Aggiunta di
sqlReplace. Consente di specificare stringhe di pattern e sostituzione per aggiornare la query SQL dell'origine dati del modello.
- Aggiunta di
2023-05-22
- È stato aggiunto il supporto per il connettore Looker.
- È stato aggiunto il supporto per i connettori della community.
2022-11-21
- È stata aggiunta la possibilità di utilizzare un report vuoto. Vedi Utilizzare un report vuoto o predefinito
- È stata aggiunta una sezione
refreshFieldsa Suggerimenti e risoluzione dei problemi.
2022-11-14
- Il riferimento al connettore per Surveys è stato rimosso a causa del ritiro di Google Surveys.
2022-06-15
- Fuori dalla versione beta
- L'API Integration è stata rinominata API Linking.
- L'API Linking non è più in versione beta.
- È stato aggiunto il parametro di controllo
pageIdper consentire il collegamento a una pagina specifica del report. - È stato aggiunto il parametro di controllo
modeper impostare lo stato del report sulla modalità Visualizzazione o Modifica al caricamento. - Ora le configurazioni delle origini dati possono essere sostituite interamente o aggiornate parzialmente. Questo comportamento è determinato dall'impostazione del parametro
ds.connector. Per maggiori dettagli, consulta Sostituzione e aggiornamento. - Ora viene utilizzato un modello predefinito se non viene fornito un modello di report utilizzando il
parametro
c.reportId. - È stato aggiunto il parametro dell'origine dati
ds.refreshFields. In questo modo puoi controllare se i campi dell'origine dati vengono aggiornati durante il caricamento di una configurazione dell'origine dati. - Connettore BigQuery
projectIdnon è obbligatorio quandotypeè impostato suCUSTOM_QUERY.- Se
billingProjectIdnon è impostato, il progetto di fatturazione tornerà aprojectIdo al progetto della tabella sottoposta a query. - È stato aggiunto il supporto per le tabelle partizionate in base alle date. Imposta il parametro
isPartitionedsutrueper utilizzare il campo di partizione come dimensione dell'intervallo di date. - È stato aggiunto il supporto per l'esecuzione di query sulle tabelle partizionate per data utilizzando il carattere jolly o il suffisso della tabella
YYYYMMDD. - È stato aggiunto il supporto per l'interrogazione delle tabelle Google Analytics, Firebase Analytics o Crashlytics e per la selezione di un modello di campi.
- Fogli Google
- Il valore predefinito di
hasHeaderètrue, coerente con il valore predefinito della UI web. includeHiddenAndFilteredCellsuddiviso inincludeHiddenCellseincludeFilteredCells. Ora entrambi hanno come valore predefinitotrue, in linea con il valore predefinito dell'interfaccia utente web.
- Il valore predefinito di
- Connettore Search Console
- Il parametro
propertyTypeè stato rinominato insearchType.
- Il parametro
- Connettore Sondaggi
surveyIdora accetta un singolo ID sondaggio o un elenco di ID sondaggio separati da virgole.
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 ciascuna.
- Supporto per i seguenti tipi di connettori: BigQuery, Cloud Spanner, Google Analytics, Google Cloud Storage, Fogli Google, Google Surveys, Search Console.