Package google.mybusiness.accountmanagement.v1

Índice

AccessControl

Esse serviço permite o gerenciamento dos usuários que têm acesso a contas e locais.

AcceptInvitation

rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty)

Aceita o convite especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
CreateAccountAdmin

rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin)

Convida o usuário especificado para se tornar um administrador da conta especificada. A pessoa convidada precisa aceitar o convite para ter acesso à conta. Consulte [AcceptInvitation] [google.mybusiness.accountmanagement.v1.AcceptInvitation] para aceitar um convite programaticamente.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
CreateLocationAdmin

rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin)

Convida o usuário especificado para se tornar um administrador do local especificado. A pessoa convidada precisa aceitar o convite para ter acesso ao local. Consulte [AcceptInvitation] [google.mybusiness.accountmangement.v1.AcceptInvitation] para aceitar um convite programaticamente.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
DeclineInvitation

rpc DeclineInvitation(DeclineInvitationRequest) returns (Empty)

Recusa o convite especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
DeleteAccountAdmin

rpc DeleteAccountAdmin(DeleteAccountAdminRequest) returns (Empty)

Remove o administrador especificado da conta especificada.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
DeleteLocationAdmin

rpc DeleteLocationAdmin(DeleteLocationAdminRequest) returns (Empty)

Remove o administrador especificado como administrador do local especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListAccountAdmins

rpc ListAccountAdmins(ListAccountAdminsRequest) returns (ListAccountAdminsResponse)

Lista os administradores da conta especificada.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListInvitations

rpc ListInvitations(ListInvitationsRequest) returns (ListInvitationsResponse)

Lista os convites pendentes da conta especificada.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListLocationAdmins

rpc ListLocationAdmins(ListLocationAdminsRequest) returns (ListLocationAdminsResponse)

Lista todos os administradores do local especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
TransferLocation

rpc TransferLocation(TransferLocationRequest) returns (Empty)

Move um local de uma conta do usuário para outra gerenciada pelo mesmo usuário. O usuário precisa ser proprietário da conta à qual o local está associado no momento e ser pelo menos administrador da conta de destino.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
UpdateAccountAdmin

rpc UpdateAccountAdmin(UpdateAccountAdminRequest) returns (Admin)

Atualiza o administrador do administrador da conta especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
UpdateLocationAdmin

rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (Admin)

Atualiza o administrador do local especificado. Somente o AdminRole do administrador pode ser atualizado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.

Contas

Essa API permite o gerenciamento de contas do negócio no Google. Ele define o seguinte modelo de recurso:

  • A API tem um conjunto de recursos de conta com o nome accounts/*.

  • Para sua conveniência, é possível usar o sinônimo "eu" em vez do ID da conta pessoal do autor da chamada autenticado. Exemplos: GET /v1/accounts/me GET /v1/accounts/me/locations

CreateAccount

rpc CreateAccount(CreateAccountRequest) returns (Account)

Cria uma conta com o nome e o tipo especificados no pai informado.

  • Não é possível criar contas pessoais e organizações.
  • Não é possível criar grupos de usuários com uma conta pessoal como proprietário principal.
  • Não é possível criar grupos por locais com um proprietário principal de uma conta pessoal se ela estiver em uma organização.
  • Os grupos por locais não podem ser proprietários dos grupos por locais.
Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Extrai a conta especificada. Retorna NOT_FOUND se a conta não existir ou se o autor da chamada não tiver direitos de acesso a ela.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

Lista todas as contas do usuário autenticado. Isso inclui todas as contas do usuário e todas as contas em que o usuário tem direitos de gerenciamento.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

Atualiza a conta comercial especificada. Não é possível atualizar contas pessoais com esse método.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.

AcceptInvitationRequest

Mensagem de solicitação para AccessControl.AcceptInvitation.

Campos
name

string

Obrigatório. O nome do convite que está sendo aceito. accounts/{account_id}/invitations/{invitation_id}

Conta

Uma conta é um contêiner para seu local. Se você é o único usuário que gerencia os locais da sua empresa, pode utilizar sua Conta do Google pessoal. Para compartilhar o gerenciamento de locais com vários usuários, crie uma conta do negócio.

Campos
name

string

Imutável. O nome do recurso, no formato accounts/{account_id}.
account_name

string

Obrigatório. Nome da conta. Para uma conta do tipo PERSONAL, são o nome e sobrenome da conta de usuário.
primary_owner

string

Obrigatório. Apenas entrada. O nome do recurso da conta que será a proprietária principal da conta que está sendo criada. Ele precisa estar no formato accounts/{account_id}.
type

AccountType

Obrigatório. Contém o tipo de conta. Contas dos tipos PESSOAL e ORGANIZAÇÃO não podem ser criadas usando esta API.
role

AccountRole

Apenas saída. Especifica o AccountRole dessa conta.
verification_state

VerificationState

Apenas saída. Se forem verificados, os locais futuros criados serão automaticamente conectados ao Google Maps e terão páginas do Google+ criadas sem a necessidade de moderação.
vetted_state

VettedState

Apenas saída. Indica se a conta é verificada pelo Google. Uma conta verificada pode verificar locais pelo método VETTED_PARTNER.
account_number

string

Apenas saída. Número de referência da conta, se provisionado.
permission_level

PermissionLevel

Apenas saída. Especifica o nível de permissão que o usuário tem para a conta.
organization_info

OrganizationInfo

Apenas saída. Informações adicionais de uma organização. Só é preenchido para uma conta da organização.

AccountRole

Indica o nível de acesso que o usuário autenticado tem nessa conta. Para mais informações, consulte o artigo da Central de Ajuda

Enums
ACCOUNT_ROLE_UNSPECIFIED Não especificado.
PRIMARY_OWNER O usuário é o proprietário principal da conta.
OWNER O usuário proprietário da conta.
MANAGER O usuário pode gerenciar esta conta.
SITE_MANAGER O usuário pode gerenciar um conjunto limitado de recursos para a conta.

AccountType

Indica o tipo de conta: pessoal/de usuário ou empresarial.

Enums
ACCOUNT_TYPE_UNSPECIFIED Não especificado.
PERSONAL Uma conta de usuário final.
LOCATION_GROUP Um grupo de locais. Para mais informações, consulte o artigo da Central de Ajuda
USER_GROUP Um grupo de usuários para separar os funcionários da organização em grupos. Para mais informações, consulte o artigo da Central de Ajuda
ORGANIZATION Uma organização que representa uma empresa. Para mais informações, consulte o artigo da Central de Ajuda

OrganizationInfo

Informações adicionais armazenadas para uma organização.

Campos
registered_domain

string

Apenas saída. O domínio registrado da conta.
address

PostalAddress

Apenas saída. O endereço postal da conta.
phone_number

string

Apenas saída. Número de contato da organização.

PermissionLevel

Indica o nível de acesso que o usuário autenticado tem nessa conta.

Enums
PERMISSION_LEVEL_UNSPECIFIED Não especificado.
OWNER_LEVEL O usuário tem permissão no nível do proprietário.
MEMBER_LEVEL O usuário tem permissão no nível de membro.

VerificationState

Indica o estado de verificação da conta.

Enums
VERIFICATION_STATE_UNSPECIFIED Não especificado.
VERIFIED Conta verificada.
UNVERIFIED Conta que não foi verificada e a verificação não foi solicitada.
VERIFICATION_REQUESTED Conta que não foi verificada, mas a verificação foi solicitada.

VettedState

Indica o estado verificado de uma conta.

Enums
VETTED_STATE_UNSPECIFIED Não especificado
NOT_VETTED A conta não é verificada pelo Google.
VETTED A conta foi verificada pelo Google e está em um estado válido. Uma conta será verificada automaticamente se tiver acesso direto a uma conta de grupo verificado.
INVALID A conta foi verificada, mas está em um estado inválido. A conta vai se comportar como uma conta não verificada.

Administrador

Um administrador de uma conta ou local.

Campos
name

string

Imutável. O nome do recurso. Para administradores de contas, o formato é: accounts/{account_id}/admins/{admin_id}

Para administradores de locais, o formato é: locations/{location_id}/admins/{admin_id}

Este campo será ignorado se definido durante a criação do administrador.
admin

string

Opcional. O nome do administrador. Ao fazer o convite inicial, este é o endereço de e-mail do convidado. Em chamadas GET, o endereço de e-mail do usuário será retornado se o convite ainda estiver pendente. Caso contrário, ele conterá o nome e o sobrenome do usuário.

Esse campo só precisa ser definido durante a criação do administrador.
account

string

Imutável. O nome do recurso da conta a que este administrador se refere. Usado ao chamar locations.admins.create para convidar um grupo por local como administrador.

Se este campo e admin forem definidos em solicitações CREATE, ele terá precedência e o endereço de e-mail em admin será ignorado.

Formato: accounts/{account}.
role

AdminRole

Obrigatório. Especifica a função que este administrador usa com a conta ou o local especificado.
pending_invitation

bool

Apenas saída. Indica se esse administrador tem um convite pendente para o recurso especificado.

AdminRole

Indica o nível de acesso que um administrador tem. Para mais informações, consulte o artigo da Central de Ajuda

Enums
ADMIN_ROLE_UNSPECIFIED Não especificado.
PRIMARY_OWNER O administrador tem acesso de proprietário e é o proprietário principal. (Exibida como "Primary Owner" na interface do usuário).
OWNER O administrador tem acesso de proprietário. (exibida como "Proprietário" na interface).
MANAGER O administrador tem acesso de gerenciamento.
SITE_MANAGER O administrador pode gerenciar páginas sociais (Google+). É exibido como "Site Manager" na interface. Esta API não permite criar um administrador de conta com a função SITE_MANAGER.

CreateAccountAdminRequest

Mensagem de solicitação para AccessControl.CreateAccountAdmin.

Campos
parent

string

Obrigatório. O nome do recurso da conta para que este administrador foi criado. accounts/{account_id}.
admin

Admin

Obrigatório. O administrador a ser criado. A função não pode ser SITE_MANAGER

CreateAccountRequest

Mensagem de solicitação para accounts.CreateAccount.

Campos
account

Account

Obrigatório. Informações da conta que será criada. Os únicos campos permitidos são conta e tipo.

CreateLocationAdminRequest

Mensagem de solicitação para AccessControl.CreateLocationAdmin.

Campos
parent

string

Obrigatório. O nome do recurso do local para o qual este administrador é criado. locations/{location_id}/admins.
admin

Admin

Obrigatório. O administrador a ser criado.

DeclineInvitationRequest

Mensagem de solicitação para AccessControl.RecusarInvitation.

Campos
name

string

Obrigatório. O nome do convite da conta que está sendo recusado. accounts/{account_id}/invitations/{invitation_id}

DeleteAccountAdminRequest

Mensagem de solicitação para AccessControl.DeleteAccountAdmin.

Campos
name

string

Obrigatório. O nome do recurso do administrador a ser removido da conta. accounts/{account_id}/admins/{admin_id}.

DeleteLocationAdminRequest

Mensagem de solicitação para AccessControl.DeleteLocationAdmin.

Campos
name

string

Obrigatório. O nome do recurso do administrador a ser removido do local.

GetAccountRequest

Mensagem de solicitação para accounts.GetAccount.

Campos
name

string

Obrigatório. O nome da conta a ser buscada.

Convite

Representa um convite pendente.

Campos
name

string

Obrigatório. O nome do recurso para o convite. accounts/{account_id}/invitations/{invitation_id}.
role

AdminRole

Apenas saída. A função de convidado na conta.
target_type

TargetType

Apenas saída. Especifica os tipos de segmentação que precisam aparecer na resposta.
Campo de união target. Indica o público-alvo deste convite. target pode ser apenas de um dos tipos a seguir:
target_account

Account

A conta pouco preenchida a que este convite se destina.
target_location

TargetLocation

O local de destino do convite.

TargetLocation

Representa um local de destino para um convite pendente.

Campos
location_name

string

O nome do local para o qual o usuário é convidado.
address

string

O endereço do local para o qual o usuário foi convidado.

TargetType

É o tipo de público-alvo do convite.

Enums
TARGET_TYPE_UNSPECIFIED Definido quando o tipo de destino não é especificado.
ACCOUNTS_ONLY Liste convites somente para segmentações do tipo "Conta".
LOCATIONS_ONLY Lista convites apenas para segmentações do tipo "Local".

ListAccountAdminsRequest

Mensagem de solicitação para AccessControl.ListAccountAdmins.

Campos
parent

string

Obrigatório. O nome da conta da qual recuperar uma lista de administradores. accounts/{account_id}/admins.

ListAccountAdminsResponse

Mensagem de resposta para AccessControl.ListAccountAdmins.

Campos
account_admins[]

Admin

Um conjunto de instâncias de administrador.

ListAccountsRequest

A mensagem de solicitação para accounts.ListAccounts.

Campos
parent_account

string

Opcional. O nome do recurso da conta para que a lista de contas acessíveis diretamente será recuperada. Isso é válido apenas para organizações e grupos de usuários. Se estiver vazio, retornará ListAccounts para o usuário autenticado. accounts/{account_id}.
page_size

int32

Opcional. Quantas contas precisam ser buscadas por página. O padrão e o máximo são 20.
page_token

string

Opcional. Se especificado, a próxima página de contas é recuperada. O pageToken é retornado quando uma chamada para accounts.list retorna mais resultados do que o tamanho de página solicitado.
filter

string

Opcional. Um filtro que restringe as contas a retornar. A resposta inclui apenas entradas que correspondem ao filtro. Se filter estiver vazio, nenhuma restrição será aplicada e todas as contas (paginadas) serão recuperadas para a conta solicitada.

Por exemplo, uma solicitação com o filtro type=USER_GROUP retornará somente grupos de usuários.

O campo type é o único filtro compatível.

ListAccountsResponse

Mensagem de resposta para accounts.ListAccounts.

Campos
accounts[]

Account

Um conjunto de contas às quais o usuário tem acesso. A conta pessoal do usuário que fez a consulta será sempre o primeiro item do resultado, a menos que seja filtrado.
next_page_token

string

Se o número de contas exceder o tamanho de página solicitado, esse campo será preenchido com um token para buscar a próxima página de contas em uma chamada subsequente para accounts.list. Se não houver mais contas, este campo não estará presente na resposta.

ListInvitationsRequest

Mensagem de solicitação para AccessControl.ListInvitations.

Campos
parent

string

Obrigatório. O nome da conta da qual a lista de convites está sendo recuperada. accounts/{account_id}/invitations
filter

string

Opcional. É possível filtrar a resposta por meio do campo Invitation.target_type.

ListInvitationsResponse

Mensagem de resposta para AccessControl.ListInvitations.

Campos
invitations[]

Invitation

Uma coleção de convites pendentes para a conta. O número de convites listados aqui não pode exceder 1.000.

ListLocationAdminsRequest

Mensagem de solicitação para AccessControl.ListLocationAdmins.

Campos
parent

string

Obrigatório. O nome do local do qual listar os administradores. locations/{location_id}/admins.

ListLocationAdminsResponse

Mensagem de resposta para AccessControl.ListLocationAdmins.

Campos
admins[]

Admin

Um conjunto de administradores.

TransferLocationRequest

Mensagem de solicitação para AccessControl.TransferLocation.

Campos
name

string

Obrigatório. O nome do local a ser transferido. locations/{location_id}.
destination_account

string

Obrigatório. Nome do recurso da conta para onde a unidade será transferida (por exemplo, "accounts/{account}").

UpdateAccountAdminRequest

Mensagem de solicitação para AccessControl.UpdateAccountAdmin.

Campos
account_admin

Admin

Obrigatório. A versão atualizada do Admin.
update_mask

FieldMask

Obrigatório. Os campos específicos que precisam ser atualizados. O único campo editável é o papel.

UpdateAccountRequest

Mensagem de solicitação para accounts.UpdateAccount.

Campos
account

Account

Obrigatório. A conta atualizada.
update_mask

FieldMask

Obrigatório. Os campos específicos que precisam ser atualizados. O único campo editável é accountName.
validate_only

bool

Opcional. Se for verdadeiro, a solicitação será validada sem realmente atualizar a conta.

UpdateLocationAdminRequest

Mensagem de solicitação para AccessControl.UpdateLocationAdmin.

Campos
location_admin

Admin

Obrigatório. A versão atualizada do Admin.
update_mask

FieldMask

Obrigatório. Os campos específicos que precisam ser atualizados. O único campo editável é o papel.