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 Overview .

Приглашение

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

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,
  "placeId": string
}
Поля
locationName

string

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

address

string

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

placeId

string

Только для вывода. Идентификатор места, куда приглашен пользователь. Заполняется не всегда.

Целевой тип

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

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