בדף הזה נספק סקירה כללית על השימוש ב-Google Chat API ועל מסמכי העזרה שלו.
ל-Google Chat API יש ממשקים של gRPC ושל REST, וגם ספריות לקוח שתומכות בשניהם. אם ספריות הלקוח שסופקו לא עומדות בצרכים שלכם, תוכלו לכתוב ספריות לקוח משלכם שמשתמשות בממשק gRPC או REST.
ספריות לקוח
הדרך המומלצת לרוב המפתחים לבצע קריאה ל-Google Chat API היא באמצעות ספריות הלקוח של Cloud הנתמכות באופן רשמי בשפה המועדפת עליכם, כמו Python, Java או Node.js.
אם אתם כותבים קוד ב-Google Apps Script, השתמשו בשירות Chat המתקדם במקום להתקין ספריית לקוח.
שמות של טיפוסים, שיטות ושדות
בהתאם לשימוש בספריות לקוח, ב-gRPC או ב-REST, יש הבדלים מסוימים בסוג, בשיטה ובשמות השדות של Google Chat API:
- ספריות הלקוח ב-Cloud מסודרות לפי שירותי gRPC והשיטות שלהם. ספריות הלקוח של Google API מסודרות כשירותים שמכילים אובייקטים או שיעורים שתואמים למשאבי REST, שגם הם מכילים שיטות תואמות.
- ה-gRPC מסודר לפי שירותים והשיטות שלהם.
- ה-REST מחולק לפי היררכיות של משאבים והשיטות שלהם.
- בשמות השדות של gRPC נעשה שימוש בקו תחתון בין המילים.
- שמות השדות ב-REST נכתבים באותיות רישיות עם תחילית קטנה (camel case), אבל שירות ה-API יקבל גם שמות באותיות רישיות עם תחילית גדולה (snake case).
- שמות השדות בספריית הלקוח נכתבים באותיות רישיות, באותיות קטנות או באותיות קטנות עם מקף, בהתאם לשפה.
מאגרי אחסון לפרוטוקולים
בין שאתם משתמשים בספריות לקוח, ב-REST או ב-gRPC, השירות הבסיסי מוגדר באמצעות Protocol Buffers. באופן ספציפי, השירות משתמש ב-proto3.
כשקוראים ל-API, יכול להיות ששדות מסוימים של בקשות או תשובות ידרשו הבנה בסיסית של סוגים ידועים של מאגרי פרוטוקול.
בנוסף, כשקוראים ל-API ל-REST, התנהגות ערך ברירת המחדל של מאגרי הפרוטוקולים עלולה לגרום לשדות חסרים בתגובה בפורמט JSON. השדות האלה מוגדרים לערך ברירת המחדל, ולכן הם לא נכללים בתגובה.
גרסאות API
אלה גרסאות ה-API הזמינות:
- v1: יציבה.
תצוגה מקדימה למפתחים
במסמכי העזרה עשויים להופיע שדות או שיטות API שזמינים רק דרך תוכנית Developer Preview. כדי לבדוק את התכונות החדשות בגרסת הבטא, לקבל גישה לתצוגה המקדימה שלהן ולשלוח משוב, תוכלו להצטרף לתוכנית הבטא למפתחים.