Referência da API Google Picker

Esta página contém uma lista de classes, métodos e tipos enumerados disponíveis na API Google Picker. Todos esses elementos pertencem ao namespace google.picker.*. Há dois tipos de classes e tipos enumerados: aqueles que são usados para criar e configurar o seletor do Google e aqueles que são retornados por ele depois que o usuário seleciona um item.

Classes e tipos de configuração

As classes e os tipos enumerados a seguir são usados para criar e configurar o seletor do Google.

DocsUploadView

Use DocsUploadView para fazer upload de documentos para o Google Drive.

DocsUploadView()Construtor.
DocsUploadView.setIncludeFolders(boolean)Permite que o usuário selecione uma pasta no Google Drive para onde o upload será feito.
DocsUploadView.setParent(string)Define o destino do upload para a pasta especificada. Isso substitui setIncludeFolders por falso.

DocsView

DocsView é uma subclasse de View que pode ser usada para visualizações do Google Drive.

DocsView(ViewId | undefined)Construtor. O ViewId precisa ser uma das visualizações do Google Drive. O padrão é ViewId.DOCS.
DocsView.setEnableDrives(boolean)Mostra os drives compartilhados e os arquivos que eles contêm. Antes de ativar os drives compartilhados, consulte a documentação da API Google Drive para ativar os drives compartilhados.
DocsView.setIncludeFolders(boolean)Mostrar pastas nos itens da visualização. Não combinar com setOwnedByMe. Quando setIncludeFolders(true) é definido, setOwnedByMe é ignorado.
DocsView.setSelectFolderEnabled(boolean)Permite que o usuário selecione uma pasta no Google Drive.
DocsView.setMode(DocsViewMode)Seleciona qual modo a visualização usa para mostrar os documentos.
DocsView.setOwnedByMe(boolean | undefined)Filtra os documentos com base no fato de eles serem de propriedade do usuário ou compartilhados com o usuário. Não combine essa configuração com setIncludeFolders. Quando setIncludeFolders(true) é definido, setOwnedByMe é ignorado.
DocsView.setParent(string)Define a pasta pai inicial a ser exibida.
DocsView.setStarred(boolean)Filtra os documentos com base em se eles estão marcados com estrela pelo usuário.

DocsViewMode

DocsViewMode é um tipo enumerado para exibir dados em uma DocsView. Use esses valores em chamadas para DocsView.setMode.

DocsViewMode.GRIDMostre documentos em uma grade de miniaturas.
DocsViewMode.LISTExiba documentos em uma lista detalhada.

Engenharia de

Feature é um tipo enumerado para ativar/desativar recursos para várias visualizações. Use esses valores em chamadas para PickerBuilder.enableFeature e PickerBuilder.disableFeature.

Feature.MINE_ONLYMostrar apenas documentos do usuário ao mostrar itens do Google Drive.
Feature.MULTISELECT_ENABLEDPermita que o usuário escolha mais de um item.
Feature.NAV_HIDDENOcultar o painel de navegação. Se o painel de navegação estiver oculto, os usuários só poderão selecionar a primeira visualização escolhida.
Feature.SIMPLE_UPLOAD_ENABLEDNos uploads de fotos, controla se a seleção por foto (em vez de por álbum) está ativada.
Feature.SUPPORT_DRIVES

Obsoleto: os itens dos drives compartilhados agora são incluídos por padrão.

Se os itens dos drives compartilhados serão incluídos nos resultados.

Seletor

Picker é o objeto de nível superior que representa a ação da interface com o usuário. Esses objetos não são criados diretamente. Em vez disso, eles usam o objeto PickerBuilder.

Picker.isVisible()Recebe um booleano indicando a visibilidade atual do seletor.
Picker.setCallback(function(object))Especifique o método de callback chamado sempre que o usuário seleciona (ou cancela) um item.
Picker.setRelayUrl(string)Especifique um URL de redirecionamento para contornar problemas entre domínios.
Picker.setVisible(boolean)Controle a visibilidade do objeto Picker.
Picker.dispose()Descarta o objeto Picker.

PickerBuilder

PickerBuilder é usado para criar objetos Picker. Exceto quando indicado o contrário, o tipo de retorno dos métodos abaixo é do tipo PickerBuilder, permitindo encadear uma chamada após a outra. Veja o exemplo de código do seletor do Google para uso comum.

PickerBuilder()Construtor.
PickerBuilder.addView(View | ViewId)Adicione um View ao painel de navegação.
PickerBuilder.addViewGroup(ViewGroup)Adicione um ViewGroup ao painel de navegação de nível superior.
PickerBuilder.build()Construir o objeto Picker. O objeto Picker é retornado.
PickerBuilder.disableFeature(Feature)Desativar um recurso seletor.
PickerBuilder.enableFeature(Feature)Ativar um recurso do seletor.
PickerBuilder.getRelayUrl()Acessa o URL de retransmissão, usado para gadgets.rpc.
PickerBuilder.getTitle()Confira o título da caixa de diálogo.
PickerBuilder.hideTitleBar()Desativar a exibição da barra de título. Para reativar, chame setTitle com um título não vazio ou indefinido.
PickerBuilder.isFeatureEnabled(Feature)Confira se um seletor Feature está ativado.
PickerBuilder.setAppId(string)Define o ID do aplicativo Google Drive necessário para permitir que o aplicativo acesse os arquivos do usuário pela API Google Drive.
PickerBuilder.setCallback(method)Defina o método de callback. Esse método é chamado quando o usuário seleciona itens ou cancela a ação. O método de callback recebe um único objeto de callback. A estrutura do objeto de callback é descrita no Guia JSON.
PickerBuilder.setDeveloperKey(string)Define a chave da API do navegador recebida do Console de APIs do Google. Consulte o Guia para desenvolvedores e saiba como conseguir essa chave.
PickerBuilder.setDocument(document)Defina o documento.
PickerBuilder.setLocale(string)Código de idioma ISO 639. Se o idioma não for compatível, será usado en-US. Este método fornece uma alternativa para definir a localidade no horário google.load(). Consulte o Guia para desenvolvedores e confira uma lista de localidades compatíveis.
PickerBuilder.setMaxItems(number)Define o número máximo de itens que um usuário pode selecionar.
PickerBuilder.setOAuthToken(string)Define um token OAuth a ser usado para autenticar o usuário atual. Dependendo do escopo do token, apenas algumas visualizações exibem dados. Os escopos válidos são Documentos Google e Drive.
PickerBuilder.setOrigin(string)Define a origem da caixa de diálogo do seletor do Google. A origem precisa ser definida como o window.location.protocol + '//' + window.location.host da página superior se o aplicativo estiver sendo executado em um iframe.
PickerBuilder.setRelayUrl(string)Define o URL de retransmissão, usado para gadgets.rpc.
PickerBuilder.setSelectableMimeTypes(string)Define a lista de tipos MIME selecionáveis. Use vírgulas para separar tipos MIME se mais de uma for necessária.
PickerBuilder.setSize()Defina o tamanho que preferir para a caixa de diálogo. A caixa de diálogo é centralizada automaticamente. O tamanho mínimo é (566.350) e máximo (1.051.650).
PickerBuilder.setTitle(string)Defina o título da caixa de diálogo.
PickerBuilder.toUri()Retorna o URI gerado por este builder.

ResourceId

ResourceId é uma classe estática usada para gerar IDs de recursos adequados para a API Google Documents List.

ResourceId.generate(Document)Mapear um objeto de documento para um ID de recurso.

View

View é a classe base abstrata para as várias classes de visualização, como DocsView.

View(ViewId)Construtor.
View.getId()Retorna o ViewId dessa visualização.
View.setMimeTypes(string)Define os tipos MIME incluídos na visualização. Use vírgulas para separar tipos MIME se mais de uma for necessária. Se você não definir tipos MIME, os arquivos de todos os tipos MIME serão exibidos na visualização.
View.setQuery(string)Para visualizações que envolvem pesquisas, preencha a consulta de pesquisa com esses termos.

ViewGroup

ViewGroup é um agrupamento visual de visualizações. O item raiz do ViewGroup precisa ser um View.

ViewGroup(View | ViewId)Uma ViewGroup é um agrupamento visual de visualizações no painel de navegação. O item raiz da ViewGroup precisa ser View.
ViewGroup.addLabel(string)Adicionar um marcador a ViewGroup.
ViewGroup.addView(ViewId | View)Adicione uma visualização ao ViewGroup. O View pode ser representado por um objeto derivado da view ou simplesmente pelo ViewId.
ViewGroup.addViewGroup(ViewGroup)Aninhar um ViewGroup no ViewGroup atual.

ViewId

ViewId é um tipo enumerado, usado para construir objetos View e ViewGroup.

ViewId.DOCSTodos os tipos de documento do Google Drive.
ViewId.DOCS_IMAGESFotos do Google Drive.
ViewId.DOCS_IMAGES_AND_VIDEOSFotos e vídeos do Google Drive.
ViewId.DOCS_VIDEOSVídeos do Google Drive.
ViewId.DOCUMENTSDocumentos do Google Drive.
ViewId.DRAWINGSDesenhos do Google Drive.
ViewId.FOLDERSPastas do Google Drive.
ViewId.FORMSFormulários do Google Drive.
ViewId.PDFSArquivos PDF armazenados no Google Drive.
ViewId.PRESENTATIONSApresentações do Google Drive.
ViewId.SPREADSHEETSPlanilhas do Google Drive.

Tipos de callback

Os tipos enumerados a seguir são encontrados nos dados de callback retornados pela API Google Picker.

Ação

Action é um tipo enumerado que representa a ação realizada pelo usuário para dispensar a caixa de diálogo. Esse valor está no campo Response.ACTION nos dados do callback.

Action.CANCELO usuário cancelou a caixa de diálogo do seletor do Google.
Action.PICKEDO usuário escolheu pelo menos um item.

Documento

Document é um tipo enumerado usado para transmitir informações sobre um item selecionado específico. Somente os campos relevantes para o item selecionado são retornados. Esse valor está no campo Response.DOCUMENTS nos dados do callback.

Document.DESCRIPTIONUma descrição do item selecionado cedida pelo usuário.
Document.DURATIONA duração de um vídeo selecionado.
Document.EMBEDDABLE_URLUm URL para este item adequado para incorporação em uma página da Web.
Document.ICON_URLÉ um URL para um ícone do item.
Document.IDID do item selecionado.
Document.IS_NEWRetorna verdadeiro se o item selecionado tiver sido enviado recentemente.
Document.LAST_EDITED_UTCO carimbo de data/hora que descreve quando esse item foi editado pela última vez.
Document.MIME_TYPEO tipo MIME deste item.
Document.NAMENome deste item.
Document.NUM_CHILDRENO número de filhos contidos neste item. Por exemplo, o número de arquivos na pasta selecionada.
Document.PARENT_IDO ID pai desse item. Por exemplo, a pasta que contém esse arquivo.
Document.SERVICE_IDUma ServiceId que descreve o serviço em que o item foi selecionado.
Document.THUMBNAILSUma matriz de Thumbnails que descrevem os atributos de uma foto ou um vídeo. As miniaturas não são retornadas se os itens selecionados pertencem ao Google Drive.
Document.TYPEO Type do item selecionado.
Document.URLUm URL para este item.

Resposta

Response é um tipo enumerado usado para transmitir informações sobre os itens selecionados do usuário.

Response.ACTIONUm tipo Action que representa a ação realizada pelo usuário para dispensar a caixa de diálogo.
Response.DOCUMENTSUma matriz de Documents selecionados pelo usuário.
Response.PARENTSOs códigos das pastas principais dos itens selecionados. Por exemplo, os IDs das pastas mãe com os arquivos que foram selecionados.
Response.VIEWA View em que o usuário selecionou esses itens.

ID do serviço

ServiceId é um tipo enumerado usado para descrever o serviço em que o item foi selecionado. Esse valor está no campo Document.SERVICE_ID do Document selecionado.

ServiceId.DOCSo Google Drive;

miniatura

Thumbnail é um tipo enumerado usado para transmitir informações sobre uma foto ou um vídeo selecionado. Esse valor pode ser encontrado no campo Document.THUMBNAILS de um Document selecionado.

Thumbnail.HEIGHTA altura da foto ou do vídeo em pixels.
Thumbnail.WIDTHA largura da foto ou do vídeo em pixels.
Thumbnail.URLUm URL para a foto ou o vídeo selecionado.

Tipo

Type é um tipo enumerado usado para categorizar o item selecionado. Esse valor pode ser encontrado no campo Document.TYPE de um Document selecionado.

Type.DOCUMENTO item é um documento.
Type.PHOTOO item é uma foto.
Type.VIDEOO item é um vídeo.