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

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

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

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

מטרות

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

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

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

  • גישה ל-Google Drive

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

  1. יוצרים סקריפט חדש בעורך Apps Script בכתובת 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

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

  1. לוחצים על עריכה .
  2. לצד שירותים, לוחצים על סמל הוספת שירות .
  3. בוחרים באפשרות Google Classroom API ולוחצים על הוספה.

מריצים את הדוגמה

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

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

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

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

השלבים הבאים

הקודם
Go
הבא
Java