REST Resource: accounts

Ресурс: Аккаунт

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

JSON-представление
{
  "name": string,
  "accountName": string,
  "primaryOwner": string,
  "type": enum (AccountType),
  "role": enum (AccountRole),
  "verificationState": enum (VerificationState),
  "vettedState": enum (VettedState),
  "accountNumber": string,
  "permissionLevel": enum (PermissionLevel),
  "organizationInfo": {
    object (OrganizationInfo)
  }
}
Поля
name

string

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

accountName

string

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

primaryOwner

string

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

type

enum ( AccountType )

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

role

enum ( AccountRole )

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

verificationState

enum ( VerificationState )

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

vettedState

enum ( VettedState )

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

accountNumber

string

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

permissionLevel

enum ( PermissionLevel )

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

organizationInfo

object ( OrganizationInfo )

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

Тип аккаунта

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

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

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

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

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

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

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

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

Проверено

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

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

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

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

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

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

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

JSON-представление
{
  "registeredDomain": string,
  "address": {
    object (PostalAddress)
  },
  "phoneNumber": string
}
Поля
registeredDomain

string

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

address

object ( PostalAddress )

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

phoneNumber

string

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

Почтовый адрес

Представляет почтовый адрес, например, для адресов почтовой доставки или платежей. Учитывая почтовый адрес, почтовая служба может доставлять товары в помещение, почтовый ящик или подобное место. Он не предназначен для моделирования географических мест (дорог, городов, гор).

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

Советы по вводу/редактированию адреса: – Используйте готовый к интернационализации виджет адреса, например https://github.com/google/libaddressinput . – Пользователям не должны предоставляться элементы пользовательского интерфейса для ввода или редактирования полей за пределами стран, где это поле есть. использовал.

Дополнительные инструкции по использованию этой схемы см. на странице https://support.google.com/business/answer/6397478 .

JSON-представление
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Поля
revision

integer

Версия схемы PostalAddress . Это значение должно быть установлено на 0, что соответствует последней версии.

Все новые версии должны быть обратно совместимы со старыми версиями.

regionCode

string

Необходимый. CLDR-код региона страны/региона адреса. Это никогда не предполагается, и пользователь должен убедиться в правильности значения. Подробности см. на https://cldr.unicode.org/ и https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html . Пример: «CH» для Швейцарии.

languageCode

string

Необязательный. Код языка BCP-47 содержимого этого адреса (если известен). Часто это язык пользовательского интерфейса формы ввода или ожидается, что он будет соответствовать одному из языков, используемых в стране/регионе адреса, или их транслитерированным эквивалентам. Это может повлиять на форматирование в некоторых странах, но не имеет решающего значения для правильности данных и никогда не повлияет на проверку или другие операции, не связанные с форматированием.

Если это значение неизвестно, его следует опустить (вместо указания возможно неправильного значения по умолчанию).

Примеры: «ж-Хант», «джа», «джа-Латн», «ен».

postalCode

string

Необязательный. Почтовый индекс адреса. Не все страны используют или требуют наличия почтовых индексов, но там, где они используются, они могут вызвать дополнительную проверку других частей адреса (например, проверка штата/почтового индекса в США).

sortingCode

string

Необязательный. Дополнительный код сортировки для конкретной страны. В большинстве регионов это не используется. Там, где оно используется, значение представляет собой либо строку типа «CEDEX», за которой необязательно следует число (например, «CEDEX 7»), либо просто число, представляющее «код сектора» (Ямайка), «указатель зоны доставки». (Малави) или «индикатор почтового отделения» (например, Кот-д'Ивуар).

administrativeArea

string

Необязательный. Высшее административное подразделение, используемое для почтовых адресов страны или региона. Например, это может быть штат, провинция, область или префектура. В частности, для Испании это провинция, а не автономное сообщество (например, «Барселона», а не «Каталония»). Многие страны не используют административную зону в почтовых адресах. Например, в Швейцарии это место следует оставить незаселенным.

locality

string

Необязательный. Обычно относится к части адреса, посвященной городу. Примеры: город в США, ИТ-коммуна, почтовый город Великобритании. В регионах мира, где населенные пункты не определены четко или не вписываются в эту структуру, оставьте locality пустым и используйте адресные строки.

sublocality

string

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

addressLines[]

string

Неструктурированные адресные строки, описывающие нижние уровни адреса.

Поскольку значения в адресных строках не содержат информации о типе и иногда могут содержать несколько значений в одном поле (например, «Остин, Техас»), важно, чтобы порядок строк был ясен. Порядок адресных строк должен быть «порядком конверта» для страны/региона адреса. В местах, где это может отличаться (например, в Японии), адрес_языка используется для явного указания (например, «ja» для упорядочения от большого к меньшему и «ja-Latn» или «en» для упорядочения от малого к большому). Таким образом, в зависимости от языка можно выбрать наиболее конкретную строку адреса.

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

Создание адреса, содержащего только регионКод и адресные строки, а затем геокодирование — рекомендуемый способ обработки полностью неструктурированных адресов (в отличие от угадывания, какие части адреса должны быть населенными пунктами или административными областями).

recipients[]

string

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

organization

string

Необязательный. Название организации по адресу.

Методы

create

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

get

 Получает указанную учетную запись.

list

 Перечисляет все учетные записи для аутентифицированного пользователя.

patch

 Обновляет указанный бизнес-аккаунт.