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

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

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

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

מטרות

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

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

• פרויקט ב-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 שבו רוצים להשתמש. לחלופין, לוחצים על Create project ופועלים לפי ההוראות במסך. אם יוצרים פרויקט ב-Google Cloud, יכול להיות שיהיה צורך להפעיל את החיוב בפרויקט.

הפעלת Chat API

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

  להפעלת ה-API

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

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

   מעבר לדף Branding

2. אם כבר הגדרתם את Google Auth platform, אתם יכולים לקבוע את ההגדרות הבאות של מסך ההסכמה ל-OAuth בקטעים Branding,‏ Audience וData Access. אם מופיעה ההודעה Google Auth platform not configured yet, לוחצים על Get Started:
1. בקטע App Information בשדה App name, מזינים שם לאפליקציה.
2. בקטע User support email, בוחרים כתובת אימייל לתמיכה שאליה משתמשים יפנו אם יש להם שאלות לגבי ההסכמה שלהם.
3. לוחצים על Next.
4. בקטע Audience, לוחצים על Internal.
5. לוחצים על Next.
6. בקטע Contact Information, מזינים כתובת אימייל שאליה אפשר לשלוח התראות על שינויים בפרויקט.
7. לוחצים על Next.
8. בקטע Finish, קוראים את המדיניות של Google בנושא נתוני משתמשים בשירותי API. אם אתם מסכימים, מסמנים את התיבה I agree to the Google API Services: User Data Policy.
9. לוחצים על Continue.
10. לוחצים על Create.
3. כרגע אתם יכולים לדלג על הוספת היקפי הרשאות. בעתיד, כשתיצרו אפליקציה לשימוש מחוץ לארגון שלכם ב-Google Workspace, תצטרכו לשנות את סוג המשתמש ל-External. לאחר מכן מוסיפים את היקפי ההרשאות שהאפליקציה דורשת. למידע נוסף, אפשר לעיין במדריך המלא בנושא הגדרת הסכמה ל-OAuth.

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

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

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

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

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

   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. יוצרים סקריפט חדש בעורך Apps Script בכתובת 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 ‏> 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
• התנסות עם ממשקי Google Workspace API ב-API Explorer