REST Resource: accounts

资源:账号

帐号是营业地点的容器。如果您是唯一负责管理营业地点的用户,您可以使用个人 Google 帐号。要与多位用户共享营业地点管理权限,请创建一个商家帐号

JSON 表示法
{
  "name": string,
  "accountName": string,
  "primaryOwner": string,
  "type": enum (AccountType),
  "role": enum (AccountRole),
  "verificationState": enum (VerificationState),
  "vettedState": enum (VettedState),
  "accountNumber": string,
  "permissionLevel": enum (PermissionLevel),
  "organizationInfo": {
    object (OrganizationInfo)
  }
}
字段
name

string

不可变。资源名称,格式为 accounts/{account_id}

accountName

string

必需。帐号的名称。对于 PERSONAL 类型的帐号,这是用户帐号的名字和姓氏。

primaryOwner

string

必需。仅限输入。账号的资源名称,将是所创建账号的主要所有者。格式应为 accounts/{account_id}

type

enum (AccountType)

必需。包含帐号类型。无法使用此 API 创建 PERSONAL 和 ORGANIZATION 类型的帐号。

role

enum (AccountRole)

仅供输出。指定此帐号的 AccountRole。

verificationState

enum (VerificationState)

仅供输出。如果通过验证,今后创建的地点信息会自动与 Google 地图相关联,并会自动创建 Google+信息页,无需进行审核。

vettedState

enum (VettedState)

仅供输出。指明帐号是否经过 Google 审核。经过审核的帐号可以通过 VETTED_PARTNER 方法验证营业地点。

accountNumber

string

仅供输出。帐号参考编号(如果已配置)。

permissionLevel

enum (PermissionLevel)

仅供输出。指定用户对此帐号的权限级别。

organizationInfo

object (OrganizationInfo)

仅供输出。组织的其他信息。系统只会为组织帐号填充此字段。

AccountType

表明帐号类型:个人/用户帐号或企业帐号。

枚举
ACCOUNT_TYPE_UNSPECIFIED 未指定。
PERSONAL 最终用户帐号。
LOCATION_GROUP 一组营业地点。如需了解详情,请参阅帮助中心文章
USER_GROUP 用于将组织员工划分为一组的用户组。如需了解详情,请参阅帮助中心文章
ORGANIZATION 代表公司的组织。如需了解详情,请参阅帮助中心文章

AccountRole

表示经过身份验证的用户对此帐号的访问权限级别。如需了解详情,请参阅帮助中心文章

枚举
ACCOUNT_ROLE_UNSPECIFIED 未指定。
PRIMARY_OWNER 该用户是此账号的主要所有者。
OWNER 帐号的用户所有者。
MANAGER 此用户可以管理此账号。
SITE_MANAGER 这类用户可以为帐号管理有限的功能。

VerificationState

指明帐号的验证状态。

枚举
VERIFICATION_STATE_UNSPECIFIED 未指定。
VERIFIED 经过验证的账号。
UNVERIFIED 账号未经过验证,也未请求验证。
VERIFICATION_REQUESTED 未验证,但已请求验证的账号。

VettedState

表示帐号的审核状态。

枚举
VETTED_STATE_UNSPECIFIED 未指定
NOT_VETTED 账号未经 Google 审核。
VETTED 账号已通过 Google 的审核,并处于有效状态。如果帐号对经过审核的群组帐号拥有直接访问,系统会自动审核该帐号。
INVALID 账号已经过审核,但处于无效状态。帐号的运作方式与未经审核的帐号类似。

PermissionLevel

表示经过身份验证的用户对此帐号的访问权限级别。

枚举
PERMISSION_LEVEL_UNSPECIFIED 未指定。
OWNER_LEVEL 用户拥有所有者级别权限。
MEMBER_LEVEL 用户拥有成员级权限。

OrganizationInfo

为组织存储的其他信息。

JSON 表示法
{
  "registeredDomain": string,
  "address": {
    object (PostalAddress)
  },
  "phoneNumber": string
}
字段
registeredDomain

string

仅供输出。帐号的注册域名。

address

object (PostalAddress)

仅供输出。帐号的邮寄地址。

phoneNumber

string

仅供输出。组织的联系电话。

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

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

方法

create

在指定的父级下创建具有指定名称和类型的帐号。

get

获取指定的帐号。

list

列出经过身份验证的用户的所有帐号。

patch

更新指定的商家帐号。