Method: accounts.invitations.list

Lista os convites pendentes para a conta especificada.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

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

Parâmetros de consulta

Parâmetros
filter

string

Opcional. A filtragem da resposta é compatível com o campo "Invitation.target_type".

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para AccessControl.ListInvitations.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
Campos
invitations[]

object (Invitation)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.

Convite

Representa um convite pendente.

Representação 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

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

enum (AdminRole)

Apenas saída. A função convidada na conta.
targetType

enum (TargetType)

Apenas saída. Especifica quais tipos de destino devem aparecer na resposta.
Campo de união target. Indica o destino do convite. target pode ser apenas de um dos tipos a seguir:
targetAccount

object (Account)

A conta com poucos dados para a qual este convite foi enviado.
targetLocation

object (TargetLocation)

O local de destino deste convite.

TargetLocation

Representa um local de destino para um convite pendente.

Representação JSON 
{
  "locationName": string,
  "address": string,
  "placeId": string
}
Campos
locationName

string

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

string

O endereço do local para onde o usuário é convidado. Nem sempre preenchido.
placeId

string

Apenas saída. O ID de lugar do local para onde o usuário foi convidado. Nem sempre preenchido.

Tipo de segmentação

O tipo de destino de um convite.

Tipos enumerados
TARGET_TYPE_UNSPECIFIED Definido quando o tipo de destino não é especificado.
ACCOUNTS_ONLY Listar convites apenas para destinos do tipo "Conta".
LOCATIONS_ONLY Lista apenas convites para segmentações do tipo "Local".