Method: accounts.invitations.list

Enumera las invitaciones pendientes para 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 admite el filtrado de 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)

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

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.

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 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:
targetAccount

object (Account)

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

object (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.

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

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.