このページは Cloud Translation API によって翻訳されました。

アドオンの早期アクセスでメソッドをプレビューする

早期アクセスプログラムまたは限定公開プレビュープログラムの API メソッドは、非公開です。つまり、標準のクライアントライブラリでは公開されず、HTTP 経由でデフォルトでアクセスできない可能性があります。このページでは、これらのプレビューメソッドにアクセスする方法について説明します。

このドキュメントでは、Preview API を使用する 4 つのオプションについて説明します。

Google 提供の静的クライアントライブラリ。
動的に生成されるクライアントライブラリ。
直接 HTTP リクエスト。
独自のカスタムクライアントライブラリ。

API を使用するには、Google 提供の静的ライブラリまたは動的に生成されるライブラリを使用することをおすすめします。

静的ライブラリ

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 などの言語のライブラリは、ディスカバリサービスのディスカバリドキュメントを使用して、実行時にクライアントライブラリを生成します。

ディスカバリドキュメントは、REST API を記述して使用するための機械可読仕様です。クライアントライブラリ、IDE プラグイン、Google API とやり取りするその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリドキュメントを提供できます。

Classroom API サービス（classroom.googleapis.com）用のディスカバリドキュメントは、次のエンドポイントにあります。

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

Python ライブラリを生成し、アドオンメソッドで Classroom サービスをインスタンス化するには、適切なサービス、認証情報、ラベルを含む検出 URL を指定します。

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 クライアントライブラリのドキュメントをご覧ください。Preview API を使用する際の重要な違いは、適切な label を指定することです。このプレビューでは、ラベルは ADD_ONS_ALPHA です。

HTTP リクエスト

クライアントライブラリを使用せずに HTTP リクエストを行う場合は、X-Goog-Visibilities ヘッダーとしてラベル（ADD_ONS_ALPHA）を含めてください。

たとえば、投稿の下にあるアドオンによって作成されたすべての添付ファイルを表示するには、次の curl リクエストを使用します。

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

各 HTTP リクエストの API は、REST ドキュメントで説明されています。

カスタムクライアントライブラリ

独自のライブラリを作成する必要がある場合は、クライアントライブラリの作成をご覧ください。独自のライブラリの作成はこのガイドの対象外ですが、動的ライブラリのセクションを確認して、Discovery でのプレビューラベルとその役割を確認してください。