Skip to main content

Data Source

The Google Classroom API connector enables you to ingest course data, roster information, coursework, student submissions, grades, guardian details, and user profiles from Google Classroom. Follow the instructions below to create a new data flow that ingests data from a Google Classroom API source in Nexla.
google_classroom_api.png

Google Classroom API

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Google Classroom API connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Google Classroom API, and click Next; or, create a new Google Classroom API credential for use in this flow.

  3. In Nexla, Google Classroom API data sources can be created using pre-built endpoint templates, which expedite source setup for common Google Classroom API endpoints. Each template is designed specifically for the corresponding Google Classroom API endpoint, making data source setup easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Google Classroom API sources can also be configured manually, allowing you to ingest data from Google Classroom API endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Google Classroom API endpoints. Each template is designed specifically for the corresponding Google Classroom API endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    List Courses

    Returns a list of courses that the authenticated user is enrolled in or teaches. Use this endpoint to export the course catalog, build course rosters, or drive downstream flows that iterate over individual courses.

    • Sends a GET request to https://classroom.googleapis.com/v1/courses and returns all courses accessible to the authenticated user.
    • Response data is extracted from $.courses[*], treating each course as a separate record.

    Course IDs returned by this endpoint are required as input parameters for all course-scoped endpoints such as List Course Teachers, List Course Work, and List Student Submissions. Use lookup-based macros to iterate over course IDs.

    List Course Teachers

    Returns a list of teachers in a specified course. Use this endpoint to audit course staffing, export teacher rosters, or synchronize instructor data with HR or LMS systems.

    • Sends a GET request to https://classroom.googleapis.com/v1/courses/{'{courseId}'}/teachers and returns all teachers enrolled in the specified course.
    • Response data is extracted from $.teachers[*], treating each teacher as a separate record.
    • Configure the following parameter: Course ID — the unique identifier of the Google Classroom course for which teachers will be listed.

    Course IDs can be obtained using the List Courses endpoint. Use lookup-based macros to iterate over multiple course IDs and retrieve teacher lists for each.

    List Course Students

    Returns a list of students enrolled in a specified course. Use this endpoint to export student rosters for reporting, grade processing, or synchronization with student information systems.

    • Sends a GET request to https://classroom.googleapis.com/v1/courses/{'{courseId}'}/students and returns all students enrolled in the specified course.
    • Response data is extracted from $.students[*], treating each student as a separate record.
    • Configure the following parameter: Course ID — the unique identifier of the Google Classroom course for which students will be listed.

    Course IDs can be obtained using the List Courses endpoint. Use lookup-based macros to retrieve student lists across multiple courses in a single flow.

    List Course Announcements

    Returns a list of announcements posted in a specified course. Use this endpoint to export course communication records for audit trails, compliance review, or content archiving.

    • Sends a GET request to https://classroom.googleapis.com/v1/courses/{'{courseId}'}/announcements and returns all announcements in the specified course.
    • Response data is extracted from $.announcements[*], treating each announcement as a separate record.
    • Configure the following parameter: Course ID — the unique identifier of the Google Classroom course for which announcements will be listed.

    Course IDs can be obtained using the List Courses endpoint.

    List Course Work

    Returns a list of course work assignments and materials in a specified course. Use this endpoint to export assignment details for grade reporting, curriculum analysis, or LMS synchronization.

    • Sends a GET request to https://classroom.googleapis.com/v1/courses/{'{courseId}'}/courseWork and returns all course work in the specified course.
    • Response data is extracted from $.courseWork[*], treating each assignment as a separate record.
    • Configure the following parameter: Course ID — the unique identifier of the Google Classroom course for which course work will be listed.

    Course work IDs returned by this endpoint are required as input for the List Student Submissions endpoint. Use lookup-based macros to chain course work retrieval with submission-level data.

    List Student Submissions

    Returns a list of student submissions for a specified course work assignment. Use this endpoint to export submission records for grade processing, analytics, or synchronization with student information systems.

    Use the wildcard value - for Course Work ID to retrieve all submissions across all course work in a course. Course and course work IDs can be obtained from the List Courses and List Course Work endpoints.

    List Aliases

    Returns a list of aliases for a course. Use this endpoint to retrieve alternate identifiers for courses, which are useful for cross-system integration and data reconciliation.

    • Sends a GET request to https://classroom.googleapis.com/v1/courses/{'{courseId}'}/aliases and returns all aliases for the specified course.
    • Response data is extracted from $.aliases[*], treating each alias as a separate record.
    • Configure the following parameter: Courseid — the unique identifier of the course for which aliases will be listed.

    Course aliases can include domain-scoped identifiers (e.g., d:my_course_code) useful for linking Google Classroom courses to external systems.

    Get Student Submission

    Returns a specific student submission by its ID. Use this endpoint to retrieve the full submission record for a single student assignment, including grade, state, and attached work.

    Submission IDs can be obtained from the List Student Submissions endpoint. Use lookup-based macros to iterate over submission IDs for detailed per-submission ingestion.

    List Course Work Materials

    Returns course work materials the requester may view in a specified course. Use this endpoint to export learning materials, reference documents, and resources shared with students.

    Students see only PUBLISHED materials; teachers and domain administrators see all materials. The results depend on the authenticated user's role in the course.

    List Topics

    Returns the list of topics in a specified course. Use this endpoint to export the course topic structure for curriculum mapping or to synchronize topic hierarchies with external LMS systems.

    • Sends a GET request to https://classroom.googleapis.com/v1/courses/{'{courseId}'}/topics and returns all topics in the specified course.
    • Response data is extracted from $.topic[*], treating each topic as a separate record.
    • Configure the following parameter: Courseid — the unique identifier of the course for which topics will be listed.

    Topic IDs can be used to filter course work or materials by topic when building structured curriculum reports.

    List Invitations

    Returns a list of invitations the requesting user may view. Use this endpoint to monitor pending enrollment invitations or audit invitation history for compliance purposes.

    Results are filtered to invitations matching the request context. At least one of userId or courseId must be specified as a filter parameter to receive results.

    List Guardian Invitations

    Returns a list of guardian invitations for a specified student. Use this endpoint to monitor the status of guardian consent invitations or audit guardian onboarding workflows.

    • Sends a GET request to https://classroom.googleapis.com/v1/userProfiles/{'{studentId}'}/guardianInvitations and returns all guardian invitations for the specified student.
    • Response data is extracted from $.guardianInvitations[*], treating each guardian invitation as a separate record.
    • Configure the following parameter: Studentid — the unique identifier of the student for whom guardian invitations will be listed. Use the literal - to list invitations across all students (domain admin only).

    Accessing guardian invitation data for all students requires domain administrator privileges in Google Workspace for Education.

    List Guardians

    Returns a list of guardians for a specified student. Use this endpoint to export guardian contact information for communication workflows or to verify guardian enrollment status.

    • Sends a GET request to https://classroom.googleapis.com/v1/userProfiles/{'{studentId}'}/guardians and returns all confirmed guardians for the specified student.
    • Response data is extracted from $.guardians[*], treating each guardian as a separate record.
    • Configure the following parameter: Studentid — the unique identifier of the student for whom guardians will be listed. Use the literal - to list guardians across all students (domain admin only).

    Only confirmed guardians (those who have accepted the invitation) are returned. Domain administrator privileges are required to list guardians across all students.

    Get User Profile

    Returns the profile for a specified user. Use this endpoint to retrieve detailed user information including name, email, and photo for students, teachers, or other users in the domain.

    • Sends a GET request to https://classroom.googleapis.com/v1/userProfiles/{'{userId}'} and returns the full user profile object.
    • Response data is extracted from $ (the root object), returning a single user profile record.
    • Configure the following parameter: Userid — the unique identifier of the user whose profile will be retrieved. Accepts a user ID or email address.

    User IDs can be obtained from the List Course Students, List Course Teachers, or List Guardians endpoints. Use lookup-based macros to retrieve profiles for lists of users.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Google Classroom API sources can also be configured manually, allowing you to ingest data from Google Classroom API endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.

First, select the API method that will be used for calls to the Google Classroom API from the Method pulldown menu. For most Google Classroom API read operations, select GET.

API Endpoint URL​

  1. Enter the URL of the Google Classroom API endpoint from which this source will fetch data in the Set API URL field. The Google Classroom REST API base URL is https://classroom.googleapis.com/v1/. Common endpoint URLs include:

    • List courses: https://classroom.googleapis.com/v1/courses

    • List students in a course: https://classroom.googleapis.com/v1/courses/{courseId}/students

    • List teachers in a course: https://classroom.googleapis.com/v1/courses/{courseId}/teachers

    • List coursework for a course: https://classroom.googleapis.com/v1/courses/{courseId}/courseWork

    • List student submissions: https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions

    • List topics in a course: https://classroom.googleapis.com/v1/courses/{courseId}/topics

    • List announcements: https://classroom.googleapis.com/v1/courses/{courseId}/announcements

    • List user profiles: https://classroom.googleapis.com/v1/userProfiles/{userId}

    • List guardians: https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians

    Replace path parameters such as {'{courseId}'}, {'{courseWorkId}'}, {'{studentId}'}, and {'{userId}'} with the actual IDs for the resources you want to retrieve. Course and resource IDs can be obtained from prior API calls (for example, listing all courses to retrieve their IDs). For the complete list of available endpoints and their parameters, refer to the Google Classroom API reference documentation.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros — all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Date/time macros are useful for Google Classroom API endpoints that accept date filters as query parameters, such as filtering coursework by due date or filtering submissions by update time.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are particularly useful for the Google Classroom API when you need to iterate over course IDs retrieved from a prior "List courses" source to fetch roster or coursework data for each course dynamically.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data returned by the Google Classroom API endpoint is needed, you can designate the part of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. Google Classroom API responses are returned in JSON format and typically include a top-level array containing the resource records along with optional pagination tokens.

For example, a request to the /courses endpoint returns a JSON object with a courses array that contains the actual course records. By entering the path to this array, you configure Nexla to treat each element in the array as a separate record.

Path to Data is essential when working with Google Classroom API responses, as the API always wraps resource records inside a named array (e.g., courses, students, teachers, courseWork, studentSubmissions, topics, announcements). Without specifying the correct path, Nexla will treat the entire response object as a single record rather than extracting the individual items.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format, enter the JSON path that points to the array containing the resource records. JSON paths use dot notation (e.g., $.courses[*] to access each course in the courses array, or $.students[*] for student records).
    Path to Data Examples for Google Classroom API:
    • For /v1/courses responses, use $.courses[*] to extract individual course records.
    • For /v1/courses/{courseId}/students responses, use $.students[*] to extract individual student records.
    • For /v1/courses/{courseId}/courseWork responses, use $.courseWork[*] to extract individual coursework records.
    • For /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions responses, use $.studentSubmissions[*].
Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content and format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. Google Classroom API responses often include a nextPageToken field and other top-level metadata alongside the resource array. You can preserve this contextual information by specifying a metadata path.

Metadata paths are useful when you want to capture pagination tokens, request identifiers, or other response-level context that applies to all records returned by a Google Classroom API call.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field. For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers and corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers may be needed for API versioning or custom request parameters.

    You do not need to include Authorization headers — these are handled automatically by Nexla based on the Google OAuth 2.0 credential you configured. Common headers like Content-Type and Accept are also managed automatically.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows you to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched and displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Google Classroom API data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.