विषय मैनेज करें

Topic एक लेबल होता है. इसका इस्तेमाल, कोर्स में CourseWork और CourseWorkMaterial स्ट्रीम आइटम को ग्रुप करने के लिए किया जाता है. आम तौर पर, Topic का इस्तेमाल, इन आइटम को समानता के आधार पर कैटगरी में बांटने के लिए किया जाता है. जैसे, आइटम असाइन किए जाने का हफ़्ता या उनका विषय. उपयोगकर्ता, Classroom के यूज़र इंटरफ़ेस (यूआई) के क्लासवर्क व्यू में, स्ट्रीम के आइटम को विज़ुअल तरीके से व्यवस्थित कर सकते हैं और उन्हें फ़िल्टर कर सकते हैं.

हर Topic की पहचान, सर्वर की ओर से असाइन किए गए यूनीक आईडी से की जाती है. Topic संसाधन में यह जानकारी भी शामिल होती है:

  • name: Classroom के यूज़र इंटरफ़ेस (यूआई) में दिखने वाला डिसप्ले नेम
  • updateTime: Topic को आखिरी बार अपडेट किए जाने का समय
  • courseId: उस कोर्स का आईडी जिससे Topic जुड़ा है

कोई विषय बनाना

topics.create() तरीके का इस्तेमाल करके, किसी कोर्स में नया Topic बनाया जा सकता है. यहां इसका एक उदाहरण दिया गया है:

Java

classroom/snippets/src/main/java/CreateTopic.java
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 फ़ील्ड हमेशा ज़रूरी होता है और इसमें कोई वैल्यू होनी चाहिए. अन्य सभी फ़ील्ड में जानकारी देना ज़रूरी नहीं है.

विषय की जानकारी पाना

यहां दिए गए उदाहरण में दिखाया गया है कि topics.get() तरीके का इस्तेमाल करके, आईडी के हिसाब से किसी Topic को कैसे वापस पाया जा सकता है:

Java

classroom/snippets/src/main/java/GetTopic.java
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 को वापस पाने के लिए, topics.list() तरीके का इस्तेमाल करें. इसके बारे में यहां दिए गए सैंपल में बताया गया है:

Java

classroom/snippets/src/main/java/ListTopics.java
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
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 फ़ील्ड, सर्वर से जनरेट होते हैं. इन्हें एपीआई की मदद से अपडेट नहीं किया जा सकता.

कोई विषय मिटाना

topics.delete() तरीके का इस्तेमाल करके, मौजूदा Topic को मिटाया जा सकता है. इसका तरीका यहां दिए गए उदाहरण में दिखाया गया है:

Java

classroom/snippets/src/main/java/DeleteTopic.java
try {
  service.courses().topics().delete(courseId, topicId).execute();
} catch (GoogleJsonResponseException e) {
  // TODO(developer) - handle error appropriately
  throw e;
} catch (Exception e) {
  throw e;
}
पीछे जाएं
कोर्सवर्क बनाना और मैनेज करना