การตั้งค่าพื้นฐาน

หากต้องการดําเนินการต่อ โปรดตรวจสอบว่าคุณได้ทำตามขั้นตอนในข้อกําหนดเบื้องต้นจนเสร็จสมบูรณ์และเราอนุมัติโปรเจ็กต์ของคุณสําหรับการเข้าถึง Business Profile API แล้ว

เปิดใช้ API

มี API 8 รายการที่เชื่อมโยงกับ Business Profile ซึ่งต้องเปิดใช้ในคอนโซล Google API ดังนี้

  • Google My Business API
  • My Business Account Management API
  • My Business Lodging API
  • My Business Place Actions API
  • My Business Notifications API
  • My Business Verifications API
  • My Business Business Information API
  • My Business Q&A API

เปิดใช้ API

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

หากต้องการเปิดใช้ API สําหรับโปรเจ็กต์ ให้ทําดังนี้

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

หากคุณเป็นผู้ใช้ Google Workspace ให้ตรวจสอบว่าเปิด Google Business Profile ให้กับบัญชีของคุณแล้วในองค์กร Google Workspace คุณจะได้รับ "ข้อผิดพลาด 403 - ปฏิเสธสิทธิ์" เมื่อใช้ GBP API หาก Google Business Profile ปิดอยู่สำหรับบัญชีของคุณในองค์กร Google Workspace

ขอรหัสไคลเอ็นต์ OAuth 2.0

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

แอปพลิเคชันต้องส่งโทเค็น OAuth 2.0 มาพร้อมกับคำขอ Business Profile API ทั้งหมดที่เข้าถึงข้อมูลส่วนตัวของผู้ใช้

หากยังไม่ได้ดำเนินการ ให้ไปที่ส่วน "ข้อมูลเข้าสู่ระบบ" ของคอนโซล Google API แล้วคลิกสร้างข้อมูลเข้าสู่ระบบ > รหัสไคลเอ็นต์ OAuth เพื่อสร้างข้อมูลเข้าสู่ระบบ OAuth 2.0 หลังจากสร้างข้อมูลเข้าสู่ระบบแล้ว คุณจะเห็นรหัสไคลเอ็นต์ในหน้าข้อมูลเข้าสู่ระบบ คลิกรหัสไคลเอ็นต์เพื่อดูรายละเอียด เช่น ข้อมูลลับไคลเอ็นต์, เปลี่ยนเส้นทาง URI, ที่อยู่ต้นทางของ JavaScript และอีเมล

ดูข้อมูลเบื้องต้นเกี่ยวกับ REST

การเรียกใช้ API มี 2 วิธีดังนี้

หากตัดสินใจว่าจะไม่ใช้ไลบรารีไคลเอ็นต์ คุณจะต้องเข้าใจพื้นฐานของ REST

REST เป็นรูปแบบสถาปัตยกรรมซอฟต์แวร์ที่ให้แนวทางที่สะดวกและสอดคล้องกันในการขอและแก้ไขข้อมูล

REST ย่อมาจาก "Representational State Transfer" ในบริบทของ Google API หมายถึงการใช้คํากริยา HTTP เพื่อดึงข้อมูลและแก้ไขการนําเสนอข้อมูลที่ Google จัดเก็บไว้

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

ใน RESTful API ของ Google ไคลเอ็นต์จะระบุการดำเนินการด้วยคำกริยา HTTP เช่น GET, POST, PUT หรือ DELETE โดยระบุทรัพยากรด้วยรหัส Uniform Resource Identifier (URI) ที่ไม่ซ้ำกันทั่วโลกในรูปแบบต่อไปนี้

https://apiName.googleapis.com/apiVersion/resourcePath?parameters

เนื่องจากทรัพยากร API ทั้งหมดมี URI ที่เข้าถึงได้ผ่าน HTTP ที่ไม่ซ้ำกัน REST จึงเปิดใช้การแคชข้อมูลและได้รับการเพิ่มประสิทธิภาพให้ทำงานร่วมกับโครงสร้างพื้นฐานแบบกระจายของเว็บ

คุณอาจพบว่าคําจํากัดความของเมธอดในเอกสารประกอบมาตรฐาน HTTP 1.1 มีประโยชน์ ซึ่งรวมถึงข้อกำหนดเฉพาะสำหรับ GET, POST, PUT และ DELETE

REST ใน Business Profile API

การดำเนินการของ Business Profile API จะเชื่อมโยงกับคํากริยา HTTP ของ REST โดยตรง

รูปแบบที่เฉพาะเจาะจงสำหรับ Business Profile API จะแสดงใน URI ต่อไปนี้

https://apiName.googleapis.com/apiVersion/resourcePath?parameters

URI ทั้งหมดที่ใช้สําหรับการดำเนินการที่รองรับแต่ละรายการใน API จะปรากฏในเอกสารอ้างอิงของ Business Profile API

เส้นทางทรัพยากรจะแตกต่างกันไปตามอุปกรณ์ปลายทาง

เช่น เส้นทางทรัพยากรไปยังบัญชีจะปรากฏดังตัวอย่างต่อไปนี้

accounts/accountId

เส้นทางทรัพยากรของสถานที่จะปรากฏในรูปแบบต่อไปนี้

locations/locationId

ดูข้อมูลเบื้องต้นเกี่ยวกับ JSON

Business Profile API จะแสดงผลข้อมูลในรูปแบบ JSON

JavaScript Object Notation (JSON) เป็นรูปแบบข้อมูลที่พบได้ทั่วไปซึ่งไม่ขึ้นอยู่กับภาษา โดยแสดงโครงสร้างข้อมูลที่กําหนดเองเป็นข้อความอย่างง่าย ดูข้อมูลเพิ่มเติมได้ที่ json.org

ใช้ Oauth Playground เพื่อทำคำขอ HTTP ง่ายๆ

คุณสามารถใช้ OAuth 2.0 Playground เพื่อทดสอบ Business Profile API เนื่องจาก Business Profile API ไม่ใช่ API สาธารณะ คุณจึงต้องทำตามขั้นตอนเพิ่มเติมอีก 2-3 ขั้นตอนเพื่อใช้ใน Playground คุณต้องมีรหัสไคลเอ็นต์สําหรับเว็บแอปพลิเคชันเพื่อดําเนินการต่อ

  1. ไปที่คอนโซล Google API แล้วเปิดโปรเจ็กต์ หากไม่มีรหัสไคลเอ็นต์ OAuth สําหรับเว็บแอปพลิเคชัน ให้สร้างรหัสดังกล่าวเลยโดยทำดังนี้
    1. เลือกรหัสไคลเอ็นต์ OAuth จากรายการแบบเลื่อนลงสร้างข้อมูลเข้าสู่ระบบ
    2. ในส่วนประเภทแอปพลิเคชัน ให้คลิกเว็บแอปพลิเคชัน

    3. เพิ่ม URI การเปลี่ยนเส้นทางที่ถูกต้องต่อไปนี้

       https://developers.google.com/oauthplayground
    4. คลิกสร้าง
  2. คัดลอกรหัสไคลเอ็นต์ไปยังคลิปบอร์ด
  3. ไปที่ OAuth 2.0 Playground
  4. คลิกไอคอนรูปเฟืองเพื่อเปิดตัวเลือกการกําหนดค่าและทําการเปลี่ยนแปลงต่อไปนี้
    1. ตั้งค่าขั้นตอน OAuth เป็นฝั่งไคลเอ็นต์
    2. เลือกใช้ข้อมูลเข้าสู่ระบบ OAuth ของคุณเอง
    3. วางรหัสไคลเอ็นต์ OAuth
  5. ปิดตัวเลือกการกําหนดค่า

  6. ในส่วน "ขั้นตอนที่ 1 - เลือกและให้สิทธิ์ API" ให้วางขอบเขตต่อไปนี้สําหรับ Business Profile API ลงในช่องป้อนขอบเขตของคุณเอง

    https://www.googleapis.com/auth/business.manage
  7. คลิกให้สิทธิ์ API
  8. คลิกยอมรับเมื่อมีข้อความแจ้ง

  9. ในส่วน "ขั้นตอนที่ 2 - กำหนดค่าคำขอไปยัง API" ให้วาง URI ต่อไปนี้ลงในช่องคำขอ URI 

    https://mybusinessaccountmanagement.googleapis.com/v1/accounts
  10. คลิกส่งคำขอ การตอบกลับควรแสดงสถานะเป็น 200 OK

ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีส่งคําขอประเภทต่างๆ ได้ที่ข้อมูลอ้างอิง Business Profile API

ไลบรารีของไคลเอ็นต์

ไลบรารีของไคลเอ็นต์ Business Profile API รองรับฟังก์ชันการทำงานของ Business Profile API ซึ่งให้ฟังก์ชันการทำงานที่เหมือนกันกับ Google API ทั้งหมด เช่น การรับส่ง HTTP, การจัดการข้อผิดพลาด, การตรวจสอบสิทธิ์ และการแยกวิเคราะห์ JSON

หากต้องการดาวน์โหลดไลบรารีของไคลเอ็นต์ โปรดดูคลัง