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

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

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

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

מטרות

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

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

  • חשבון Google for Education שבו Google Classroom מופעל.

  • גישה ל-Google Drive

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

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

classroom/quickstart/quickstart.gs
/**
 * Lists 10 course names and ids.
 */
function listCourses() {
  /**  here pass pageSize Query parameter as argument to get maximum number of result
   * @see https://developers.google.com/classroom/reference/rest/v1/courses/list
   */
  const optionalArgs = {
    pageSize: 10
    // Use other parameter here if needed
  };
  try {
    // call courses.list() method to list the courses in classroom
    const response = Classroom.Courses.list(optionalArgs);
    const courses = response.courses;
    if (!courses || courses.length === 0) {
      console.log('No courses found.');
      return;
    }
    // Print the course names and IDs of the courses
    for (const course of courses) {
      console.log('%s (%s)', course.name, course.id);
    }
  } catch (err) {
    // TODO (developer)- Handle Courses.list() exception from Classroom API
    // get errors like PERMISSION_DENIED/INVALID_ARGUMENT/NOT_FOUND
    console.log('Failed with error %s', err.message);
  }
}

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

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

הפעלת Google Classroom API

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

הרצת הדוגמה

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

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

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

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

השלבים הבאים

הקודם
Go
הבא
Java