หากต้องการดำเนินการต่อ ให้ตรวจสอบว่าคุณได้ทำตามขั้นตอนใน ข้อกำหนดเบื้องต้นและเราได้อนุมัติโปรเจ็กต์สำหรับ Business Profile แล้ว การเข้าถึง API
เปิดใช้ 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 สำหรับโปรเจ็กต์ของคุณ ให้ทำดังนี้
- เปิดไลบรารี API ในคอนโซล Google API หากได้รับข้อความแจ้ง ให้เลือก หรือสร้างโปรเจ็กต์ใหม่ ไลบรารี API แสดงรายการทั้งหมดที่มี API ที่จัดกลุ่มตามกลุ่มผลิตภัณฑ์และความนิยม
- หากไม่เห็น API ที่ต้องการเปิดใช้ในรายการ ให้ใช้การค้นหาเพื่อ หาเจอ
- เลือก API ที่ต้องการเปิดใช้ แล้วคลิกเปิดใช้
- หากได้รับข้อความแจ้ง ให้เปิดใช้การเรียกเก็บเงิน
- หากได้รับข้อความแจ้ง ให้ยอมรับข้อกำหนดในการให้บริการของ 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 Console แล้วคลิก สร้างข้อมูลเข้าสู่ระบบ > รหัสไคลเอ็นต์ OAuth สำหรับสร้างข้อมูลเข้าสู่ระบบ OAuth 2.0 หลังจากที่คุณ สร้างข้อมูลเข้าสู่ระบบแล้ว คุณจะเห็นรหัสไคลเอ็นต์ในหน้าข้อมูลเข้าสู่ระบบ คลิก รหัสไคลเอ็นต์สำหรับรายละเอียด เช่น รหัสลับไคลเอ็นต์, URI การเปลี่ยนเส้นทาง, ที่อยู่ของต้นทาง JavaScript และอีเมล อีเมล
ดูข้อมูลพื้นฐานเกี่ยวกับ REST
การเรียก API ทำได้ 2 วิธีดังนี้
- ส่งคำขอ HTTP และแยกวิเคราะห์การตอบกลับ
- ใช้ไลบรารีของไคลเอ็นต์
หากตัดสินใจไม่ใช้ไลบรารีของไคลเอ็นต์ คุณต้องเข้าใจพื้นฐานของ REST
REST คือรูปแบบสถาปัตยกรรมซอฟต์แวร์ที่ให้แนวทางที่สะดวกและสอดคล้องกันใน ส่งคำขอและแก้ไขข้อมูล
คำว่า REST ย่อมาจาก "Agentational State Transfer" ในบริบทของ Google API เพื่อใช้คำกริยา HTTP เพื่อดึงและแก้ไขการนำเสนอข้อมูลที่ Google จัดเก็บไว้
ระบบ RESTful จัดเก็บทรัพยากรไว้ในพื้นที่เก็บข้อมูล ลูกค้าส่งคำขอสำหรับ เซิร์ฟเวอร์เพื่อดำเนินการบางอย่าง เช่น สร้าง เรียก อัปเดต หรือลบทรัพยากร และเซิร์ฟเวอร์จะดำเนินการดังกล่าวและส่งการตอบกลับ คำตอบดังกล่าวมักจะอยู่ในรูปแบบของ การแสดงทรัพยากรที่ระบุ
ใน RESTful API ของ Google ไคลเอ็นต์จะระบุการทำงานด้วยคำกริยา HTTP เช่น
GET, POST, PUT หรือ DELETE ไคลเอ็นต์ระบุ
ทรัพยากรโดย Uniform Resource Identifier (URL) ที่ไม่ซ้ำกันทั่วโลกในรูปแบบต่อไปนี้
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 ขั้นตอนเพื่อใช้ API ใน Playground คุณ ต้องการรหัสไคลเอ็นต์สำหรับเว็บแอปพลิเคชันเพื่อดำเนินการต่อ
- ไปที่คอนโซล Google API และเปิดโปรเจ็กต์ หากไม่มีรหัสไคลเอ็นต์ OAuth สำหรับเว็บแอปพลิเคชัน ให้สร้างรหัสใหม่ ในขณะนี้:
- จากรายการแบบเลื่อนลงสร้างข้อมูลเข้าสู่ระบบ ให้เลือกรหัสไคลเอ็นต์ OAuth
- ในส่วนประเภทแอปพลิเคชัน ให้คลิกเว็บแอปพลิเคชัน
เพิ่มข้อมูลต่อไปนี้เป็น URI การเปลี่ยนเส้นทางที่ถูกต้อง
https://developers.google.com/oauthplayground
- คลิกสร้าง
- คัดลอกรหัสไคลเอ็นต์ไปยังคลิปบอร์ด
- ไปที่ OAuth 2.0 Playground
- คลิกไอคอนรูปเฟืองเพื่อเปิดตัวเลือกการกำหนดค่าและทำการเปลี่ยนแปลงต่อไปนี้
- ตั้งค่าขั้นตอน OAuth เป็นฝั่งไคลเอ็นต์
- เลือกใช้ข้อมูลเข้าสู่ระบบ OAuth ของคุณเอง
- วางรหัสไคลเอ็นต์ OAuth
- ปิดตัวเลือกการกำหนดค่า
ใต้ "ขั้นตอนที่ 1 - เลือกและ ให้สิทธิ์ API" วางขอบเขตต่อไปนี้สำหรับ Business Profile API ในช่องป้อนขอบเขตของคุณเอง ให้ทำดังนี้
https://www.googleapis.com/auth/business.manage
- คลิกให้สิทธิ์ API
- คลิกยอมรับเมื่อมีข้อความแจ้ง
-
ใต้ "ขั้นตอนที่ 2 - กำหนดค่าคำขอไปยัง API" ให้วาง URI ต่อไปนี้ใน ช่อง URL คำขอ:
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- คลิกส่งคำขอ คำตอบควรแสดงสถานะ
200 OK
สำหรับข้อมูลเพิ่มเติมเกี่ยวกับวิธีส่งคำขอประเภทต่างๆ โปรดดู เอกสารอ้างอิง Business Profile API
ไลบรารีของไคลเอ็นต์
ไลบรารีของไคลเอ็นต์ Business Profile API รองรับฟังก์ชันการทำงานของ Business Profile API ซึ่งมี ฟังก์ชันทั่วไปของ Google API ทั้งหมด เช่น การส่งผ่าน HTTP, การจัดการข้อผิดพลาด, การตรวจสอบสิทธิ์ และการแยกวิเคราะห์ JSON
หากต้องการดาวน์โหลดไลบรารีของไคลเอ็นต์ โปรดดูไลบรารี