返品ユーザー情報

Google ドライブには、ドライブ ユーザーに関する情報を収集する 2 つの方法があります。

  • about リソースを使用すると、ユーザー、ユーザーの Drive 設定、システム機能に関する情報を取得できます。

  • apps リソースを使用すると、ユーザーがインストールしたアプリのリストを取得できます。このリストには、各アプリがサポートする MIME タイプ、ファイル拡張子などの詳細情報が含まれます。

このガイドでは、ドライブでユーザー情報を取得する方法について説明します。

ユーザーの詳細を取得する

about のインスタンスとしてドライブ ユーザーの情報を返すには、get() メソッドを使用します。返される値はバイト単位で測定されます。

get() メソッドでは、レスポンスで返すフィールドを一覧表示するために fields パラメータが必要です。パラメータを省略すると、メソッドからエラーが返されます。必要なフィールドを正確に返すには、特定のフィールドを返すをご覧ください。

例を表示

次のコードサンプルは、リクエストのクエリ パラメータとして複数の fields を指定する方法を示しています。レスポンスには、リクエストのフィールド値が返されます。

リクエスト

GET https://www.googleapis.com/drive/v3/about/?fields=kind,user,storageQuota

レスポンス

{
  "kind": "drive#about",
  "user": {
    "kind": "drive#user",
    "displayName": "DISPLAY_NAME",
    "photoLink": "PHOTO_LINK",
    "me": true,
    "permissionId": "PERMISSION_ID",
    "emailAddress": "EMAIL_ADDRESS"
  },
  "storageQuota": {
    "usage": "10845031958",
    "usageInDrive": "2222008387",
    "usageInDriveTrash": "91566"
  }
}

レスポンスには次の値が含まれます。

  • DISPLAY_NAME: ユーザー名（平文）。
  • PHOTO_LINK: ユーザーのプロフィール写真の URL。
  • PERMISSION_ID: Permission リソース内のユーザー ID。
  • EMAIL_ADDRESS: ユーザーのメールアドレス

ユーザーアプリを一覧表示する

Google ドライブ アプリは Google Workspace Marketplace に表示され、Google ドキュメント アプリや、ドキュメントへの署名にドキュメント内で使用されるアドオンなど、ドライブをより便利にするために使用されます。詳細については、Google ドライブ アプリを使用するをご覧ください。

ユーザーがインストールしたすべてのアプリのリストを apps のインスタンスとして返すには、パラメータなしで list() メソッドを使用します。

fields パラメータを設定して、レスポンスで返されるフィールドを一覧表示できます。必要なフィールドを正確に返すには、特定のフィールドを返すをご覧ください。

例を表示

次のコードサンプルは、リクエストでユーザーがインストールしたすべてのアプリのリストを返す方法を示しています。レスポンスには、リクエストのフィールド値が返されます。

リクエスト

GET https://www.googleapis.com/drive/v3/apps

レスポンス

{
  "kind": "drive#appList",
  "selfLink": "https://www.googleapis.com/drive/v3/apps",
  "items": [
    {
      "kind": "drive#app",
      "id": "ID",
      "name": "Google Sheets",
      "supportsCreate": true,
      "supportsImport": true,
      "supportsMultiOpen": false,
      "supportsOfflineCreate": true,
      "productUrl": "https://chrome.google.com/webstore/detail/felcaaldnbdncclmgdcncolpebgiejap",
      "productId": "PRODUCT_ID"
    }
  ],
  "defaultAppIds": [
    "ID"
  ]
}

レスポンスには次の値が含まれます。

  • ID: アプリ ID。
  • PRODUCT_ID: このアプリの商品リスティング ID。

クエリ パラメータを使用してユーザーアプリを一覧表示する

特定のアプリを検索するには、次のオプションのクエリ パラメータの 1 つ以上を使用します。

  • appFilterExtensions: ファイル拡張子のカンマ区切りリストを使用して検索結果をフィルタします。リストに表示されたファイル拡張子を開くことができる、アプリクエリ スコープ内のアプリがレスポンスに含まれます。appFilterMimeTypes も指定されている場合は、2 つのアプリリストの結合が返されます。拡張機能の例としては、Microsoft Word の docx や Microsoft PowerPoint の pptx などがあります。ファイル拡張子のその他の例については、Google Workspace ドキュメントの MIME タイプをエクスポートするをご覧ください。

    次のコードサンプルは、複数のファイル拡張子をクエリ パラメータ GET https://www.googleapis.com/drive/v3/apps?appFilterExtensions=docx,pptx として指定する方法を示しています。

  • appFilterMimeTypes: MIME タイプのカンマ区切りリストを使用して検索結果をフィルタします。リストされた MIME タイプを開くことができる、アプリクエリ スコープ内のアプリがレスポンスに含まれます。appFilterExtensions も指定されている場合は、2 つのアプリリストの統合が返されます。MIME タイプの例としては、Google フォームの場合は application/vnd.google-apps.form、Google サイトの場合は application/vnd.google-apps.site などがあります。MIME タイプのその他の例については、Google Workspace と Google ドライブでサポートされている MIME タイプをご覧ください。

    次のコードサンプルは、複数の MIME タイプをクエリ パラメータ GET https://www.googleapis.com/drive/v3/apps?appFilterMimeTypes=application/vnd.google-apps.form,application/vnd.google-apps.site として指定する方法を示しています。

  • languageCode: BCP 47 で定義されている言語 / 地域コード（Unicode の LDML 形式の拡張機能を含む）を使用して検索結果をフィルタします。言語コードの例としては、英語（米国）の場合は en-us、フランス語（カナダ）の場合は fr-ca などがあります。

    次のコードサンプルは、複数の言語コードをクエリ パラメータ GET https://www.googleapis.com/drive/v3/apps?languageCode=en-us,fr-ca として指定する方法を示しています。

ID でユーザーアプリを取得する

詳細なアプリ情報を apps のインスタンスとしてダウンロードするには、アプリ ID を指定して get() メソッドを使用します。

例を表示

次のコードサンプルは、リクエストでクエリ パラメータとして appId を指定する方法を示しています。レスポンスには、リクエストのフィールド値が返されます。

リクエスト

GET https://www.googleapis.com/drive/v3/apps/APP_ID

レスポンス

{
  "kind": "drive#app",
  "id": "ID",
  "name": "Google Sheets",
  "supportsCreate": true,
  "supportsImport": true,
  "supportsMultiOpen": false,
  "supportsOfflineCreate": true,
  "productUrl": "https://chrome.google.com/webstore/detail/felcaaldnbdncclmgdcncolpebgiejap",
  "productId": "PRODUCT_ID"
}

レスポンスには次の値が含まれます。

  • ID: アプリ ID。
  • PRODUCT_ID: このアプリの商品リスティング ID。

次に進む手順をいくつかご紹介します。