REST Resource: accounts.businessInfo

资源：BusinessInfo

BusinessInfo 消息包含有关商家业务的重要信息。

此消息会捕获商家的主要详细信息，例如实际地址、客户服务联系信息和地区专用标识符。

JSON 表示法 
{
  "name": string,
  "address": {
    object (PostalAddress)
  },
  "phone": {
    object (PhoneNumber)
  },
  "phoneVerificationState": enum (PhoneVerificationState),
  "customerService": {
    object (CustomerService)
  },
  "koreanBusinessRegistrationNumber": string
}
字段
name

string

标识符。商家信息的资源名称。格式：accounts/{account}/businessInfo
address

object (PostalAddress)

可选。商家的地址。仅支持 regionCode、addressLines、postalCode、administrativeArea 和 locality 字段。系统会忽略所有其他字段。
phone

object (PhoneNumber)

仅限输出。商家的电话号码。
phoneVerificationState

enum (PhoneVerificationState)

仅限输出。商家的电话验证状态。
customerService

object (CustomerService)

可选。商家的客户服务。
koreanBusinessRegistrationNumber

string

可选。10 位数的韩国企业注册号，以英文短划线分隔，格式为 XXX-XX-XXXXX。

PostalAddress

表示邮政地址。例如邮政递送或付款地址。给定邮政地址时，邮政服务可以将物品投递到处所、邮政信箱或其他投递地点。此对象不模拟地理位置（道路、城镇、山区）。

在典型的使用场景中，地址将通过用户输入或导入现有数据来创建，具体取决于进程的类型。

有关输入/修改地址的建议：使用支持国际化的地址微件，例如 https://github.com/google/libaddressinput。在使用某个字段的国家/地区之外，不应向用户显示用于输入或修改该字段的界面元素。

如需详细了解如何使用此架构，请参阅：https://support.google.com/business/answer/6397478

JSON 表示法 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
字段
revision

integer

PostalAddress 的架构修订版本。必须将其设置为 0，也就是最新版本。

所有新版本必须向后兼容旧版本。
regionCode

string

必需。地址的国家/地区的 CLDR 地区代码。系统不会推断此字段，该值由用户确保正确。如需了解详情，请参阅 https://cldr.unicode.org/ 和 https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html。例如：瑞士的地区代码为“CH”。
languageCode

string

选填。此地址内容的 BCP-47 语言代码（如果已知）。这通常是输入表单的界面语言，或者与地址的“国家/地区”中使用的某种语言或其转换后的其他语言相匹配。这可能会影响某些国家/地区的格式，但对数据的正确性并不重要，也不会影响任何验证或其他与格式无关的操作。

如果此值未知，则应省略（而不是指定可能不正确的默认值）。

示例：“zh-Hant”、“ja”、“ja-Latn”、“en”。
postalCode

string

可选。地址的邮政编码。并非所有国家/地区都使用或要求使用邮政编码，但在使用邮政编码时，它们可能会触发以地址其他部分为参照的额外验证（例如美国的州/邮政编码验证）。
sortingCode

string

可选。特定于国家/地区的额外排序代码。大多数区域都未使用此功能。在使用时，此值可以是字符串（例如“CEDEX”），可选地后跟数字（例如“CEDEX 7”），也可以是仅包含数字的值，表示“行业代码”（牙买加）、“配送区域指示标志”（马拉维）或“邮局指示标志”（例如科特迪瓦）。
administrativeArea

string

可选。最高行政区划，用于国家或地区的邮政地址。例如，此值可以是州、省、州（俄罗斯）或县。具体来说，对于西班牙，此值为省而非自治区（例如此值为“巴塞罗那”而非“加泰罗尼亚”）。许多国家在邮政地址中不使用行政区划。例如对于瑞士，此字段应留空。
locality

string

可选。一般是指地址的城市/城镇部分。示例：美国的城市、意大利的市镇、英国的邮镇。对于没有明确定义 locality 或者其无法很好地对应这个结构的区域，应将 locality 留空并使用 address_lines。
sublocality

string

可选。地址的子级市行政区。例如，此值可以是社区、自治市/镇/区、行政区。
addressLines[]

string

描述详细地址的非结构化地址行。

由于 addressLines 中的值没有类型信息，并且有时可能在单个字段中包含多个值（例如“Austin, TX”），因此清楚的行顺序很重要。地址行的顺序应该是地址的国家/地区的“信封顺序”。在某些地方，此顺序有可能不同（例如日本），在这种情况下可以使用 address_language 来明确顺序（例如，“ja”表示从大到小排序，“ja-Latn”或“en”表示从小到大排序）。这样就可以根据语言选择地址的具体行。

地址的最小结构化表示形式由 regionCode 和 addressLines 组成，其中所有其他信息都放在 addressLines 中。可以在没有地理编码的情况下非常近似地设置此地址的格式，但是在至少部分完成之前，不能对任何地址组成部分进行语义推理。

创建仅包含 regionCode 和 addressLines 的地址，然后进行地理编码是处理完全非结构化地址的推荐方法（而不是猜测地址的哪些部分是城市/市镇或行政区）。
recipients[]

string

可选。此地址的收件人。在某些情况下，该字段可能包含多行信息。例如，它可能包含“转交”信息。
organization

string

可选。地址对应的组织的名称。

电话号码

表示电话号码的对象，适合用作 API 线格格式。

此表示法：

  • 不应用于电话号码的语言区域专用格式，例如“+1 (650) 253-0000 ext. 123”

  • 不适合高效存储

  • 可能不适合拨号 - 应使用专用库（请参阅参考文献）来解析号码以实现此目的

如需对此编号执行有意义的操作（例如，根据各种用例设置其格式），请先将其转换为 i18n.phonenumbers.PhoneNumber 对象。

例如，在 Java 中，代码如下所示：

com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); }

参考文献：- https://github.com/google/libphonenumber

JSON 表示法 
{
  "extension": string,

  // Union field kind can be only one of the following:
  "e164Number": string,
  "shortCode": {
    object (ShortCode)
  }
  // End of list of possible types for union field kind.
}
字段
extension

string

电话号码的扩展号码。ITU 建议中未对此扩展进行标准化，但将其定义为一系列数字，长度不得超过 40 位数。除了数字之外，此字段中可能还存储了一些其他拨号字符，例如“,”（表示等待）或“#”。

请注意，目前没有任何地区使用带短号的扩展号码，因此此字段通常仅与 E.164 号码一起设置。它与 E.164 号码分开存储，以便日后扩展短号码。
联合字段 kind。必需。可以是普通号码，也可以是短号码。将来可能会向下面的 oneof 添加新字段，因此客户端应忽略未设置任何所对应字段的电话号码。kind 只能是下列其中一项：
e164Number

string

电话号码，以加号 ('+') 开头，后跟采用宽松的 ITU E.164 格式的电话号码，该格式由国家/地区拨号代码（1 到 3 位数）和用户号码组成，且不包含其他空格或格式设置。例如：- 正确：+15552220123 - 错误：+1 (555) 222-01234 x123。

ITU E.164 格式将后者限制为 12 位数，但在实践中，并非所有国家/地区都遵循这一限制，因此我们在此放宽了这一限制。不允许使用仅限国内的电话号码。

参考文献：- https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164。- https://en.wikipedia.org/wiki/List_of_country_calling_codes
shortCode

object (ShortCode)

短号码。

参考文献：- https://en.wikipedia.org/wiki/Short_code

ShortCode

表示短号码的对象。短号码通常比普通电话号码短得多，可用于在彩信和短信系统中寻址消息，以及用于缩写拨号（例如“发短信至 611 即可查看您的套餐剩余分钟数”）。

短号仅限于特定地区，无法拨打国际短号，这意味着相同的短号可以在不同地区使用，但使用方式和价格各不相同，即使这些地区使用相同的国家/地区电话代码（例如：美国和加拿大）也是如此。

JSON 表示法 
{
  "regionCode": string,
  "number": string
}
字段
regionCode

string

必需。可以拨打此短号码的地区的 BCP-47 地区代码，例如“US”和“BB”。

参考文献：- http://www.unicode.org/reports/tr35/#unicode_region_subtag
number

string

必需。短号码数字，不带前置加号 (“+”) 或国家/地区电话代码。例如“611”。

PhoneVerificationState

电话验证状态。

枚举
PHONE_VERIFICATION_STATE_UNSPECIFIED 默认值。此值未使用。
PHONE_VERIFICATION_STATE_VERIFIED 手机已通过验证。
PHONE_VERIFICATION_STATE_UNVERIFIED 手机未验证

CustomerService

客户服务信息。

JSON 表示法 
{
  "uri": string,
  "email": string,
  "phone": {
    object (PhoneNumber)
  }
}
字段
uri

string

可选。用于查找客户服务的 URI。
email

string

可选。可联系客户服务的电子邮件地址。
phone

object (PhoneNumber)

可选。可拨打的客户服务电话号码。

方法

getBusinessInfo

 检索账号的商家信息。

updateBusinessInfo

 更新账号的商家信息。