ドライブの 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. （省略可）[Short description] フィールドに、短い 1 行の説明を入力します。簡単な説明は、ドライブ設定の [アプリの管理] タブに表示されます。
  6. （省略可）[詳細] 欄に完全な説明を入力します。

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

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

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

  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 は、ユーザーをアプリケーションにリダイレクトするために [新規] ボタンによって使用されます。

  13. （省略可）Google Workspace でサポートされているファイルを開く場合は、[インポート] チェックボックスをオンにします。

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

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

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

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

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

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

state パラメータ

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

テンプレート変数 説明 URL アプリケーション
{ids} 開いているファイル ID のカンマ区切りのリスト。 URL を開く
{exportIds} エクスポートされるファイル ID のカンマ区切りのリスト（組み込みの Google ドキュメントを開くときにのみ使用されます）。 URL を開く
{resourceKeys} 各リソースキーにマッピングされたファイル ID の JSON 辞書。 URL を開く
{folderId} 親フォルダの ID。 新規作成 URL
{folderResourceKey} 親フォルダのリソースキー。 新規作成 URL
{userId} ユーザーを識別するプロファイル ID。 オープン URL と新しい URL
{action} 実行されるアクション。値は、Open URL を使用する場合は open、新しい 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 内の状態情報の例

オープン URL の state 情報は次のとおりです。

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

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

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