REST Resource: inventory.partners.merchants

Источник: Торговец

Информация о продавце, представленном на платформе агрегатора.

JSON-представление
{
  "name": string,
  "merchantName": string,
  "telephone": string,
  "url": string,
  "geo": {
    object (GeoCoordinates)
  },
  "category": string,
  "numBookings30d": string,
  "taxRateBasisPoints": integer,
  "taxRate": {
    object (TaxRate)
  },
  "paymentRestrictions": {
    object (PaymentRestrictions)
  },
  "paymentOption": [
    {
      object (PaymentOption)
    }
  ],
  "paymentProcessorConfig": {
    object (PaymentProcessorConfig)
  },
  "tokenizationConfig": {
    object (TokenizationConfig)
  },
  "terms": {
    object (Terms)
  },
  "brandId": string,
  "matchingHints": {
    object (MerchantMatchingHints)
  },
  "serviceAttribute": [
    {
      object (ServiceAttribute)
    }
  ],
  "actionLink": [
    {
      object (ActionLink)
    }
  ],
  "reservationLinkoutTemplate": [
    {
      object (LinkoutTemplate)
    }
  ],
  "waitlistAdvisement": {
    object (Advisement)
  },
  "economicOperator": {
    object (EconomicOperator)
  }
}
Поля
name

string

Название ресурса продавца имеет формат partners/{partner_id}/merchants/{merchantId} .

merchantName

string

Данные merchantName, telephone, url и geo используются для сопоставления ассортимента партнеров с продавцами, уже представленными на Google Maps. Эта информация отображаться не будет.

Название продавца.

telephone

string

Общедоступный телефонный номер продавца, включая коды страны и региона, например, +14567891234.

url

string

URL общедоступного веб-сайта продавца.

geo

object ( GeoCoordinates )

Географическая информация о продавце, включая широту, долготу и адрес.

category

string

Категория бизнеса на платформе агрегатора.

numBookings30d
(deprecated)

string ( int64 format)

Это поле устарело.

taxRateBasisPoints
(deprecated)

integer ( uint32 format)

Налоговая ставка продавца в базисных пунктах (одна сотая процента). Например, если налоговая ставка составляет 7,5%, это поле следует установить на значение 750.

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

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

Это поле устарело, пожалуйста, используйте вместо него taxRate.

taxRate
(deprecated)

object ( TaxRate )

Налоговая ставка продавца. Если это поле присутствует, оно переопределяет устаревшее поле taxRateBasisPoints. Пустое сообщение (например, taxRate { }) обнулит применяемую налоговую ставку. Устарело, поскольку сквозные платежи (E2E) больше не поддерживаются.

paymentRestrictions
(deprecated)

object ( PaymentRestrictions )

Ограничения на способы оплаты, принимаемые этим продавцом. Если это поле не заполнено, предполагается, что ограничений нет. Устарело, поскольку сквозные платежи (E2E payments) больше не поддерживаются.

paymentOption[]
(deprecated)

object ( PaymentOption )

Доступные способы оплаты для этого продавца. Сервисы, работающие с этим продавцом, смогут индивидуально ограничивать доступные способы оплаты. Устарело, поскольку сквозные платежи (E2E payments) больше не поддерживаются.

paymentProcessorConfig
(deprecated)

object ( PaymentProcessorConfig )

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

tokenizationConfig
(deprecated)

object ( TokenizationConfig )

Настройка для токенизированного платежного процессора, если продавец его поддерживает. Устарело, поскольку сквозные платежи (E2E) больше не поддерживаются.

terms

object ( Terms )

Условия и положения конкретного продавца отображаются пользователю при бронировании услуги через систему «Забронировать через Google». Помимо этого, пользователю всегда отображаются условия и положения партнера-агрегатора, которые здесь приводить не нужно.

brandId

string

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

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

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

Если партнёр...

Не имеет нескольких брендов, ориентированных на потребителя? --> Проигнорируйте это поле

Имеется несколько настроенных брендов?

  If this field is set
    --> Associated consumer-facing brand attribution is used

  If this field is unset or the empty string
    --> Default consumer-facing brand attribution is used

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

matchingHints

object ( MerchantMatchingHints )

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

serviceAttribute[]

object ( ServiceAttribute )

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

reservationLinkoutTemplate[]

object ( LinkoutTemplate )

Необязательно. Шаблон для создания ссылки, определяющий, как Google должен генерировать URL-адрес партнера для бронирования столика на его платформе.

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

Шаблон URI поддерживает поля, которые будут заполняться на основе выбора пользователя при бронировании. Для успешного создания URL-адреса бронирования необходимы все обязательные поля: * (обязательно) partySize, int: размер группы, для которой пользователь запрашивает бронирование. * (обязательно) selected_date_time, дата и время в формате ISO 8601 ( https://en.wikipedia.org/wiki/ISO_8601) : время, на которое пользователь запрашивает бронирование. * (необязательно) merchantId, string: идентификатор продавца, у которого пользователь запрашивает бронирование; не требуется, если шаблон уже содержит идентификатор продавца. * (необязательно) roomId, string: идентификатор номера, для которого пользователь запрашивает бронирование.

waitlistAdvisement

object ( Advisement )

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

economicOperator

object ( EconomicOperator )

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

Ограничения платежей

Ограничения на способы оплаты, принимаемые этим продавцом.

JSON-представление
{
  "creditCardRestrictions": {
    object (CreditCardRestrictions)
  }
}
Поля
creditCardRestrictions

object ( CreditCardRestrictions )

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

Ограничения по кредитным картам

Ограничения на типы кредитных карт, принимаемых этим продавцом.

JSON-представление
{
  "creditCardType": [
    enum (CreditCardType)
  ]
}
Поля
creditCardType[]

enum ( CreditCardType )

Список поддерживаемых кредитных карт. Если список пуст, поддержка кредитных карт отсутствует.

Тип кредитной карты

Тип кредитной карты.

Перечисления
CREDIT_CARD_TYPE_UNSPECIFIED Неиспользованный.
VISA Кредитная карта Visa.
MASTERCARD Кредитная карта Mastercard.
AMERICAN_EXPRESS Кредитная карта American Express.
DISCOVER Кредитная карта Discover.
JCB Кредитная карта JCB.

Вариант оплаты

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

JSON-представление
{
  "paymentOptionId": string,
  "name": string,
  "description": string,
  "price": {
    object (Price)
  },
  "taxRate": {
    object (TaxRate)
  },
  "paymentOptionType": enum (PaymentOptionType),
  "sessionCount": string,
  "purchaseInterval": {
    object (TimeRange)
  },
  "validInterval": {
    object (TimeRange)
  },
  "validDuration": string,
  "activationType": enum (ActivationType),
  "userRestriction": {
    object (UserPurchaseRestriction)
  }
}
Поля
paymentOptionId

string

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

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

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

name

string

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

description

string

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

price

object ( Price )

Стоимость выбранного способа оплаты.

taxRate

object ( TaxRate )

Налоговая ставка для данного способа оплаты. Если это поле присутствует, оно переопределяет поле taxRate, имеющееся в настройках продавца или сервиса. Пустое сообщение (например, taxRate { }) обнулит применяемую налоговую ставку.

paymentOptionType

enum ( PaymentOptionType )

Тип оплаты: разовое использование при разовых посещениях, многократное использование при покупке абонементов и неограниченное использование при оформлении членства.

sessionCount

string ( int64 format)

Сколько сеансов можно оплатить этим способом. Действительно только для многосеансовых пакетов, где значение должно быть больше 1.

purchaseInterval

object ( TimeRange )

Способ оплаты можно приобрести в течение этого периода.

validInterval

object ( TimeRange )

Способ оплаты можно использовать в течение этого интервала (например, специальная цена на январь 2017 года). Если он присутствует, то переопределяет значения validDuration и activationType.

validDuration

string ( Duration format)

Срок действия выбранного способа оплаты (например, 30-дневная подписка).

Длительность в секундах, содержащая до девяти знаков после запятой, заканчивающаяся на « s ». Пример: "3.5s" .

activationType

enum ( ActivationType )

Определяет способ расчета даты начала действия данного способа оплаты.

userRestriction

object ( UserPurchaseRestriction )

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

Тип платежа

Тип способа оплаты.

Перечисления
PAYMENT_OPTION_TYPE_UNSPECIFIED Неиспользованный.
PAYMENT_OPTION_SINGLE_USE Способ оплаты можно использовать только один раз.
PAYMENT_OPTION_MULTI_USE Способ оплаты можно использовать, если количество сессий превышает 0.
PAYMENT_OPTION_UNLIMITED Способ оплаты можно использовать в течение установленного временного интервала — подсчет сессий не учитывается.

Тип активации

Определяет способ установления даты начала действия.

Перечисления
ACTIVATION_TYPE_UNSPECIFIED Неиспользованный.
ACTIVATION_ON_PURCHASE Срок действия начинается с момента покупки.
ACTIVATION_ON_FIRST_USE Срок действия начинается с момента первого использования способа оплаты.

Ограничение на покупку пользователя

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

JSON-представление
{
  "newToMerchant": boolean,
  "newToPaymentOption": boolean
}
Поля
newToMerchant

boolean

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

newToPaymentOption

boolean

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

PaymentProcessorConfig

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

JSON-представление
{
  "processor": enum (Processor),
  "publicKey": string,
  "version": string
}
Поля
processor

enum ( Processor )

Определяет партнера по обработке платежей, к которому применяется данная конфигурация.

publicKey

string

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

Для Stripe см.: https://stripe.com/docs/dashboard#api-keys Для Braintree см.: https://articles.braintreepayments.com/control-panel/important-gateway-credentials

version

string

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

Процессор

Определяет конкретного партнера по обработке платежей.

Перечисления
PROCESSOR_UNSPECIFIED Неиспользованный
PROCESSOR_STRIPE Настройки для осуществления платежей через Stripe.
PROCESSOR_BRAINTREE Настройки для осуществления платежей через Braintree.

TokenizationConfig

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

JSON-представление
{
  "tokenizationParameter": {
    string: string,
    ...
  },
  "billingInformationFormat": enum (BillingInformationFormat)
}
Поля
tokenizationParameter

map (key: string, value: string)

В конфигурации токенизации обычно присутствует один параметр tokenizationParameter, ключом которого является "gateway", а значением — имя процессора.

Остальные параметры зависят от процессора. Дополнительную информацию см. в документации Google Pay.

Пример использования Braintree: tokenizationParameter { key: "gateway" value: "braintree" } tokenizationParameter { key: "braintree:apiVersion" value: "v1" } tokenizationParameter { key: "braintree:sdkVersion" value: "2.30.0" } tokenizationParameter { key: "braintree:merchantId" value: "abcdef" } tokenizationParameter { key: "braintree:clientKey" value: "production_xxx_yyy" }

Пример использования Stripe: tokenizationParameter { key: "gateway" value: "stripe" } tokenizationParameter { key: "stripe:version" value: "2018-02-28" } tokenizationParameter { key: "stripe:publishableKey" value: "pk_1234" }

Пример использования Adyen: tokenizationParameter { key: "gateway" value: "adyen" } tokenizationParameter { key: "gatewayMerchantId" value: "yourId" }

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

billingInformationFormat

enum ( BillingInformationFormat )

Включите в платежный токен платежную информацию пользователя, введенную в Google Pay с его FOP (см. выше). Если оставить поле пустым, это эквивалентно указанию MIN.

Формат платежной информации

Какую часть платежного адреса следует запросить у пользователя и включить в токен. Значения перечисления соответствуют параметрам API Google Pay (см. https://developers.google.com/pay/api/web/reference/object#BillingAddressParameters) .

Перечисления
BILLING_INFORMATION_FORMAT_UNSPECIFIED Не указано. По умолчанию используется значение MIN.
MIN Имя, код страны и почтовый индекс (настройка Google Pay по умолчанию).
FULL Имя, адрес, населенный пункт, регион, код страны и почтовый индекс.

Условия

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

JSON-представление
{
  "url": string,
  "text": string,
  "localizedText": {
    object (Text)
  }
}
Поля
url

string

При желании можно указать URL-адрес страницы с Условиями использования.

text

string

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

localizedText

object ( Text )

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

MerchantMatchingHints

Подсказки, помогающие Google сопоставить продавца с местом на Google Maps.

JSON-представление
{
  "placeId": string
}
Поля
placeId

string

Идентификатор места (Place ID) в базе данных Google Places и на Google Maps. Дополнительную информацию об идентификаторах мест см. на странице https://developers.google.com/places/web-service/place-id .

ServiceAttribute

Атрибуты услуг — это определяемые партнерами категории, описывающие услуги для продавца. Например, банк может определить атрибут услуги «Тип счета» с возможными значениями «Личный» и «Коммерческий», а парикмахерская — атрибут услуги «Тип услуги» с возможными значениями «Стрижка», «Окрашивание» и «Стиль».

JSON-представление
{
  "attributeId": string,
  "attributeName": string,
  "value": [
    {
      object (Value)
    }
  ]
}
Поля
attributeId

string

Идентификатор, который однозначно идентифицирует данный атрибут услуги среди других атрибутов для того же продавца, например, "account-type".

attributeName

string

Имя, видимое пользователю, для этого атрибута, например, «Тип учетной записи».

value[]

object ( Value )

Все возможные значения для этого атрибута сервиса.

Ценить

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

JSON-представление
{
  "valueId": string,
  "valueName": string
}
Поля
valueId

string

Идентификатор, который однозначно отличает это значение от других для данного атрибута услуги, например, «personal».

valueName

string

Имя, видимое пользователю, для значения, например, "Personal".

LinkoutTemplate

Шаблон, определяющий, как Google должен генерировать URL-адреса для сайта партнера.

JSON-представление
{
  "uriTemplate": string
}
Поля
uriTemplate

string

Шаблон URI должен соответствовать RFC 6570, см. https://datatracker.ietf.org/doc/html/rfc6570 . Поддерживает шаблоны уровня 1 и все составные шаблоны уровня 4. Например: http://example.com/book/{foo}?b={bar } * foo = 2 * bar = abc https://example.com/book/2?b=abc

Консультации

Уведомления, отображаемые пользователю при бронировании через сервис «Забронировать через Google».

JSON-представление
{
  "text": {
    object (Text)
  }
}
Поля
text

object ( Text )

Пользовательское сообщение, которое будет отображаться при бронировании через сервис «Забронировать через Google».

Экономический оператор

Информация об экономическом операторе для агрегатора.

JSON-представление
{
  "text": {
    object (Text)
  }
}
Поля
text

object ( Text )

Обязательно. Наименование, адрес, номер телефона и адрес электронной почты экономического оператора, определяемого как производитель, уполномоченный представитель, импортер, дистрибьютор, поставщик услуг по выполнению заказов или любое другое физическое или юридическое лицо, имеющее обязательства, связанные с производством продукции, ее предоставлением или вводом в эксплуатацию. Строковое представление экономического оператора в произвольном формате. Эта информация может быть отформатирована с использованием символов "" и "\n".

Методы

create

Создает нового Merchant управляемого указанным агрегатором, и возвращает его.

delete

Удаляет существующего Merchant управляемого указанным агрегатором.

getStatus

Получите статус Merchant MerchantStatus ).

patch

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