מדריכים למתחילים מסבירים איך להגדיר ולהפעיל אפליקציה שמתקשרת Google Workspace API.
המדריכים למתחילים של Google Workspace משתמשים בספריות הלקוח של ה-API כדי לטפל פרטים על תהליך האימות וההרשאה. מומלץ להשתמש בספריות הלקוח עבור האפליקציות שלכם. המדריך למתחילים הזה משתמש גישת אימות פשוטה שמתאימה לבדיקות הסביבה. בסביבת ייצור, מומלץ ללמוד על אימות והרשאה לפני בחירת פרטי הכניסה שמתאימים לאפליקציה שלכם.
לכתוב Google Apps Script שמבצע בקשות ל-Google Chat API.
מטרות
- מגדירים את הסביבה.
- יוצרים את הסקריפט ומגדירים אותו.
- מריצים את הסקריפט.
דרישות מוקדמות
- חשבון Google Workspace מסוג Business או Enterprise עם גישה ל-Google Chat.
הגדרת הפרויקט ב-Cloud
אם אתם משתמשים בפרויקט חדש ב-Google Cloud כדי להשלים את המדריך למתחילים הזה, אתם צריכים: להגדיר אותו ולהוסיף את עצמכם כמשתמש לבדיקה. אם כבר השלמתם את השלבים האלה בפרויקט שלכם ב-Cloud, דלגו לחלק הבא.
פתיחת הפרויקט ב-Cloud במסוף Google Cloud
אם עדיין לא פתוח, פותחים את הפרויקט ב-Cloud שבו מתכוונים להשתמש. לדוגמה הזו:
- במסוף Google Cloud, נכנסים לדף Select a project.
- בוחרים את הפרויקט ב-Google Cloud שבו רוצים להשתמש. לחלופין, לוחצים על Create project (יצירת פרויקט) ופועלים לפי ההוראות במסך. אם אתם יוצרים פרויקט ב-Google Cloud, ייתכן שתצטרכו להפעיל את החיוב בפרויקט.
הפעלת Chat API
לפני שמשתמשים ב-Google APIs, צריך להפעיל אותם בפרויקט ב-Google Cloud. אפשר להפעיל ממשק API אחד או יותר בפרויקט אחד ב-Google Cloud.במסוף Google Cloud, מפעילים את Google Chat API.
הגדרת מסך ההסכמה של OAuth
- במסוף Google Cloud, נכנסים לתפריט > ממשקי API ו- שירותים > מסך ההסכמה של OAuth.
- בקטע סוג המשתמש, בוחרים באפשרות פנימי ולוחצים על יצירה.
- ממלאים את טופס הרישום של האפליקציה ולוחצים על שמירה והמשך.
בשלב הזה אפשר לדלג על הוספת היקפי הרשאות וללחוץ על שמירה והמשך. בעתיד, כשתיצרו אפליקציה לשימוש מחוץ ל- בארגון ב-Google Workspace, צריך לשנות את סוג המשתמש לחיצוני, ואז: להוסיף את היקפי ההרשאות שנדרשים לאפליקציה.
- מעיינים בסיכום של רישום האפליקציה. כדי לבצע שינויים, לוחצים על עריכה. אם האפליקציה ההרשמה נראית תקינה, לוחצים על חזרה ללוח הבקרה.
איך מגדירים את אפליקציית Google Chat
כדי לשלוח קריאה ל-Google Chat API, צריך להגדיר אפליקציית Google Chat. Google Chat – לכל בקשה לכתיבה שמשייך את אפליקציית Google Chat בממשק המשתמש באמצעות את הפרטים הבאים.
נכנסים לדף Configuration במסוף Google Cloud:
בקטע Application info (פרטי האפליקציה), מזינים את הפרטים הבאים:
- בשדה שם האפליקציה, מזינים
Chat API quickstart app
. - בשדה כתובת URL של הדמות, מזינים
https://developers.google.com/chat/images/quickstart-app-avatar.png
. - בשדה תיאור, מזינים
Quickstart for calling the Chat API
.
- בשדה שם האפליקציה, מזינים
בקטע תכונות אינטראקטיביות לוחצים על הפעלת תכונות אינטראקטיביות למצב מושבת כדי להשבית תכונות אינטראקטיביות אפליקציית Chat.
לוחצים על שמירה.
יצירת הסקריפט
- כדי ליצור סקריפט חדש, עוברים אל script.google.com/create.
- מחליפים את התוכן של עורך הסקריפטים בקוד הבא:
- לוחצים על 'שמירה'
.
- לוחצים על פרויקט ללא שם, מקלידים מדריך למתחילים, ולוחצים על שינוי שם.
הגדרת הסקריפט
העתקת מספר הפרויקט ב-Cloud
- במסוף Google Cloud, נכנסים לתפריט > IAM & אדמין > הגדרות.
- מעתיקים את הערך בשדה Project number.
מקשרים את הפרויקט ב-Google Cloud
- פותחים את פרויקט Apps Script.
- לוחצים על Project Settings (הגדרות הפרויקט) .
- בקטע פרויקט ב-Google Cloud Platform (GCP), לוחצים על שינוי פרויקט.
- בקטע מספר הפרויקט ב-GCP, מדביקים את מספר הפרויקט ב-Google Cloud.
- לוחצים על Set project (הגדרת פרויקט).
הפעלת Google Chat API
- פותחים את פרויקט Apps Script.
- לוחצים על Project Settings (הגדרות הפרויקט) .
- בקטע הגדרות כלליות, מפעילים את האפשרות הצגת 'appsscript.json'. קובץ מניפסט בעורך.
- לוחצים על עריכה
appscript.json
, ומחליפים את התוכן בקוד הבא:
, בוחרים את
הרצת הדוגמה
בעורך Apps Script, לוחצים על Run.
בפעם הראשונה שמריצים את הדוגמה, מוצגת בקשה לאשר גישה:
- לוחצים על בדיקת ההרשאות.
- בוחרים חשבון.
- לוחצים על אישור.
יומן הביצוע של הסקריפט יופיע בתחתית החלון.