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

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

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

לכתוב Google Apps Script שמבצע בקשות ל-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. לוחצים על פרויקט ללא שם, מקלידים מדריך למתחילים, ולוחצים על שינוי שם.

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

הפעלה של Google Classroom API

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

הרצת הדוגמה

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

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

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

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

השלבים הבאים