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

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

Drive API を有効にする

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

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

• Google Cloud コンソールで、Google Drive API を有効にします。

  API の有効化

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

state パラメータ

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

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

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

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

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

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

URL を開くための JSON 形式の状態情報の例

Open URL の state 情報は次のとおりです。

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

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

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

関連トピック

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