Pengantar
Linking API menyediakan antarmuka yang andal untuk mengonfigurasi dan meneruskan pengguna langsung ke laporan Looker Studio melalui URL. Saat mengikuti URL Linking API, pengguna akan mendapati pengalaman yang disederhanakan untuk melihat dan berinteraksi dengan data mereka secara cepat.
Dokumen ini menjelaskan format yang diperlukan untuk URL Linking API dan parameter yang tersedia.
Kasus penggunaan dan manfaat
Linking API dapat digunakan untuk memberikan laporan yang telah dikonfigurasi sebelumnya bagi pelanggan agar dapat melihat dan berinteraksi dengan data mereka. Manfaat utama Linking API adalah sebagai berikut:
- Pengalaman pembuatan laporan sekali klik untuk pelanggan Anda.
- Konfigurasi data disediakan di URL sehingga pengguna tidak perlu mengonfigurasi laporan untuk data mereka.
- Pengguna dapat menyimpan laporan dengan sekali klik dan mengunjungi kembali laporan tersebut kapan saja.
- Membuat laporan dalam skala besar. Linking API mengurangi waktu yang diperlukan untuk membuat duplikat atau membuat laporan baru.
- Aktifkan integrasi produk. Antarmuka stabil memungkinkan Anda mengintegrasikan Looker Studio ke dalam alur kerja produk.
Cara kerjanya
Berikut penjelasan cara developer dan pengguna berinteraksi dengan Linking API.
Menautkan alur kerja developer API
Developer menyiapkan laporan template, sumber data, dan memformat URL Linking API. Alur kerja umum untuk developer adalah sebagai berikut:
- Tentukan apakah akan menggunakan laporan kosong, template laporan default yang disediakan oleh Looker Studio, atau membuat laporan Looker Studio yang akan berfungsi sebagai template. Hal ini termasuk mengonfigurasi sumber data template.
- Format URL Linking API untuk kasus penggunaan tertentu Anda. Jika ada, tentukan template laporan dan parameter lainnya, termasuk nama laporan, nama sumber data, dan konfigurasi sumber data.
- Gunakan URL Linking API untuk mengarahkan pengguna ke laporan.
Menautkan pengalaman pengguna API
Pengguna mengikuti URL Linking API, yang jika dikonfigurasi dengan benar oleh developer, akan mengarahkan mereka ke laporan Looker Studio yang memungkinkan mereka melihat dan berinteraksi dengan data yang dapat diakses. Pengalaman pengguna biasanya adalah sebagai berikut:
- Di browser, pengguna membuka layanan yang telah terintegrasi dengan Linking API.
- Pesan ajakan (CTA) mengundang pengguna untuk mengklik link guna melihat data mereka di Looker Studio.
- Pengguna mengikuti link dan diarahkan ke laporan Looker Studio. Laporan dimuat dan pengguna dapat melihat dan berinteraksi dengan datanya.
- Pengguna mengklik “Edit dan bagikan”. Laporan disimpan ke akun Looker Studio mereka.
- Pengguna kini memiliki akses dan kontrol penuh atas salinan laporan yang mereka miliki. Mereka dapat melihat, mengedit, dan membagikannya kapan saja.
Persyaratan
Untuk memastikan URL Linking API berfungsi seperti yang diharapkan, hal berikut diperlukan:
- Laporan, untuk digunakan sebagai template. Jika tidak disediakan, laporan kosong atau laporan default, yang disediakan oleh Looker Studio, dapat digunakan.
- Pengguna URL Linking API harus memiliki, setidaknya, akses lihat ke laporan template. Bergantung pada jenis sumber data yang digunakan dalam laporan dan konfigurasi yang diberikan melalui Linking API, pengguna mungkin juga memerlukan akses lihat ke sumber data. Lihat Izin template untuk mengetahui detailnya.
- Jenis konektor setiap sumber data harus mendukung konfigurasi melalui Linking API. Lihat Referensi konektor untuk mengetahui daftar konektor yang didukung.
- Pengguna URL Linking API harus memiliki akses ke data yang dikonfigurasi di URL Linking API. Jika pengguna tidak memiliki akses ke data pokok, komponen laporan dependen apa pun akan menampilkan error.
Parameter URL
URL Linking API harus dalam format berikut:
https://lookerstudio.google.com/reporting/create?parameters
URL diharapkan akan digunakan dalam konteks browser web, biasanya oleh pengguna yang mengklik link atau dialihkan ke URL. Alat ini juga dapat digunakan untuk Menyematkan laporan.
Contoh URL
Berikut adalah contoh URL Linking API. Nama laporan ditetapkan dan satu sumber data BigQuery dikonfigurasi:
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
Beberapa parameter URL diperlukan, sedangkan beberapa lainnya bersifat opsional. Berikut adalah daftar parameter yang digunakan untuk menentukan URL Linking API:
Parameter kontrol
Parameter kontrol menentukan status laporan saat dilihat melalui URL Linking API.
Nama parameter | Deskripsi |
---|---|
Opsional. ID Laporan template. Looker Studio akan membuka dan mengonfigurasi laporan yang ditentukan. Untuk detail tentang cara menemukan ID, lihat ID Laporan. Jika tidak ditentukan, laporan kosong atau template laporan default akan digunakan. Lihat Menggunakan laporan kosong atau default untuk mengetahui detailnya. | |
Opsional. ID halaman awal yang akan dimuat dalam laporan. Setelan defaultnya adalah halaman pertama laporan jika tidak ditentukan. | |
Opsional. Mode laporan awal. Salah satu dari
view atau
edit . Jika tidak ditentukan, setelan defaultnya adalah view .
|
|
Opsional. Visibilitas dialog info/debug. Tetapkan ke
true untuk menampilkan tombol dialog. Nilai defaultnya adalah false jika tidak ditentukan. Lihat
Memecahkan masalah konfigurasi untuk mempelajari lebih lanjut.
|
Contoh
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
Parameter laporan
Parameter laporan menggantikan properti laporan.
Nama parameter | Deskripsi |
---|---|
Opsional. Menetapkan nama laporan. Jika tidak ditentukan, nama laporan template akan ditetapkan secara default. | |
Opsional. Menetapkan ID Pengukuran Google Analytics untuk Mengukur penggunaan laporan. Gunakan koma untuk memisahkan beberapa ID. Jika |
|
Opsional. Tetapkan ke Jika |
Contoh
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
Parameter sumber data
Parameter sumber data memungkinkan Anda menentukan konfigurasi sumber data dan data yang akan diakses untuk sumber data dalam laporan template.
alias
digunakan untuk mereferensikan sumber data dalam laporan yang sudah ada. Menggunakan alias memungkinkan kompatibilitas mundur jika sumber data ditambahkan/dihapus dari laporan template.
Untuk mengetahui detail tentang cara menemukan sumber data alias
, lihat Alias sumber data.
Parameter sumber data
Parameter berikut umum di semua jenis konektor:
Nama | Deskripsi |
---|---|
Opsional. Menetapkan nama sumber data. Jika |
|
Opsional. Tetapkan ke Jika |
|
Opsional.
Jenis konektor sumber data. Untuk mengetahui informasi selengkapnya tentang jenis konektor yang didukung, lihat Referensi konektor. Jika ditetapkan, semua parameter konektor yang diperlukan untuk jenis konektor tersebut harus ditentukan di URL Linking API dan konfigurasi sumber data template akan diganti secara keseluruhan. Jika tidak ditentukan, nol atau beberapa parameter konektor untuk jenis konektor dapat ditentukan di URL Linking API. Konfigurasi sumber data template akan digunakan untuk menentukan parameter yang tidak diberikan di URL Linking API. Untuk mengetahui detail cara mengidentifikasi jenis konektor sumber data template, lihat Jenis konektor. Untuk mempelajari lebih lanjut cara parameter |
|
Opsional.
Tetapkan ke Tetapkan ke Jika tidak ditentukan, setelan defaultnya akan bervariasi menurut jenis konektor. Tinjau Referensi konektor untuk default khusus konektor jika Anda ingin mengganti perilaku default. Pertimbangan saat menggunakan
refreshFields :
|
|
Wajib. Konfigurasi sumber data untuk jenis konektor. Untuk detail cara mengidentifikasi konektor yang digunakan untuk membuat sumber data, lihat Jenis konektor. Untuk mengetahui detail tentang parameter sumber data yang tersedia untuk setiap jenis konektor, lihat Referensi konektor. |
Ganti vs pembaruan - Konfigurasi sumber data
Saat menetapkan parameter sumber data, keberadaan atau penghapusan
parameter ds.connector
di URL Linking API menunjukkan
niat untuk mengganti atau memperbarui konfigurasi sumber data
template.
Tabel berikut menjelaskan cara parameter ds.connector
memengaruhi apakah
konfigurasi sumber data template diganti secara keseluruhan atau digunakan untuk memperbarui
parameter yang tidak ditentukan:
Apakah ds.connector sudah ditetapkan? |
Konfigurasi dan perilaku yang diharapkan | Penggunaan umum |
---|---|---|
Ya |
Ganti. Konfigurasi sumber data template diganti secara
keseluruhan, menggunakan parameter sumber data yang ditentukan dalam URL Linking
API. Anda harus menentukan semua parameter yang diperlukan untuk jenis konektor. Lihat Parameter yang diperlukan saat
ds.connector ditetapkan.
|
|
Tidak | Perbarui. Konfigurasi sumber data template akan digunakan untuk
menentukan parameter yang tidak diberikan di URL Linking API. Semua parameter konektor untuk jenis konektor bersifat opsional, kecuali jika dinyatakan lain.
Hal ini menyederhanakan URL Linking API dan secara umum direkomendasikan jika Anda memahami konfigurasi sumber data template dan hanya ingin mengganti subset parameter. |
|
Parameter yang diperlukan saat ds.connector
ditetapkan
Jika parameter ds.connector
sumber data ditentukan, semua parameter konektor yang ditetapkan sebagai Wajib harus ditentukan untuk sumber data tersebut. Jika parameter ds.connector
sumber data tidak ditentukan, semua parameter konektor, bahkan yang ditetapkan sebagai wajib, dapat diperlakukan sebagai opsional, kecuali jika dinyatakan lain.
Contoh
Mengonfigurasi laporan dengan satu sumber data BigQuery (ds0
) dan mengganti konfigurasi sumber data secara keseluruhan:
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
Alias sumber data dapat dihilangkan jika laporan memiliki satu sumber data. URL di atas dapat disederhanakan menjadi berikut:
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
Mengonfigurasi laporan dengan satu sumber data BigQuery (ds0
) dan memperbarui ID project penagihan saja dari sumber data tersebut:
https://lookerstudio.google.com/reporting/create?
c.reportId=12345
&r.reportName=MyNewReport
&ds.ds0.billingProjectId=my-billing-project
Mengonfigurasi laporan dengan dua sumber data, sumber data BigQuery (ds0
) dan sumber data Google Analytics (ds1
). Konfigurasi sumber data BigQuery diganti secara keseluruhan, sedangkan konfigurasi Google Analytics memperbarui satu parameter dan mengandalkan sumber data template ds1
untuk setiap parameter konektor yang belum ditentukan:
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
Membuat vs Menambahkan
Terkadang ada baiknya memiliki sumber data yang sama di beberapa laporan, jadi pembaruan pada sumber data akan memengaruhi semua laporan secara bersamaan. Saat membuat laporan dengan Linking API, Anda dapat menambahkan kembali sumber data dari laporan template dengan memastikan semua kondisi berikut terpenuhi:
- Sumber data dapat digunakan kembali (lihat sumber data sematan vs. sumber data yang dapat digunakan kembali)
- URL tidak merujuk ke sumber data dengan alias
- URL tidak menggunakan alias karakter pengganti (lihat Karakter pengganti alias sumber data)
Saat sumber data baru dibuat dengan Linking API, sumber data baru akan menggunakan kredensial pengguna yang mengklik URL. Itu berarti pengguna harus memiliki akses ke data yang mendasarinya atau koneksi tidak akan berfungsi. Dengan menambahkan kembali sumber data ke laporan yang baru dibuat, Anda dapat mempertahankan kredensialnya sehingga pengguna dapat terus mengakses data dalam laporan baru mereka.
Karakter pengganti alias sumber data
Untuk menerapkan parameter Linking API ke beberapa sumber data, alias karakter pengganti ds.*
dapat digunakan sebagai pengganti alias sumber data.
Hal ini dapat berguna untuk menghapus parameter berulang dari URL Anda. Misalnya, jika Anda memiliki template dengan tiga sumber data BigQuery terlampir, dan Anda ingin mengganti projectId
dan datasetId
di setiap sumber data, tetapi mempertahankan tableId
, Anda dapat menulisnya sebagai:
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
Atau, dengan karakter pengganti ds.*
, Anda dapat menggunakan URL yang setara ini:
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&ds.*.projectId=client-project
&ds.*.datasetId=client-dataset
Parameter yang diberikan ke Linking API yang tidak menggunakan karakter pengganti ds.*
lebih diprioritaskan daripada parameter yang digunakan. Pada contoh di atas, Anda dapat menambahkan alias sumber data tertentu untuk mengganti nilai dari karakter pengganti.
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&ds.*.projectId=client-project
&ds.*.datasetId=client-dataset
&ds.ds1.datasetId=client-dataset
Secara lebih umum, urutan prioritas parameter adalah:
- Parameter yang diberikan dengan alias tertentu (
ds.ds1.datasetId
) - Parameter yang diberikan menggunakan karakter pengganti (
ds.*.datasetId
) - Nilai yang berasal dari sumber data template, jika ds.connector tidak diberikan (lihat Mengganti vs memperbarui)
- Nilai default untuk parameter, jika bersifat opsional.
Referensi konektor
Linking API mendukung konektor dan konfigurasi berikut. Untuk setiap konektor, daftar parameter sumber data yang tersedia diberikan.
BigQuery
Konektor BigQuery mendukung dua jenis kueri, yaitu kueri TABLE
. Di sini, Anda dapat memberikan ID Tabel dari tabel yang akan dikueri dan CUSTOM_QUERY
, untuk memberikan pernyataan SQL untuk membuat kueri tabel.
Kueri TABLE
Parameter berikut berlaku jika type
ditetapkan ke TABLE
dan Anda memberikan ID tabel untuk dikueri.
Nama parameter | Deskripsi |
---|---|
Opsional. Tetapkan ke bigQuery untuk
konektor BigQuery.Jika ditetapkan, akan mengganti sumber data dengan konfigurasi BigQuery yang disediakan. Lihat Mengganti vs mengupdate. |
|
Wajib** Jenis kueri. Tetapkan ke
TABLE . |
|
Wajib** Project ID tabel yang akan dikueri. | |
Diperlukan** ID Set Data tabel yang akan dikueri. | |
Wajib** ID Tabel tabel yang akan di-kueri. Tabel yang di-sharding tanggal: Akhiran * (karakter karakter pengganti) atau YYYYMMDD didukung
saat membuat kueri tabel yang di-sharding tanggal.Jika sebuah tabel diidentifikasi sebagai Google Analytics, Firebase Analytics, atau Firebase Crashlytics, template kolom default akan dipilih kecuali jika salah satunya ditentukan. Lihat parameter terkait tabel template kolom. |
|
Opsional. ID Project yang akan digunakan untuk penagihan. Jika tidak disetel,
projectId akan digunakan. |
|
Opsional. Tetapkan ke true jika tabel dipartisi dan Anda ingin menggunakan kolom partisi sebagai dimensi rentang tanggal. Hal ini
hanya berlaku untuk partisi berbasis waktu (Misalnya, menggunakan kolom partisi berbasis
waktu atau kolom semu _PARTITIONTIME ) dan
tidak berfungsi untuk tabel partisi rentang bilangan bulat. Nilai defaultnya adalah false jika tidak ditentukan. Untuk mempelajari lebih lanjut, lihat
Pengantar tabel yang dipartisi. |
|
Opsional. Jika tidak ditentukan, setelan defaultnya adalah true . Lihat refreshFields untuk mengetahui detailnya. |
Template kolom untuk Google Analytics, Firebase Analytics, dan Crashlytics
Untuk tabel yang diidentifikasi sebagai Google Analytics, Firebase Analytics, atau Firebase Crashlytics, parameter tambahan tersedia untuk menetapkan template kolom. Jika tidak ditentukan, template default akan dipilih.
Nama | Deskripsi |
---|---|
Opsional. Template kolom Google Analytics yang akan digunakan. Hanya berlaku
jika BigQuery Export untuk tabel Google Analytics sedang dikueri. Salah satu dari ALL , SESSION , HITS . Untuk tabel Google Analytics, setelan defaultnya adalah ALL jika tidak ditentukan. |
|
Opsional. Template kolom Firebase Analytics yang akan digunakan. Hanya berlaku jika tabel BigQuery Export untuk Firebase Analytics sedang dikueri.
Hanya dapat disetel ke EVENTS . Untuk tabel Firebase Analytics, nilai defaultnya adalah EVENTS jika tidak ditentukan. |
|
Template kolom Firebase Crashlytics yang akan digunakan. Hanya dapat ditetapkan ke
DEFAULT . Hanya berlaku jika tabel BigQuery Export untuk Firebase Crashlytics sedang dikueri. Untuk tabel Firebase Crashlytics, nilai defaultnya adalah DEFAULT jika tidak ditentukan. |
Kueri CUSTOM
Parameter berikut berlaku jika type
ditetapkan ke CUSTOM_QUERY
dan
Anda memberikan pernyataan SQL untuk membuat kueri tabel.
Nama parameter | Deskripsi |
---|---|
Opsional. Tetapkan ke bigQuery untuk
konektor BigQuery.Jika ditetapkan, akan mengganti sumber data dengan konfigurasi BigQuery yang disediakan. Lihat Mengganti vs mengupdate. |
|
Wajib** Jenis kueri. Tetapkan ke
CUSTOM_QUERY . |
|
Wajib** Kueri SQL yang akan dijalankan. | |
Opsional. ID Project yang akan digunakan untuk penagihan. Jika tidak disetel,
projectId akan digunakan. Jika projectId tidak ditetapkan, project tabel yang dikueri akan digunakan. |
|
Opsional. Daftar pola dan string pengganti yang dipisahkan koma untuk
diterapkan pada kueri SQL. Penggantian string hanya diterapkan jika ada
kecocokan pola. Gunakan koma untuk memisahkan pasangan string pola dan
pengganti. Misalnya, |
|
Opsional. Jika tidak ditentukan, setelan defaultnya adalah true . Lihat refreshFields untuk mengetahui detailnya. |
Contoh
Konfigurasi jenis TABLE
tempat kueri ditentukan dengan ID Tabel:
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
Konfigurasi jenis TABLE
untuk membuat kueri tabel yang di-sharding tanggal menggunakan akhiran karakter pengganti:
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_*
Konfigurasi jenis TABLE
untuk membuat kueri tabel yang di-sharding tanggal menggunakan akhiran 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
Konfigurasi jenis TABLE
untuk membuat kueri tabel BigQuery Export untuk Google Analytics, menggunakan template kolom 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
Konfigurasi jenis TABLE
untuk membuat kueri tabel yang dipartisi dengan waktu penyerapan dan
menggunakan kolom partisi sebagai dimensi rentang tanggal:
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
Konfigurasi jenis CUSTOM_QUERY
tempat kueri ditentukan dengan pernyataan 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
Konfigurasi jenis CUSTOM_QUERY
dengan hanya pernyataan SQL yang diperbarui dan
sumber data template digunakan untuk konfigurasi lainnya:
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.sql=SELECT%20corpus%20FROM%20%60bigquery-public-data.samples.shakespeare%60
Konfigurasi jenis CUSTOM_QUERY
dengan pernyataan SQL sumber data
template diperbarui menggunakan 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
Nama parameter | Deskripsi |
---|---|
Opsional. Tetapkan ke cloudSpanner untuk
konektor Cloud Spanner.Jika disetel, mengganti sumber data dengan konfigurasi Cloud Spanner yang disediakan. Lihat Mengganti vs mengupdate. |
|
Wajib** Project ID. | |
Wajib** ID instance. | |
Wajib** ID Database. | |
Wajib** Kueri SQL yang akan dijalankan. | |
Opsional. Jika tidak ditentukan, setelan defaultnya adalah true .
Lihat refreshFields untuk mengetahui detailnya. |
Contoh
Konfigurasi Cloud Spanner dengan pernyataan 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
Konektor Komunitas
Nama parameter | Deskripsi |
---|---|
Opsional. Tetapkan ke community untuk
Konektor Komunitas.Jika ditetapkan, sumber data akan diganti dengan konfigurasi Konektor Komunitas yang disediakan. Lihat Mengganti vs mengupdate. |
|
Wajib** Konektor Komunitas
connectorId (juga dikenal sebagai deploymentId ).
| |
Opsional. Parameter khusus konektor tambahan, seperti yang ditetapkan oleh konfigurasi konektor konektor komunitas. | |
Opsional. Jika tidak ditentukan, setelan defaultnya adalah true . Lihat refreshFields untuk mengetahui detailnya. |
Contoh
Hubungkan ke konektor komunitas dengan parameter konfigurasi state
dan 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
Nama parameter | Deskripsi |
---|---|
Opsional. Tetapkan ke googleAnalytics untuk konektor Google Analytics.Jika ditetapkan, mengganti sumber data dengan konfigurasi Google Analytics yang disediakan. Lihat Mengganti vs mengupdate. |
|
Wajib** ID Akun. | |
Wajib** ID Properti. | |
ID Tampilan. Wajib** untuk properti Universal Analytics. Jangan tetapkan untuk properti Google Analytics 4. |
|
Opsional. Jika tidak ditentukan, setelan defaultnya adalah false . Lihat refreshFields untuk mengetahui detailnya. |
Contoh
Konfigurasi Google Analytics untuk properti 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
Konfigurasi Google Analytics untuk properti 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
Nama parameter | Deskripsi |
---|---|
Opsional. Tetapkan ke googleCloudStorage
konektor Google Cloud Storage.Jika disetel, sumber data akan diganti dengan konfigurasi Google Cloud Storage yang disediakan. Lihat Mengganti vs mengupdate. |
|
Wajib** Jenis jalur. Gunakan
FILE untuk memilih satu file atau FOLDER untuk memilih
semua file untuk jalur yang ditentukan. |
|
Diperlukan** Jalur file (misalnya MyBucket/MyData/MyFile.csv) jika pathType adalah FILE atau jalur folder (misalnya *MyBucket/MyData) jika pathType adalah FOLDER . |
|
Opsional. Jika tidak ditentukan, setelan defaultnya adalah true .
Lihat refreshFields untuk mengetahui detailnya. |
Contoh
Konfigurasi Google Cloud Storage untuk satu 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
Konfigurasi Google Cloud Storage untuk semua file di jalur:
https://lookerstudio.google.com/reporting/create?
c.reportId=231908kpf
&ds.ds50.connector=googleCloudStorage
&ds.ds50.pathType=FOLDER
&ds.ds50.path=MyBucket%2FMyData
Google Spreadsheet
Nama parameter | Deskripsi |
---|---|
Opsional. Tetapkan ke googleSheets untuk
konektor Google Spreadsheet.Jika ditetapkan, akan mengganti sumber data dengan konfigurasi Google Spreadsheet yang disediakan. Lihat Mengganti vs mengupdate. |
|
Wajib** ID spreadsheet. | |
Wajib** ID lembar kerja. | |
Opsional. Tetapkan ke true untuk menggunakan baris pertama sebagai header.
Jika tidak ditentukan, setelan defaultnya adalah true . Header kolom harus unik. Kolom dengan tajuk kosong tidak akan ditambahkan ke sumber data.
|
|
Opsional. Tetapkan ke true untuk menyertakan sel tersembunyi.
Jika tidak ditentukan, setelan defaultnya adalah true . |
|
Opsional. Tetapkan ke true untuk menyertakan sel yang difilter.
Jika tidak ditentukan, setelan defaultnya adalah true . |
|
Opsional. Rentang, misalnya A1:B52. | |
Opsional. Jika tidak ditentukan, setelan defaultnya adalah true . Lihat refreshFields untuk mengetahui detailnya. |
Contoh
Konfigurasi Google Spreadsheet:
https://lookerstudio.google.com/reporting/create?
c.reportId=101112jkl
&ds.ds3.connector=googleSheets
&ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
&ds.ds3.worksheetId=903806437
Konfigurasi Google Spreadsheet dengan baris pertama yang digunakan sebagai header serta sel yang disembunyikan dan difilter disertakan:
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
Konfigurasi Google Spreadsheet dengan rentang (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
Nama parameter | Deskripsi |
---|---|
Opsional. Tetapkan ke looker untuk
konektor Looker.Jika disetel, sumber data akan diganti dengan konfigurasi Looker yang disediakan. Lihat Mengganti vs mengupdate. |
|
Wajib** URL instance Looker. | |
Wajib** Model Looker. | |
Wajib** Jelajah Looker. | |
Opsional. Jika tidak ditentukan, setelan defaultnya adalah false . Lihat refreshFields untuk mengetahui detailnya. |
Contoh
Menghubungkan ke Jelajah 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
Nama parameter | Deskripsi |
---|---|
Opsional. Tetapkan ke searchConsole untuk
konektor Search Console.Jika ditetapkan, akan mengganti sumber data dengan konfigurasi Search Console yang disediakan. Lihat Mengganti vs mengupdate. |
|
Wajib** URL situs. Untuk Properti domain, awali dengan sc-domain\: . |
|
Wajib** Menentukan jenis tabel. Dapat berupa salah satu dari SITE_IMPRESSION atau URL_IMPRESSION . |
|
Wajib** Menetapkan jenis penelusuran. Dapat berupa salah satu dari WEB , IMAGE , VIDEO , atau NEWS . |
|
Opsional. Jika tidak ditentukan, setelan defaultnya adalah false . Lihat refreshFields untuk mengetahui detailnya. |
Contoh
Konfigurasi Search Console untuk properti awalan 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
Konfigurasi Search Console untuk Properti domain:
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
Izin template
Untuk memastikan pengalaman pengguna terbaik bagi pengguna, penting untuk menetapkan izin akses laporan dengan benar untuk laporan template dan sumber data terkait. Izin yang diperlukan bergantung pada apakah template laporan menggunakan sumber data sematan atau sumber data yang dapat digunakan kembali dan apakah konfigurasi Linking API ditetapkan untuk mengganti atau memperbarui konfigurasi sumber data.
Tabel berikut memberikan akses sumber data yang direkomendasikan untuk pengalaman pengguna yang optimal berdasarkan sumber data template dan konfigurasi Linking API:
Jenis sumber data | Menautkan konfigurasi API untuk sumber data | Rekomendasi untuk izin sumber data | Catatan |
---|---|---|---|
Disematkan | Mengganti | T/A - Akses lihat akan diwariskan dari laporan. | Jika pengguna memiliki akses lihat ke laporan template, mereka akan otomatis memiliki akses lihat ke sumber data sematan. |
Disematkan | Update | T/A - Akses lihat akan diwariskan dari laporan. | Jika pengguna memiliki akses lihat ke laporan template, mereka akan otomatis memiliki akses lihat ke sumber data sematan. |
Dapat digunakan kembali | Mengganti | Pengguna tidak memerlukan akses lihat. | Akses lihat tidak diperlukan karena konfigurasi sumber data diganti sepenuhnya melalui Linking API. |
Dapat digunakan kembali | Update | Pengguna memerlukan akses lihat. | Akses lihat ke sumber data diperlukan agar Linking API dapat membaca dan menggunakan konfigurasi dari sumber data template. Jika pengguna tidak memiliki akses lihat, mereka akan menerima error saat memuat laporan. |
Menggunakan laporan kosong atau default
Untuk menggunakan laporan kosong atau laporan default, konfigurasikan Linking API Anda sebagai berikut:
Jenis laporan | Menyetel parameter kontrol reportId |
Tetapkan parameter sumber data ( ). |
Catatan |
---|---|---|---|
Laporan kosong | Tidak | Tidak | |
Laporan default | Tidak | Ya | Laporan default disediakan oleh Looker Studio. Anda tidak perlu menggunakan alias sumber data saat menentukan parameter sumber data untuk laporan default, karena laporan default memiliki satu sumber data sematan. |
Contoh berikut menunjukkan berbagai URL Linking API yang menggunakan laporan kosong atau default.
Mulai alur kerja pembuatan laporan dengan laporan kosong:
https://lookerstudio.google.com/reporting/create
Mulai alur kerja pembuatan laporan dengan laporan kosong dan tetapkan nama laporan:
https://lookerstudio.google.com/reporting/create?r.reportName=MyNewReport
Gunakan template laporan default dengan konfigurasi konektor Google Spreadsheet:
https://lookerstudio.google.com/reporting/create?
ds.connector=googleSheets
&ds.spreadsheetId=1Q-w7KeeJj1jk3wFcFm4NsPlppNscs0CtHf_EP9fsYOo
&ds.worksheetId=0
Menyematkan laporan
Untuk menyematkan laporan yang dibuat dengan Linking API, tetapkan
parameter URL dan sertakan jalur /embed/
. URL sematan
Linking API harus dalam format berikut:
https://lookerstudio.google.com/embed/reporting/create?parameters
Menemukan ID dan alias
ID Laporan
Untuk menemukan ID laporan:
- Buka laporan yang ingin Anda gunakan sebagai template. Periksa URL laporan. Bagian antara
reporting/
dan/page
adalah ID laporan. Misalnya, pada URL berikut,0B_U5RNpwhcE6SF85TENURnc4UjA
adalah ID laporan:
https://lookerstudio.google.com/reporting/0B_U5RNpwhcE6SF85TENURnc4UjA/page/1M
Alias sumber data
Laporan dapat memiliki beberapa sumber data. Sumber data harus dirujuk oleh aliasnya.
Untuk menemukan alias sumber data:
- Edit laporan.
- Dari toolbar, pilih Aset > Kelola sumber data yang ditambahkan.
- Periksa kolom Alias untuk menemukan informasi alias untuk setiap sumber data.
Anda dapat mengedit nama alias untuk memastikan kompatibilitas mundur saat Sumber Data ditambahkan atau dihapus.
Jenis konektor
Laporan dapat memiliki beberapa sumber data, yang masing-masing dibuat dengan mengonfigurasi konektor. Untuk menemukan jenis konektor yang digunakan untuk membuat sumber data:
- Edit laporan.
- Dari toolbar, pilih Aset > Kelola sumber data yang ditambahkan.
- Periksa kolom Jenis Konektor untuk mengidentifikasi konektor yang digunakan untuk membuat sumber data.
Tips & pemecahan masalah
Jika Anda mengalami masalah, tinjau detail di bawah untuk mengidentifikasi potensi masalah dan kesalahan konfigurasi umum.
Dialog debug
Gunakan dialog debug untuk meninjau konfigurasi Linking API sebagaimana diinterpretasikan oleh Looker Studio. Ini dapat membantu men-debug masalah dengan API.
- Saat terjadi error selama penguraian URL Linking API, dialog akan otomatis ditampilkan dengan detail tentang error tersebut.
- Saat terjadi error dan tidak ada dialog yang ditampilkan secara otomatis, cari tombol info di kanan atas laporan. Klik untuk informasi debug tambahan.
- Jika tidak ada tombol info yang tersedia, Anda dapat mengaktifkan tombol tersebut dengan menambahkan parameter
&c.explain=true
ke bagian akhir URL Linking API.
Izin
Pastikan Anda telah menetapkan izin template yang benar untuk jenis sumber data dan konfigurasi Linking API. Lihat Izin template untuk mengetahui detailnya.
Memperbarui vs mengganti
Jika memperbarui konfigurasi sumber data dari template sumber data, tinjau konfigurasi sumber data template dan konfigurasi Linking API untuk memastikan keduanya kompatibel. Pastikan kolom yang dihasilkan dari konfigurasi baru kompatibel dengan komponen dan konfigurasi laporan.
Saat melakukan update vs penggantian, Anda dapat menyetel konfigurasi yang tidak valid dengan perilaku yang tidak ditentukan. Lihat artikel Mengganti vs mengupdate untuk mengetahui detailnya.
Memuat ulang kolom
Jika Anda telah mengonfigurasi nama, jenis, atau agregasi untuk sumber data template, perubahan ini hanya akan beralih ke sumber data yang dikonfigurasi Linking API jika parameter ds.refreshFields
ditetapkan ke false
.
Tinjau parameter sumber data ds.refreshFields
dari URL Linking API Anda. Jika dihilangkan, pastikan nilai default parameter untuk setiap jenis konektor sudah benar untuk kasus penggunaan Anda.
Umumnya, jika Anda telah mengonfigurasi kolom di sumber data template dan yakin bahwa konfigurasi sumber data baru melalui Linking API akan selalu menghasilkan kolom yang sama persis, maka sebaiknya tetapkan refreshFields
ke false
.
Misalnya, jika selama pembuatan template laporan, Looker Studio
mengidentifikasi kolom sumber data tertentu sebagai jenis Number dan Anda mengubahnya untuk
mengetik Year, perubahan konfigurasi kolom ini kini menjadi bagian dari sumber data
template. Setiap diagram dalam template laporan yang menggunakan kolom yang dikoreksi akan mengharapkan Year dan jika diagram berbasis waktu, diagram tersebut mungkin tidak akan dirender. Jika Linking API digunakan untuk menyediakan konfigurasi sumber data baru yang menghasilkan kolom yang sama persis, ada dua hasil berdasarkan nilai parameter refreshFields
:
Jika ditetapkan ke
true
, konfigurasi kolom dari sumber data template tidak akan dialihkan, dan diagram mungkin berpotensi gagal dimuat jika bergantung pada konfigurasi kolom yang sama (yaitu kolom dengan jenis Tahun diharapkan).Jika ditetapkan ke
false
, konfigurasi kolom dari sumber data template akan dialihkan ke sumber data baru dan diagram laporan akan menerima kolom yang sama dengan konfigurasi yang sama dan berhasil dimuat.
Masukan dan dukungan
Gunakan Issue Tracker untuk melaporkan masalah Linking API atau untuk memberikan masukan. Lihat Dukungan untuk mengetahui referensi umum tentang cara mendapatkan bantuan dan mengajukan pertanyaan.
Log perubahan
2023-06-06
- Menambahkan parameter laporan
r.measurementId
danr.keepMeasurementId
untuk mengonfigurasi setelan laporan ID Pengukuran Google Analytics. - Menambahkan
ds.keepDatasourceName
untuk mengontrol penggunaan ulang nama sumber data template. - Menambahkan bagian Sematkan laporan.
- Konektor BigQuery
- Menambahkan
sqlReplace
. Memungkinkan Anda menentukan string pengganti dan pola untuk memperbarui kueri SQL sumber data template.
- Menambahkan
2023-05-22
- Menambahkan dukungan untuk konektor Looker.
- Menambahkan dukungan untuk Konektor Komunitas.
2022-11-21
- Menambahkan kemampuan untuk menggunakan laporan kosong. Lihat Menggunakan laporan kosong atau default
- Menambahkan bagian
refreshFields
ke Tips & pemecahan masalah.
2022-11-14
- Referensi konektor Survei telah dihapus karena adanya Penghentian Google Survei.
2022-06-15
- Di luar versi beta
- Integration API telah diganti namanya menjadi Linking API.
- Linking API tidak tersedia dalam versi beta.
- Menambahkan parameter kontrol
pageId
untuk mengizinkan penautan ke halaman laporan tertentu. - Menambahkan parameter kontrol
mode
untuk menetapkan status laporan ke mode Lihat atau Edit saat dimuat. - Konfigurasi sumber data kini dapat diganti seluruhnya atau sebagian. Perilaku ini ditentukan oleh apakah
parameter
ds.connector
telah ditetapkan atau tidak. Lihat Mengganti vs mengupdate untuk mengetahui detailnya. - Template default kini digunakan jika template laporan tidak disediakan menggunakan
parameter
c.reportId
. - Menambahkan parameter sumber data
ds.refreshFields
. Hal ini memungkinkan Anda mengontrol apakah kolom sumber data dimuat ulang saat memuat konfigurasi sumber data. - Konektor BigQuery
projectId
tidak diperlukan jikatype
disetel keCUSTOM_QUERY
.- Jika
billingProjectId
tidak ditetapkan, project penagihan akan berganti keprojectId
atau project dari tabel yang dikueri. - Menambahkan dukungan untuk tabel yang dipartisi menurut tanggal. Tetapkan parameter
isPartitioned
ketrue
untuk menggunakan kolom partisi sebagai dimensi rentang tanggal. - Menambahkan dukungan untuk membuat kueri tabel yang dipartisi tanggal menggunakan karakter pengganti atau akhiran tabel
YYYYMMDD
. - Menambahkan dukungan untuk mengkueri tabel Google Analytics, Firebase Analytics, atau Crashlytics dan memilih template kolom.
- Google Spreadsheet
hasHeader
ditetapkan secara default ketrue
, konsisten dengan default UI web.includeHiddenAndFilteredCell
dibagi menjadiincludeHiddenCells
danincludeFilteredCells
. Keduanya kini ditetapkan secara default ketrue
, konsisten dengan default UI web.
- Konektor Search Console
- Mengganti nama parameter
propertyType
menjadisearchType
.
- Mengganti nama parameter
- Konektor Survei
surveyId
kini menerima satu ID survei atau daftar ID survei yang dipisahkan koma.
2021-12-16
- Rilis awal Integration API.
- Mendukung penautan ke laporan yang ada dan menyetel nama laporan.
- Beberapa sumber data dapat dikonfigurasi dan setiap nama sumber data dapat ditetapkan.
- Dukungan untuk jenis konektor berikut: BigQuery, Cloud Spanner, Google Analytics, Google Cloud Storage, Google Spreadsheet, Google Survei, Search Console.