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

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

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

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

מטרות

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

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

  • חשבון Google שבו Gmail מופעל.

  • גישה ל-Google Drive

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

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

gmail/quickstart/quickstart.gs
/**
 * Lists all labels in the user's mailbox
 * @see https://developers.google.com/gmail/api/reference/rest/v1/users.labels/list
 */
function listLabels() {
  try {
    // Gmail.Users.Labels.list() API returns the list of all Labels in user's mailbox
    const response = Gmail.Users.Labels.list('me');
    if (!response || response.labels.length === 0) {
      // TODO (developer) - No labels are returned from the response
      console.log('No labels found.');
      return;
    }
    // Print the Labels that are available.
    console.log('Labels:');
    for (const label of response.labels ) {
      console.log('- %s', label.name);
    }
  } catch (err) {
    // TODO (developer) - Handle exception on Labels.list() API
    console.log('Labels.list() API failed with error %s', err.toString());
  }
}

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

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

הפעלת Gmail API

  1. פותחים את הפרויקט ב-Apps Script.
  1. לוחצים על עריכה .
  2. לצד Services (שירותים), לוחצים על Add a service (הוספת שירות) .
  3. בוחרים באפשרות Gmail API ולוחצים על הוספה.

הרצת הדוגמה

עורכים את הסקריפט ב-Apps Script ולוחצים על הפעלה.

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

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

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

השלבים הבאים