返品ユーザー情報

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

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

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

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

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

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

レスポンスで返すフィールドを指定するには、get メソッドで fields システム パラメータを 設定する必要があります。ほとんどのドライブ メソッドでは、デフォルト以外のフィールドを返す場合にのみこの操作が必要ですが、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。

次に、試すことができる手順をいくつか示します。