Method: accounts.invitations.list

Se muestran las invitaciones pendientes de la cuenta especificada.

Solicitud HTTP

GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

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

Parámetros de consulta

Parámetros
filter

string

Opcional. Se puede filtrar la respuesta a través del campo Invitation.target_type.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para AccessControl.ListInvitations.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
Campos
invitations[]

object (Invitation)

Es un conjunto de invitaciones pendientes de la cuenta. La cantidad de invitaciones que se incluyen aquí no puede ser superior a 1,000.

Alcances 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.

Invitación

Representa una invitación pendiente.

Representación JSON 
{
  "name": string,
  "role": enum (AdminRole),
  "targetType": enum (TargetType),

  // Union field target can be only one of the following:
  "targetAccount": {
    object (Account)
  },
  "targetLocation": {
    object (TargetLocation)
  }
  // End of list of possible types for union field target.
}
Campos
name

string

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

enum (AdminRole)

Solo salida. El rol invitado en la cuenta.
targetType

enum (TargetType)

Solo salida. Especifica qué tipos de objetivos 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:
targetAccount

object (Account)

La cuenta propagada de manera dispersa a la que corresponde esta invitación.
targetLocation

object (TargetLocation)

La ubicación de destino a la que se dirige esta invitación.

TargetLocation

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

Representación JSON 
{
  "locationName": string,
  "address": string
}
Campos
locationName

string

El nombre de la ubicación a la que se invita al usuario.
address

string

Es la dirección de la ubicación a la que se invita al usuario.

TipoObjetivo

El tipo de destino al que se orienta una invitación.

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