बाहरी अटैचमेंट और चालू करें

Classroom के ऐड-ऑन के बारे में जानकारी देने वाली वॉकथ्रू सीरीज़ का यह सातवां वॉकथ्रू है.

इस वॉकथ्रू में, Google Classroom के बाहर से ऐड-ऑन अटैचमेंट बनाने के लिए, वेब ऐप्लिकेशन में व्यवहार जोड़ा जाता है. इस व्यवहार का इस्तेमाल अपने उपयोगकर्ताओं को आपके मौजूदा प्रॉडक्ट या वेबसाइट से ऐड-ऑन अटैचमेंट बनाने देने के लिए करें. यह CourseWork इंटिग्रेशन के लिए भी एक बेहतरीन सुविधा है, क्योंकि इससे मौजूदा ट्रैफ़िक को, ऐड-ऑन के बेहतर उपयोगकर्ता अनुभव पर भेजा जा सकता है. इसके लिए, ट्रैफ़िक के फ़्लो में बदलाव करने की ज़रूरत नहीं होती. सुझाई गई प्रोसेस, Classroom के बाहर अटैचमेंट बनाना गाइड पेज पर दी गई है.

ऐड-ऑन के अटैचमेंट की मदद से, प्रोग्राम के हिसाब से किसी असाइनमेंट में बदलाव करने के लिए, अपने ऐड-ऑन में भी व्यवहार जोड़ा जाता है. आपके पास ऐसे किसी भी असाइनमेंट में बदलाव करने का विकल्प होता है जिसमें आपका कोई ऐड-ऑन अटैचमेंट हो. इससे कोई फ़र्क़ नहीं पड़ता कि उसे किसने बनाया है. ऐसा करना खास तौर पर तब मददगार होता है, जब छात्र/छात्रा कोई गतिविधि पूरी कर लें, तो असाइनमेंट सबमिट कर दें. इससे शिक्षक को यह पता चलता है कि असाइन किए गए टास्क पूरे हो गए हैं और छात्र-छात्राओं का काम समीक्षा के लिए तैयार है.

आपने अपने ऐड-ऑन का वह फ़ाइनल वर्शन रिलीज़ किया है जो कॉन्टेंट टाइप या गतिविधि टाइप के अटैचमेंट के साथ काम करता है. इस गाइड में कॉन्टेंट टाइप वाले अटैचमेंट का इस्तेमाल किया गया है.

असाइनमेंट मैनेजमेंट के लिए OAuth स्कोप जोड़ना

पक्का करें कि आपका ऐप्लिकेशन इन स्कोप का अनुरोध करता हो:

  • https://www.googleapis.com/auth/classroom.addons.teacher
  • https://www.googleapis.com/auth/classroom.addons.student
  • https://www.googleapis.com/auth/classroom.coursework.students

classroom.coursework.students स्कोप की ज़रूरत पहले नहीं थी. इसका इस्तेमाल, CourseWork असाइनमेंट बनाने या उनमें बदलाव करने के लिए किया जाता है. इस स्कोप को अपने Cloud प्रोजेक्ट के Google Workspace Marketplace SDK टूल, OAuth की सहमति वाली स्क्रीन, और अपने सर्वर कोड में स्कोप की सूचियों में जोड़ें.

Python

  SCOPES = [
    "https://www.googleapis.com/auth/classroom.addons.teacher",
    "https://www.googleapis.com/auth/classroom.addons.student",
    "https://www.googleapis.com/auth/classroom.coursework.students",
  ]

Classroom में असाइनमेंट बनाना

बिना iframe वाले वेब पेज पर बटन जोड़ना

इस वॉकथ्रू में बताए गए फ़्लो की मदद से, उपयोगकर्ता Google Classroom में असाइनमेंट और अटैचमेंट बना सकता है. इसके लिए, उसे Google के प्रॉडक्ट का इस्तेमाल करने की ज़रूरत नहीं है. आम तौर पर, यह आपकी मौजूदा वेबसाइट या ऐप्लिकेशन होती है. इस उदाहरण के लिए, आपको बाहरी साइट के तौर पर काम करने के लिए, एक मॉक वेब पेज बनाना होगा. आपको एक ऐसा बटन या लिंक चाहिए जिस पर क्लिक करने पर, एक नया रूट खुले. यह रूट, नया असाइनमेंट बनाने के लिए, सुझाया गया CourseWorkफ़्लो चलाता है.

अगर आपके पास पहले से कोई बटन या लिंक नहीं है, तो आपको उपयोगकर्ता को साइन इन करने की अनुमति देने के लिए बटन या लिंक जोड़ना होगा. इसके बाद, एपीआई के अनुरोध करने के लिए, आपको उपयोगकर्ता के क्रेडेंशियल की ज़रूरत होगी. इसलिए, उपयोगकर्ता को OAuth 2.0 हैंडशेक पूरा करना होगा. खास दिशा-निर्देशों के लिए, साइन इन करने के लिए सिलसिलेवार तरीके से निर्देश देखें.

Python

Python के दिए गए उदाहरण में, /index रूट में बदलाव किया गया है. इस रूट को सिलसिलेवार निर्देशों के पहले चरण में दिखाया गया था.

<!-- /webapp/templates/index.html -->
<a href="clear-credentials.html">Logout</a>
<a href="start-auth-flow.html">Login</a>

<br>

<a href="create-coursework-assignment.html">Create a CourseWork Assignment</a>

अपनी वेबसाइट में किसी डेस्टिनेशन को दिखाने के लिए, एचटीएमएल टेंप्लेट जोड़ें. इस पेज पर वह कॉन्टेंट दिखेगा जिसे आपके CourseWork असाइनमेंट से अटैच किया जाएगा.

<!-- /webapp/templates/example-coursework-assignment.html -->
<h1>CourseWork assignment loaded!</h1>
<p>You've loaded a CourseWork assignment! It was created from an external web page.</p>

courseWork से जुड़े रूट मैनेज करने के लिए, एक नई Python मॉड्यूल फ़ाइल बनाएं. हमारे दिए गए उदाहरण में यह coursework_routes.py है. यहां दिए गए तीन रूट जोड़ें. ध्यान दें कि आपको कुछ कॉन्टेंट बाद में भरना होगा.

# /webapp/coursework_routes.py
@app.route("/create-coursework-assignment")
def create_coursework_assignment():
  """
  Completes the assignment creation flow.
  """

  # Check that the user is signed in. If not, perform the OAuth 2.0
  # authorization flow.
  credentials = get_credentials()

  if not credentials:
    return start_auth_flow("coursework_assignment_callback")

  # Construct the Google Classroom service.
  classroom_service = get_classroom_service()

  pass  # To be completed later.

@app.route("/example-coursework-assignment/<assignment_type>")
def example_coursework_assignment(assignment_type):
  """
  Renders the "example-coursework-assignment.html" template.
  """
  return flask.render_template(
      "example-coursework-assignment.html", assignment_type=assignment_type
  )

@app.route("/coursework-assignment-callback")
def coursework_assignment_callback():
  """
  Completes the OAuth 2.0 handshake and stores credentials in the session.
  This is identical to the callback introduced in the sign-in walkthrough,
  but redirects the user to the index page instead of the attachment
  discovery page.
  """
  flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
      CLIENT_SECRETS_FILE,
      scopes=SCOPES,
      state=flask.session["state"],
      redirect_uri=flask.url_for("coursework_assignment_callback", _external=True),
  )

  flow.fetch_token(authorization_response=flask.request.url)

  credentials = flow.credentials
  flask.session["credentials"] = session_credentials_to_dict(
      credentials
  )

  # Close the current window and redirect the user to the index page.
  return flask.render_template("close-me.html", redirect_destination="index")

यह देखना कि किसी उपयोगकर्ता ने अटैचमेंट बनाया है या नहीं

किसी उपयोगकर्ता की ओर से ऐड-ऑन अटैचमेंट बनाने से पहले, उसे कुछ ज़रूरी शर्तें पूरी करनी होंगी. Google, userProfiles.checkUserCapability का इस्तेमाल करके यह तय करता है कि उपयोगकर्ता ने ये ज़रूरी शर्तें पूरी की हैं या नहीं. ज़रूरी शर्तें पूरी करने वाले उपयोगकर्ता को ज़रूरी शर्तें पूरी करने वाला उपयोगकर्ता कहा जाता है.

CourseWork बनाने के रूट को लागू करने के लिए, ज़रूरी शर्तों की जांच करने की सुविधा जोड़ें. इसके बाद, जवाब में allowed फ़ील्ड की जांच करें. ज़रूरी शर्तें पूरी करने वाले उपयोगकर्ताओं के लिए, ऐड-ऑन अटैचमेंट वाला असाइनमेंट बनाने के लिए, दिए गए तरीके का पालन करें. इसके अलावा, लिंक किया गया कॉन्टेंट बनाएं. आपको उस कोर्स का आईडी पता होना चाहिए जिसमें उपयोगकर्ता को असाइनमेंट बनाना है. आम तौर पर, आपको उपयोगकर्ता से यह बताने के लिए कहा जाएगा कि किस कोर्स का इस्तेमाल करना है. इसे आसानी से समझने के लिए, हमने इस उदाहरण में हार्ड कोड की गई वैल्यू का इस्तेमाल किया है.

Python

# /webapp/coursework_routes.py
@app.route("/create-coursework-assignment")
def create_coursework_assignment():
  """
  Completes the assignment creation flow.
  """
  # ... Check that the user is signed in and get the Classroom service ...

  # Check whether the user can create add-on attachments.
  eligibility_response = (
      classroom_service.userProfiles()
      .checkUserCapability(
        userId="me",
        capability="CREATE_ADD_ON_ATTACHMENT",
        # The previewVersion is necessary while the method is available in the
        # Workspace Developer Preview Program.
        previewVersion="V1_20240930_PREVIEW",
      ).execute()
  )
  is_create_attachment_eligible = eligibility_response.get("allowed")

  if is_create_attachment_eligible:
    # See the "Create an assignment with add-on attachment for eligible users" section for implementation.
  if not is_create_attachment_eligible:
    # See the "Create a Link Material" section for implementation.

ज़रूरी शर्तें पूरी करने वाले उपयोगकर्ताओं के लिए, ऐड-ऑन अटैचमेंट वाला असाइनमेंट बनाएं

अगर उपयोगकर्ता ऐड-ऑन अटैचमेंट बनाने की ज़रूरी शर्तें पूरी करता है, तो ये काम करें:

  1. Google Classroom में बिना किसी अटैचमेंट के courseWork असाइनमेंट बनाने के लिए, एपीआई अनुरोध भेजें.
  2. नए बनाए गए असाइनमेंट का id निकालें.
  3. नया कोर्सवर्क AddOnAttachment बनाएं.
  4. Google Classroom में, हाल ही में बनाए गए असाइनमेंट में ऐड-ऑन अटैचमेंट बनाने का अनुरोध भेजें.

Python

# The ID of the course to which the assignment will be added.
course_id = 1234567890  # TODO(developer) Replace with an actual course ID.

# /webapp/coursework_routes.py
if is_create_attachment_eligible:
  # Create an assignment.
  coursework = {
      "title": "My CourseWork Assignment with Add-on Attachment",
      "description": "Created using the Classroom CourseWork API.",
      "workType": "ASSIGNMENT",
      "state": "DRAFT",  # Set to 'PUBLISHED' to assign to students.
  }

  # Issue a request to create the assignment.
  create_assignment_response = (
      classroom_service.courses()
      .courseWork()
      .create(courseId=course_id, body=coursework)
      .execute()
  )

  # Create an add-on attachment that links to the selected content and
  # associate it with the new assignment.
  content_url = flask.url_for(
      "example_coursework_assignment",
      assignment_type="add-on-attachment",
      _scheme="https",
      _external=True,
  )

  # Construct an AddOnAttachment instance.
  attachment = {
      "teacherViewUri": {"uri": content_url},
      "studentViewUri": {"uri": content_url},
      "title": f'Test Attachment for Assignment {create_assignment_response.get("id")}',
  }

  # Issue a request to create the attachment.
  add_on_attachment_response = (
      classroom_service.courses()
      .courseWork()
      .addOnAttachments()
      .create(
          courseId=course_id,
          itemId=create_assignment_response.get("id"),  # ID of the new assignment.
          body=attachment,
      )
      .execute()
  )

अगर उपयोगकर्ता के पास ऐड-ऑन अटैचमेंट बनाने की ज़रूरी शर्तें पूरी नहीं हैं, तो लिंक किए गए कॉन्टेंट का इस्तेमाल करें. इसके लिए, यह तरीका अपनाएं:

Python

# The ID of the course to which the assignment will be added.
course_id = 1234567890  # TODO(developer) Replace with an actual course ID.

if not is_create_attachment_eligible:
    coursework = {
        "title": "My CourseWork Assignment with Link Material",
        "description": "Created using the Classroom CourseWork API.",
        "workType": "ASSIGNMENT",
        "state": "DRAFT",  # Set to 'PUBLISHED' to assign to students.
        # Specify the URL for your content as a Link Material.
        "materials": [
            {
                "link": {
                    "url": flask.url_for(
                        "example_coursework_assignment",
                        assignment_type="link-material",
                        _scheme="https",
                        _external=True,
                    )
                }
            }
        ],
    }

    # Issue a request to create the assignment.
    assignment_response = (
        classroom_service.courses()
        .courseWork()
        .create(courseId=course_id, body=coursework)
        .execute()
    )

पहले से बने असाइनमेंट में बदलाव करें

आपके पास Google Classroom में मौजूद किसी भी स्ट्रीम आइटम को ऐक्सेस करने, उसमें बदलाव करने, उसे सबमिट करने, वापस पाने या लौटाने का विकल्प होता है. ऐसा तब भी किया जा सकता है, जब स्ट्रीम आइटम को किसी और ने बनाया हो. हालांकि, इसके लिए ज़रूरी है कि उसमें आपका कम से कम एक ऐड-ऑन अटैचमेंट हो. स्ट्रीम आइटम कोई भी Announcement, CourseWork असाइनमेंट या CourseWorkMaterial हो सकते हैं.

इसे दिखाने के लिए, आपको दिए गए स्ट्रीम आइटम में बदलाव करने के लिए एक रूट जोड़ना होगा. इस तरीके का इस्तेमाल करके पुष्टि करें कि आपके पास एपीआई का इस्तेमाल करके, अपने बनाए गए स्ट्रीम आइटम को ऐक्सेस करने और उनमें बदलाव करने का ऐक्सेस है. साथ ही, यह भी पुष्टि करें कि आपके पास Google Classroom के यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, शिक्षक के बनाए गए स्ट्रीम आइटम को ऐक्सेस करने और उनमें बदलाव करने का ऐक्सेस है.

इस वॉकथ्रू में, उस वेब पेज पर एक और लिंक या बटन जोड़ें जिसमें आपने पहले बदलाव किया था. CourseWork assignment में बदलाव करने के लिए, यह एक नया रास्ता खोल देगा.

Python

Python के दिए गए उदाहरण में, /index रूट में बदलाव किया गया है. इस रूट में, इस ट्यूटोरियल में पहले ही बदलाव किया गया था.

<!-- /webapp/templates/index.html -->
<a href="modify-coursework-assignment.html">Create a CourseWork Assignment</a>

कोर्सवर्क से जुड़े रूट को मैनेज करने के लिए, नया रूट बनाएं. यह हमारे दिए गए उदाहरण में, coursework_routes.py फ़ाइल में है.

# Check that the user is signed in.
credentials = get_credentials()

if not credentials:
  return start_auth_flow("coursework_assignment_callback")

# Get the Google Classroom service.
classroom_service = get_classroom_service()

# The ID of the course to which the assignment will be added.
# Ordinarily, you'll prompt the user to specify which course to use. For
# simplicity, we use a hard-coded value in this example.
course_id = 1234567890  # TODO(developer) Replace with an actual course ID.
assignment_id = 1234567890  # TODO(developer) Replace with an actual assignment ID.

# Retrieve details about the CourseWork assignment.
get_coursework_response = (
    classroom_service.courses()
    .courseWork()
    .get(courseId=course_id, id=assignment_id)
    .execute()
)

# Alter the current title.
assignment_title = f"{get_coursework_response.get('title')} (Modified by API request)"

# Issue a request to modify the assignment.
modify_coursework_response = (
    classroom_service.courses()
    .courseWork()
    .patch(
        courseId=course_id,
        id=assignment_id,
        updateMask="title",
        body={"title": assignment_title},
    )
    .execute()
)

ऐड-ऑन की जांच करना

चीज़ों को आसान बनाने के लिए, दिए गए उदाहरणों में कोर्स और असाइनमेंट के हार्ड कोड वाले आइडेंटिफ़ायर का इस्तेमाल किया गया है. ये आइडेंटिफ़ायर पाने के लिए, courses और courseWork संसाधनों के get और list तरीकों के लिए, शिक्षक के क्रेडेंशियल का इस्तेमाल करके अनुरोध करें. courseWork असाइनमेंट बनाते समय भी ये वैल्यू जवाब में दिखती हैं.

अपना सर्वर चलाएं. इसके बाद, अपने इंडेक्स पेज पर जाएं और शिक्षक के तौर पर साइन इन करें. इसके लिए, आपको Google Workspace for Education Teaching & Learning या Plus लाइसेंस की ज़रूरत नहीं है. अपने टेस्ट डोमेन के एडमिन कंसोल से, उपयोगकर्ता के लाइसेंस का स्टेटस टॉगल किया जा सकता है. इसके लिए, कोर्सवर्क असाइनमेंट बनाएं बटन पर क्लिक करें. इसके बाद, Google Classroom का यूज़र इंटरफ़ेस (यूआई) खोलें और पुष्टि करें कि लिंक किए गए कॉन्टेंट के अटैचमेंट वाला असाइनमेंट बनाया गया है. अटैचमेंट में, लिंक किए गए वेब पेज का टाइटल और यूआरएल दिखना चाहिए.

ऐड-ऑन अटैचमेंट बनाने की सुविधा की जांच करना

इंडेक्स पेज पर वापस जाएं और शिक्षक के तौर पर साइन इन करें. इसके लिए, आपके पास Google Workspace for Education Teaching & Learning या Plus का लाइसेंस होना चाहिए. कोर्सवर्क असाइनमेंट बनाएं बटन पर क्लिक करें. इसके बाद, Google Classroom का यूज़र इंटरफ़ेस खोलें और पुष्टि करें कि ऐड-ऑन अटैचमेंट वाला असाइनमेंट बनाया गया है. अटैचमेंट में आपके ऐड-ऑन ऐप्लिकेशन का नाम और कोड में दिया गया टाइटल दिखना चाहिए.

असाइनमेंट में बदलाव करने की सुविधा को टेस्ट करना

इंडेक्स पेज पर वापस जाएं और पक्का करें कि आपने Teaching & Learning या Plus लाइसेंस वाले शिक्षक के तौर पर साइन इन किया हो. कोर्सवर्क असाइनमेंट में बदलाव करें बटन पर क्लिक करें. इसके बाद, Google Classroom के यूज़र इंटरफ़ेस (यूआई) पर वापस जाएं और पुष्टि करें कि असाइनमेंट के टाइटल में बदलाव किया गया है.

बधाई हो! आपने वॉकथ्रू सीरीज़ पूरी कर ली हो.