Referencia de la API del selector de Google

Esta página contiene una lista de clases, métodos y tipos enumerados disponibles en la API del selector de Google. Todos estos elementos pertenecen al espacio de nombres google.picker.* Hay 2 tipos de clases y tipos enumerados: los que se usan para compilar y configurar el selector de Google y los que muestra el selector de Google una vez que el usuario selecciona un elemento.

Tipos y clases de configuración

Las siguientes clases y los tipos enumerados se usan para compilar y configurar el selector de Google.

Vista de carga de documentos

Usa DocsUploadView para subir documentos a Google Drive.

DocsUploadView()Constructor.
DocsUploadView.setIncludeFolders(boolean)Permite que el usuario seleccione una carpeta de Google Drive para subir.
DocsUploadView.setParent(string)Establece el destino de carga en la carpeta especificada. Esto anula setIncludeFolders a falso.

Vista de documentos

DocsView es una subclase de View que se puede usar para las vistas de Google Drive.

DocsView(ViewId | undefined)Constructor. La ViewId debe ser una de las vistas de Google Drive. El valor predeterminado es ViewId.DOCS.
DocsView.setEnableDrives(boolean)Muestra las unidades compartidas y los archivos que contienen. Antes de habilitarlas, consulta la documentación de la API de Google Drive para habilitar las unidades compartidas.
DocsView.setIncludeFolders(boolean)Mostrar carpetas en los elementos de vista. No combinar con setOwnedByMe Cuando se configura setIncludeFolders(true), se ignora setOwnedByMe.
DocsView.setSelectFolderEnabled(boolean)Permite que el usuario seleccione una carpeta en Google Drive.
DocsView.setMode(DocsViewMode)Selecciona el modo que se usará en la vista para mostrar los documentos.
DocsView.setOwnedByMe(boolean | undefined)Filtra los documentos según si son propiedad del usuario o si se compartieron con este. No combine esta configuración con setIncludeFolders. Cuando se configura setIncludeFolders(true), se ignora setOwnedByMe.
DocsView.setParent(string)Configura la carpeta superior inicial para mostrar.
DocsView.setStarred(boolean)Filtra los documentos en función de si el usuario los destaca.

Modo de vista de documentos

DocsViewMode es un tipo enumerado para mostrar datos dentro de DocsView. Usa estos valores en las llamadas a DocsView.setMode.

DocsViewMode.GRIDMuestra documentos en una cuadrícula de miniaturas.
DocsViewMode.LISTMuestra documentos en una lista detallada.

Función

Feature es un tipo enumerado que permite activar o desactivar funciones para varias vistas. Usa estos valores en las llamadas a PickerBuilder.enableFeature y PickerBuilder.disableFeature.

Feature.MINE_ONLYMostrar solo los documentos que son propiedad del usuario cuando se muestran elementos de Google Drive.
Feature.MULTISELECT_ENABLEDPermitir que el usuario elija más de un elemento.
Feature.NAV_HIDDENOcultar el panel de navegación. Si el panel de navegación está oculto, los usuarios solo pueden seleccionar una opción de la primera vista elegida.
Feature.SIMPLE_UPLOAD_ENABLEDPara las cargas de fotos, controla si se habilita la selección por fotos (en lugar de por álbum).
Feature.SUPPORT_DRIVES

Obsoleto: Los elementos de las unidades compartidas ahora se incluyen de forma predeterminada.

Indica si los elementos de la unidad compartida se incluyen en los resultados.

Selector

Picker es el objeto de nivel superior que representa la acción de la IU con el usuario. Estos objetos no se crean directamente, sino que usan el objeto PickerBuilder.

Picker.isVisible()Obtén un valor booleano que indique la visibilidad actual del selector.
Picker.setCallback(function(object))Especifica el método de devolución de llamada al que el usuario seleccione un elemento (o que cancele).
Picker.setRelayUrl(string)Especifique una URL de retransmisión para evitar problemas de diferentes dominios.
Picker.setVisible(boolean)Controlar la visibilidad del objeto Selector
Picker.dispose()Desecha el objeto Picker.

Selector

PickerBuilder se usa para crear objetos Picker. Salvo que se indique lo contrario, el tipo de datos que se muestra a continuación es del tipo PickerBuilder, lo que te permite encadenar una llamada tras otra. Consulta la muestra de código del selector de Google para conocer el uso habitual.

PickerBuilder()Constructor.
PickerBuilder.addView(View | ViewId)Agrega un objeto View al panel de navegación.
PickerBuilder.addViewGroup(ViewGroup)Agrega un objeto ViewGroup al panel de navegación de nivel superior.
PickerBuilder.build()Construye el objeto Selector. Se muestra el objeto Picker.
PickerBuilder.disableFeature(Feature)Inhabilitar una función de selector
PickerBuilder.enableFeature(Feature)Habilita una función de selector.
PickerBuilder.getRelayUrl()Obtén la URL de retransmisión que se usa en gadgets.rpc.
PickerBuilder.getTitle()Obtén el título del diálogo.
PickerBuilder.hideTitleBar()Inhabilitar la barra de título para que no se muestre Para volver a habilitarlas, llama a setTitle con un título no vacío o no definido.
PickerBuilder.isFeatureEnabled(Feature)Comprueba si está habilitado un selector Feature.
PickerBuilder.setAppId(string)Configura el ID de aplicación de Google Drive necesario para permitir que la aplicación acceda a los archivos del usuario a través de la API de Google Drive.
PickerBuilder.setCallback(method)Configura el método de devolución de llamada. Se llama a este método cuando el usuario selecciona elementos o cancela la acción. El método de devolución de llamada recibe un solo objeto de devolución de llamada. La estructura del objeto de devolución de llamada se describe en la Guía de JSON.
PickerBuilder.setDeveloperKey(string)Configura la clave de API del navegador que se obtuvo de Google API Console. Consulta la Guía para desarrolladores a fin de obtener detalles sobre cómo obtener la clave de API del navegador.
PickerBuilder.setDocument(document)Configura el documento.
PickerBuilder.setLocale(string)Código de idioma ISO 639. Si el idioma no es compatible, se utiliza en-US. Este método proporciona una alternativa a la configuración regional en google.load(). Consulta la Guía para desarrolladores para obtener una lista de las configuraciones regionales compatibles.
PickerBuilder.setMaxItems(number)Establece la cantidad máxima de elementos que un usuario puede seleccionar.
PickerBuilder.setOAuthToken(string)Establece un token de OAuth para usar en la autenticación del usuario actual. Según el alcance del token, solo ciertas vistas muestran datos. Los alcances válidos son Documentos de Google, Drive, Fotos, YouTube.
PickerBuilder.setOrigin(string)Establece el origen del cuadro de diálogo del selector de Google. Si la aplicación se ejecuta en un iframe, el origen debe establecerse en el window.location.protocol + '//' + window.location.host de la página superior.
PickerBuilder.setRelayUrl(string)Configura la URL de retransmisión que se utiliza para gadgets.rpc.
PickerBuilder.setSelectableMimeTypes(string)Establece la lista de los tipos de MIME seleccionables. Usa comas para separar los tipos de MIME si se requiere más de uno.
PickerBuilder.setSize()Establece el tamaño de diálogo preferido. El cuadro de diálogo se centra automáticamente. Tiene un tamaño mínimo de (566,350) y un tamaño máximo de (1,051,650).
PickerBuilder.setTitle(string)Configura el título del diálogo.
PickerBuilder.toUri()Muestra el URI que generó este compilador.

ResourceId

ResourceId es una clase estática que se usa a fin de generar ID de recursos adecuados para la API de lista de documentos de Google.

ResourceId.generate(Document)Asigna un objeto de documento a un ID de recurso.

Ver

View es la clase base abstracta para las diferentes clases de View, como DocsView.

View(ViewId)Constructor.
View.getId()Muestra el ViewId para esta vista.
View.setMimeTypes(string)Establece los tipos de MIME incluidos en la vista. Usa comas para separar los tipos de MIME si se requiere más de uno. Si no configuras los tipos de MIME, los archivos de todos los tipos de MIME se muestran en la vista.
View.setQuery(string)Para las vistas que incluyen búsquedas, completa previamente la búsqueda con estos términos.

ViewGroup

ViewGroup es una agrupación visual de vistas. El elemento raíz del objeto ViewGroup debe ser un objeto View.

ViewGroup(View | ViewId)Un objeto ViewGroup es una agrupación visual de vistas en el panel de navegación. El elemento raíz de la ViewGroup debe ser View.
ViewGroup.addLabel(string)Agrega una etiqueta a este elemento ViewGroup.
ViewGroup.addView(ViewId | View)Agrega una vista a ViewGroup. El View se puede representar con un objeto derivado de view o simplemente con ViewId.
ViewGroup.addViewGroup(ViewGroup)Anida un ViewGroup en el ViewGroup actual.

ID de vista

ViewId es un tipo enumerado, que se usa para construir objetos View y ViewGroup.

ViewId.DOCSTodos los tipos de documentos de Google Drive.
ViewId.DOCS_IMAGESFotos de Google Drive.
ViewId.DOCS_IMAGES_AND_VIDEOSFotos y videos de Google Drive.
ViewId.DOCS_VIDEOSVideos de Google Drive
ViewId.DOCUMENTSDocumentos de Google Drive.
ViewId.DRAWINGSDibujos de Google Drive.
ViewId.FOLDERSCarpetas de Google Drive.
ViewId.FORMSFormularios de Google Drive.
ViewId.PDFSArchivos PDF almacenados en Google Drive.
ViewId.PRESENTATIONSPresentaciones de Google Drive.
ViewId.SPREADSHEETSHojas de cálculo de Google Drive

Tipos de devolución de llamada

Los siguientes tipos enumerados se encuentran en los datos de devolución de llamada mostrados por la API del selector de Google.

Acción

Action es un tipo enumerado que representa la acción que realiza el usuario para descartar el diálogo. Este valor se encuentra en el campo Response.ACTION en los datos de devolución de llamada.

Action.CANCELEl usuario canceló el cuadro de diálogo del selector de Google.
Action.PICKEDEl usuario eligió al menos un elemento.

Documento

Document es un tipo enumerado que se usa para transmitir información sobre un elemento específico. Solo se muestran los campos que son relevantes para el elemento seleccionado. Este valor se encuentra en el campo Response.DOCUMENTS en los datos de devolución de llamada.

Document.DESCRIPTIONEs una descripción que proporcionó el usuario del elemento seleccionado.
Document.DURATIONEs la duración de un video seleccionado.
Document.EMBEDDABLE_URLUna URL para este elemento apta para insertarla en una página web.
Document.ICON_URLUna URL a un ícono para este elemento.
Document.IDEl ID del artículo seleccionado.
Document.IS_NEWMuestra true si el elemento seleccionado se acaba de subir.
Document.LAST_EDITED_UTCLa marca de tiempo que describe cuándo se editó por última vez este elemento.
Document.MIME_TYPEEs el tipo de MIME de este elemento.
Document.NAMEEl nombre de este elemento.
Document.NUM_CHILDRENIndica la cantidad de elementos secundarios contenidos en este elemento. Por ejemplo, la cantidad de archivos en la carpeta seleccionada.
Document.PARENT_IDEl ID superior de este elemento. Por ejemplo, la carpeta que contiene este archivo.
Document.SERVICE_IDUn objeto ServiceId que describe el servicio en el que se seleccionó este elemento.
Document.THUMBNAILSEs un array de Thumbnail que describe los atributos de una foto o un video. No se mostrarán miniaturas si los elementos seleccionados pertenecen a Google Drive.
Document.TYPEEl Type del elemento seleccionado.
Document.URLCorresponde a una URL para este elemento.

Respuesta

Response es un tipo enumerado que se usa para transmitir información sobre los elementos seleccionados del usuario.

Response.ACTIONUn tipo Action que representa la acción que realiza el usuario para descartar el diálogo.
Response.DOCUMENTSUn arreglo de Document seleccionado por el usuario.
Response.PARENTSLos ID de las carpetas superiores de los elementos seleccionados. (Por ejemplo, los ID de las carpetas superiores cuyos archivos se seleccionaron).
Response.VIEWEl View que seleccionó el usuario.

ID del servicio

ServiceId es un tipo enumerado que se usa para describir el servicio desde el que se seleccionó el elemento. Este valor se encuentra en el campo Document.SERVICE_ID del Document seleccionado.

ServiceId.DOCSGoogle Drive.

miniatura

Thumbnail es un tipo enumerado que se utiliza para transmitir información sobre una foto o video seleccionado. Este valor se puede encontrar en el campo Document.THUMBNAILS de un Document seleccionado.

Thumbnail.HEIGHTCorresponde a la altura de la foto o el video en píxeles.
Thumbnail.WIDTHCorresponde al ancho de la foto o el video en píxeles.
Thumbnail.URLUna URL para la foto o el video seleccionado.

tipo

Type es un tipo enumerado que se usa para categorizar el elemento seleccionado. Este valor se puede encontrar en el campo Document.TYPE de un Document seleccionado.

Type.DOCUMENTEl elemento es un documento.
Type.PHOTOEl elemento es una foto.
Type.VIDEOEl elemento es un video.