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

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

เปิดใช้ API

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

  • Google My Business API
  • API การจัดการบัญชี My Business
  • API ที่พักของ My Business
  • API การดำเนินการของสถานที่ใน My Business
  • My Business Notifications API
  • My Business Verification API
  • API ข้อมูลธุรกิจ My Business
  • 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" เมื่อใช้ API ของ GBP หากปิด 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 เป็นคำสั้นๆ ของ "Sentational State Transfer" ในบริบทของ Google APIs หมายถึงการใช้คำกริยา 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

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