API呼び出しを行う前に、アプリ用のGoogle APIプロジェクトを設定する必要があります。これは、通常、Marketplaceアプリの開発の第一歩です。このプロジェクトでは、アプリケーションで使用される多くの設定とサービスが定義されています。プロジェクトを設定するには、以下が必要です。
- Google APIコンソールでプロジェクトを作成する
- アプリで使用するGoogleサービスを選択する
- G Suite Marketplace SDKおよびその他のサービスを設定する
- 該当する場合、あなたのアプリをサービスアカウントとして設定する
- アプリケーションで使用する必要がある適切なIDと秘密または鍵を取得する
次の段落では、これらの手順をより詳細に説明します。既存のアプリケーションをすでにお持ちの場合は、手順1と2を省略することができます。
準備するためのリソース
プロジェクトを設定するために必要なリソースは次のとおりです。
- 次の解像度でアプリのアイコン:32×32,48×48,96×96,128×128ピクセル
- ポップアップダイアログで使用するアイコンを指定することもできます。このアイコンは60×120ピクセル以下でなければなりません
- WebサーバーのURL、認可リダイレクトコールバック、および製品ホームページ(オプション)
これらのリソースのそれぞれは、下記の1つ以上のステップで必要となります。
新しいプロジェクトを作成する
Google APIコンソールに移動します。「プロジェクトの作成」をクリックして名前を入力し、「作成」をクリックします。
使用するサービスを選択する
Google Developers Consoleにアクセスし、G Suite Marketplace SDKを有効にし、アプリケーションに必要な他のサービス用にAPIまたはSDKを有効にする必要があります。あなたがここでそれらを有効にする場合、アプリはGoogleサービスにのみアクセスできます。
プロジェクトのAPIをアクティブにするには、次の手順を実行します。
- Google Developers ConsoleでAPIライブラリを開きます。プロンプトが表示されたら、プロジェクトを選択するか、新しいプロジェクトを作成します。APIライブラリには、利用可能なすべてのAPIが、製品ファミリごとおよび人気ごとにグループ化されて一覧表示されます。
- アクティブ化するAPIがリストに表示されない場合は、検索を使用してそのAPIを探します。
- アクティブ化するAPIを選択し、[APIを有効にする ]ボタンを選択します。
APIを有効にしたら、コンソールのAPIセクションにある有効APIリンクを使用して、有効になっているすべてのAPIのリストを表示します。リストから、APIを無効にして再度有効にすることができます。一部のAPIでは、サービスを有効にする前に利用規約に同意するよう求められます。
G Suite Marketplace SDKを設定する
多くのサービスでは追加の設定手順が必要です。G Suite Marketplace SDKはこれらの1つです。
有効になっているすべてのAPIのリストを表示するには、Google APIコンソールの APIセクションの[ 有効なAPI]リンクを使用してください。リストで、G Suite Marketplace SDKを見つけて、設定アイコンをクリックします。次の各設定を構成する必要があります。
- アプリケーション情報:アプリの次の情報を入力します:
- アプリの簡単な説明
- 各サイズのアイコン
- このオプションを許可する場合は、[個別インストールを有効にする]を選択します(下記参照)
- サポートURL:アプリの利用規約のURLを入力します。必要に応じて、リストされている他の種類のURLも入力します
- スコープ:アプリケーションがアクセスするサービスのOAuth2スコープを入力します
- 拡張機能:これらの設定はアプリの拡張機能を有効にします(下記参照)
完了したら[変更を保存]をクリックします。
個別のインストールを有効にする
通常、G Suite Marketplaceアプリケーションは、G Suiteドメイン管理者のみが表示およびインストールできます。以下のように個別インストールを有効にするを選択すると、個々のユーザーにアプリをインストールさせることができます。
これはChromeウェブストアのデベロッパーダッシュボードの表示オプションと相互作用します。
- 公開設定が非公開の場合、ドメイン内のユーザーのみがアプリを検出してインストールできます。
- 視認性がある場合は公開、その後、任意のユーザー、任意のGmailや他のGoogleユーザーGスイートドメイン内または単にかどうかは、アプリを発見し、インストールすることができます。
アプリリンク表示オプションについて
このペインのこのセクションでは、機能のいくつかの追加の領域を有効にして構成できます。
- Universal Navigation Extension これは、各Googleアプリのページの上部に表示されるユニバーサルナビゲーションバーに、アプリケーションのメニュー項目を配置します。表示されるフィールドにリンクURLを含める必要があります。
- ドライブ拡張機能 これにより、アプリがGoogleドライブアプリになります。また、サービスペインでGoogleドライブSDKを有効にする必要があります。GoogleドライブSDKを設定していない場合は、今すぐ設定する必要があります。
- COB拡張機能 これにより、Gmail Contextual Gadgetsでアプリを使用できるようになります。この拡張機能のパラメータは、表示されるダイアログで設定する必要があります。
- アドオン拡張機能 Googleスプレッドシート、ドキュメント、フォームのアドオンを 公開することができます。これらの拡張機能を使用するには、スクリプトキーとOAuthスコープのリストが必要です。
追加のサービスを設定する
設定が必要な他のサービスを有効にした場合、有効なAPIリストにも設定アイコンが表示されます。今これらのそれぞれを設定してください。(サービスの設定オプションの詳細については、そのサービスのドキュメントを参照してください)。
クライアントIDの作成
アプリケーションのクライアントIDと秘密鍵を作成する必要があります。作成するタイプは、作成するアプリケーションのタイプによって異なります。たとえば、サービスアカウントを使用してドメイン管理者がアプリケーションをinsallableにしたい場合は、この手順でサービスアカウントの資格情報を作成する必要があります。
WebアプリケーションクライアントIDを作成する
ではAPIアクセス・ペイン、OAuth 2.0のクライアントIDを作成]をクリックします。
- [クライアントIDの作成]ダイアログボックスが表示されます。ブランディングセクションで、製品名(必須)、製品ロゴ、ホームページURLを入力します。完了したら、[次へ]をクリックします。
- [クライアントIDの設定]セクションで、[アプリケーションタイプ]に[Webアプリケーション]を選択し、アプリのベースURLを入力します。(許可されたリダイレクトURIまたはJavaScriptの原点を変更する必要がある場合は、さらにオプションをクリックします)。完了したら、[次へ]をクリックします。
- [クライアントIDの作成]ボタンをクリックします。
- ダイアログボックスが表示され、サービスアカウントの秘密鍵をダウンロードできます。[秘密鍵のダウンロード]をクリックします。
ではAPIアクセスペイン、WebアプリケーションのセクションのクライアントIDを見つけて、クライアントIDとクライアントシークレットを注意してください。アプリからの認証コールを行うにはこれらが必要です。
サービスアカウントクライアントIDを作成する
エンドユーザーにアプリケーションを個別にインストールさせたい場合は、サービスアカウントはオプションです。
ただし、ドメイン管理者がG Suiteドメイン内のすべてのユーザーに対してアプリケーションをインストールする場合は、サービスアカウントを使用してください。サービスアカウントにより、Gスイートのドメイン管理者は、ドメイン内のユーザーに代わってユーザーデータにアクセスするドメイン全体の権限をサービスアカウントに付与できます。
サービスアカウントについては、「サーバーアプリケーションへのOAuth 2.0の使用」のドキュメントで詳しく説明しています。
アプリケーションでサービスアカウントを使用する場合は、サービスアカウントの資格情報を作成する必要があります。
- [別のクライアントIDを作成…]ボタンをクリックします。
- アプリケーションタイプのサービスアカウントを選択し、アプリのベースURLを入力します。(許可されたリダイレクトURIまたはJavaScriptの原点を変更する必要がある場合は、さらにオプションをクリックします)。
- [クライアントIDの作成]ボタンをクリックします。
[ APIアクセス]ウィンドウで、サービスアカウントのクライアントIDを見つけて記録します。あなたのアプリはあなたのサービスアカウントから認証電話をかけるために、ダウンロードした秘密鍵と共にこのIDを必要とします。