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

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

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

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

מטרות

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

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

הגדרת פרויקט בענן

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

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

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

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

    בוחרים פרויקט בענן

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

הפעלת Chat API

לפני שאתם משתמשים בממשקי Google API, אתם צריכים להפעיל אותם בפרויקט ב-Google Cloud. בכל פרויקט אפשר להפעיל ממשק API אחד או יותר.
  1. ב-Google API Console, נכנסים לתפריט > Google Auth platform > Branding.

    מעבר לדף Branding

  2. אם כבר הגדרתם את פלטפורמת האימות של Google, אתם יכולים לקבוע את ההגדרות הבאות של מסך ההסכמה ל-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 API Console, עוברים לדף 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. יוצרים סקריפט חדש בכלי לעריכת סקריפטים בכתובת script.google.com/create.
  2. מחליפים את התוכן של הכלי לעריכת סקריפטים בקוד הבא:

chat/quickstart/Code.gs
/**
 * 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) {
      for (const space of responsePage.spaces) {
        console.log(space);
      }
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

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

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

מעתיקים את מספר הפרויקט בענן

  1. ב-Google API Console, עוברים אל תפריט > IAM & Admin > Settings (הגדרות).

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

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

הפעלת Google Chat API

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

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

chat/quickstart/appsscript.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, לוחצים על Run (הפעלה).

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

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

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

השלבים הבאים