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

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

Drive API を有効にする

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

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

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

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

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

  2. [API とサービス] ダッシュボードの下部にある [Google Drive API] をクリックします。Google Drive API の構成ページが表示されます。
  3. [ドライブ UI の統合] タブを選択します。
  4. (省略可)[アプリケーション名] フィールドに名前を入力します。アプリケーション名は、ドライブ設定の [アプリの管理] タブでユーザーに表示されます。
  5. (省略可)[簡単な説明] フィールドに短い説明を 1 行で入力します。簡単な説明は、ドライブの設定の [アプリの管理] タブでユーザーに表示されます。
  6. (省略可)[詳しい説明] フィールドに詳しい説明を入力します。
  7. 1 つ以上のアプリケーション アイコンをアップロードして、接続されているドライブアプリのリストと、[アプリで開く] コンテキスト メニューに表示します。アイコンは、背景が透明な PNG 形式である必要があります。ドライブにアイコンが表示されるまでには、最長で 24 時間ほどかかる場合があります。

  8. ドライブ UI の [アプリで開く] メニュー項目を使用するには、[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 スコープをリクエストする

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

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} 実行されるアクション。オープン 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"
}

Open URL の JSON の状態情報の例

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

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

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

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