מדריך למתחילים ב-Google Apps Script

יוצרים סקריפט של Google Apps שמבצע בקשות ל-Google Chat API.

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

ב-Apps Script, מדריכי ההתחלה המהירה של Google Workspace משתמשים בשירותי Google מתקדמים כדי לקרוא לממשקי ה-API של Google Workspace ולטפל בחלק מהפרטים של תהליך האימות וההרשאה.

מטרות

• מגדירים את הסביבה.
• יוצרים ומגדירים את הסקריפט.
• מריצים את הסקריפט.

דרישות מוקדמות

• פרויקט ב-Google Cloud.

• חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.

הגדרת הפרויקט ב-Cloud

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

פותחים את פרויקט Cloud במסוף Google Cloud

אם הוא לא פתוח, פותחים את פרויקט Cloud שבו רוצים להשתמש בדוגמה הזו:

1. נכנסים לדף Select a project במסוף Google Cloud.

   בוחרים פרויקט ב-Cloud

2. בוחרים את הפרויקט ב-Google Cloud שבו רוצים להשתמש. לחלופין, לוחצים על יצירת פרויקט ופועלים לפי ההוראות במסך. אם יוצרים פרויקט ב-Google Cloud, יכול להיות שיהיה צורך להפעיל את החיוב בפרויקט.

הפעלת Chat API

• במסוף Google Cloud, מפעילים את Google Chat API.

  להפעלת ה-API

הגדרת מסך ההסכמה של OAuth

1. במסוף Google Cloud, עוברים אל תפריט menu > > Branding.

   מעבר לדף 'מיתוג'

2. אם כבר הגדרתם את , תוכלו להגדיר את ההגדרות הבאות של מסך ההסכמה ל-OAuth בקטעים מיתוג, קהל וגישה לנתונים. אם מופיעה ההודעה עדיין לא הוגדר, לוחצים על תחילת העבודה:
1. בקטע App Information (פרטי האפליקציה), בשדה App name (שם האפליקציה), מזינים שם לאפליקציה.
2. בקטע כתובת אימייל לתמיכה במשתמשים, בוחרים כתובת אימייל לתמיכה שדרכה משתמשים יכולים ליצור איתכם קשר אם יש להם שאלות לגבי ההסכמה שלהם.
3. לוחצים על הבא.
4. בקטע קהל, בוחרים באפשרות פנימי.
5. לוחצים על הבא.
6. בקטע פרטים ליצירת קשר, מזינים כתובת אימייל שאליה אפשר לשלוח התראות על שינויים בפרויקט.
7. לוחצים על הבא.
8. בקטע סיום, קוראים את המדיניות של Google בנושא נתוני משתמשים בשירותי API. אם אתם מסכימים, מסמנים את התיבה אני מסכים/ה למדיניות של Google בנושא נתוני משתמשים בשירותי API.
9. לוחצים על המשך.
10. לוחצים על יצירה.
3. בינתיים, אפשר לדלג על הוספת היקפי הרשאות. בעתיד, כשתיצרו אפליקציה לשימוש מחוץ לארגון Google Workspace שלכם, תצטרכו לשנות את סוג המשתמש לחיצוני. לאחר מכן מוסיפים את היקפי ההרשאות שהאפליקציה דורשת. למידע נוסף, אפשר לעיין במדריך המלא בנושא הגדרת הסכמה ל-OAuth.

הגדרת האפליקציה של Google Chat

כדי להתקשר אל Google Chat API, צריך להגדיר אפליקציית Google Chat. לכל בקשת כתיבה, Google Chat משייך את אפליקציית Google Chat בממשק המשתמש באמצעות המידע הבא.

1. במסוף Google Cloud, עוברים לדף Configuration של Chat API:

   כניסה לדף ההגדרות של Chat API

2. בקטע פרטי הבקשה, מזינים את הפרטים הבאים:

   1. בשדה שם האפליקציה, מזינים Chat API quickstart app.
   2. בשדה כתובת ה-URL של האווטאר מזינים את הערך https://developers.google.com/chat/images/quickstart-app-avatar.png.
   3. בשדה Description (תיאור) מזינים Quickstart for calling the Chat API.

3. בקטע תכונות אינטראקטיביות, לוחצים על המתג הפעלת תכונות אינטראקטיביות כדי להעביר אותו למצב מושבת. כך משביתים את התכונות האינטראקטיביות באפליקציית Chat.

4. לוחצים על שמירה.

יצירת הסקריפט

1. יוצרים סקריפט חדש בכתובת script.google.com/create.
2. מחליפים את התוכן של עורך הסקריפטים בקוד הבא:

/**  * This quickstart sample shows how to list spaces with user credential  *  * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'  * referenced in the manifest file (appsscript.json).  */ function listSpaces() {   // Initialize request argument(s)   // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)   const filter = 'space_type = "SPACE"';    // Iterate through the response pages using page tokens   let responsePage;   let pageToken = null;   do {     // Request response pages     responsePage = Chat.Spaces.list({       filter: filter,       pageToken: pageToken     });     // Handle response pages     if (responsePage.spaces) {       responsePage.spaces.forEach((space) => console.log(space));     }     // Update the page token to the next one     pageToken = responsePage.nextPageToken;   } while (pageToken); }

3. לוחצים על סמל השמירה .
4. לוחצים על Untitled project, מקלידים Quickstart ולוחצים על Rename.

הגדרת הסקריפט

העתקת מספר הפרויקט ב-Cloud

1. במסוף Google Cloud, נכנסים לתפריט menu > IAM & Admin ‏(IAM ומנהל מערכת) > Settings (הגדרות).

   כניסה לדף IAM & Admin Settings

2. מעתיקים את הערך בשדה מספר הפרויקט.

קישור פרויקט ב-Google Cloud

1. פותחים את פרויקט Apps Script.
2. לוחצים על Project Settings (הגדרות הפרויקט) settings.
3. בקטע פרויקט Google Cloud Platform (GCP)‎, לוחצים על שינוי הפרויקט.
4. בשדה מספר פרויקט GCP, מדביקים את מספר הפרויקט ב-Google Cloud.
5. לוחצים על הגדרת פרויקט.

הפעלת Google Chat API

פותחים את פרויקט Apps Script.

1. לוחצים על Project Settings (הגדרות הפרויקט) settings.
2. בקטע הגדרות כלליות, מפעילים את האפשרות הצגת קובץ המניפסט appsscript.json בעורך.
3. לוחצים על עריכה code, בוחרים את הקובץ appscript.json ומחליפים את התוכן בקוד הבא:

{   "timeZone": "America/New_York",   "exceptionLogging": "STACKDRIVER",   "runtimeVersion": "V8",   "oauthScopes": [     "https://www.googleapis.com/auth/chat.spaces.readonly"   ],   "chat": {},   "dependencies": {     "enabledAdvancedServices": [{       "userSymbol": "Chat",       "version": "v1",       "serviceId": "chat"     }]   } }

הרצת הדוגמה

בעורך Apps Script, לוחצים על הפעלה.

בפעם הראשונה שמריצים את הדוגמה, מוצגת בקשה לאישור הגישה:

1. לוחצים על בדיקת ההרשאות.
2. בוחרים חשבון.
3. לוחצים על אישור.

יומן ההפעלה של הסקריפט מופיע בתחתית החלון.

השלבים הבאים

• תיעוד של שירותים מתקדמים ב-Google Apps Script