API ของ Looker Studio

Looker Studio API ช่วยให้คุณค้นหาและจัดการเนื้อหา Looker Studio ได้

กรณีการใช้งานหลักสําหรับ API คือการอนุญาตให้องค์กร Google Workspace หรือ Cloud Identity จัดการและย้ายข้อมูลชิ้นงาน Looker Studio โดยอัตโนมัติ

ภาพรวมของข้อกําหนด

จําเป็นต้องมีขั้นตอนต่อไปนี้เพื่อใช้ Looker Studio API

  1. กําหนดค่าแอปให้ใช้ API
  2. ใช้คอนโซลผู้ดูแลระบบของ Google เพื่อให้สิทธิ์แอป
  3. รับโทเค็นเพื่อการเข้าถึง OAuth 2.0 และเรียกใช้ API

ขั้นตอนข้างต้นหรืออาจดําเนินการโดยองค์กรเดียวกัน หรือเป็นกรณีเฉพาะ โดยขึ้นอยู่กับสถานการณ์ทั่วไปต่อไปนี้

  • แอปภายในที่พัฒนาขึ้นสําหรับองค์กร องค์กรกําหนดค่าและให้สิทธิ์แอปแก่ผู้ใช้ทุกคนในองค์กร
  • แอปของบุคคลที่สามซึ่งพัฒนาสําหรับผู้ใช้/ลูกค้าภายนอก (เช่น นักพัฒนาซอฟต์แวร์และผู้ใช้อยู่ในองค์กรต่างๆ) นักพัฒนาซอฟต์แวร์กําหนดค่าแอปแต่องค์กรของผู้ใช้ให้สิทธิ์แอปของบุคคลที่สาม

1. กําหนดค่าแอปเพื่อใช้ API

ทําตามขั้นตอนต่อไปนี้เพื่อกําหนดค่าแอป

เปิดใช้ API

วิธีเปิดใช้ API สําหรับโปรเจ็กต์

  1. เปิด Looker Studio API ในคอนโซล Google API
  2. เมื่อระบบแจ้ง ให้เลือกโครงการ หรือสร้างโครงการใหม่
  3. คลิกเปิดใช้
  4. ถ้าได้รับข้อความแจ้ง ให้อ่านและยอมรับข้อกําหนดในการให้บริการของ API

สร้างไคลเอ็นต์ OAuth

ขั้นตอนต่อไปนี้เป็นขั้นตอนในการสร้างไคลเอ็นต์ OAuth และควรมีการปรับเปลี่ยนให้ตรงตามข้อกําหนดของแอป

  1. ไปที่กําหนดค่าหน้าจอคํายินยอม OAuth
    1. เลือกภายใน คลิกสร้าง
    2. กรอกข้อมูลในช่องที่ต้องกรอก แล้วคลิกบันทึก
  2. ไปที่ Credentials (ข้อมูลเข้าสู่ระบบ)
    1. คลิกสร้างข้อมูลรับรอง
    2. เลือกรหัสไคลเอ็นต์ OAuth
    3. เลือก Application Type ที่เหมาะสม (เว็บแอปพลิเคชันเป็นแอปพลิเคชันที่ใช้กันมากที่สุด)
    4. กรอกข้อมูลในช่องที่ต้องกรอก แล้วคลิกสร้าง
  3. จดบันทึกรหัสไคลเอ็นต์ เนื่องจากรหัสดังกล่าวใช้เพื่อให้สิทธิ์แอป

2. ให้สิทธิ์แอปสําหรับองค์กร

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

กําหนดค่าการมอบสิทธิ์ทั่วทั้งโดเมนด้วยรหัสไคลเอ็นต์ OAuth ของแอป และขอบเขตที่แอปกําหนด

  1. ลงชื่อเข้าใช้คอนโซลผู้ดูแลระบบของ Google และไปที่การมอบสิทธิ์ทั่วทั้งโดเมน
  2. ใน API clients ให้คลิกเพิ่มใหม่
  3. ป้อน Client ID ของแอปที่จะให้สิทธิ์ (เช่น แอปที่ใช้ API ของ Looker Studio)
  4. ป้อนขอบเขต OAuth ที่ทั้งหมดซึ่งแอปต้องการ มักมีการขอขอบเขตต่อไปนี้หากใช้ Looker Studio API เพื่อจัดการเนื้อหา
    • https://www.googleapis.com/auth/datastudio
    • https://www.googleapis.com/auth/userinfo.profile
  5. คลิกให้สิทธิ์

หลังจากให้สิทธิ์แอปแล้ว ผู้ใช้ Workspace ทุกคนในองค์กรจะได้รับอนุญาตให้ใช้แอปกับ Looker Studio API โดยอัตโนมัติ

3. การรับโทเค็นเพื่อการเข้าถึง OAuth 2.0 และเรียก API

เมื่อพัฒนาและให้สิทธิ์แอปแล้ว คุณจะมีสิทธิ์เรียก API สําหรับผู้ใช้ Workspace ได้ โปรดดูรายละเอียดเกี่ยวกับการทํางานกับ Google APIs โดยใช้ OAuth ที่การใช้ OAuth 2.0 เพื่อเข้าถึง Google API โปรดดูข้อมูลอ้างอิง API สําหรับการดําเนินการที่ใช้ได้

การแก้ปัญหา

ไม่มีกล่องโต้ตอบ OAuth

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

ข้อผิดพลาด 400: invalid_scope

หากผู้ใช้ได้รับข้อความ Error 400: invalid_scope เมื่อพยายามให้สิทธิ์แอป แสดงว่าองค์กรของผู้ใช้ไม่ได้ให้สิทธิ์แอปอย่างถูกต้องหรือไม่ถูกต้อง ปัญหานี้จะต้องขอให้องค์กรให้สิทธิ์แอปของตนเพื่อแก้ไขปัญหานี้

ข้อความแสดงข้อผิดพลาด OAuth 400 ที่ระบุว่ามีการขอขอบเขตที่ไม่ถูกต้อง