ניהול נושאים

Topic היא תווית לקיבוץ פריטים בפיד של קורס, כמו CourseWork ו-CourseWorkMaterial. Topic משמש בדרך כלל לסיווג הפריטים לפי דמיון, למשל השבוע שבו הפריטים הוקצו או הנושא שלהם. המשתמשים יכולים לארגן ולסנן את הפריטים בעדכונים לכיתה בתצוגה עבודה בממשק המשתמש של Classroom.

כל Topic מזוהה באמצעות מזהה ייחודי שהוקצה על ידי השרת. במשאב Topic נכללים גם:

• ‫name: השם המוצג שמופיע בממשק המשתמש של Classroom
• updateTime: השעה שבה Topic עודכן לאחרונה
• ‫courseId: המזהה של הקורס שאליו משויך Topic

יצירת נושא

אפשר ליצור Topic חדש בקורס באמצעות השיטה topics.create(), כמו בדוגמה הבאה:

Java

classroom/snippets/src/main/java/CreateTopic.java

הצגת הקוד ב-GitHub

Topic topic = null;
try {
  // Create the new Topic.
  Topic content = new Topic().setName("Semester 1");
  topic = service.courses().topics().create(courseId, content).execute();
  System.out.println("Topic id: " + topic.getTopicId() + "\n" + "Course id: " + courseId);
} catch (GoogleJsonResponseException e) {
  // TODO (developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("The courseId does not exist: %s.\n", courseId);
  } else {
    throw e;
  }
} catch (Exception e) {
  throw e;
}
return topic;

Python

topic = {
    "name": 'Example Topic'
}
response = service.courses().topics().create(
  courseId=<course ID or alias>,
  body=topic).execute()
print('Topic created: ', response['name'])

השדה name הוא תמיד שדה חובה והוא צריך להיות מחרוזת לא ריקה. כל שאר השדות הם אופציונליים.

חשוב: יש באג שגורם לכך שקובץ Topic שנוצר עם רווח בסוף לא ניתן לשימוש ב-Classroom. חשוב להקפיד להסיר רווחים לבנים בסוף השורה (‎ ) כשיוצרים Topic

.

אחזור פרטים על נושא

אפשר לאחזר Topic ספציפי לפי מזהה באמצעות שיטת topics.get(), כמו בדוגמה הבאה:

Java

classroom/snippets/src/main/java/GetTopic.java

הצגת הקוד ב-GitHub

Topic topic = null;
try {
  // Get the topic.
  topic = service.courses().topics().get(courseId, topicId).execute();
  System.out.printf("Topic '%s' found.\n", topic.getName());
} catch (GoogleJsonResponseException e) {
  // TODO (developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("The courseId or topicId does not exist: %s, %s.\n", courseId, topicId);
  }
  throw e;
} catch (Exception e) {
  throw e;
}
return topic;

Python

response = service.courses().topics().get(
  courseId=<course ID or alias>,
  id=<topic ID>).execute()
print('{0} ({1})'.format(response['name'], response['topicId']))

כדי לאחזר את כל Topic בקורס, משתמשים בשיטה topics.list(), כמו בדוגמה הבאה:

Java

classroom/snippets/src/main/java/ListTopics.java

הצגת הקוד ב-GitHub

List<Topic> topics = new ArrayList<>();
String pageToken = null;

try {
  do {
    ListTopicResponse response =
        service
            .courses()
            .topics()
            .list(courseId)
            .setPageSize(100)
            .setPageToken(pageToken)
            .execute();

    /* Ensure that the response is not null before retrieving data from it to avoid errors. */
    if (response.getTopic() != null) {
      topics.addAll(response.getTopic());
      pageToken = response.getNextPageToken();
    }
  } while (pageToken != null);

  if (topics.isEmpty()) {
    System.out.println("No topics found.");
  } else {
    for (Topic topic : topics) {
      System.out.printf("%s (%s)\n", topic.getName(), topic.getTopicId());
    }
  }
} catch (GoogleJsonResponseException e) {
  // TODO (developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("The courseId does not exist: %s.\n", courseId);
  } else {
    throw e;
  }
} catch (Exception e) {
  throw e;
}
return topics;

Python

topics = []
page_token = None
while True:
    response = service.courses().topics().list(
        pageToken=page_token,
        pageSize=30,
        courseId=<course ID or alias>).execute()
    topics.extend(response.get('topic', []))
    page_token = response.get('nextPageToken', None)
    if not page_token:
        break
if not topics:
    print('No topics found.')
else:
    print('Topics:')
    for topic in topics:
        print('{0} ({1})'.format(topic['name'], topic['topicId']))

עדכון נושא

אפשר לעדכן Topic name קיים באמצעות השיטה topics.patch(), כמו בדוגמה הבאה:

Java

classroom/snippets/src/main/java/UpdateTopic.java

הצגת הקוד ב-GitHub

Topic topic = null;
try {
  // Retrieve the topic to update.
  Topic topicToUpdate = service.courses().topics().get(courseId, topicId).execute();

  // Update the name field for the topic retrieved.
  topicToUpdate.setName("Semester 2");

  /* Call the patch endpoint and set the updateMask query parameter to the field that needs to
  be updated. */
  topic =
      service
          .courses()
          .topics()
          .patch(courseId, topicId, topicToUpdate)
          .set("updateMask", "name")
          .execute();

  /* Prints the updated topic. */
  System.out.printf("Topic '%s' updated.\n", topic.getName());
} catch (GoogleJsonResponseException e) {
  // TODO(developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("The courseId or topicId does not exist: %s, %s.\n", courseId, topicId);
  } else {
    throw e;
  }
} catch (Exception e) {
  throw e;
}
return topic;

Python

topic = {
  "name": "New Topic Name"
}
response = service.courses().topics().patch(
  courseId=<course ID or alias>,
  id=<topic ID>,
  updateMask="name",
  body=topic).execute()
print('{0} ({1})'.format(response['name'], response['topicId']))

השדות Topic id ו-updateTime נוצרים על ידי השרת ואי אפשר לעדכן אותם באמצעות ה-API.

הערה: אם מבצעים תיקון של Topic בלי לשנות את name, מוחזר קוד סטטוס HTTP 403 Forbidden.

מחיקת נושא

אפשר למחוק Topic קיים באמצעות השיטה topics.delete(), כמו שמוצג בדוגמה הבאה:

Java

classroom/snippets/src/main/java/DeleteTopic.java

הצגת הקוד ב-GitHub

try {
  service.courses().topics().delete(courseId, topicId).execute();
} catch (GoogleJsonResponseException e) {
  // TODO(developer) - handle error appropriately
  throw e;
} catch (Exception e) {
  throw e;
}