Справочник по API Google Picker, Справочник по API Google Picker

Эта страница содержит список классов, методов и перечисляемых типов, доступных в Google Picker API. Все эти элементы принадлежат пространству имен google.picker.* Существует 2 типа классов и перечисляемых типов: те, которые используются для создания и настройки средства выбора Google, и те, которые возвращаются средством выбора Google после того, как пользователь выбрал элемент. элемент.

Классы и типы конфигурации

Следующие классы и перечисляемые типы используются для создания и настройки Google Picker.

DocsUploadView

Используйте DocsUploadView для загрузки документов на Google Диск.

DocsUploadView() Конструктор.
DocsUploadView.setIncludeFolders(boolean) Позволяет пользователю выбрать папку на Google Диске для загрузки.
DocsUploadView.setParent(string) Устанавливает назначение загрузки в указанную папку. Это переопределяет setIncludeFolders на false.

Просмотр документов

DocsView — это подкласс View , который можно использовать для представлений Google Диска.

DocsView( ViewId | undefined) Конструктор. ViewId должен быть одним из представлений Google Диска. По умолчанию — ViewId.DOCS .
DocsView.setEnableDrives(boolean) Показывает общие диски и содержащиеся на них файлы. Перед включением ознакомьтесь с документацией по API Google Диска для включения общих дисков .
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 — это объект верхнего уровня, представляющий действие пользовательского интерфейса с пользователем. Эти объекты не создаются напрямую, а вместо этого используют объект PickerBuilder .

Picker.isVisible() Получите логическое значение, указывающее текущую видимость средства выбора.
Picker.setCallback(function(object)) Укажите метод обратного вызова, вызываемый всякий раз, когда пользователь выбирает элемент (или отменяет его).
Picker.setRelayUrl(string) Укажите URL-адрес ретрансляции, чтобы обойти междоменные проблемы.
Picker.setVisible(boolean) Управляйте видимостью объекта Picker.
Picker.dispose() Удаляет объект Picker.

PickerBuilder

PickerBuilder используется для создания объектов Picker . Если не указано иное, возвращаемый тип методов ниже имеет тип PickerBuilder , что позволяет вам связывать один вызов за другим. См. пример кода Google Picker для типичного использования.

PickerBuilder() Конструктор.
PickerBuilder.addView( View | ViewId ) Добавьте View на панель навигации.
PickerBuilder.addViewGroup( ViewGroup ) Добавьте ViewGroup в панель навигации верхнего уровня.
PickerBuilder.build() Создайте объект Picker. Возвращается объект Picker.
PickerBuilder.disableFeature( Feature ) Отключить функцию выбора.
PickerBuilder.enableFeature( Feature ) Включите функцию выбора.
PickerBuilder.getRelayUrl() Получите URL-адрес реле, используемый для gadgets.rpc.
PickerBuilder.getTitle() Получить заголовок диалога.
PickerBuilder.hideTitleBar() Отключить отображение строки заголовка. Чтобы снова включить, вызовите setTitle с непустым заголовком или неопределенным.
PickerBuilder.isFeatureEnabled( Feature ) Проверьте, включена ли Feature выбора.
PickerBuilder.setAppId(string) Задает идентификатор приложения Google Диска , необходимый для предоставления приложению доступа к файлам пользователя через API Google Диска .
PickerBuilder.setCallback(method) Установите метод обратного вызова. Этот метод вызывается, когда пользователь выбирает элементы или отменяет их. Метод обратного вызова получает один объект обратного вызова. Структура объекта обратного вызова описана в JSON Guide .
PickerBuilder.setDeveloperKey(string) Задает ключ API браузера, полученный из Google API Console . Подробную информацию о том, как получить ключ API браузера, см. в Руководстве разработчика .
PickerBuilder.setDocument(document) Установите документ.
PickerBuilder.setLocale(string) Код языка ISO 639. Если язык не поддерживается, используется en-US. Этот метод представляет собой альтернативу установке локали во время google.load(). Список поддерживаемых локалей см. в Руководстве разработчика .
PickerBuilder.setMaxItems(number) Устанавливает максимальное количество элементов, которые может выбрать пользователь.
PickerBuilder.setOAuthToken(string) Задает токен OAuth для аутентификации текущего пользователя. В зависимости от области маркера данные отображаются только в определенных представлениях. Допустимые области: Документы Google, Диск, Фото, YouTube.
PickerBuilder.setOrigin(string) Устанавливает источник диалогового окна выбора Google. Источник должен быть установлен на window.location.protocol + '//' + window.location.host самой верхней страницы, если ваше приложение работает в iframe.
PickerBuilder.setRelayUrl(string) Установите URL-адрес ретрансляции, используемый для gadgets.rpc.
PickerBuilder.setSelectableMimeTypes(string) Задайте список доступных для выбора типов MIME. Используйте запятые для разделения типов MIME, если требуется более одного.
PickerBuilder.setSize() Установите предпочтительный размер диалогового окна. Диалог автоматически центрируется. Он имеет минимальный размер (566 350) и максимальный размер (1051 650).
PickerBuilder.setTitle(string) Установите заголовок диалога.
PickerBuilder.toUri() Возвращает URI, сгенерированный этим компоновщиком.

идентификатор ресурса

ResourceId — это статический класс, используемый для создания идентификаторов ресурсов, подходящих для API списка документов Google.

ResourceId.generate( Document ) Сопоставьте объект документа с идентификатором ресурса.

Вид

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 Гугл Диск фото.
ViewId.DOCS_IMAGES_AND_VIDEOS Google Диск фото и видео.
ViewId.DOCS_VIDEOS Видео с Гугл Диска.
ViewId.DOCUMENTS Документы Google Диска.
ViewId.DRAWINGS Рисунки на гугл диске.
ViewId.FOLDERS Папки Google Диска.
ViewId.FORMS Формы Google Диска.
ViewId.PDFS PDF-файлы, хранящиеся на Google Диске.
ViewId.PRESENTATIONS Презентации Google Диска.
ViewId.SPREADSHEETS Таблицы Google Диска.

Типы обратного вызова

Следующие перечисленные типы находятся в данных обратного вызова, возвращаемых Google Picker API.

Действие

Action — это перечисляемый тип, представляющий действие, предпринятое пользователем для закрытия диалогового окна. Это значение находится в поле Response.ACTION в данных обратного вызова.

Action.CANCEL Пользователь отменил диалоговое окно Google Picker.
Action.PICKED Пользователь выбрал хотя бы один элемент.

Документ

Document — это перечисляемый тип, используемый для передачи информации о конкретном выбранном элементе. Возвращаются только те поля, которые относятся к выбранному элементу. Это значение находится в поле Response.DOCUMENTS в данных обратного вызова.

Document.DESCRIPTION Добавленное пользователем описание выбранного элемента.
Document.DURATION Продолжительность выбранного видео.
Document.EMBEDDABLE_URL URL-адрес этого элемента, подходящий для встраивания в веб-страницу.
Document.ICON_URL URL-адрес значка для этого элемента.
Document.ID Идентификатор выбранного элемента.
Document.IS_NEW Возвращает true, если выбранный элемент был только что загружен.
Document.LAST_EDITED_UTC Временная метка, описывающая, когда этот элемент последний раз редактировался.
Document.MIME_TYPE MIME-тип этого элемента.
Document.NAME Название этого элемента.
Document.NUM_CHILDREN Количество детей, содержащихся в этом элементе. Например, количество файлов в выбранной папке.
Document.PARENT_ID Родительский идентификатор этого элемента. Например, папка, содержащая этот файл.
Document.SERVICE_ID ServiceId , описывающий службу, из которой был выбран этот элемент.
Document.THUMBNAILS Массив Thumbnail , описывающий атрибуты фото или видео. Эскизы не возвращаются, если выбранные элементы принадлежат Google Диску.
Document.TYPE Type выбранного элемента.
Document.URL URL-адрес этого элемента.

Ответ

Response — это перечисляемый тип, используемый для передачи информации о выбранных пользователем элементах.

Response.ACTION Тип Action , представляющий действие, предпринятое пользователем для закрытия диалогового окна.
Response.DOCUMENTS Массив Document , выбранных пользователем.
Response.PARENTS Идентификаторы родительских папок для выбранных элементов. (Например, идентификаторы родительских папок, файлы которых были выбраны.)
Response.VIEW View , из которого пользователь выбрал эти элементы.

сервис-идентификатор

ServiceId — это перечисляемый тип, используемый для описания службы, из которой был выбран элемент. Это значение находится в поле Document.SERVICE_ID выбранного Document .

ServiceId.DOCS Гугл Диск.

миниатюра

Thumbnail — это перечисляемый тип, используемый для передачи информации о выбранной фотографии или видео. Это значение можно найти в поле Document.THUMBNAILS выбранного Document .

Thumbnail.HEIGHT Высота фото или видео в пикселях.
Thumbnail.WIDTH Ширина фото или видео в пикселях.
Thumbnail.URL URL-адрес выбранного фото или видео.

тип

Type — перечисляемый тип, используемый для классификации выбранного элемента. Это значение можно найти в поле Document.TYPE выбранного Document .

Type.DOCUMENT Объект является документом.
Type.PHOTO Товар представляет собой фотографию.
Type.VIDEO Товар представляет собой видео.
,

Эта страница содержит список классов, методов и перечисляемых типов, доступных в Google Picker API. Все эти элементы принадлежат пространству имен google.picker.* Существует 2 типа классов и перечисляемых типов: те, которые используются для создания и настройки средства выбора Google, и те, которые возвращаются средством выбора Google после того, как пользователь выбрал элемент. элемент.

Классы и типы конфигурации

Следующие классы и перечисляемые типы используются для создания и настройки Google Picker.

DocsUploadView

Используйте DocsUploadView для загрузки документов на Google Диск.

DocsUploadView() Конструктор.
DocsUploadView.setIncludeFolders(boolean) Позволяет пользователю выбрать папку на Google Диске для загрузки.
DocsUploadView.setParent(string) Устанавливает назначение загрузки в указанную папку. Это переопределяет setIncludeFolders на false.

Просмотр документов

DocsView — это подкласс View , который можно использовать для представлений Google Диска.

DocsView( ViewId | undefined) Конструктор. ViewId должен быть одним из представлений Google Диска. По умолчанию — ViewId.DOCS .
DocsView.setEnableDrives(boolean) Показывает общие диски и содержащиеся на них файлы. Перед включением ознакомьтесь с документацией по API Google Диска для включения общих дисков .
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 — это объект верхнего уровня, представляющий действие пользовательского интерфейса с пользователем. Эти объекты не создаются напрямую, а вместо этого используют объект PickerBuilder .

Picker.isVisible() Получите логическое значение, указывающее текущую видимость средства выбора.
Picker.setCallback(function(object)) Укажите метод обратного вызова, вызываемый всякий раз, когда пользователь выбирает элемент (или отменяет его).
Picker.setRelayUrl(string) Укажите URL-адрес ретрансляции, чтобы обойти междоменные проблемы.
Picker.setVisible(boolean) Управляйте видимостью объекта Picker.
Picker.dispose() Удаляет объект Picker.

PickerBuilder

PickerBuilder используется для создания объектов Picker . Если не указано иное, возвращаемый тип методов ниже имеет тип PickerBuilder , что позволяет вам связывать один вызов за другим. См. пример кода Google Picker для типичного использования.

PickerBuilder() Конструктор.
PickerBuilder.addView( View | ViewId ) Добавьте View на панель навигации.
PickerBuilder.addViewGroup( ViewGroup ) Добавьте ViewGroup в панель навигации верхнего уровня.
PickerBuilder.build() Создайте объект Picker. Возвращается объект Picker.
PickerBuilder.disableFeature( Feature ) Отключить функцию выбора.
PickerBuilder.enableFeature( Feature ) Включите функцию выбора.
PickerBuilder.getRelayUrl() Получите URL-адрес реле, используемый для gadgets.rpc.
PickerBuilder.getTitle() Получить заголовок диалога.
PickerBuilder.hideTitleBar() Отключить отображение строки заголовка. Чтобы снова включить, вызовите setTitle с непустым заголовком или неопределенным.
PickerBuilder.isFeatureEnabled( Feature ) Проверьте, включена ли Feature выбора.
PickerBuilder.setAppId(string) Задает идентификатор приложения Google Диска , необходимый для предоставления приложению доступа к файлам пользователя через API Google Диска .
PickerBuilder.setCallback(method) Установите метод обратного вызова. Этот метод вызывается, когда пользователь выбирает элементы или отменяет их. Метод обратного вызова получает один объект обратного вызова. Структура объекта обратного вызова описана в JSON Guide .
PickerBuilder.setDeveloperKey(string) Задает ключ API браузера, полученный из Google API Console . Подробную информацию о том, как получить ключ API браузера, см. в Руководстве разработчика .
PickerBuilder.setDocument(document) Установите документ.
PickerBuilder.setLocale(string) Код языка ISO 639. Если язык не поддерживается, используется en-US. Этот метод представляет собой альтернативу установке локали во время google.load(). Список поддерживаемых локалей см. в Руководстве разработчика .
PickerBuilder.setMaxItems(number) Устанавливает максимальное количество элементов, которые может выбрать пользователь.
PickerBuilder.setOAuthToken(string) Задает токен OAuth для аутентификации текущего пользователя. В зависимости от области маркера данные отображаются только в определенных представлениях. Допустимые области: Документы Google, Диск, Фото, YouTube.
PickerBuilder.setOrigin(string) Устанавливает источник диалогового окна выбора Google. Источник должен быть установлен на window.location.protocol + '//' + window.location.host самой верхней страницы, если ваше приложение работает в iframe.
PickerBuilder.setRelayUrl(string) Установите URL-адрес ретрансляции, используемый для gadgets.rpc.
PickerBuilder.setSelectableMimeTypes(string) Задайте список доступных для выбора типов MIME. Используйте запятые для разделения типов MIME, если требуется более одного.
PickerBuilder.setSize() Установите предпочтительный размер диалогового окна. Диалог автоматически центрируется. Он имеет минимальный размер (566 350) и максимальный размер (1051 650).
PickerBuilder.setTitle(string) Установите заголовок диалога.
PickerBuilder.toUri() Возвращает URI, сгенерированный этим компоновщиком.

идентификатор ресурса

ResourceId — это статический класс, используемый для создания идентификаторов ресурсов, подходящих для API списка документов Google.

ResourceId.generate( Document ) Сопоставьте объект документа с идентификатором ресурса.

Вид

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 Гугл Диск фото.
ViewId.DOCS_IMAGES_AND_VIDEOS Google Диск фото и видео.
ViewId.DOCS_VIDEOS Видео с Гугл Диска.
ViewId.DOCUMENTS Документы Google Диска.
ViewId.DRAWINGS Рисунки на гугл диске.
ViewId.FOLDERS Папки Google Диска.
ViewId.FORMS Формы Google Диска.
ViewId.PDFS PDF-файлы, хранящиеся на Google Диске.
ViewId.PRESENTATIONS Презентации Google Диска.
ViewId.SPREADSHEETS Таблицы Google Диска.

Типы обратного вызова

Следующие перечисленные типы находятся в данных обратного вызова, возвращаемых Google Picker API.

Действие

Action — это перечисляемый тип, представляющий действие, предпринятое пользователем для закрытия диалогового окна. Это значение находится в поле Response.ACTION в данных обратного вызова.

Action.CANCEL Пользователь отменил диалоговое окно Google Picker.
Action.PICKED Пользователь выбрал хотя бы один элемент.

Документ

Document — это перечисляемый тип, используемый для передачи информации о конкретном выбранном элементе. Возвращаются только те поля, которые относятся к выбранному элементу. Это значение находится в поле Response.DOCUMENTS в данных обратного вызова.

Document.DESCRIPTION Добавленное пользователем описание выбранного элемента.
Document.DURATION Продолжительность выбранного видео.
Document.EMBEDDABLE_URL URL-адрес этого элемента, подходящий для встраивания в веб-страницу.
Document.ICON_URL URL-адрес значка для этого элемента.
Document.ID Идентификатор выбранного элемента.
Document.IS_NEW Возвращает true, если выбранный элемент был только что загружен.
Document.LAST_EDITED_UTC Временная метка, описывающая, когда этот элемент последний раз редактировался.
Document.MIME_TYPE MIME-тип этого элемента.
Document.NAME Название этого элемента.
Document.NUM_CHILDREN Количество детей, содержащихся в этом элементе. Например, количество файлов в выбранной папке.
Document.PARENT_ID Родительский идентификатор этого элемента. Например, папка, содержащая этот файл.
Document.SERVICE_ID ServiceId , описывающий службу, из которой был выбран этот элемент.
Document.THUMBNAILS Массив Thumbnail , описывающий атрибуты фото или видео. Эскизы не возвращаются, если выбранные элементы принадлежат Google Диску.
Document.TYPE Type выбранного элемента.
Document.URL URL-адрес этого элемента.

Ответ

Response — это перечисляемый тип, используемый для передачи информации о выбранных пользователем элементах.

Response.ACTION Тип Action , представляющий действие, предпринятое пользователем для закрытия диалогового окна.
Response.DOCUMENTS Массив Document , выбранных пользователем.
Response.PARENTS Идентификаторы родительских папок для выбранных элементов. (Например, идентификаторы родительских папок, файлы которых были выбраны.)
Response.VIEW View , из которого пользователь выбрал эти элементы.

сервис-идентификатор

ServiceId — это перечисляемый тип, используемый для описания службы, из которой был выбран элемент. Это значение находится в поле Document.SERVICE_ID выбранного Document .

ServiceId.DOCS Гугл Диск.

миниатюра

Thumbnail — это перечисляемый тип, используемый для передачи информации о выбранной фотографии или видео. Это значение можно найти в поле Document.THUMBNAILS выбранного Document .

Thumbnail.HEIGHT Высота фото или видео в пикселях.
Thumbnail.WIDTH Ширина фото или видео в пикселях.
Thumbnail.URL URL-адрес выбранного фото или видео.

тип

Type — перечисляемый тип, используемый для классификации выбранного элемента. Это значение можно найти в поле Document.TYPE выбранного Document .

Type.DOCUMENT Объект является документом.
Type.PHOTO Товар представляет собой фотографию.
Type.VIDEO Товар представляет собой видео.