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 URL Linking API yang diperlukan dan parameter yang tersedia.
Kasus penggunaan dan manfaat
Linking API dapat digunakan untuk memberikan laporan yang telah dikonfigurasi sebelumnya bagi pelanggan Anda agar mereka 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 membuka kembali laporan tersebut kapan saja.
- Membuat laporan dalam skala besar. Linking API mengurangi waktu yang diperlukan untuk menduplikasi atau membuat laporan baru.
- Aktifkan integrasi produk. Antarmuka yang stabil memungkinkan Anda mengintegrasikan Looker Studio ke dalam alur kerja produk.
Cara kerjanya
Berikut ini menjelaskan cara developer dan pengguna berinteraksi dengan Linking API.
Alur kerja developer Linking 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 mencakup konfigurasi sumber data template.
- Memformat URL Linking API untuk kasus penggunaan spesifik Anda. Jika berlaku, 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.
Pengalaman pengguna Linking 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 mereka akses. Pengalaman pengguna yang umum mungkin 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 serta berinteraksi dengan datanya.
- Pengguna mengklik “Edit dan bagikan”. Laporan disimpan ke akun Looker Studio-nya.
- Pengguna kini memiliki akses dan kontrol penuh atas salinan laporan miliknya. Mereka dapat melihat, mengedit, dan membagikan kapan saja.
Persyaratan
Untuk memastikan URL Linking API berfungsi seperti yang diharapkan, hal berikut diperlukan:
- Laporan, untuk dijadikan template. Jika tidak diberikan, 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, semua komponen laporan yang bergantung akan menampilkan error.
Parameter URL
URL Linking API harus dalam format berikut:
https://lookerstudio.google.com/reporting/create?parameters
URL diharapkan digunakan dalam konteks browser web, biasanya oleh pengguna yang mengklik link atau dialihkan ke URL. Fitur 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 wajib ada, 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 mengetahui 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. Secara default, halaman pertama laporan jika tidak ditentukan. | |
Opsional. Mode laporan awal. Salah satu dari
view atau
edit. Nilai defaultnya adalah view jika tidak ditentukan.
|
|
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, defaultnya adalah nama laporan template. | |
|
Opsional. Menetapkan ID Pengukuran Google Analytics ke Ukur penggunaan laporan. Gunakan koma untuk memisahkan beberapa ID. Jika |
|
|
Opsional. Setel 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 ada. Penggunaan alias memungkinkan kompatibilitas mundur jika sumber data ditambahkan/dihapus dari laporan template.
Untuk mengetahui detail 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. Setel ke Jika |
|
|
Opsional.
Jenis konektor sumber data. Untuk mengetahui informasi selengkapnya tentang jenis konektor yang didukung, lihat Referensi konektor. Jika disetel, semua parameter konektor yang diperlukan untuk jenis konektor harus ditentukan di URL Linking API dan konfigurasi sumber data template akan diganti seluruhnya. Jika tidak ditentukan, nol atau lebih parameter konektor untuk jenis konektor dapat ditentukan di URL Linking API. Konfigurasi sumber data template akan digunakan untuk menentukan parameter apa pun yang tidak disediakan di URL Linking API. Untuk mengetahui detail tentang cara mengidentifikasi jenis konektor sumber data template, lihat Jenis konektor. Untuk mempelajari lebih lanjut cara parameter |
|
|
Opsional.
Disetel ke Setel ke Jika tidak ditentukan, default akan bervariasi menurut jenis konektor. Tinjau Referensi konektor untuk default khusus konektor jika Anda ingin mengganti perilaku default. Pertimbangan saat menggunakan
refreshFields:
|
|
| Wajib diisi. Konfigurasi sumber data untuk jenis konektor. Untuk mengetahui 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. |
Mengganti vs. memperbarui - Konfigurasi sumber data
Saat menetapkan parameter sumber data, ada atau tidaknya parameter
ds.connector di URL Linking API menunjukkan niat untuk
mengganti atau memperbarui konfigurasi sumber data template,
masing-masing.
Tabel berikut menjelaskan pengaruh parameter ds.connector terhadap apakah konfigurasi sumber data template diganti seluruhnya atau digunakan untuk memperbarui parameter yang tidak ditentukan:
Apakah ds.connector sudah disetel? |
Konfigurasi dan perilaku yang diharapkan | Penggunaan umum |
|---|---|---|
| Ya |
Ganti. Konfigurasi sumber data template diganti sepenuhnya, menggunakan parameter sumber data yang ditentukan di URL Linking API. Anda harus menentukan semua parameter yang diperlukan untuk
jenis konektor. Lihat Parameter wajib saat
ds.connector ditetapkan.
|
|
| Tidak | Update. Konfigurasi sumber data template akan digunakan untuk
menentukan parameter apa pun yang tidak disediakan di URL Linking API. Semua parameter konektor untuk jenis konektor bersifat opsional, kecuali jika dinyatakan lain.
Hal ini menyederhanakan URL Linking API dan umumnya direkomendasikan jika Anda sudah memahami konfigurasi sumber data template dan hanya ingin mengganti sebagian parameter. |
|
Parameter yang diperlukan saat ds.connector disetel
Jika parameter ds.connector sumber data ditentukan, maka semua parameter konektor yang ditetapkan sebagai Wajib harus ditentukan untuk sumber data. Jika parameter ds.connector sumber data tidak ditentukan, maka semua parameter konektor, bahkan yang ditetapkan sebagai wajib, dapat dianggap 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 hanya ID project penagihan dari
sumber data:
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 sepenuhnya, sedangkan konfigurasi Google Analytics memperbarui satu parameter dan mengandalkan sumber data template ds1 untuk parameter konektor yang tidak 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, sumber data yang sama dapat digunakan dalam beberapa laporan sehingga 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 mereferensikan sumber data berdasarkan alias
- URL tidak menggunakan alias karakter pengganti (lihat Karakter pengganti alias sumber data)
Saat sumber data baru dibuat dengan Linking API, sumber data tersebut menggunakan kredensial pengguna yang mengklik URL. Artinya, pengguna harus memiliki akses ke data pokok 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 yang terlampir, dan Anda ingin mengganti projectId dan datasetId di setiap sumber data, tetapi mempertahankan tableId, Anda dapat menuliskannya 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.* akan
lebih diprioritaskan daripada parameter yang menggunakan karakter pengganti. 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 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 disediakan (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 akan diberikan.
BigQuery
Konektor BigQuery mendukung dua jenis kueri, yaitu kueri TABLE, yang
memungkinkan Anda memberikan ID Tabel dari tabel yang akan dikueri, dan CUSTOM_QUERY, yang
memungkinkan Anda memberikan pernyataan SQL untuk mengkueri tabel.
Kueri TABEL
Parameter berikut berlaku saat type disetel ke TABLE dan Anda memberikan ID tabel yang akan dikueri.
| Nama parameter | Deskripsi |
|---|---|
Opsional. Setel ke bigQuery untuk
konektor
BigQuery.Jika disetel, menggantikan sumber data dengan konfigurasi BigQuery yang diberikan. Lihat Mengganti vs. memperbarui. |
|
Wajib** Jenis kueri. Tetapkan ke
TABLE. |
|
| Wajib** Project ID tabel yang akan dikueri. | |
| Wajib** ID Set Data tabel yang akan dikueri. | |
| Wajib** ID Tabel dari tabel yang akan
dikueri. Tabel yang di-shard menurut tanggal: Sufiks * (karakter pengganti) atau YYYYMMDD didukung
saat mengkueri tabel yang di-shard menurut tanggal.Jika tabel diidentifikasi sebagai Google Analytics, Firebase Analytics, atau Firebase Crashlytics, template kolom default akan dipilih kecuali jika ditentukan. Lihat parameter terkait tabel template kolom. |
|
Opsional. ID Project yang akan digunakan untuk penagihan. Jika tidak disetel,
projectId akan digunakan. |
|
Opsional. Setel ke true jika tabel dipartisi dan Anda
ingin menggunakan kolom partisi sebagai dimensi rentang tanggal. Ini hanya berlaku untuk partisi berbasis waktu (misalnya, menggunakan kolom partisi berbasis waktu atau pseudokolom _PARTITIONTIME) dan tidak berfungsi untuk tabel berpartisi rentang bilangan bulat. Nilai defaultnya adalah
false jika tidak ditentukan. Untuk mempelajari lebih lanjut, lihat
Pengantar tabel berpartisi. |
|
Opsional. Nilai defaultnya adalah true jika tidak ditentukan. 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
saat tabel BigQuery Export untuk Google Analytics dikueri. Salah satu
dari ALL, SESSION, HITS. Untuk tabel Google Analytics, nilai defaultnya adalah ALL jika tidak ditentukan. |
|
Opsional. Template kolom Firebase Analytics yang akan digunakan. Hanya berlaku
saat tabel BigQuery Export untuk Firebase Analytics dikueri.
Hanya dapat disetel ke EVENTS. Untuk tabel Firebase Analytics,
defaultnya adalah EVENTS jika tidak ditentukan. |
|
Template kolom Firebase Crashlytics yang akan digunakan. Hanya dapat disetel ke
DEFAULT. Hanya berlaku saat tabel BigQuery export untuk Firebase Crashlytics sedang dikueri. Untuk tabel Firebase Crashlytics,
defaultnya adalah DEFAULT jika tidak ditentukan. |
Kueri KUSTOM
Parameter berikut berlaku jika type disetel ke CUSTOM_QUERY dan
Anda memberikan pernyataan SQL untuk membuat kueri tabel.
| Nama parameter | Deskripsi |
|---|---|
Opsional. Setel ke bigQuery untuk
konektor
BigQuery.Jika disetel, menggantikan sumber data dengan konfigurasi BigQuery yang diberikan. Lihat Mengganti vs. memperbarui. |
|
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
maka project tabel yang dikueri akan digunakan. |
|
|
Opsional. Daftar string pola dan penggantian yang dipisahkan koma untuk diterapkan ke kueri SQL. Penggantian string hanya diterapkan jika ada
pencocokan pola. Gunakan koma untuk memisahkan pasangan string pola dan string pengganti. Misalnya, |
|
Opsional. Nilai defaultnya adalah true jika tidak ditentukan. 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-shard menurut tanggal menggunakan sufiks 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-shard menurut tanggal menggunakan sufiks 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 mengkueri tabel berpartisi berdasarkan 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 yang hanya memperbarui pernyataan SQL 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 tempat 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. Setel ke cloudSpanneruntuk
konektor
Cloud Spanner.Jika ditetapkan, menggantikan sumber data dengan konfigurasi Cloud Spanner yang diberikan. Lihat Mengganti vs. memperbarui. |
|
| Wajib** Project ID. | |
| Wajib** ID instance. | |
| Wajib diisi** ID Database. | |
| Wajib** Kueri SQL yang akan dijalankan. | |
Opsional. Nilai defaultnya adalah true jika tidak ditentukan.
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. Disetel ke community untuk
Konektor Komunitas.Jika disetel, menggantikan sumber data dengan konfigurasi Konektor Komunitas yang diberikan. Lihat Mengganti vs. memperbarui. |
|
Wajib** Konektor Komunitas
connectorId (juga dikenal sebagai deploymentId).
| |
| Opsional. Parameter tambahan khusus konektor, seperti yang ditentukan oleh konfigurasi konektor konektor komunitas. | |
Opsional. Nilai defaultnya adalah true jika tidak ditentukan. Lihat
refreshFields untuk mengetahui detailnya. |
Contoh
Terhubung 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. Disetel ke googleAnalytics untuk
konektor Google
Analytics.Jika disetel, menggantikan sumber data dengan konfigurasi Google Analytics yang diberikan. Lihat Mengganti vs. memperbarui. |
|
| Wajib diisi** ID Akun. | |
| Wajib** ID Properti. | |
| ID Tampilan. Wajib** untuk properti Universal Analytics. Jangan tetapkan untuk properti Google Analytics 4. |
|
Opsional. Nilai defaultnya adalah false jika tidak ditentukan. 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. Setel ke googleCloudStorage
Google
Cloud Storage connector.Jika disetel, menggantikan sumber data dengan konfigurasi Google Cloud Storage yang diberikan. Lihat Mengganti vs. memperbarui. |
|
Wajib** Jenis jalur. Gunakan
FILE untuk memilih satu file atau FOLDER untuk memilih
semua file untuk jalur tertentu. |
|
Wajib** Jalur file (misalnya,
MyBucket/MyData/MyFile.csv) jika pathType adalah
FILE atau jalur folder (misalnya, *MyBucket/MyData) jika
pathType adalah FOLDER. |
|
Opsional. Nilai defaultnya adalah true jika tidak ditentukan.
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. Setel ke googleSheets untuk
konektor Google
Spreadsheet.Jika disetel, menggantikan sumber data dengan konfigurasi Google Spreadsheet yang diberikan. Lihat Mengganti vs. memperbarui. |
|
| Wajib diisi** ID spreadsheet. | |
| Wajib** ID lembar kerja. | |
Opsional. Setel ke true untuk menggunakan baris pertama sebagai header.
Nilai defaultnya adalah true jika tidak ditentukan. Header kolom harus unik. Kolom dengan tajuk kosong tidak akan ditambahkan ke sumber data.
|
|
Opsional. Tetapkan ke true untuk menyertakan sel tersembunyi.
Nilai defaultnya adalah true jika tidak ditentukan. |
|
Opsional. Setel ke true untuk menyertakan sel yang difilter.
Nilai defaultnya adalah true jika tidak ditentukan. |
|
| Opsional. Rentang, misalnya A1:B52. | |
Opsional. Nilai defaultnya adalah true jika tidak ditentukan. 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 digunakan sebagai header dan 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. Setel ke looker untuk
konektor Looker.Jika disetel, mengganti sumber data dengan konfigurasi Looker yang diberikan. Lihat Mengganti vs. memperbarui. |
|
| Wajib** URL instance Looker. | |
| Wajib** Model Looker. | |
| Wajib** Eksplorasi Looker. | |
Opsional. Nilai defaultnya adalah false jika tidak ditentukan. 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. Setel ke searchConsole untuk
konektor Search
Console.Jika disetel, menggantikan sumber data dengan konfigurasi Search Console yang diberikan. Lihat Mengganti vs. memperbarui. |
|
Wajib** URL situs. Untuk
Properti
Domain, tambahkan awalan sc-domain\:. |
|
Wajib** Menetapkan 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. Nilai defaultnya adalah false jika tidak ditentukan. 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 yang terbaik, Anda harus menyetel izin akses laporan dengan benar untuk laporan template dan sumber data terkait. Izin yang diperlukan bergantung pada apakah template laporan menggunakan sumber data sematan vs. 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 | Konfigurasi Linking API untuk sumber data | Rekomendasi untuk izin sumber data | Catatan |
|---|---|---|---|
| Tersemat | Ganti | T/A - Akses lihat akan diwarisi dari laporan. | Jika pengguna memiliki akses lihat ke laporan template, mereka akan otomatis memiliki akses lihat ke sumber data sematan. |
| Tersemat | Perbarui | T/A - Akses lihat akan diwarisi dari laporan. | Jika pengguna memiliki akses lihat ke laporan template, mereka akan otomatis memiliki akses lihat ke sumber data sematan. |
| Dapat digunakan kembali | Ganti | Pengguna tidak memerlukan akses lihat. | Karena konfigurasi sumber data diganti sepenuhnya melalui Linking API, akses lihat tidak diperlukan. |
| Dapat digunakan kembali | Perbarui | 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 | Menetapkan parameter kontrol reportId |
Tetapkan parameter sumber data (). |
Catatan |
|---|---|---|---|
| Laporan kosong | Tidak | Tidak | |
| Laporan default | Tidak | Ya | Laporan default disediakan oleh Looker Studio. Alias sumber data tidak diperlukan 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 menetapkan nama laporan:
https://lookerstudio.google.com/reporting/create?r.reportName=MyNewReport
Menggunakan 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 di antara
reporting/dan/pageadalah ID laporan. Misalnya, pada URL berikut,0B_U5RNpwhcE6SF85TENURnc4UjAadalah ID laporan:
https://lookerstudio.google.com/reporting/0B_U5RNpwhcE6SF85TENURnc4UjA/page/1M
Alias sumber data
Laporan dapat memiliki beberapa sumber data. Sumber data harus dirujuk berdasarkan 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 ditafsirkan oleh Looker Studio. Hal ini dapat membantu melakukan proses debug masalah dengan API.
- Jika terjadi error selama penguraian URL Linking API, dialog akan otomatis ditampilkan dengan detail tentang error tersebut.
- Jika 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, Anda dapat mengaktifkan tombol dengan
menambahkan parameter
&c.explain=truedi 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 bahwa kolom yang dihasilkan dari konfigurasi baru kompatibel dengan komponen dan konfigurasi laporan.
Saat melakukan update vs. penggantian, konfigurasi yang tidak valid dengan perilaku yang tidak ditentukan dapat disetel. Lihat Mengganti vs. memperbarui untuk mengetahui detailnya.
Memperbarui kolom
Jika Anda telah mengonfigurasi nama, jenis, atau agregasi kolom untuk sumber data template, perubahan ini hanya akan diterapkan 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.
Secara umum, 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, sebaiknya tetapkan refreshFields ke false.
Misalnya, jika selama pembuatan template laporan, Looker Studio mengidentifikasi kolom sumber data tertentu sebagai jenis Number dan Anda mengubahnya menjadi jenis Year, perubahan konfigurasi kolom ini kini menjadi bagian dari sumber data template. Diagram apa pun dalam template laporan yang menggunakan kolom yang diperbaiki akan
memerlukan Tahun dan jika diagram berbasis waktu, diagram tersebut mungkin tidak dirender. Jika
Linking API digunakan untuk memberikan konfigurasi sumber data baru yang menghasilkan
kolom yang persis sama, ada dua hasil berdasarkan nilai parameter
refreshFields:
Jika disetel ke
true, konfigurasi kolom dari sumber data template tidak akan dipertahankan, dan diagram berpotensi gagal dimuat jika bergantung pada konfigurasi kolom yang sama (yaitu, kolom jenis Tahun diharapkan).Jika disetel ke
false, konfigurasi kolom dari sumber data template akan diteruskan 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 memberikan masukan. Lihat Dukungan untuk referensi umum tentang cara mendapatkan bantuan dan mengajukan pertanyaan.
Log perubahan
2023-06-06
- Menambahkan parameter laporan
r.measurementIddanr.keepMeasurementIduntuk mengonfigurasi setelan laporan ID Pengukuran Google Analytics. - Menambahkan
ds.keepDatasourceNameuntuk mengontrol penggunaan ulang nama sumber data template. - Menambahkan bagian Sematkan laporan.
- Konektor BigQuery
sqlReplaceditambahkan. Memungkinkan Anda menentukan string pola dan penggantian untuk memperbarui kueri SQL sumber data template.
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
refreshFieldske Tips & pemecahan masalah.
2022-11-14
- Referensi konektor Survei telah dihapus karena Penghentian Google Survei.
2022-06-15
- Keluar dari versi beta
- Integration API telah diganti namanya menjadi Linking API.
- Linking API tidak lagi dalam versi beta.
- Menambahkan parameter kontrol
pageIduntuk memungkinkan penautan ke halaman laporan tertentu. - Menambahkan parameter kontrol
modeuntuk menyetel status laporan ke mode Lihat atau Edit saat dimuat. - Konfigurasi sumber data kini dapat diganti sepenuhnya atau diperbarui sebagian. Perilaku ini ditentukan oleh apakah parameter
ds.connectorditetapkan. Lihat Mengganti vs. memperbarui 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
projectIdtidak diperlukan jikatypedisetel keCUSTOM_QUERY.- Jika
billingProjectIdtidak ditetapkan, project penagihan akan melakukan penggantian keprojectIdatau project tabel yang dikueri. - Menambahkan dukungan untuk tabel berpartisi menurut tanggal. Tetapkan parameter
isPartitionedketrueuntuk menggunakan kolom partisi sebagai dimensi rentang tanggal. - Menambahkan dukungan untuk membuat kueri tabel berpartisi tanggal menggunakan karakter
pengganti atau akhiran tabel
YYYYMMDD. - Menambahkan dukungan untuk membuat kueri tabel Google Analytics, Firebase Analytics, atau Crashlytics dan memilih template kolom.
- Google Spreadsheet
hasHeadersecara default adalahtrue, sesuai dengan default UI web.includeHiddenAndFilteredCelldibagi menjadiincludeHiddenCellsdanincludeFilteredCells. Keduanya kini secara default ditetapkan ketrue, sesuai dengan default UI web.
- Konektor Search Console
- Mengganti nama parameter
propertyTypemenjadisearchType.
- Mengganti nama parameter
- Konektor Survei
surveyIdsekarang 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.