REST Resource: inventory.partners.merchants

リソース: Merchant

アグリゲータのプラットフォーム上の販売者に関する情報。

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)
  },
  "economicOperator": {
    object (EconomicOperator)
  }
}
フィールド
name

string

販売者のリソース名。partners/{partner_id}/merchants/{merchantId} の形式で指定します。
merchantName

string

merchantName、電話番号、URL、地域は、パートナーの在庫を Google マップにすでに表示されている販売者とマッチングするために使用されます。この情報は表示されません。

販売者の名前。
telephone

string

販売者の国番号と市外局番を含む公開電話番号（例: +14567891234）。
url

string

販売者の公開ウェブサイトの URL。
geo

object (GeoCoordinates)

販売者の地理情報（緯度、経度、住所など）。
category

string

アグリゲータのプラットフォームにおけるビジネスのカテゴリ。
numBookings30d
(deprecated)

string (int64 format)

このフィールドのサポートは終了しました。
taxRateBasisPoints
(deprecated)

integer (uint32 format)

販売者の税率（ベーシス ポイント: 1% の 100 分の 1）。たとえば、税率が 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

パートナーの帰属を表示する際に使用する、消費者向けのブランドを識別する不透明型の文字列。このフィールドを使用すると、複数の消費者向けブランドを所有するパートナーが、同じフィード内のすべてのブランドの販売者を指定できます。

ブランドは、名前、ロゴ、利用規約、プライバシー ポリシーなど、消費者向けのプロパティで構成されます。

消費者向けのパートナー ブランドが 1 つしかない場合は、このフィールドを設定する必要はなく、無視してかまいません。

パートナーの種類別の処理方法:

消費者向けのブランドが 1 つしかない場合は、このフィールドは無視します。

複数のブランドが設定されている場合は、次のように処理されます。

  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

注意: ほとんどのパートナーは、このフィールドを設定する必要はありません。パートナーがこのフィールドを使用する場合は、各ブランド（デフォルトのブランドを含む）を個別に設定する必要がありますので、Google までご連絡ください。
matchingHints

object (MerchantMatchingHints)

販売者が Google マップの場所とマッチングされる際のヒント注: 上記で指定した情報を使用して販売者と Google マップの場所がマッチングされるため、ほとんどのパートナーはこのフィールドを設定する必要がありません。（省略可）
serviceAttribute[]

object (ServiceAttribute)

この販売者のサービスを説明するために使用されるサービス属性の定義。（省略可）
waitlistAdvisement

object (Advisement)

省略可。「Google で予約」を通じて順番待ちリストに登録するユーザー向けの、特定の販売者からの一般的なアドバイス。アドバイス内の個々のテキスト フィールドの長さは 100 バイト以下にしてください。
economicOperator

object (EconomicOperator)

省略可。法規制の遵守に必要な、この特定の販売者に関連付けられた経済運営者情報。（省略可）

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 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)

この支払いオプションの税率。指定されている場合、Merchant または Service に存在する taxRate フィールドがオーバーライドされます。メッセージが空の場合（例: taxRate { }）は、適用される税率を 0 にリセットします。
paymentOptionType

enum (PaymentOptionType)

この支払いオプションの種類。ドロップインの場合は 1 回限り、パックの場合は複数回、メンバーシップの場合は無制限。
sessionCount

string (int64 format)

この支払いオプションを利用できるセッション数。値が 1 以上となるマルチセッションやパックの場合にのみ有効。
purchaseInterval

object (TimeRange)

支払いオプションを購入できる期間。
validInterval

object (TimeRange)

支払いオプションはこの期間内に利用できます（例: 2017 年 1 月の特別価格）。指定されている場合は、validDuration と activationType がオーバーライドされます。
validDuration

string (Duration format)

支払いオプションの有効期間（例: 30 日間のメンバーシップ）。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
activationType

enum (ActivationType)

この支払いオプションの有効期限の開始日を決定する方法を定義します。
userRestriction

object (UserPurchaseRestriction)

この支払いオプションを購入できるユーザーを制限します。プロモーションの支払いオプションを一部のユーザーに制限するために使用できます。設定されていない場合、すべてのユーザーが対象となります。

PaymentOptionType

支払いオプションのタイプ。

列挙型
PAYMENT_OPTION_TYPE_UNSPECIFIED 未使用。
PAYMENT_OPTION_SINGLE_USE 支払いオプションは 1 回のみ使用可能。
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

決済代行業者の設定。Merchant ごとに設定します。

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

決済代行業者のトークン化の設定。Merchant ごとに設定します。

JSON 表現 
{
  "tokenizationParameter": {
    string: string,
    ...
  },
  "billingInformationFormat": enum (BillingInformationFormat)
}
フィールド
tokenizationParameter

map (key: string, value: string)

トークン化の設定には通常、キーが「gateway」で値が決済代行業者の名前である tokenizationParameter が 1 個あります。

パラメータの残りは決済代行業者によって異なります。詳しくは、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 を指定した場合と同じ処理を行います。

BillingInformationFormat

トークンに含める請求先住所の記載事項（ユーザーが入力）。列挙値は Google Pay API のパラメータに対応します（https://developers.google.com/pay/api/web/reference/object#BillingAddressParameters を参照）。

列挙型
BILLING_INFORMATION_FORMAT_UNSPECIFIED 指定なし。デフォルトは MIN です。
MIN 名前、国コード、郵便番号（Google Pay のデフォルト設定）。
FULL 名前、番地、地域区分、県、国コード、郵便番号。

Terms

「Google で予約」で予約を行うためにユーザーに表示される一連のルールとガイドライン。

JSON 表現 
{
  "url": string,
  "text": string,
  "localizedText": {
    object (Text)
  }
}
フィールド
url

string

（省略可）利用規約の URL。
text

string

ユーザーに表示するテキスト。新しい統合には、以下の localizedText を使用します。
localizedText

object (Text)

ユーザーに表示するローカライズされたテキスト。

MerchantMatchingHints

販売者と Google マップの場所とのマッチング時に参照されるヒント。

JSON 表現 
{
  "placeId": string
}
フィールド
placeId

string

Google プレイス データベースと Google マップ上の場所の Place ID。Place ID について詳しくは、https://developers.google.com/places/web-service/place-id をご覧ください。

ServiceAttribute

サービス属性は、Merchant の Services を記述するパートナー定義のカテゴリです。たとえば、銀行では「口座種別」サービス属性を「個人」と「ビジネス」の値で定義し、美容室では「サービスの種類」サービス属性を「ヘアカット」、「ヘアカラー」、「スタイリング」の値で定義できます。

JSON 表現 
{
  "attributeId": string,
  "attributeName": string,
  "value": [
    {
      object (Value)
    }
  ]
}
フィールド
attributeId

string

同じ販売者のサービス属性を一意に識別する ID（例:「account-type」を選択します。
attributeName

string

ユーザーに表示される属性の名前。例:[アカウントの種類] を選択します。
value[]

object (Value)

このサービス属性で可能なすべての値。

値

特定のサービス属性に指定できる値を表します。

JSON 表現 
{
  "valueId": string,
  "valueName": string
}
フィールド
valueId

string

このサービス属性の値を他の値から一意に識別する ID（「personal」など）。
valueName

string

ユーザーに表示される値の名前。例:「個人」。

アドバイス

「Google で予約」で予約するときにユーザーに表示される注意事項。

JSON 表現 
{
  "text": {
    object (Text)
  }
}
フィールド
text

object (Text)

「Google で予約」で予約する際にユーザーに表示されるカスタム メッセージ。

EconomicOperator

アグリゲータの経済事業者に関する情報。

JSON 表現 
{
  "text": {
    object (Text)
  }
}
フィールド
text

object (Text)

必須。経済事業者の名前、住所、電話番号、メールアドレス。製造者、正式な代表者、輸入業者、流通業者、納品サービス プロバイダ、または製品の製造、販売、サービスの提供に関連する義務を負うその他の自然人または法人。economicOperator の自由形式の文字列表現。この情報は、」および "\n".

メソッド

create

 指定されたアグリゲータによって管理される新しい Merchant を作成して返します。

delete

 指定されたアグリゲータによって管理されている既存の Merchant を削除します。

getStatus

 Merchant の MerchantStatus を取得します。

patch

 指定されたアグリゲータによって管理されている既存の Merchant を更新して返します。