Package google.mybusiness.accountmanagement.v1

Índice

AccessControl

Este servicio permite administrar los usuarios que tienen acceso a cuentas y ubicaciones.

AcceptInvitation

rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty)

Acepta la invitación especificada.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
CreateAccountAdmin

rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin)

Invita al usuario especificado a convertirse en administrador de la cuenta especificada. El invitado debe aceptar la invitación para obtener acceso a la cuenta. Consulta [AcceptInvitation] [google.mybusiness.accountmanagement.v1.AcceptInvitation] para aceptar una invitación de manera programática.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
CreateLocationAdmin

rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin)

Invita al usuario especificado a convertirse en administrador de la ubicación especificada. El invitado debe aceptar la invitación para obtener acceso a la ubicación. Consulta [AcceptInvitation] [google.mybusiness.accountmangement.v1.AcceptInvitation] para aceptar una invitación de manera programática.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
DeclineInvitation

rpc DeclineInvitation(DeclineInvitationRequest) returns (Empty)

Rechaza la invitación especificada.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
DeleteAccountAdmin

rpc DeleteAccountAdmin(DeleteAccountAdminRequest) returns (Empty)

Quita al administrador especificado de la cuenta especificada.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
DeleteLocationAdmin

rpc DeleteLocationAdmin(DeleteLocationAdminRequest) returns (Empty)

Quita al administrador especificado como administrador de la ubicación especificada.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
ListAccountAdmins

rpc ListAccountAdmins(ListAccountAdminsRequest) returns (ListAccountAdminsResponse)

Muestra una lista de los administradores de la cuenta especificada.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
ListInvitations

rpc ListInvitations(ListInvitationsRequest) returns (ListInvitationsResponse)

Enumera las invitaciones pendientes para la cuenta especificada.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
ListLocationAdmins

rpc ListLocationAdmins(ListLocationAdminsRequest) returns (ListLocationAdminsResponse)

Muestra una lista de todos los administradores de la ubicación especificada.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
TransferLocation

rpc TransferLocation(TransferLocationRequest) returns (Empty)

Traslada una ubicación de una cuenta que posee el usuario a otra cuenta administrada por el mismo usuario. El usuario debe ser propietario de la cuenta a la que está asociada la ubicación actualmente y, además, debe ser al menos un administrador de la cuenta de destino.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
UpdateAccountAdmin

rpc UpdateAccountAdmin(UpdateAccountAdminRequest) returns (Admin)

Actualiza el administrador del administrador de la cuenta especificado.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
UpdateLocationAdmin

rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (Admin)

Actualiza el administrador de la ubicación especificada. Solo se puede actualizar el AdminRole del administrador.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.

Cuentas

Esta API permite administrar cuentas comerciales en Google. Define el siguiente modelo de recursos:

  • La API tiene una colección de recursos de la cuenta llamada accounts/*.

  • Para tu comodidad, puedes usar el sinónimo "yo" en lugar del ID de la cuenta para la cuenta personal del emisor autenticado. Ejemplos: GET /v1/accounts/me GET /v1/accounts/me/locations

CreateAccount

rpc CreateAccount(CreateAccountRequest) returns (Account)

Crea una cuenta con el nombre y el tipo especificados en el elemento superior determinado.

  • No se pueden crear cuentas personales ni organizaciones.
  • No se pueden crear grupos de usuarios con una cuenta personal como propietario principal.
  • No se pueden crear grupos por ubicación con el propietario principal de una cuenta personal si esta cuenta está en una organización.
  • Los grupos por ubicación no pueden ser propietarios de grupos por ubicación.
Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Obtiene la cuenta especificada. Muestra NOT_FOUND si la cuenta no existe o si el emisor no tiene derechos de acceso a ella.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

Enumera todas las cuentas del usuario autenticado. Esto incluye todas las cuentas que pertenecen al usuario, así como todas las cuentas para las que el usuario tenga derechos de administración.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

Actualiza la cuenta comercial especificada. Las cuentas personales no se pueden actualizar con este método.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.

AcceptInvitationRequest

Mensaje de solicitud para AccessControl.AcceptInvitation.

Campos
name

string

Obligatorio. El nombre de la invitación que se acepta. accounts/{account_id}/invitations/{invitation_id}

Cuenta

Una cuenta es un contenedor para tu ubicación. Si eres el único usuario que administra ubicaciones para tu empresa, puedes usar tu Cuenta de Google personal. Para compartir la administración de ubicaciones con varios usuarios, crea una cuenta comercial.

Campos
name

string

Inmutable. El nombre del recurso, en el formato accounts/{account_id}.
account_name

string

Obligatorio. El nombre de la cuenta. Para una cuenta de tipo PERSONAL, este es el nombre y apellido de la cuenta de usuario.
primary_owner

string

Obligatorio. Solo entrada. El nombre de recurso de la cuenta que será el propietario principal de la cuenta que se creará. Debe tener el formato accounts/{account_id}.
type

AccountType

Obligatorio. Contiene el tipo de cuenta. Las cuentas de tipo PERSONAL y ORGANIZATION no pueden crearse con esta API.
role

AccountRole

Solo salida. Especifica el AccountRole de esta cuenta.
verification_state

VerificationState

Solo salida. Si se verifica, las ubicaciones futuras que se creen se conectarán automáticamente a Google Maps y se crearán páginas de Google+ sin requerir moderación.
vetted_state

VettedState

Solo salida. Indica si la cuenta está aprobada por Google. Una cuenta aprobada puede verificar las ubicaciones a través del método VETTED_PARTNER.
account_number

string

Solo salida. Número de referencia de la cuenta (si se aprovisionó).
permission_level

PermissionLevel

Solo salida. Especifica el nivel de permiso que el usuario tiene para esta cuenta.
organization_info

OrganizationInfo

Solo salida. Es la información adicional de una organización. Se propaga solo para una cuenta de organización.

AccountRole

Indica el nivel de acceso que tiene el usuario autenticado en esta cuenta. Para obtener más información, consulta el artículo del Centro de ayuda.

Enumeradores
ACCOUNT_ROLE_UNSPECIFIED No se especifica.
PRIMARY_OWNER El usuario es el propietario principal de esta cuenta.
OWNER Es el propietario del usuario de la cuenta.
MANAGER El usuario puede administrar esta cuenta.
SITE_MANAGER El usuario puede administrar un conjunto limitado de funciones para la cuenta.

AccountType

Indica de qué tipo es esta cuenta: una cuenta personal o de usuario, o una comercial.

Enumeradores
ACCOUNT_TYPE_UNSPECIFIED No se especifica.
PERSONAL Una cuenta de usuario final
LOCATION_GROUP Un grupo de Ubicaciones. Para obtener más información, consulta el artículo del Centro de ayuda.
USER_GROUP Un grupo de usuarios para separar al personal de la organización en grupos. Para obtener más información, consulta el artículo del Centro de ayuda.
ORGANIZATION Es una organización que representa a una empresa. Para obtener más información, consulta el artículo del Centro de ayuda.

OrganizationInfo

Es la información adicional almacenada para una organización.

Campos
registered_domain

string

Solo salida. El dominio registrado para la cuenta.
address

PostalAddress

Solo salida. Es la dirección postal de la cuenta.
phone_number

string

Solo salida. Es el número de contacto de la organización.

PermissionLevel

Indica el nivel de acceso que tiene el usuario autenticado en esta cuenta.

Enumeradores
PERMISSION_LEVEL_UNSPECIFIED No se especifica.
OWNER_LEVEL El usuario tiene permiso de nivel de propietario.
MEMBER_LEVEL El usuario tiene permiso de nivel de miembro.

VerificationState

Indica el estado de verificación de la cuenta.

Enumeradores
VERIFICATION_STATE_UNSPECIFIED No se especifica.
VERIFIED Cuenta verificada
UNVERIFIED Esta cuenta no se verificó y no se solicitó la verificación.
VERIFICATION_REQUESTED Cuenta que no está verificada, pero se solicitó la verificación.

VettedState

Indica el estado verificado de una cuenta.

Enumeradores
VETTED_STATE_UNSPECIFIED No especificado
NOT_VETTED Google no verificó la cuenta.
VETTED La cuenta está verificada por Google y se encuentra en un estado válido. Una cuenta se verifica automáticamente si tiene acceso directo a una cuenta de grupo aprobada.
INVALID La cuenta se aprobó, pero su estado no es válido. La cuenta se comportará como una no verificada.

Administrador

Un administrador de una cuenta o ubicación

Campos
name

string

Inmutable. Es el nombre del recurso. Para los administradores de cuenta, la dirección tiene el siguiente formato: accounts/{account_id}/admins/{admin_id}

Para los administradores de ubicación, tienen el siguiente formato: locations/{location_id}/admins/{admin_id}

Este campo se ignorará si se establece durante la creación del administrador.
admin

string

Opcional. El nombre del administrador. Cuando se envía la invitación inicial, esta es la dirección de correo electrónico del invitado. En las llamadas de GET, se muestra la dirección de correo electrónico del usuario si la invitación aún está pendiente. De lo contrario, contiene el nombre y el apellido del usuario.

Este campo solo se debe configurar durante la creación del administrador.
account

string

Inmutable. Indica el nombre del recurso de la cuenta al que hace referencia este administrador. Se usa cuando se llama a locations.admins.create para invitar a un LocationGroup como administrador.

Si tanto este campo como admin se configuran en las solicitudes CREATE, este campo tiene prioridad y se ignorará la dirección de correo electrónico de admin.

Formato: accounts/{account}.
role

AdminRole

Obligatorio. Especifica el rol que usa este administrador con la cuenta o ubicación especificadas.
pending_invitation

bool

Solo salida. Indica si este administrador tiene una invitación pendiente para el recurso especificado.

AdminRole

Indica el nivel de acceso que tiene un administrador. Para obtener más información, consulta el artículo del Centro de ayuda.

Enumeradores
ADMIN_ROLE_UNSPECIFIED No se especifica.
PRIMARY_OWNER El administrador tiene acceso de nivel de propietario y es el propietario principal. (Se muestra como "Propietario principal" en la IU).
OWNER El administrador tiene acceso de nivel del propietario. (Se muestra como "Propietario" en la IU).
MANAGER El administrador tiene acceso de administración.
SITE_MANAGER El administrador puede gestionar páginas sociales (de Google+). (Se muestra como "Administrador del sitio" en la IU). Esta API no permite crear un administrador de cuenta con la función SITE_MANAGER.

CreateAccountAdminRequest

Mensaje de solicitud para AccessControl.CreateAccountAdmin.

Campos
parent

string

Obligatorio. Es el nombre del recurso de la cuenta para la que se creó este administrador. accounts/{account_id}.
admin

Admin

Obligatorio. El administrador que se creó. La función no puede ser SITE_MANAGER

CreateAccountRequest

Mensaje de solicitud para Accounts.CreateAccount.

Campos
account

Account

Obligatorio. Información de la cuenta que se creará. Los únicos campos permitidos son Cuenta y Tipo.

CreateLocationAdminRequest

Mensaje de solicitud para AccessControl.CreateLocationAdmin.

Campos
parent

string

Obligatorio. Es el nombre del recurso de la ubicación para la que se creó este administrador. locations/{location_id}/admins.
admin

Admin

Obligatorio. El administrador que se creará.

DeclineInvitationRequest

Mensaje de solicitud para AccessControl.DenyInvitation.

Campos
name

string

Obligatorio. El nombre de la invitación a la cuenta que se rechaza. accounts/{account_id}/invitations/{invitation_id}

DeleteAccountAdminRequest

Mensaje de solicitud para AccessControl.DeleteAccountAdmin.

Campos
name

string

Obligatorio. El nombre del recurso del administrador que se quitará de la cuenta. accounts/{account_id}/admins/{admin_id}.

DeleteLocationAdminRequest

Mensaje de solicitud para AccessControl.DeleteLocationAdmin.

Campos
name

string

Obligatorio. El nombre del recurso del administrador que se quitará de la ubicación.

GetAccountRequest

Mensaje de solicitud para Accounts.GetAccount.

Campos
name

string

Obligatorio. El nombre de la cuenta que se recuperará.

Invitación

Representa una invitación pendiente.

Campos
name

string

Obligatorio. El nombre del recurso para la invitación. accounts/{account_id}/invitations/{invitation_id}.
role

AdminRole

Solo salida. El rol invitado en la cuenta.
target_type

TargetType

Solo salida. Especifica qué tipos de destino deben aparecer en la respuesta.
Campo de unión target. Indica el destino de esta invitación. Las direcciones (target) solo pueden ser una de las siguientes opciones:
target_account

Account

La cuenta poco propagada a la que corresponde esta invitación.
target_location

TargetLocation

La ubicación de segmentación para la que se creó esta invitación.

TargetLocation

Representa una ubicación de segmentación para una invitación pendiente.

Campos
location_name

string

El nombre de la ubicación a la que está invitado el usuario.
address

string

La dirección de la ubicación a la que está invitado al usuario.

TargetType

Es el tipo de segmentación para una invitación.

Enumeradores
TARGET_TYPE_UNSPECIFIED Se establece cuando no se especifica el tipo de objetivo.
ACCOUNTS_ONLY Enumera las invitaciones solo para destinos del tipo Cuenta.
LOCATIONS_ONLY Enumera invitaciones solo para objetivos de tipo Ubicación.

ListAccountAdminsRequest

Mensaje de solicitud para AccessControl.ListAccountAdmins.

Campos
parent

string

Obligatorio. El nombre de la cuenta desde la que se recupera la lista de administradores. accounts/{account_id}/admins.

ListAccountAdminsResponse

Mensaje de respuesta para AccessControl.ListAccountAdmins.

Campos
account_admins[]

Admin

Un conjunto de instancias de administrador

ListAccountsRequest

Mensaje de solicitud para Accounts.List Accounts.

Campos
parent_account

string

Opcional. El nombre del recurso de la cuenta para la que se debe recuperar la lista de cuentas a las que se puede acceder directamente. Esto solo tiene sentido para las organizaciones y los grupos de usuarios. Si está vacío, se mostrará ListAccounts para el usuario autenticado. accounts/{account_id}.
page_size

int32

Opcional. La cantidad de cuentas que se deben recuperar por página. El valor predeterminado y el máximo es 20.
page_token

string

Opcional. Si se especifica, se recupera la siguiente página de cuentas. Se muestra pageToken cuando una llamada a accounts.list muestra más resultados de los que pueden caber en el tamaño de la página solicitado.
filter

string

Opcional. Un filtro que restringe las cuentas que se muestran. La respuesta solo incluye entradas que coinciden con el filtro. Si filter está vacío, no se aplican restricciones y se recuperan todas las cuentas (paginadas) para la cuenta solicitada.

Por ejemplo, una solicitud con el filtro type=USER_GROUP solo mostrará grupos de usuarios.

El campo type es el único filtro compatible.

ListAccountsResponse

Mensaje de respuesta para Accounts.List Accounts.

Campos
accounts[]

Account

Es un conjunto de cuentas a las que el usuario tiene acceso. La cuenta personal del usuario que realiza la consulta siempre será el primer elemento del resultado, a menos que se filtre.
next_page_token

string

Si la cantidad de cuentas supera el tamaño de la página solicitada, este campo se propaga con un token para recuperar la página siguiente de cuentas en una llamada posterior a accounts.list. Si no hay más cuentas, este campo no aparece en la respuesta.

ListInvitationsRequest

Mensaje de solicitud para AccessControl.ListInvitations.

Campos
parent

string

Obligatorio. El nombre de la cuenta de la que se recupera la lista de invitaciones. accounts/{account_id}/invitations
filter

string

Opcional. Se admite el filtrado de la respuesta a través del campo Invitation.target_type.

ListInvitationsResponse

Mensaje de respuesta para AccessControl.ListInvitations.

Campos
invitations[]

Invitation

Un conjunto de invitaciones que están pendientes para la cuenta La cantidad de invitaciones indicadas aquí no puede ser mayor que 1,000.

ListLocationAdminsRequest

Mensaje de solicitud para AccessControl.ListLocationAdmins.

Campos
parent

string

Obligatorio. El nombre de la ubicación de la que se incluirán los administradores en la lista. locations/{location_id}/admins.

ListLocationAdminsResponse

Mensaje de respuesta para AccessControl.ListLocationAdmins.

Campos
admins[]

Admin

Un conjunto de administradores.

TransferLocationRequest

Mensaje de solicitud para AccessControl.TransferLocation.

Campos
name

string

Obligatorio. El nombre de la ubicación que se transferirá. locations/{location_id}.
destination_account

string

Obligatorio. Nombre del recurso de la cuenta al que se transferirá la ubicación (por ejemplo, "accounts/{account}")

UpdateAccountAdminRequest

Mensaje de solicitud para AccessControl.UpdateAccountAdmin.

Campos
account_admin

Admin

Obligatorio. La versión actualizada del Administrador.
update_mask

FieldMask

Obligatorio. Los campos específicos que deben actualizarse. El único campo que se puede editar es el de rol.

UpdateAccountRequest

Mensaje de solicitud para Accounts.UpdateAccount.

Campos
account

Account

Obligatorio. La cuenta actualizada.
update_mask

FieldMask

Obligatorio. Los campos específicos que deben actualizarse. El único campo que se puede editar es accountName.
validate_only

bool

Opcional. Si es verdadero, la solicitud se valida sin actualizar la cuenta.

UpdateLocationAdminRequest

Mensaje de solicitud para AccessControl.UpdateLocationAdmin.

Campos
location_admin

Admin

Obligatorio. La versión actualizada del Administrador.
update_mask

FieldMask

Obligatorio. Los campos específicos que deben actualizarse. El único campo que se puede editar es el de rol.