返品ユーザー情報

Google ドライブには、ドライブ ユーザーに関する情報を収集するための 2 つのオプションがあります。

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

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

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

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

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

get メソッドで fields システム パラメータを設定して、レスポンスで返すフィールドを指定する必要があります。ほとんどの Drive メソッドでは、このアクションはデフォルト以外のフィールドを返す場合にのみ必要ですが、about リソースでは必須です。パラメータを省略すると、メソッドはエラーを返します。詳細については、特定のフィールドを返すをご覧ください。

次のコードサンプルは、リクエストで複数の 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 システム パラメータを設定します。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。

以下に、次の手順をいくつかご紹介します。