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