如何为推送通知注册 Google Classroom API？

Question

我想创建一个程序来接收来自我的 Google Classroom 的相关通知，并对这些数据进行处理。 我如何注册 Google Classroom 以对事件做出反应？ 我还没有做任何东西，我对谷歌的API一无所知。 我应该怎么办？

Answer 1

为推送通知注册 Google Classroom API 的过程包括身份验证、授权和解析向 Google 发出的请求以告知您的 Classroom 发送这些推送通知。

我强烈建议您使用 Java 编程语言了解 Google Cloud 平台的基本知识，这与我尝试这样做时不同。 相信我……这并不好玩。 我相信你会充分理解这个概念，以便能够将它转移到你选择的语言中，我在 Java 中做到了这一点，使用 IntelliJ IDEA 作为我的 IDE。

除了 Google Classroom API 之外，Google 还为其集合提供了另一项服务，称为“Pub/Sub”。 Pub/Sub 代表发布者/订阅者。 如果您熟悉队列的工作原理，请将 Pub/Sub 视为一种改进的队列系统。 您有一个发布者，他在“主题”上发布消息，还有一个订阅者从主题中提取消息，并选择是否“确认”该消息。 确认消息会将其从队列中删除。 例如，发布者代码向主题发送消息“Hello, World”。 该消息将保留在主题中，直到该主题的订阅者选择拉取消息、阅读“Hello, World”并确认该消息，因此在拉取消息时不会再次弹出。 发布者可以发送任意数量的消息。 发布者可以发送 10 条消息，订阅者可以选择将它们全部拉出并遍历它们，或者一次只提取几条。

这适用于此系统，因为您将使用 Google Classroom API 的内置功能，该功能允许 API 充当“发布者”并向您选择的主题发送更新消息。 然后，您将有一个单独的应用程序随时检查更新。 现在为了简化它，您告诉 Classroom API“请向该主题发送更新消息。我只希望在教师以任何方式编辑课程作业目录时更新”。 Classroom API 将遵循此请求，每当教师编辑、发布或删除等时，程序将向您的主题发送消息。

如果您的课堂发布者一天发送 5 次更新，您将有 5 条可提取的消息发送到您的主题，该主题的任何订阅程序都可以提取和确认。

如果你不够了解，在你看来。 拜托，请在继续之前对 Google Cloud Pub/Sub 进行一些研究，因为这样做基本上是围绕此服务展开的。

让我们一步一步来...

1. 创建一个新项目
2. 启用课堂 API 和 PubSub API
3. 启用计费
4. 转到“IAM 和管理”
5. 授予所有者权限“classroom-notifications@system.gserviceaccount.com”
6. 使用“用户数据”为 Classroom API 和“基于 UI 的平台”设置凭据
7. 设置同意屏幕。 现在只需添加一个应用程序名称。
8. 创建凭据作为“OAuth 客户端 ID”
9. 选择应用程序类型 > 其他。 不要介意客户名称
10. 下载 JSON 文件。 将其重命名为“credentials_temp.json”
11. 创建一个基于 Gradle 的 Java 项目（我使用的是 IntelliJ）。 群号：temp。 工件 ID：temp。 项目名称：温度
12. 将其添加到“依赖项”下的 build.gradle

compile 'com.google.api-client:google-api-client:1.23.0'
compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
compile 'com.google.apis:google-api-services-classroom:v1-rev135-1.23.0'

13. 将 build.gradle 中的sourceCompatibility变量设置为11
14. 导入这些更改（右下角可能有一个小框，上面写着“导入更改”选项）
15. 将凭据文件放在 src/main/resources 中
16. 在 src/main/java 中，新建一个类。 将其命名为“TempTest.java”
17. 使用我为您编写的代码

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.client.util.store.FileDataStoreFactory;
import com.google.api.services.classroom.Classroom;
import com.google.api.services.classroom.model.*;

import java.io.*;
import java.security.GeneralSecurityException;
import java.util.ArrayList;
import java.util.List;

import static com.google.api.services.classroom.ClassroomScopes.all;

public class TempTest {
    private static final String APPLICATION_NAME = "Google Classroom API Java Quickstart";
    private static final JsonFactory JSON_FACTORY = JacksonFactory.getDefaultInstance();
    private static final String TOKENS_DIRECTORY_PATH = "tokens";
    private static final String CREDENTIALS_FILE_PATH = "/credentials.json";
    private static List<String> SCOPES = new ArrayList<>();
    private static Classroom service;
    private static String TOPIC_NAME = "projects/temp-260404/topics/temp";
    private static String COURSE_ID = "47737005203";

    static {
        SCOPES.addAll(all());
    }

    public static void main(String... args) throws IOException, GeneralSecurityException {

        final var HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
        service = buildClassroomService(HTTP_TRANSPORT);

//      registerForPushNotifications();

        List<Course> courses = getAllCourses();

        if (courses == null || courses.size() == 0)
            System.out.println("No courses found.");
        else {
            System.out.println("\nCourses:");

            for (var currentCourse : courses)
                System.out.println(currentCourse.getName() + "(" + currentCourse.getId() + ")");
        }
    }

    private static void registerForPushNotifications() throws IOException {
        final var pubSupTopic = new CloudPubsubTopic()
                .setTopicName(TOPIC_NAME);

        final var courseWorkChangesInfo = new CourseRosterChangesInfo()
                .setCourseId(COURSE_ID);

        final var feed = new Feed()
                .setFeedType("COURSE_WORK_CHANGES")
                .set("courseWorkChangesInfo", courseWorkChangesInfo);

        Registration notificationsRegistration = new Registration()
                .setFeed(feed)
                .setCloudPubsubTopic(pubSupTopic);

        pubSupTopic.setFactory(JSON_FACTORY);
        courseWorkChangesInfo.setFactory(JSON_FACTORY);
        feed.setFactory(JSON_FACTORY);
        notificationsRegistration.setFactory(JSON_FACTORY);

        service.registrations().create(notificationsRegistration).execute();
        System.out.println("Successfully registered");
    }

    private static Classroom buildClassroomService(final NetHttpTransport HTTP_TRANSPORT) throws IOException {
        final var serviceCredentials = getCredentials(HTTP_TRANSPORT);

        return new Classroom.Builder(HTTP_TRANSPORT, JSON_FACTORY, serviceCredentials)
                .setApplicationName(APPLICATION_NAME)
                .build();
    }

    private static Credential getCredentials(final NetHttpTransport HTTP_TRANSPORT) throws IOException {
        final var clientSecrets = loadJSONClientSecrets();
        final var dataStoreFactory = new FileDataStoreFactory(new File(TOKENS_DIRECTORY_PATH));

        final var authenticationFlow = new GoogleAuthorizationCodeFlow.Builder(
                HTTP_TRANSPORT, JSON_FACTORY, clientSecrets, SCOPES)
                .setDataStoreFactory(dataStoreFactory)
                .setAccessType("offline")
                .build();

        return redirectToAuthentication(authenticationFlow);
    }

    private static GoogleClientSecrets loadJSONClientSecrets() throws IOException {
        final var credentialFileStream = getCredentialsJSONFile();
        if (credentialFileStream == null)
            throw new FileNotFoundException("Resource not found: " + CREDENTIALS_FILE_PATH);

        return GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(credentialFileStream));
    }

    private static InputStream getCredentialsJSONFile() {
        return TempTest.class.getResourceAsStream(CREDENTIALS_FILE_PATH);
    }

    private static Credential redirectToAuthentication(GoogleAuthorizationCodeFlow flow) throws IOException {
        final var receiver = new LocalServerReceiver.Builder().setPort(8888).build();
        return new AuthorizationCodeInstalledApp(flow, receiver).authorize("user");
    }

    private static List<Course> getAllCourses() throws IOException {
        ListCoursesResponse response = service.courses().list()
                .execute();

        return response.getCourses();
    }
}

18. 转到 Google 课堂并创建您自己的课堂以进行测试。
19. 转到 Pub/Sub 并创建一个新主题。 确保将其设置为“Google 托管密钥”。 制作时在“主题名称”下获取其名称。 有一个用于复制完整路径的小按钮。
20. 将类的 TOPIC_NAME 字段设置为包含您刚刚复制的主题名称的字符串
21. 运行代码并授权所有范围。 您将被重定向。 确保选择与使用 Cloud Platform 的帐户相同的帐户。
22. 运行它会在括号中为您提供课程列表及其 ID 号。 复制你做的测试课程的ID号。 它应该在运行代码后输出到控制台。
23. 将课程的 COURSE_ID 字段设置为包含您刚刚复制的 ID 的字符串
24. 取消第 40 行的注释并再次运行代码
25. 你完成了我的例子

您刚才所做的是验证您自己的身份，以便 Google 知道您授予它什么权限，并且它可以验证您的身份。 然后，您向 Google 发送了一个 JSON 请求，其中包含有关您希望将更新发布到哪个主题、要获取的更新类型以及从中获取这些更新的特定教室的信息。

我强烈建议您在此处了解 JSON 响应的结构是如何工作的。 也许从这里开始。

谷歌文档上的这个页面有不错的信息。 它还显示了您将使用 Google Pub/Sub API 从另一个程序中提取的消息的 JSON 格式。 我没有把它包括在这里。

谢谢你，祝你好运。 抱歉，我可能会多次编辑这个问题。 我现在真的很累。