トピックの管理

Topic は、コース内の CourseWork ストリーム アイテムと CourseWorkMaterial ストリーム アイテムをグループ化するためのラベルです。通常、Topic は、アイテムが割り当てられた週や科目など、類似性に基づいてアイテムを分類するために使用されます。ユーザーは、Classroom UI の [Classwork] ビューで、ストリーミング アイテムを視覚的に整理してフィルタできます。

各 Topic は、サーバーから割り当てられた一意の ID で識別されます。Topic リソースには次のものが含まれます。

• name: Classroom UI に表示される表示名
• updateTime: Topic が最後に更新された時刻
• courseId: Topic が関連付けられているコースの ID

トピックを作成する

次のサンプルに示すように、topics.create() メソッドを使用して、コースに新しい Topic を作成できます。

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 を作成するときは、末尾の空白文字を削除してください。

トピックの詳細を取得する

次のサンプルに示すように、topics.get() メソッドを使用して、ID で特定の Topic を取得できます。

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']))

次のサンプルに示すように、topics.list() メソッドを使用して、コース内のすべての Topic を取得します。

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 で更新することはできません。

注: name を変更せずに Topic にパッチを適用すると、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;
}