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

Parámetros
parent

string

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

Parámetros de consulta

Parámetros
filter

string

Opcional. El filtrado de la respuesta se admite 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

Es el 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 una colección de invitaciones pendientes para la cuenta. La cantidad de invitaciones que se muestran aquí no puede superar las 1,000.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.

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. Es el nombre del recurso de la invitación. accounts/{account_id}/invitations/{invitation_id}.
role

enum (AdminRole)

Solo salida. Es 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 objetivo para el que se envía esta invitación. target puede ser solo uno de los parámetros siguientes:
targetAccount

object (Account)

Es la cuenta con pocos datos para la que se envió la invitación.
targetLocation

object (TargetLocation)

Es la ubicación objetivo para la que se envía la invitación.

TargetLocation

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

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

string

Es 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. No siempre se propaga.
placeId

string

Solo salida. Es el ID de lugar de la ubicación a la que se invita al usuario. No siempre se propaga.

TipoObjetivo

Es el tipo de objetivo para el que se envía una invitación.

Enums
TARGET_TYPE_UNSPECIFIED Se establece cuando no se especifica el tipo de destino.
ACCOUNTS_ONLY Enumera las invitaciones solo para los objetivos del tipo Cuenta.
LOCATIONS_ONLY Enumera las invitaciones solo para los objetivos del tipo Location.