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

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

เปิดใช้ API

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

  • Google My Business API
  • API การจัดการบัญชี My Business
  • API ที่พัก My Business
  • API การดำเนินการของ My Business Place
  • My Business Notifications API
  • API การยืนยันธุรกิจของฉัน
  • API ข้อมูลทางธุรกิจของฉัน
  • API ถาม& ตอบของ My Business

เปิดใช้ 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 - PERMISSION DENIED" เมื่อใช้ 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 เป็นคำสั้นๆ ของ "การโอนสถานะตัวแทน" ในบริบทของ 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 ใน API ของ Business Profile

การดำเนินการของ 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

สร้างคำขอ HTTP แบบง่าย

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

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

    3. เพิ่ม URL การเปลี่ยนเส้นทางต่อไปนี้เป็น 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

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