REST Resource: users

Recurso: User

Um único usuário no Display & Vídeo em 360°.

Representação JSON
{
  "name": string,
  "userId": string,
  "email": string,
  "displayName": string,
  "assignedUserRoles": [
    {
      object (AssignedUserRole)
    }
  ]
}
Campos
name

string

Apenas saída. O nome de recurso do usuário.

userId

string (int64 format)

Apenas saída. O ID exclusivo do usuário. Atribuído pelo sistema.

email

string

Obrigatório. Imutável. O endereço de e-mail usado para identificar o usuário.

displayName

string

Obrigatório. O nome de exibição do usuário.

Precisa ser codificado em UTF-8 com tamanho máximo de 240 bytes.

assignedUserRoles[]

object (AssignedUserRole)

As funções de usuário atribuídas.

Obrigatório em users.create. Saída apenas em users.patch. Só pode ser atualizado até users.bulkEditAssignedUserRoles.

AssignedUserRole

Uma única função do usuário atribuída, que define a interação autorizada de um usuário com determinado parceiro ou anunciante.

Representação JSON
{
  "assignedUserRoleId": string,
  "userRole": enum (UserRole),

  // Union field entity_id can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field entity_id.
}
Campos
assignedUserRoleId

string

Apenas saída. O ID da função do usuário atribuída.

userRole

enum (UserRole)

Obrigatório. A função do usuário a ser atribuída a um usuário para a entidade.

Campo de união entity_id. Obrigatório.

O ID da entidade a que a função de usuário atribuída se aplica. entity_id pode ser apenas de um dos tipos a seguir:

partnerId

string (int64 format)

O ID do parceiro ao qual a função de usuário atribuída se aplica.

advertiserId

string (int64 format)

O ID do anunciante ao qual a função de usuário atribuída se aplica.

UserRole

Possíveis funções de usuário.

Enums
USER_ROLE_UNSPECIFIED Valor padrão quando a função do usuário não é especificada ou é desconhecida nesta versão.
ADMIN O usuário pode gerenciar campanhas, criativos, pedidos de inserção, itens de linha e relatórios da entidade. Eles podem visualizar e editar informações de faturamento, criar ou modificar usuários e ativar ou desativar trocas. Esse papel só pode ser atribuído a uma entidade parceira.
ADMIN_PARTNER_CLIENT O usuário pode gerenciar campanhas, criativos, pedidos de inserção, itens de linha e relatórios da entidade. Eles podem criar e modificar outros usuários do ADMIN_PARTNER_CLIENT e visualizar informações de faturamento. Eles não podem visualizar modelos de receita, marcações ou quaisquer outros campos sensíveis ao revendedor. Esse papel só pode ser atribuído a uma entidade parceira.
STANDARD O usuário pode gerenciar campanhas, criativos, pedidos de inserção, itens de linha e relatórios da entidade. Eles não podem criar e modificar usuários nem visualizar informações de faturamento.
STANDARD_PLANNER O usuário pode ver todas as campanhas, criativos, pedidos de inserção, itens de linha e relatórios da entidade, incluindo todos os dados de custo. Eles podem criar e modificar recursos relacionados ao planejamento, incluindo planos e inventário.
STANDARD_PLANNER_LIMITED O usuário pode ver todas as campanhas, criativos, pedidos de inserção, itens de linha e relatórios da entidade. Eles podem criar ou modificar recursos relacionados ao planejamento, incluindo planos e inventário. Eles não têm acesso a dados de custo e não podem iniciar, aceitar ou negociar transações.
STANDARD_PARTNER_CLIENT O usuário pode gerenciar campanhas, criativos, pedidos de inserção, itens de linha e relatórios da entidade. Eles não podem criar ou modificar outros usuários nem visualizar informações de faturamento. Eles não podem visualizar modelos de receita, marcações ou quaisquer outros campos sensíveis ao revendedor. Esse papel só pode ser atribuído a uma entidade de anunciante.
READ_ONLY O usuário só pode criar relatórios e visualizar os dados da entidade.
REPORTING_ONLY O usuário só pode criar e gerenciar relatórios.
LIMITED_REPORTING_ONLY O usuário só pode criar e gerenciar os seguintes relatórios seguros para o cliente: Geral, Desempenho do público-alvo, Parceiros cruzados, Palavra-chave, ID do pedido, Categoria e Provedor de dados de terceiros.
CREATIVE O usuário pode visualizar as informações do plano de mídia de que precisa para colaborar, mas não pode visualizar o Marketplace nem dados relacionados ao custo.
CREATIVE_ADMIN O usuário pode visualizar as informações do plano de mídia de que precisa para colaborar, mas não pode visualizar o Marketplace nem dados relacionados ao custo. Além disso, ele pode adicionar outros administradores ou usuários de criação à entidade.

Métodos

bulkEditAssignedUserRoles

Edição em massa das funções de um usuário.

create

Cria um novo usuário.

delete

Exclui um usuário.

get

Recebe um usuário.

list

Lista os usuários que estão acessíveis ao usuário atual.

patch

Atualiza um usuário existente.