このページには、Google Picker API で使用可能なクラス、メソッド、列挙型の一覧が掲載されています。これらの要素はすべて名前空間 google.picker.*
に属します。クラスと列挙型には、Google Picker の構築と構成に使用されるタイプと、ユーザーがアイテムを選択すると Google Picker によって返される 2 つのタイプがあります。
構成のクラスと型
Google Picker の構築と設定には、次のクラスと列挙型が使用されます。
DocsUploadView
DocsUploadView
を使用してドキュメントを Google ドライブにアップロードします。
DocsUploadView() | コンストラクタ。 |
DocsUploadView.setIncludeFolders(boolean) | ユーザーが Google ドライブ内のアップロード先のフォルダを選択できます。 |
DocsUploadView.setParent(string) | アップロード先を指定のフォルダに設定します。これにより、setIncludeFolders が false にオーバーライドされます。 |
DocsView
DocsView
は、Google ドライブのビューに使用できる View
のサブクラスです。
DocsView(ViewId | undefined) | コンストラクタ。ViewId は、Google ドライブ ビューのいずれかである必要があります。デフォルトは ViewId.DOCS です。 |
DocsView.setEnableDrives(boolean) | 共有ドライブとそこにあるファイルが表示されます。有効にする前に、共有ドライブの有効化に関する Google Drive API のドキュメントをご覧ください。 |
DocsView.setIncludeFolders(boolean) | ビューアイテムにフォルダを表示します。setOwnedByMe とは組み合わせないでください。setIncludeFolders(true) が設定されている場合、setOwnedByMe は無視されます。 |
DocsView.setSelectFolderEnabled(boolean) | ユーザーが Google ドライブ内のフォルダを選択できるようにします。 |
DocsView.setMode(DocsViewMode) | ビューがドキュメントを表示するために使用するモードを選択します。 |
DocsView.setOwnedByMe(boolean | undefined) | ドキュメントをユーザーが所有しているか、共有されているかによってフィルタします。この設定を setIncludeFolders と併用しないでください。setIncludeFolders(true) が設定されている場合、setOwnedByMe は無視されます。 |
DocsView.setParent(string) | 表示する最初の親フォルダを設定します。 |
DocsView.setStarred(boolean) | ユーザーがスターを付けたかどうかでドキュメントをフィルタします。 |
DocsViewMode
DocsViewMode
は、DocsView 内にデータを表示する列挙型です。これらの値を DocsView.setMode
の呼び出しで使用します。
DocsViewMode.GRID | ドキュメントをサムネイル グリッドに表示します。 |
DocsViewMode.LIST | 詳細リストにドキュメントを表示します。 |
特徴
Feature
は、さまざまなビューの機能をオン/オフするための列挙型です。これらの値は、PickerBuilder.enableFeature
と PickerBuilder.disableFeature
の呼び出しで使用します。
Feature.MINE_ONLY | Google ドライブのアイテムを表示するときに、ユーザーが所有するドキュメントのみを表示します。 |
Feature.MULTISELECT_ENABLED | ユーザーが複数のアイテムを選択できるようにします。 |
Feature.NAV_HIDDEN | ナビゲーション パネルを非表示にする。ナビゲーション パネルが非表示になっている場合、ユーザーは最初に選択したビューからのみ選択できます。 |
Feature.SIMPLE_UPLOAD_ENABLED | 写真のアップロード時に、(アルバムごとではなく)写真ごとに選択を有効にするかどうかを制御します。 |
Feature.SUPPORT_DRIVES |
非推奨: 共有ドライブのアイテムがデフォルトで含まれるようになりました。 結果に共有ドライブのアイテムを含めるかどうか。 |
選択ツール
Picker
は、ユーザーの UI アクションを表す最上位オブジェクトです。これらのオブジェクトは直接作成されるのではなく、代わりに PickerBuilder
オブジェクトを使用します。
Picker.isVisible() | 現在の Picker の公開設定を示すブール値を取得します。 |
Picker.setCallback(function(object)) | ユーザーがアイテムを選択(またはキャンセル)するたびに呼び出されるコールバック メソッドを指定します。 |
Picker.setRelayUrl(string) | クロスドメインの問題を回避するため、リレー URL を指定してください。 |
Picker.setVisible(boolean) | Picker オブジェクトの表示を制御します。 |
Picker.dispose() | Picker オブジェクトを破棄します。 |
PickerBuilder
PickerBuilder
は、Picker
オブジェクトの作成に使用されます。特に明記されていない限り、以下のメソッドの戻り値の型は PickerBuilder
型であり、1 つの呼び出しを一つずつ連続して呼び出すことができます。一般的な使用方法については、Google Picker のコードサンプルをご覧ください。
PickerBuilder() | コンストラクタ。 |
PickerBuilder.addView( | View をナビゲーション パネルに追加します。 |
PickerBuilder.addViewGroup(ViewGroup) | 最上位のナビゲーション パネルに ViewGroup を追加します。 |
PickerBuilder.build() | Picker オブジェクトを作成します。Picker オブジェクトが返されます。 |
PickerBuilder.disableFeature(Feature) | 選択ツール機能を無効にします。 |
PickerBuilder.enableFeature(Feature) | 選択ツール機能を有効にする。 |
PickerBuilder.getRelayUrl() | assets.rpc に使用されるリレー URL を取得します。 |
PickerBuilder.getTitle() | ダイアログのタイトルを取得します。 |
PickerBuilder.hideTitleBar() | タイトルバーの表示を無効にします。再度有効にするには、空でないタイトルまたは未定義のタイトルを指定して setTitle を呼び出します。 |
PickerBuilder.isFeatureEnabled(Feature) | 選択ツール Feature が有効になっているかどうかを確認します。 |
PickerBuilder.setAppId(string) | アプリケーションが Google Drive API を介してユーザーのファイルにアクセスできるようにするために必要な Google ドライブ アプリ ID を設定します。 |
PickerBuilder.setCallback(method) | コールバック メソッドを設定します。このメソッドは、ユーザーがアイテムを選択したとき、またはキャンセルしたときに呼び出されます。コールバック メソッドは、コールバック オブジェクトを 1 つ受け取ります。コールバック オブジェクトの構造については、JSON ガイドをご覧ください。 |
PickerBuilder.setDeveloperKey(string) | Google API Console から取得したブラウザ API キーを設定します。ブラウザの API キーを取得する方法について詳しくは、デベロッパー ガイドをご覧ください。 |
PickerBuilder.setDocument(document) | ドキュメントを設定します。 |
PickerBuilder.setLocale(string) | ISO 639 言語コード。言語がサポートされていない場合は、en-US が使用されます。このメソッドは、google.load() の時点でロケールを設定する代わりに使用できます。サポートされている言語 / 地域の一覧については、デベロッパー ガイドをご覧ください。 |
PickerBuilder.setMaxItems(number) | ユーザーが選択できるアイテムの最大数を設定します。 |
PickerBuilder.setOAuthToken(string) | 現在のユーザーの認証に使用する OAuth トークンを設定します。トークンの範囲に応じて、特定のビューにのみデータが表示されます。有効なスコープは Google ドキュメントとドライブです。 |
PickerBuilder.setOrigin(string) | Google Picker ダイアログのオリジンを設定します。アプリケーションが iframe 内で実行されている場合は、オリジンを最上位ページの window.location.protocol + '//' + window.location.host に設定する必要があります。 |
PickerBuilder.setRelayUrl(string) | assets.rpc に使用されるリレー URL を設定します。 |
PickerBuilder.setSelectableMimeTypes(string) | 選択可能な MIME タイプのリストを設定します。MIME タイプが複数ある場合は、カンマを使用して区切ります。 |
PickerBuilder.setSize() | 使用するダイアログ サイズを設定します。ダイアログは自動的に中央揃えされます。最小サイズは(566,350)、最大サイズは(1051,650)です。 |
PickerBuilder.setTitle(string) | ダイアログのタイトルを設定します。 |
PickerBuilder.toUri() | このビルダーによって生成された URI を返します。 |
ResourceId
ResourceId
は、Google Documents List API に適したリソース ID を生成するために使用される静的クラスです。
ResourceId.generate(Document) | ドキュメント オブジェクトをリソース ID にマッピングします。 |
表示
View
は、さまざまな View クラスの抽象基本クラス(DocsView
など)です。
View(ViewId) | コンストラクタ。 |
View.getId() | このビューの ViewId を返します。 |
View.setMimeTypes(string) | ビューに含める MIME タイプを設定します。MIME タイプが複数ある場合は、カンマを使用して区切ります。MIME タイプを設定しない場合は、すべての MIME タイプのファイルがビューに表示されます。 |
View.setQuery(string) | 検索を含むビューの場合は、次の用語が検索クエリに事前入力されます。 |
ViewGroup
ViewGroup
は、ビューの視覚的なグループです。ViewGroup 自体のルート アイテムは View
である必要があります。
ViewGroup(View | ViewId) | ViewGroup は、ナビゲーション パネルのビューを視覚的にグループ化したものです。ViewGroup 自体のルート アイテムは View である必要があります。 |
ViewGroup.addLabel(string) | この ViewGroup にラベルを追加します。 |
ViewGroup.addView(ViewId | View) | ViewGroup にビューを追加します。View は、view から派生したオブジェクト、または単に ViewId で表すことができます。 |
ViewGroup.addViewGroup(ViewGroup) | 現在の ViewGroup 内に ViewGroup をネストします。 |
ViewId
ViewId
は列挙型で、View
オブジェクトと ViewGroup
オブジェクトの作成に使用されます。
ViewId.DOCS | Google ドライブのすべてのドキュメント タイプ。 |
ViewId.DOCS_IMAGES | Google ドライブの写真。 |
ViewId.DOCS_IMAGES_AND_VIDEOS | Google ドライブの写真や動画。 |
ViewId.DOCS_VIDEOS | Google ドライブの動画。 |
ViewId.DOCUMENTS | Google ドライブのドキュメント。 |
ViewId.DRAWINGS | Google ドライブの図形描画。 |
ViewId.FOLDERS | Google ドライブ フォルダ。 |
ViewId.FORMS | Google ドライブのフォーム。 |
ViewId.PDFS | Google ドライブに保存されている PDF ファイル。 |
ViewId.PRESENTATIONS | Google ドライブのプレゼンテーション。 |
ViewId.SPREADSHEETS | Google ドライブのスプレッドシート。 |
コールバックの種類
Google Picker API から返されるコールバック データには、次の列挙型があります。
アクション
Action
は、ユーザーがダイアログを閉じるために行った操作を表す列挙型です。この値は、コールバック データの Response.ACTION
フィールドに含まれます。
Action.CANCEL | ユーザーが Google Picker ダイアログをキャンセルしました。 |
Action.PICKED | ユーザーが 1 つ以上のアイテムを選択しています。 |
ドキュメント
Document
は、選択された特定のアイテムに関する情報を伝えるために使用される列挙型です。選択したアイテムに関連するフィールドのみが返されます。この値は、コールバック データの Response.DOCUMENTS
フィールドに含まれます。
Document.DESCRIPTION | 選択したアイテムについてユーザーが投稿した説明。 |
Document.DURATION | 選択した動画の再生時間。 |
Document.EMBEDDABLE_URL | ウェブページへの埋め込みに適したアイテムの URL です。 |
Document.ICON_URL | このアイテムのアイコンへの URL です。 |
Document.ID | 選択したアイテムの ID。 |
Document.IS_NEW | 選択したアイテムがアップロードされたばかりの場合は true を返します。 |
Document.LAST_EDITED_UTC | このアイテムが最後に編集された日時を示すタイムスタンプです。 |
Document.MIME_TYPE | このアイテムの MIME タイプ。 |
Document.NAME | このアイテムの名前。 |
Document.NUM_CHILDREN | このアイテムに含まれる子の数。(選択したフォルダ内のファイル数など)。 |
Document.PARENT_ID | このアイテムの親 ID です。たとえば、このファイルを含むフォルダです。 |
Document.SERVICE_ID | このアイテムの選択元であるサービスを記述する ServiceId 。 |
Document.THUMBNAILS | 写真または動画の属性を記述する Thumbnail の配列。選択したアイテムが Google ドライブに属している場合、サムネイルは返されません。 |
Document.TYPE | 選択したアイテムの Type 。 |
Document.URL | このアイテムへの URL です。 |
レスポンス
Response
は、ユーザーが選択したアイテムに関する情報を伝えるために使用される列挙型です。
Response.ACTION | ユーザーがダイアログを閉じるために行った操作を表す Action 型。 |
Response.DOCUMENTS | ユーザーが選択した Document の配列。 |
Response.PARENTS | 選択したアイテムの親フォルダの ID。(ファイルが選択されている親フォルダの ID など)。 |
Response.VIEW | ユーザーがこれらのアイテムを選択した View 。 |
サービス ID
ServiceId
は、アイテムが選択されたサービスを記述するために使用される列挙型です。この値は、選択した Document
の Document.SERVICE_ID
フィールドにあります。
ServiceId.DOCS | Google ドライブ。 |
サムネイル
Thumbnail
は、選択された写真または動画に関する情報を伝えるために使用される列挙型です。この値は、選択した Document
の Document.THUMBNAILS
フィールドで確認できます。
Thumbnail.HEIGHT | 写真または動画の高さ(ピクセル単位)。 |
Thumbnail.WIDTH | 写真または動画の幅(ピクセル単位)。 |
Thumbnail.URL | 選択した写真または動画の URL。 |
type
Type
は、選択したアイテムの分類に使用される列挙型です。この値は、選択した Document
の Document.TYPE
フィールドで確認できます。
Type.DOCUMENT | アイテムがドキュメントである。 |
Type.PHOTO | アイテムが写真である。 |
Type.VIDEO | アイテムが動画である。 |