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)
    }
  ],
  "waitlistAdvisement": {
    object (Advisement)
  }
}
字段
name

string

商家资源名称,格式为 partners/{partner_id}/merchants/{merchantId}

merchantName

string

merchantName、telephone、url 和 geo 用于将合作伙伴商品目录与 Google 地图上已有的商家进行匹配。此信息不会显示。

商家的名称。

telephone

string

商家的公开电话号码(包括国家/地区代码和区号),例如+14567891234。

url

string

商家公开网站的网址。

geo

object (GeoCoordinates)

商家的地理位置信息,包括纬度、经度和地址。

category

string

集合商家平台中商家的类别。

numBookings30d
(deprecated)

string (int64 format)

该字段已弃用。

taxRateBasisPoints
(deprecated)

integer (uint32 format)

商家的税率(以 0.01% 为基准点)。例如,如果税率为 7.5%,应将该字段设置为 750。

如果未设置或将该字段设置为 0,对于由此商家提供的任何服务,向用户收取的总费用为 Service.price 所指定的确切价格。该服务价格被视为无需缴纳税费或已包含适用税费。系统不会将税费作为单独的订单项向用户显示。

如果将该字段设置为任何非零值,对于由此商家提供的任何服务,向用户收取的总费用将包含服务价格以及使用此处提供的税率计算得出的税费。最小货币单位的小数部分(例如,1 美分的小数部分)将四舍五入为最接近的偶数。系统会将税费作为单独的订单项向用户显示。

此字段已弃用,请改用 taxRate。

taxRate

object (TaxRate)

商家的税率。如果设置该字段,它会替换已弃用的 taxRateBasisPoints 字段。空白消息(即 taxRate { })会将适用税率重置为零。

paymentRestrictions

object (PaymentRestrictions)

对此商家所接受付款方式的限制。如果未设置此字段,则假定不存在任何限制。

paymentOption[]

object (PaymentOption)

此商家所支持的付款方式。此商家的服务将能够单独限制其允许的付款方式。

paymentProcessorConfig
(deprecated)

object (PaymentProcessorConfig)

适用于令牌化付款处理方的配置(如果商家支持)。

tokenizationConfig

object (TokenizationConfig)

适用于令牌化付款处理方的配置(如果商家支持)。

terms

object (Terms)

特定商家的条款及条件,在用户使用“通过 Google 预订”功能预订服务时显示。此外,这些集合商家合作伙伴的条款及条件会始终向用户显示,且不得在此处提供。

brandId

string

不透明的字符串,用于在显示合作伙伴属性时标识面向消费者的品牌。此字段允许拥有多个面向消费者的品牌的合作伙伴在同一 Feed 中提供所有品牌的商家。

品牌由面向消费者的属性(例如名称、徽标、服务条款及隐私权政策)组成。

如果只有一个面向消费者的合作伙伴品牌,则无需设置该字段,且可将其忽略。

如果合作伙伴…

没有多个面向消费者的品牌?--> 请忽略此字段

配置了多个品牌?

  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 地图上的地点进行匹配的提示。请注意:大多数合作伙伴都不需要设置该字段,因为 Google 会使用上述信息将商家与 Google 地图上的地点进行匹配。(可选)

serviceAttribute[]

object (ServiceAttribute)

用于描述此商家的服务的任何服务属性的定义。(可选)

waitlistAdvisement

object (Advisement)

可选。特定商家针对通过“通过 Google 预订”加入等候名单的用户提供的一般建议。建议中各个文本字段的长度应限制为 100 个字节。

PaymentRestrictions

对此商家所接受付款方式的限制。

JSON 表示法
{
  "creditCardRestrictions": {
    object (CreditCardRestrictions)
  }
}
字段
creditCardRestrictions

object (CreditCardRestrictions)

对此商家所接受的信用卡的限制。如果未设置该字段,我们会默认接受所有信用卡。请注意,CreditCardType 支持的卡的列表会不断增加,这意味着如果留空,则相应配置需要适应将来的更改。

CreditCardRestrictions

对此商家所接受的信用卡类型的限制。

JSON 表示法
{
  "creditCardType": [
    enum (CreditCardType)
  ]
}
字段
creditCardType[]

enum (CreditCardType)

受支持的信用卡列表。留空表示不支持任何信用卡。

CreditCardType

信用卡类型。

枚举
CREDIT_CARD_TYPE_UNSPECIFIED 未使用。
VISA Visa 信用卡。
MASTERCARD Mastercard 信用卡。
AMERICAN_EXPRESS 美国运通信用卡。
DISCOVER Discover 信用卡。
JCB JCB 信用卡。

PaymentOption

付款方式,可用于支付商家所提供服务的费用。多个商家(例如同一连锁品牌的商家)可共用同一付款方式。

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 时,更新某个商家所接受付款方式的任何值后,其他商家使用相同 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 年 1 月特惠价格)。如果存在,则此参数会替换 validDuration 和 activationType。

validDuration

string (Duration format)

付款方式的有效期限(例如 30 天的会员资格有效期)。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

activationType

enum (ActivationType)

定义如何确定此付款方式的有效开始日期。

userRestriction

object (UserPurchaseRestriction)

有资格购买此付款方式的用户需满足的限制条件。可用于将促销付款方式的限制为部分用户。如果未设置,则所有用户均符合条件。

PaymentOptionType

付款方式的类型。

枚举
PAYMENT_OPTION_TYPE_UNSPECIFIED 未使用。
PAYMENT_OPTION_SINGLE_USE 付款方式只能使用一次。
PAYMENT_OPTION_MULTI_USE 当付款方式的会话数大于 0 时,便可以使用相应付款方式。
PAYMENT_OPTION_UNLIMITED 付款方式可在其有效的时间范围内使用(会话数不适用)。

ActivationType

定义如何确定有效期的开始日期。

枚举
ACTIVATION_TYPE_UNSPECIFIED 未使用。
ACTIVATION_ON_PURCHASE 自购买时开始生效。
ACTIVATION_ON_FIRST_USE 自首次使用付款方式时开始生效。

UserPurchaseRestriction

有资格购买付款方式的用户需满足的限制条件。

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 中输入的结算信息(请参阅上文)。将此字段留空等同于指定 MIN。

BillingInformationFormat

在账单邮寄地址信息中要求用户支付的金额,将其包含在令牌中。枚举值应对应于 Google Pay API 中的参数(请参阅 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

(可选)指向条款及条件的网址。

text

string

将向用户显示的文字。为新的集成使用以下 localizedText。

localizedText

object (Text)

要向用户显示的本地化文本。

MerchantMatchingHints

可帮助 Google 将商家与 Google 地图上的地点进行匹配的提示。

JSON 表示法
{
  "placeId": string
}
字段
placeId

string

Google Places 数据库中和 Google 地图上某个地点的地点 ID。如需详细了解地点 ID,请参阅 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

值的用户可见名称,例如“个人”。

建议

通过“通过 Google 预订”功能预订时向用户显示的建议。

JSON 表示法
{
  "text": {
    object (Text)
  }
}
字段
text

object (Text)

通过“通过 Google 预订”功能预订时向用户显示的自定义消息。

方法

create

创建由指定的集合商家管理的新 Merchant,并将其返回。

delete

删除由指定的集合商家管理的现有 Merchant

getStatus

获取 MerchantMerchantStatus

patch

更新由指定的集合商家管理的现有 Merchant,并将其返回。