Method: accounts.invitations.list

Lista os convites pendentes para a conta especificada.

Solicitação HTTP

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/invitations

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

Parâmetros de caminho

Parâmetros
parent

string

O nome da conta da qual a lista de convites está sendo recuperada.

Parâmetros de consulta

Parâmetros
targetType

enum (TargetType)

Especifica quais tipos de destino devem aparecer na resposta.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

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

Mensagem de resposta para AccessControl.ListInvitations.

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

object (Invitation)

Um conjunto de convites de locais pendentes na conta. O número de convites listados aqui não pode exceder 1.000.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

Tipo de segmentação

O tipo de destino ao qual um convite se destina.

Enums
ALL Liste convites para todos os tipos de segmentação. Esse é o padrão.
ACCOUNTS_ONLY Listar convites apenas para segmentações do tipo "Account".
LOCATIONS_ONLY Listar convites apenas para segmentações do tipo "Local".