ドライブの UI 統合を構成する

ユーザーがファイルを作成または開いたときに Google ドライブにアプリを表示するには、まずドライブのユーザー インターフェース（UI）統合を設定する必要があります。Google Workspace Marketplace にアプリを掲載する場合も、構成が必要です。

ドライブ API を有効にする

Google API を使用する前に、Google Cloud プロジェクトで API を有効にする必要があります。1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。

Google ドライブ UI との統合を開始するには、Drive API を有効にする必要があります。これにより、API と UI 統合機能にアクセスできるようになります。

• Google Cloud コンソールで、Google ドライブ API を有効にします。

  API の有効化

ドライブ UI の統合を設定する

1. Google API コンソールで、メニュー > [API とサービス] > [有効な API とサービス] に移動します。

   [有効な API とサービス] に移動

2. [API とサービス] ダッシュボードの下部にある [Google Drive API] をクリックします。Google ドライブ API の構成ページが表示されます。
3. [Drive UI integration] タブを選択します。
4. （省略可）[アプリケーション名] フィールドに名前を入力します。アプリケーション名は、ドライブの設定の [アプリの管理] タブでユーザーに表示されます。
5. （省略可）[簡単な説明] フィールドに、1 行の簡単な説明を入力します。簡単な説明は、ドライブの設定の [アプリを管理] タブでユーザーに表示されます。
6. （省略可）[長い説明] フィールドに詳細な説明を入力します。

7. 1 つ以上のアプリアイコンをアップロードして、ユーザーの接続済みドライブ アプリの一覧と [開く] コンテキスト メニューに表示します。アイコンは背景が透明な PNG 形式にする必要があります。アイコンがドライブに表示されるまでに、最長で 24 時間ほどかかることがあります。

   注: ドキュメント アイコンは非推奨になりました。アプリケーション アイコンは、ショートカット ファイルとサードパーティのショートカット ファイルの横に表示されます。他のファイル形式には標準アイコンのセットが使用されます。

8. ドライブの UI の [アプリで開く] メニュー項目を使用するには、[開く URL] フィールドにアプリの URL を入力します。この URL は [開く] コンテキスト メニューで使用されます。

   • この URL には完全修飾ドメイン名を含める必要があります。localhost は使用できません。
   • この URL は、アプリケーションの対象ユーザーがアクセスできる必要があります。一般公開用と一部のユーザーへの限定公開用など、複数のアプリ バージョンがある場合は、各バージョンで固有の URL を使用する必要があります。その後、バージョンごとに異なるアプリ構成を作成できます。
   • Google Workspace Marketplace にアプリを掲載するには、事前にこの URL の所有権を証明する必要があります。
   • デフォルトでは、この URL に state クエリ パラメータが付加され、ドライブ UI からアプリにデータが渡されます。state パラメータの内容については、state パラメータをご覧ください。
   警告: OAuth 2.0 同意画面を自動的に表示するオプションは非推奨になりました。このチェックボックスはオンにしないでください。アプリケーションはすべての認証リクエストを開始する必要があります。

9. （省略可）[デフォルトの MIME タイプ] フィールドと [デフォルトのファイル拡張子] フィールドに、デフォルトの MIME タイプとファイル拡張子を入力します。デフォルトの MIME タイプとファイル拡張子は、アプリが独自に開くように構築されたファイルを表します。たとえば、アプリで、画像をレイヤリングして編集するための組み込み形式を開くことができます。標準のメディアタイプのみを含め、誤字脱字がないことを確認してください。アプリがショートカット ファイルまたはサードパーティ製ショートカット ファイルのみを開く場合は、MIME タイプを空白のままにできます。

10. （省略可）[Secondary MIME types] フィールドと [Secondary file extensions] フィールドに、セカンダリ MIME タイプとファイル拡張子を入力します。セカンダリ MIME タイプとファイル拡張子は、アプリで開くことができるが、アプリに固有ではないファイルを表します。たとえば、PNG 画像と JPG 画像を開く画像編集アプリなどです。標準のメディアタイプのみを含め、誤字脱字がないことを確認してください。アプリがショートカット ファイルまたはサードパーティ製ショートカット ファイルのみを開く場合は、MIME タイプを空白のままにできます。

    注: ファイルを開くことができるドライブ アプリを複数インストールしている場合、ユーザーが別のアプリを選択するまで、最後にインストールしたアプリが使用されます。

11. ドライブ UI の [新規] ボタンを使用して、ユーザーがアプリでファイルを作成できるようにするには、[ファイルの作成] チェックボックスをオンにします。[新しい URL] フィールドと、必要に応じて [ドキュメント名] フィールドが表示されます。

    • この URL には完全修飾ドメイン名を含める必要があります。localhost は使用できません。
    • Google Workspace Marketplace にアプリを掲載するには、事前にこの URL の所有権を証明する必要があります。
    • デフォルトでは、この URL に state クエリ パラメータが付加され、ドライブ UI からアプリにデータが渡されます。state パラメータの内容については、state パラメータをご覧ください。

12. [新しい URL] フィールドに URL を入力します。この URL は、[新規] ボタンでユーザーをアプリケーションにリダイレクトするために使用されます。

    注: [Document name] フィールドは空欄のままにします。このフィールドは使用されなくなりました。

13. （省略可）アプリで Google Workspace 対応ファイルを開く場合は、[インポート] チェックボックスをオンにします。

14. （省略可）アプリで共有ドライブのファイルを管理する必要がある場合は、[共有ドライブのサポート] チェックボックスをオンにします。アプリで共有ドライブをサポートする方法について詳しくは、共有ドライブのサポートを実装するをご覧ください。

15. [送信] をクリックします。

drive.install スコープをリクエストする

アプリを [開く] メニューまたは [新規] メニューのオプションとして表示するには、Drive UI と統合するための https://www.googleapis.com/auth/drive.install スコープをリクエストします。このスコープをリクエストすると、ユーザーに次のようなダイアログが表示されます。

図 1. ドライブ UI のスコープを使用する場合のインストール ダイアログ。

ドライブアプリでリクエストできるスコープと、そのリクエスト方法について詳しくは、API 固有の認可と認証情報をご覧ください。

注: Google Workspace Marketplace に ドライブアプリを公開すると、ユーザーとドメイン管理者は Google Workspace Marketplace からアプリを直接検索してインストールできます。

state パラメータ

デフォルトでは、state パラメータが [URL を開く] と [新しい URL] の両方に追加され、ドライブの UI からアプリにデータが渡されます。このパラメータには、テンプレート変数とアプリへのリクエストに関するデータを含む JSON エンコードされた文字列が含まれています。含まれる変数は、使用される URL のタイプ（[URL を開く] または [新しい URL]）によって異なります。

テンプレート変数	説明	URL の適用
{ids}	開いているファイル ID のカンマ区切りのリスト。	URL を開く
{exportIds}	エクスポートされるファイル ID のカンマ区切りリスト（組み込みの Google ドキュメントを開く場合にのみ使用されます）。	URL を開く
{resourceKeys}	ファイル ID と対応するリソースキーがマッピングされた JSON 辞書。	URL を開く
{folderId}	親フォルダの ID。	新しい URL
{folderResourceKey}	親フォルダのリソースキー。	新しい URL
{userId}	ユーザーを識別するプロフィール ID。	Open URL と New URL
{action}	実行中のアクション。Open URL を使用している場合は open、New URL を使用している場合は create になります。	Open URL と New URL

state パラメータは URL エンコードされているため、アプリはエスケープ文字を処理して JSON として解析する必要があります。アプリは state パラメータの create 値を検出して、ファイル作成リクエストを検証できます。

新しい URL の JSON 形式の状態情報の例

新しい URL の state 情報は次のとおりです。

{
  "action":"create",
  "folderId":"FOLDER_ID",
  "folderResourceKey":"FOLDER_RESOURCE_KEY",
  "userId":"USER_ID"
}

Open URL の JSON 形式の状態情報の例

URL を開く場合の state 情報は次のとおりです。

{
  "ids": ["ID"],
  "resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
  "action":"open",
  "userId":"USER_ID"
}

ID とリソースキーは、ファイル メタデータの取得とファイル コンテンツのダウンロードに使用されます。アプリがファイル ID とアクセス トークンを取得したら、files.get メソッドの説明に従って、権限の確認、ファイル メタデータの取得、ファイル コンテンツのダウンロードを行うことができます。

注: ショートカットからファイルを開くアプリやサードパーティ製ショートカットを含むすべてのアプリは、files.get メソッドを呼び出して、ドキュメントに対するユーザーの権限を確認する必要があります。アプリは、編集や保存ができないファイルを開くときに、読み取り専用のユーザーに警告する必要があります（編集に時間を費やしてから保存時にエラーを表示するのではなく）。

関連トピック

インストールされたアプリは、ドライブの UI から起動されたアクションを作成、管理、開くことができなければなりません。詳しくは、ドライブ UI の [新規] ボタンと統合するまたはドライブ UI の [アプリで開く] コンテキスト メニューと統合するをご覧ください。