המדריך למתחילים של Google Apps Script

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

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

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

מטרות

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

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

הגדרת הפרויקט ב-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 APIs, צריך להפעיל אותם בפרויקט ב-Google Cloud. אפשר להפעיל ממשק API אחד או יותר בפרויקט אחד ב-Google Cloud.
  1. במסוף Google Cloud, נכנסים לתפריט > APIs & Services > OAuth consent screen.

    מעבר למסך ההסכמה ל-OAuth

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

  4. בשלב הזה, אפשר לדלג על הוספת היקפי הרשאה וללחוץ על Save and Continue (שמירה והמשך). בעתיד, כשיוצרים אפליקציה לשימוש מחוץ לארגון ב-Google Workspace, צריך לשנות את סוג המשתמש ל-חיצוני, ואז להוסיף את היקפי ההרשאה הנדרשים לאפליקציה.

  5. בודקים את סיכום רישום האפליקציה. כדי לבצע שינויים, לוחצים על עריכה. אם הרשמת האפליקציה נראית תקינה, לוחצים על Back to Dashboard.

איך מגדירים את אפליקציית Google Chat

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

  1. נכנסים לדף Configuration במסוף Google Cloud:

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

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

    1. בשדה App name, מזינים 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) {
      responsePage.spaces.forEach((space) => console.log(space));
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

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

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

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

  1. במסוף Google Cloud, נכנסים לתפריט > IAM & Admin > Settings.

    כניסה לדף IAM & Admin

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

הפעלת Google Chat API

  1. פותחים את הפרויקט ב-Apps Script.
  1. לוחצים על Project Settings (הגדרות הפרויקט) .
  2. בקטע הגדרות כלליות, מפעילים את האפשרות הצגת קובץ המניפסט 'appsscript.json' בעורך.
  3. לוחצים על Editor (עריכה) , בוחרים את הקובץ 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. לוחצים על אישור.

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

השלבים הבאים