Method: accounts.invitations.list

Elenca gli inviti in attesa per l'account specificato.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome dell'account da cui viene recuperato l'elenco degli inviti. accounts/{account_id}/invitations

Parametri di query

Parametri
filter

string

Facoltativo. Il filtro della risposta è supportato tramite il campo Invitation.target_type.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per AccessControl.ListInvitations.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
Campi
invitations[]

object (Invitation)

Una raccolta di inviti in attesa per l'account. Il numero di inviti elencati qui non può superare 1000.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la OAuth 2.0 Overview.

Invito

Rappresenta un invito in attesa.

Rappresentazione 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.
}
Campi
name

string

Obbligatorio. Il nome della risorsa per l'invito. accounts/{account_id}/invitations/{invitation_id}.
role

enum (AdminRole)

Solo output. Il ruolo invitato nell'account.
targetType

enum (TargetType)

Solo output. Specifica i tipi di target che devono essere visualizzati nella risposta.
Campo unione target. Indica il target a cui è destinato questo invito. target può essere solo uno dei seguenti tipi:
targetAccount

object (Account)

L'account con pochi dati per cui è stato inviato l'invito.
targetLocation

object (TargetLocation)

La posizione di destinazione a cui si riferisce questo invito.

TargetLocation

Rappresenta una posizione di destinazione per un invito in attesa.

Rappresentazione JSON 
{
  "locationName": string,
  "address": string,
  "placeId": string
}
Campi
locationName

string

Il nome della posizione a cui viene invitato l'utente.
address

string

L'indirizzo della posizione a cui l'utente è invitato. Non sempre compilato.
placeId

string

Solo output. L'ID luogo della sede a cui viene invitato l'utente. Non sempre compilato.

TargetType

Il tipo di target a cui è destinato l'invito.

Enum
TARGET_TYPE_UNSPECIFIED Impostato quando il tipo di target non è specificato.
ACCOUNTS_ONLY Elenca gli inviti solo per i target di tipo Account.
LOCATIONS_ONLY Elenca gli inviti solo per i target di tipo Località.