ドライブの 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 コンソールで、メニュー > [API とサービス] > [有効な API とサービス] に移動します。

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

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

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

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

    • この URL には完全修飾ドメイン名を含める必要があります。localhost は使用できません。
    • この URL は、アプリの対象ユーザーからアクセスできる必要があります。 公開リリース用と特定のユーザーへの限定リリース用など、複数のアプリ バージョンがある場合は、各バージョンで固有の URL を使用する必要があります。その後、バージョンごとに異なるアプリ構成を作成できます。
    • 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 スコープをリクエストする

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

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

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

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。 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"
}

Open URL の状態情報の JSON の例

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

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

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

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