- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Convite
- TargetLocation
- TargetType
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 |
Obrigatório. O nome da conta da qual a lista de convites está sendo recuperada. |
Parâmetros de consulta
Parâmetros | |
---|---|
filter |
Opcional. A filtragem da resposta é suportada pelo 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 ( |
Campos | |
---|---|
invitations[] |
Um conjunto de convites pendentes na 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 ( |
Campos | |
---|---|
name |
Obrigatório. O nome do recurso do convite. |
role |
Apenas saída. A função convidada na conta. |
targetType |
Apenas saída. Especifica quais tipos de destino devem aparecer na resposta. |
Campo de união target . Indica o alvo do convite. target pode ser apenas de um dos tipos a seguir: |
|
targetAccount |
A conta com pouco preenchimento. |
targetLocation |
O local de segmentação para o qual este convite se destina. |
TargetLocation
Representa uma região de segmentação para um convite pendente.
Representação JSON |
---|
{ "locationName": string, "address": string } |
Campos | |
---|---|
locationName |
O nome do local para o qual o usuário é convidado. |
address |
O endereço do local para o qual o usuário foi convidado. |
Tipo de segmentação
O tipo de destino ao qual um convite se destina.
Enums | |
---|---|
TARGET_TYPE_UNSPECIFIED |
Definido quando o tipo de destino não é especificado. |
ACCOUNTS_ONLY |
Listar convites apenas para segmentações do tipo "Account". |
LOCATIONS_ONLY |
Listar convites apenas para segmentações do tipo "Local". |