Package google.mybusiness.v4

Индекс

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

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

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

rpc AcceptInvitation( AcceptInvitationRequest ) returns ( Empty )

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

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc CreateAccountAdmin( CreateAccountAdminRequest ) returns ( Admin )

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

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc CreateLocationAdmin( CreateLocationAdminRequest ) returns ( Admin )

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

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc DeclineInvitation( DeclineInvitationRequest ) returns ( Empty )

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

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc DeleteAccountAdmin( DeleteAccountAdminRequest ) returns ( Empty )

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

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc DeleteLocationAdmin( DeleteLocationAdminRequest ) returns ( Empty )

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

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc ListAccountAdmins( ListAccountAdminsRequest ) returns ( ListAccountAdminsResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc ListInvitations( ListInvitationsRequest ) returns ( ListInvitationsResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc ListLocationAdmins( ListLocationAdminsRequest ) returns ( ListLocationAdminsResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc UpdateAccountAdmin( UpdateAccountAdminRequest ) returns ( Admin )

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

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc UpdateLocationAdmin( UpdateLocationAdminRequest ) returns ( Admin )

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

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

Требуется одна из следующих областей OAuth:

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

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

Счета

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

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

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

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

rpc CreateAccount( CreateAccountRequest ) returns ( Account )

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

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

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

Требуется одна из следующих областей OAuth:

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

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

Удалить уведомления

rpc DeleteNotifications( DeleteNotificationsRequest ) returns ( Empty )

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

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

Требуется одна из следующих областей OAuth:

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

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

Создать номер аккаунта

rpc GenerateAccountNumber( GenerateAccountNumberRequest ) returns ( Account )

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

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc GetAccount( GetAccountRequest ) returns ( Account )

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

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

Требуется одна из следующих областей OAuth:

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

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

Получать уведомления

rpc GetNotifications( GetNotificationsRequest ) returns ( Notifications )

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

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc ListAccounts( ListAccountsRequest ) returns ( ListAccountsResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc UpdateAccount( UpdateAccountRequest ) returns ( Account )

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

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

Требуется одна из следующих областей OAuth:

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

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

Уведомления об обновлении

rpc UpdateNotifications( UpdateNotificationsRequest ) returns ( Notifications )

Устанавливает настройки уведомлений pubsub для учетной записи, сообщая бизнес-профилю, по какой теме отправлять уведомления pubsub:

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

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

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

Требуется одна из следующих областей OAuth:

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

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

БизнесКатегории

Этот API обеспечивает видимость поддерживаемых категорий для местоположений компаний в Google. Вы можете получить постраничные списки всех доступных бизнес-категорий или выполнить поиск по определенному термину. Справочную информацию см. в разделе «Категории» этой статьи: https://support.google.com/business/answer/3038177.

BatchGetBusinessCategories

rpc BatchGetBusinessCategories( BatchGetBusinessCategoriesRequest ) returns ( BatchGetBusinessCategoriesResponse )

Возвращает список бизнес-категорий для указанного языка и идентификаторов GConcept.

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

Требуется одна из следующих областей OAuth:

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

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

СписокБизнесКатегории

rpc ListBusinessCategories( ListBusinessCategoriesRequest ) returns ( ListBusinessCategoriesResponse )

Возвращает список категорий бизнеса. Поиск будет соответствовать названию категории, но не ее идентификатору.

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

Требуется одна из следующих областей OAuth:

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

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

БизнесОбмен сообщениямиСервис

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

Последователи

Этот API предоставляет API управления подписчиками.

GetFollowersMetadata

rpc GetFollowersMetadata( GetFollowersMetadataRequest ) returns ( FollowersMetadata )

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

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

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

Требуется одна из следующих областей OAuth:

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

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

ЕдаМенюСервис

Этот API позволяет получать и обновлять меню блюд в торговых точках.

Обратите внимание, что Location.PriceList также представляет «меню» одного из своих типов, но с ограниченными полями. Он использует то же хранилище, что и FoodMenus. После завершения миграции на FoodMenuService клиентам настоятельно не рекомендуется больше использовать Location.PriceList для обновления данных меню, что может привести к неожиданной потере данных.

GetFoodМеню

rpc GetFoodMenus( GetFoodMenusRequest ) returns ( FoodMenus )

Возвращает меню блюд определенного места. Вызывайте это только в том случае, если location.location_state.can_have_food_menu имеет значение true.

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

Требуется одна из следующих областей OAuth:

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

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

ОбновлениеЕдаМеню

rpc UpdateFoodMenus( UpdateFoodMenusRequest ) returns ( FoodMenus )

Обновляет меню еды в определенном месте. Вызывайте это только в том случае, если location.location_state.can_have_food_menu имеет значение true.

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

Требуется одна из следующих областей OAuth:

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

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

GoogleМестаположения

Этот API обеспечивает доступ и поиск GoogleLocation .

СписокрекомендуемыхGoogleМестоположения

rpc ListRecommendedGoogleLocations( ListRecommendedGoogleLocationsRequest ) returns ( ListRecommendedGoogleLocationsResponse )

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

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

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

Требуется одна из следующих областей OAuth:

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

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

Сообщить о местоположении Google

rpc ReportGoogleLocation( ReportGoogleLocationRequest ) returns ( Empty )

Сообщить о GoogleLocation .

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

Требуется одна из следующих областей OAuth:

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

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

ПоискGoogleМестоположения

rpc SearchGoogleLocations( SearchGoogleLocationsRequest ) returns ( SearchGoogleLocationsResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

HealthProviderAttributesService

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

GetHealthProviderAttributes

rpc GetHealthProviderAttributes( GetHealthProviderAttributesRequest ) returns ( HealthProviderAttributes )

Возвращает атрибуты поставщика медицинских услуг для определенного местоположения.

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

Требуется одна из следующих областей OAuth:

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

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

ОбновлениеHealthProviderAttributes

rpc UpdateHealthProviderAttributes( UpdateHealthProviderAttributesRequest ) returns ( HealthProviderAttributes )

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

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

Требуется одна из следующих областей OAuth:

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

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

Информация

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

ОтчетLocalPostInsights

rpc ReportLocalPostInsights( ReportLocalPostInsightsRequest ) returns ( ReportLocalPostInsightsResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

ОтчетLocationInsights

rpc ReportLocationInsights( ReportLocationInsightsRequest ) returns ( ReportLocationInsightsResponse )

Возвращает отчет, содержащий информацию об одном или нескольких показателях по местоположению.

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

Требуется одна из следующих областей OAuth:

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

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

СтрахованиеСетьСервис

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

СписокСтраховых Сетей

rpc ListInsuranceNetworks( ListInsuranceNetworksRequest ) returns ( ListInsuranceNetworksResponse )

Возвращает список всех страховых сетей, поддерживаемых Google.

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

Требуется одна из следующих областей OAuth:

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

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

Локальные сообщения

Этот API предоставляет API управления локальными сообщениями.

СоздатьLocalPost

rpc CreateLocalPost( CreateLocalPostRequest ) returns ( LocalPost )

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

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

Требуется одна из следующих областей OAuth:

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

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

Удалитьлокальный пост

rpc DeleteLocalPost( DeleteLocalPostRequest ) returns ( Empty )

Удаляет локальную публикацию. Возвращает NOT_FOUND если локальное сообщение не существует.

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

Требуется одна из следующих областей OAuth:

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

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

GetLocalPost

rpc GetLocalPost( GetLocalPostRequest ) returns ( LocalPost )

Получает указанное локальное сообщение. Возвращает NOT_FOUND если локальное сообщение не существует.

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

Требуется одна из следующих областей OAuth:

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

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

Список локальных сообщений

rpc ListLocalPosts( ListLocalPostsRequest ) returns ( ListLocalPostsResponse )

Возвращает список локальных сообщений, связанных с местоположением.

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

Требуется одна из следующих областей OAuth:

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

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

ОбновлениеLocalPost

rpc UpdateLocalPost( UpdateLocalPostRequest ) returns ( LocalPost )

Обновляет указанное локальное сообщение и возвращает обновленное локальное сообщение.

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

Требуется одна из следующих областей OAuth:

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

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

Локации

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

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

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

  • Каждая Account имеет коллекцию ресурсов Location с именем accounts/*/locations/*

Местонахождение партнера

rpc AssociateLocation( AssociateLocationRequest ) returns ( Empty )

Связывает местоположение с идентификатором места. Любая предыдущая ассоциация перезаписывается. Эта операция действительна только в том случае, если местоположение не проверено. Ассоциация должна быть допустимой, то есть она отображается в списке FindMatchingLocations .

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

Требуется одна из следующих областей OAuth:

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

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

Пакетное получение местоположений

rpc BatchGetLocations( BatchGetLocationsRequest ) returns ( BatchGetLocationsResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

ClearLocationAssociation

rpc ClearLocationAssociation( ClearLocationAssociationRequest ) returns ( Empty )

Очищает связь между местоположением и его идентификатором места. Эта операция действительна только в том случае, если местоположение не проверено.

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc CreateLocation( CreateLocationRequest ) returns ( Location )

Создает новое location , принадлежащее указанной учетной записи, и возвращает его.

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc DeleteLocation( DeleteLocationRequest ) returns ( Empty )

Удаляет местоположение.

Найти соответствующие местоположения

rpc FindMatchingLocations( FindMatchingLocationsRequest ) returns ( FindMatchingLocationsResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

GetChain

rpc GetChain( GetChainRequest ) returns ( Chain )

Получает указанную цепочку. Возвращает NOT_FOUND если цепочка не существует.

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

Требуется одна из следующих областей OAuth:

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

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

GetGoogleUpdatedLocation

rpc GetGoogleUpdatedLocation( GetLocationRequest ) returns ( GoogleUpdatedLocation )

Получает обновленную Google версию указанного местоположения. Возвращает NOT_FOUND если местоположение не существует.

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

Требуется одна из следующих областей OAuth:

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

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

Получить местоположение

rpc GetLocation( GetLocationRequest ) returns ( Location )

Получает указанное расположение. Возвращает NOT_FOUND если местоположение не существует.

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

Требуется одна из следующих областей OAuth:

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

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

ЛистАтрибутМетаданные

rpc ListAttributeMetadata( ListAttributeMetadataRequest ) returns ( ListAttributeMetadataResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

СписокМестоположений

rpc ListLocations( ListLocationsRequest ) returns ( ListLocationsResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

Поисковые цепочки

rpc SearchChains( SearchChainsRequest ) returns ( SearchChainsResponse )

Ищет цепочку по названию цепочки.

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

Требуется одна из следующих областей OAuth:

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

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

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

rpc TransferLocation( TransferLocationRequest ) returns ( Location )

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

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

Требуется одна из следующих областей OAuth:

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

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

ОбновитьМестоположение

rpc UpdateLocation( UpdateLocationRequest ) returns ( Location )

Обновляет указанное расположение.

Фотографии разрешены только в местах, где есть страница Google+.

Возвращает NOT_FOUND если местоположение не существует.

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

Требуется одна из следующих областей OAuth:

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

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

СМИ

Эта услуга позволяет управлять медиафайлами (фото и видео), связанными с местоположением.

CreateMediaItem

rpc CreateMediaItem( CreateMediaItemRequest ) returns ( MediaItem )

Создает новый элемент мультимедиа для местоположения.

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

Требуется одна из следующих областей OAuth:

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

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

Удалитьмедиаитем

rpc DeleteMediaItem( DeleteMediaItemRequest ) returns ( Empty )

Удаляет указанный элемент мультимедиа.

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

Требуется одна из следующих областей OAuth:

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

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

GetCustomerMediaItem

rpc GetCustomerMediaItem( GetCustomerMediaItemRequest ) returns ( MediaItem )

Возвращает метаданные для запрошенного клиентского медиа-элемента.

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

Требуется одна из следующих областей OAuth:

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

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

GetMediaItem

rpc GetMediaItem( GetMediaItemRequest ) returns ( MediaItem )

Возвращает метаданные для запрошенного медиа-элемента.

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

Требуется одна из следующих областей OAuth:

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

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

ListCustomerMediaItems

rpc ListCustomerMediaItems( ListCustomerMediaItemsRequest ) returns ( ListCustomerMediaItemsResponse )

Возвращает список элементов мультимедиа, связанных с местоположением и предоставленных клиентами.

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

Требуется одна из следующих областей OAuth:

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

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

ListMediaItems

rpc ListMediaItems( ListMediaItemsRequest ) returns ( ListMediaItemsResponse )

Возвращает список медиа-элементов, связанных с местоположением.

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

Требуется одна из следующих областей OAuth:

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

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

StartUploadMediaItemData

rpc StartUploadMediaItemData( StartUploadMediaItemDataRequest ) returns ( MediaItemDataRef )

Создает MediaItemDataRef для загрузки элемента мультимедиа.

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

Требуется одна из следующих областей OAuth:

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

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

UpdateMediaItem

rpc UpdateMediaItem( UpdateMediaItemRequest ) returns ( MediaItem )

Обновляет метаданные указанного элемента мультимедиа. Это можно использовать только для обновления категории элемента мультимедиа, за исключением того, что новая категория не может быть ОБЛОЖКА или ПРОФИЛЬ.

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

Требуется одна из следующих областей OAuth:

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

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

Вопросы и ответы

Эта услуга позволяет управлять вопросами и ответами о местоположении. Операции вопросов и ответов действительны только для проверенных местоположений.

Создать вопрос

rpc CreateQuestion( CreateQuestionRequest ) returns ( Question )

Добавляет вопрос для указанного места.

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

Требуется одна из следующих областей OAuth:

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

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

Удалитьответ

rpc DeleteAnswer( DeleteAnswerRequest ) returns ( Empty )

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

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

Требуется одна из следующих областей OAuth:

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

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

Удалитьвопрос

rpc DeleteQuestion( DeleteQuestionRequest ) returns ( Empty )

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

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

Требуется одна из следующих областей OAuth:

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

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

Список ответов

rpc ListAnswers( ListAnswersRequest ) returns ( ListAnswersResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

Список вопросов

rpc ListQuestions( ListQuestionsRequest ) returns ( ListQuestionsResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

ОбновлениеВопрос

rpc UpdateQuestion( UpdateQuestionRequest ) returns ( Question )

Обновляет конкретный вопрос, написанный текущим пользователем.

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

Требуется одна из следующих областей OAuth:

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

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

Упсертответ

rpc UpsertAnswer( UpsertAnswerRequest ) returns ( Answer )

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

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

Требуется одна из следующих областей OAuth:

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

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

Отзывы

Этот API предоставляет операции CRUD для обзоров. google.mybusiness.v4.Reviews .

Пакетное получение отзывов

rpc BatchGetReviews( BatchGetReviewsRequest ) returns ( BatchGetReviewsResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

УдалитьОтзывОтветить

rpc DeleteReviewReply( DeleteReviewReplyRequest ) returns ( Empty )

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

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

Требуется одна из следующих областей OAuth:

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

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

Получить обзор

rpc GetReview( GetReviewRequest ) returns ( Review )

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

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

Требуется одна из следующих областей OAuth:

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

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

СписокОтзывов

rpc ListReviews( ListReviewsRequest ) returns ( ListReviewsResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

ОбновлениеОтзывОтветить

rpc UpdateReviewReply( UpdateReviewReplyRequest ) returns ( ReviewReply )

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

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

Требуется одна из следующих областей OAuth:

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

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

Списки услуг

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

Получить список служб

rpc GetServiceList( GetServiceListRequest ) returns ( ServiceList )

Получить указанный список услуг местоположения.

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

Требуется одна из следующих областей OAuth:

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

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

ОбновлениеServiceList

rpc UpdateServiceList( UpdateServiceListRequest ) returns ( ServiceList )

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

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

Требуется одна из следующих областей OAuth:

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

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

Проверки

Этот API позволяет управлять проверкой местоположения в Google. Это позволяет вам управлять ресурсами Verification .

Каждое Location имеет коллекцию ресурсов Verification с именами accounts/*/locations/*/verifications/* .

Полная проверка

rpc CompleteVerification( CompleteVerificationRequest ) returns ( CompleteVerificationResponse )

Завершает PENDING проверку.

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

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

Требуется одна из следующих областей OAuth:

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

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

FetchVerificationOptions

rpc FetchVerificationOptions( FetchVerificationOptionsRequest ) returns ( FetchVerificationOptionsResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

Список проверок

rpc ListVerifications( ListVerificationsRequest ) returns ( ListVerificationsResponse )

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

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

Требуется одна из следующих областей OAuth:

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

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

Проверить местоположение

rpc VerifyLocation( VerifyLocationRequest ) returns ( VerifyLocationResponse )

Запускает процесс проверки местоположения.

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

Требуется одна из следующих областей OAuth:

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

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

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

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

Поля
name

string

Имя принимаемого приглашения.

Счет

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

Поля
name

string

Имя ресурса в формате accounts/{account_id} .

account_name

string

Имя учетной записи.

type

AccountType

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

role

AccountRole

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

state

AccountState

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

account_number

string

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

permission_level

PermissionLevel

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

organization_info

OrganizationInfo

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

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

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

Поля
registered_domain

string

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

postal_address

PostalAddress

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

phone_number

string

Контактный номер организации.

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

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

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

состояние аккаунта

Указывает состояние учетной записи, например, была ли она проверена Google.

Поля
status

AccountStatus

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

Статус аккаунта

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

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

Тип аккаунта

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

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

Расширения местоположения AdWords

Дополнительная информация, отображаемая в AdWords.

Поля
ad_phone

string

Альтернативный номер телефона, который будет отображаться в расширениях адресов AdWords вместо основного номера телефона местоположения.

АдресВвод

Вход для проверки АДРЕСА.

Поля
mailer_contact_name

string

Имя контактного лица, на которое должно быть отправлено письмо.

Админ

Администратор Account или Location .

Поля
name

string

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

Для администраторов местоположения это имеет форму: accounts/{account_id}/locations/{location_id}/admins/{admin_id}

admin_name

string

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

role

AdminRole

Указывает AdminRole , которую этот администратор использует с указанным ресурсом Account или Location .

pending_invitation

bool

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

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

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

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

Тип оповещения

Тип события, для которого было создано оповещение.

Перечисления
ALERT_TYPE_UNSPECIFIED Никакого оповещения не указано.
COVID_19 Оповещения, связанные с пандемией коронавирусного заболевания 2019 года. Сообщения Covid поддерживают только поле сводки и поле призыва к действию. Когда эти оповещения перестанут быть актуальными, создание новых публикаций с оповещениями для типа COVID-19 будет отключено. Однако продавец по-прежнему сможет управлять своими существующими сообщениями о COVID-19.

Аллерген

Информация об аллергенах, касающихся продукта питания.

Перечисления
ALLERGEN_UNSPECIFIED Аллерген не указан
DAIRY Аллерген, связанный с молочными продуктами
EGG Аллерген, связанный с яйцами
FISH Аллерген, связанный с рыбой
PEANUT Аллерген, связанный с арахисом
SHELLFISH Аллерген, связанный с моллюсками
SOY Аллерген, связанный с соей
TREE_NUT Аллерген, связанный с древесными орехами
WHEAT Аллерген, связанный с пшеницей

Отвечать

Представляет собой ответ на вопрос

Поля
name

string

Только вывод. Уникальное имя для учетных записей ответов/*/locations/*/questions/*/ответы/*

author

Author

Только вывод. Автор ответа.

upvote_count

int32

Только вывод. Количество голосов за ответ.

text

string

Текст ответа. Он должен содержать хотя бы один символ без пробелов. Максимальная длина — 4096 символов.

create_time

Timestamp

Только вывод. Временная метка, когда был написан ответ.

update_time

Timestamp

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

AssociateLocationRequest

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

Поля
name

string

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

place_id

string

Ассоциацию создать. Если не установлено, это указывает на отсутствие совпадения.

Атрибут

Атрибут местоположения. Атрибуты предоставляют дополнительную информацию о местоположении. Атрибуты, которые можно задать для местоположения, могут различаться в зависимости от свойств этого местоположения (например, категории). Доступные атрибуты определяются Google и могут быть добавлены и удалены без изменений API.

Поля
attribute_id

string

Идентификатор атрибута. Идентификаторы атрибутов предоставляются Google.

value_type

AttributeValueType

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

values[]

Value

Значения этого атрибута. Тип предоставляемых значений должен соответствовать ожидаемому для этого атрибута; см. Тип АтрибутеЗначения . Это повторяющееся поле, в котором могут быть указаны несколько значений атрибута. Типы атрибутов поддерживают только одно значение.

repeated_enum_value

RepeatedEnumAttributeValue

Если тип значения атрибута — REPEATED_ENUM, он содержит значение атрибута, а остальные поля значений должны быть пустыми.

url_values[]

UrlAttributeValue

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

АтрибутМетаданные

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

Поля
attribute_id

string

Идентификатор атрибута.

value_type

AttributeValueType

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

display_name

string

Локализованное отображаемое имя атрибута, если оно доступно; в противном случае — отображаемое имя на английском языке.

group_display_name

string

Локализованное отображаемое имя группы, содержащей этот атрибут, если доступно; в противном случае — английское название группы. Связанные атрибуты собраны в группу и должны отображаться вместе под указанным здесь заголовком.

is_repeatable

bool

Если это правда, атрибут поддерживает несколько значений. Если значение false, следует указать только одно значение.

value_metadata[]

AttributeValueMetadata

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

is_deprecated

bool

Если это правда, атрибут устарел и больше не должен использоваться. Если он устарел, обновление этого атрибута не приведет к ошибке, но обновления не будут сохранены. В какой-то момент после устаревания атрибут будет полностью удален, и это станет ошибкой.

АтрибутЗначениеМетаданные

Метаданные для поддерживаемых значений атрибутов.

Поля
value

Value

Значение атрибута.

display_name

string

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

Например, для атрибута перечисления «WiFi» оно может содержать «Paid», обозначающее платный Wi-Fi.

АтрибутЗначениеТип

Тип значения атрибута.

Перечисления
ATTRIBUTE_VALUE_TYPE_UNSPECIFIED Не указан.
BOOL Значения этого атрибута являются логическими.
ENUM Атрибут имеет заранее определенный список доступных значений, которые можно использовать. В метаданных для этого атрибута будут перечислены эти значения.
URL Значениями этого атрибута являются URL-адреса.
REPEATED_ENUM Значение атрибута представляет собой перечисление с несколькими возможными значениями, которые можно явно установить или удалить.

Автор

Представляет автора вопроса или ответа

Поля
display_name

string

Отображаемое имя пользователя

profile_photo_url

string

URL-адрес фотографии профиля пользователя.

type

AuthorType

Тип пользователя, которым является автор.

Тип автора

Перечисление типа пользователя, которым является автор.

Перечисления
AUTHOR_TYPE_UNSPECIFIED Это не следует использовать.
REGULAR_USER Обычный пользователь.
LOCAL_GUIDE Местный гид
MERCHANT Владелец/управляющий локации

Базовый запрос метрики

Запрос на базовую информацию о метриках.

Поля
metric_requests[]

MetricRequest

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

time_range

TimeRange

Диапазон, для которого собираются показатели. Максимальный диапазон составляет 18 месяцев с даты запроса. В некоторых случаях данные могут отсутствовать в течение нескольких дней, близких к дате запроса. Недостающие данные будут указаны в metricValues ​​в ответе.

Пакетный запросGetBusinessCategoriesRequest

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

Поля
language_code

string

Необходимый. Код языка BCP 47, на котором должны быть возвращены имена категорий.

category_ids[]

string

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

region_code

string

Необязательный. Код страны ISO 3166-1 альфа-2, используемый для определения нестандартного языка.

view

CategoryView

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

BatchGetBusinessCategoriesResponse

Ответное сообщение для BusinessCategories.BatchGetBusinessCategories.

Поля
categories[]

Category

Категории, соответствующие идентификаторам GConcept, указанным в запросе. Они не будут идти в том же порядке, что и идентификаторы категорий в запросе.

Пакетный метод GetLocationsRequest

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

Поля
name

string

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

location_names[]

string

Коллекция мест для извлечения, указанная по их именам.

Пакетный метод GetLocationsResponse

Ответное сообщение для Locations.BatchGetLocations.

Поля
locations[]

Location

Коллекция локаций.

Пакетное получениеотзывовзапрос

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

Поля
name

string

Имя учетной записи, из которой можно получить список отзывов из нескольких местоположений.

location_names[]

string

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

page_size

int32

Сколько отзывов нужно получить на странице. Значение по умолчанию — 50.

page_token

string

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

order_by

string

Необязательный. Указывает поле для сортировки отзывов. Если не указано, порядок возвращаемых обзоров по умолчанию будет update_time desc . Допустимыми порядками сортировки являются rating , rating desc и update_time desc . rating вернет отзывы в порядке возрастания. update_time (т.е. порядок возрастания) не поддерживается.

ignore_rating_only_reviews

bool

Игнорировать ли отзывы, содержащие только оценки.

Пакетный метод GetReviewsResponse

Ответное сообщение для Reviews.BatchGetReviews.

Поля
location_reviews[]

LocationReview

Отзывы с информацией о местоположении.

next_page_token

string

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

Рабочие часы

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

Поля
periods[]

TimePeriod

Подборка случаев, когда это заведение было открыто для бизнеса. Каждый период представляет собой диапазон часов, в течение которых заведение открыто в течение недели.

Призыв к действию

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

Поля
action_type

ActionType

Тип действия, которое будет выполнено.

url

string

URL-адрес, на который будет перенаправлен пользователь при нажатии. Это поле следует оставить незаполненным для призыва к действию «Позвонить».

Тип действия

Тип действия, которое будет выполнено.

Перечисления
ACTION_TYPE_UNSPECIFIED Тип не указан.
BOOK В этом сообщении пользователь хочет записаться на прием/стол/и т. д.
ORDER Этот пост хочет, чтобы пользователь что-то заказал.
SHOP В этом посте пользователь хочет просмотреть каталог продуктов.
LEARN_MORE Этот пост хочет, чтобы пользователь узнал больше (на своем веб-сайте).
SIGN_UP В этом сообщении пользователю предлагается зарегистрироваться/зарегистрироваться/присоединиться к чему-либо.
GET_OFFER

Устарело. Используйте OFFER в LocalPostTopicType , чтобы создать публикацию с содержанием предложения.

CALL В этом сообщении пользователь хочет позвонить в компанию.

Категория

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

Поля
display_name

string

. Читабельное имя категории. Это устанавливается при чтении местоположения. При изменении местоположения необходимо установить category_id .

Примечание. Это поле используется только в ответах. Любое значение, указанное здесь в запросе, игнорируется.

category_id

string

. Стабильный идентификатор (предоставленный Google) для этой категории. category_id необходимо указывать при изменении категории (при создании или обновлении местоположения).

Примечание. Это поле используется только в ответах. Любое значение, указанное здесь в запросе, игнорируется.

service_types[]

ServiceType

. Список всех типов услуг, доступных для этой бизнес-категории.

Примечание. Это поле используется только в ответах. Любое значение, указанное здесь в запросе, игнорируется.

more_hours_types[]

MoreHoursType

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

КатегорияПросмотр

Перечисление, помогающее ограничить объем данных, возвращаемых сервером.

Перечисления
CATEGORY_VIEW_UNSPECIFIED Не указано, эквивалентно CATEGORY_METADATA_ONLY.
BASIC Ответ сервера будет включать только поля категории display_name, Category_id и Language_code. В нем отсутствуют любые поля, связанные с метаданными типа службы.
FULL Возвращает все поля ответа.

Цепь

Сеть – это бренд, с которым могут быть связаны филиалы вашего бизнеса.

Поля
name

string

Имя ресурса цепочки в формате chains/{chain_place_id} .

chain_names[]

ChainName

Названия сети.

websites[]

ChainUrl

Сайты сети.

location_count

int32

Количество локаций, входящих в эту цепочку.

Имяцепи

Имя, которое будет использоваться при отображении цепочки.

Поля
display_name

string

Отображаемое имя этой цепочки.

language_code

string

Код языка названия BCP 47.

Цепной URL

URL-адрес, который будет использоваться при отображении цепочки.

Поля
url

string

URL-адрес этой цепочки.

ClearLocationAssociationRequest

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

Поля
name

string

Имя ресурса расположения, которое требуется отключить.

Завершить запрос на проверку

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

Поля
name

string

Имя ресурса для завершения проверки.

pin

string

ПИН-код, полученный продавцом для завершения проверки.

ПолныйVerificationResponse

Ответное сообщение для Verifications.CompleteVerificationAction.

Поля
verification

Verification

Завершенная проверка.

CreateAccountAdminRequest

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

Поля
parent

string

Имя ресурса учетной записи, для которой создан этот администратор.

admin

Admin

Админ для создания

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

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

Поля
primary_owner

string

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

account

Account

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

CreateLocalPostRequest

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

Поля
parent

string

Имя места, в котором будет создано локальное сообщение.

local_post

LocalPost

Новые метаданные локальной публикации.

CreateLocationAdminRequest

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

Поля
parent

string

Имя ресурса местоположения, для которого создан этот администратор.

admin

Admin

Админ для создания

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

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

Поля
parent

string

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

location

Location

Новые метаданные местоположения.

validate_only

bool

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

request_id

string

Уникальный идентификатор запроса, позволяющий серверу обнаруживать дублированные запросы. Мы рекомендуем использовать UUID. Максимальная длина — 50 символов.

CreateMediaItemRequest

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

Поля
parent

string

Имя ресурса места, где будет создан этот медиа-элемент.

media_item

MediaItem

Создаваемый медиа-элемент.

СоздатьВопросЗапрос

Запрос сообщения для вопросов и ответов.CreateQuestion

Поля
parent

string

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

question

Question

Новый вопрос.

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

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

Поля
name

string

Имя приглашения учетной записи, которое отклоняется.

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

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

Поля
name

string

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

Удалить ответреквест

Запрос сообщения для вопросов и ответов.DeleteAnswer

Поля
parent

string

Название вопроса, на который нужно удалить ответ.

Удалитьлокалпострекуест

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

Поля
name

string

Название локальной публикации, которую нужно удалить.

УдалитьLocationAdminRequest

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

Поля
name

string

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

Удалитьлокационный запрос

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

Поля
name

string

Имя места, которое нужно удалить.

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

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

Поля
name

string

Имя удаляемого медиа-элемента.

Удалить запрос уведомлений

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

Поля
name

string

Имя ресурса для параметров уведомлений, которые необходимо очистить.

УдалитьВопросЗапрос

Запрос сообщения для вопросов и ответов.DeleteQuestion

Поля
name

string

Название вопроса, который нужно удалить.

Удалитьревиевереплиреквест

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

Поля
name

string

Название ответа на отзыв, который нужно удалить.

ДиетическиеОграничения

Диетическая информация о продукте.

Перечисления
DIETARY_RESTRICTION_UNSPECIFIED Тип диеты не указан
HALAL Обозначение еды как халяльного блюда.
KOSHER Обозначение еды как кошерного блюда.
ORGANIC Обозначение еды как органического блюда.
VEGAN Обозначение еды как веганского блюда.
VEGETARIAN Обозначение еды как вегетарианского блюда.

РазмерноеМетричноеЗначение

Значение одной метрики с заданным измерением времени.

Поля
metric_option

MetricOption

Опция, запрашивающая это размерное значение.

time_dimension

TimeDimension

Размерность значения.

value

Int64Value

Значение. Если значение не установлено, запрошенные данные отсутствуют.

TimeDimension

Измерение, по которому разделены данные.

Поля
day_of_week

DayOfWeek

Дню недели (от ПОНЕДЕЛЬНИКА до ВОСКРЕСЕНЬЯ), которому соответствует это значение. Установите параметр BREAKDOWN_DAY_OF_WEEK.

time_of_day

TimeOfDay

Час дня (от 0 до 23), которому соответствует это значение. Установите параметр BREAKDOWN_HOUR_OF_DAY.

time_range

TimeRange

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

DriveDirectionMetricsRequest

Запрос о понимании направления вождения.

Поля
num_days

NumDays

Количество дней для агрегирования данных для. Возвращенные результаты будут доступны в течение последнего количества запрошенных дней. Допустимые значения составляют 7, 30 и 90.

language_code

string

Код BCP 47 для языка. Если код языка не указан, по умолчанию используется английский.

Число дней

Количество дней, которые этот запрос может поддержать.

Перечисления
SEVEN 7 дней. Это значение по умолчанию.
THIRTY 30 дней.
NINETY 90 дней.

Электронная почта

Ввод для проверки электронной почты.

Поля
email_address

string

Адрес электронной почты, на который следует отправлять PIN -код.

Адрес электронной почты принимается только в том случае, если это один из адресов, предоставленных FetchVerificationOptions. Если EmailVerificationData имеет is_user_name_editable в True, клиент может указать другое имя пользователя (локальная часть), но должен соответствовать имени домена.

Ошибка

Подробно описывает ошибку, которая привела к проверке или внутреннему сбою.

Поля
code

int32

Код состояния, который должен быть значением перечисления ErrorCode .

field

string

Путь, ведущий к поле в органе запроса. Значение представляет собой последовательность, разделенные DOT, идентифицированные, которые идентифицируют поле протокола буфера. Например, «error_details.field» определит это поле.

message

string

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

value

string

Значение, которое не удалось.

field_index

int32

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

Код ошибки

Коды ошибок для ErrorDetail :

  • От 1 до 199: общие коды ошибок, которые применяются ко всем полям.
  • От 1000 до 1099: коды ошибок, связанные с фотографиями.
  • С 1100 до 1199: коды ошибок, связанные с адресами и широте/долготой.
  • От 1200 до 1299: коды ошибок, связанные с категорией.
  • 1300–1399: Коды ошибок, связанных с операцией.

Перечисления
ERROR_CODE_UNSPECIFIED Код ошибки улавливает.
MISSING_VALUE Требуемое значение не было предоставлено.
INVALID_VALUE Была предоставлена ​​неверная стоимость.
INVALID_CHARACTERS Неверные персонажи были найдены.
TOO_MANY_ITEMS Больше, чем максимальное количество предметов, было предоставлено в повторном поле.
READ_ONLY Поле только для чтения не может быть изменено.
OVERLAPPING_RANGES Предметы в повторяющемся поле - это диапазоны, которые перекрываются друг с другом.
INVERTED_RANGE Предоставленный диапазон перевернут. Это также включает в себя случай пустого диапазона.
VALUE_OUTSIDE_ALLOWED_RANGE Предоставленная стоимость находится за пределами допустимого диапазона.
MISSING_DEPENDENT_FIELD Требуемое зависимое поле отсутствует.
FIELD_HAS_DEPENDENCIES Поле требуется зависимым полем и не может быть удалено.
UNSUPPORTED_VALUE Предоставленная стоимость, хотя и, возможно, действительная, не поддерживается из -за других ограничений.
EXPIRED_VALUE Предоставленная стоимость истек и больше не является действительной.
PHOTO_FETCH_FAILED Принесите фото из указанного URL -адреса.
PHOTO_UPLOAD_FAILED Загрузите фото с указанного URL -адреса.
GEOCODE_ERROR Была ошибка, автоматически определяющая широту/долготу.
LAT_LNG_OUTSIDE_COUNTRY Предоставленная широта/долгота не лежит в предоставленной стране.
LAT_LNG_REQUIRED Широта и долгота должны быть предоставлены.
LAT_LNG_TOO_FAR_FROM_ADDRESS Пара широты/долготы и адреса слишком далеко друг от друга.
CATEGORY_NOT_VERIFIED Предоставленная категория не проверена.
OPERATION_EXECUTION_ERROR Общая ошибка выполнения операции.
OPERATION_UNSUPPORTED_UNDER_ACCOUNT_CONDITION Работа не поддерживается из -за условия учетной записи.
LOCATION_DISABLED_FOR_LOCAL_POST_API Местоположение отключено для локального Post API.

FetchVerificationOptionsRequest

Запросить сообщение для проверки.

Поля
name

string

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

language_code

string

Языковой код BCP 47, представляющий язык, который должен использоваться для процесса проверки. Доступные варианты варьируются в зависимости от языка.

context

ServiceBusinessContext

Дополнительная контекстная информация для проверки услуг. Требуется для местоположений, чей бизнес -тип - customer_location_only. Invalid_argument будет брошен, если он будет установлен для других видов бизнеса.

FetchVerificationOptionsResponse

Ответ Сообщение для проверки.

Поля
options[]

VerificationOption

Доступные варианты проверки.

FindmatchinglocationsRequest

Запросить сообщение о локации.

Поля
name

string

Название ресурса местоположения, чтобы найти совпадения.

language_code

string

Предпочтительный язык для места сопоставления (в формате BCP-47).

num_results

int32

Количество совпадений для возврата. Значение по умолчанию составляет 3, максимум 10. Обратите внимание, что задержка может увеличиться, если запрашивается больше. Там нет страниц.

max_cache_duration

Duration

Устарело. Это поле игнорируется для всех запросов.

FindMatchingLocationsResponse

Ответ Сообщение для локаций.

Поля
matched_locations[]

MatchedLocation

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

match_time

Timestamp

Когда соответствующий алгоритм был в последний раз выполнен для этого места.

Последователи .metadata

Последовательные метаданные для места.

Поля
name

string

Имя ресурса для этого. accounts/{account_id}/locations/{location_id}/последователи/метаданные

count

uint64

Общее количество последователей для места.

Меню еды

Меню бизнеса, который подает блюда с едой.

Поля
labels[]

MenuLabel

Необходимый. Языковые этикетки для меню. Например, «Меню», «Специальный обед». Отображения должны составлять 140 символов или меньше, с описаниями 1000 символов или меньше. По крайней мере, один набор ярлыков требуется.

source_url

string

Необязательный. Источник URL меню, если есть веб -страница.

sections[]

FoodMenuSection

Необходимый. Разделы меню.

cuisines[]

Cuisine

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

Кухня

Кухня информация о ресторане.

Перечисления
CUISINE_UNSPECIFIED Кухня не указана
AMERICAN американская еда
ASIAN Азиатская еда
BRAZILIAN Бразильская кухня
BREAK_FAST Завтрак
BRUNCH Бранч
CHICKEN Курица
CHINESE китайская еда
FAMILY Кухня семейного стиля
FAST_FOOD Быстрое питание
FRENCH французская еда
GREEK Греческая кухня
GERMAN Немецкая еда
HAMBURGER Гамбургер
INDIAN Индийская еда
INDONESIAN Индонезийская еда
ITALIAN итальянская еда
JAPANESE японская еда
KOREAN Корейская еда
LATIN_AMERICAN Латиноамериканская еда
MEDITERRANEAN Средиземноморская еда
MEXICAN Мексиканская еда
PAKISTANI Пакистанская еда
PIZZA Пицца
SEAFOOD Морепродукты
SPANISH испанская еда
SUSHI Суши
THAI тайская еда
TURKISH турецкая еда
VEGETARIAN Вегетарианская еда
VIETNAMESE Вьетнамская еда
OTHER_CUISINE Другая кухня

Foodmenuitem

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

Поля
labels[]

MenuLabel

Необходимый. Языковые метки метки для этого пункта меню. Отображения должны составлять 140 символов или меньше, с описаниями 1000 символов или меньше. По крайней мере, один набор ярлыков требуется.

attributes

FoodMenuItemAttributes

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

options[]

FoodMenuItemOption

Необязательный. Это предназначен для элемента, который поставляется в разных вариантах, и пользователи обязаны сделать выбор. Например, «обычная» против «большой» пиццы. Когда будут указаны параметры, этикетки и атрибуты на уровне элемента автоматически станут первыми мечениями и атрибутами. Клиенты должны указать только другие дополнительные варианты питания в этой области.

Foodmenuitemattributes

Атрибуты продукта/блюдо.

Поля
price

Money

Необходимый. Цена блюда с едой.

spiciness

Spiciness

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

allergen[]

Allergen

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

dietary_restriction[]

DietaryRestriction

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

nutrition_facts

NutritionFacts

Необязательный. Факты питания блюда. Настоятельно рекомендуется предоставить эту область.

ingredients[]

Ingredient

Необязательный. Ингредиенты блюда с едой.

serves_num_people

int32

Необязательный. Количество людей может подавать этот вариант блюд.

preparation_methods[]

PreparationMethod

Необязательный. Методы того, как готовится вариант пищевого блюда.

portion_size

PortionSize

Необязательный. Размер заказа, представленного в единицах предметов. (например, 4 «шампуры», 6 «кусочков»)

media_keys[]

string

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

Ингредиент

Это сообщение обозначает информацию об ингредиенте о продовольственном блюде.

Поля
labels[]

MenuLabel

Необходимый. Ярлыки для описания ингредиента. Отображения должны составлять 140 символов или меньше, с описаниями 1000 символов или меньше. По крайней мере, один набор ярлыков требуется.

Порции размером

Порция порции размера блюда с едой.

Поля
quantity

int32

Необходимый. Количество порции.

unit[]

MenuLabel

Необходимый. Полевое поле name_info предназначено для устройства на нескольких языках.

Foodmenuitemoption

Вариант элемента. Это требует явного выбора пользователя.

Поля
labels[]

MenuLabel

Необходимый. Языковые метки метки для этого варианта меню. Например: «Говяжий пад Тай», «Вегетарианская пада Тай», «Маленькая пицца», «Большая пицца». Отображения должны составлять 140 символов или меньше, с описаниями 1000 символов или меньше. По крайней мере, один набор ярлыков требуется.

attributes

FoodMenuItemAttributes

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

Продовольственная

Раздел меню. Он может содержать несколько предметов/посуды.

Поля
labels[]

MenuLabel

Необходимый. Языковые метки метки для этого раздела меню. Отображения должны составлять 140 символов или меньше, с описаниями 1000 символов или меньше. По крайней мере, один набор ярлыков требуется.

items[]

FoodMenuItem

Необходимый. Пункты раздела. В каждом разделе должен быть хотя бы предмет.

Foodmenus

Меню бизнеса, которые подают блюда с едой.

Поля
name

string

Необходимый. Идентификатор Google для этого местоположения в форме: accounts/{account_id}/locations/{location_id}/foodMenus

menus[]

FoodMenu

Необязательный. Коллекция продовольственных меню.

GenerateAccountnumberRequest

Запросить сообщение для учетных записей. Generateaccountnumber.

Поля
name

string

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

GetAccountRequest

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

Поля
name

string

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

GetChainRequest

Запросить сообщение о локации.getchain.

Поля
name

string

Имя ресурса цепочки, в chains/{chain_place_id} .

GetCustomerMediaItemRequest

Запросить сообщение для media.getCustomerMediaItem.

Поля
name

string

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

GetFollowersMetAdatareQuest

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

Поля
name

string

Название ресурса метаданных последователей местоположения. accounts/{account_id}/locations/{location_id}/последователи/метаданные

GetFoodMenusRequest

Запросить сообщение для foodmenu.getfoodmenus

Поля
name

string

Необходимый. Идентификатор Google для этого местоположения в форме: accounts/{account_id}/locations/{location_id}/foodMenus

read_mask

FieldMask

Необязательный. Конкретные поля для возврата. Если маска не указана, то она возвращает полный Foodmenu (так же, как «*»). Повторные элементы поля не могут быть указаны индивидуально. Например: «Имя» и «Меню» являются действительными масками, в то время как «меню. Разрешения» недействительны.

Gethealthproviderattributesrequest

Запросить сообщение для здравоохранения

Поля
name

string

Необходимый. Идентификатор Google для этого местоположения в форме: accounts/{account_id}/locations/{location_id}/healthproviderattributes

language_code

string

Необязательный. Код BCP 47 для языка. Если код языка не указан, по умолчанию используется английский. На данный момент поддерживается только «en».

Getlocalpostrequest

Запросить сообщение о локальном prosts.getlocalpost.

Поля
name

string

Название местного поста для получения.

GetLocationRequest

Запросить сообщение о локации.getLocation.

Поля
name

string

Название местоположения для получения.

GetMediaItemRequest

Запросить сообщение для media.getmediaitem.

Поля
name

string

Название запрошенного элемента медиа.

GetNotificationsRequest

Запросить сообщение для учетных записей.getNotifications.

Поля
name

string

Уведомление Настройки Настройки Имя ресурса.

GetReviewRequest

Запросить сообщение для Reviews.getReview.

Поля
name

string

Название обзора для получения.

GetserviceListriestest

Получить сообщение о запросе списка услуг.

Поля
name

string

Необходимый. Идентификатор Google для этого местоположения в форме: accounts/{account_id}/locations/{location_id}/servicelist

GoogleМестоположение

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

Поля
name

string

Имя ресурса этого GoogleLocation, в формате googleLocations/{googleLocationId} .

location

Location

Малонаселенная информация Location . Это поле можно повторно использовать в CreateLocation , если в настоящее время не заявляет пользователь.

request_admin_rights_url

string

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

GoogleUpdatedLocation

Представляет место, которое было изменено Google.

Поля
location

Location

Google-Updated версия этого места.

diff_mask

FieldMask

Поля, которые Google обновил.

HealthProviderattributes

Атрибуты медицинского работника связаны с этим местоположением.

Поля
name

string

Необходимый. Идентификатор Google для этого местоположения в форме: accounts/{account_id}/locations/{location_id}/healthProviderAttributes

insurance_networks[]

InsuranceNetwork

Необязательный. Список страховых сетей, связанных с этим местоположением.

Insurancenetwork

Единственная страховая сеть. Следующий идентификатор: 5

Поля
network_id

string

Необходимый. Идентификатор этой страховой сети, сгенерированной Google.

network_names

map<string, string>

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

payer_names

map<string, string>

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

state

NetworkState

Только вывод. Состояние этой страховой сети.

Внутренняя ошибка

Описывает внутренние неудачи.

Поля
error_details[]

ErrorDetail

Подробно отдельные неудачи.

Приглашение

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

Поля
name

string

Имя ресурса для приглашения.

role

AdminRole

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

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

Account

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

target_location

TargetLocation

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

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

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

Поля
location_name

string

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

location_address

string

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

Запрос ListAccountAdmins

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

Поля
parent

string

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

ListAccountAdminsResponse

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

Поля
admins[]

Admin

Коллекция экземпляров Admin .

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

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

Поля
page_size

int32

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

page_token

string

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

name

string

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

filter

string

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

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

ListAccountsResponse

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

Поля
accounts[]

Account

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

next_page_token

string

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

ListAnsWersRequest

Запросить сообщение о вопросах andanswers.listanswers

Поля
parent

string

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

page_size

int32

Сколько ответов на получение на страницу. Значения по умолчанию и максимум page_size составляют 10.

page_token

string

Если указано, получена следующая страница ответов.

order_by

string

Приказ вернуть ответы. Действительные параметры включают «Update_time desc» и «upvote_count desc», которые возвращают ответы, отсортированные нисходящими по запрашиваемому полю. Порядок сортировки по умолчанию - «Update_time desc».

ListAnsWersResponse

Ответное сообщение для вопросов andanswers.listanswers

Поля
answers[]

Answer

Запрошенные ответы.

total_size

int32

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

next_page_token

string

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

ListattribitemetAdatarequest

Запросить сообщение для местоположения. Если имя ресурса местоположения предоставляется, то это место будет использоваться для заполнения остальных критериев. Если нет, категория и страна должны быть предоставлены.

Поля
name

string

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

category_id

string

Основная стабильная идентификация категории для поиска доступных атрибутов.

country

string

ISO 3166-1 Код страны Альфа-2, чтобы найти доступные атрибуты.

language_code

string

Код языка BCP 47 для получения имен отображения атрибутов. Если этот язык недоступен, он будет предоставлен на английском языке.

page_size

int32

Сколько атрибутов включать на страницу. По умолчанию 200, минимум - 1.

page_token

string

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

ListattribitemetAdataresponse

Ответ Сообщение для локаций.

Поля
attributes[]

AttributeMetadata

Коллекция метаданных атрибутов для доступных атрибутов.

next_page_token

string

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

ListBusinessCategoriesRequest

Поля
region_code

string

ISO 3166-1 Код страны Альфа-2.

language_code

string

BCP 47 Код языка. Если язык недоступен, он по умолчанию по умолчанию на английский.

search_term

string

Дополнительная строка фильтра от пользователя.

page_size

int32

Сколько категорий получить на страницу. По умолчанию — 100, минимум — 1, максимальный размер страницы — 100.

page_token

string

Если указано, будет получена следующая страница категорий.

view

CategoryView

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

ListBusinessCategoriesResponse

Поля
categories[]

Category

Категории. Категории являются основным представлением. Они не содержат информации о услугах.

total_category_count

int32

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

next_page_token

string

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

ListCustomerMediaItemsRequest

Запросить сообщение для media.listcustomermediaitems.

Поля
parent

string

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

page_size

int32

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

page_token

string

Если указано, возвращает следующую страницу элементов мультимедиа.

ListCustomerMediaItemsResponse

Ответное сообщение для media.listcustomermediaitems.

Поля
media_items[]

MediaItem

Вернуемый список предметов СМИ.

total_media_item_count

int32

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

next_page_token

string

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

ListInsUrancenetWorksRequest

Запросить сообщение для insurancenetworkservice.listinsurancenetworks

Поля
parent

string

Необходимый. Название места, страховые сети которого будут указаны. Имя в форме: Accounts/{account_id}/locations/{location_id}

language_code

string

Необязательный. Код BCP 47 для языка. Если код языка не указан, по умолчанию используется английский. На данный момент поддерживается только «en».

page_size

int32

Сколько страховых сетей вернуть на страницу. Значение по умолчанию — 5000. Максимальный размер страницы — 10000.

page_token

string

Если указано, возвращает следующую страницу страховых сетей.

ListInsUrancenetWorksResponse

Ответное сообщение для InsuranceNetworkService.ListInsuranceNetworks

Поля
networks[]

InsuranceNetwork

Список страховых сетей, поддерживаемых Google.

next_page_token

string

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

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

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

Поля
parent

string

Имя учетной записи, из которой извлекается список приглашений.

target_type

TargetType

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

Тип цели

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

Перечисления
ALL Перечислите приглашения для всех целевых типов. Это значение по умолчанию.
ACCOUNTS_ONLY Перечислите приглашения только для целей типа «Учетная запись».
LOCATIONS_ONLY Перечислите приглашения только для целей типа «Местоположение».

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

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

Поля
invitations[]

Invitation

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

Listlocalpostsrequest

Запросить сообщение для ListLocalPosts

Поля
parent

string

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

page_size

int32

Сколько местных сообщений вернуть на страницу. По умолчанию 20. Минимум составляет 1, а максимальный размер страницы составляет 100.

page_token

string

Если указано, возвращает следующую страницу локальных сообщений.

Listlocalpostsresponse

Ответное сообщение для ListLocalPosts

Поля
local_posts[]

LocalPost

Вернутый список местных сообщений.

next_page_token

string

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

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

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

Поля
parent

string

Название места, администраторов которого нужно вывести в список.

ListLocationAdminsResponse

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

Поля
admins[]

Admin

Коллекция экземпляров Admin .

ListLocationsRequest

Запросить сообщение о локациях.

Поля
parent

string

Имя учетной записи, из которой нужно получить данные о местоположениях. Если Account имеет личную AccountType , возвращаются только места, которые непосредственно принадлежат учетной записи, в противном случае она вернет все доступные местоположения из учетной записи, прямо или косвенно.

page_size

int32

Сколько местоположений нужно получить на странице. По умолчанию — 100, минимум — 1, максимальный размер страницы — 100.

page_token

string

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

filter

string

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

Дополнительные сведения о допустимых полях и примерах их использования см. в Руководстве по работе с данными о местоположении .

language_code
(deprecated)

string

Код языка BCP 47, на котором будут отображаться свойства местоположения. Если этот язык недоступен, они будут предоставлены на языке местоположения. Если ни один из них недоступен, они будут предоставлены на английском языке.

Устарело. После 15 августа 2020 года это поле больше не будет применяться. Вместо этого язык местоположения всегда будет использоваться.

order_by

string

Порядок сортировки запроса. Несколько полей должны быть разделены запятыми в соответствии с синтаксисом SQL. По умолчанию порядок сортировки — по возрастанию. Чтобы указать порядок убывания, следует добавить суффикс «desc». Допустимые поля для order_by являются location_name и store_code. Например: "location_name, store_code desc" или "location_name" или "store_code desc"

ListLocationsResponse

Ответ Сообщение для локаций.

Поля
locations[]

Location

Локации.

next_page_token

string

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

total_size

int32

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

ListMediaItemsRequest

Запросить сообщение для media.listmediaitems.

Поля
parent

string

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

page_size

int32

Сколько элементов медиа возврата на страницу. Значение по умолчанию составляет 100, что также является максимально поддерживаемым количеством элементов мультимедиа, которые могут быть добавлены в место с Google My Business API. Максимальный размер страницы - 2500.

page_token

string

Если указано, возвращает следующую страницу элементов мультимедиа.

ListMediaItemSresponse

Ответное сообщение для media.listmediaitems.

Поля
media_items[]

MediaItem

Вернуемый список предметов СМИ.

total_media_item_count

int32

Общее количество средств массовой информации для этого места, независимо от страниц.

next_page_token

string

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

ListQuestionsRequest

Запросить сообщение о вопросах andanswers.listquestions

Поля
parent

string

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

page_size

int32

Сколько вопросов получить на страницу. Значения по умолчанию и максимум page_size составляют 10.

page_token

string

Если указано, получена следующая страница вопросов.

answers_per_question

int32

Сколько ответов на получение за вопрос. Значения по умолчанию и максимальному answers_per_question

filter

string

Фильтр, ограничивающий вопросы для возврата. Единственный фильтр, поддерживаемый в настоящее время, - это "Ignore_answered = true"

order_by

string

Приказ вернуть вопросы. Действительные параметры включают «Update_time desc» и «upvote_count desc», которые возвращают вопросы, отсортированные нисходящими по запрашиваемому полю. Порядок сортировки по умолчанию - «Update_time desc».

ListQuestionsResponse

Ответное сообщение для вопросов andanswers.listquestions

Поля
questions[]

Question

Запрошенные вопросы,

total_size

int32

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

next_page_token

string

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

ListrecommendedGoogleLocationsRequest

Запросить сообщение на перечисление рекомендуемых мест для учетной записи бизнес -профиля.

Поля
name

string

Название ресурса учетной записи для получения рекомендованных местоположений Google.

page_size

int32

Сколько местоположений нужно получить на странице. По умолчанию — 25, минимум — 1, максимальный размер страницы — 100.

page_token

string

Если указано, извлекается следующая страница местоположений.

ListrecommendedGoogleLocationsResponse

Ответное сообщение для GoogleLocations.ListRecommendedGoogleLocations.

Он также содержит некоторые местоположения, на которые заявили права другие пользователи бизнес-профиля с тех пор, как они в последний раз были рекомендованы этому аккаунту бизнес-профиля.

Поля
google_locations[]

GoogleLocation

Местоположение, рекомендованное для аккаунта профиля компании. Каждый из них представляет местоположение GoogleLocation , присутствующее на Картах. Местоположение отсортировано в порядке убывания соответствия аккаунту профиля компании.

total_size

int32

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

next_page_token

string

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

ListreviewSrequest

Запросить сообщение о просмотре.

Поля
parent

string

Название местоположения для получения обзоров для.

page_size

int32

Сколько обзоров для получения на страницу. Максимальный page_size составляет 50.

page_token

string

Если указано, он получает следующую страницу обзоров.

order_by

string

Определяет поле для сортировки обзоров. В случае неопределенности, возвращаемый порядок обзоров по умолчанию по умолчанию в update_time desc . Допустимые заказы, которые можно сортировать по rating , rating desc и update_time desc .

ListreviewSresponse

Ответ Сообщение для обзоров. Listreviews.

Поля
reviews[]

Review

Отзывы.

average_rating

double

Средний рейтинг звезд всех обзоров для этого места по шкале от 1 до 5, где 5 - самый высокий рейтинг.

total_review_count

int32

Общее количество обзоров для этого места.

next_page_token

string

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

ListVerificationsRequest

Запросить сообщение для проверки. Списокверирование.

Поля
parent

string

Название ресурса местоположения, к которому принадлежат запросы на проверку.

page_size

int32

Сколько проверки включать на страницу. Если не установлено, верните все.

page_token

string

Если указано, возвращает следующую страницу проверки.

ListVerificationsResponse

Ответное сообщение для проверки. Списокверирование.

Поля
verifications[]

Verification

Список проверки.

next_page_token

string

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

LocalPost

Представляет местный пост для местоположения.

Поля
name

string

Только вывод. Идентификатор Google для этого локального поста в форме: accounts/{account_id}/locations/{location_id}/localPosts/{local_post_id}

language_code

string

Язык местного поста.

summary

string

Описание/Тело местного поста.

call_to_action

CallToAction

URL -адрес, на который пользователи отправляются при нажатии на акцию. Игнорируется для OFFER типа темы.

create_time

Timestamp

Только вывод. Время создания поста.

update_time

Timestamp

Только вывод. Время последней модификации поста, сделанного пользователем.

event

LocalPostEvent

Информация о событии. Требуется для EVENT типов тем и OFFER .

state

LocalPostState

Только вывод. Состояние поста, указывающее, в какой части его жизненного цикла он находится.

media[]

MediaItem

СМИ, связанные с постом. Source_url - единственное поддерживаемое поле данных для LocalPost MediaItem.

search_url

string

Только вывод. Ссылка на локальный пост в Google Search. Эта ссылка может быть использована для обмена сообщением через социальные сети, электронную почту, текст и т. Д.

topic_type

LocalPostTopicType

Необходимый. Тип темы поста: Стандартное, событие, предложение или предупреждение.

alert_type

AlertType

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

offer

LocalPostOffer

Дополнительные данные для предложений. Это должно быть установлено только тогда, когда предложена тема_тип.

LocalPoststate

Указывает, в каком состоянии находится почта в

Перечисления
LOCAL_POST_STATE_UNSPECIFIED Состояние не указано.
REJECTED Этот пост был отклонен из -за нарушения политики контента.
LIVE Этот пост опубликован и в настоящее время появляется в результатах поиска.
PROCESSING Этот пост обрабатывается и не появляется в результатах поиска.

LocalPostevent

Вся информация, относящаяся к событию, представленной в местном посте.

Поля
title

string

Название события.

schedule

TimeInterval

Событие даты начала и окончания/времени.

LocalPostmetrics

Все метрики запрошены на местный пост.

Поля
local_post_name

string

metric_values[]

MetricValue

Список значений для запрошенных метрик.

LocalPostoffer

Конкретные поля для предложений.

Поля
coupon_code

string

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

redeem_online_url

string

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

terms_conditions

string

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

LocalPostTopicType

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

Перечисления
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED Тип поста не указан.
STANDARD Post содержит основную информацию, такую ​​как резюме и изображения.
EVENT Post содержит основную информацию и событие.
OFFER Post содержит основную информацию, событие и предложение, связанное с контентом (например, код купона)
ALERT Высокие и своевременные объявления, связанные с продолжающимся событием. Эти типы сообщений не всегда доступны для авторизации.

Расположение

Местоположение. См. Статью «Справочный центр» для подробного описания этих полей или конечной точки категории для списка действительных бизнес -категорий.

Поля
name

string

Идентификатор Google для этого местоположения в форме: accounts/{account_id}/locations/{location_id}

В контексте матчей это поле не будет заполнено.

language_code

string

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

store_code

string

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

location_name

string

Название местоположения должно отражать реальное название вашего бизнеса, как постоянно используется на вашем магазине, веб-сайте и канцелярских товарах, и, как известно клиентам. Любая дополнительная информация, когда она имеет отношение, может быть включена в другие области ресурса (например, Address , Categories ). Не добавляйте ненужную информацию к своему имени (например, предпочитайте «Google», а не «Google Inc. - Mountain View Corporate штаб -квартира»). Не включайте маркетинговые слоганы, коды магазинов, специальные символы, часы или закрытое/открытое состояние, номера телефонов, URL -адреса веб -сайта, информацию о услуге/продукте, местоположение/адрес или указания или информацию о сдерживании (например, «Chase Ant в Duane Reade ").

primary_phone

string

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

additional_phones[]

string

До двух телефонов (мобильный или стационарный, без факса), на котором можно вызвать ваш бизнес, в дополнение к вашему основному номеру телефона.

address

PostalAddress

Точный, точный адрес для описания местоположения вашего бизнеса. PO Boxes или почтовые ящики, расположенные в удаленных местах, неприемлемы. В настоящее время вы можете указать максимум пять значений address_lines в адресе.

primary_category

Category

Категория, которая лучше всего описывает основной бизнес, в котором участвует это место.

additional_categories[]

Category

Дополнительные категории для описания вашего бизнеса. Категории помогают вашим клиентам найти точные, конкретные результаты для услуг, которые они заинтересованы. Выберите категории, которые являются максимально конкретными, но представитель вашего основного бизнеса.

website_url

string

URL для этого бизнеса. Если возможно, используйте URL, который представляет это отдельное местоположение бизнеса вместо общего веб -сайта/URL, который представляет все местоположения, или бренд.

regular_hours

BusinessHours

Часы работы для бизнеса.

special_hours

SpecialHours

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

service_area

ServiceAreaBusiness

Предприятия в области обслуживания предоставляют свой сервис в местоположении клиента. Если этот бизнес является бизнесом в области обслуживания, в этой области описывается район, обслуживаемый бизнесом.

location_key

LocationKey

Коллекция ключей, которые связывают этот бизнес с другими свойствами Google, таких как страница Google+ и Google Maps.

labels[]

string

Коллекция строк свободной формы, позволяющая вам пометить ваш бизнес. Эти этикетки не сталкиваются с пользователем; Только вы можете их увидеть. Ограничено 255 символами (на этикетке).

ad_words_location_extensions

AdWordsLocationExtensions

Дополнительная информация, которая появляется в AdWords.

latlng

LatLng

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

open_info

OpenInfo

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

location_state

LocationState

Только вывод. Набор логических, которые отражают состояние местоположения.

attributes[]

Attribute

Атрибуты для этого места.

metadata

Metadata

Только вывод. Дополнительная не пользовательская информация.

price_lists[]
(deprecated)

PriceList

Установилось: информация о ценовом списке для этого места.

profile

Profile

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

relationship_data

RelationshipData

Все места и цепь связаны с этим.

more_hours[]

MoreHours

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

Метаданные

Дополнительная не пользовательская информация о местоположении.

Поля
duplicate
(deprecated)

Duplicate

Информация о месте, где дублирует это местоположение. Присутствует только тогда, когда location_state.is_duplicate это правда. Установилось: мы больше не поддерживаем подробную информацию для дубликатов.

maps_url

string

Ссылка на местоположение на картах.

new_review_url

string

Ссылка на страницу в поиске Google, где клиент может оставить отзыв для местоположения.

Дублировать

Информация о месте, где дублирует это местоположение.

Поля
location_name

string

Название ресурса места, которое это дублирует. Заполнено только если у аутентифицированного пользователя есть права доступа к этому местоположению, и это место не удалено.

place_id

string

Место идентификатор места, которое это дублирует.

access

Access

Указывает, имеет ли пользователь доступ к месту, которое он дублирует.

Доступ

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

Перечисления
ACCESS_UNSPECIFIED Не указан.
ACCESS_UNKNOWN Невозможно определить, имеет ли пользователь доступ к месту, которое он дублирует.
ALLOWED У пользователя есть доступ к месту, которое он дублирует.
INSUFFICIENT У пользователя нет доступа к месту, которое он дублирует.

Отношения

Информация всех мест для родителей и детей, связанных с этим.

Поля
parent_chain

string

Название ресурса цепочки, которой является это место. How to find Chain ID

LocationDrivingDirectionMetrics

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

Поля
location_name

string

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

top_direction_sources[]

TopDirectionSources

Запросы направления вождения по исходному региону. По соглашению, они отсортированы по подсчету с максимум 10 результатов.

time_zone

string

Часовой пояс (Iana Timezone ID, например, «Европа/Лондон»).

TopDirectionsources

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

Поля
day_count

int32

Количество дней данных агрегировано.

region_counts[]

RegionCount

Регионы отсортированы в порядке убывания по графу.

Регионат

Регион с связанным с этим запрос.

Поля
latlng

LatLng

Центр региона.

label

string

Черопитая этикетка для региона.

count

int64

Количество запросов направления вождения из этого региона.

LocationKey

Альтернативные/суррогатные ссылки на ключ для местоположения.

Поля
plus_page_id

string

Только вывод. Если в этом месте связана страница Google+, это заполняется идентификатором страницы Google+ для этого места.

place_id

string

Если это место было проверено и подключено к/отображается на картах Google, это поле заполнено идентификатором места для места. Этот идентификатор может быть использован в различных местах API.

Если это место не является проверенным, это поле может быть заполнено, если местоположение было связано с местом, которое появляется на картах Google.

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

Дополнительный explicit_no_place_id Bool квалифицирует, является ли идентификатор незаметного места или нет.

explicit_no_place_id

bool

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

request_id

string

Только вывод. request_id используется для создания этого местоположения. Может быть пустым, если это место было создано за пределами Google My Business API или местоположения бизнес -профиля.

LocationMetrics

Серия метрик и разбивки, связанные с местоположением в течение некоторого времени.

Поля
location_name

string

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

time_zone

string

Яна часовой пояс для места.

metric_values[]

MetricValue

Список значений для запрошенных метрик.

LocationReview

Представляет обзор с информацией о местоположении.

Поля
name

string

Имя ресурса местоположения.

review

Review

Обзор для местоположения.

Штат место

Содержит набор логических, которые отражают состояние местоположения.

Поля
is_google_updated

bool

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

is_duplicate

bool

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

is_suspended

bool

Только вывод. Указывает, является ли местоположение приостановлено. Приостановленные местоположения не видны конечным пользователям в продуктах Google. Если вы считаете, что это была ошибка, см. Статью о справочнике .

can_update

bool

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

can_delete

bool

Только вывод. Указывает, можно ли удалить местоположение с помощью Google My Business API.

is_verified

bool

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

needs_reverification

bool

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

is_pending_review

bool

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

is_disabled

bool

Только вывод. Указывает, отключено ли местоположение.

is_published

bool

Только вывод. Указывает, опубликовано ли место.

is_disconnected

bool

Только вывод. Указывает, отключено ли место от места на картах Google.

is_local_post_api_disabled

bool

Только вывод. Указывает, отключены ли alcounts.locations.localposts для этого места.

can_modify_service_list

bool

Только вывод. Указывает, может ли листинг изменять сервис -директор.

can_have_food_menus

bool

Только вывод. Указывает, имеет ли листинг право на меню еды.

has_pending_edits

bool

Только вывод. Указывает, находится ли какое -либо из свойств этого места в редактировании в ожидании состояния.

has_pending_verification

bool

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

can_operate_health_data

bool

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

can_operate_lodging_data

bool

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

MatchedLocation

Представляет возможное совпадение с местоположением.

Поля
location

Location

Редко заселенное местоположение, которое является потенциальным совпадением. Unpopulated fields include, but may not be limited to: name (the matched location cannot be retrieved via GetLocation nor BatchGetLocations ); store_code ; service_area coverage area details; labels ; ad_words_location_extensions ; photos

is_exact_match

bool

Is this an exact match?

MediaItem

Один медиа-объект.

Поля
name

string

Имя ресурса для этого элемента мультимедиа. accounts/{account_id}/locations/{location_id}/media/{media_key}

media_format

MediaFormat

Формат этого медиа-элемента. Должен быть установлен при создании элемента мультимедиа и доступен только для чтения для всех остальных запросов. Невозможно обновить.

location_association

LocationAssociation

Требуется при вызове CreatePhoto . Описывает, как этот медиа-элемент связан с его местоположением. Должна быть либо категория (например, ЭКСТЕРЬЕР), либо идентификатор позиции прайс-листа.

This is required when adding new media to a location with CreateMediaItem . Для других типов носителей, например фотографий в локальных постах, этого не будет.

google_url

string

Только вывод. URL-адрес этого медиафайла, размещенный в Google. Этот URL-адрес не является статическим, поскольку со временем он может меняться. Для видео это будет изображение предварительного просмотра с наложенным значком воспроизведения.

thumbnail_url

string

Только вывод. Если указано, URL-адрес миниатюры этого медиа-элемента.

create_time

Timestamp

Только вывод. Время создания этого медиа-элемента.

dimensions

Dimensions

Только вывод. Размеры (ширина и высота) в пикселях.

insights

MediaInsights

Только вывод. Статистика для этого медиа-материала.

attribution

Attribution

Только вывод. Информация об атрибуции медиа-элементов клиента. Вы должны отображать эту атрибуцию так, как она предоставлена ​​вашим пользователям, и не должны удалять или изменять ее.

description

string

Description for this media item. Описания нельзя изменить через Google My Business API, но их можно установить при создании нового медиа-элемента, который не является обложкой.

data поля объединения. Источник данных элемента мультимедиа. При создании нового элемента мультимедиа необходимо указать URL-адрес или ссылку на данные.

За исключением категорий PROFILE и COVER , все фотографии должны иметь размер не менее 250 пикселей по короткому краю и размер файла не менее 10 240 байт.

Все загружаемые фотографии должны соответствовать рекомендациям для фотографий в профиле компании . data могут быть только одним из следующих:

source_url

string

Общедоступный URL-адрес, по которому можно получить элемент мультимедиа.

When creating one of this or data_ref must be set to specify the source of the media item.

If source_url was used when creating a media item, it will be populated with that source URL when the media item is retrieved.

Это поле не может быть обновлено.

data_ref

MediaItemDataRef

Только ввод. A reference to media item binary data as obtained by the StartUploadMediaItemData method.

При создании медиа-элемента либо

sourceUrl

или

dataRef

должен быть установлен.

Атрибуция

Информация об авторстве для медиа-элементов клиента, например имя автора и изображение профиля.

Поля
profile_name

string

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

profile_photo_url

string

URL миниатюры фотографии профиля связанного пользователя.

takedown_url

string

URL-адрес страницы удаления, на которой можно сообщить о неприемлемом медиа-элементе.

profile_url

string

URL-адрес страницы профиля Google Maps связанного пользователя.

Размеры

Размеры медиа-объекта.

Поля
width_pixels

int32

Ширина медиа-элемента в пикселях.

height_pixels

int32

Высота мультимедийного элемента в пикселях.

МестоположениеАссоциация

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

Поля
Поле объединения location_attachment_type . Носители местоположения должны иметь категорию или идентификатор элемента прайс-листа, с которым они связаны. Средства массовой информации, не относящиеся к локации (например, фотографии местных постов), не должны иметь ни того, ни другого. location_attachment_type может быть только одним из следующих:
category

Category

Категория, к которой принадлежит это фото места.

price_list_item_id

string

Идентификатор позиции прайс-листа, с которой связана эта фотография местоположения.

Категория

Перечисление для категории медиа-элемента.

Перечисления
CATEGORY_UNSPECIFIED Неуказанная категория.
COVER Фото на обложке. У локации есть только одна обложка.
PROFILE Аватар. У каждого местоположения есть только одна фотография профиля.
EXTERIOR Внешние СМИ.
INTERIOR Внутренние СМИ.
PRODUCT Продуктовые носители.
AT_WORK «Действующие» СМИ.
FOOD_AND_DRINK СМИ о еде и напитках.
MENU Меню медиа.
COMMON_AREA Средства массовой информации общего пользования.
ROOMS Номера СМИ.
TEAMS Медиа команд.
ADDITIONAL Дополнительные, неклассифицированные медиа.

Медиаформат

Перечисление для формата мультимедиа.

Перечисления
MEDIA_FORMAT_UNSPECIFIED Формат не указан.
PHOTO Медиа-элемент — фотография. В этой версии поддерживаются только фотографии.
VIDEO Медиа-элемент — видео.

МедиаИнсайтс

Аналитика и статистика по медиа-материалу.

Поля
view_count

int64

Только вывод. Сколько раз был просмотрен медиа-элемент.

Медиаитемдатареф

Ссылка на двоичные данные фотографии MediaItem , загруженные через API Google My Business.

Create a data ref using StartUploadMediaItemData , and use this ref when uploading bytes to [UpdateMedia] and subsequently calling CreateMediaItem .

Поля
resource_name

string

Уникальный идентификатор двоичных данных этого элемента мультимедиа. Used to upload the photo data with [UpdateMedia] and when creating a new media item from those bytes with CreateMediaItem .

Example of uploading bytes: curl -X POST -T{path_to_file} "http://mybusiness.googleapis.com/upload/v1/media/{resource_name}?upload_type=media"

For CreateMediaItem calls, set this as the MediaItem data_ref .

Label to be used when displaying the menu and its various sub-components.

Поля
display_name

string

Необходимый. Display name of the component.

description

string

Необязательный. Supplementary information of the component.

language_code

string

Необязательный. The BCP 47 code of language. If the language is not available, it will default to English.

Metric

A metric of data about a resource.

Перечисления
METRIC_UNSPECIFIED No metric specified.
ALL Shorthand to request all available metrics. Which metrics are included in ALL varies, and depends on the resource for which insights are being requested.
QUERIES_DIRECT The number of times the resource was shown when searching for the location directly.
QUERIES_INDIRECT The number of times the resource was shown as a result of a categorical search (for example, restaurant).
QUERIES_CHAIN The number of times a resource was shown as a result of a search for the chain it belongs to, or a brand it sells. For example, Starbucks, Adidas. This is a subset of QUERIES_INDIRECT.
VIEWS_MAPS The number of times the resource was viewed on Google Maps.
ACTIONS_WEBSITE The number of times the website was clicked.
ACTIONS_PHONE The number of times the phone number was clicked.
ACTIONS_DRIVING_DIRECTIONS The number of times driving directions were requested.
PHOTOS_VIEWS_MERCHANT The number of views on media items uploaded by the merchant.
PHOTOS_VIEWS_CUSTOMERS The number of views on media items uploaded by customers.
PHOTOS_COUNT_MERCHANT The total number of media items that are currently live that have been uploaded by the merchant.
PHOTOS_COUNT_CUSTOMERS The total number of media items that are currently live that have been uploaded by customers.
LOCAL_POST_VIEWS_SEARCH The number of times the local post was viewed on Google Search.
LOCAL_POST_ACTIONS_CALL_TO_ACTION The number of times the call to action button was clicked on Google.

MetricOption

Option to specify how data should be displayed in the response.

Перечисления
METRIC_OPTION_UNSPECIFIED No metric option specified. Will default to AGGREGATED_TOTAL in a request.
AGGREGATED_TOTAL Return values aggregated over the entire time frame. Это значение по умолчанию.
AGGREGATED_DAILY Return daily timestamped values across time range.
BREAKDOWN_DAY_OF_WEEK Values will be returned as a breakdown by day of the week. Only valid for ACTIONS_PHONE.
BREAKDOWN_HOUR_OF_DAY Values will be returned as a breakdown by hour of the day. Only valid for ACTIONS_PHONE.

MetricRequest

A request to return values for one metric and the options for how those values should be returned.

Поля
metric

Metric

The requested metric.

options[]

MetricOption

How the values should appear when returned.

MetricValue

A value for a single Metric from a starting time.

Поля
metric

Metric

The metric for which the value applies.

total_value

DimensionalMetricValue

The total aggregated value for this metric. Set for the AGGREGATED_TOTAL option.

dimensional_values[]

DimensionalMetricValue

Dimensional values for this metric.

MoreHours

The time periods during which a location is open for certain types of business.

Поля
hours_type_id

string

Необходимый. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations.

periods[]

TimePeriod

Необходимый. A collection of times that this location is open. Each period represents a range of hours when the location is open during the week.

MoreHoursType

More hours types that a business can offers, in addition to its regular hours.

Поля
hours_type_id

string

Только вывод. A stable ID provided by Google for this hours type.

display_name

string

Только вывод. The human-readable English display name for the hours type.

localized_display_name

string

Только вывод. The human-readable localized display name for the hours type.

NetworkState

The state of an insurance network regarding this location.

Перечисления
NETWORK_STATE_UNSPECIFIED Значение по умолчанию.
ACCEPTED This network is accepted by this location.
PENDING_ADD There is a pending request to add this network to the accepted list.
PENDING_DELETE There is a pending request to remove this network from the accepted list.
NOT_ACCEPTED This network is not accepted by this location.

NotificationType

Type of notification sent to the Cloud Pub/Sub topic.

Перечисления
NOTIFICATION_TYPE_UNSPECIFIED No notification type. Will not match any notifications.
GOOGLE_UPDATE The location has Google updates for review. The location_name field on the notification will provide the resource name of the location with Google updates.
NEW_REVIEW A new review has been added to the location. The review_name field on the notification will provide the resource name of the review that was added, and location_name will have the location's resource name.
UPDATED_REVIEW A review on the location has been updated. The review_name field on the notification will provide the resource name of the review that was added, and location_name will have the location's resource name.
NEW_CUSTOMER_MEDIA A new media item has been added to the location by a Google Maps user. The notification will provide the resource name of the new media item.
NEW_QUESTION A new question is added to the location. The notification will provide the resource name of question.
UPDATED_QUESTION A question of the location is updated. The notification will provide the resource name of question.
NEW_ANSWER A new answer is added to the location. The notification will provide the resource name of question and answer.
UPDATED_ANSWER An answer of the location is updated. The notification will provide the resource name of question and answer.
UPDATED_LOCATION_STATE The LocationState of the Location was updated. The Notification will contain the field mask of the updated LocationState fields.

Уведомления

A Google Cloud Pub/Sub topic where notifications can be published when a location is updated or has a new review. There will be only one notification settings resource per-account.

Поля
name

string

Только вывод. The notifications resource name.

topic_name

string

The Google Cloud Pub/Sub topic that will receive notifications when locations managed by this account are updated. If unset, no notifications will be posted.

The account mybusiness-api-pubsub@system.gserviceaccount.com must have at least Publish permissions on the Cloud Pub/Sub topic.

notification_types[]

NotificationType

The types of notifications that will be sent to the Cloud Pub/Sub topic. At least one must be specified. To stop receiving notifications entirely, use DeleteNotifications .

Пищевая ценность

This message represents nutrition facts for a food dish.

Поля
calories

CaloriesFact

Необязательный. Calories of the dish.

total_fat

NutritionFact

Необязательный. Fat information for a given food dish.

cholesterol

NutritionFact

Необязательный. Cholesterol information for a given food dish.

sodium

NutritionFact

Необязательный. Sodium information for a given food dish.

total_carbohydrate

NutritionFact

Необязательный. Carbohydrate information for a given food dish.

protein

NutritionFact

Необязательный. Protein information for a given food dish.

CaloriesFact

This message denotes calories information with an upper bound and lower bound range. Lower amount must be specified. Both lower and upper amounts are non-negative numbers.

Поля
lower_amount

int32

Необходимый. Lower amount of calories

upper_amount

int32

Необязательный. Upper amount of calories

unit

EnergyUnit

Необходимый. Unit of the given calories information.

EnergyUnit

Possible units of food energy (calories).

Перечисления
ENERGY_UNIT_UNSPECIFIED Energy unit unspecified
CALORIE Калорийность
JOULE Джоуль

MassUnit

Possible units of mass.

Перечисления
MASS_UNIT_UNSPECIFIED Mass unit unspecified
GRAM Gram
MILLIGRAM Миллиграмм

NutritionFact

This message denotes nutrition information with an upper bound and lower bound range and can be represented by mass unit. Lower amount must be specified. Both lower and upper amounts are non-negative numbers.

Поля
lower_amount

double

Необходимый. Lower amount of nutrition

upper_amount

double

Необязательный. Upper amount of nutrition

unit

MassUnit

Необходимый. Unit of the given nutrition information.

OpenInfo

Information related to the opening state of the business.

Поля
status

OpenForBusiness

Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed.

can_reopen

bool

Только вывод. Indicates whether this business is eligible for re-open.

opening_date

Date

The date on which the location first opened. If the exact day is not known, month and year only can be provided. The date must be in the past or be no more than one year in the future.

Открыт для бизнеса

Indicates the status of a location.

Перечисления
OPEN_FOR_BUSINESS_UNSPECIFIED Не указан.
OPEN Indicates that the location is open.
CLOSED_PERMANENTLY Indicates that the location has been permanently closed.
CLOSED_TEMPORARILY Indicates that the location has been temporarily closed. This value may only be applied to published locations (ie location_state.is_published = true). When updating the status field to this value, clients are required to set the update_mask explicitly to open_info.status . No other update masks can be set during this update call. This is a temporary restriction which will be relaxed soon.

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

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

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

PhoneInput

Input for PHONE_CALL/SMS verification.

Поля
phone_number

string

The phone number that should be called or be sent SMS to. It must be one of the phone numbers in the eligible options.

PlaceInfo

Defines an area that's represented by a place ID.

Поля
name

string

The localized name of the place. For example, Scottsdale, AZ .

place_id

string

The ID of the place. Must correspond to a region.

Места

Defines the union of areas represented by a set of places.

Поля
place_infos[]

PlaceInfo

The areas represented by place IDs. Limited to a maximum of 20 places.

PointRadius

A radius around a particular point (latitude/longitude).

Поля
latlng

LatLng

The latitude/longitude that specifies the center of an area defined by the radius.

radius_km

float

The distance in kilometers of the area around the point.

PreparationMethod

Preparation method of a food dish.

Перечисления
PREPARATION_METHOD_UNSPECIFIED Preparation method unspecified
BAKED Baked method
BARBECUED Barbecued method
BASTED Basted method
BLANCHED Blanched method
BOILED Boiled method
BRAISED Braised method
CODDLED Coddled method
FERMENTED Fermented method
FRIED Fried method
GRILLED Grilled method
KNEADED Kneaded method
MARINATED Marinated method
PAN_FRIED Pan fried method
PICKLED Pickled method
PRESSURE_COOKED Pressure cooked method
ROASTED Roasted method
SAUTEED Sauteed method
SEARED Seared method
SIMMERED Simmered method
SMOKED Smoked method
STEAMED Steamed method
STEEPED Steeped method
STIR_FRIED Stir fried method
OTHER_METHOD Other method

PriceList

Deprecated: A list of item price information. Price lists are structured as one or more price lists, each containing one or more sections with one or more items. For example, food price lists may represent breakfast/lunch/dinner menus, with sections for burgers/steak/seafood.

Поля
price_list_id

string

Необходимый. ID for the price list. Price list, section, and item IDs cannot be duplicated within this Location.

labels[]

Label

Необходимый. Language-tagged labels for the price list.

source_url

string

Optional source URL of where the price list was retrieved from. For example, this could be the URL of the page that was automatically scraped to populate the menu information.

sections[]

Section

Необходимый. Sections for this price list. Each price list must contain at least one section.

Этикетка

Label to be used when displaying the price list, section, or item.

Поля
display_name

string

Необходимый. Display name for the price list, section, or item.

description

string

Необязательный. Description of the price list, section, or item.

language_code

string

Необязательный. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language.

Раздел

A section of the price list containing one or more items.

Поля
section_id

string

Необходимый. ID for the section. Price list, section, and item IDs cannot be duplicated within this Location.

labels[]

Label

Необходимый. Language-tagged labels for the section. We recommend that section names and descriptions be 140 characters or less. At least one set of labels is required.

section_type

SectionType

Необязательный. Type of the current price list section. Default value is FOOD.

items[]

Item

Items that are contained within this section of the price list.

Элемент

A single list item. Each variation of an item in the price list should have its own Item with its own price data.

Поля
item_id

string

Необходимый. ID for the item. Price list, section, and item IDs cannot be duplicated within this Location.

labels[]

Label

Необходимый. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. At least one set of labels is required.

price

Money

Необязательный. Price of the item.

SectionType

Type of the section.

Перечисления
SECTION_TYPE_UNSPECIFIED Не указан.
FOOD Section contains items that represent food.
SERVICES Section contains items that represent services.

Профиль

All information pertaining to the location's profile.

Поля
description

string

Description of the location in your own voice, not editable by anyone else.

Вопрос

Represents a single question and some of its answers.

Поля
name

string

Только вывод. The unique name for the question. accounts/*/locations/*/questions/*

author

Author

Только вывод. The author of the question.

upvote_count

int32

Только вывод. The number of upvotes for the question.

text

string

The text of the question. It should contain at least three words and the total length should be greater than or equal to 10 characters. The maximum length is 4096 characters.

create_time

Timestamp

Только вывод. The timestamp for when the question was written.

update_time

Timestamp

Только вывод. The timestamp for when the question was last modified.

top_answers[]

Answer

Только вывод. A list of answers to the question, sorted by upvotes. This may not be a complete list of answers depending on the request parameters (answers_per_question)

total_answer_count

int32

Только вывод. The total number of answers posted for this question.

RepeatedEnumAttributeValue

Values for an attribute with a value_type of REPEATED_ENUM. This consists of two lists of value IDs: those that are set (true) and those that are unset (false). Values absent are considered unknown. At least one value must be specified.

Поля
set_values[]

string

Enum values that are set.

unset_values[]

string

Enum values that are unset.

ReportGoogleLocationRequest

Request message for reporting a GoogleLocation .

Поля
name

string

Resource name of a [GoogleLocation], in the format googleLocations/{googleLocationId} .

location_group_name

string

Необязательный. The resource name of the location group that this Google Location is being reported for, in the format accounts/{account_id} .

report_reason_elaboration

string

Необязательный. A text entry for elaborating on the reason for which the user is reporting this location. The maximum length is 512 characters.

report_reason_language_code

string

Необязательный. The BCP 47 code of language used in report_reason_elaboration .

Union field report_reason . Reason why this location is being reported. A reason must be provided. report_reason can be only one of the following:
report_reason_bad_location

BadLocationReason

The reason for which the user is reporting this location when the issue is with the location itself.

report_reason_bad_recommendation

BadRecommendationReason

The reason for which the user is reporting this location when the issue is with the recommendation. This report is useful if the location has been recommended to the Business Profile account.

BadLocationReason

A set of possible reasons for reporting a location when there is an issue with the quality of data in the location itself.

Перечисления
BAD_LOCATION_REASON_UNSPECIFIED Не указан.
NOT_A_LOCATION The recommended location is not an actual location.
PERMANENTLY_CLOSED The recommended location is permanently closed.
DOES_NOT_EXIST The recommended location does not exist.
SPAM The recommended location is spam, fake or offensive.
NOT_A_BUSINESS The recommended location is a private place or home.
MOVED

The recommended location has moved to a new location.

Should be accompanied by a report_reason_elaboration specifying the new address.

DUPLICATE The recommended location is a duplicate of another location.

BadRecommendationReason

A set of possible reasons for reporting a location when there is an issue with the quality of recommendation (when this location is recommended to the user).

Перечисления
BAD_RECOMMENDATION_REASON_UNSPECIFIED Не указан.
NOT_A_STORE_FRONT The recommended location is not a store front.
NOT_PART_OF_SUGGESTED_CHAIN

The recommended location doesn't belong to the chain suggested in the chain_display_name in the returned location.

Should be accompanied by a report_reason_elaboration specifying the name of the correct chain.

IRRELEVANT

The recommended location is not relevant to the user.

Should be accompanied by a report_reason_elaboration for why the recommendation is irrelevant.

ReportLocalPostInsightsRequest

Request message for Insights.ReportLocalPostInsights

Поля
name

string

Необходимый. The name of the location for which to fetch insights.

local_post_names[]

string

Необходимый. The list of posts for which to fetch insights data. All posts have to belong to the location whose name is specified in the name field.

basic_request

BasicMetricsRequest

A request to include basic metric insights in the report. This request applies to all posts requested.

ReportLocalPostInsightsResponse

Response message for Insights.ReportLocalPostInsights

Поля
name

string

local_post_metrics[]

LocalPostMetrics

One entry per requested post corresponding to this location.

time_zone

string

Time zone (IANA timezone IDs, eg, 'Europe/London') of the location.

ReportLocationInsightsRequest

Request message for Insights.ReportLocationInsights.

Поля
name

string

The account resource name.

location_names[]

string

A collection of locations to fetch insights for, specified by their names.

basic_request

BasicMetricsRequest

A request to include basic metric insights in the report.

driving_directions_request

DrivingDirectionMetricsRequest

A request to include insights about driving-direction requests in the report.

ReportLocationInsightsResponse

Response message for Insights.ReportLocationInsights .

Поля
location_metrics[]

LocationMetrics

A collection of metric values by location.

location_driving_direction_metrics[]

LocationDrivingDirectionMetrics

A collection of values for driving direction-related metrics.

Обзор

Только вывод. Represents a review for a location.

Поля
name

string

Имя ресурса. For Review it is of the form accounts/{account_id}/locations/{location_id}/reviews/{review_id}

review_id

string

The encrypted unique identifier.

reviewer

Reviewer

The author of the review.

star_rating

StarRating

The star rating of the review.

comment

string

The body of the review as plain text with markups.

create_time

Timestamp

The timestamp for when the review was written.

update_time

Timestamp

The timestamp for when the review was last modified.

review_reply

ReviewReply

The owner/manager of this location's reply to this review.

Рецензент

Represents the author of the review.

Поля
profile_photo_url

string

The profile photo link of the reviewer. Only populated if is_anonymous is false.

display_name

string

The name of the reviewer. Only populated with the reviewer's real name if is_anonymous is false.

is_anonymous

bool

Indicates whether the reviewer has opted to remain anonymous.

Звездный рейтинг

The star rating out of five, where five is the highest rated.

Перечисления
STAR_RATING_UNSPECIFIED Не указан.
ONE One star out of a maximum of five.
TWO Two stars out of a maximum of five.
THREE Three stars out of a maximum of five.
FOUR Four stars out of a maximum of five.
FIVE The maximum star rating.

ReviewReply

Represents the location owner/manager's reply to a review.

Поля
comment

string

The body of the reply as plain text with markups. The maximum length is 4096 bytes.

update_time

Timestamp

Только вывод. The timestamp for when the reply was last modified.

SearchChainsRequest

Request message for Locations.SearchChains.

Поля
chain_display_name

string

Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: "walmart", "wal-mart", "walmmmart", "沃尔玛"

result_count

int32

The maximum number of matched chains to return from this query. The default is 10. The maximum possible value is 500.

SearchChainsResponse

Response message for Locations.SearchChains.

Поля
chains[]

Chain

Chains that match the queried chain_display_name in SearchChainsRequest. If there are no matches, this field will be empty. Results are listed in order of relevance.

SearchGoogleLocationsRequest

Request message for GoogleLocations.SearchGoogleLocations.

Поля
result_count

int32

The number of matches to return. The default value is 3, with a maximum of 10. Note that latency may increase if more are requested. There is no pagination.

Union field search_query . Поисковый запрос. This can be provided either as a location object or as a string query. search_query can be only one of the following:
location

Location

Location to search for. If provided, will find locations which match the provided location details.

query

string

Text query to search for. The search results from a query string will be less accurate than if providing an exact location, but can provide more inexact matches.

SearchGoogleLocationsResponse

Response message for GoogleLocations.SearchGoogleLocations.

Поля
google_locations[]

GoogleLocation

A collection of GoogleLocations that are potential matches to the specified request, listed in order from most to least accuracy.

ServiceAreaBusiness

Service area businesses provide their service at the customer's location (for example, a locksmith or plumber).

Поля
business_type

BusinessType

Indicates the type of the service area business.

Union field coverageArea . Indicates the coverage area where the business offers service. coverageArea can be only one of the following:
radius

PointRadius

Только вывод. The area that this business serves centered around a point.

places

Places

The area that this business serves defined through a set of places.

Вид бизнеса

Indicates whether this business only offers services onsite at a customer location (for example, a tow truck), or at both an address and onsite (for example, a pizza store with a dining area, that also delivers to customers).

Перечисления
BUSINESS_TYPE_UNSPECIFIED Только вывод. Не указан.
CUSTOMER_LOCATION_ONLY Offers service only in the surrounding area (not at the business address).
CUSTOMER_AND_BUSINESS_LOCATION Offers service at the business address and the surrounding area.

ServiceBusinessContext

Additional data for service business verification.

Поля
address

PostalAddress

The verification address of the location. It is used to either enable more verification options or send a postcard.

Перечень услуг

A service list containing one or more service items.

Поля
name

string

Необходимый. Google identifier for this location in the form: accounts/{account_id}/locations/{location_id}/serviceList

service_items[]

ServiceItem

Service items that are contained within this service list. Duplicated service items will be removed automatically.

ServiceItem

A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.

Поля
is_offered

bool

Необязательный. This field decides whether or not the input service is offered by the merchant.

price

Money

Необязательный. Represents the monetary price of the service item. We recommend that currency_code and units should be set when including a price.

Union field service_item_info . One of the following fields should always be set. service_item_info can be only one of the following:
structured_service_item

StructuredServiceItem

This field will be set case of structured services data.

free_form_service_item

FreeFormServiceItem

This field will be set case of free-form services data.

FreeFormServiceItem

Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for of such services via a geomerchant surface.

Поля
category_id

string

Необходимый. The category_id and service_type_id should match the possible combinations provided in the Category message.

label

Label

Необходимый. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated via service_type_id.

StructuredServiceItem

Represents a structured service offered by the merchant. For eg: toilet_installation.

Поля
service_type_id

string

Необходимый. The service_type_id field is a Google provided unique ID that can be found in ServiceTypeMetadata . This information is provided by BatchGetBusinessCategories rpc service.

description

string

Необязательный. Description of structured service item. The character limit is 300.

Тип Обслуживания

A message describing a service type that the business offers.

Поля
service_type_id

string

Только вывод. A stable ID (provided by Google) for this service type.

display_name

string

Только вывод. The human-readable display name for the service type.

SpecialHourPeriod

Represents a single time period when a location's operational hours differ from its normal business hours. A special hour period must represent a range of less than 24 hours. The open_time and start_date must predate the close_time and end_date . The close_time and end_date can extend to 11:59 am on the day after the specified start_date . For example, the following inputs are valid:

start_date=2015-11-23, open_time=08:00, close_time=18:00
start_date=2015-11-23, end_date=2015-11-23, open_time=08:00,
close_time=18:00 start_date=2015-11-23, end_date=2015-11-24,
open_time=13:00, close_time=11:59

The following inputs are not valid:

start_date=2015-11-23, open_time=13:00, close_time=11:59
start_date=2015-11-23, end_date=2015-11-24, open_time=13:00,
close_time=12:00 start_date=2015-11-23, end_date=2015-11-25,
open_time=08:00, close_time=18:00
Поля
start_date

Date

The calendar date this special hour period starts on.

open_time

string

The wall time on start_date when a location opens, expressed in 24hr ISO 8601 extended format. (hh:mm) Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if is_closed is false.

end_date

Date

The calendar date this special hour period ends on. If end_date field is not set, default to the date specified in start_date . If set, this field must be equal to or at most 1 day after start_date .

close_time

string

The wall time on end_date when a location closes, expressed in 24hr ISO 8601 extended format. (hh:mm) Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if is_closed is false.

is_closed

bool

If true, end_date , open_time , and close_time are ignored, and the date specified in start_date is treated as the location being closed for the entire day.

SpecialHours

Represents a set of time periods when a location's operational hours differ from its normal business hours.

Поля
special_hour_periods[]

SpecialHourPeriod

A list of exceptions to the business's regular hours.

Spiciness

The spiciness level of a food item.

Перечисления
SPICINESS_UNSPECIFIED Level unspecified
MILD Denotion of mild spicy.
MEDIUM Denotion of medium spicy.
HOT Denotion of hot spicy. The most spiciest level.

StartUploadMediaItemDataRequest

Request message for Media.StartUploadMediaItemData.

Поля
parent

string

The resource name of the location this media item is to be added to.

Временной интервал

An interval of time, inclusive. It must contain all fields to be valid.

Поля
start_date

Date

The start date of this period.

start_time

TimeOfDay

The start time of this period.

end_date

Date

The end date of this period.

end_time

TimeOfDay

The end time of this period.

Временной период

Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.

Поля
open_day

DayOfWeek

Indicates the day of the week this period starts on.

open_time

string

Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field.

close_day

DayOfWeek

Indicates the day of the week this period ends on.

close_time

string

Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field.

Временной диапазон

A range of time. Data will be pulled over the range as a half-open inverval (that is, [start_time, end_time)).

Поля
start_time

Timestamp

Epoch timestamp for the start of the range (inclusive).

end_time

Timestamp

Epoch timestamp for the end of the range (exclusive).

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

Request message for Locations.TransferLocation.

Поля
name

string

Имя места для переноса.

to_account

string

Name of the account resource to transfer the location to (for example, "accounts/8675309").

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

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

Поля
name

string

The resource name of the admin to update.

admin

Admin

The updated admin. Note: The only editable field is role . All other fields are ignored.

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

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

Поля
name

string

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

account

Account

The updated account information. Note: The only editable field is account_name .

validate_only

bool

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

UpdateFoodMenusRequest

Request message for FoodMenu.UpdateFoodMenus

Поля
food_menus

FoodMenus

Необходимый. The updated food menu information. Menu can be unset by updating without any menu sections.

update_mask

FieldMask

Необязательный. Конкретные поля для обновления. Если маска не указана, это рассматривается как полное обновление, и всем полям присваиваются переданные значения, что может включать в себя снятие пустых полей в запросе. Repeated field items can not be individually updated. Note: "name" of FoodMenus is the resource identifier which is not updatable.

UpdateHealthProviderAttributesRequest

Request message for HealthProviderAttributes.UpdateHealthProviderAttributes

Поля
health_provider_attributes

HealthProviderAttributes

Необходимый. The updated health provider attributes.

update_mask

FieldMask

Необязательный. Конкретные поля для обновления. Если маска не указана, это рассматривается как полное обновление, и всем полям присваиваются переданные значения, что может включать в себя снятие пустых полей в запросе. In V1, there is only the insurance_networks field to update. Дополнительные атрибуты будут поддерживаться позже.

UpdateLocalPostRequest

Request message for UpdateLocalPost.

Поля
name

string

The name of the local post to update.

local_post

LocalPost

The updated local post information.

update_mask

FieldMask

Конкретные поля для обновления. You must specify each field that is being updated in the mask.

ОбновлениеLocationAdminRequest

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

Поля
name

string

The resource name of the admin to update.

admin

Admin

The updated admin. Note: The only editable field is role . All other fields are ignored.

UpdateLocationRequest

Request message for Locations.UpdateLocation.

Поля
name

string

The name of the location to update.

location

Location

The updated location information.

update_mask

FieldMask

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

validate_only

bool

If true, the request is validated without actually updating the location.

attribute_mask

FieldMask

The IDs of the attributes to update. Only attributes noted in the mask will be updated. If an attribute is present in the mask and not in the location, it will be removed. An empty mask will update all attributes.

Whenever this field is set, the update_mask should include attributes as one of the fields to update.

UpdateMediaItemRequest

Request message for Media.UpdateMediaItem.

Поля
name

string

The name of the media item to be updated.

media_item

MediaItem

The media item to be updated.

Only the category or price list item id can be updated.

update_mask

FieldMask

Конкретные поля для обновления. If no mask is specified, then this is treated as a full update and all editable fields are set to the values passed in.

UpdateNotificationsRequest

Request message for Accounts.UpdateNotifications.

Поля
name

string

The notification settings resource name.

notifications

Notifications

The updated notification settings.

UpdateQuestionRequest

Request message for QuestionsAndAnswers.UpdateQuestion

Поля
name

string

The name of the question to update.

question

Question

The updated question.

UpdateReviewReplyRequest

Request message for Reviews.UpdateReviewReply.

Поля
name

string

The name of the review to respond to.

review_reply

ReviewReply

The reply to the review. If a reply already exists, this will replace the old reply.

UpdateServiceListRequest

Update service list request message.

Поля
service_list

ServiceList

Необязательный. The updated service list information. If leave this field empty, the api will delete the ServiceList. If a ServiceList is set, the api will replace the original ServiceList with the set one.

update_mask

FieldMask

Необязательный. Конкретные поля для обновления. Если маска не указана, это рассматривается как полное обновление, и всем полям присваиваются переданные значения, что может включать в себя снятие пустых полей в запросе. Repeated field items can not be individually updated.

UpsertAnswerRequest

Request message for QuestionsAndAnswers.UpsertAnswer

Поля
parent

string

The name of the question to write an answer for.

answer

Answer

The new answer.

UrlAttributeValue

Values for an attribute with a value_type of URL.

Поля
url

string

URL-адрес.

Ошибка проверки

Describes validation failures in a client request.

Поля
error_details[]

ErrorDetail

Details individual validation failures with integer error codes.

Проверка

A verification represents a verification attempt on a location.

Поля
name

string

Resource name of the verification.

method

VerificationMethod

The method of the verification.

state

VerificationState

The state of the verification.

create_time

Timestamp

The timestamp when the verification is requested.

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

All possible verification states.

Перечисления
VERIFICATION_STATE_UNSPECIFIED Default value, will result in errors.
PENDING The verification is pending.
COMPLETED The verification is completed.
FAILED The verification is failed.

VerificationMethod

Specifies the processes used by Google to verify a location.

Перечисления
VERIFICATION_METHOD_UNSPECIFIED Default value, will result in errors.
ADDRESS Send a postcard with a verification PIN to a specific mailing address. The PIN is used to complete verification with Google.
EMAIL Send an email with a verification PIN to a specific email address. The PIN is used to complete verification with Google.
PHONE_CALL Make a phone call with a verification PIN to a specific phone number. The PIN is used to complete verification with Google.
SMS Send an SMS with a verification PIN to a specific phone number. The PIN is used to complete verification with Google.
AUTO Verify the location without additional user action. This option may not be available for all locations.

VerificationOption

The verification option represents how to verify the location (indicated by verification method) and where the verification will be sent to (indicated by display data).

Поля
verification_method

VerificationMethod

Method to verify the location.

Union field DisplayData . One of the display data. The data must match the method. Empty if the corresponding method doesn't have any display data. DisplayData can be only one of the following:
phone_data

PhoneVerificationData

Set only if the method is PHONE_CALL or SMS.

address_data

AddressVerificationData

Set only if the method is MAIL.

email_data

EmailVerificationData

Set only if the method is EMAIL.

AddressVerificationData

Display data for verifications through postcard.

Поля
business_name

string

Merchant's business name.

address

PostalAddress

Address that a postcard can be sent to.

EmailVerificationData

Display data for verifications through email.

Поля
domain_name

string

Domain name in the email address. eg "gmail.com" in foo@gmail.com

user_name

string

User name in the email address. eg "foo" in foo@gmail.com

is_user_name_editable

bool

Whether client is allowed to provide a different user name.

PhoneVerificationData

Display Data for verifications through phone, eg phone call, sms.

Поля
phone_number

string

Phone number that the PIN will be sent to.

VerifyLocationRequest

Request message for Verifications.VerifyLocation.

Поля
name

string

Resource name of the location to verify.

method

VerificationMethod

Verification method.

language_code

string

The BCP 47 language code representing the language that is to be used for the verification process.

context

ServiceBusinessContext

Extra context information for the verification of service businesses. Required for the locations whose business type is CUSTOMER_LOCATION_ONLY. For ADDRESS verification, the address will be used to send out postcard. For other methods, it should be the same as the one that is passed to FetchVerificationOptions. INVALID_ARGUMENT will be thrown if it is set for other types of business locations.

Union field RequestData . User input data for specific method in addition to the display data. The data must match the requested method. Leave it empty if no data is needed. RequestData can be only one of the following:
email_input

EmailInput

The input for EMAIL method.

address_input

AddressInput

The input for ADDRESS method.

phone_input

PhoneInput

The input for PHONE_CALL/SMS method

VerifyLocationResponse

Response message for Verifications.VerifyLocation.

Поля
verification

Verification

The created verification request.