Google Workspace Marketplace SDK でアプリを構成する

このページでは、Google Workspace Marketplace SDK を使用して Google Workspace Marketplace でアプリを構成して管理する方法について説明します。

アプリを使えるようにするには、Marketplace SDK で設定する必要があります。Marketplace SDK は、Google Workspace Marketplace でアプリを作成、管理できるツールキットです。Marketplace SDK を使用すると、次のような Marketplace の設定を管理できます。

  • アプリを特定の Google Workspace 組織(限定公開アプリ)でのみ利用可能にするのか、すべての Marketplace ユーザー(公開アプリ)で利用可能にするのか
  • アプリをインストールできる Marketplace ユーザーの種類
  • アプリが統合されている Google Workspace アプリ
  • アプリに必要な OAuth スコープ
  • アプリを作成、維持している組織に関する情報

アプリを限定公開または一般公開するかどうかにかかわらず、Marketplace SDK を使用して Marketplace でアプリを管理する必要があります。

Marketplace SDK を有効にする

まだ有効にしていない場合は、Google Cloud プロジェクトで Google Workspace Marketplace SDK を有効にします。

Google Cloud コンソールで Cloud プロジェクトを開きます。

このサンプルに使用する Cloud プロジェクトをまだ開いていない場合は、開きます。

  1. Google Cloud コンソールで [プロジェクトを選択] ページに移動します。

    Cloud プロジェクトを選択する

  2. 使用する Google Cloud プロジェクトを選択します。または、[プロジェクトを作成] をクリックし、画面の指示に沿って操作します。Google Cloud プロジェクトを作成する場合は、プロジェクトの課金を有効にする必要がある場合があります。

Google Workspace Marketplace SDK を有効にする

Google API を使用する前に、Google Cloud プロジェクトで API を有効にする必要があります。1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。
  • Google Cloud コンソールで、Google Workspace Marketplace SDK を有効にします。

    SDK を有効にする

アプリの構成設定を決定する

次のリファレンスでは、Marketplace SDK の [アプリの設定] ページで使用できる設定について説明します。

アプリを表示、インストールできるユーザーを選択する

アプリを構成するときに、次の設定を使用してアプリにアクセスできるユーザーを指定します。

  • アプリの公開設定: Google Workspace 組織内でアプリを公開する場合、アプリのリスティングを非公開にするかどうか、組織内のすべてのユーザーに公開するか、Google Workspace を使用しているすべてのユーザーに公開するかを指定します。
  • インストール設定: アプリを Google Workspace 管理者のみがインストールできるかどうか。

アプリのリスティングで指定した設定に関係なく、Google Workspace 組織に属するユーザーは、管理者が設定した設定に基づいて、アプリを検出、インストール、使用できない場合があります。管理者は、次のような方法でアプリの可用性に影響を与えることができます。

  • ユーザーが Marketplace でアプリを表示できるかどうかを管理し、ユーザーに代わってアプリをインストールします。
  • 許可リストを使用して、組織のアプリを管理、キュレートします。許可リストを使用する組織向けのアプリを開発している場合は、アプリを許可リストに追加する方法について管理者に確認してください。
  • Google Chat、Google Chat アプリ、またはその両方へのアクセス権を削除するなど、特定の Google Workspace アプリケーションを無効にします。この場合、ユーザーは Marketplace からアプリをインストールできません。

管理者が Marketplace へのアクセスを管理する方法については、 Marketplace 管理者向けヘルプ ドキュメントをご覧ください。

アプリの公開設定

Google Workspace アカウント(職場または学校の組織によって作成されたアカウント)を使用している場合は、[アプリの公開設定] オプションが表示されます。一般ユーザー アカウント(末尾が @gmail.com のアカウント)を使用している場合は、公開設定のみ可能です。

  • 公開: ドメイン外のユーザーがアプリを見つけてインストールできます。公開設定を選択した場合、アプリのリスティングは公開前に Google によって審査され、承認されます。
  • 非公開: ドメイン内のユーザーのみがアプリを見つけてインストールできます。

[非公開] として公開すると、アプリのリスティングは閲覧結果や検索結果に表示されなくなります。ユーザーは、直接 URL を使用してのみアプリのストアページにアクセスできます。

アプリを利用できる国や地域を制限する場合は、ストアのリスティングを作成するときに [配信] セクションで設定します。

アプリのインストール設定

[インストール設定] オプションでは、ユーザーまたは Google Workspace 管理者が Google Workspace Marketplace のストアの掲載ページからアプリをインストールできるかどうかを指定します。

  • 個別インストールと管理者によるインストール(デフォルト): アプリは、個々のユーザーがインストールできます。また、ドメイン、組織部門、またはユーザー グループの管理者がインストールすることもできます。個々のインストールが有効になっている場合でも、ユーザーのドメイン ポリシーによってアプリをインストールできないことがあります。
  • 管理者のみによるインストール: アプリは、ドメイン、組織部門、またはユーザー グループの管理者のみによってインストールできます。アプリは、Google Workspace Marketplace の検索結果で、管理者と Google アカウントにログインしていないユーザーにのみ表示されます。アプリにドメインのインストールが必要な場合は、このオプションを選択します。

一般的な設置と公開設定

次の表に、インストールと公開に関する一般的なアプリ構成オプションを示します。

対象となるアプリのユーザー アプリの公開設定 アプリのインストール設定 アプリをインストールできるのは誰ですか? アプリを使用できるのは誰ですか?
Google Workspace 組織用にビルドされたアプリの場合  
組織内の特定のユーザー 非公開限定公開 個別インストールと管理者によるインストール 許可されている場合、アプリのリスティング URL を知っている組織内のすべてのユーザー。 許可されている場合、アプリのリスティング URL を知っている組織内のすべてのユーザー。
あなたの組織 プライベート 個別インストールと管理者によるインストール 許可されている場合、組織内の全員。 許可されている場合、組織内の全員。
あなたの組織 プライベート 管理者のみ 管理者 管理者によってアプリがインストールされているユーザー。
特定の Google Workspace 組織外のユーザーが利用できるアプリの場合  
Google Workspace 組織のユーザー 公開 管理者のみ 管理者 管理者によってアプリがインストールされているユーザー。
すべての Google Workspace ユーザー 公開 個別インストールと管理者によるインストール
  • Google Workspace アプリケーションを個人で使用しているすべてのユーザー。
  • 許可されている場合、Google Workspace 組織内のユーザー。
  • Google Workspace アプリケーションを個人で使用しているすべてのユーザー。
  • 許可されている場合、Google Workspace 組織内のユーザー。

アプリが Google Workspace アプリケーションとどのように統合されているかを確認する

アプリまたはアドオンが連携するように設計されている Google Workspace サービス(Google Workspace アドオンや Google Chat アプリなど)を選択します。少なくとも 1 つのオプションを選択する必要があります。場合によっては、アプリのリスティングに複数のアプリ統合を含めることができます。アプリの統合を一覧表示するをご覧ください。

選択したアプリの統合によっては、追加情報を提供して、Google Cloud プロジェクトで関連する API を有効にする必要があります。次の表に、それぞれに必要な追加の設定を示します。

Google Workspace アドオン(Apps Script)

Google Workspace アドオンを公開するには、アドオンのデプロイ ID を指定する必要があります。デプロイ ID を確認する手順は次のとおりです。

  1. Apps Script エディタで Google Workspace アドオンを開きます。
  2. [Deploy] > [ Manage deployments] をクリックします。
  3. デプロイ ID で [コピー] をクリックします。

Google Workspace アドオン(HTTP デプロイ)

HTTP エンドポイントを使用して Google Workspace アドオンをビルドした場合は、次の手順で Google Cloud デプロイ リソースからデプロイ ID を取得します。

  1. [アプリの構成] ページの [Google Workspace アドオン] で、[HTTP またはその他のデプロイ> デプロイを選択] をクリックします。
  2. 公開するデプロイメントを選択します。
  3. [選択] をクリックします。

エディタのアドオン(ドキュメント、スプレッドシート、スライド、フォーム)

エディタ アドオンを公開するには、公開するプロジェクト スクリプト IDバージョンを指定する必要があります。

プロジェクト スクリプト ID を確認する手順は次のとおりです。

  1. Apps Script エディタでアドオンを開きます。
  2. 左側の [プロジェクト設定] をクリックします。
  3. [ID] でスクリプト ID をコピーします。

バージョンを確認する手順は次のとおりです。

  1. Apps Script エディタでアドオンを開きます。
  2. 右上の [Deploy> Manage deployments] をクリックします。
  3. バージョン番号は [構成] の下にあります。

Google Chat 用アプリ

Google Chat アプリを公開するには、Google Chat API を構成する必要があります。Google Chat アプリを公開するをご覧ください。

ドライブ アプリ

ドライブ アプリを公開するには、 Google Drive API を有効にして構成する必要があります。

ウェブアプリ

ウェブアプリを公開するには、ユニバーサル ナビゲーション URL(Google アプリ メニュー からウェブアプリを参照する URL)を指定する必要があります。ウェブアプリは本番環境にあり、完全に機能している必要があります。

ストアの掲載情報ページに入力する際に、96x96 ピクセルと 48x48 ピクセルのサイズの追加のアイコンを用意する必要があります。

Apps Script でウェブアプリを作成した場合は、次の手順でユニバーサル ナビゲーション URL を取得します。

  1. Apps Script エディタで Google Workspace アドオンを開きます。
  2. [Deploy] > [New deployment] をクリックします。
  3. [タイプを選択] で [ウェブアプリ] をクリックします。
  4. オプションに入力して、[デプロイ] をクリックします。
  5. [コピー] をクリックします。

アプリに必要なアクセス権限のレベルを指定する

[OAuth スコープ] で、アプリに必要な OAuth 2.0 スコープの完全なリストを指定します。ここで入力する OAuth スコープは、OAuth 同意画面と、該当する場合は Apps Script マニフェストに表示されるスコープと一致している必要があります。

複数のアプリ統合を追加する場合は、各アプリのスコープを Marketplace SDK アプリ構成ページと OAuth 同意画面に追加してください。

可能な限り狭いスコープを使用してください(たとえば、読み取り専用スコープのみが必要な場合は、完全なドライブ スコープを含めないでください)。

Apps Script プロジェクトの場合、詳しくは承認スコープをご覧ください。

アプリ デベロッパーに関する情報を提供する

[デベロッパー情報] で、連絡先情報などの詳細を入力します。これらのフィールドは、アプリのストアの掲載情報ページに表示されます。

フィールド
取引業者ステータス

消費者保護法により、欧州経済領域(EEA)に居住する消費者には、Google Workspace Marketplace の販売者がトレーダーであるか、トレーダーではないかを通知する必要があります。

  • トレーダー: トレーダーとは、商業、ビジネス、技術、職業に関連する目的で活動する個人、またはトレーダーの名前または代理で活動する個人です。
  • トレーダーではない: トレーダーではない(消費者)とは、専門的な目的以外の目的で活動する個人です。

指定しない場合、アプリのストアの掲載情報ページに「トレーダーのステータス未指定」と表示されます。

デベロッパー名 アプリの作成者として表示する名前。トレーダーの場合は、商号または登録名を入力してください。
デベロッパーの住所

トレーダーには必須です。取引業者以外は収集されません。

ビジネスの所在地。連絡可能な有効な住所を入力してください。

デベロッパーのウェブサイトの URL デベロッパーとしてお客様(またはお客様の組織)を紹介しているウェブサイト。
デベロッパーのメールアドレス

連絡先として使用するメールアドレス。アプリの掲載情報に含まれていません。このメールアドレスは使用されるため、最新の状態に保ってください。

  • Google がデベロッパーに連絡する必要がある場合(アプリの審査プロセス中など)。
  • ストアの掲載情報ページに [問題を報告] URL が表示されない場合に、編集者アドオンからフィードバックを送信するには。
申請ウェブサイトの URL 省略可。アプリの詳細を説明するウェブサイト。

Marketplace SDK でアプリの構成設定を保存する

前のセクションの情報を使用して、Marketplace SDK にアプリ構成を保存します。

  1. Google Cloud コンソールで、Marketplace SDK の [構成] ページに移動します。

    [Marketplace SDK の設定] ページに移動

  2. 前のセクションで確認した内容に基づいて、各セクションに入力します。

  3. [保存] をクリックします。

  4. (省略可)Google アナリティクスアプリの使用状況に関する分析情報を取得できます。これを行うには、Marketplace SDK に Google アナリティクス ID を追加します。

    1. [分析] タブに移動します。
    2. Google アナリティクス ID を入力します。
    3. [保存] をクリックします。