Method: accounts.invitations.list

Перечисляет ожидающие приглашения для указанной учетной записи.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
parent

string

Необходимый. Имя учетной записи, из которой извлекается список приглашений. accounts/{account_id}/invitations

Параметры запроса

Параметры
filter

string

Необязательный. Фильтрация ответа поддерживается через поле Invitation.target_type.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответное сообщение для AccessControl.ListInvitations.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
Поля
invitations[]

object ( Invitation )

Коллекция приглашений, ожидающих рассмотрения для учетной записи. Количество приглашений, перечисленных здесь, не может превышать 1000.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

Приглашение

Представляет ожидающее приглашение.

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.
}
Поля
name

string

Необходимый. Имя ресурса для приглашения. accounts/{account_id}/invitations/{invitation_id} .

role

enum ( AdminRole )

Только вывод. Приглашенная роль на аккаунте.

targetType

enum ( TargetType )

Только вывод. Указывает, какие целевые типы должны отображаться в ответе.

target Союза. Указывает цель, для которой предназначено это приглашение. target может быть только одно из следующих:
targetAccount

object ( Account )

Малонаселенный аккаунт, для которого предназначено это приглашение.

targetLocation

object ( TargetLocation )

Целевое местоположение, для которого предназначено это приглашение.

Целевое местоположение

Представляет целевое расположение для ожидающего приглашения.

JSON-представление 
{
  "locationName": string,
  "address": string
}
Поля
locationName

string

Название локации, в которую приглашен пользователь.

address

string

Адрес локации, в которую приглашен пользователь.

Тип цели

Тип цели, для которой предназначено приглашение.

Перечисления
TARGET_TYPE_UNSPECIFIED Устанавливается, когда тип цели не указан.
ACCOUNTS_ONLY Перечислите приглашения только для целей типа «Учетная запись».
LOCATIONS_ONLY Перечислите приглашения только для целей типа «Местоположение».