Package google.mybusiness.accountmanagement.v1

Индекс

Контроль доступа

Эта служба позволяет управлять пользователями, имеющими доступ к учетным записям и местоположениям.

Принять приглашение

rpc AcceptInvitation( AcceptInvitationRequest ) returns ( Empty )

Принимает указанное приглашение.

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

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

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

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

СоздатьАккаунтАдминистратор

rpc CreateAccountAdmin( CreateAccountAdminRequest ) returns ( Admin )

Приглашает указанного пользователя стать администратором указанной учетной записи. Приглашенный должен принять приглашение, чтобы получить доступ к учетной записи. См. [AcceptInvitation] [google.mybusiness.accountmanagement.v1.AcceptInvitation], чтобы программно принять приглашение.

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

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

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

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

СоздатьМестоположениеАдминистратор

rpc CreateLocationAdmin( CreateLocationAdminRequest ) returns ( Admin )

Приглашает указанного пользователя стать администратором указанного местоположения. Приглашенный должен принять приглашение, чтобы получить доступ к локации. См. [AcceptInvitation] [google.mybusiness.accountmangement.v1.AcceptInvitation], чтобы программно принять приглашение.

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

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

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

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

Отклонить приглашение

rpc DeclineInvitation( DeclineInvitationRequest ) returns ( Empty )

Отклоняет указанное приглашение.

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

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

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

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

УдалитьАккаунтАдминистратор

rpc DeleteAccountAdmin( DeleteAccountAdminRequest ) returns ( Empty )

Удаляет указанного администратора из указанной учетной записи.

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

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

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

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

УдалитьМестоположениеАдминистратор

rpc DeleteLocationAdmin( DeleteLocationAdminRequest ) returns ( Empty )

Удаляет указанного администратора в качестве менеджера указанного местоположения.

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

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

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

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

СписокАдминистраторовАккаунта

rpc ListAccountAdmins( ListAccountAdminsRequest ) returns ( ListAccountAdminsResponse )

Перечисляет администраторов указанной учетной записи.

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

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

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

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

Список приглашений

rpc ListInvitations( ListInvitationsRequest ) returns ( ListInvitationsResponse )

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

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

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

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

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

СписокМестоположениеАдминистраторы

rpc ListLocationAdmins( ListLocationAdminsRequest ) returns ( ListLocationAdminsResponse )

Список всех администраторов указанного местоположения.

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

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

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

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

ТрансферМестоположение

rpc TransferLocation( TransferLocationRequest ) returns ( Empty )

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

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

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

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

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

ОбновлениеАккаунтАдминистратор

rpc UpdateAccountAdmin( UpdateAccountAdminRequest ) returns ( Admin )

Обновляет администратора для указанного администратора учетной записи.

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

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

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

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

ОбновлениеМестоположенияАдминистратор

rpc UpdateLocationAdmin( UpdateLocationAdminRequest ) returns ( Admin )

Обновляет администратора для указанного местоположения. Обновить можно только роль AdminRole администратора.

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

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

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

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

Счета

Этот API позволяет управлять бизнес-аккаунтами в Google. Он определяет следующую модель ресурсов:

  • API имеет коллекцию ресурсов учетной записи с именем accounts/* .

  • Для удобства вы можете использовать синоним «я» вместо идентификатора учетной записи для личной учетной записи аутентифицированного абонента. Примеры: GET /v1/accounts/me GET /v1/accounts/me/locations

Зарегистрироваться

rpc CreateAccount( CreateAccountRequest ) returns ( Account )

Создает учетную запись с указанным именем и типом под данным родителем.

  • Личные аккаунты и Организации создавать нельзя.
  • Группы пользователей не могут быть созданы с использованием Личной учетной записи в качестве основного владельца.
  • Группы местоположений не могут быть созданы с основным владельцем Личной учетной записи, если Личная учетная запись находится в Организации.
  • Группы местоположений не могут владеть группами местоположений.
Области авторизации

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

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

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

Получить аккаунт

rpc GetAccount( GetAccountRequest ) returns ( Account )

Получает указанную учетную запись. Возвращает NOT_FOUND если учетная запись не существует или если вызывающая сторона не имеет к ней прав доступа.

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

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

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

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

Список аккаунтов

rpc ListAccounts( ListAccountsRequest ) returns ( ListAccountsResponse )

Перечисляет все учетные записи для аутентифицированного пользователя. Сюда входят все учетные записи, которыми владеет пользователь, а также любые учетные записи, для которых у пользователя есть права управления.

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

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

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

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

ОбновитьАккаунт

rpc UpdateAccount( UpdateAccountRequest ) returns ( Account )

Обновляет указанный бизнес-аккаунт. Личные аккаунты нельзя обновить этим способом.

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

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

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

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

Принять запрос приглашения

Сообщение запроса для AccessControl.AcceptInvitation.

Поля
name

string

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

Счет

Учетная запись — это контейнер для вашего местоположения. Если вы единственный пользователь, который управляет адресами вашей компании, вы можете использовать свой личный аккаунт Google. Чтобы поделиться управлением местоположениями с несколькими пользователями, создайте бизнес-аккаунт .

Поля
name

string

Неизменный. Имя ресурса в формате accounts/{account_id} .

account_name

string

Необходимый. Имя учетной записи. Для учетной записи типа PERSONAL это имя и фамилия учетной записи пользователя.

primary_owner

string

Необходимый. Только ввод. Имя ресурса учетной записи, которая будет основным владельцем создаваемой учетной записи. Он должен иметь форму accounts/{account_id} .

type

AccountType

Необходимый. Содержит тип учетной записи. С помощью этого API невозможно создать учетные записи типа ПЕРСОНАЛЬНЫЙ и ОРГАНИЗАЦИОННЫЙ.

role

AccountRole

Только вывод. Указывает AccountRole этой учетной записи.

verification_state

VerificationState

Только вывод. Если проверка подтверждена, будущие создаваемые местоположения автоматически подключаются к Картам Google и создаются страницы Google+ без необходимости модерации.

vetted_state

VettedState

Только вывод. Указывает, проверена ли учетная запись Google. Проверенная учетная запись может проверять местоположения с помощью метода VETTED_PARTNER.

account_number

string

Только вывод. Ссылочный номер учетной записи, если он предоставлен.

permission_level

PermissionLevel

Только вывод. Указывает уровень разрешений, который имеет пользователь для этой учетной записи.

organization_info

OrganizationInfo

Только вывод. Дополнительная информация об организации. Это поле заполняется только для учетной записи организации.

роль учетной записи

Указывает уровень доступа, который имеет аутентифицированный пользователь для этой учетной записи. Дополнительную информацию можно найти в статье Справочного центра .

Перечисления
ACCOUNT_ROLE_UNSPECIFIED Не указан.
PRIMARY_OWNER Пользователь является основным владельцем этой учетной записи.
OWNER Пользователь-владелец учетной записи.
MANAGER Пользователь может управлять этой учетной записью.
SITE_MANAGER Пользователь может управлять ограниченным набором функций учетной записи.

Тип аккаунта

Указывает, какой это тип учетной записи: личная/пользовательская или бизнес-учетная запись.

Перечисления
ACCOUNT_TYPE_UNSPECIFIED Не указан.
PERSONAL Учетная запись конечного пользователя.
LOCATION_GROUP Группа локаций. Дополнительную информацию можно найти в статье Справочного центра .
USER_GROUP Группа пользователей для разделения сотрудников организации на группы. Дополнительную информацию можно найти в статье Справочного центра .
ORGANIZATION Организация, представляющая компанию. Дополнительную информацию можно найти в статье Справочного центра .

Информация об организации

Дополнительная информация, хранящаяся для организации.

Поля
registered_domain

string

Только вывод. Зарегистрированный домен для учетной записи.

address

PostalAddress

Только вывод. Почтовый адрес аккаунта.

phone_number

string

Только вывод. Контактный номер организации.

Уровень разрешения

Указывает уровень доступа, который имеет аутентифицированный пользователь для этой учетной записи.

Перечисления
PERMISSION_LEVEL_UNSPECIFIED Не указан.
OWNER_LEVEL Пользователь имеет разрешение уровня владельца.
MEMBER_LEVEL Пользователь имеет разрешение уровня члена.

Состояние Верификации

Указывает состояние проверки учетной записи.

Перечисления
VERIFICATION_STATE_UNSPECIFIED Не указан.
VERIFIED Подтвержденный аккаунт.
UNVERIFIED Аккаунт не подтвержден, и верификация не запрошена.
VERIFICATION_REQUESTED Аккаунт не подтвержден, но запрошена проверка.

Проверено

Указывает проверенное состояние учетной записи.

Перечисления
VETTED_STATE_UNSPECIFIED Не указан
NOT_VETTED Аккаунт не проверяется Google.
VETTED Аккаунт проверен Google и находится в действительном состоянии. Учетная запись автоматически проверяется, если она имеет прямой доступ к проверенной учетной записи группы.
INVALID Аккаунт проверен, но находится в недействительном состоянии. Учетная запись будет вести себя как непроверенная учетная запись.

Админ

Администратор учетной записи или местоположения.

Поля
name

string

Неизменный. Имя ресурса. Для администраторов учетных записей это имеет форму: accounts/{account_id}/admins/{admin_id}

Для администраторов локаций это имеет вид: locations/{location_id}/admins/{admin_id}

Это поле будет игнорироваться, если оно задано при создании администратора.

admin

string

Необязательный. Имя администратора. При первоначальном приглашении это адрес электронной почты приглашенного. При вызовах GET возвращается адрес электронной почты пользователя, если приглашение все еще находится на рассмотрении. В противном случае он содержит имя и фамилию пользователя.

Это поле необходимо задать только во время создания администратора.

account

string

Неизменный. Имя ресурса учетной записи, на который ссылается этот администратор. Используется при вызове location.admins.create, чтобы пригласить LocationGroup в качестве администратора.

Если и это поле, и admin установлены для запросов CREATE , это поле имеет приоритет, и адрес электронной почты в admin будет игнорироваться.

Формат: accounts/{account} .

role

AdminRole

Необходимый. Указывает роль, которую этот администратор использует с указанной учетной записью или местоположением.

pending_invitation

bool

Только вывод. Указывает, есть ли у этого администратора ожидающее приглашение для указанного ресурса.

роль администратора

Указывает уровень доступа, который имеет администратор. Дополнительную информацию можно найти в статье Справочного центра .

Перечисления
ADMIN_ROLE_UNSPECIFIED Не указан.
PRIMARY_OWNER Администратор имеет доступ на уровне владельца и является основным владельцем. (Отображается в пользовательском интерфейсе как «Основной владелец»).
OWNER Администратор имеет доступ на уровне владельца. (Отображается как «Владелец» в пользовательском интерфейсе).
MANAGER Администратор имеет управленческий доступ.
SITE_MANAGER Администратор может управлять страницами социальных сетей (Google+). (Отображается в пользовательском интерфейсе как «Менеджер сайта»). Этот API не позволяет создать администратора учетной записи с ролью SITE_MANAGER.

CreateAccountAdminRequest

Сообщение запроса для AccessControl.CreateAccountAdmin.

Поля
parent

string

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

admin

Admin

Необходимый. Администратор создал. Роль не может быть SITE_MANAGER.

Запрос создания учетной записи

Сообщение запроса для Accounts.CreateAccount.

Поля
account

Account

Необходимый. Информация об учетной записи, которую необходимо создать. Единственными разрешенными полями являются учетная запись и тип.

CreateLocationAdminRequest

Сообщение запроса для AccessControl.CreateLocationAdmin.

Поля
parent

string

Необходимый. Имя ресурса местоположения, для которого создан этот администратор. locations/{location_id}/admins .

admin

Admin

Необходимый. Администратор для создания.

Отклонить запрос приглашения

Сообщение запроса для AccessControl.DeclineInvitation.

Поля
name

string

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

Удалитьаккаунтадминреквест

Сообщение запроса для AccessControl.DeleteAccountAdmin.

Поля
name

string

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

УдалитьLocationAdminRequest

Сообщение запроса для AccessControl.DeleteLocationAdmin.

Поля
name

string

Необходимый. Имя ресурса администратора, которого нужно удалить из местоположения.

GetAccountRequest

Сообщение запроса для Accounts.GetAccount.

Поля
name

string

Необходимый. Имя учетной записи для получения.

Приглашение

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

Поля
name

string

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

role

AdminRole

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

target_type

TargetType

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

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

Account

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

target_location

TargetLocation

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

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

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

Поля
location_name

string

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

address

string

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

Тип цели

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

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

Запрос ListAccountAdmins

Сообщение запроса для AccessControl.ListAccountAdmins.

Поля
parent

string

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

ListAccountAdminsResponse

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

Поля
account_admins[]

Admin

Коллекция экземпляров администратора.

Запрос списка аккаунтов

Сообщение запроса для Accounts.ListAccounts.

Поля
parent_account

string

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

page_size

int32

Необязательный. Сколько аккаунтов нужно получить на страницу. По умолчанию и максимум — 20.

page_token

string

Необязательный. Если указано, извлекается следующая страница учетных записей. pageToken возвращается, когда вызов accounts.list возвращает больше результатов, чем может поместиться в запрошенный размер страницы.

filter

string

Необязательный. Фильтр, ограничивающий возврат учетных записей. Ответ включает только записи, соответствующие фильтру. Если filter пуст, ограничения не применяются, и для запрошенной учетной записи извлекаются все учетные записи (с разбивкой на страницы).

Например, запрос с type=USER_GROUP вернет только группы пользователей.

Поле type — единственный поддерживаемый фильтр.

ListAccountsResponse

Ответное сообщение для Accounts.ListAccounts.

Поля
accounts[]

Account

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

next_page_token

string

Если количество учетных записей превышает запрошенный размер страницы, это поле заполняется токеном для получения следующей страницы учетных записей при последующем вызове accounts.list . Если учетных записей больше нет, это поле отсутствует в ответе.

Список приглашенийЗапрос

Сообщение запроса для AccessControl.ListInvitations.

Поля
parent

string

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

filter

string

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

Список приглашенийОтвет

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

Поля
invitations[]

Invitation

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

СписокМестоположениеАдминистраторыЗапрос

Сообщение запроса для AccessControl.ListLocationAdmins.

Поля
parent

string

Необходимый. Название места, администраторов которого нужно вывести в список. locations/{location_id}/admins .

ListLocationAdminsResponse

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

Поля
admins[]

Admin

Коллекция администраторов.

ТрансферМестоположениеЗапрос

Сообщение запроса для AccessControl.TransferLocation.

Поля
name

string

Необходимый. Имя места для переноса. locations/{location_id} .

destination_account

string

Необходимый. Имя ресурса учетной записи, в который необходимо передать местоположение (например, «accounts/{account}»).

ОбновлениеАккаунтАдминистратораЗапрос

Сообщение запроса для AccessControl.UpdateAccountAdmin.

Поля
account_admin

Admin

Необходимый. Обновленная версия Админа.

update_mask

FieldMask

Необходимый. Конкретные поля, которые следует обновить. Единственное редактируемое поле — роль.

Запрос обновления аккаунта

Сообщение запроса для Accounts.UpdateAccount.

Поля
account

Account

Необходимый. Обновленный Аккаунт.

update_mask

FieldMask

Необходимый. Конкретные поля, которые следует обновить. Единственное редактируемое поле — accountName .

validate_only

bool

Необязательный. Если это правда, запрос проверяется без фактического обновления учетной записи.

ОбновлениеLocationAdminRequest

Сообщение запроса для AccessControl.UpdateLocationAdmin.

Поля
location_admin

Admin

Необходимый. Обновленная версия Админа.

update_mask

FieldMask

Необходимый. Конкретные поля, которые следует обновить. Единственное редактируемое поле — роль.