搶先體驗版外掛程式中的預覽方法

搶先體驗或不公開預先發布版程式中的 API 方法為不公開， 它們不會在標準用戶端程式庫中公開，且可能不會 預設可透過 HTTP 存取本頁說明如何存取這些 預覽方法。

本文件討論使用預覽 API 的四個選項：

  1. Google 提供的靜態用戶端程式庫。
  2. 動態產生的用戶端程式庫。
  3. 直接 HTTP 要求。
  4. 您專屬的自訂用戶端程式庫。

使用 Google 提供的靜態或動態產生程式庫 我們會建議他們如何使用 API

靜態程式庫

如果用戶端程式庫支援 Java、Node.js、PHP 和 C# 等程式語言，就必須從 來源。您可在用戶端程式庫下載中取得這些程式庫。 而且已有預覽方法

您可能需要修改一般依附元件設定，才能使用這些元件 不必匯入標準用戶端程式庫 可以使用預覽方法

舉例來說，如果您使用 Node.js 和 npm，請新增 Node.js 用戶端程式庫 下載 (googleapis-classroom-1.0.4.tgz) 做為本機依附元件 package.json:

{
  "name": "nodejs-classroom-example",
  "version": "1.0.0",
  ...
  "dependencies": {
    "@google-cloud/local-auth": "^2.1.0",
    "googleapis": "^95.0.0",
    "classroom-with-addons": "file:./googleapis-classroom-1.0.4.tgz"
  }
}

然後在應用程式中，除了 classroom-with-addons 模組外，還需要 使用 模組 再從該位置將 classroom 服務執行個體化 模組：

const {authenticate} = require('@google-cloud/local-auth');
const {google} = require('googleapis');
const classroomWithAddons = require('classroom-with-addons');

...

const classroom = classroomWithAddons.classroom({
  version: 'v1',
  auth: auth,
});

...

動態程式庫

使用 Python 等程式語言的程式庫，在執行階段利用 從 Discovery 服務取得 探索文件。

「探索文件」是一種機器可讀取的規格，用於說明和 使用 REST API它的用途是建構用戶端程式庫、IDE 外掛程式，以及 其他與 Google API 互動的工具一項服務可能會提供 探索文件。

Classroom API 服務的探索文件 您可在下列端點找到 (classroom.googleapis.com)：

  • https://classroom.googleapis.com/$discovery/rest?labels=<PREVIEW_LABEL>&version=v1&key=<PREVIEW_LABEL>

如何產生 Python 程式庫並使用 外掛程式方法，您就能使用適合的服務指定 Discovery 網址、 憑證和標籤

classroom_service_with_rubrics = googleapiclient.discovery.build(
  serviceName="classroom",
  version="v1",
  credentials=credentials,
  static_discovery=False,
  discoveryServiceUrl=f"https://classroom.googleapis.com/$discovery/rest?labels=ADD_ONS_ALPHA&key=ABCXYZ")

請參閱個別 Google API 用戶端程式庫說明文件，瞭解各個 API 詳情 語言。使用預覽 API 時，必須明確區別 適當的 label。在這個預覽畫面中，標籤為 ADD_ONS_ALPHA。

HTTP 要求

如果您在沒有用戶端程式庫的情況下發出 HTTP 要求，請務必加入標籤 (ADD_ONS_ALPHA) 做為 X-Goog-Visibilities 標頭。

舉例來說，如要查看外掛程式在訊息底下建立的所有附件，請使用 下列 curl 要求：

curl \
  'https://classroom.googleapis.com/v1/courses/[courseId]/courseWork/[itemId]/addOnAttachments?key=[YOUR_API_KEY]' \
  --header 'X-Goog-Visibilities: ADD_ONS_ALPHA' \
  --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
  --header 'Accept: application/json' \
  --compressed

REST 說明文件中提供了各 HTTP 要求的 API。

自訂用戶端程式庫

如果您需要建構自己的程式庫，請參閱建構用戶端程式庫。建立中 您自己的程式庫不在本指南的涵蓋範圍內，但請務必詳閱 動態程式庫一節，瞭解預覽標籤及其在以下項目中的角色： 曝光：