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

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

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

יוצרים Google Apps Script ששולח בקשות לממשק ה-API של Gmail.

מטרות

  • יוצרים את הסקריפט.
  • מפעילים את 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. לוחצים על פרויקט ללא שם, מקלידים התחלה מהירה, ולוחצים על שינוי שם.

הפעלת ממשק ה-API של Gmail

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

הפעלת הדוגמה

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

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

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

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

השלבים הבאים