הגדרה בסיסית

כדי להמשיך, חשוב לוודא שהשלמת את השלבים ב- דרישות מוקדמות ושאישרנו את הפרויקט שלכם עבור פרופיל העסק ב-Google גישה לממשקי API.

הפעלת ממשקי ה-API

יש שמונה ממשקי API שמשויכים לפרופיל העסק וצריך להפעיל אותם ב-Google API מסוף:

  • Google My Business API
  • ממשק ה-API לניהול חשבון העסק שלי
  • My Business Lodging API
  • My Business Place Actions API
  • My Business Notifications API
  • ממשק ה-API לאימות העסק שלי
  • ממשק ה-API של פרטי העסק שלי
  • ממשק API של שאלות ותשובות לעסק שלי

הפעלת API

אם ביצעתם את כל הפעולות דרישות קדם שקיבלו גישה ל-API, אבל עדיין אין להם אפשרות כדי להשתמש בקיצור הדרך שסופק, אפשר להפעיל את ה-API באופן ידני באמצעות השלבים הבאים.

כדי להפעיל API לפרויקט:

  1. פותחים את ספריית ה-API במסוף Google API. אם מתבקשים, בוחרים או ליצור פרויקט חדש. בספריית ה-API יש רשימה של כל האפשרויות הזמינות ממשקי API שמקובצים לפי משפחת המוצרים והפופולריות שלהם.
  2. אם ממשק ה-API שאתם רוצים להפעיל לא מופיע ברשימה, צריך להשתמש בחיפוש כדי למצוא אותו.
  3. בוחרים את ה-API שרוצים להפעיל ולוחצים על Enable (הפעלה). לחצן.
  4. אם מופיעה בקשה, מפעילים את החיוב.
  5. אם מופיעה בקשה, מאשרים את התנאים וההגבלות של ה-API.

אם אתם משתמשים ב-Google Workspace, עליכם לוודא שפרופיל העסק ב-Google מופעל בחשבון שלכם בארגון שלכם ב-Google Workspace. אם פרופיל העסק ב-Google מושבת בחשבון שלך בארגון ב-Google Workspace, ההודעה 'שגיאה 403 – הרשאה DENIED' תוצג כשמשתמשים בממשקי ה-API של GBP.

בקשת מזהה לקוח ב-OAuth 2.0

מאחר שהאפליקציה שלך ניגשת לנתונים מוגנים שאינם ציבוריים, עליך מזהה הלקוח של OAuth 2.0. הפעולה הזו מאפשרת לאפליקציה לבקש הרשאה לגשת לנתוני המיקום של הארגון בשם משתמשי האפליקציה שלך.

האפליקציה שלך צריכה לשלוח אסימון OAuth 2.0 עם כל בקשה של ממשקי Business Profile API שניגשת לנתונים פרטיים של משתמש.

אם עדיין לא עשיתם זאת, עוברים לקטע 'פרטי כניסה'. בקטע של Google API Console ולוחצים יצירת פרטי כניסה > מזהה הלקוח ב-OAuth כדי ליצור את פרטי הכניסה של OAuth 2.0. אחרי שיצרתם את פרטי הכניסה, תוכלו לראות את מזהה הלקוח בדף Credentials. לוחצים על מזהה לקוח לפרטים, כמו סוד לקוח, מזהי URI להפניה אוטומטית, כתובת מקורות של JavaScript ואימייל address.

העקרונות הבסיסיים של REST

יש שתי דרכים להפעיל את ממשקי ה-API:

אם תחליטו לא להשתמש בספריות לקוח, תצטרכו להבין את העקרונות הבסיסיים של REST.

REST הוא סגנון של ארכיטקטורת תוכנה שמאפשר גישה נוחה ועקבית לבקש נתונים ולשנות אותם.

המונח REST הוא קיצור של "העברה של מצב ייצוג". בהקשר של Google APIs, לשימוש בפעלים של HTTP כדי לאחזר ולשנות ייצוגים של נתונים ש-Google מאחסנת.

מערכת RESTful מאחסנת משאבים במאגר נתונים. לקוח שולח בקשה השרת לצורך ביצוע פעולה מסוימת, כגון יצירה, אחזור, עדכון או מחיקה של משאב, והשרת מבצע את הפעולה ושולח תגובה. בדרך כלל התגובה הזו מוצגת בצורה של ייצוג בווקטור של המשאב שצוין.

בממשקי RESTful API של Google, הלקוח מציין פעולה עם פועל HTTP, כמו GET, POST, PUT או DELETE. הלקוח מציין משאב לפי מזהה משאב אחיד (URI) ייחודי גלובלי בפורמט הבא:

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

מכיוון שלכל משאבי ה-API יש מזהה URI ייחודי שאפשר לגשת אליו באמצעות HTTP, ב-REST אפשר לשמור נתונים במטמון מותאמות במיוחד לעבודה עם התשתית המבוזרת של האינטרנט.

אפשר למצוא הגדרות method במשאבי העזרה של תקני HTTP 1.1 שימושי. הם כוללים מפרטים של GET, POST, PUT וגם DELETE

REST בממשקי ה-API של פרופיל העסק ב-Google

הפעולות של ממשקי ה-API של פרופיל העסק ב-Google ממופות ישירות לפעלים מסוג REST HTTP.

הפורמט הספציפי של ממשקי Business Profile API מוצג ב-URI הבא:

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

הקבוצה המלאה של מזהי URI שמשמשים לכל פעולה נתמכת בממשקי ה-API מופיעה בממשקי ה-API של פרופיל העסק מסמכי תיעוד של קובצי עזר.

נתיבי המשאבים משתנים בהתאם לנקודת הקצה.

למשל, נתיב המשאב לחשבון מופיע בדוגמה הבאה:

accounts/accountId

נתיב המשאב של מיקום מופיע בצורה הבאה:

locations/locationId

העקרונות הבסיסיים של JSON

ממשקי ה-API של 'פרופיל העסק ב-Google' מחזירים נתונים בפורמט JSON.

JavaScript Object Notation (JSON) הוא פורמט נתונים נפוץ ובלתי תלוי בשפה, מספקת ייצוג טקסט פשוט של מבני נתונים שרירותיים. מידע נוסף זמין במאמר הבא: json.org.

שימוש ב-OAuth Playground כדי לשלוח בקשת HTTP פשוטה

אפשר להשתמש OAuth 2.0 Playground כדי להתנסות בממשקי ה-API של פרופיל העסק ב-Google. כי ממשקי ה-API של פרופיל העסק ב-Google הם לא ממשקי API ציבוריים. יש כמה פעולות נוספות שצריך לבצע כדי להשתמש בהם ב-Playground. שלך נדרש מזהה לקוח לאפליקציית אינטרנט כדי להמשיך.

  1. עוברים אל Google API Console ופותחים את הפרויקט. אם אין לכם מזהה לקוח OAuth לאפליקציות אינטרנט, אפשר ליצור אחד עכשיו:
    1. ברשימה הנפתחת Create credentials, בוחרים באפשרות OAuth client ID.
    2. בקטע Application type לוחצים על Web Application.

    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, מדביקים את ההיקף הבא של ממשקי API של פרופיל העסק בשדה הזנת היקפים משלכם:

    https://www.googleapis.com/auth/business.manage
  7. לוחצים על Authorize APIs.
  8. כשמופיעה בקשה, לוחצים על אישור.

  9. בקטע 'שלב 2 – הגדרת הבקשה ל-API', מדביקים את ה-URI הבא השדה URI של הבקשה: 

    https://mybusinessaccountmanagement.googleapis.com/v1/accounts
  10. לוחצים על שליחת הבקשה. הסטטוס של התגובה צריך להיות 200 OK.

כדי לקבל מידע נוסף על שליחת סוגים שונים של בקשות, אפשר לעיין במאמר: חומר העזר בנושא ממשקי ה-API של פרופיל העסק ב-Google.

ספריות לקוח

ספריות הלקוח של ממשקי ה-API של 'פרופיל העסק ב-Google' תומכות בפונקציונליות של ממשקי ה-API של 'פרופיל העסק ב-Google'. הם מספקים פונקציונליות שמשותף לכל ממשקי ה-API של Google, כמו העברת HTTP, טיפול בשגיאות, אימות, וניתוח JSON.

כדי להוריד ספריות לקוח, ראו ספריות.