סקירה כללית על Google Chat API

בדף הזה מופיעה סקירה כללית על השימוש ב-Google Chat API ועל מסמכי העיון שלו.

ל-Google Chat API יש ממשקי gRPC ו-REST, וגם ספריות לקוח שתומכות בשניהם. לחלופין, אם ספריות הלקוח שסופקו לא מתאימות לצרכים שלכם, אתם יכולים לכתוב ספריות לקוח משלכם שמשתמשות בממשק gRPC או REST.

ספריות לקוח

הדרך המומלצת לרוב המפתחים לקרוא ל-Google Chat API היא באמצעות ספריות הלקוח של Cloud שנתמכות באופן רשמי בשפה המועדפת עליכם, כמו Python,‏ Java או Node.js.

אם אתם כותבים קוד באמצעות Google Apps Script, אתם יכולים להשתמש בשירות המתקדם של Chat במקום להתקין ספריית לקוח.

סוג, שיטה ושמות שדות

הסוג, השיטה ושמות השדות של Google Chat API משתנים בהתאם לשימוש בספריות לקוח, ב-gRPC או ב-REST:

  • ספריות הלקוח ב-Cloud מסודרות לפי שירותי gRPC והשיטות שלהם. ספריות הלקוח של Google API מסודרות כשירותים שמכילים אובייקטים או מחלקות שתואמים למשאבי REST, שמכילים גם שיטות תואמות.
  • פרוטוקול gRPC מסודר לפי שירותים והשיטות שלהם.
  • ממשק REST מסודר לפי היררכיות של משאבים והשיטות שלהם.
  • שמות השדות ב-gRPC הם בפורמט snake case.
  • שמות השדות ב-REST הם בפורמט CamelCase, אבל שירות ה-API יקבל גם פורמט CamelCase וגם פורמט SnakeCase.
  • שמות השדות בספריית הלקוח הם באותיות רישיות בתחילת כל מילה, בשיטת Camel Case או בשיטת Snake Case, בהתאם לשם שמתאים לשפה.

מאגרי אחסון לפרוטוקולים

בין אם אתם משתמשים בספריות לקוח, ב-REST או ב-gRPC, השירות הבסיסי מוגדר באמצעות מאגרי פרוטוקולים. באופן ספציפי, השירות משתמש ב-proto3.

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

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

גרסאות API

הגרסאות הבאות של ה-API זמינות:

  • v1: יציבה.

תצוגה מקדימה למפתחים

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