Method: accounts.invitations.list

Lista os convites pendentes da 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 da qual a lista de convites está sendo recuperada. accounts/{account_id}/invitations

Parâmetros de consulta

Parâmetros
filter

string

Opcional. É possível filtrar a resposta por meio do 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 a Visão geral do OAuth 2.0.

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 de convidado na conta.
targetType

enum (TargetType)

Apenas saída. Especifica os tipos de segmentação que precisam aparecer na resposta.
Campo de união target. Indica o público-alvo deste convite. target pode ser apenas de um dos tipos a seguir:
targetAccount

object (Account)

A conta pouco preenchida a que este convite se destina.
targetLocation

object (TargetLocation)

O local de destino do convite.

TargetLocation

Representa um local de destino para um convite pendente.

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

string

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

string

O endereço do local para o qual o usuário foi convidado.

TargetType

É o tipo de público-alvo do convite.

Enums
TARGET_TYPE_UNSPECIFIED Definido quando o tipo de destino não é especificado.
ACCOUNTS_ONLY Liste convites somente para segmentações do tipo "Conta".
LOCATIONS_ONLY Lista convites apenas para segmentações do tipo "Local".