Индекс
-
AccessControl
(интерфейс) (устарело) -
Accounts
(интерфейс) (устарело) -
BusinessCategories
(интерфейс) -
BusinessMessagingService
(интерфейс) -
Followers
(интерфейс) -
FoodMenuService
(интерфейс) -
GoogleLocations
(интерфейс) -
HealthProviderAttributesService
(интерфейс) -
Insights
(интерфейс) -
InsuranceNetworkService
(интерфейс) -
LocalPosts
(интерфейс) -
Locations
(интерфейс) -
Media
(интерфейс) -
QuestionsAndAnswers
(интерфейс) -
Reviews
(интерфейс) -
ServiceLists
(интерфейс) -
Verifications
(интерфейс) -
AcceptInvitationRequest
(сообщение) -
Account
(сообщение) (устарело) -
Account.OrganizationInfo
(сообщение) -
AccountRole
(перечисление) -
AccountState
(сообщение) -
AccountState.AccountStatus
(перечисление) -
AccountType
(перечисление) -
AdWordsLocationExtensions
(сообщение) -
AddressInput
(сообщение) -
Admin
(сообщение) -
Admin.AdminRole
(перечисление) -
AlertType
(перечисление) -
Allergen
(перечисление) -
Answer
(сообщение) -
AssociateLocationRequest
(сообщение) -
Attribute
(сообщение) -
AttributeMetadata
(сообщение) -
AttributeMetadata.AttributeValueMetadata
(сообщение) -
AttributeValueType
(перечисление) -
Author
(сообщение) -
Author.AuthorType
(перечисление) -
BasicMetricsRequest
(сообщение) -
BatchGetBusinessCategoriesRequest
(сообщение) -
BatchGetBusinessCategoriesResponse
(сообщение) -
BatchGetLocationsRequest
(сообщение) -
BatchGetLocationsResponse
(сообщение) -
BatchGetReviewsRequest
(сообщение) -
BatchGetReviewsResponse
(сообщение) -
BusinessHours
(сообщение) -
CallToAction
(сообщение) -
CallToAction.ActionType
(перечисление) -
Category
(сообщение) -
CategoryView
(перечисление) -
Chain
(сообщение) -
Chain.ChainName
(сообщение) -
Chain.ChainUrl
(сообщение) -
ClearLocationAssociationRequest
(сообщение) -
CompleteVerificationRequest
(сообщение) -
CompleteVerificationResponse
(сообщение) -
CreateAccountAdminRequest
(сообщение) -
CreateAccountRequest
(сообщение) -
CreateLocalPostRequest
(сообщение) -
CreateLocationAdminRequest
(сообщение) -
CreateLocationRequest
(сообщение) -
CreateMediaItemRequest
(сообщение) -
CreateQuestionRequest
(сообщение) -
DeclineInvitationRequest
(сообщение) -
DeleteAccountAdminRequest
(сообщение) -
DeleteAnswerRequest
(сообщение) -
DeleteLocalPostRequest
(сообщение) -
DeleteLocationAdminRequest
(сообщение) -
DeleteLocationRequest
(сообщение) -
DeleteMediaItemRequest
(сообщение) -
DeleteNotificationsRequest
(сообщение) -
DeleteQuestionRequest
(сообщение) -
DeleteReviewReplyRequest
(сообщение) -
DietaryRestriction
(перечисление) -
DimensionalMetricValue
(сообщение) -
DimensionalMetricValue.TimeDimension
(сообщение) -
DrivingDirectionMetricsRequest
(сообщение) -
DrivingDirectionMetricsRequest.NumDays
(перечисление) -
EmailInput
(сообщение) -
ErrorDetail
(сообщение) -
ErrorDetail.ErrorCode
(перечисление) -
FetchVerificationOptionsRequest
(сообщение) -
FetchVerificationOptionsResponse
(сообщение) -
FindMatchingLocationsRequest
(сообщение) -
FindMatchingLocationsResponse
(сообщение) -
FollowersMetadata
(сообщение) -
FoodMenu
(сообщение) -
FoodMenu.Cuisine
(перечисление) -
FoodMenuItem
(сообщение) -
FoodMenuItemAttributes
(сообщение) -
FoodMenuItemAttributes.Ingredient
(сообщение) -
FoodMenuItemAttributes.PortionSize
(сообщение) -
FoodMenuItemOption
(сообщение) -
FoodMenuSection
(сообщение) -
FoodMenus
(сообщение) -
GenerateAccountNumberRequest
(сообщение) -
GetAccountRequest
(сообщение) -
GetChainRequest
(сообщение) -
GetCustomerMediaItemRequest
(сообщение) -
GetFollowersMetadataRequest
(сообщение) -
GetFoodMenusRequest
(сообщение) -
GetHealthProviderAttributesRequest
(сообщение) -
GetLocalPostRequest
(сообщение) -
GetLocationRequest
(сообщение) -
GetMediaItemRequest
(сообщение) -
GetNotificationsRequest
(сообщение) -
GetReviewRequest
(сообщение) -
GetServiceListRequest
(сообщение) -
GoogleLocation
(сообщение) -
GoogleUpdatedLocation
(сообщение) -
HealthProviderAttributes
(сообщение) -
InsuranceNetwork
(сообщение) -
InternalError
(сообщение) -
Invitation
(сообщение) -
Invitation.TargetLocation
(сообщение) -
ListAccountAdminsRequest
(сообщение) -
ListAccountAdminsResponse
(сообщение) -
ListAccountsRequest
(сообщение) -
ListAccountsResponse
(сообщение) -
ListAnswersRequest
(сообщение) -
ListAnswersResponse
(сообщение) -
ListAttributeMetadataRequest
(сообщение) -
ListAttributeMetadataResponse
(сообщение) -
ListBusinessCategoriesRequest
(сообщение) -
ListBusinessCategoriesResponse
(сообщение) -
ListCustomerMediaItemsRequest
(сообщение) -
ListCustomerMediaItemsResponse
(сообщение) -
ListInsuranceNetworksRequest
(сообщение) -
ListInsuranceNetworksResponse
(сообщение) -
ListInvitationsRequest
(сообщение) -
ListInvitationsRequest.TargetType
(перечисление) -
ListInvitationsResponse
(сообщение) -
ListLocalPostsRequest
(сообщение) -
ListLocalPostsResponse
(сообщение) -
ListLocationAdminsRequest
(сообщение) -
ListLocationAdminsResponse
(сообщение) -
ListLocationsRequest
(сообщение) -
ListLocationsResponse
(сообщение) -
ListMediaItemsRequest
(сообщение) -
ListMediaItemsResponse
(сообщение) -
ListQuestionsRequest
(сообщение) -
ListQuestionsResponse
(сообщение) -
ListRecommendedGoogleLocationsRequest
(сообщение) -
ListRecommendedGoogleLocationsResponse
(сообщение) -
ListReviewsRequest
(сообщение) -
ListReviewsResponse
(сообщение) -
ListVerificationsRequest
(сообщение) -
ListVerificationsResponse
(сообщение) -
LocalPost
(сообщение) -
LocalPost.LocalPostState
(перечисление) -
LocalPostEvent
(сообщение) -
LocalPostMetrics
(сообщение) -
LocalPostOffer
(сообщение) -
LocalPostTopicType
(перечисление) -
Location
(сообщение) -
Location.Metadata
(сообщение) -
Location.Metadata.Duplicate
(сообщение) -
Location.Metadata.Duplicate.Access
(перечисление) -
Location.RelationshipData
(сообщение) -
LocationDrivingDirectionMetrics
(сообщение) -
LocationDrivingDirectionMetrics.TopDirectionSources
(сообщение) -
LocationDrivingDirectionMetrics.TopDirectionSources.RegionCount
(сообщение) -
LocationKey
(сообщение) -
LocationMetrics
(сообщение) -
LocationReview
(сообщение) -
LocationState
(сообщение) -
MatchedLocation
(сообщение) -
MediaItem
(сообщение) -
MediaItem.Attribution
(сообщение) -
MediaItem.Dimensions
(сообщение) -
MediaItem.LocationAssociation
(сообщение) -
MediaItem.LocationAssociation.Category
(перечисление) -
MediaItem.MediaFormat
(перечисление) -
MediaItem.MediaInsights
(сообщение) -
MediaItemDataRef
(сообщение) -
MenuLabel
(сообщение) -
Metric
(перечисление) -
MetricOption
(перечисление) -
MetricRequest
(сообщение) -
MetricValue
(сообщение) -
MoreHours
(сообщение) -
MoreHoursType
(сообщение) -
NetworkState
(перечисление) -
NotificationType
(перечисление) -
Notifications
(сообщение) -
NutritionFacts
(сообщение) -
NutritionFacts.CaloriesFact
(сообщение) -
NutritionFacts.EnergyUnit
(перечисление) -
NutritionFacts.MassUnit
(перечисление) -
NutritionFacts.NutritionFact
(сообщение) -
OpenInfo
(сообщение) -
OpenInfo.OpenForBusiness
(перечисление) -
PermissionLevel
(перечисление) -
PhoneInput
(сообщение) -
PlaceInfo
(сообщение) -
Places
(сообщение) -
PointRadius
(сообщение) -
PreparationMethod
(перечисление) -
PriceList
(сообщение) (устарело) -
PriceList.Label
(сообщение) -
PriceList.Section
(сообщение) -
PriceList.Section.Item
(сообщение) -
PriceList.Section.SectionType
(перечисление) -
Profile
(сообщение) -
Question
(сообщение) -
RepeatedEnumAttributeValue
(сообщение) -
ReportGoogleLocationRequest
(сообщение) -
ReportGoogleLocationRequest.BadLocationReason
(перечисление) -
ReportGoogleLocationRequest.BadRecommendationReason
(перечисление) -
ReportLocalPostInsightsRequest
(сообщение) -
ReportLocalPostInsightsResponse
(сообщение) -
ReportLocationInsightsRequest
(сообщение) -
ReportLocationInsightsResponse
(сообщение) -
Review
(сообщение) -
Review.Reviewer
(сообщение) -
Review.StarRating
(перечисление) -
ReviewReply
(сообщение) -
SearchChainsRequest
(сообщение) -
SearchChainsResponse
(сообщение) -
SearchGoogleLocationsRequest
(сообщение) -
SearchGoogleLocationsResponse
(сообщение) -
ServiceAreaBusiness
(сообщение) -
ServiceAreaBusiness.BusinessType
(перечисление) -
ServiceBusinessContext
(сообщение) -
ServiceList
(сообщение) -
ServiceList.ServiceItem
(сообщение) -
ServiceList.ServiceItem.FreeFormServiceItem
(сообщение) -
ServiceList.ServiceItem.StructuredServiceItem
(сообщение) -
ServiceType
(сообщение) -
SpecialHourPeriod
(сообщение) -
SpecialHours
(сообщение) -
Spiciness
(перечисление) -
StartUploadMediaItemDataRequest
(сообщение) -
TimeInterval
(сообщение) -
TimePeriod
(сообщение) -
TimeRange
(сообщение) -
TransferLocationRequest
(сообщение) -
UpdateAccountAdminRequest
(сообщение) -
UpdateAccountRequest
(сообщение) -
UpdateFoodMenusRequest
(сообщение) -
UpdateHealthProviderAttributesRequest
(сообщение) -
UpdateLocalPostRequest
(сообщение) -
UpdateLocationAdminRequest
(сообщение) -
UpdateLocationRequest
(сообщение) -
UpdateMediaItemRequest
(сообщение) -
UpdateNotificationsRequest
(сообщение) -
UpdateQuestionRequest
(сообщение) -
UpdateReviewReplyRequest
(сообщение) -
UpdateServiceListRequest
(сообщение) -
UpsertAnswerRequest
(сообщение) -
UrlAttributeValue
(сообщение) -
ValidationError
(сообщение) -
Verification
(сообщение) -
Verification.VerificationState
(перечисление) -
VerificationMethod
(перечисление) -
VerificationOption
(сообщение) -
VerificationOption.AddressVerificationData
(сообщение) -
VerificationOption.EmailVerificationData
(сообщение) -
VerificationOption.PhoneVerificationData
(сообщение) -
VerifyLocationRequest
(сообщение) -
VerifyLocationResponse
(сообщение)
Контроль доступа
Эта служба позволяет управлять пользователями, имеющими доступ к учетным записям и местоположениям.
Принять приглашение | |
---|---|
Принимает указанное приглашение.
|
СоздатьАккаунтАдминистратор | |
---|---|
Приглашает указанного пользователя стать администратором указанной учетной записи. Приглашенный должен принять приглашение, чтобы получить доступ к учетной записи. См. [AcceptInvitation] [google.mybusiness.v4.AcceptInvitation], чтобы программно принять приглашение.
|
СоздатьМестоположениеАдминистратор | |
---|---|
Приглашает указанного пользователя стать администратором указанного местоположения. Приглашенный должен принять приглашение, чтобы получить доступ к локации. См. [AcceptInvitation] [google.mybusiness.v4.AcceptInvitation], чтобы программно принять приглашение.
|
Отклонить приглашение | |
---|---|
Отклоняет указанное приглашение.
|
УдалитьАккаунтАдминистратор | |
---|---|
Удаляет указанного администратора из указанной учетной записи.
|
УдалитьМестоположениеАдминистратор | |
---|---|
Удаляет указанного администратора в качестве менеджера указанного местоположения.
|
СписокАдминистраторовАккаунта | |
---|---|
Перечисляет администраторов указанной учетной записи.
|
Список приглашений | |
---|---|
Перечисляет ожидающие приглашения для указанной учетной записи.
|
СписокМестоположениеАдминистраторы | |
---|---|
Список всех администраторов указанного местоположения.
|
ОбновлениеАккаунтАдминистратор | |
---|---|
Обновляет администратора для указанного администратора учетной записи. Обновить можно только роль AdminRole администратора.
|
ОбновлениеМестоположенияАдминистратор | |
---|---|
Обновляет администратора для указанного администратора местоположения. Обновить можно только роль AdminRole администратора.
|
Счета
Этот API позволяет управлять бизнес-аккаунтами в Google. Это позволяет вам управлять ресурсами Account
. Он определяет следующую модель ресурсов:
API имеет коллекцию ресурсов
Account
записи с именемaccounts/*
Для удобства вы можете использовать синоним «я» вместо идентификатора учетной записи для личной учетной записи аутентифицированного абонента. Примеры: GET /v4/accounts/me GET /v4/accounts/me/locations
Зарегистрироваться | |
---|---|
Создает учетную запись с указанным именем и типом под данным родителем.
|
Удалить уведомления | |
---|---|
Очищает настройки уведомлений pubsub для учетной записи.
|
Создать номер аккаунта | |
---|---|
Генерирует номер счета для этой учетной записи. Номер учетной записи не предоставляется при создании учетной записи. Используйте этот запрос, чтобы создать номер счета, когда это необходимо.
|
Получить аккаунт | |
---|---|
Получает указанную учетную запись. Возвращает
|
Получать уведомления | |
---|---|
Возвращает настройки уведомлений pubsub для учетной записи.
|
Список аккаунтов | |
---|---|
Перечисляет все учетные записи для аутентифицированного пользователя. Сюда входят все учетные записи, которыми владеет пользователь, а также любые учетные записи, для которых у пользователя есть права управления.
|
ОбновитьАккаунт | |
---|---|
Обновляет указанный бизнес-аккаунт. Личные аккаунты нельзя обновить этим способом.
|
Уведомления об обновлении | |
---|---|
Устанавливает настройки уведомлений pubsub для учетной записи, сообщая бизнес-профилю, по какой теме отправлять уведомления pubsub:
У учетной записи будет только один ресурс настроек уведомлений, и можно установить только одну тему pubsub.
|
БизнесКатегории
Этот API обеспечивает видимость поддерживаемых категорий для местоположений компаний в Google. Вы можете получить постраничные списки всех доступных бизнес-категорий или выполнить поиск по определенному термину. Справочную информацию см. в разделе «Категории» этой статьи: https://support.google.com/business/answer/3038177.
BatchGetBusinessCategories | |
---|---|
Возвращает список бизнес-категорий для указанного языка и идентификаторов GConcept.
|
СписокБизнесКатегории | |
---|---|
Возвращает список категорий бизнеса. Поиск будет соответствовать названию категории, но не ее идентификатору.
|
БизнесОбмен сообщениямиСервис
Позволяет компаниям регистрировать свои местоположения для обмена деловыми сообщениями, чтобы обеспечить канал связи с потребителями, которые ищут их местоположения. Чтобы просматривать деловые сообщения и выполнять действия с ними, вам необходимо быть MANAGER
или OWNER
этого местоположения.
Последователи
Этот API предоставляет API управления подписчиками.
GetFollowersMetadata | |
---|---|
Получите настройки подписчиков для определенного местоположения. NOT_FOUND возвращается, если учетная запись или местоположение не существует. PRECONDITION_FAILED возвращается, если местоположение не проверено и не подключено к Картам.
|
ЕдаМенюСервис
Этот API позволяет получать и обновлять меню блюд в торговых точках.
Обратите внимание, что Location.PriceList также представляет «меню» одного из своих типов, но с ограниченными полями. Он использует то же хранилище, что и FoodMenus. После завершения миграции на FoodMenuService клиентам настоятельно не рекомендуется больше использовать Location.PriceList для обновления данных меню, что может привести к неожиданной потере данных.
GetFoodМеню | |
---|---|
Возвращает меню блюд определенного места. Вызывайте это только в том случае, если location.location_state.can_have_food_menu имеет значение true.
|
ОбновлениеЕдаМеню | |
---|---|
Обновляет меню еды в определенном месте. Вызывайте это только в том случае, если location.location_state.can_have_food_menu имеет значение true.
|
GoogleМестаположения
Этот API обеспечивает доступ и поиск GoogleLocation
.
СписокрекомендуемыхGoogleМестоположения | |
---|---|
Перечислите все Рекомендации для личных учетных записей основаны на всех местоположениях, к которым у пользователя есть доступ в профиле компании (включая местоположения, к которым он может получить доступ через группы местоположений), и представляют собой расширенный набор всех рекомендаций, созданных для пользователя.
|
Сообщить о местоположении Google | |
---|---|
Сообщить о
|
ПоискGoogleМестоположения | |
---|---|
Найдите все возможные местоположения, соответствующие указанному запросу.
|
HealthProviderAttributesService
Эта услуга позволяет управлять атрибутами поставщика медицинских услуг (например, страховкой, принимаемой в данном месте), связанными с местоположением.
GetHealthProviderAttributes | |
---|---|
Возвращает атрибуты поставщика медицинских услуг для определенного местоположения.
|
ОбновлениеHealthProviderAttributes | |
---|---|
Обновляет атрибуты поставщика медицинских услуг для определенного местоположения.
|
Информация
Создает отчеты с подробным описанием потребительской информации для одного или нескольких объявлений в сервисах Google. Агрегированные данные по базовым показателям можно запрашивать за период до 18 месяцев. Метрики, поддерживающие разбивку, могут отображать агрегированные данные в этом диапазоне с разбивкой по дням недели или часам дня. Запросы направления движения могут быть представлены в виде снимков за выбранное количество дней.
ОтчетLocalPostInsights | |
---|---|
Возвращает информацию о наборе локальных публикаций, связанных с одним листингом. Какие метрики и как они сообщаются, являются параметрами, указанными в протоколе запроса.
|
ОтчетLocationInsights | |
---|---|
Возвращает отчет, содержащий информацию об одном или нескольких показателях по местоположению.
|
СтрахованиеСетьСервис
Эта услуга позволяет получить информацию обо всех поддерживаемых страховых сетях для предприятий здравоохранения в Google.
СписокСтраховых Сетей | |
---|---|
Возвращает список всех страховых сетей, поддерживаемых Google.
|
Локальные сообщения
Этот API предоставляет API управления локальными сообщениями.
СоздатьLocalPost | |
---|---|
Создает новую локальную публикацию, связанную с указанным местоположением, и возвращает ее.
|
Удалитьлокальный пост | |
---|---|
Удаляет локальную публикацию. Возвращает
|
GetLocalPost | |
---|---|
Получает указанное локальное сообщение. Возвращает
|
Список локальных сообщений | |
---|---|
Возвращает список локальных сообщений, связанных с местоположением.
|
ОбновлениеLocalPost | |
---|---|
Обновляет указанное локальное сообщение и возвращает обновленное локальное сообщение.
|
Локации
Этот API позволяет управлять местоположениями компаний в Google. Он позволяет вам управлять ресурсами Location
. Он определяет следующую модель ресурсов:
API имеет коллекцию ресурсов
Account
записи с именемaccounts/*
Для удобства вы можете использовать синоним «я» вместо идентификатора учетной записи для личной учетной записи аутентифицированного абонента. Примеры: GET /v4/accounts/me GET /v4/accounts/me/locations
Каждая
Account
имеет коллекцию ресурсовLocation
с именемaccounts/*/locations/*
Местонахождение партнера | |
---|---|
Связывает местоположение с идентификатором места. Любая предыдущая ассоциация перезаписывается. Эта операция действительна только в том случае, если местоположение не проверено. Ассоциация должна быть допустимой, то есть она отображается в списке
|
Пакетное получение местоположений | |
---|---|
Получает все указанные местоположения в данной учетной записи.
|
ClearLocationAssociation | |
---|---|
Очищает связь между местоположением и его идентификатором места. Эта операция действительна только в том случае, если местоположение не проверено.
|
Создать местоположение | |
---|---|
Создает новое
|
Удалить местоположение | |
---|---|
Удаляет местоположение. Возвращает
|
Найти соответствующие местоположения | |
---|---|
Находит все возможные местоположения, соответствующие указанному местоположению. Эта операция действительна только в том случае, если местоположение не проверено.
|
GetChain | |
---|---|
Получает указанную цепочку. Возвращает
|
GetGoogleUpdatedLocation | |
---|---|
Получает обновленную Google версию указанного местоположения. Возвращает
|
Получить местоположение | |
---|---|
Получает указанное расположение. Возвращает
|
ЛистАтрибутМетаданные | |
---|---|
Возвращает список доступных атрибутов, которые будут доступны для местоположения с заданной основной категорией и страной.
|
СписокМестоположений | |
---|---|
Перечисляет местоположения для указанной учетной записи.
|
Поисковые цепочки | |
---|---|
Ищет цепочку по названию цепочки.
|
ТрансферМестоположение | |
---|---|
Перемещает местоположение из учетной записи, принадлежащей пользователю, в другую учетную запись, которой управляет тот же пользователь. Пользователь должен быть владельцем учетной записи, с которой в данный момент связано местоположение, а также должен быть как минимум менеджером целевой учетной записи. Возвращает местоположение с новым именем ресурса.
|
ОбновитьМестоположение | |
---|---|
Обновляет указанное расположение. Фотографии разрешены только в местах, где есть страница Google+. Возвращает
|
СМИ
Эта услуга позволяет управлять медиафайлами (фото и видео), связанными с местоположением.
CreateMediaItem | |
---|---|
Создает новый элемент мультимедиа для местоположения.
|
Удалитьмедиаитем | |
---|---|
Удаляет указанный элемент мультимедиа.
|
GetCustomerMediaItem | |
---|---|
Возвращает метаданные для запрошенного клиентского медиа-элемента.
|
GetMediaItem | |
---|---|
Возвращает метаданные для запрошенного медиа-элемента.
|
ListCustomerMediaItems | |
---|---|
Возвращает список элементов мультимедиа, связанных с местоположением и предоставленных клиентами.
|
ListMediaItems | |
---|---|
Возвращает список медиа-элементов, связанных с местоположением.
|
StartUploadMediaItemData | |
---|---|
Создает
|
UpdateMediaItem | |
---|---|
Обновляет метаданные указанного элемента мультимедиа. Это можно использовать только для обновления категории элемента мультимедиа, за исключением того, что новая категория не может быть ОБЛОЖКА или ПРОФИЛЬ.
|
Вопросы и ответы
Эта услуга позволяет управлять вопросами и ответами о местоположении. Операции вопросов и ответов действительны только для проверенных местоположений.
Создать вопрос | |
---|---|
Добавляет вопрос для указанного места.
|
Удалитьответ | |
---|---|
Удаляет ответ, написанный текущим пользователем на вопрос.
|
Удалитьвопрос | |
---|---|
Удаляет конкретный вопрос, написанный текущим пользователем.
|
Список ответов | |
---|---|
Возвращает постраничный список ответов на указанный вопрос.
|
Список вопросов | |
---|---|
Возвращает постраничный список вопросов и некоторые ответы на него для указанного местоположения.
|
ОбновлениеВопрос | |
---|---|
Обновляет конкретный вопрос, написанный текущим пользователем.
|
Упсертответ | |
---|---|
Создает ответ или обновляет существующий ответ, написанный пользователем на указанный вопрос. Пользователь может создать только один ответ на вопрос.
|
Отзывы
Этот API предоставляет операции CRUD для обзоров. google.mybusiness.v4.Reviews
.
Пакетное получение отзывов | |
---|---|
Возвращает постраничный список отзывов для всех указанных местоположений. Эта операция действительна только в том случае, если указанные местоположения проверены.
|
УдалитьОтзывОтветить | |
---|---|
Удаляет ответ на указанный отзыв. Эта операция действительна только в том случае, если указанное местоположение проверено.
|
Получить обзор | |
---|---|
Возвращает указанный отзыв. Эта операция действительна только в том случае, если указанное местоположение проверено. Возвращает
|
СписокОтзывов | |
---|---|
Возвращает постраничный список отзывов для указанного местоположения. Эта операция действительна только в том случае, если указанное местоположение проверено.
|
ОбновлениеОтзывОтветить | |
---|---|
Обновляет ответ на указанный отзыв. Ответ создается, если он не существует. Эта операция действительна только в том случае, если указанное местоположение проверено.
|
Списки услуг
Этот API позволяет получать и обновлять список сервисов местоположений компаний в Google. Список услуг содержит список элементов услуг, которые являются услугами, предоставляемыми продавцами. Услугой может быть стрижка, установка водонагревателя и т.д.
Получить список служб | |
---|---|
Получить указанный список услуг местоположения.
|
ОбновлениеServiceList | |
---|---|
Обновляет указанный список служб местоположения.
|
Проверки
Этот API позволяет управлять проверкой местоположения в Google. Это позволяет вам управлять ресурсами Verification
.
Каждое Location
имеет коллекцию ресурсов Verification
с именами accounts/*/locations/*/verifications/*
.
Полная проверка | |
---|---|
Завершает Это необходимо только для
|
FetchVerificationOptions | |
---|---|
Сообщает обо всех подходящих вариантах проверки для местоположения на определенном языке.
|
Список проверок | |
---|---|
Список проверок местоположения, упорядоченный по времени создания.
|
Проверить местоположение | |
---|---|
Запускает процесс проверки местоположения.
|
Принять запрос приглашения
Сообщение запроса для AccessControl.AcceptInvitation.
Поля | |
---|---|
name | Имя принимаемого приглашения. |
Счет
Аккаунт – это контейнер для местоположений вашей компании. Если вы единственный пользователь, который управляет адресами вашей компании, вы можете использовать свой личный аккаунт Google. Чтобы поделиться управлением местоположениями с несколькими пользователями, создайте бизнес-аккаунт .
Поля | |
---|---|
name | Имя ресурса в формате |
account_name | Имя учетной записи. |
type | Только вывод. Указывает |
role | Только вывод. Указывает роль |
state | Только вывод. Указывает |
account_number | Ссылочный номер учетной записи, если он предоставлен. |
permission_level | Только вывод. Указывает |
organization_info | Дополнительная информация об организации. Это поле заполняется только для учетной записи организации. |
Информация об организации
Дополнительная информация, хранящаяся для организации.
Поля | |
---|---|
registered_domain | Зарегистрированный домен для учетной записи. |
postal_address | Почтовый адрес аккаунта. |
phone_number | Контактный номер организации. |
роль учетной записи
Указывает уровень доступа, который имеет аутентифицированный пользователь для этой учетной записи. Дополнительную информацию можно найти в статье Справочного центра .
Перечисления | |
---|---|
ACCOUNT_ROLE_UNSPECIFIED | Не указан. |
OWNER | Пользователь является владельцем этой учетной записи. (Отображается в пользовательском интерфейсе как «Основной владелец»). |
CO_OWNER | Пользователь является совладельцем аккаунта. (Отображается как «Владелец» в пользовательском интерфейсе). |
MANAGER | Пользователь может управлять этой учетной записью. |
COMMUNITY_MANAGER | Пользователь может управлять страницами социальных сетей (Google+) для своей учетной записи. (Отображается в пользовательском интерфейсе как «Менеджер сайта»). |
состояние аккаунта
Указывает состояние учетной записи, например, была ли она проверена Google.
Поля | |
---|---|
status | Если проверка подтверждена, будущие создаваемые местоположения автоматически подключаются к Картам Google и создаются страницы Google+ без необходимости модерации. |
Статус аккаунта
Указывает статус проверки учетной записи.
Перечисления | |
---|---|
ACCOUNT_STATUS_UNSPECIFIED | Не указан. |
VERIFIED | Подтвержденный аккаунт. |
UNVERIFIED | Аккаунт не подтвержден, и верификация не запрошена. |
VERIFICATION_REQUESTED | Аккаунт не подтвержден, но запрошена проверка. |
Тип аккаунта
Указывает, какой это тип учетной записи: личная/пользовательская или бизнес-учетная запись.
Перечисления | |
---|---|
ACCOUNT_TYPE_UNSPECIFIED | Не указан. |
PERSONAL | Учетная запись конечного пользователя. |
LOCATION_GROUP | Группа локаций. Дополнительную информацию можно найти в статье Справочного центра . |
USER_GROUP | Группа пользователей для разделения сотрудников организации на группы. Дополнительную информацию можно найти в статье Справочного центра . |
ORGANIZATION | Организация, представляющая компанию. Дополнительную информацию можно найти в статье Справочного центра . |
Расширения местоположения AdWords
Дополнительная информация, отображаемая в AdWords.
Поля | |
---|---|
ad_phone | Альтернативный номер телефона, который будет отображаться в расширениях адресов AdWords вместо основного номера телефона местоположения. |
АдресВвод
Вход для проверки АДРЕСА.
Поля | |
---|---|
mailer_contact_name | Имя контактного лица, на которое должно быть отправлено письмо. |
Админ
Поля | |
---|---|
name | Имя ресурса. Для администраторов учетных записей это имеет форму: Для администраторов местоположения это имеет форму: |
admin_name | Имя администратора. При первоначальном приглашении это адрес электронной почты приглашенного. При вызовах |
role | Указывает |
pending_invitation | Только вывод. Указывает, есть ли у этого администратора ожидающее приглашение для указанного ресурса. |
роль администратора
Указывает уровень доступа, который имеет администратор. Дополнительную информацию можно найти в статье Справочного центра .
Перечисления | |
---|---|
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 | Только вывод. Уникальное имя для учетных записей ответов/*/locations/*/questions/*/ответы/* |
author | Только вывод. Автор ответа. |
upvote_count | Только вывод. Количество голосов за ответ. |
text | Текст ответа. Он должен содержать хотя бы один символ без пробелов. Максимальная длина — 4096 символов. |
create_time | Только вывод. Временная метка, когда был написан ответ. |
update_time | Только вывод. Временная метка последнего изменения ответа. |
AssociateLocationRequest
Сообщение запроса для Locations.AssociateLocationRequest.
Поля | |
---|---|
name | Имя ресурса расположения, которое необходимо связать. |
place_id | Ассоциацию создать. Если не установлено, это указывает на отсутствие совпадения. |
Атрибут
Атрибут местоположения. Атрибуты предоставляют дополнительную информацию о местоположении. Атрибуты, которые можно задать для местоположения, могут различаться в зависимости от свойств этого местоположения (например, категории). Доступные атрибуты определяются Google и могут быть добавлены и удалены без изменений API.
Поля | |
---|---|
attribute_id | Идентификатор атрибута. Идентификаторы атрибутов предоставляются Google. |
value_type | Только вывод. Тип значения, которое содержит этот атрибут. Это следует использовать для определения того, как интерпретировать значение. |
values[] | Значения этого атрибута. Тип предоставляемых значений должен соответствовать ожидаемому для этого атрибута; см. Тип АтрибутеЗначения . Это повторяющееся поле, в котором могут быть указаны несколько значений атрибута. Типы атрибутов поддерживают только одно значение. |
repeated_enum_value | Если тип значения атрибута — REPEATED_ENUM, он содержит значение атрибута, а остальные поля значений должны быть пустыми. |
url_values[] | Если типом значения атрибута является URL-адрес, это поле содержит значения для этого атрибута, а остальные поля значений должны быть пустыми. |
АтрибутМетаданные
Метаданные для атрибута. Содержит отображаемую информацию для атрибута, включая локализованное имя и заголовок для группировки связанных атрибутов.
Поля | |
---|---|
attribute_id | Идентификатор атрибута. |
value_type | Тип значения атрибута. Ожидается, что установленные и полученные значения будут относиться к этому типу. |
display_name | Локализованное отображаемое имя атрибута, если оно доступно; в противном случае — отображаемое имя на английском языке. |
group_display_name | Локализованное отображаемое имя группы, содержащей этот атрибут, если доступно; в противном случае — английское название группы. Связанные атрибуты собраны в группу и должны отображаться вместе под указанным здесь заголовком. |
is_repeatable | Если это правда, атрибут поддерживает несколько значений. Если значение false, следует указать только одно значение. |
value_metadata[] | Для некоторых типов атрибутов (например, перечислений) предоставляется список поддерживаемых значений и соответствующие отображаемые имена для этих значений. |
is_deprecated | Если это правда, атрибут устарел и больше не должен использоваться. Если он устарел, обновление этого атрибута не приведет к ошибке, но обновления не будут сохранены. В какой-то момент после устаревания атрибут будет полностью удален, и это станет ошибкой. |
АтрибутЗначениеМетаданные
Метаданные для поддерживаемых значений атрибутов.
Поля | |
---|---|
value | Значение атрибута. |
display_name | Отображаемое имя для этого значения, локализованное, если оно доступно; иначе на английском языке. Отображаемое имя значения предназначено для использования в контексте с отображаемым именем атрибута. Например, для атрибута перечисления «WiFi» оно может содержать «Paid», обозначающее платный Wi-Fi. |
АтрибутЗначениеТип
Тип значения атрибута.
Перечисления | |
---|---|
ATTRIBUTE_VALUE_TYPE_UNSPECIFIED | Не указан. |
BOOL | Значения этого атрибута являются логическими. |
ENUM | Атрибут имеет заранее определенный список доступных значений, которые можно использовать. В метаданных для этого атрибута будут перечислены эти значения. |
URL | Значениями этого атрибута являются URL-адреса. |
REPEATED_ENUM | Значение атрибута представляет собой перечисление с несколькими возможными значениями, которые можно явно установить или удалить. |
Автор
Представляет автора вопроса или ответа
Поля | |
---|---|
display_name | Отображаемое имя пользователя |
profile_photo_url | URL-адрес фотографии профиля пользователя. |
type | Тип пользователя, которым является автор. |
Тип автора
Перечисление типа пользователя, которым является автор.
Перечисления | |
---|---|
AUTHOR_TYPE_UNSPECIFIED | Это не следует использовать. |
REGULAR_USER | Обычный пользователь. |
LOCAL_GUIDE | Местный гид |
MERCHANT | Владелец/управляющий локации |
Базовый запрос метрики
Запрос на базовую информацию о метриках.
Поля | |
---|---|
metric_requests[] | Коллекция метрик для возврата значений, включающая варианты того, как следует возвращать данные. |
time_range | Диапазон, для которого собираются показатели. Максимальный диапазон составляет 18 месяцев с даты запроса. В некоторых случаях данные могут отсутствовать в течение нескольких дней, близких к дате запроса. Недостающие данные будут указаны в |
Пакетный запросGetBusinessCategoriesRequest
Сообщение запроса для BusinessCategories.BatchGetBusinessCategories.
Поля | |
---|---|
language_code | Необходимый. Код языка BCP 47, на котором должны быть возвращены имена категорий. |
category_ids[] | Необходимый. Должно быть установлено хотя бы одно имя. Идентификаторы GConcept, для которых должны быть возвращены локализованные имена категорий. |
region_code | Необязательный. Код страны ISO 3166-1 альфа-2, используемый для определения нестандартного языка. |
view | Необходимый. Указывает, какие части ресурса категории должны быть возвращены в ответе. |
BatchGetBusinessCategoriesResponse
Ответное сообщение для BusinessCategories.BatchGetBusinessCategories.
Поля | |
---|---|
categories[] | Категории, соответствующие идентификаторам GConcept, указанным в запросе. Они не будут идти в том же порядке, что и идентификаторы категорий в запросе. |
Пакетный метод GetLocationsRequest
Сообщение запроса для Locations.BatchGetLocations.
Поля | |
---|---|
name | Имя учетной записи, из которой можно получить данные о местоположениях. |
location_names[] | Коллекция мест для извлечения, указанная по их именам. |
Пакетный метод GetLocationsResponse
Ответное сообщение для Locations.BatchGetLocations.
Поля | |
---|---|
locations[] | Коллекция локаций. |
Пакетное получениеотзывовзапрос
Сообщение запроса для Reviews.BatchGetReviews.
Поля | |
---|---|
name | Имя учетной записи, из которой можно получить список отзывов из нескольких местоположений. |
location_names[] | Коллекция мест, для которых нужно получить отзывы, указанные по их названиям. |
page_size | Сколько отзывов нужно получить на странице. Значение по умолчанию — 50. |
page_token | Если указано, будет получена следующая страница отзывов. |
order_by | Необязательный. Указывает поле для сортировки отзывов. Если не указано, порядок возвращаемых обзоров по умолчанию будет |
ignore_rating_only_reviews | Игнорировать ли отзывы, содержащие только оценки. |
Пакетный метод GetReviewsResponse
Ответное сообщение для Reviews.BatchGetReviews.
Поля | |
---|---|
location_reviews[] | Отзывы с информацией о местоположении. |
next_page_token | Если количество отзывов превысило запрошенный размер страницы, это поле заполняется токеном для получения следующей страницы отзывов при последующих вызовах. Если отзывов больше нет, это поле не будет присутствовать в ответе. |
Рабочие часы
Представляет периоды времени, в течение которых это местоположение открыто для бизнеса. Содержит коллекцию экземпляров TimePeriod
.
Поля | |
---|---|
periods[] | Подборка случаев, когда это заведение было открыто для бизнеса. Каждый период представляет собой диапазон часов, в течение которых заведение открыто в течение недели. |
Призыв к действию
Действие, которое выполняется, когда пользователь нажимает на публикацию.
Поля | |
---|---|
action_type | Тип действия, которое будет выполнено. |
url | URL-адрес, на который будет перенаправлен пользователь при нажатии. Это поле следует оставить незаполненным для призыва к действию «Позвонить». |
Тип действия
Тип действия, которое будет выполнено.
Перечисления | |
---|---|
ACTION_TYPE_UNSPECIFIED | Тип не указан. |
BOOK | В этом сообщении пользователь хочет записаться на прием/стол/и т. д. |
ORDER | Этот пост хочет, чтобы пользователь что-то заказал. |
SHOP | В этом посте пользователь хочет просмотреть каталог продуктов. |
LEARN_MORE | Этот пост хочет, чтобы пользователь узнал больше (на своем веб-сайте). |
SIGN_UP | В этом сообщении пользователю предлагается зарегистрироваться/зарегистрироваться/присоединиться к чему-либо. |
GET_OFFER | Устарело. Используйте |
CALL | В этом сообщении пользователь хочет позвонить в компанию. |
Категория
Категория, описывающая, чем является этот бизнес (а не чем он занимается). Список допустимых идентификаторов категорий и сопоставлений с их удобочитаемыми именами см. в разделе категории.list .
Поля | |
---|---|
display_name | . Читабельное имя категории. Это устанавливается при чтении местоположения. При изменении местоположения необходимо установить Примечание. Это поле используется только в ответах. Любое значение, указанное здесь в запросе, игнорируется. |
category_id | . Стабильный идентификатор (предоставленный Google) для этой категории. Примечание. Это поле используется только в ответах. Любое значение, указанное здесь в запросе, игнорируется. |
service_types[] | . Список всех типов услуг, доступных для этой бизнес-категории. Примечание. Это поле используется только в ответах. Любое значение, указанное здесь в запросе, игнорируется. |
more_hours_types[] | Только вывод. Дополнительные типы часов, доступные для этой категории бизнеса. |
КатегорияПросмотр
Перечисление, помогающее ограничить объем данных, возвращаемых сервером.
Перечисления | |
---|---|
CATEGORY_VIEW_UNSPECIFIED | Не указано, эквивалентно CATEGORY_METADATA_ONLY. |
BASIC | Ответ сервера будет включать только поля категории display_name, Category_id и Language_code. В нем отсутствуют любые поля, связанные с метаданными типа службы. |
FULL | Возвращает все поля ответа. |
Цепь
Сеть – это бренд, с которым могут быть связаны филиалы вашего бизнеса.
Поля | |
---|---|
name | Имя ресурса цепочки в формате |
chain_names[] | Названия сети. |
websites[] | Сайты сети. |
location_count | Количество локаций, входящих в эту цепочку. |
Имяцепи
Имя, которое будет использоваться при отображении цепочки.
Поля | |
---|---|
display_name | Отображаемое имя этой цепочки. |
language_code | Код языка названия BCP 47. |
Цепной URL
URL-адрес, который будет использоваться при отображении цепочки.
Поля | |
---|---|
url | URL-адрес этой цепочки. |
ClearLocationAssociationRequest
Сообщение запроса для Locations.ClearLocationAssociationRequest.
Поля | |
---|---|
name | Имя ресурса расположения, которое требуется отключить. |
Завершить запрос на проверку
Сообщение запроса для Verifications.CompleteVerificationAction.
Поля | |
---|---|
name | Имя ресурса для завершения проверки. |
pin | ПИН-код, полученный продавцом для завершения проверки. |
ПолныйVerificationResponse
Ответное сообщение для Verifications.CompleteVerificationAction.
Поля | |
---|---|
verification | Завершенная проверка. |
CreateAccountAdminRequest
Сообщение запроса для AccessControl.CreateAccountAdmin.
Поля | |
---|---|
parent | Имя ресурса учетной записи, для которой создан этот администратор. |
admin | Админ для создания |
Запрос создания учетной записи
Сообщение запроса для Accounts.CreateAccount.
Поля | |
---|---|
primary_owner | Имя ресурса учетной записи, которая будет основным владельцем создаваемой учетной записи. Он должен иметь форму |
account | Информация об учетной записи, которую необходимо создать. Единственными разрешенными полями являются имя_аккаунта и тип. |
CreateLocalPostRequest
Сообщение запроса для CreateLocalPost.
Поля | |
---|---|
parent | Имя места, в котором будет создано локальное сообщение. |
local_post | Новые метаданные локальной публикации. |
CreateLocationAdminRequest
Сообщение запроса для AccessControl.CreateLocationAdmin.
Поля | |
---|---|
parent | Имя ресурса местоположения, для которого создан этот администратор. |
admin | Админ для создания |
Создать запрос местоположения
Сообщение запроса для Locations.CreateLocation.
Поля | |
---|---|
parent | Имя учетной записи, в которой необходимо создать это местоположение. |
location | Новые метаданные местоположения. |
validate_only | Если это правда, запрос проверяется без фактического создания местоположения. |
request_id | Уникальный идентификатор запроса, позволяющий серверу обнаруживать дублированные запросы. Мы рекомендуем использовать UUID. Максимальная длина — 50 символов. |
CreateMediaItemRequest
Сообщение запроса для Media.CreateMediaItem.
Поля | |
---|---|
parent | Имя ресурса места, где будет создан этот медиа-элемент. |
media_item | Создаваемый медиа-элемент. |
СоздатьВопросЗапрос
Запрос сообщения для вопросов и ответов.CreateQuestion
Поля | |
---|---|
parent | Название места, для которого нужно написать вопрос. |
question | Новый вопрос. |
Отклонить запрос приглашения
Сообщение запроса для AccessControl.DeclineInvitation.
Поля | |
---|---|
name | Имя приглашения учетной записи, которое отклоняется. |
Удалитьаккаунтадминреквест
Сообщение запроса для AccessControl.DeleteAccountAdmin.
Поля | |
---|---|
name | Имя ресурса администратора, которого нужно удалить из учетной записи. |
Удалить ответреквест
Запрос сообщения для вопросов и ответов.DeleteAnswer
Поля | |
---|---|
parent | Название вопроса, на который нужно удалить ответ. |
Удалитьлокалпострекуест
Сообщение запроса для DeleteLocalPost.
Поля | |
---|---|
name | Название локальной публикации, которую нужно удалить. |
УдалитьLocationAdminRequest
Сообщение запроса для AccessControl.DeleteLocationAdmin.
Поля | |
---|---|
name | Имя ресурса администратора, которого нужно удалить из местоположения. |
Удалитьлокационный запрос
Сообщение запроса для Locations.DeleteLocation.
Поля | |
---|---|
name | Имя места, которое нужно удалить. |
Удалитьмедиаитемрекуест
Сообщение запроса для Media.DeleteMediaItem.
Поля | |
---|---|
name | Имя удаляемого медиа-элемента. |
Удалить запрос уведомлений
Сообщение запроса для Accounts.DeleteNotifications.
Поля | |
---|---|
name | Имя ресурса для параметров уведомлений, которые необходимо очистить. |
УдалитьВопросЗапрос
Запрос сообщения для вопросов и ответов.DeleteQuestion
Поля | |
---|---|
name | Название вопроса, который нужно удалить. |
Удалитьревиевереплиреквест
Сообщение запроса для Reviews.DeleteReviewReply.
Поля | |
---|---|
name | Название ответа на отзыв, который нужно удалить. |
ДиетическиеОграничения
Диетическая информация о продукте.
Перечисления | |
---|---|
DIETARY_RESTRICTION_UNSPECIFIED | Тип диеты не указан |
HALAL | Обозначение еды как халяльного блюда. |
KOSHER | Обозначение еды как кошерного блюда. |
ORGANIC | Обозначение еды как органического блюда. |
VEGAN | Обозначение еды как веганского блюда. |
VEGETARIAN | Обозначение еды как вегетарианского блюда. |
РазмерноеМетричноеЗначение
Значение одной метрики с заданным измерением времени.
Поля | |
---|---|
metric_option | Опция, запрашивающая это размерное значение. |
time_dimension | Размерность значения. |
value | Значение. Если значение не установлено, запрошенные данные отсутствуют. |
TimeDimension
Измерение, по которому разделены данные.
Поля | |
---|---|
day_of_week | Дню недели (от ПОНЕДЕЛЬНИКА до ВОСКРЕСЕНЬЯ), которому соответствует это значение. Установите параметр BREAKDOWN_DAY_OF_WEEK. |
time_of_day | Час дня (от 0 до 23), которому соответствует это значение. Установите параметр BREAKDOWN_HOUR_OF_DAY. |
time_range | Диапазон времени, который охватывает это значение. Установите для агрегированных опций и агрегированных и агрегированных. |
DriveDirectionMetricsRequest
Запрос о понимании направления вождения.
Поля | |
---|---|
num_days | Количество дней для агрегирования данных для. Возвращенные результаты будут доступны в течение последнего количества запрошенных дней. Допустимые значения составляют 7, 30 и 90. |
language_code | Код BCP 47 для языка. Если код языка не указан, по умолчанию используется английский. |
Число дней
Количество дней, которые этот запрос может поддержать.
Перечисления | |
---|---|
SEVEN | 7 дней. Это значение по умолчанию. |
THIRTY | 30 дней. |
NINETY | 90 дней. |
Электронная почта
Ввод для проверки электронной почты.
Поля | |
---|---|
email_address | Адрес электронной почты, на который следует отправлять PIN -код. Адрес электронной почты принимается только в том случае, если это один из адресов, предоставленных FetchVerificationOptions. Если |
Ошибка
Подробно описывает ошибку, которая привела к проверке или внутреннему сбою.
Поля | |
---|---|
code | Код состояния, который должен быть значением перечисления |
field | Путь, ведущий к поле в органе запроса. Значение представляет собой последовательность, разделенные DOT, идентифицированные, которые идентифицируют поле протокола буфера. Например, «error_details.field» определит это поле. |
message | Описание того, почему поле вызвало неудачу. Сообщение на английском языке и может не подходить для отображения пользователям. |
value | Значение, которое не удалось. |
field_index | Если поле запроса, которое сгенерировало эту ошибку, повторяется, это будет содержать индекс на основе нулевого уровня входа в этом поле, что вызвало отказ проверки. |
Код ошибки
Коды ошибок для 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 | Название ресурса местоположения для проверки. |
language_code | Языковой код BCP 47, представляющий язык, который должен использоваться для процесса проверки. Доступные варианты варьируются в зависимости от языка. |
context | Дополнительная контекстная информация для проверки услуг. Требуется для местоположений, чей бизнес -тип - customer_location_only. Invalid_argument будет брошен, если он будет установлен для других видов бизнеса. |
FetchVerificationOptionsResponse
Ответ Сообщение для проверки.
Поля | |
---|---|
options[] | Доступные варианты проверки. |
FindmatchinglocationsRequest
Запросить сообщение о локации.
Поля | |
---|---|
name | Название ресурса местоположения, чтобы найти совпадения. |
language_code | Предпочтительный язык для места сопоставления (в формате BCP-47). |
num_results | Количество совпадений для возврата. Значение по умолчанию составляет 3, максимум 10. Обратите внимание, что задержка может увеличиться, если запрашивается больше. Там нет страниц. |
max_cache_duration | Устарело. Это поле игнорируется для всех запросов. |
FindMatchingLocationsResponse
Ответ Сообщение для локаций.
Поля | |
---|---|
matched_locations[] | Коллекция локаций, которые являются потенциальными совпадами с указанным местоположением, перечисленным в порядке от Best до наименьшего соответствия. Если есть точное совпадение, оно будет в первой позиции. |
match_time | Когда соответствующий алгоритм был в последний раз выполнен для этого места. |
Последователи .metadata
Последовательные метаданные для места.
Поля | |
---|---|
name | Имя ресурса для этого. accounts/{account_id}/locations/{location_id}/последователи/метаданные |
count | Общее количество последователей для места. |
Меню еды
Меню бизнеса, который подает блюда с едой.
Поля | |
---|---|
labels[] | Необходимый. Языковые этикетки для меню. Например, «Меню», «Специальный обед». Отображения должны составлять 140 символов или меньше, с описаниями 1000 символов или меньше. По крайней мере, один набор ярлыков требуется. |
source_url | Необязательный. Источник URL меню, если есть веб -страница. |
sections[] | Необходимый. Разделы меню. |
cuisines[] | Необязательный. Информация о кухне для меню еды. Настоятельно рекомендуется предоставить эту область. |
Кухня
Кухня информация о ресторане.
Перечисления | |
---|---|
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[] | Необходимый. Языковые метки метки для этого пункта меню. Отображения должны составлять 140 символов или меньше, с описаниями 1000 символов или меньше. По крайней мере, один набор ярлыков требуется. |
attributes | Необходимый. Подробные атрибуты элемента. Когда варианты элемента указаны, это считается базовыми атрибутами и заполняется для каждой опции. |
options[] | Необязательный. Это предназначен для элемента, который поставляется в разных вариантах, и пользователи обязаны сделать выбор. Например, «обычная» против «большой» пиццы. Когда будут указаны параметры, этикетки и атрибуты на уровне элемента автоматически станут первыми мечениями и атрибутами. Клиенты должны указать только другие дополнительные варианты питания в этой области. |
Foodmenuitemattributes
Атрибуты продукта/блюдо.
Поля | |
---|---|
price | Необходимый. Цена блюда с едой. |
spiciness | Необязательный. Уровень пряности блюда с едой. |
allergen[] | Необязательный. Аллергены, связанные с блюдом с едой. Настоятельно рекомендуется предоставить эту область. |
dietary_restriction[] | Необязательный. Диетическая информация о пищевой блюде. Настоятельно рекомендуется предоставить эту область. |
nutrition_facts | Необязательный. Факты питания блюда. Настоятельно рекомендуется предоставить эту область. |
ingredients[] | Необязательный. Ингредиенты блюда с едой. |
serves_num_people | Необязательный. Количество людей может подавать этот вариант блюд. |
preparation_methods[] | Необязательный. Методы того, как готовится вариант пищевого блюда. |
portion_size | Необязательный. Размер заказа, представленного в единицах предметов. (например, 4 «шампуры», 6 «кусочков») |
media_keys[] | Необязательный. Ключи СМИ СМИ, связанные с блюдом. Поддерживается только фототежиры. Когда есть несколько связанных фотографий, первая фотография считается предпочтительным фото. |
Ингредиент
Это сообщение обозначает информацию об ингредиенте о продовольственном блюде.
Поля | |
---|---|
labels[] | Необходимый. Ярлыки для описания ингредиента. Отображения должны составлять 140 символов или меньше, с описаниями 1000 символов или меньше. По крайней мере, один набор ярлыков требуется. |
Порции размером
Порция порции размера блюда с едой.
Поля | |
---|---|
quantity | Необходимый. Количество порции. |
unit[] | Необходимый. Полевое поле name_info предназначено для устройства на нескольких языках. |
Foodmenuitemoption
Вариант элемента. Это требует явного выбора пользователя.
Поля | |
---|---|
labels[] | Необходимый. Языковые метки метки для этого варианта меню. Например: «Говяжий пад Тай», «Вегетарианская пада Тай», «Маленькая пицца», «Большая пицца». Отображения должны составлять 140 символов или меньше, с описаниями 1000 символов или меньше. По крайней мере, один набор ярлыков требуется. |
attributes | Необходимый. Подробные атрибуты опции элемента. Индивидуальные неуточненные атрибуты будут унаследованы с уровня элемента, а также базовая. |
Продовольственная
Раздел меню. Он может содержать несколько предметов/посуды.
Поля | |
---|---|
labels[] | Необходимый. Языковые метки метки для этого раздела меню. Отображения должны составлять 140 символов или меньше, с описаниями 1000 символов или меньше. По крайней мере, один набор ярлыков требуется. |
items[] | Необходимый. Пункты раздела. В каждом разделе должен быть хотя бы предмет. |
Foodmenus
Меню бизнеса, которые подают блюда с едой.
Поля | |
---|---|
name | Необходимый. Идентификатор Google для этого местоположения в форме: |
menus[] | Необязательный. Коллекция продовольственных меню. |
GenerateAccountnumberRequest
Запросить сообщение для учетных записей. Generateaccountnumber.
Поля | |
---|---|
name | Имя учетной записи для создания номера учетной записи для. |
GetAccountRequest
Сообщение запроса для Accounts.GetAccount.
Поля | |
---|---|
name | Имя учетной записи для получения. |
GetChainRequest
Запросить сообщение о локации.getchain.
Поля | |
---|---|
name | Имя ресурса цепочки, в |
GetCustomerMediaItemRequest
Запросить сообщение для media.getCustomerMediaItem.
Поля | |
---|---|
name | Название ресурса запрошенного клиента. |
GetFollowersMetAdatareQuest
Запросите сообщение, чтобы получить метаданные подписчиков для местоположения.
Поля | |
---|---|
name | Название ресурса метаданных последователей местоположения. accounts/{account_id}/locations/{location_id}/последователи/метаданные |
GetFoodMenusRequest
Запросить сообщение для foodmenu.getfoodmenus
Поля | |
---|---|
name | Необходимый. Идентификатор Google для этого местоположения в форме: |
read_mask | Необязательный. Конкретные поля для возврата. Если маска не указана, то она возвращает полный Foodmenu (так же, как «*»). Повторные элементы поля не могут быть указаны индивидуально. Например: «Имя» и «Меню» являются действительными масками, в то время как «меню. Разрешения» недействительны. |
Gethealthproviderattributesrequest
Запросить сообщение для здравоохранения
Поля | |
---|---|
name | Необходимый. Идентификатор Google для этого местоположения в форме: accounts/{account_id}/locations/{location_id}/healthproviderattributes |
language_code | Необязательный. Код BCP 47 для языка. Если код языка не указан, по умолчанию используется английский. На данный момент поддерживается только «en». |
Getlocalpostrequest
Запросить сообщение о локальном prosts.getlocalpost.
Поля | |
---|---|
name | Название местного поста для получения. |
GetLocationRequest
Запросить сообщение о локации.getLocation.
Поля | |
---|---|
name | Название местоположения для получения. |
GetMediaItemRequest
Запросить сообщение для media.getmediaitem.
Поля | |
---|---|
name | Название запрошенного элемента медиа. |
GetNotificationsRequest
Запросить сообщение для учетных записей.getNotifications.
Поля | |
---|---|
name | Уведомление Настройки Настройки Имя ресурса. |
GetReviewRequest
Запросить сообщение для Reviews.getReview.
Поля | |
---|---|
name | Название обзора для получения. |
GetserviceListriestest
Получить сообщение о запросе списка услуг.
Поля | |
---|---|
name | Необходимый. Идентификатор Google для этого местоположения в форме: |
GoogleМестоположение
Представляет Location
, которое присутствует в Google. Это может быть место, которое было заявлено пользователем, кем -то еще, или может быть невостребованным.
Поля | |
---|---|
name | Имя ресурса этого GoogleLocation, в формате |
location | Малонаселенная информация |
request_admin_rights_url | URL, который будет перенаправить пользователя на пользовательский интерфейс Admin Rights. Это поле присутствует только в том случае, если место уже было заявлено о любом пользователе, включая текущего пользователя. |
GoogleUpdatedLocation
Представляет место, которое было изменено Google.
Поля | |
---|---|
location | Google-Updated версия этого места. |
diff_mask | Поля, которые Google обновил. |
HealthProviderattributes
Атрибуты медицинского работника связаны с этим местоположением.
Поля | |
---|---|
name | Необходимый. Идентификатор Google для этого местоположения в форме: |
insurance_networks[] | Необязательный. Список страховых сетей, связанных с этим местоположением. |
Insurancenetwork
Единственная страховая сеть. Следующий идентификатор: 5
Поля | |
---|---|
network_id | Необходимый. Идентификатор этой страховой сети, сгенерированной Google. |
network_names | Только вывод. Карта сетевых отображающих имен на запрошенных языках, где язык является ключом, а локализованное отображаемое имя - это значение. Отображение на английском языке установлено по умолчанию. |
payer_names | Только вывод. Карта плательщика отображает имена на запрошенных языках, где язык является ключом, а локализованное имя отображаемого - это значение. Отображение на английском языке установлено по умолчанию. |
state | Только вывод. Состояние этой страховой сети. |
Внутренняя ошибка
Описывает внутренние неудачи.
Поля | |
---|---|
error_details[] | Подробно отдельные неудачи. |
Приглашение
Только вывод. Представляет ожидающее приглашение.
Поля | ||
---|---|---|
name | Имя ресурса для приглашения. | |
role | Приглашенная роль на аккаунте. | |
Полевая target Союза. Указывает цель, для которой предназначено это приглашение. target может быть только одно из следующих: | ||
target_account | Малонаселенный аккаунт, для которого предназначено это приглашение. | |
target_location | Целевое местоположение, для которого предназначено это приглашение. |
Целевое местоположение
Представляет целевое расположение для ожидающего приглашения.
Поля | |
---|---|
location_name | Название локации, в которую приглашен пользователь. |
location_address | Адрес локации, в которую приглашен пользователь. |
Запрос ListAccountAdmins
Сообщение запроса для AccessControl.ListAccountAdmins.
Поля | |
---|---|
parent | Имя учетной записи, из которой можно получить список администраторов. |
ListAccountAdminsResponse
Ответное сообщение для AccessControl.ListAccountAdmins.
Поля | |
---|---|
admins[] | Коллекция экземпляров |
Запрос списка аккаунтов
Сообщение запроса для Accounts.ListAccounts.
Поля | |
---|---|
page_size | Сколько аккаунтов нужно получить на страницу. По умолчанию — 20, минимум — 2, максимальный размер страницы — 20. |
page_token | Если указано, извлекается следующая страница учетных записей. |
name | Имя ресурса учетной записи, для которой необходимо получить список учетных записей с прямым доступом. Это имеет смысл только для организаций и групп пользователей. Если пусто, вернет |
filter | Фильтр, ограничивающий возврат учетных записей. Ответ включает только записи, соответствующие фильтру. Если Например, запрос с |
ListAccountsResponse
Ответное сообщение для Accounts.ListAccounts.
Поля | |
---|---|
accounts[] | Коллекция учетных записей, к которым у пользователя есть доступ. Личный аккаунт пользователя, выполняющего запрос, всегда будет первым элементом результата, если он не отфильтрован. |
next_page_token | Если количество учетных записей превышает запрошенный размер страницы, это поле заполняется токеном для получения следующей страницы учетных записей при последующем вызове |
ListAnsWersRequest
Запросить сообщение о вопросах andanswers.listanswers
Поля | |
---|---|
parent | Название вопроса, чтобы получить ответы для. |
page_size | Сколько ответов на получение на страницу. Значения по умолчанию и максимум |
page_token | Если указано, получена следующая страница ответов. |
order_by | Приказ вернуть ответы. Действительные параметры включают «Update_time desc» и «upvote_count desc», которые возвращают ответы, отсортированные нисходящими по запрашиваемому полю. Порядок сортировки по умолчанию - «Update_time desc». |
ListAnsWersResponse
Ответное сообщение для вопросов andanswers.listanswers
Поля | |
---|---|
answers[] | Запрошенные ответы. |
total_size | Общее количество ответов, размещенных по этому вопросу на всех страницах. |
next_page_token | Если количество ответов превышает запрошенный размер страницы максимума, это поле заполнено токеном, чтобы получить следующую страницу ответов при последующем вызове. Если ответов больше нет, это поле не присутствует в ответе. |
ListattribitemetAdatarequest
Запросить сообщение для местоположения. Если имя ресурса местоположения предоставляется, то это место будет использоваться для заполнения остальных критериев. Если нет, категория и страна должны быть предоставлены.
Поля | |
---|---|
name | Название ресурса местоположения для поиска доступных атрибутов. |
category_id | Основная стабильная идентификация категории для поиска доступных атрибутов. |
country | ISO 3166-1 Код страны Альфа-2, чтобы найти доступные атрибуты. |
language_code | Код языка BCP 47 для получения имен отображения атрибутов. Если этот язык недоступен, он будет предоставлен на английском языке. |
page_size | Сколько атрибутов включать на страницу. По умолчанию 200, минимум - 1. |
page_token | Если указано, получена следующая страница метаданных атрибутов. |
ListattribitemetAdataresponse
Ответ Сообщение для локаций.
Поля | |
---|---|
attributes[] | Коллекция метаданных атрибутов для доступных атрибутов. |
next_page_token | Если количество атрибутов превысило запрошенную размер страницы, это поле будет заполнено токеном, чтобы получить следующую страницу атрибутов при последующем вызове |
ListBusinessCategoriesRequest
Поля | |
---|---|
region_code | ISO 3166-1 Код страны Альфа-2. |
language_code | BCP 47 Код языка. Если язык недоступен, он по умолчанию по умолчанию на английский. |
search_term | Дополнительная строка фильтра от пользователя. |
page_size | Сколько категорий получить на страницу. По умолчанию — 100, минимум — 1, максимальный размер страницы — 100. |
page_token | Если указано, будет получена следующая страница категорий. |
view | Необязательный. Определяет, какие детали для ресурса категории должны быть возвращены в ответе. |
ListBusinessCategoriesResponse
Поля | |
---|---|
categories[] | Категории. Категории являются основным представлением. Они не содержат информации о услугах. |
total_category_count | Общее количество категорий для параметров запроса. |
next_page_token | Если количество категорий превысило запрошенное размер страницы, это поле будет заполнено токеном для получения следующей страницы категорий при последующем вызове к |
ListCustomerMediaItemsRequest
Запросить сообщение для media.listcustomermediaitems.
Поля | |
---|---|
parent | Название местоположения, чьи клиентские средства массовой информации будут перечислены. |
page_size | Сколько элементов медиа возврата на страницу. Значение по умолчанию составляет 100, максимально поддерживаемый размер страницы составляет 200. |
page_token | Если указано, возвращает следующую страницу элементов мультимедиа. |
ListCustomerMediaItemsResponse
Ответное сообщение для media.listcustomermediaitems.
Поля | |
---|---|
media_items[] | Вернуемый список предметов СМИ. |
total_media_item_count | Общее количество средств массовой информации для этого места, независимо от страниц. Это число является приблизительным, особенно когда есть несколько страниц результатов. |
next_page_token | Если есть больше элементов мультимедиа, чем запрашиваемый размер страницы, то это поле заполнено токеном, чтобы получить следующую страницу элементов мультимедиа при последующем вызове с ListCustomerMediaItems. |
ListInsUrancenetWorksRequest
Запросить сообщение для insurancenetworkservice.listinsurancenetworks
Поля | |
---|---|
parent | Необходимый. Название места, страховые сети которого будут указаны. Имя в форме: Accounts/{account_id}/locations/{location_id} |
language_code | Необязательный. Код BCP 47 для языка. Если код языка не указан, по умолчанию используется английский. На данный момент поддерживается только «en». |
page_size | Сколько страховых сетей вернуть на страницу. Значение по умолчанию — 5000. Максимальный размер страницы — 10000. |
page_token | Если указано, возвращает следующую страницу страховых сетей. |
ListInsUrancenetWorksResponse
Ответное сообщение для InsuranceNetworkService.ListInsuranceNetworks
Поля | |
---|---|
networks[] | Список страховых сетей, поддерживаемых Google. |
next_page_token | Если есть больше страховых сетей, чем запрашиваемый размер страницы, то это поле заполнено токеном, чтобы получить следующую страницу страховых сетей при последующем вызове ListInsurancenetWorks. |
Список приглашенийЗапрос
Сообщение запроса для AccessControl.ListInvitations.
Поля | |
---|---|
parent | Имя учетной записи, из которой извлекается список приглашений. |
target_type | Указывает, какие целевые типы должны отображаться в ответе. |
Тип цели
Тип цели, для которой предназначено приглашение.
Перечисления | |
---|---|
ALL | Перечислите приглашения для всех целевых типов. Это значение по умолчанию. |
ACCOUNTS_ONLY | Перечислите приглашения только для целей типа «Учетная запись». |
LOCATIONS_ONLY | Перечислите приглашения только для целей типа «Местоположение». |
Список приглашенийОтвет
Ответное сообщение для AccessControl.ListInvitations.
Поля | |
---|---|
invitations[] | Коллекция приглашений на местоположение, которые находятся на рассмотрении для учетной записи. Количество приглашений, перечисленных здесь, не может превышать 1000. |
Listlocalpostsrequest
Запросить сообщение для ListLocalPosts
Поля | |
---|---|
parent | Название местоположения, чьи местные посты будут перечислены. |
page_size | Сколько местных сообщений вернуть на страницу. По умолчанию 20. Минимум составляет 1, а максимальный размер страницы составляет 100. |
page_token | Если указано, возвращает следующую страницу локальных сообщений. |
Listlocalpostsresponse
Ответное сообщение для ListLocalPosts
Поля | |
---|---|
local_posts[] | Вернутый список местных сообщений. |
next_page_token | Если есть больше локальных сообщений, чем запрашиваемый размер страницы, то это поле заполнено токеном, чтобы получить следующую страницу локальных сообщений при последующем вызове с |
СписокМестоположениеАдминистраторыЗапрос
Сообщение запроса для AccessControl.ListLocationAdmins.
Поля | |
---|---|
parent | Название места, администраторов которого нужно вывести в список. |
ListLocationAdminsResponse
Ответное сообщение для AccessControl.ListLocationAdmins.
Поля | |
---|---|
admins[] | Коллекция экземпляров |
ListLocationsRequest
Запросить сообщение о локациях.
Поля | |
---|---|
parent | Имя учетной записи, из которой нужно получить данные о местоположениях. Если |
page_size | Сколько местоположений нужно получить на странице. По умолчанию — 100, минимум — 1, максимальный размер страницы — 100. |
page_token | Если указано, извлекается следующая |
filter | Фильтр, ограничивающий возвращаемые местоположения. Ответ включает только записи, соответствующие фильтру. Если Дополнительные сведения о допустимых полях и примерах их использования см. в Руководстве по работе с данными о местоположении . |
language_code | Код языка BCP 47, на котором будут отображаться свойства местоположения. Если этот язык недоступен, они будут предоставлены на языке местоположения. Если ни один из них недоступен, они будут предоставлены на английском языке. Устарело. После 15 августа 2020 года это поле больше не будет применяться. Вместо этого язык местоположения всегда будет использоваться. |
order_by | Порядок сортировки запроса. Несколько полей должны быть разделены запятыми в соответствии с синтаксисом SQL. По умолчанию порядок сортировки — по возрастанию. Чтобы указать порядок убывания, следует добавить суффикс «desc». Допустимые поля для order_by являются location_name и store_code. Например: "location_name, store_code desc" или "location_name" или "store_code desc" |
ListLocationsResponse
Ответ Сообщение для локаций.
Поля | |
---|---|
locations[] | Локации. |
next_page_token | Если количество местоположений превысило запрошенный размер страницы, это поле заполнено токеном, чтобы получить следующую страницу местоположений при последующем вызове к |
total_size | Примерное количество локаций в списке независимо от нумерации страниц. |
ListMediaItemsRequest
Запросить сообщение для media.listmediaitems.
Поля | |
---|---|
parent | Название местоположения, чьи средства массовой информации будут перечислены. |
page_size | Сколько элементов медиа возврата на страницу. Значение по умолчанию составляет 100, что также является максимально поддерживаемым количеством элементов мультимедиа, которые могут быть добавлены в место с Google My Business API. Максимальный размер страницы - 2500. |
page_token | Если указано, возвращает следующую страницу элементов мультимедиа. |
ListMediaItemSresponse
Ответное сообщение для media.listmediaitems.
Поля | |
---|---|
media_items[] | Вернуемый список предметов СМИ. |
total_media_item_count | Общее количество средств массовой информации для этого места, независимо от страниц. |
next_page_token | Если есть больше элементов мультимедиа, чем запрашиваемый размер страницы, то это поле заполнено токеном, чтобы получить следующую страницу элементов мультимедиа при последующем вызове ListMediaItems. |
ListQuestionsRequest
Запросить сообщение о вопросах andanswers.listquestions
Поля | |
---|---|
parent | Название местоположения, чтобы получить вопросы для. |
page_size | Сколько вопросов получить на страницу. Значения по умолчанию и максимум |
page_token | Если указано, получена следующая страница вопросов. |
answers_per_question | Сколько ответов на получение за вопрос. Значения по умолчанию и максимальному |
filter | Фильтр, ограничивающий вопросы для возврата. Единственный фильтр, поддерживаемый в настоящее время, - это "Ignore_answered = true" |
order_by | Приказ вернуть вопросы. Действительные параметры включают «Update_time desc» и «upvote_count desc», которые возвращают вопросы, отсортированные нисходящими по запрашиваемому полю. Порядок сортировки по умолчанию - «Update_time desc». |
ListQuestionsResponse
Ответное сообщение для вопросов andanswers.listquestions
Поля | |
---|---|
questions[] | Запрошенные вопросы, |
total_size | Общее количество вопросов, размещенных для этого места на всех страницах. |
next_page_token | Если количество вопросов превышает запрошенный размер максимальной страницы, это поле заполнено токеном, чтобы получить следующую страницу вопросов при последующем вызове. Если нет вопросов, это поле не присутствует в ответе. |
ListrecommendedGoogleLocationsRequest
Запросить сообщение на перечисление рекомендуемых мест для учетной записи бизнес -профиля.
Поля | |
---|---|
name | Название ресурса учетной записи для получения рекомендованных местоположений Google. |
page_size | Сколько местоположений нужно получить на странице. По умолчанию — 25, минимум — 1, максимальный размер страницы — 100. |
page_token | Если указано, извлекается следующая страница местоположений. |
ListrecommendedGoogleLocationsResponse
Ответное сообщение для GoogleLocations.ListRecommendedGoogleLocations.
Он также содержит некоторые местоположения, на которые заявили права другие пользователи бизнес-профиля с тех пор, как они в последний раз были рекомендованы этому аккаунту бизнес-профиля.
Поля | |
---|---|
google_locations[] | Местоположение, рекомендованное для аккаунта профиля компании. Каждый из них представляет местоположение |
total_size | Общее количество рекомендуемых местоположений для этого аккаунта профиля компании, независимо от нумерации страниц. |
next_page_token | Во время разбивки на страницы, если на следующей странице доступно больше местоположений, это поле заполняется токеном для получения следующей страницы местоположений при последующем вызове. Если больше нет местоположений для выборки, это поле отсутствует в ответе. |
ListreviewSrequest
Запросить сообщение о просмотре.
Поля | |
---|---|
parent | Название местоположения для получения обзоров для. |
page_size | Сколько обзоров для получения на страницу. Максимальный |
page_token | Если указано, он получает следующую страницу обзоров. |
order_by | Определяет поле для сортировки обзоров. В случае неопределенности, возвращаемый порядок обзоров по умолчанию по умолчанию в |
ListreviewSresponse
Ответ Сообщение для обзоров. Listreviews.
Поля | |
---|---|
reviews[] | Отзывы. |
average_rating | Средний рейтинг звезд всех обзоров для этого места по шкале от 1 до 5, где 5 - самый высокий рейтинг. |
total_review_count | Общее количество обзоров для этого места. |
next_page_token | Если количество отзывов превысило запрошенный размер страницы, это поле заполнено токеном, чтобы получить следующую страницу отзывов при последующем вызове Listreviews. Если больше нет отзывов, это поле не присутствует в ответе. |
ListVerificationsRequest
Запросить сообщение для проверки. Списокверирование.
Поля | |
---|---|
parent | Название ресурса местоположения, к которому принадлежат запросы на проверку. |
page_size | Сколько проверки включать на страницу. Если не установлено, верните все. |
page_token | Если указано, возвращает следующую страницу проверки. |
ListVerificationsResponse
Ответное сообщение для проверки. Списокверирование.
Поля | |
---|---|
verifications[] | Список проверки. |
next_page_token | Если количество проверки превысило запрошенную размер страницы, это поле будет заполнено токеном, чтобы получить следующую страницу проверки при последующем вызове. Если больше нет атрибутов, это поле не будет присутствовать в ответе. |
LocalPost
Представляет местный пост для местоположения.
Поля | |
---|---|
name | Только вывод. Идентификатор Google для этого локального поста в форме: |
language_code | Язык местного поста. |
summary | Описание/Тело местного поста. |
call_to_action | URL -адрес, на который пользователи отправляются при нажатии на акцию. Игнорируется для |
create_time | Только вывод. Время создания поста. |
update_time | Только вывод. Время последней модификации поста, сделанного пользователем. |
event | Информация о событии. Требуется для |
state | Только вывод. Состояние поста, указывающее, в какой части его жизненного цикла он находится. |
media[] | СМИ, связанные с постом. Source_url - единственное поддерживаемое поле данных для LocalPost MediaItem. |
search_url | Только вывод. Ссылка на локальный пост в Google Search. Эта ссылка может быть использована для обмена сообщением через социальные сети, электронную почту, текст и т. Д. |
topic_type | Необходимый. Тип темы поста: Стандартное, событие, предложение или предупреждение. |
alert_type | Тип оповещения, созданный пост для. Это поле применимо только к сообщениям о предупреждении topic_type и ведет себя как подтип оповещений. |
offer | Дополнительные данные для предложений. Это должно быть установлено только тогда, когда предложена тема_тип. |
LocalPoststate
Указывает, в каком состоянии находится почта в
Перечисления | |
---|---|
LOCAL_POST_STATE_UNSPECIFIED | Состояние не указано. |
REJECTED | Этот пост был отклонен из -за нарушения политики контента. |
LIVE | Этот пост опубликован и в настоящее время появляется в результатах поиска. |
PROCESSING | Этот пост обрабатывается и не появляется в результатах поиска. |
LocalPostevent
Вся информация, относящаяся к событию, представленной в местном посте.
Поля | |
---|---|
title | Название события. |
schedule | Событие даты начала и окончания/времени. |
LocalPostmetrics
Все метрики запрошены на местный пост.
Поля | |
---|---|
local_post_name | |
metric_values[] | Список значений для запрошенных метрик. |
LocalPostoffer
Конкретные поля для предложений.
Поля | |
---|---|
coupon_code | Необязательный. Предложите код, который можно использовать в магазине или онлайн. |
redeem_online_url | Необязательный. Ссылка на онлайн на предложение об искуплении. |
terms_conditions | Необязательный. Предлагаем положения и условия. |
LocalPostTopicType
Тип темы локального поста, который используется для выбора разных шаблонов для создания и отображения поста.
Перечисления | |
---|---|
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED | Тип поста не указан. |
STANDARD | Post содержит основную информацию, такую как резюме и изображения. |
EVENT | Post содержит основную информацию и событие. |
OFFER | Post содержит основную информацию, событие и предложение, связанное с контентом (например, код купона) |
ALERT | Высокие и своевременные объявления, связанные с продолжающимся событием. Эти типы сообщений не всегда доступны для авторизации. |
Расположение
Местоположение. См. Статью «Справочный центр» для подробного описания этих полей или конечной точки категории для списка действительных бизнес -категорий.
Поля | |
---|---|
name | Идентификатор Google для этого местоположения в форме: В контексте матчей это поле не будет заполнено. |
language_code | Язык местоположения. Установить во время создания и не обновлять. |
store_code | Внешний идентификатор для этого места, который должен быть уникальным внутри данной учетной записи. Это средство связывания местоположения с вашими собственными записями. |
location_name | Название местоположения должно отражать реальное название вашего бизнеса, как постоянно используется на вашем магазине, веб-сайте и канцелярских товарах, и, как известно клиентам. Любая дополнительная информация, когда она имеет отношение, может быть включена в другие области ресурса (например, |
primary_phone | Номер телефона, который подключается к вашему отдельному бизнесу как можно напрямую. Используйте локальный номер телефона вместо центрального номера головоломки на колл -центре, когда это возможно. |
additional_phones[] | До двух телефонов (мобильный или стационарный, без факса), на котором можно вызвать ваш бизнес, в дополнение к вашему основному номеру телефона. |
address | Точный, точный адрес для описания местоположения вашего бизнеса. PO Boxes или почтовые ящики, расположенные в удаленных местах, неприемлемы. В настоящее время вы можете указать максимум пять значений |
primary_category | Категория, которая лучше всего описывает основной бизнес, в котором участвует это место. |
additional_categories[] | Дополнительные категории для описания вашего бизнеса. Категории помогают вашим клиентам найти точные, конкретные результаты для услуг, которые они заинтересованы. Выберите категории, которые являются максимально конкретными, но представитель вашего основного бизнеса. |
website_url | URL для этого бизнеса. Если возможно, используйте URL, который представляет это отдельное местоположение бизнеса вместо общего веб -сайта/URL, который представляет все местоположения, или бренд. |
regular_hours | Часы работы для бизнеса. |
special_hours | Особые часы для бизнеса. Обычно это включает в себя праздничные часы, а в других случаях вне обычных рабочих часов. Это переопределяет обычные рабочие часы. |
service_area | Предприятия в области обслуживания предоставляют свой сервис в местоположении клиента. Если этот бизнес является бизнесом в области обслуживания, в этой области описывается район, обслуживаемый бизнесом. |
location_key | Коллекция ключей, которые связывают этот бизнес с другими свойствами Google, таких как страница Google+ и Google Maps. |
labels[] | Коллекция строк свободной формы, позволяющая вам пометить ваш бизнес. Эти этикетки не сталкиваются с пользователем; Только вы можете их увидеть. Ограничено 255 символами (на этикетке). |
ad_words_location_extensions | Дополнительная информация, которая появляется в AdWords. |
latlng | Предоставленная пользователем широта и долгота. При создании местоположения это поле игнорируется, если предоставленные геокоды адреса успешно. Это поле возвращается по запросам GET только в том случае, если предоставленное пользователем значение |
open_info | Флаг, который указывает, является ли местоположение в настоящее время открыто для бизнеса. |
location_state | Только вывод. Набор логических, которые отражают состояние местоположения. |
attributes[] | Атрибуты для этого места. |
metadata | Только вывод. Дополнительная не пользовательская информация. |
price_lists[] | Установилось: информация о ценовом списке для этого места. |
profile | Описывает свой бизнес своим собственным голосом и делится с пользователями уникальной истории вашего бизнеса и предложений. |
relationship_data | Все места и цепь связаны с этим. |
more_hours[] | Больше часов для различных департаментов бизнеса или конкретных клиентов. |
Метаданные
Дополнительная не пользовательская информация о местоположении.
Поля | |
---|---|
duplicate | Информация о месте, где дублирует это местоположение. Присутствует только тогда, когда |
maps_url | Ссылка на местоположение на картах. |
new_review_url | Ссылка на страницу в поиске Google, где клиент может оставить отзыв для местоположения. |
Дублировать
Информация о месте, где дублирует это местоположение.
Поля | |
---|---|
location_name | Название ресурса места, которое это дублирует. Заполнено только если у аутентифицированного пользователя есть права доступа к этому местоположению, и это место не удалено. |
place_id | Место идентификатор места, которое это дублирует. |
access | Указывает, имеет ли пользователь доступ к месту, которое он дублирует. |
Доступ
Уровень доступа пользователя к месту, которое он дублирует. Это заменяет право собственности и должно использоваться вместо этого.
Перечисления | |
---|---|
ACCESS_UNSPECIFIED | Не указан. |
ACCESS_UNKNOWN | Невозможно определить, имеет ли пользователь доступ к месту, которое он дублирует. |
ALLOWED | У пользователя есть доступ к месту, которое он дублирует. |
INSUFFICIENT | У пользователя нет доступа к месту, которое он дублирует. |
Отношения
Информация всех мест для родителей и детей, связанных с этим.
Поля | |
---|---|
parent_chain | Название ресурса цепочки, которой является это место. |
LocationDrivingDirectionMetrics
Местоположение, индексируемое с регионами, из которых обычно приходят люди. Это запечатлено путем подсчета, сколько запросов направления вождения в этом месте находится из каждого региона.
Поля | |
---|---|
location_name | Название ресурса местоположения. Это метрическое значение принадлежит. |
top_direction_sources[] | Запросы направления вождения по исходному региону. По соглашению, они отсортированы по подсчету с максимум 10 результатов. |
time_zone | Часовой пояс (Iana Timezone ID, например, «Европа/Лондон»). |
TopDirectionsources
Верхние регионы, откуда возникли запросы на направление вождения.
Поля | |
---|---|
day_count | Количество дней данных агрегировано. |
region_counts[] | Регионы отсортированы в порядке убывания по графу. |
Регионат
Регион с связанным с этим запрос.
Поля | |
---|---|
latlng | Центр региона. |
label | Черопитая этикетка для региона. |
count | Количество запросов направления вождения из этого региона. |
LocationKey
Альтернативные/суррогатные ссылки на ключ для местоположения.
Поля | |
---|---|
plus_page_id | Только вывод. Если в этом месте связана страница Google+, это заполняется идентификатором страницы Google+ для этого места. |
place_id | Если это место было проверено и подключено к/отображается на картах Google, это поле заполнено идентификатором места для места. Этот идентификатор может быть использован в различных местах API. Если это место не является проверенным, это поле может быть заполнено, если местоположение было связано с местом, которое появляется на картах Google. Это поле может быть установлено во время создания вызовов, но не для обновления. Дополнительный |
explicit_no_place_id | Только вывод. Значение истина указывает, что идентификатор незаметного места преднамерен, что отличается от никакой связи еще. |
request_id | Только вывод. |
LocationMetrics
Серия метрик и разбивки, связанные с местоположением в течение некоторого времени.
Поля | |
---|---|
location_name | Имя ресурса местоположения эти значения принадлежат. |
time_zone | Яна часовой пояс для места. |
metric_values[] | Список значений для запрошенных метрик. |
LocationReview
Представляет обзор с информацией о местоположении.
Поля | |
---|---|
name | Имя ресурса местоположения. |
review | Обзор для местоположения. |
Штат место
Содержит набор логических, которые отражают состояние местоположения.
Поля | |
---|---|
is_google_updated | Только вывод. Указывает, имеет ли идентификатор места, связанный с этим местоположением, обновляется. |
is_duplicate | Только вывод. Указывает, является ли расположение дубликатом другого места. |
is_suspended | Только вывод. Указывает, является ли местоположение приостановлено. Приостановленные местоположения не видны конечным пользователям в продуктах Google. Если вы считаете, что это была ошибка, см. Статью о справочнике . |
can_update | Только вывод. Указывает, можно ли обновить местоположение. |
can_delete | Только вывод. Указывает, можно ли удалить местоположение с помощью Google My Business API. |
is_verified | Только вывод. Указывает, подтверждается ли местоположение. |
needs_reverification | Только вывод. Указывает, требует ли местоположение. |
is_pending_review | Только вывод. Указывает, находится ли обзор местоположения в ожидании. |
is_disabled | Только вывод. Указывает, отключено ли местоположение. |
is_published | Только вывод. Указывает, опубликовано ли место. |
is_disconnected | Только вывод. Указывает, отключено ли место от места на картах Google. |
is_local_post_api_disabled | Только вывод. Указывает, отключены ли alcounts.locations.localposts для этого места. |
can_modify_service_list | Только вывод. Указывает, может ли листинг изменять сервис -директор. |
can_have_food_menus | Только вывод. Указывает, имеет ли листинг право на меню еды. |
has_pending_edits | Только вывод. Указывает, находится ли какое -либо из свойств этого места в редактировании в ожидании состояния. |
has_pending_verification | Только вывод. Указывает, имеет ли местоположение ожидаемые запросы на проверку. |
can_operate_health_data | Только вывод. Указывает, может ли расположение работать на данных о здоровье. |
can_operate_lodging_data | Только вывод. Указывает, может ли место работать на данных о проживании. |
MatchedLocation
Представляет возможное совпадение с местоположением.
Поля | |
---|---|
location | Редко заселенное местоположение, которое является потенциальным совпадением. Unpopulated fields include, but may not be limited to: name (the matched location cannot be retrieved via |
is_exact_match | Is this an exact match? |
MediaItem
Один медиа-объект.
Поля | ||
---|---|---|
name | Имя ресурса для этого элемента мультимедиа. | |
media_format | Формат этого медиа-элемента. Должен быть установлен при создании элемента мультимедиа и доступен только для чтения для всех остальных запросов. Невозможно обновить. | |
location_association | Требуется при вызове This is required when adding new media to a location with | |
google_url | Только вывод. URL-адрес этого медиафайла, размещенный в Google. Этот URL-адрес не является статическим, поскольку со временем он может меняться. Для видео это будет изображение предварительного просмотра с наложенным значком воспроизведения. | |
thumbnail_url | Только вывод. Если указано, URL-адрес миниатюры этого медиа-элемента. | |
create_time | Только вывод. Время создания этого медиа-элемента. | |
dimensions | Только вывод. Размеры (ширина и высота) в пикселях. | |
insights | Только вывод. Статистика для этого медиа-материала. | |
attribution | Только вывод. Информация об атрибуции медиа-элементов клиента. Вы должны отображать эту атрибуцию так, как она предоставлена вашим пользователям, и не должны удалять или изменять ее. | |
description | Description for this media item. Описания нельзя изменить через Google My Business API, но их можно установить при создании нового медиа-элемента, который не является обложкой. | |
За исключением категорий Все загружаемые фотографии должны соответствовать рекомендациям для фотографий в профиле компании . | ||
source_url | Общедоступный URL-адрес, по которому можно получить элемент мультимедиа. When creating one of this or data_ref must be set to specify the source of the media item. If Это поле не может быть обновлено. | |
data_ref | Только ввод. A reference to media item binary data as obtained by the При создании медиа-элемента либо или должен быть установлен. |
Атрибуция
Информация об авторстве для медиа-элементов клиента, например имя автора и изображение профиля.
Поля | |
---|---|
profile_name | Имя пользователя, которому будет присвоен элемент мультимедиа. |
profile_photo_url | URL миниатюры фотографии профиля связанного пользователя. |
takedown_url | URL-адрес страницы удаления, на которой можно сообщить о неприемлемом медиа-элементе. |
profile_url | URL-адрес страницы профиля Google Maps связанного пользователя. |
Размеры
Размеры медиа-объекта.
Поля | |
---|---|
width_pixels | Ширина медиа-элемента в пикселях. |
height_pixels | Высота мультимедийного элемента в пикселях. |
МестоположениеАссоциация
Как медиа-элемент связан со своим местоположением.
Поля | ||
---|---|---|
Поле объединения location_attachment_type . Носители местоположения должны иметь категорию или идентификатор элемента прайс-листа, с которым они связаны. Средства массовой информации, не относящиеся к локации (например, фотографии местных постов), не должны иметь ни того, ни другого. location_attachment_type может быть только одним из следующих: | ||
category | Категория, к которой принадлежит это фото места. | |
price_list_item_id | Идентификатор позиции прайс-листа, с которой связана эта фотография местоположения. |
Категория
Перечисление для категории медиа-элемента.
Перечисления | |
---|---|
CATEGORY_UNSPECIFIED | Неуказанная категория. |
COVER | Фото на обложке. У локации есть только одна обложка. |
PROFILE | Аватар. У каждого местоположения есть только одна фотография профиля. |
LOGO | Фотография логотипа. |
EXTERIOR | Внешние СМИ. |
INTERIOR | Внутренние СМИ. |
PRODUCT | Продуктовые носители. |
AT_WORK | «Действующие» СМИ. |
FOOD_AND_DRINK | СМИ о еде и напитках. |
MENU | Меню медиа. |
COMMON_AREA | Средства массовой информации общего пользования. |
ROOMS | Номера СМИ. |
TEAMS | Медиа команд. |
ADDITIONAL | Дополнительные, неклассифицированные медиа. |
Медиаформат
Перечисление для формата мультимедиа.
Перечисления | |
---|---|
MEDIA_FORMAT_UNSPECIFIED | Формат не указан. |
PHOTO | Медиа-элемент — фотография. В этой версии поддерживаются только фотографии. |
VIDEO | Медиа-элемент — видео. |
МедиаИнсайтс
Аналитика и статистика по медиа-материалу.
Поля | |
---|---|
view_count | Только вывод. Сколько раз был просмотрен медиа-элемент. |
Медиаитемдатареф
Ссылка на двоичные данные фотографии 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 | Уникальный идентификатор двоичных данных этого элемента мультимедиа. Used to upload the photo data with [UpdateMedia] and when creating a new media item from those bytes with Example of uploading bytes: For |
MenuLabel
Label to be used when displaying the menu and its various sub-components.
Поля | |
---|---|
display_name | Необходимый. Display name of the component. |
description | Необязательный. Supplementary information of the component. |
language_code | Необязательный. 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. |
VIEWS_SEARCH | The number of times the resource was viewed on Google Search. |
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 | The requested metric. |
options[] | How the values should appear when returned. |
MetricValue
A value for a single Metric from a starting time.
Поля | |
---|---|
metric | The metric for which the value applies. |
total_value | The total aggregated value for this metric. Set for the AGGREGATED_TOTAL option. |
dimensional_values[] | Dimensional values for this metric. |
MoreHours
The time periods during which a location is open for certain types of business.
Поля | |
---|---|
hours_type_id | Необходимый. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations. |
periods[] | Необходимый. 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 | Только вывод. A stable ID provided by Google for this hours type. |
display_name | Только вывод. The human-readable English display name for the hours type. |
localized_display_name | Только вывод. 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 | Только вывод. The notifications resource name. |
topic_name | 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[] | 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 |
Пищевая ценность
This message represents nutrition facts for a food dish.
Поля | |
---|---|
calories | Необязательный. Calories of the dish. |
total_fat | Необязательный. Fat information for a given food dish. |
cholesterol | Необязательный. Cholesterol information for a given food dish. |
sodium | Необязательный. Sodium information for a given food dish. |
total_carbohydrate | Необязательный. Carbohydrate information for a given food dish. |
protein | Необязательный. 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 | Необходимый. Lower amount of calories |
upper_amount | Необязательный. Upper amount of calories |
unit | Необходимый. 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 | Необходимый. Lower amount of nutrition |
upper_amount | Необязательный. Upper amount of nutrition |
unit | Необходимый. Unit of the given nutrition information. |
OpenInfo
Information related to the opening state of the business.
Поля | |
---|---|
status | Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed. |
can_reopen | Только вывод. Indicates whether this business is eligible for re-open. |
opening_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 | 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 | The localized name of the place. For example, |
place_id | The ID of the place. Must correspond to a region. |
Места
Defines the union of areas represented by a set of places.
Поля | |
---|---|
place_infos[] | The areas represented by place IDs. Limited to a maximum of 20 places. |
PointRadius
A radius around a particular point (latitude/longitude).
Поля | |
---|---|
latlng | The latitude/longitude that specifies the center of an area defined by the radius. |
radius_km | 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 | Необходимый. ID for the price list. Price list, section, and item IDs cannot be duplicated within this Location. |
labels[] | Необходимый. Language-tagged labels for the price list. |
source_url | 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[] | Необходимый. 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 | Необходимый. Display name for the price list, section, or item. |
description | Необязательный. Description of the price list, section, or item. |
language_code | Необязательный. 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 | Необходимый. ID for the section. Price list, section, and item IDs cannot be duplicated within this Location. |
labels[] | Необходимый. 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 | Необязательный. Type of the current price list section. Default value is FOOD. |
items[] | 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 | Необходимый. ID for the item. Price list, section, and item IDs cannot be duplicated within this Location. |
labels[] | Необходимый. 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 | Необязательный. 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 | Description of the location in your own voice, not editable by anyone else. |
Вопрос
Represents a single question and some of its answers.
Поля | |
---|---|
name | Только вывод. The unique name for the question. accounts/*/locations/*/questions/* |
author | Только вывод. The author of the question. |
upvote_count | Только вывод. The number of upvotes for the question. |
text | 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 | Только вывод. The timestamp for when the question was written. |
update_time | Только вывод. The timestamp for when the question was last modified. |
top_answers[] | Только вывод. 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 | Только вывод. 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[] | Enum values that are set. |
unset_values[] | Enum values that are unset. |
ReportGoogleLocationRequest
Request message for reporting a GoogleLocation
.
Поля | ||
---|---|---|
name | Resource name of a [GoogleLocation], in the format | |
location_group_name | Необязательный. The resource name of the location group that this Google Location is being reported for, in the format | |
report_reason_elaboration | Необязательный. 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 | Необязательный. The BCP 47 code of language used in | |
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 | The reason for which the user is reporting this location when the issue is with the location itself. | |
report_reason_bad_recommendation | 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 |
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 Should be accompanied by a |
IRRELEVANT | The recommended location is not relevant to the user. Should be accompanied by a |
ReportLocalPostInsightsRequest
Request message for Insights.ReportLocalPostInsights
Поля | |
---|---|
name | Необходимый. The name of the location for which to fetch insights. |
local_post_names[] | Необходимый. The list of posts for which to fetch insights data. All posts have to belong to the location whose name is specified in the |
basic_request | A request to include basic metric insights in the report. This request applies to all posts requested. |
ReportLocalPostInsightsResponse
Response message for Insights.ReportLocalPostInsights
Поля | |
---|---|
name | |
local_post_metrics[] | One entry per requested post corresponding to this location. |
time_zone | Time zone (IANA timezone IDs, eg, 'Europe/London') of the location. |
ReportLocationInsightsRequest
Request message for Insights.ReportLocationInsights.
Поля | |
---|---|
name | The account resource name. |
location_names[] | A collection of locations to fetch insights for, specified by their names. |
basic_request | A request to include basic metric insights in the report. |
driving_directions_request | A request to include insights about driving-direction requests in the report. |
ReportLocationInsightsResponse
Response message for Insights.ReportLocationInsights
.
Поля | |
---|---|
location_metrics[] | A collection of metric values by location. |
location_driving_direction_metrics[] | A collection of values for driving direction-related metrics. |
Обзор
Только вывод. Represents a review for a location.
Поля | |
---|---|
name | Имя ресурса. For Review it is of the form |
review_id | The encrypted unique identifier. |
reviewer | The author of the review. |
star_rating | The star rating of the review. |
comment | The body of the review as plain text with markups. |
create_time | The timestamp for when the review was written. |
update_time | The timestamp for when the review was last modified. |
review_reply | The owner/manager of this location's reply to this review. |
Рецензент
Represents the author of the review.
Поля | |
---|---|
profile_photo_url | The profile photo link of the reviewer. Only populated if |
display_name | The name of the reviewer. Only populated with the reviewer's real name if |
is_anonymous | 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 | The body of the reply as plain text with markups. The maximum length is 4096 bytes. |
update_time | Только вывод. The timestamp for when the reply was last modified. |
SearchChainsRequest
Request message for Locations.SearchChains.
Поля | |
---|---|
chain_display_name | Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: "walmart", "wal-mart", "walmmmart", "沃尔玛" |
result_count | 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[] | 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 | 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 to search for. If provided, will find locations which match the provided location details. | |
query | 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[] | 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 | Indicates the | |
Union field coverageArea . Indicates the coverage area where the business offers service. coverageArea can be only one of the following: | ||
radius | Только вывод. The area that this business serves centered around a point. | |
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 | 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 | Необходимый. Google identifier for this location in the form: |
service_items[] | 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 | Необязательный. This field decides whether or not the input service is offered by the merchant. | |
price | Необязательный. 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 | This field will be set case of structured services data. | |
free_form_service_item | 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 | Необходимый. The |
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 | Необходимый. The |
description | Необязательный. Description of structured service item. The character limit is 300. |
Тип Обслуживания
A message describing a service type that the business offers.
Поля | |
---|---|
service_type_id | Только вывод. A stable ID (provided by Google) for this service type. |
display_name | Только вывод. 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 | The calendar date this special hour period starts on. |
open_time | The wall time on |
end_date | The calendar date this special hour period ends on. If |
close_time | The wall time on |
is_closed | If true, |
SpecialHours
Represents a set of time periods when a location's operational hours differ from its normal business hours.
Поля | |
---|---|
special_hour_periods[] | 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 | 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 | The start date of this period. |
start_time | The start time of this period. |
end_date | The end date of this period. |
end_time | 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 | Indicates the |
open_time | 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 | Indicates the |
close_time | 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 | Epoch timestamp for the start of the range (inclusive). |
end_time | Epoch timestamp for the end of the range (exclusive). |
ТрансферМестоположениеЗапрос
Request message for Locations.TransferLocation.
Поля | |
---|---|
name | Имя места для переноса. |
to_account | Name of the account resource to transfer the location to (for example, "accounts/8675309"). |
ОбновлениеАккаунтАдминистратораЗапрос
Сообщение запроса для AccessControl.UpdateAccountAdmin.
Поля | |
---|---|
name | The resource name of the admin to update. |
admin | The updated admin. Note: The only editable field is |
Запрос обновления аккаунта
Сообщение запроса для Accounts.UpdateAccount.
Поля | |
---|---|
name | Имя учетной записи для обновления. |
account | The updated account information. Note: The only editable field is |
validate_only | Если это правда, запрос проверяется без фактического обновления учетной записи. |
UpdateFoodMenusRequest
Request message for FoodMenu.UpdateFoodMenus
Поля | |
---|---|
food_menus | Необходимый. The updated food menu information. Menu can be unset by updating without any menu sections. |
update_mask | Необязательный. Конкретные поля для обновления. Если маска не указана, это рассматривается как полное обновление, и всем полям присваиваются переданные значения, что может включать в себя снятие пустых полей в запросе. 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 | Необходимый. The updated health provider attributes. |
update_mask | Необязательный. Конкретные поля для обновления. Если маска не указана, это рассматривается как полное обновление, и всем полям присваиваются переданные значения, что может включать в себя снятие пустых полей в запросе. In V1, there is only the insurance_networks field to update. Дополнительные атрибуты будут поддерживаться позже. |
UpdateLocalPostRequest
Request message for UpdateLocalPost.
Поля | |
---|---|
name | The name of the local post to update. |
local_post | The updated local post information. |
update_mask | Конкретные поля для обновления. You must specify each field that is being updated in the mask. |
ОбновлениеLocationAdminRequest
Сообщение запроса для AccessControl.UpdateLocationAdmin.
Поля | |
---|---|
name | The resource name of the admin to update. |
admin | The updated admin. Note: The only editable field is |
UpdateLocationRequest
Request message for Locations.UpdateLocation.
Поля | |
---|---|
name | The name of the location to update. |
location | The updated location information. |
update_mask | Конкретные поля для обновления. Если маска не указана, это рассматривается как полное обновление, и всем полям присваиваются переданные значения, что может включать в себя снятие пустых полей в запросе. |
validate_only | If true, the request is validated without actually updating the location. |
attribute_mask | 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 | The name of the media item to be updated. |
media_item | The media item to be updated. Only the category or price list item id can be updated. |
update_mask | Конкретные поля для обновления. 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 | The notification settings resource name. |
notifications | The updated notification settings. |
UpdateQuestionRequest
Request message for QuestionsAndAnswers.UpdateQuestion
Поля | |
---|---|
name | The name of the question to update. |
question | The updated question. |
UpdateReviewReplyRequest
Request message for Reviews.UpdateReviewReply.
Поля | |
---|---|
name | The name of the review to respond to. |
review_reply | The reply to the review. If a reply already exists, this will replace the old reply. |
UpdateServiceListRequest
Update service list request message.
Поля | |
---|---|
service_list | Необязательный. 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 | Необязательный. Конкретные поля для обновления. Если маска не указана, это рассматривается как полное обновление, и всем полям присваиваются переданные значения, что может включать в себя снятие пустых полей в запросе. Repeated field items can not be individually updated. |
UpsertAnswerRequest
Request message for QuestionsAndAnswers.UpsertAnswer
Поля | |
---|---|
parent | The name of the question to write an answer for. |
answer | The new answer. |
UrlAttributeValue
Values for an attribute with a value_type
of URL.
Поля | |
---|---|
url | URL-адрес. |
Ошибка проверки
Describes validation failures in a client request.
Поля | |
---|---|
error_details[] | Details individual validation failures with integer error codes. |
Проверка
A verification represents a verification attempt on a location.
Поля | |
---|---|
name | Resource name of the verification. |
method | The method of the verification. |
state | The state of the verification. |
create_time | 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 | 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 | Set only if the method is PHONE_CALL or SMS. | |
address_data | Set only if the method is MAIL. | |
email_data | Set only if the method is EMAIL. |
AddressVerificationData
Display data for verifications through postcard.
Поля | |
---|---|
business_name | Merchant's business name. |
address | Address that a postcard can be sent to. |
EmailVerificationData
Display data for verifications through email.
Поля | |
---|---|
domain_name | Domain name in the email address. eg "gmail.com" in foo@gmail.com |
user_name | User name in the email address. eg "foo" in foo@gmail.com |
is_user_name_editable | Whether client is allowed to provide a different user name. |
PhoneVerificationData
Display Data for verifications through phone, eg phone call, sms.
Поля | |
---|---|
phone_number | Phone number that the PIN will be sent to. |
VerifyLocationRequest
Request message for Verifications.VerifyLocation.
Поля | ||
---|---|---|
name | Resource name of the location to verify. | |
method | Verification method. | |
language_code | The BCP 47 language code representing the language that is to be used for the verification process. | |
context | 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 | The input for EMAIL method. | |
address_input | The input for ADDRESS method. | |
phone_input | The input for PHONE_CALL/SMS method |
VerifyLocationResponse
Response message for Verifications.VerifyLocation.
Поля | |
---|---|
verification | The created verification request. |