בדף הזה תוכלו לקרוא סקירה כללית על השימוש ב-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 נעשה שימוש באותיות גדולות בלבד, אבל שירות ה-API יקבל את אחד מהשניים. קאמל קייס או נרתיק של נחש.
- בשמות של שדות בספריית הלקוח נעשה שימוש באותיות גדולות בלבד, באותיות רישיות או בקאמל קייס של נחש, בהתאם לשם האידיומטי של השפה.
מאגרי נתונים זמניים של פרוטוקולים
לא משנה אם אתם משתמשים בספריות לקוח, ב-REST או ב-gRPC, השירות הבסיסי מוגדרים באמצעות מאגרי פרוטוקולים. באופן ספציפי, השירות משתמש ב-proto3.
כשמבצעים קריאה ל-API, חלק מהשדות של הבקשה או התגובה עשויים לדרוש הבנה סוגים ידועים של מאגרי נתונים זמניים של פרוטוקולים.
בנוסף, כשקוראים ל-API ל-REST, ההתנהגות של ערך ברירת המחדל בפרוטוקול מאגרי נתונים זמניים עלולים לגרום לכך שיהיו שדות חסרים בתגובת JSON. השדות האלה מוגדרים לערך ברירת המחדל, כך שהם לא ייכללו בתשובה.
גרסאות API
אלה גרסאות ה-API הזמינות:
- v1: יציב.
תצוגה מקדימה למפתחים
במסמכים ייתכן שתראו שיטות או שדות של API זמינה דרך התוכנית 'תצוגה מקדימה למפתחים'. כדי לבדוק, לראות תצוגה מקדימה ולהציע את המשוב על התכונות החדשות ביותר בגרסת טרום-השקה (Preview), תוכנית התצוגה המקדימה למפתחים.