Permissions: create

Cria uma permissão para um arquivo ou drive compartilhado. Veja mais informações sobre como criar permissões em Compartilhar arquivos, pastas e drives. Faça um teste agora.

Solicitação

Solicitação HTTP

POST https://www.googleapis.com/drive/v3/files/fileId/permissions

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
fileId string Mostra o ID do arquivo ou drive compartilhado.
Parâmetros de consulta opcionais
emailMessage string Uma mensagem de texto simples personalizada a ser incluída no e-mail de notificação.
enforceSingleParent boolean Obsoleto. Consulte moveToNewOwnersRoot para ver mais detalhes. Padrão: false
fields string Os caminhos dos campos que você quer incluir na resposta. Se não for especificado, a resposta incluirá um conjunto padrão de campos específicos a esse método. Para o desenvolvimento, é possível usar o valor especial * para retornar todos os campos, mas você terá um desempenho melhor selecionando apenas os campos necessários. Veja mais informações em Retornar campos específicos de um arquivo.
moveToNewOwnersRoot boolean Esse parâmetro só terá efeito se o item não estiver em um drive compartilhado e a solicitação estiver tentando transferir a propriedade dele. Se definido como true, o item será movido para a pasta raiz do Meu Drive do novo proprietário e todos os pais anteriores serão removidos. Se definido como false, os pais não serão alterados. Padrão: false
sendNotificationEmail boolean Se é necessário enviar um e-mail de notificação ao compartilhar com usuários ou grupos. O padrão é "true" para usuários e grupos e não é permitido para outras solicitações. Ela não pode ser desativada para transferências de propriedade.
supportsAllDrives boolean Indica se o aplicativo solicitante é compatível com os itens "Meu Drive" e drives compartilhados. Padrão: false.
supportsTeamDrives boolean O uso suspenso oferece suporte a AllAllDrives. Padrão: false
transferOwnership boolean Define se a propriedade do usuário será transferida para o usuário especificado e o downgrade do proprietário atual para um gravador. Esse parâmetro é obrigatório como confirmação do efeito colateral. Os proprietários de arquivos só podem transferir a propriedade de arquivos no Meu Drive. Os arquivos em um drive compartilhado pertencem à organização proprietária do drive. As transferências de propriedade não são compatíveis com arquivos e pastas nos drives compartilhados. Os organizadores de um drive compartilhado podem mover itens desse drive para o Meu Drive, o que transfere a propriedade para eles. Padrão: false.
useDomainAdminAccess boolean Emita a solicitação como administrador do domínio. Se ela for definida como true, o solicitante receberá acesso se o parâmetro do ID do arquivo se referir a um drive compartilhado e se o solicitante for um administrador do domínio a que ele pertence. Padrão: false

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos:

Escopo
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file

Alguns escopos são restritos e exigem uma avaliação de segurança para serem usados pelo app. Para mais informações, consulte a página de autenticação e autorização.

Corpo da solicitação

No corpo da solicitação, forneça um recurso Permissions com as seguintes propriedades:

Nome da propriedade Valor Descrição Observações
Propriedades obrigatórias
role string O papel concedido pela permissão. Embora novos valores possam ser compatíveis no futuro, os seguintes itens são permitidos:
  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
 gravável
type string É o tipo de beneficiário. Os valores válidos são:
  • user
  • group
  • domain
  • anyone
Ao criar uma permissão, se type for user ou group, você vai precisar fornecer um emailAddress para o usuário ou grupo. Quando type for domain, é necessário fornecer um domain. Não há informações extras necessárias para o tipo anyone.		 gravável
Propriedades opcionais
allowFileDiscovery boolean Indica se a permissão permite que o arquivo seja descoberto na pesquisa. Isso se aplica apenas às permissões do tipo domain ou anyone. gravável
domain string O domínio ao qual esta permissão se refere. Atualmente, as seguintes opções são permitidas:
  • O domínio inteiro, como "sua-empresa.com".
  • Um público-alvo, como "ID.audience.googledomains.com".
 gravável
emailAddress string É o endereço de e-mail do usuário ou grupo ao qual essa permissão se refere. gravável
expirationTime datetime A hora em que essa permissão expira (RFC 3339, data e hora). Os prazos de validade têm as seguintes restrições:
  • Eles não podem ser definidos em itens do drive compartilhado.
  • Eles só podem ser definidos com permissões de usuário e grupo.
  • A hora deve ser uma data futura.
  • O horário não pode ser mais de um ano no futuro.
 gravável
pendingOwner boolean Indica se a conta associada a esta permissão tem um proprietário pendente. Preenchido apenas para permissões do tipo user em arquivos que não estão em um drive compartilhado. gravável
view string Indica a visualização dessa permissão. Preenchido apenas para permissões que pertencem a uma visualização. published é o único valor compatível. gravável

Resposta

Se bem-sucedido, este método retornará um recurso Permissions no corpo da resposta.

Confira!

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.