このページでは、Google Cloud プロジェクト内で Classroom アドオン用に Google Cloud プロジェクトを構成します。 Google Cloud プロジェクトは、OAuth 2.0 による Google シングル サインオンの実装に使用する (Google SSO など)を使用して、アドオンからのリクエストを承認したり、 Google Workspace Marketplace のアドオンのリストに あります
Google Chat にアドオンを公開する マーケットプレイスについては、アプリの公開をご覧ください。
Google Cloud プロジェクトの作成
作成するプロジェクトには 2 つのタイプがあります。1 つはプライベート プロジェクトで、もう一つは 2 つのプロジェクトに分けられます。「一般の人々」および 「非公開」ラベルとは、公開でのアプリケーションの公開、 Google Workspace Marketplace限定公開のマーケットプレイス アプリケーションをインストールしたドメイン内のユーザーのみがインストールできる 作成され、一般公開されている すべての Google Workspace ドメインで利用できます。これらは 2 つの異なる プロジェクトとして、パブリックとプライベートの両方を使用することはできません。一般公開アプリケーション Marketplace で利用できるようになる前に 審査と承認を受ける必要があります
Google Cloud プロジェクトの作成に関する一般的な情報については、 Google Cloud プロジェクト。
一般公開の Google Cloud プロジェクトを作成する
このプロジェクトは、アクセス可能なアドオン アプリケーションを表します。 管理、教師、生徒が含まれます。一般公開プロジェクトはレビューと Google Workspace Marketplace チームの承認を得たうえでリリースまたは インストールされています。
本番環境ドメインで新しい Google Cloud プロジェクトを作成します。
Cloud プロジェクトで Classroom API を有効にします。
Cloud プロジェクトで Google Workspace Marketplace SDK を有効にします。
Marketplace SDK を設定する アプリの構成 [アプリの公開設定] を [公開] に設定し、[限定公開] チェックボックスをオンにします。
Marketplace SDK の必須項目に入力します [ストアの掲載情報] ページに移動して [ 公開。
アプリが Google Workspace Marketplace チームによって審査されます。。 より、 Marketplace SDK。アプリが承認されたら、 [限定公開] チェックボックスをオンにして、教師と管理者が Marketplace。
限定公開の Google Cloud プロジェクトを作成する
この限定公開プロジェクトは、開発に使用されるアドオン アプリケーションを表します。 作成されたドメイン外のユーザーはアクセスできませんが、 インストール前に承認する必要はありませんそのため Google では このプロジェクトを使用して、制御された環境でアドオンの開発とテストを行います。
Teaching and Learning Upgrade アカウントでは Google Workspace for Education ドメインへのアクセス権が必要です。Learning Plus または Plus ライセンスが必要です。このような API へのアクセス権をまだ持っていない場合は、 次の手順に沿って Google Workspace for Education のデモドメインを設定し、 Plus のライセンスを作成し、Classroom アドオン API へのアクセスを許可します。
- デベロッパーのテストドメインを取得する手順を完了します。
デモドメインの管理者としてログインした状態で Google Cloud プロジェクトです
Google Cloud コンソールにアクセスできない場合や Cloud Identity の 作成するには、 管理コンソール:
- [アカウント設定] >年齢に基づくアクセス設定] ページで、 [このグループまたは組織部門のすべてのユーザーが 18 歳または 古いバージョンです。
- [アプリ] >その他の Google サービス:
- Google Cloud Platform はどなたでもご利用可能です。
- プロジェクト作成の設定が [ユーザーにプロジェクトの作成を許可する] に設定されている。
- Cloud Shell のアクセス設定は [Cloud Shell へのアクセスを許可する] になっています。
デモドメインのアップグレード リクエスト フォームに必要事項を入力して送信します。これを送信しています Google Workspace for Education Plus へのアップグレードを 10 回 その Cloud プロジェクトが他の Google Cloud リージョンに Classroom アドオン API。
アップグレードと許可リストのプロセスが完了すると、メールが届きます できます。のテスト用教師アカウントに Plus ライセンスを割り当てます 管理コンソールをご覧ください。アンダー ディレクトリ >ユーザー] をタップまたはクリックし、テスト用の教師のアカウントを作成または選択します。各 教師のライセンスで、Google Workspace for Education Plus が割り当て済みであることを確認します。
Cloud プロジェクトで Classroom API を有効にします。
Cloud プロジェクトで Google Workspace Marketplace SDK を有効にします。
Marketplace SDK を設定する アプリの構成 [App Visibility] を [private] にします。
Marketplace SDK の必須項目に入力します [ストアの掲載情報] ページに移動して [ 公開。アプリの掲載情報が公開されると、ドメイン内のユーザーは Google Workspace Marketplace でアプリを見つけてインストールする。または、 [ストアの掲載情報] ページに表示されているアプリの URL にアクセスします。
OAuth 2.0
Classroom API にアクセスするには、ユーザーデータへのアクセス権が必要です。これらの ログインしているユーザーの OAuth スコープへの Google アクセスを Google にリクエストすることで取得できる トークンを受け取ります。このトークンを使用して、後で API 呼び出しに Google Classroomスコープは Google Workspace Marketplace のストアの掲載情報に アドオンをインストールする場合、ドメイン ユーザーに代わって同意を取得できます。
利用可能なすべての API の詳細なリストについては、Google API の OAuth スコープのページをご覧ください。 その用途について説明します。Workspace ドキュメントの Configure OAuth ページを参照 をご覧ください。
ユーザー権限
ウェブアプリでは、次のスコープのうち少なくとも 1 つをリクエストする必要があります。
https://www.googleapis.com/auth/userinfo.email
を使用すると、 ユーザーのメールアドレスを表示します。https://www.googleapis.com/auth/userinfo.profile
を使用すると、 個人情報(例: ポートレート、姓名、名)を表示する ユーザーが公開した名前などの個人情報 できます。
ユーザーがアドオンでこれらのスコープのいずれかを承認すると、
login_hint
クエリ パラメータで識別されます。このパラメータは
必ず追加することをおすすめします。ユーザーが承認しなかった場合
login_hint
は送信されません。
login_hint
は、必要に応じて使用できる標準の OpenID Connect パラメータです。
Google ログインの使用時や OAuth トークンのリクエスト時に Google に渡します。これは、
は、エンドユーザーによる承認処理をスムーズにすることを目的としています。
Classroom アドオンのスコープ
以下のスコープは Classroom アドオンに固有のものです。
https://www.googleapis.com/auth/classroom.addons.teacher
を使用すると、 すべての API メソッドにアクセスできますhttps://www.googleapis.com/auth/classroom.addons.student
を使用すると、 権限があることを確認します。
ユーザーの認証情報を示す有効な OAuth アクセス トークンがあったとしても、 追加要件が適用されます。
- どの方法でも、ユーザーはコースの教師または生徒である必要があります
リクエスト内の
courseId
によって指定されます。 - 添付ファイルの作成、更新、削除、成績の送信には、 学びました。
- Google Classroom の特定の投稿への通話は、以下によって制限されます。
チェックを行います
- すでに投稿に添付されたアドオンは、
リクエストする対象:
- iframe 起動検証
- アタッチメントの読み取り、更新、削除オペレーション
- その投稿の更新情報を採点する
- 添付ファイルの検出 iframe を最初に開いたとき、アドオンが
投稿に添付ファイルがありません。
addOnToken
クエリ パラメータ を使って、以下をリクエストすることができます。- 投稿の下に添付ファイルを作成します(
addOnToken
は必須です) - リリースの検証(
addOnToken
が指定されている場合は検証され、 アドオンの既存の添付ファイルがない場合に必要 投稿)
- 投稿の下に添付ファイルを作成します(
- すでに投稿に添付されたアドオンは、
リクエストする対象:
OAuth の確認
Classroom アドオンは、Google API を使用して Google ユーザーの分析できます
詳細については、OAuth API の確認に関するよくある質問をご覧ください。 確認プロセスに進みます。
Google Workspace Marketplace リスティング
Google Workspace Marketplace SDK の一般的な構成情報については、以下をご覧ください。 Google Workspace Marketplace SDK を有効にして構成する Google Workspace Marketplace のストアの掲載情報を作成します。
リスティングに関する考慮事項
一般公開の Google Cloud プロジェクトの Marketplace SDK ストア Listing には、アプリケーションの名前と、 記述する必要がありますこれらの詳細は複数の [App Details] で言語を確認できます。
リスティングでは、次のガイドラインを遵守してください。
[App Details] で、以下の操作を行います。
アプリケーション名に句読点は使用しないでください。たとえば、「My Add-on by My Company」「My Company: My Add-on」をまたは 会社」です。
[Short Description] と [Detailed Description] には、 検索します。
+ [Pricing] フィールドの値が選択されていることを確認します。この フィールドに、[無料]、[無料トライアル付き]、[有料サービス: 、有料料金です。費用を指定する必要は 金額が表示されます。
[カテゴリ] フィールドの値が選択されていることを確認します。 学術リソースや教師用および管理者向けツールは、 Classroom アドオンです。
アイテムは、Marketplace のアプリ 詳細の説明をご覧ください。
[画像および映像] で、以下の操作を行います。
提供された画像および映像が不鮮明ではなく、指定されたサイズを満たしている Google Workspace Marketplace の基準
提供されるスクリーンショットは、アドオンを正確に表しています あります。
[サポートリンク] で、次の操作を行います。
- アプリケーションの利用規約 Service です。
Google API ブランドの取り扱いガイドラインに準拠していることを確認します。 使用できる名前と説明が記載されています。
リスティングで Google プロダクトに言及する場合は、 商標リストに記載されている形式を使用してください。必ず 商標(TM)記号(指定されている場合)「Google DocsTM」ではなく「Google 。
Google のライセンスおよび請求サービスと統合する
Google Workspace Marketplace アプリケーションを Google のライセンスおよび請求サービスと統合するには、にアクセスしてください。 Marketplace API
設置の設定
アドオンでは、管理者に加えて個別インストールを許可可能 インストールできます。このページでは、この 2 つのインストール方法の違いについて説明します。 できます。どちらかのインストール タイプをプロモートするものではありません。以下を選択できます。 Google Workspace Marketplace SDK で個別にインストールを許可するかどうか [App Configuration] ページ。
管理者によるインストール
管理者によるインストールでは、管理者がすべての または特定のアクセス グループや組織部門に割り当てることができます。単独 ドメイン管理者が管理者によるインストールを実行できます「 管理者は必要に応じて、すべてのユーザーに代わってすべてのアクセス スコープに同意できる ドメイン内です。アクセス スコープが IAM によって変更されている場合、 できます。
管理者によるインストールに関する考慮事項は次のとおりです。
- 厳密に管理。管理者は、スペースにアクセスできるユーザーを できます。
- ライセンスとの互換性。アプリにライセンスが必要な場合は 管理者を通じてインストールをチャネル化することで、 ライセンスが配布され、対応する あります
- エンドユーザーの負担を軽減。管理者によるインストールにより、 教師と生徒に負担がかかりますこれによって、ユーザーがよりシームレスに クリックや混乱を招く可能性も低くなります。
ドメイン内に Marketplace アプリをインストールする方法について詳しくは、ドメイン内に Marketplace アプリをインストールするをご覧ください。 管理者によるインストールと組織構造の仕組み をご覧ください。
個別インストール
個別インストールの場合は、ユーザーのアカウントにアドオンが追加されます。ユーザー インストール中にアドオンのアクセス スコープへの同意を求めるメッセージが表示されます。
個々のインストールに関する考慮事項は次のとおりです。
- 導入を促進する。より多くのユーザーが Google Workspace Marketplace個別にインストールを許可すると、プロンプトに プロダクトの導入や推奨の余地がある
- 管理者によるテスト。管理者は、Google Workspace の 承認またはインストールする前に、テストや評価を 考えてみましょう
管理者は、ユーザーの代わりにアドオンをインストールするほかに、 個別のユーザーへのアクセスを許可するアドオンをユーザーがインストールできるように許可リストを インストールできます。アドオンが許可リストに登録されていなくても、ユーザーは Google Workspace Marketplace に登録しているにもかかわらず、 add-on;代わりに、アドオンがインストールされていないことを説明するメッセージが表示されます。 許可するかどうかを設定できます。Google Workspace を管理する 許可リストに登録されている Marketplace アプリをご覧ください。
詳しくは、Google Workspace Marketplace のインストール設定に関するドキュメントをご覧ください。 ご確認ください。
アプリの統合
[添付ファイルの設定 URI] フィールドに、起動用の iframe URL を指定する必要があります。この
URL は、Attachment Discovery iframe の iframe src
値として使用されます。「
添付ファイル検出 iframe は、教師がコンテンツまたはアクティビティを
課題に添付します
アタッチメントを許可するすべての URI プレフィックスも指定する必要があります。 できます。この機能により、添付ファイルが暗号化され、 保護します。
これらのフィールドについて詳しくは、iframe ガイドページをご覧ください。
テスト アカウント
デモドメインでテスト アカウントを作成して、 できます。切り替えをテストするには、2 つの生徒アカウントが必要です 生徒の提出物の確認の iframe。
推奨されるテスト アカウント:
- Tammy Teacher、tammy.teacher@<デモドメイン>
- Sam Student、sam.student@<デモドメイン>
- Sally Student(sally.student@<お使いのデモドメイン>)
次の手順で新しいテスト アカウントを作成します。
- 管理コンソールにログインします。
- [ユーザー] に移動します。
- [新しいユーザーの追加] をクリックします(図 1 を参照)。
- ユーザーの情報を入力し、適切なロールを割り当てます。
図 1.[新しいユーザーを追加] リンクの場所
できます。
次の手順で新しいテストグループを作成します。
- 管理コンソールにログインします。
- [グループ] に移動します。
- [Create group] をクリックします(図 2 を参照)。
- グループのメンバーとオーナーを入力します。
図 2.[グループを作成] リンクの場所:
できます。