API การเชื่อมโยง

บทนำ

Linking API มีอินเทอร์เฟซที่เชื่อถือได้ในการกำหนดค่าและส่งต่อผู้ใช้ ไปยังรายงาน Data Studio โดยตรงผ่าน URL เมื่อผู้ใช้คลิกลิงก์ API URL ระบบจะมอบประสบการณ์การใช้งานที่มีประสิทธิภาพเพื่อให้ผู้ใช้ดูและโต้ตอบกับ ข้อมูลได้อย่างรวดเร็ว

เอกสารนี้จะอธิบายรูปแบบที่จำเป็นของ URL ของ Linking API และ พารามิเตอร์ที่ใช้ได้

กรณีการใช้งานและสิทธิประโยชน์

คุณสามารถใช้ Linking API เพื่อจัดทำรายงานที่กำหนดค่าไว้ล่วงหน้าให้ลูกค้า ดูและโต้ตอบกับข้อมูลของตนได้ ประโยชน์หลักของ Linking API มีดังนี้

  • ประสบการณ์การสร้างรายงานแบบคลิกเดียวสำหรับลูกค้า
    • การกำหนดค่าข้อมูลจะอยู่ใน URL เพื่อให้ผู้ใช้ไม่ต้องกำหนดค่ารายงานสำหรับข้อมูลของตน
    • ผู้ใช้สามารถบันทึกรายงานได้ในคลิกเดียวและกลับมาดูรายงานได้ทุกเมื่อ
  • สร้างรายงานจำนวนมาก Linking API ช่วยลดเวลาที่ต้องใช้ในการ ทำซ้ำหรือสร้างรายงานใหม่
  • เปิดใช้การผสานรวมผลิตภัณฑ์ อินเทอร์เฟซที่เสถียรช่วยให้คุณ ผสานรวม Data Studio เข้ากับเวิร์กโฟลว์ของผลิตภัณฑ์ได้

วิธีการทำงาน

ต่อไปนี้จะอธิบายวิธีที่นักพัฒนาแอปและผู้ใช้โต้ตอบกับ Linking API

เวิร์กโฟลว์ของนักพัฒนาซอฟต์แวร์ Linking API

นักพัฒนาซอฟต์แวร์จัดเตรียมรายงานเทมเพลต แหล่งข้อมูล และจัดรูปแบบ URL ของ Linking API เวิร์กโฟลว์ทั่วไปสำหรับนักพัฒนาแอปมีดังนี้

  1. เลือกว่าจะใช้รายงานเปล่า เทมเพลตรายงานเริ่มต้นที่ Data Studio มีให้ หรือสร้างรายงาน Data Studio ที่จะใช้เป็นเทมเพลต ซึ่งรวมถึงการกำหนดค่าแหล่งข้อมูลเทมเพลต
  2. จัดรูปแบบ URL ของ Linking API สำหรับ Use Case ที่เฉพาะเจาะจง หากมี ให้ระบุ เทมเพลตรายงานและพารามิเตอร์อื่นๆ รวมถึงชื่อรายงาน ชื่อแหล่งข้อมูล และการกำหนดค่าแหล่งข้อมูล
  3. ใช้ URL ของ Linking API เพื่อนำผู้ใช้ไปยังรายงาน

ประสบการณ์ของผู้ใช้ API การลิงก์

ผู้ใช้จะทำตาม URL ของ Linking API ซึ่งหากนักพัฒนาซอฟต์แวร์กำหนดค่าอย่างถูกต้อง URL จะนำผู้ใช้ไปยังรายงาน Data Studio ที่อนุญาตให้ผู้ใช้ดูและโต้ตอบกับข้อมูลที่ตนมีสิทธิ์เข้าถึง ประสบการณ์ของผู้ใช้โดยทั่วไปอาจเป็นดังนี้

  1. ในเบราว์เซอร์ ผู้ใช้จะเข้าชมบริการที่ผสานรวมกับ Linking API
  2. คำกระตุ้นให้ดำเนินการจะเชิญชวนให้ผู้ใช้คลิกลิงก์เพื่อดูข้อมูลใน Data Studio
  3. ผู้ใช้คลิกลิงก์และระบบจะนำไปยังรายงาน Data Studio รายงานจะโหลดและผู้ใช้จะดูและโต้ตอบกับข้อมูลได้
  4. ผู้ใช้คลิก "แก้ไขและแชร์" ระบบจะบันทึกรายงานลงในบัญชี Data Studio ของผู้ใช้
  5. ตอนนี้ผู้ใช้มีสิทธิ์เข้าถึงและควบคุมสำเนารายงานของตนเองได้อย่างเต็มที่แล้ว โดยจะดู แก้ไข และแชร์ได้ทุกเมื่อ

ข้อกำหนด

คุณต้องมีสิ่งต่อไปนี้เพื่อให้มั่นใจว่า URL ของ Linking API จะทำงานได้ตามที่คาดไว้

  1. รายงานเพื่อใช้เป็นเทมเพลต หากไม่ได้ระบุไว้ คุณจะใช้รายงานว่างหรือรายงานเริ่มต้นที่ Data Studio จัดเตรียมไว้ได้
  2. ผู้ใช้ URL ของ Linking API ต้องมีสิทธิ์ดูรายงานเทมเพลตเป็นอย่างน้อย ผู้ใช้อาจต้องมีสิทธิ์ดูแหล่งข้อมูลด้วย ทั้งนี้ขึ้นอยู่กับประเภทแหล่งข้อมูลที่ใช้ในรายงาน และการกำหนดค่าที่ระบุผ่าน Linking API ดูรายละเอียดได้ที่สิทธิ์ของเทมเพลต
  3. ประเภทเครื่องมือเชื่อมต่อของแหล่งข้อมูลแต่ละแหล่งต้องรองรับการกำหนดค่าผ่าน Linking API ดูรายการตัวเชื่อมต่อที่รองรับได้ที่ข้อมูลอ้างอิงตัวเชื่อมต่อ
  4. ผู้ใช้ URL ของ Linking API ต้องมีสิทธิ์เข้าถึงข้อมูลที่กำหนดค่าไว้ใน URL ของ Linking API หากผู้ใช้ไม่มีสิทธิ์เข้าถึงข้อมูลพื้นฐาน คอมโพเนนต์รายงานที่ขึ้นต่อกันจะแสดงข้อผิดพลาด

พารามิเตอร์ URL

URL ของ Linking API ต้องอยู่ในรูปแบบต่อไปนี้

https://lookerstudio.google.com/reporting/create?parameters

คาดว่า URL จะใช้ในบริบทของเว็บเบราว์เซอร์ โดยปกติแล้วผู้ใช้จะคลิกลิงก์หรือถูกเปลี่ยนเส้นทางไปยัง URL นอกจากนี้ยังใช้เพื่อ ฝังรายงานได้ด้วย

URL ตัวอย่าง

ตัวอย่าง URL ของ Linking API มีดังนี้ ระบบจะตั้งชื่อรายงานและกำหนดค่าแหล่งข้อมูล 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

พารามิเตอร์ URL บางรายการเป็นพารามิเตอร์ที่จำเป็น ในขณะที่บางรายการเป็นพารามิเตอร์ที่ไม่บังคับ ต่อไปนี้คือ รายการพารามิเตอร์ที่ใช้ในการกำหนด URL ของ Linking API

พารามิเตอร์การควบคุม

พารามิเตอร์ควบคุมจะกำหนดสถานะของรายงานเมื่อดูผ่าน URL ของ Linking API

ชื่อพารามิเตอร์ คำอธิบาย
c.reportId
ไม่บังคับ รหัสรายงานเทมเพลต Data Studio จะเปิดขึ้นและกำหนดค่า รายงานที่ระบุ ดูรายละเอียดวิธีค้นหารหัสได้ที่ รหัสรายงาน หากไม่ได้ระบุ ระบบจะใช้รายงานที่ว่างเปล่าหรือ เทมเพลตรายงานเริ่มต้น โปรดดูรายละเอียดที่ใช้ รายงานที่ว่างเปล่าหรือรายงานเริ่มต้น
c.pageId
ไม่บังคับ รหัสของหน้าแรกที่จะโหลดในรายงาน หากไม่ได้ระบุไว้ ค่าเริ่มต้นจะเป็นหน้าแรกของรายงาน
c.mode
ไม่บังคับ โหมดรายงานเริ่มต้น อย่างใดอย่างหนึ่งต่อไปนี้ view หรือ edit ค่าเริ่มต้นจะเป็น view หากไม่ได้ระบุไว้
c.explain
ไม่บังคับ ระดับการมองเห็นของกล่องโต้ตอบข้อมูล/การแก้ไขข้อบกพร่อง ตั้งค่าเป็น true เพื่อแสดงปุ่มกล่องโต้ตอบ หากไม่ได้ระบุ ค่าเริ่มต้นจะเป็น false ดูข้อมูลเพิ่มเติมได้ที่ การแก้ปัญหาการกำหนดค่า

ตัวอย่าง

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

พารามิเตอร์รายงาน

พารามิเตอร์รายงานจะลบล้างพร็อพเพอร์ตี้รายงาน

ชื่อพารามิเตอร์ คำอธิบาย
r.reportName
ไม่บังคับ ตั้งชื่อรายงาน หากไม่ได้ระบุ ระบบจะใช้ชื่อรายงานเทมเพลตเป็นค่าเริ่มต้น
r.measurementId

ไม่บังคับ ตั้งค่ารหัสการวัด Google Analytics เพื่อ วัด การใช้งานรายงาน ใช้เครื่องหมายคอมมาคั่นระหว่างรหัสหลายรายการ

หากไม่ได้ระบุ r.measurementId และ r.keepMeasurementId การตั้งค่ารายงานรหัสการวัดของ Google Analytics จะเป็นค่าเริ่มต้นที่ไม่ได้ตั้งค่า หากตั้งค่า r.measurementId และ r.keepMeasurementId ไว้ r.keepMeasurementId จะมีลำดับความสำคัญเหนือกว่าในการตั้งค่ารหัส
r.keepMeasurementId

ไม่บังคับ ตั้งค่าเป็น true เพื่อใช้รายงานเทมเพลต รหัสการวัดของ Google Analytics ค่าเริ่มต้นจะเป็น false หากไม่ได้ระบุไว้

หากไม่ได้ระบุ r.measurementId และ r.keepMeasurementId การตั้งค่ารายงานรหัสการวัดของ Google Analytics จะเป็นค่าเริ่มต้นที่ไม่ได้ตั้งค่า หากตั้งค่า r.measurementId และ r.keepMeasurementId ไว้ r.keepMeasurementId จะมีลำดับความสำคัญเหนือกว่าในการตั้งค่ารหัส

ตัวอย่าง

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

พารามิเตอร์แหล่งข้อมูล

พารามิเตอร์แหล่งข้อมูลช่วยให้คุณกำหนดค่าแหล่งข้อมูลและ ข้อมูลที่จะเข้าถึงสำหรับแหล่งข้อมูลในรายงานเทมเพลตได้

alias ใช้เพื่ออ้างอิงแหล่งข้อมูลในรายงานที่มีอยู่ การใช้นามแฝงจะช่วยให้มีความเข้ากันได้แบบย้อนหลังหากมีการเพิ่ม/นำแหล่งข้อมูลออกจากรายงานเทมเพลต

โปรดดูรายละเอียดเกี่ยวกับวิธีค้นหาแหล่งข้อมูล alias ที่หัวข้อนามแฝงของแหล่งข้อมูล

พารามิเตอร์แหล่งข้อมูล

พารามิเตอร์ต่อไปนี้เป็นพารามิเตอร์ทั่วไปในตัวเชื่อมต่อทุกประเภท

ชื่อ คำอธิบาย
ds.alias.datasourceName

ไม่บังคับ ตั้งชื่อแหล่งข้อมูล

หากไม่ได้ระบุ ds.datasourceName และ ds.keepDatasourceName ชื่อแหล่งข้อมูล จะใช้รูปแบบการตั้งชื่อเริ่มต้นซึ่งรวมถึงประเภทเครื่องมือเชื่อมต่อและ เวลาที่สร้าง (เช่น samples - 12/12/21, 10:53 PM) หากตั้งค่า ds.datasourceName และ ds.keepDatasourceName ds.datasourceName จะมีลำดับความสำคัญเหนือกว่าในการตั้งค่าชื่อแหล่งข้อมูล
ds.alias.keepDatasourceName

ไม่บังคับ ตั้งค่าเป็น true เพื่อใช้ชื่อแหล่งข้อมูลเทมเพลต ค่าเริ่มต้นจะเป็น false หากไม่ได้ระบุไว้

หากไม่ได้ระบุ ds.datasourceName และ ds.keepDatasourceName ชื่อแหล่งข้อมูล จะใช้รูปแบบการตั้งชื่อเริ่มต้นซึ่งรวมถึงประเภทเครื่องมือเชื่อมต่อและ เวลาที่สร้าง (เช่น samples - 12/12/21, 10:53 PM) หากตั้งค่า ds.datasourceName และ ds.keepDatasourceName ds.datasourceName จะมีลำดับความสำคัญเหนือกว่าในการตั้งค่าชื่อแหล่งข้อมูล
ds.alias.connector
ไม่บังคับ

ประเภทเครื่องมือเชื่อมต่อของแหล่งข้อมูล ดูข้อมูลเพิ่มเติมเกี่ยวกับ ประเภทตัวเชื่อมต่อที่รองรับได้ที่ข้อมูลอ้างอิง ตัวเชื่อมต่อ

หากตั้งค่าไว้ คุณต้องระบุ พารามิเตอร์ของเครื่องมือเชื่อมต่อที่จำเป็นทั้งหมดสำหรับประเภทเครื่องมือเชื่อมต่อใน URL ของ Linking API และการกำหนดค่าแหล่งข้อมูลเทมเพลตจะ ถูกแทนที่ทั้งหมด

หากไม่ได้ระบุ คุณจะระบุ พารามิเตอร์ตัวเชื่อมต่อตั้งแต่ 0 รายการขึ้นไปสำหรับประเภทตัวเชื่อมต่อได้ใน URL ของ Linking API ระบบจะใช้การกำหนดค่าแหล่งข้อมูลเทมเพลตเพื่อ ระบุพารามิเตอร์ที่ไม่ได้ระบุใน URL ของ Linking API ดูรายละเอียด เกี่ยวกับวิธีระบุประเภทเครื่องมือเชื่อมต่อของแหล่งข้อมูลเทมเพลตได้ที่ ประเภทเครื่องมือเชื่อมต่อ

ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีที่พารามิเตอร์ ds.connector ส่งผลต่อ การแทนที่การกำหนดค่าแหล่งข้อมูลเทมเพลตทั้งหมด หรือใช้เพื่ออัปเดตพารามิเตอร์ที่ไม่ได้ระบุได้ที่ แทนที่เทียบกับอัปเดต
ds.alias.refreshFields
ไม่บังคับ

ตั้งค่าเป็น true เพื่อใช้การกำหนดค่าแหล่งข้อมูล ที่ระบุผ่าน Linking API เพื่อ รีเฟรช ฟิลด์แหล่งข้อมูลและอัปเดตคอมโพเนนต์รายงานด้วยฟิลด์ใหม่ ที่เลือก true โดยปกติจะ ระบุเมื่อเปลี่ยนประเภทเครื่องมือเชื่อมต่อหรือ สำหรับประเภทเครื่องมือเชื่อมต่อที่การเปลี่ยนแปลงการกำหนดค่าทำให้เกิดฟิลด์ที่แตกต่างกัน (เช่น ฟิลด์สำหรับแหล่งข้อมูล BigQuery มักจะเปลี่ยนแปลงตามการกำหนดค่าตารางที่แตกต่างกัน)

ตั้งค่าเป็น false เพื่อปล่อยให้ฟิลด์แหล่งข้อมูล ไม่เปลี่ยนแปลงจากรายงานเทมเพลต โดยปกติแล้ว false จะระบุเมื่อการกำหนดค่าข้อมูลใหม่ให้ผลลัพธ์เป็นช่องที่เหมือนกันทุกประการ และคุณต้องการคงการเปลี่ยนแปลงช่องที่ทำกับแหล่งข้อมูลเทมเพลตไว้

หากไม่ได้ระบุ ค่าเริ่มต้นจะแตกต่างกันไปตามประเภทตัวเชื่อมต่อ ดูค่าเริ่มต้นเฉพาะของเครื่องมือเชื่อมต่อใน ข้อมูลอ้างอิงของเครื่องมือเชื่อมต่อในกรณีที่คุณต้องการลบล้างลักษณะการทํางานเริ่มต้น

ข้อควรพิจารณาเมื่อใช้ refreshFields
  • หากตั้งค่า refreshFields เป็น false และการกำหนดค่าแหล่งข้อมูลที่ระบุผ่าน Linking API ให้ฟิลด์แตกต่างจากที่ใช้ในรายงานเทมเพลต ผู้ใช้มีแนวโน้มที่จะเห็นข้อผิดพลาดในการกำหนดค่าสำหรับคอมโพเนนต์ที่ได้รับผลกระทบ
  • การเปลี่ยนแปลงฟิลด์ในแหล่งข้อมูลเทมเพลต (เช่น ชื่อ ประเภท การรวม ฯลฯ) จะไม่ส่งผลต่อแหล่งข้อมูลใหม่เมื่อตั้งค่า refreshFields เป็น true ตั้งค่า refreshFields เป็น false เพื่อรักษาการกำหนดค่าฟิลด์ จากแหล่งข้อมูลเทมเพลต
  • ฟิลด์ที่คํานวณแล้วและ พารามิเตอร์ที่กําหนดไว้ในแหล่งข้อมูลเทมเพลตจะได้รับการคัดลอกไปยัง แหล่งข้อมูลที่สร้างขึ้นใหม่เสมอ และจะไม่ได้รับผลกระทบจากค่าของ refreshFields
ds.alias.connectorParameters
ต้องระบุ การกำหนดค่าแหล่งข้อมูลสำหรับ ประเภทเครื่องมือเชื่อมต่อ ดูรายละเอียดวิธีระบุ เครื่องมือเชื่อมต่อที่ใช้สร้างแหล่งข้อมูลได้ที่ ประเภทเครื่องมือเชื่อมต่อ ดูรายละเอียดเกี่ยวกับพารามิเตอร์แหล่งข้อมูลที่มีให้สำหรับเครื่องมือเชื่อมต่อแต่ละประเภทได้ที่ข้อมูลอ้างอิงของเครื่องมือเชื่อมต่อ

แทนที่เทียบกับอัปเดต - การกำหนดค่าแหล่งข้อมูล

เมื่อตั้งค่าพารามิเตอร์แหล่งข้อมูล การมีหรือไม่มีพารามิเตอร์ ds.connector ใน URL ของ Linking API จะบ่งบอกถึงความตั้งใจที่จะแทนที่หรืออัปเดตการกำหนดค่าแหล่งข้อมูลเทมเพลตตามลำดับ

ตารางต่อไปนี้แสดงรายละเอียดว่าพารามิเตอร์ ds.connector ส่งผลต่อการแทนที่การกำหนดค่าแหล่งข้อมูลเทมเพลตทั้งหมดหรือใช้เพื่ออัปเดตพารามิเตอร์ที่ไม่ได้ระบุอย่างไร

ตั้งค่า ds.connector แล้วใช่ไหม การกำหนดค่าและลักษณะการทำงานที่คาดไว้ การใช้งานทั่วไป
ใช่ แทนที่ ระบบจะแทนที่การกำหนดค่าแหล่งข้อมูลเทมเพลตทั้งหมดโดยใช้พารามิเตอร์แหล่งข้อมูลที่ระบุใน URL ของ Linking API คุณต้องระบุพารามิเตอร์ที่จำเป็นทั้งหมดสำหรับ ประเภทตัวเชื่อมต่อ ดูพารามิเตอร์ที่จำเป็นเมื่อ ds.connector ตั้งค่า
  • เมื่อเปลี่ยนประเภทเครื่องมือเชื่อมต่อของแหล่งข้อมูล เช่น หากคุณ กําหนดค่าแหล่งข้อมูล BigQuery ในรายงานเทมเพลต แต่ต้องการ กําหนดค่าแหล่งข้อมูลชีตผ่าน Linking API ซึ่งจะต้อง กำหนดค่าตัวเชื่อมต่อใหม่ทั้งหมด
  • เมื่อคุณต้องการรับประกันการกำหนดค่าแหล่งข้อมูล การแทนที่การกำหนดค่าจะหลีกเลี่ยงการใช้ค่าที่ไม่รู้จักซึ่งอาจ มาจากแหล่งข้อมูลเทมเพลต
ไม่ อัปเดต ระบบจะใช้การกำหนดค่าแหล่งข้อมูลเทมเพลตเพื่อ ระบุพารามิเตอร์ที่ไม่ได้ระบุใน URL ของ Linking API พารามิเตอร์ของหัวต่อ ทั้งหมดสำหรับประเภทหัวต่อเป็นพารามิเตอร์ที่ไม่บังคับ เว้นแต่จะระบุไว้เป็นอย่างอื่น

วิธีนี้จะช่วยลดความซับซ้อนของ URL ของ Linking API และโดยทั่วไปเราขอแนะนำให้ใช้เมื่อคุณ คุ้นเคยกับการกำหนดค่าแหล่งข้อมูลเทมเพลต และต้องการ ลบล้างพารามิเตอร์เพียงบางส่วนเท่านั้น
  • เมื่อคุณต้องการระบุเฉพาะค่าพารามิเตอร์ที่แตกต่างจาก แหล่งข้อมูลเทมเพลต และยอมรับที่จะใช้แหล่งข้อมูลเทมเพลต สำหรับพารามิเตอร์ตัวเชื่อมต่อที่ไม่ได้ระบุ เช่น เปลี่ยนเฉพาะ รหัสโปรเจ็กต์การเรียกเก็บเงินของการกำหนดค่าแหล่งข้อมูล BigQuery และใช้ การกำหนดค่าเทมเพลตสำหรับพารามิเตอร์อื่นๆ ทั้งหมด

พารามิเตอร์ที่จำเป็นเมื่อตั้งค่า ds.connector

หากมีการระบุพารามิเตอร์ ds.connector ของแหล่งข้อมูล จะต้องระบุพารามิเตอร์เครื่องมือเชื่อมต่อทั้งหมดที่กำหนดเป็นต้องระบุสำหรับแหล่งข้อมูล หากไม่ได้ระบุพารามิเตอร์ ds.connector ของแหล่งข้อมูล พารามิเตอร์ตัวเชื่อมต่อทั้งหมด แม้แต่พารามิเตอร์ที่กำหนดให้เป็นพารามิเตอร์ที่จำเป็น ก็จะถือเป็นพารามิเตอร์ที่ไม่บังคับ เว้นแต่จะระบุไว้เป็นอย่างอื่น

ตัวอย่าง

กำหนดค่ารายงานที่มีแหล่งข้อมูล BigQuery แหล่งเดียว (ds0) และแทนที่ การกำหนดค่าแหล่งข้อมูลทั้งหมด

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

คุณละเว้นชื่อแทนแหล่งข้อมูลได้เมื่อรายงานมีแหล่งข้อมูลเดียว URL ด้านบนสามารถย่อให้สั้นลงได้ดังนี้

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

กำหนดค่ารายงานที่มีแหล่งข้อมูล BigQuery เดียว (ds0) และ อัปเดตเฉพาะรหัสโปรเจ็กต์การเรียกเก็บเงินของ แหล่งข้อมูล

https://lookerstudio.google.com/reporting/create?
  c.reportId=12345
  &r.reportName=MyNewReport
  &ds.ds0.billingProjectId=my-billing-project

กําหนดค่ารายงานที่มีแหล่งข้อมูล 2 แหล่ง ได้แก่ แหล่งข้อมูล BigQuery (ds0) และแหล่งข้อมูล Google Analytics (ds1) การกําหนดค่าแหล่งข้อมูล BigQuery จะถูกแทนที่ทั้งหมด ในขณะที่การกําหนดค่า Google Analytics จะอัปเดตพารามิเตอร์เดียวและใช้แหล่งข้อมูลเทมเพลต ds1 สําหรับพารามิเตอร์เครื่องมือเชื่อมต่อที่ไม่ได้ระบุ

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

สร้างกับเพิ่ม

บางครั้งการมีแหล่งข้อมูลเดียวกันในหลายรายงานก็มีประโยชน์ เพื่อให้การอัปเดตแหล่งข้อมูลส่งผลต่อรายงานทั้งหมดพร้อมกัน เมื่อสร้างรายงานด้วย Linking API คุณจะเพิ่มแหล่งข้อมูลจากรายงานเทมเพลตอีกครั้งได้โดยตรวจสอบว่าตรงตามเงื่อนไขต่อไปนี้ทั้งหมด

  1. แหล่งข้อมูลนำมาใช้ซ้ำได้ (ดูแหล่งข้อมูลที่ฝังกับแหล่งข้อมูลที่นำมาใช้ซ้ำได้)
  2. URL ไม่ได้อ้างอิงแหล่งข้อมูลตามชื่อแทน
  3. URL ไม่ได้ใช้นามแฝงไวลด์การ์ด (ดูไวลด์การ์ดนามแฝงแหล่งข้อมูล)

เมื่อสร้างแหล่งข้อมูลใหม่ด้วย Linking API ระบบจะใช้ข้อมูลเข้าสู่ระบบของผู้ใช้ที่คลิก URL ซึ่งหมายความว่าผู้ใช้ต้องมีสิทธิ์เข้าถึงข้อมูลพื้นฐาน มิเช่นนั้นการเชื่อมต่อจะไม่ทำงาน การเพิ่มแหล่งข้อมูลลงในรายงานที่สร้างขึ้นใหม่จะช่วยให้คุณเก็บข้อมูลเข้าสู่ระบบของแหล่งข้อมูลไว้ได้ เพื่อให้ผู้ใช้เข้าถึงข้อมูลในรายงานใหม่ได้ต่อไป

ไวลด์การ์ดชื่อแทนแหล่งข้อมูล

หากต้องการใช้พารามิเตอร์ Linking API กับแหล่งข้อมูลหลายแหล่ง คุณสามารถใช้ชื่อแทนสัญลักษณ์แทน ds.*แทนชื่อแทนแหล่งข้อมูลได้

ซึ่งอาจมีประโยชน์ในการนำพารามิเตอร์ที่ซ้ำกันออกจาก URL ตัวอย่างเช่น หากคุณมีเทมเพลตที่แนบแหล่งข้อมูล BigQuery 3 รายการ และต้องการแทนที่ projectId และ datasetId ในแต่ละรายการ แต่เก็บ tableId ไว้ คุณสามารถเขียนได้ดังนี้

  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

หรือจะใช้ URL ที่เทียบเท่านี้ก็ได้โดยใช้ไวลด์การ์ด ds.*

  https://lookerstudio.google.com/reporting/create?
  c.reportId=7890
  &ds.*.projectId=client-project
  &ds.*.datasetId=client-dataset

พารามิเตอร์ที่ระบุใน Linking API ซึ่งไม่ได้ใช้ไวลด์การ์ด ds.* จะมีความสำคัญมากกว่าพารามิเตอร์ที่ใช้ ในตัวอย่างด้านบน คุณสามารถเพิ่มนามแฝงแหล่งข้อมูลที่เฉพาะเจาะจงเพื่อลบล้างค่าจากไวลด์การ์ดได้

  https://lookerstudio.google.com/reporting/create?
  c.reportId=7890
  &ds.*.projectId=client-project
  &ds.*.datasetId=client-dataset
  &ds.ds1.datasetId=client-dataset

โดยทั่วไปแล้ว ลำดับความสำคัญของพารามิเตอร์มีดังนี้

  1. พารามิเตอร์ที่ระบุด้วยนามแฝงที่เฉพาะเจาะจง (ds.ds1.datasetId)
  2. พารามิเตอร์ที่ระบุโดยใช้ไวลด์การ์ด (ds.*.datasetId)
  3. ค่าที่ได้จากแหล่งข้อมูลเทมเพลต หากไม่ได้ระบุ ds.connector (ดูแทนที่เทียบกับการอัปเดต)
  4. ค่าเริ่มต้นของพารามิเตอร์ (หากเป็นพารามิเตอร์ที่ไม่บังคับ)

ข้อมูลอ้างอิงของเครื่องมือเชื่อมต่อ

Linking API รองรับตัวเชื่อมต่อและการกำหนดค่าต่อไปนี้ สำหรับ ตัวเชื่อมต่อแต่ละตัว จะมีรายการพารามิเตอร์แหล่งข้อมูลที่ใช้ได้

BigQuery

ตัวเชื่อมต่อ BigQuery รองรับการค้นหา 2 ประเภท ได้แก่ TABLE ซึ่งคุณระบุรหัสตารางของตารางที่จะค้นหา และ CUSTOM_QUERY ซึ่งคุณระบุคำสั่ง SQL เพื่อค้นหาตาราง

การค้นหาตาราง

พารามิเตอร์ต่อไปนี้จะมีผลเมื่อตั้งค่า type เป็น TABLE และคุณระบุรหัสของตารางที่จะค้นหา

ชื่อพารามิเตอร์ คำอธิบาย
ds.alias.connector
ไม่บังคับ ตั้งค่าเป็น bigQuery สำหรับ เครื่องมือเชื่อมต่อ BigQuery

หากตั้งค่าไว้ จะแทนที่แหล่งข้อมูลด้วย การกำหนดค่า BigQuery ที่ระบุ ดูการแทนที่กับการอัปเดต
ds.alias.type
ต้องระบุ** ประเภทการค้นหา ตั้งค่าเป็น TABLE
ds.alias.projectId
ต้องระบุ** รหัสโปรเจ็กต์ของตาราง ที่จะค้นหา
ds.alias.datasetId
ต้องระบุ** รหัสชุดข้อมูลของตารางที่จะ ค้นหา
ds.alias.tableId
ต้องระบุ** รหัสตารางของตารางที่จะ ค้นหา

ตารางที่แบ่งตามวันที่:
ระบบรองรับ * (อักขระไวด์การ์ด) หรือคำต่อท้าย YYYYMMDD เมื่อค้นหาตารางที่แบ่งตามวันที่
หากระบบระบุตารางเป็น Google Analytics, Firebase Analytics หรือ Firebase Crashlytics ระบบจะเลือกเทมเพลตฟิลด์เริ่มต้น เว้นแต่จะมีการระบุไว้ ดูพารามิเตอร์ที่เกี่ยวข้องกับตารางเทมเพลตฟิลด์
ds.alias.billingProjectId
ไม่บังคับ รหัสของโปรเจ็กต์ที่จะใช้สำหรับการเรียกเก็บเงิน หากไม่ได้ตั้งค่า ระบบจะใช้ projectId
ds.alias.isPartitioned
ไม่บังคับ ตั้งค่าเป็น true หากตารางได้รับการแบ่งพาร์ติชันและคุณ ต้องการใช้คอลัมน์การแบ่งพาร์ติชันเป็นมิติข้อมูลช่วงวันที่ ซึ่งใช้ได้กับการแบ่งพาร์ติชันตามเวลาเท่านั้น (เช่น การใช้คอลัมน์การแบ่งพาร์ติชันตามเวลาหรือ_PARTITIONTIME Pseudocolumn) และใช้ไม่ได้กับตารางที่แบ่งพาร์ติชันช่วงจำนวนเต็ม หากไม่ได้ระบุ ค่าเริ่มต้นจะเป็น false ดูข้อมูลเพิ่มเติมได้ที่ ข้อมูลเบื้องต้นเกี่ยวกับตารางที่แบ่งพาร์ติชันแล้ว
ds.alias.refreshFields
ไม่บังคับ ค่าเริ่มต้นจะเป็น true หากไม่ได้ระบุไว้ ดูรายละเอียดได้ที่ refreshFields
เทมเพลตฟิลด์สําหรับ Google Analytics, Firebase Analytics และ Crashlytics

สําหรับตารางที่ระบุว่าเป็น Google Analytics, Firebase Analytics หรือ Firebase Crashlytics จะมีพารามิเตอร์เพิ่มเติมให้ตั้งค่าเทมเพลตฟิลด์ หากไม่ได้ระบุไว้ ระบบจะเลือกเทมเพลตเริ่มต้น

ชื่อ คำอธิบาย
ds.alias.gaTemplateLevel
ไม่บังคับ เทมเพลตช่อง Google Analytics ที่จะใช้ ใช้ได้เฉพาะ เมื่อมีการค้นหาตาราง BigQuery Export สำหรับ Google Analytics หนึ่งใน ALL, SESSION, HITS สําหรับตาราง Google Analytics ค่าเริ่มต้นจะเป็น ALL หากไม่ได้ระบุ
ds.alias.firebaseTemplateLevel
ไม่บังคับ เทมเพลตช่อง Firebase Analytics ที่จะใช้ ใช้ได้ เฉพาะเมื่อมีการค้นหา BigQuery Export สำหรับตาราง Firebase Analytics ตั้งค่าได้เป็น EVENTS เท่านั้น สําหรับตาราง Firebase Analytics ค่าเริ่มต้นจะเป็น EVENTS หากไม่ได้ระบุ
ds.alias.crashlyticsTemplateLevel
เทมเพลตฟิลด์ Firebase Crashlytics ที่จะใช้ ตั้งค่าได้เฉพาะ DEFAULT ใช้ได้เฉพาะเมื่อมีการค้นหา BigQuery Export สำหรับตาราง Firebase Crashlytics สำหรับตาราง Firebase Crashlytics ค่าเริ่มต้นจะเป็น DEFAULT หากไม่ได้ระบุไว้

คำค้นหาที่กำหนดเอง

พารามิเตอร์ต่อไปนี้จะมีผลเมื่อตั้งค่า type เป็น CUSTOM_QUERY และคุณระบุคำสั่ง SQL เพื่อค้นหาตาราง

ชื่อพารามิเตอร์ คำอธิบาย
ds.alias.connector
ไม่บังคับ ตั้งค่าเป็น bigQuery สำหรับ เครื่องมือเชื่อมต่อ BigQuery

หากตั้งค่าไว้ จะแทนที่แหล่งข้อมูลด้วย การกำหนดค่า BigQuery ที่ระบุ ดูการแทนที่กับการอัปเดต
ds.alias.type
ต้องระบุ** ประเภทการค้นหา ตั้งค่าเป็น CUSTOM_QUERY
ds.alias.sql
ต้องระบุ** การค้นหา SQL ที่จะเรียกใช้
ds.alias.billingProjectId
ไม่บังคับ รหัสของโปรเจ็กต์ที่จะใช้สำหรับการเรียกเก็บเงิน หากไม่ได้ตั้งค่า ระบบจะใช้ projectId หากไม่ได้ตั้งค่า projectId ระบบจะใช้โปรเจ็กต์ของตารางที่ค้นหา
ds.alias.sqlReplace

ไม่บังคับ รายการสตริงรูปแบบและสตริงแทนที่ที่คั่นด้วยคอมมาเพื่อ ใช้กับคำค้นหา SQL ระบบจะใช้การแทนที่สตริงก็ต่อเมื่อมีการ จับคู่รูปแบบเท่านั้น ใช้คอมมาเพื่อคั่นคู่สตริงรูปแบบและสตริงแทนที่ เช่น stringPattern1,replacementString1, stringPattern2,replacementString2
ds.alias.refreshFields
ไม่บังคับ ค่าเริ่มต้นจะเป็น true หากไม่ได้ระบุไว้ ดูรายละเอียดได้ที่ refreshFields

ตัวอย่าง

การกำหนดค่าประเภท TABLE ซึ่งมีการกำหนดการค้นหาด้วยรหัสตาราง

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

การกำหนดค่าประเภท TABLE เพื่อค้นหาตารางที่แบ่งพาร์ติชันตามวันที่โดยใช้คำต่อท้ายที่เป็นอักขระไวลด์การ์ด 

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_*

การกำหนดค่าประเภท TABLE เพื่อค้นหาตารางที่แยกส่วนตามวันที่โดยใช้คำต่อท้าย 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

TABLEการกำหนดค่าประเภทเพื่อค้นหาตาราง BigQuery Export สำหรับ Google Analytics โดยใช้เทมเพลตฟิลด์ 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

การกำหนดค่าประเภท TABLE เพื่อค้นหาตารางที่แบ่งพาร์ติชันตามเวลาในการนำเข้าและ ใช้คอลัมน์การแบ่งพาร์ติชันเป็นมิติข้อมูลช่วงวันที่

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

CUSTOM_QUERYการกำหนดค่าประเภทที่กำหนดคำค้นหาด้วยคำสั่ง 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

การกำหนดค่าประเภท CUSTOM_QUERY ที่อัปเดตเฉพาะคำสั่ง SQL และใช้แหล่งข้อมูลเทมเพลตสำหรับการกำหนดค่าที่เหลือ

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.sql=SELECT%20corpus%20FROM%20%60bigquery-public-data.samples.shakespeare%60

การกำหนดค่าประเภท CUSTOM_QUERY ซึ่งมีการอัปเดตคำสั่ง SQL ของแหล่งข้อมูลเทมเพลตโดยใช้ 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

ชื่อพารามิเตอร์ คำอธิบาย
ds.alias.connector
ไม่บังคับ ตั้งค่าเป็น cloudSpanner สำหรับ Cloud Spanner Connector

หากตั้งค่าไว้ จะแทนที่แหล่งข้อมูลด้วยการกำหนดค่า Cloud Spanner ที่ระบุ ดูการแทนที่กับการอัปเดต
ds.alias.projectId
ต้องระบุ** รหัสโปรเจ็กต์
ds.alias.instanceId
ต้องระบุ** รหัสอินสแตนซ์
ds.alias.databaseId
ต้องระบุ** รหัสฐานข้อมูล
ds.alias.sql
ต้องระบุ** การค้นหา SQL ที่จะเรียกใช้
ds.alias.refreshFields
ไม่บังคับ ค่าเริ่มต้นจะเป็น true หากไม่ได้ระบุไว้ ดูรายละเอียดได้ที่ refreshFields

ตัวอย่าง

การกำหนดค่า Cloud Spanner ด้วยคำสั่ง 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

ปลั๊กอินจากชุมชนสำหรับใช้ลิงก์ข้อมูล

ชื่อพารามิเตอร์ คำอธิบาย
ds.alias.connector
ไม่บังคับ ตั้งค่าเป็น community สำหรับ Community Connector

หากตั้งค่าไว้ จะแทนที่แหล่งข้อมูลด้วยการกำหนดค่า Community Connector ที่ระบุ ดูการแทนที่กับการอัปเดต
ds.alias.connectorId
ต้องระบุ** ตัวเชื่อมต่อชุมชน connectorId (หรือที่เรียกว่า deploymentId)
ds.alias.parameters
ไม่บังคับ พารามิเตอร์เพิ่มเติมที่เฉพาะเจาะจงสำหรับตัวเชื่อมต่อตามที่กำหนดโดย ตัวเชื่อมต่อชุมชน การกำหนดค่าตัวเชื่อมต่อ
ds.alias.refreshFields
ไม่บังคับ ค่าเริ่มต้นจะเป็น true หากไม่ได้ระบุไว้ ดูรายละเอียดได้ที่ refreshFields

ตัวอย่าง

เชื่อมต่อกับปลั๊กอินจากชุมชนสำหรับใช้ลิงก์ข้อมูลด้วยพารามิเตอร์การกำหนดค่า state และ 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

ชื่อพารามิเตอร์ คำอธิบาย
ds.alias.connector
ไม่บังคับ ตั้งค่าเป็น googleAnalytics สำหรับ ตัวเชื่อมต่อ Google Analytics

หากตั้งค่าไว้ จะแทนที่แหล่งข้อมูลด้วย การกำหนดค่า Google Analytics ที่ระบุ ดูการแทนที่กับการอัปเดต
ds.alias.accountId
ต้องระบุ** รหัสบัญชี
ds.alias.propertyId
ต้องระบุ** รหัสพร็อพเพอร์ตี้
ds.alias.viewId
รหัสข้อมูลพร็อพเพอร์ตี้
ต้องระบุ** สําหรับพร็อพเพอร์ตี้ Universal Analytics
ไม่ต้องตั้งค่าสําหรับพร็อพเพอร์ตี้ Google Analytics 4
ds.alias.refreshFields
ไม่บังคับ ค่าเริ่มต้นจะเป็น false หากไม่ได้ระบุไว้ ดูรายละเอียดได้ที่ refreshFields

ตัวอย่าง

การกําหนดค่า Google Analytics สําหรับพร็อพเพอร์ตี้ 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

การกำหนดค่า Google Analytics สำหรับพร็อพเพอร์ตี้ 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

ชื่อพารามิเตอร์ คำอธิบาย
ds.alias.connector
ไม่บังคับ ตั้งค่าเป็น googleCloudStorage Google Cloud Storage Connector

หากตั้งค่าไว้ จะแทนที่แหล่งข้อมูล ด้วยการกำหนดค่า Google Cloud Storage ที่ระบุ ดูการแทนที่กับการอัปเดต
ds.alias.pathType
ต้องระบุ** ประเภทเส้นทาง ใช้ FILE เพื่อเลือกไฟล์เดียวหรือ FOLDER เพื่อเลือก ไฟล์ทั้งหมดสำหรับเส้นทางที่ระบุ
ds.alias.path
ต้องระบุ** เส้นทางไฟล์ (เช่น MyBucket/MyData/MyFile.csv) หาก pathType เป็น FILE หรือเส้นทางโฟลเดอร์ (เช่น *MyBucket/MyData) หาก pathType เป็น FOLDER
ds.alias.refreshFields
ไม่บังคับ ค่าเริ่มต้นจะเป็น true หากไม่ได้ระบุไว้ ดูรายละเอียดได้ที่ refreshFields

ตัวอย่าง

การกำหนดค่า Google Cloud Storage สำหรับไฟล์เดียว

https://lookerstudio.google.com/reporting/create?
  c.reportId=231908kpf
  &ds.ds50.connector=googleCloudStorage
  &ds.ds50.pathType=FILE
  &ds.ds50.path=MyBucket%2FMyData%2FMyFile.csv

การกำหนดค่า Google Cloud Storage สำหรับไฟล์ทั้งหมดในเส้นทาง

https://lookerstudio.google.com/reporting/create?
  c.reportId=231908kpf
  &ds.ds50.connector=googleCloudStorage
  &ds.ds50.pathType=FOLDER
  &ds.ds50.path=MyBucket%2FMyData

Google ชีต

ชื่อพารามิเตอร์ คำอธิบาย
ds.alias.connector
ไม่บังคับ ตั้งค่าเป็น googleSheets สำหรับ Google ตัวเชื่อมต่อชีต

หากตั้งค่าไว้ จะแทนที่แหล่งข้อมูลด้วยการกำหนดค่า Google ชีตที่ ระบุ ดูการแทนที่กับการอัปเดต
ds.alias.spreadsheetId
ต้องระบุ** รหัสสเปรดชีต
ds.alias.worksheetId
ต้องระบุ** รหัสเวิร์กชีต
ds.alias.hasHeader
ไม่บังคับ ตั้งค่าเป็น true เพื่อใช้แถวแรกเป็นส่วนหัว ค่าเริ่มต้นจะเป็น true หากไม่ได้ระบุไว้ ส่วนหัวคอลัมน์ต้องไม่ซ้ำกัน ระบบจะไม่เพิ่มคอลัมน์ที่มีส่วนหัวว่างเปล่าลงในแหล่งข้อมูล
ds.alias.includeHiddenCells
ไม่บังคับ ตั้งค่าเป็น true เพื่อรวมเซลล์ที่ซ่อน ค่าเริ่มต้นจะเป็น true หากไม่ได้ระบุไว้
ds.alias.includeFilteredCell
ไม่บังคับ ตั้งค่าเป็น true เพื่อรวมเซลล์ที่กรอง ค่าเริ่มต้นจะเป็น true หากไม่ได้ระบุไว้
ds.alias.range
ไม่บังคับ ช่วง เช่น A1:B52
ds.alias.refreshFields
ไม่บังคับ ค่าเริ่มต้นจะเป็น true หากไม่ได้ระบุไว้ ดูรายละเอียดได้ที่ refreshFields

ตัวอย่าง

การกำหนดค่า Google ชีต

https://lookerstudio.google.com/reporting/create?
  c.reportId=101112jkl
  &ds.ds3.connector=googleSheets
  &ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
  &ds.ds3.worksheetId=903806437

การกำหนดค่า Google ชีตโดยใช้แถวแรกเป็นส่วนหัว รวมถึงเซลล์ที่ซ่อนและกรองแล้วมีดังนี้ 

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

การกำหนดค่า Google ชีตที่มีช่วง (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

ชื่อพารามิเตอร์ คำอธิบาย
ds.alias.connector
ไม่บังคับ ตั้งค่าเป็น looker สำหรับ เครื่องมือเชื่อมต่อ Looker

หากตั้งค่าไว้ จะแทนที่แหล่งข้อมูลด้วยการกำหนดค่า Looker ที่ ระบุ ดูการแทนที่กับการอัปเดต
ds.alias.instanceUrl
ต้องระบุ** URL ของอินสแตนซ์ Looker
ds.alias.model
ต้องระบุ** โมเดล Looker
ds.alias.explore
ต้องระบุ** การสำรวจ Looker
ds.alias.refreshFields
ไม่บังคับ ค่าเริ่มต้นจะเป็น false หากไม่ได้ระบุไว้ ดูรายละเอียดได้ที่ refreshFields

ตัวอย่าง

เชื่อมต่อกับ Looker Explore

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

ชื่อพารามิเตอร์ คำอธิบาย
ds.alias.connector
ไม่บังคับ ตั้งค่าเป็น searchConsole สำหรับ เครื่องมือเชื่อมต่อ Search Console

หากตั้งค่าไว้ จะแทนที่แหล่งข้อมูลด้วย การกำหนดค่า Search Console ที่ระบุ ดูการแทนที่กับการอัปเดต
ds.alias.siteUrl
ต้องระบุ** URL ของเว็บไซต์ สําหรับโดเมน พร็อพเพอร์ตี้ ให้ใส่sc-domain\:ไว้ข้างหน้า
ds.alias.tableType
ต้องระบุ** ตั้งค่าประเภทตาราง อาจเป็น SITE_IMPRESSION หรือ URL_IMPRESSION
ds.alias.searchType
ต้องระบุ** กำหนดประเภทการค้นหา อาจเป็น WEB, IMAGE, VIDEO หรือ NEWS
ds.alias.refreshFields
ไม่บังคับ ค่าเริ่มต้นจะเป็น false หากไม่ได้ระบุไว้ ดูรายละเอียดได้ที่ refreshFields

ตัวอย่าง

การกำหนดค่า Search Console สำหรับพร็อพเพอร์ตี้คำนำหน้า 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

การกำหนดค่า Search Console สำหรับพร็อพเพอร์ตี้โดเมน

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

สิทธิ์ของเทมเพลต

คุณต้องตั้งค่าสิทธิ์เข้าถึงรายงานสำหรับรายงานเทมเพลตและแหล่งข้อมูลที่เชื่อมโยงอย่างถูกต้องเพื่อให้ผู้ใช้ได้รับประสบการณ์การใช้งานที่ดีที่สุด สิทธิ์ที่จำเป็นจะขึ้นอยู่กับว่าเทมเพลตรายงาน ใช้แหล่งข้อมูลแบบฝังเทียบกับแหล่งข้อมูลที่ใช้ซ้ำได้ และการกำหนดค่า Linking API ตั้งค่าเป็นแทนที่หรืออัปเดตการกำหนดค่าแหล่งข้อมูลหรือไม่

ตารางต่อไปนี้แสดงการเข้าถึงแหล่งข้อมูลที่แนะนําเพื่อประสบการณ์ของผู้ใช้ที่ดีที่สุด โดยอิงตามแหล่งข้อมูลเทมเพลตและการกําหนดค่า Linking API

ประเภทแหล่งข้อมูล การกำหนดค่า API การลิงก์สำหรับแหล่งข้อมูล คำแนะนำเกี่ยวกับสิทธิ์ของแหล่งข้อมูล หมายเหตุ
แบบฝัง แทนที่ ไม่เกี่ยวข้อง - สิทธิ์ดูจะรับช่วงมาจากรายงาน หากผู้ใช้มีสิทธิ์ดูรายงานเทมเพลต ผู้ใช้จะมีสิทธิ์ดูแหล่งข้อมูลที่ฝังไว้โดยอัตโนมัติ
แบบฝัง อัปเดต ไม่เกี่ยวข้อง - สิทธิ์ดูจะรับช่วงมาจากรายงาน หากผู้ใช้มีสิทธิ์ดูรายงานเทมเพลต ผู้ใช้จะมีสิทธิ์ดูแหล่งข้อมูลที่ฝังไว้โดยอัตโนมัติ
นำกลับมาใช้ใหม่ได้ แทนที่ ผู้ใช้ไม่จำเป็นต้องมีสิทธิ์ดู เนื่องจากระบบจะแทนที่การกำหนดค่าแหล่งข้อมูลทั้งหมด ผ่าน Linking API จึงไม่จำเป็นต้องมีสิทธิ์ดู
นำกลับมาใช้ใหม่ได้ อัปเดต ผู้ใช้ต้องมีสิทธิ์ดู ต้องมีสิทธิ์ดูแหล่งข้อมูลเพื่อให้ Linking API อ่านและใช้การกำหนดค่าจากแหล่งข้อมูลเทมเพลตได้ หาก ผู้ใช้ไม่มีสิทธิ์เข้าถึงระดับดู ผู้ใช้จะได้รับข้อผิดพลาดเมื่อ โหลดรายงาน

ใช้รายงานเปล่าหรือรายงานเริ่มต้น

หากต้องการใช้รายงานเปล่าหรือรายงานเริ่มต้น ให้กำหนดค่า Linking API ดังนี้

ประเภทรายงาน ตั้งค่าพารามิเตอร์ควบคุม reportId ตั้งค่าพารามิเตอร์แหล่งข้อมูล (ds) หมายเหตุ
รายงานว่างเปล่า ไม่ ไม่
รายงานเริ่มต้น ไม่ ใช่

รายงานเริ่มต้นมาจาก Data Studio

คุณไม่จำเป็นต้องใช้ชื่อแทนแหล่งข้อมูลเมื่อระบุ พารามิเตอร์แหล่งข้อมูลสำหรับรายงานเริ่มต้น เนื่องจากรายงานเริ่มต้นมี แหล่งข้อมูลที่ฝังเพียงแหล่งเดียว

ตัวอย่างต่อไปนี้แสดง URL ของ Linking API ต่างๆ ที่ใช้รายงานที่ว่างเปล่าหรือรายงานเริ่มต้น

เริ่มเวิร์กโฟลว์การสร้างรายงานด้วยรายงานเปล่า

https://lookerstudio.google.com/reporting/create

เริ่มเวิร์กโฟลว์การสร้างรายงานด้วยรายงานเปล่าและตั้งชื่อรายงาน 

https://lookerstudio.google.com/reporting/create?r.reportName=MyNewReport

ใช้เทมเพลตรายงานเริ่มต้นกับการกำหนดค่าเครื่องมือเชื่อมต่อ Google ชีต

https://lookerstudio.google.com/reporting/create?
  ds.connector=googleSheets
  &ds.spreadsheetId=1Q-w7KeeJj1jk3wFcFm4NsPlppNscs0CtHf_EP9fsYOo
  &ds.worksheetId=0

ฝังรายงาน

หากต้องการฝังรายงานที่สร้างด้วย Linking API ให้ตั้งค่าพารามิเตอร์ URL และรวมเส้นทาง /embed/ URL การฝัง Linking API ต้องมีรูปแบบดังนี้

https://lookerstudio.google.com/embed/reporting/create?parameters

ค้นหารหัสและชื่อแทน

รหัสรายงาน

วิธีค้นหารหัสรายงาน

  1. เปิดรายงานที่ต้องการใช้เป็นเทมเพลต ตรวจสอบ URL ของรายงาน ส่วนระหว่าง reporting/ กับ /page คือรหัสรายงาน ตัวอย่างเช่น ใน URL ต่อไปนี้ 0B_U5RNpwhcE6SF85TENURnc4UjA คือรหัสรายงาน 
https://lookerstudio.google.com/reporting/0B_U5RNpwhcE6SF85TENURnc4UjA/page/1M
แถบที่อยู่ของเบราว์เซอร์แสดง URL ของรายงาน Data Studio ระบบจะไฮไลต์รหัสรายงาน
ค้นหารหัสรายงานใน URL ของรายงาน

ชื่อแทนแหล่งข้อมูล

รายงานมีแหล่งข้อมูลได้หลายแหล่ง ควรอ้างอิงแหล่งข้อมูลด้วยชื่อแทน

วิธีค้นหาชื่อแทนแหล่งข้อมูล

  1. แก้ไขรายงาน
  2. จากแถบเครื่องมือ ให้เลือกแหล่งข้อมูล > จัดการแหล่งข้อมูลที่เพิ่ม
  3. ตรวจสอบคอลัมน์ชื่อแทนเพื่อดูข้อมูลชื่อแทนของแหล่งข้อมูลแต่ละแหล่ง

คุณสามารถแก้ไขชื่อแทนเพื่อให้มั่นใจว่ามีความเข้ากันได้แบบย้อนหลังเมื่อมีการเพิ่มหรือนำแหล่งข้อมูลออก

รายการแหล่งข้อมูลในหน้าการจัดการทรัพยากรแหล่งข้อมูล คอลัมน์ชื่อแทนจะไฮไลต์อยู่
ค้นหาชื่อแทนแหล่งข้อมูลในหน้าการจัดการแหล่งข้อมูล

ประเภทหัวชาร์จไฟฟ้า

รายงานมีแหล่งข้อมูลได้หลายรายการ โดยแต่ละรายการสร้างขึ้นจากการกำหนดค่า ตัวเชื่อมต่อ วิธีค้นหาประเภทเครื่องมือเชื่อมต่อที่ใช้สร้างแหล่งข้อมูล

  1. แก้ไขรายงาน
  2. จากแถบเครื่องมือ ให้เลือกแหล่งข้อมูล > จัดการแหล่งข้อมูลที่เพิ่ม
  3. ตรวจสอบคอลัมน์ประเภทเครื่องมือเชื่อมต่อเพื่อระบุเครื่องมือเชื่อมต่อที่ใช้สร้างแหล่งข้อมูล
รายการแหล่งข้อมูลในหน้าการจัดการทรัพยากรแหล่งข้อมูล คอลัมน์ประเภทหัวชาร์จไฟฟ้าจะไฮไลต์อยู่
ค้นหาประเภทตัวเชื่อมต่อแหล่งข้อมูลในหน้าการจัดการแหล่งข้อมูล

เคล็ดลับและการแก้ปัญหา

หากพบปัญหา โปรดดูรายละเอียดด้านล่างเพื่อระบุปัญหาที่อาจเกิดขึ้น และการกำหนดค่าที่ไม่ถูกต้องที่พบบ่อย

กล่องโต้ตอบการแก้ไขข้อบกพร่อง

ใช้กล่องโต้ตอบการแก้ไขข้อบกพร่องเพื่อตรวจสอบการกำหนดค่า Linking API ตามที่ Data Studio ตีความ ซึ่งจะช่วยแก้ไขข้อบกพร่องของ API ได้

  • เมื่อพบข้อผิดพลาดขณะแยกวิเคราะห์ URL ของ Linking API กล่องโต้ตอบจะแสดงโดยอัตโนมัติพร้อมรายละเอียดเกี่ยวกับ ข้อผิดพลาด
  • เมื่อเกิดข้อผิดพลาดและไม่มีกล่องโต้ตอบแสดงขึ้นโดยอัตโนมัติ ให้มองหา ปุ่มข้อมูลที่ด้านขวาบนของรายงาน คลิกเพื่อดู ข้อมูลการแก้ไขข้อบกพร่องเพิ่มเติม
    ปุ่มข้อมูลเพื่อดูวิธีสร้างรายงาน
  • หากไม่มีปุ่มข้อมูล คุณสามารถเปิดใช้ปุ่มได้โดย ต่อพารามิเตอร์ &c.explain=true ท้าย URL ของ Linking API

สิทธิ์

ตรวจสอบว่าคุณได้ตั้งค่าสิทธิ์เทมเพลตที่ถูกต้องสำหรับประเภทแหล่งข้อมูล และการกำหนดค่า Linking API ดูรายละเอียดได้ที่สิทธิ์ของเทมเพลต

อัปเดตกับแทนที่

หากอัปเดตการกำหนดค่าแหล่งข้อมูลจากเทมเพลตแหล่งข้อมูล ให้ตรวจสอบ การกำหนดค่าแหล่งข้อมูลเทมเพลตและการกำหนดค่า API การลิงก์เพื่อให้แน่ใจว่า เข้ากันได้ ตรวจสอบว่าฟิลด์ที่ได้จากการกำหนดค่าใหม่ เข้ากันได้กับคอมโพเนนต์และการกำหนดค่ารายงาน

เมื่อทำการอัปเดตเทียบกับการแทนที่ คุณอาจตั้งค่าที่ไม่ถูกต้องซึ่งมีลักษณะการทำงานที่ไม่ได้กำหนดไว้ ดูรายละเอียดได้ที่ การแทนที่กับการอัปเดต

รีเฟรชฟิลด์

หากคุณกำหนดค่าชื่อฟิลด์ ประเภท หรือการรวมสำหรับแหล่งข้อมูลเทมเพลต การเปลี่ยนแปลงเหล่านี้จะส่งต่อไปยังแหล่งข้อมูลที่กำหนดค่า API การลิงก์ ก็ต่อเมื่อตั้งค่าพารามิเตอร์ ds.refreshFields เป็น false

ตรวจสอบพารามิเตอร์แหล่งข้อมูล ds.refreshFields ของ URL ของ Linking API หากละเว้น ให้ยืนยันว่าค่าเริ่มต้นของพารามิเตอร์สำหรับ ตัวเชื่อมต่อแต่ละประเภทถูกต้องสำหรับกรณีการใช้งานของคุณ

โดยทั่วไป หากคุณได้กำหนดค่าฟิลด์ในแหล่งข้อมูลเทมเพลตและมั่นใจว่าการกำหนดค่าแหล่งข้อมูลใหม่ผ่าน Linking API จะให้ฟิลด์เดียวกันทุกครั้ง ขอแนะนำให้ตั้งค่า refreshFields เป็น false

เช่น หากในระหว่างการสร้างเทมเพลตรายงาน Data Studio ระบุฟิลด์แหล่งข้อมูลหนึ่งๆ เป็นประเภทตัวเลข และคุณเปลี่ยนเป็นประเภทปี การเปลี่ยนแปลงการกำหนดค่าฟิลด์นี้จะกลายเป็นส่วนหนึ่งของแหล่งข้อมูลเทมเพลต แผนภูมิใดก็ตามในเทมเพลตรายงานที่ใช้ฟิลด์ที่แก้ไขแล้วจะ คาดหวังปี และหากแผนภูมิอิงตามเวลา แผนภูมิอาจไม่แสดงหากไม่มีข้อมูลดังกล่าว หากใช้ Linking API เพื่อระบุการกำหนดค่าแหล่งข้อมูลใหม่ที่ให้ฟิลด์เดียวกันทุกประการ จะมีผลลัพธ์ 2 อย่างตามค่าของพารามิเตอร์ refreshFields ดังนี้

  • หากตั้งค่าเป็น true การกำหนดค่าฟิลด์จากแหล่งข้อมูลเทมเพลตจะไม่โอน และแผนภูมิอาจโหลดไม่สำเร็จหากขึ้นอยู่กับการกำหนดค่าฟิลด์เดียวกัน (เช่น คาดว่าจะเป็นฟิลด์ประเภทปี)

  • หากตั้งค่าเป็น false การกำหนดค่าฟิลด์จากแหล่งข้อมูลเทมเพลต จะโอนไปยังแหล่งข้อมูลใหม่ และแผนภูมิรายงานจะได้รับ ฟิลด์เดียวกันที่มีการกำหนดค่าเดียวกันและโหลดสำเร็จ

ความคิดเห็นและการสนับสนุน

ใช้Issue Trackerเพื่อรายงานปัญหาเกี่ยวกับ Linking API หรือแสดงความคิดเห็น ดูการสนับสนุนเพื่อดูแหล่งข้อมูลทั่วไปเกี่ยวกับการขอรับความช่วยเหลือและการถามคำถาม

บันทึกการเปลี่ยนแปลง

2023-06-06

  • เพิ่มพารามิเตอร์รายงาน r.measurementId และ r.keepMeasurementId เพื่อกําหนดค่า การตั้งค่ารายงานรหัสการวัดของ Google Analytics
  • เพิ่ม ds.keepDatasourceName เพื่อควบคุมการนำชื่อแหล่งข้อมูลเทมเพลตกลับมาใช้ซ้ำ
  • เพิ่มส่วนฝังรายงาน
  • ตัวเชื่อมต่อ BigQuery
    • เพิ่ม sqlReplace แล้ว ช่วยให้คุณระบุรูปแบบและสตริงการแทนที่เพื่ออัปเดตคำค้นหา SQL ของเทมเพลตแหล่งข้อมูลได้

2023-05-22

2022-11-21

2022-11-14

2022-06-15

  • เลิกการทดสอบเบต้า
    • เราได้เปลี่ยนชื่อ Integration API เป็น Linking API แล้ว
    • API การลิงก์พ้นระยะเบต้าแล้ว
  • เพิ่มpageIdพารามิเตอร์ควบคุมเพื่อให้ลิงก์ไปยังหน้ารายงาน ที่เฉพาะเจาะจงได้
  • เพิ่มพารามิเตอร์ควบคุม mode เพื่อตั้งค่าสถานะรายงานเป็นโหมดดูหรือแก้ไขเมื่อโหลด
  • ตอนนี้คุณสามารถแทนที่การกำหนดค่าแหล่งข้อมูลทั้งหมดหรืออัปเดตบางส่วนได้แล้ว ลักษณะการทำงานนี้จะขึ้นอยู่กับว่ามีการตั้งค่าพารามิเตอร์ ds.connector หรือไม่ ดูรายละเอียดได้ที่แทนที่เทียบกับอัปเดต
  • ตอนนี้ระบบจะใช้เทมเพลตเริ่มต้นหากไม่ได้ระบุเทมเพลตรายงานโดยใช้พารามิเตอร์ c.reportId
  • เพิ่มds.refreshFieldsพารามิเตอร์แหล่งข้อมูล ซึ่งจะช่วยให้คุณควบคุมได้ว่าจะรีเฟรชฟิลด์แหล่งข้อมูลเมื่อโหลดการกำหนดค่าแหล่งข้อมูลหรือไม่
  • ตัวเชื่อมต่อ BigQuery
    • ไม่จำเป็นต้องระบุ projectId เมื่อตั้งค่า type เป็น CUSTOM_QUERY
    • เมื่อไม่ได้ตั้งค่า billingProjectId โปรเจ็กต์การเรียกเก็บเงินจะกลับไปใช้ projectId หรือโปรเจ็กต์ของตารางที่ค้นหา
    • เพิ่มการรองรับตารางที่แบ่งพาร์ติชันตามวันที่ ตั้งค่าพารามิเตอร์ isPartitioned เป็น true เพื่อใช้ฟิลด์พาร์ติชันเป็นมิติข้อมูลช่วงวันที่
    • เพิ่มการรองรับการค้นหาตารางที่แบ่งพาร์ติชันตามวันที่โดยใช้ อักขระไวลด์การ์ดหรือคำต่อท้ายตาราง YYYYMMDD
    • เพิ่มการรองรับการค้นหาตาราง Google Analytics, Firebase Analytics หรือ Crashlytics และการเลือกเทมเพลตฟิลด์
  • Google ชีต
    • hasHeader มีค่าเริ่มต้นเป็น true ซึ่งสอดคล้องกับค่าเริ่มต้นของ UI บนเว็บ
    • includeHiddenAndFilteredCell แบ่งออกเป็น includeHiddenCells และ
    • includeFilteredCells ตอนนี้ทั้ง 2 อย่างจะใช้ true เป็นค่าเริ่มต้น ซึ่งสอดคล้องกับค่าเริ่มต้นของ UI บนเว็บ
  • เครื่องมือเชื่อมต่อ Search Console
    • เปลี่ยนชื่อพารามิเตอร์ propertyType เป็น searchType
  • ตัวเชื่อมต่อแบบสำรวจ
    • surveyId ตอนนี้ยอมรับรหัสแบบสำรวจรายการเดียวหรือรายการรหัสแบบสำรวจที่คั่นด้วยคอมมาแล้ว

2021-12-16

  • การเปิดตัว Integration API ครั้งแรก
    • รองรับการลิงก์ไปยังรายงานที่มีอยู่และการตั้งชื่อรายงาน
    • คุณกำหนดค่าแหล่งข้อมูลได้หลายรายการและตั้งชื่อแหล่งข้อมูลแต่ละรายการได้
    • รองรับเครื่องมือเชื่อมต่อประเภทต่อไปนี้: BigQuery, Cloud Spanner, Google Analytics, Google Cloud Storage, Google ชีต, Google Surveys, Search Console