Google ドライブには、ドライブ ユーザーに関する情報を収集する方法が 2 つあります。
about
リソースを使用すると、ユーザー、ユーザーのドライブ設定、システム機能に関する情報を取得できます。apps
リソースを使用すると、ユーザーがインストールしたアプリのリストと、各アプリでサポートされている MIME タイプ、ファイル拡張子、その他の詳細情報を取得できます。
このガイドでは、ドライブでユーザー情報を取得する方法について説明します。
ユーザーに関する情報を取得する
ドライブ ユーザーの情報を about
のインスタンスとして返すには、about.get
メソッドを使用します。about.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
のインスタンスとして返すには、パラメータを指定せずに apps.list
メソッドを使用します。
例を表示
次のコードサンプルは、リクエストでユーザーがインストールしたすべてのアプリのリストを返す方法を示しています。レスポンスでリクエストのフィールド値が返されます。
リクエスト
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 を指定して apps.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。
関連トピック
次の方法をお試しください。
ドライブ内にファイルを作成するには、ファイルを作成するをご覧ください。
ファイルを作成または更新するときにファイルデータをアップロードするには、ファイルデータをアップロードするをご覧ください。
ファイルのダウンロードとエクスポートを行う方法については、ファイルのダウンロードとエクスポートをご覧ください。