Package google.mybusiness.accountmanagement.v1

索引

• AccessControl（界面）
• Accounts（界面）
• AcceptInvitationRequest（消息）
• Account（消息）
• Account.AccountRole（枚举）
• Account.AccountType（枚举）
• Account.OrganizationInfo（消息）
• Account.PermissionLevel（枚举）
• Account.VerificationState（枚举）
• Account.VettedState（枚举）
• Admin（消息）
• Admin.AdminRole（枚举）
• CreateAccountAdminRequest（消息）
• CreateAccountRequest（消息）
• CreateLocationAdminRequest（消息）
• DeclineInvitationRequest（消息）
• DeleteAccountAdminRequest（消息）
• DeleteLocationAdminRequest（消息）
• GetAccountRequest（消息）
• Invitation（消息）
• Invitation.TargetLocation（消息）
• Invitation.TargetType（枚举）
• ListAccountAdminsRequest（消息）
• ListAccountAdminsResponse（消息）
• ListAccountsRequest（消息）
• ListAccountsResponse（消息）
• ListInvitationsRequest（消息）
• ListInvitationsResponse（消息）
• ListLocationAdminsRequest（消息）
• ListLocationAdminsResponse（消息）
• TransferLocationRequest（消息）
• UpdateAccountAdminRequest（消息）
• UpdateAccountRequest（消息）
• UpdateLocationAdminRequest（消息）

AccessControl

此服务可用于管理有权访问帐号和营业地点的用户。

AcceptInvitation
rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty) 接受指定的邀请。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

CreateAccountAdmin
rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin) 邀请指定用户担任指定账号的管理员。邀请对象必须接受邀请才能获得帐号访问权限。如需以编程方式接受邀请，请参阅 [AcceptInvitation] [google.mybusiness.accountmanagement.v1.AcceptInvitation]。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

CreateLocationAdmin
rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin) 邀请指定用户担任指定营业地点的管理员。邀请对象必须接受邀请才能获得相应营业地点的访问权限。如需以编程方式接受邀请，请参阅 [AcceptInvitation] [google.mybusiness.accountmangement.v1.AcceptInvitation]。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

DeclineInvitation
rpc DeclineInvitation(DeclineInvitationRequest) returns (Empty) 拒绝指定的邀请。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

DeleteAccountAdmin
rpc DeleteAccountAdmin(DeleteAccountAdminRequest) returns (Empty) 从指定帐号中移除指定管理员。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

DeleteLocationAdmin
rpc DeleteLocationAdmin(DeleteLocationAdminRequest) returns (Empty) 移除担任指定营业地点管理员的指定管理员。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

ListAccountAdmins
rpc ListAccountAdmins(ListAccountAdminsRequest) returns (ListAccountAdminsResponse) 列出指定帐号的管理员。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

ListInvitations
rpc ListInvitations(ListInvitationsRequest) returns (ListInvitationsResponse) 列出指定帐号的待处理邀请。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

ListLocationAdmins
rpc ListLocationAdmins(ListLocationAdminsRequest) returns (ListLocationAdminsResponse) 列出指定营业地点的所有管理员。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

TransferLocation
rpc TransferLocation(TransferLocationRequest) returns (Empty) 将营业地点从用户拥有的账号迁移到同一用户管理的另一个账号。用户必须是该营业地点当前关联的帐号的所有者，且必须至少是目标帐号的管理员。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

UpdateAccountAdmin
rpc UpdateAccountAdmin(UpdateAccountAdminRequest) returns (Admin) 更新指定 Account Admin 的管理员。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

UpdateLocationAdmin
rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (Admin) 更新指定营业地点的管理员。只能更新 Admin 的 AdminRole。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

账号

借助此 API，您可以在 Google 上管理商家帐号。它定义了以下资源模型：

• 该 API 拥有一组名为 accounts/* 的帐号资源。

• 为方便起见，您可以使用同义词“我”代替经过身份验证的调用者的个人帐号的帐号 ID。示例：GET /v1/accounts/me GET /v1/accounts/me/locations

CreateAccount
rpc CreateAccount(CreateAccountRequest) returns (Account) 在指定的父级下创建具有指定名称和类型的帐号。 无法创建个人账号和组织。 不能将个人帐号作为主要所有者来创建用户群组。 如果个人帐号位于组织中，则不能由个人帐号的主要所有者创建营业地点组。 营业地点组不能拥有营业地点组。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

GetAccount
rpc GetAccount(GetAccountRequest) returns (Account) 获取指定的帐号。如果帐号不存在或调用者无权访问该帐号，则返回 NOT_FOUND。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

ListAccounts
rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse) 列出经过身份验证的用户的所有帐号。这包括用户拥有的所有帐号，以及用户拥有管理权限的所有帐号。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

UpdateAccount
rpc UpdateAccount(UpdateAccountRequest) returns (Account) 更新指定的商家帐号。无法使用此方法更新个人帐号。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

AcceptInvitationRequest

AccessControl.AcceptInvitation 的请求消息。

字段
name	string 必需。要接受的邀请的名称。accounts/{account_id}/invitations/{invitation_id}

账号

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

字段
name	string 不可变。资源名称，格式为 accounts/{account_id}。
account_name	string 必需。帐号的名称。对于 PERSONAL 类型的帐号，这是用户帐号的名字和姓氏。
primary_owner	string 必需。仅限输入。账号的资源名称，将是所创建账号的主要所有者。格式应为 accounts/{account_id}。
type	AccountType 必需。包含帐号类型。无法使用此 API 创建 PERSONAL 和 ORGANIZATION 类型的帐号。
role	AccountRole 仅供输出。指定此帐号的 AccountRole。
verification_state	VerificationState 仅供输出。如果通过验证，今后创建的地点信息会自动与 Google 地图相关联，并会自动创建 Google+信息页，无需进行审核。
vetted_state	VettedState 仅供输出。指明帐号是否经过 Google 审核。经过审核的帐号可以通过 VETTED_PARTNER 方法验证营业地点。
account_number	string 仅供输出。帐号参考编号（如果已配置）。
permission_level	PermissionLevel 仅供输出。指定用户对此帐号的权限级别。
organization_info	OrganizationInfo 仅供输出。组织的其他信息。系统只会为组织帐号填充此字段。

AccountRole

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

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

AccountType

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

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

OrganizationInfo

为组织存储的其他信息。

字段
registered_domain	string 仅供输出。帐号的注册域名。
address	PostalAddress 仅供输出。帐号的邮寄地址。
phone_number	string 仅供输出。组织的联系电话。

PermissionLevel

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

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

VerificationState

指明帐号的验证状态。

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

VettedState

表示帐号的审核状态。

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

管理

帐号或营业地点的管理员。

字段
name	string 不可变。资源名称。 对于账号管理员，其格式为：accounts/{account_id}/admins/{admin_id} 对于营业地点管理员，其格式为：locations/{location_id}/admins/{admin_id} 如果在管理员创建期间设置了此字段，则会被忽略。
admin	string 可选。管理员的姓名。首次发送邀请时，这就是邀请对象的电子邮件地址。调用 GET 时，如果邀请仍处于待处理状态，系统会返回用户的电子邮件地址。否则，其中会包含用户的名字和姓氏。 此字段只需在管理员创建期间设置。
account	string 不可变。此管理员引用的帐号资源的名称。在调用 locations.admins.create 以邀请营业地点组担任管理员时使用。 如果 CREATE 请求中同时设置了此字段和 admin，则此字段优先，并忽略 admin 中的电子邮件地址。 格式：accounts/{account}。
role	AdminRole 必需。指定此管理员用于指定帐号或营业地点的角色。
pending_invitation	bool 仅供输出。指明此管理员是否有对指定资源的待处理邀请。

AdminRole

表示管理员拥有的访问权限级别。如需了解详情，请参阅帮助中心文章

枚举
ADMIN_ROLE_UNSPECIFIED	未指定。
PRIMARY_OWNER	管理员拥有所有者级别的访问权限，并且是主要所有者。（在界面中显示为“主要所有者”）。
OWNER	管理员拥有所有者级别的访问权限。（在界面中显示为“所有者”）。
MANAGER	管理员拥有管理权限。
SITE_MANAGER	管理员可以管理社交 (Google+) 信息页。（在界面中显示为“网站管理员”）。此 API 不允许创建具有 SITE_MANAGER 角色的帐号管理员。

CreateAccountAdminRequest

AccessControl.CreateAccountAdmin 的请求消息。

字段
parent	string 必需。为其创建此管理员的帐号的资源名称。accounts/{account_id}.
admin	Admin 必需。要创建的管理员。角色不能是 SITE_MANAGER

CreateAccountRequest

Accounts.CreateAccount 的请求消息。

字段
account	Account 必需。要创建的帐号的帐号信息。只允许使用“account”和“type”这两个字段。

CreateLocationAdminRequest

AccessControl.CreateLocationAdmin 的请求消息。

字段
parent	string 必需。创建此管理员的营业地点的资源名称。locations/{location_id}/admins.
admin	Admin 必需。要创建的管理员。

DeclineInvitationRequest

AccessControl.InvalidInvitation 的请求消息。

字段
name	string 必需。要拒绝的账号邀请的名称。accounts/{account_id}/invitations/{invitation_id}

DeleteAccountAdminRequest

AccessControl.DeleteAccountAdmin 的请求消息。

字段
name	string 必需。要从帐号中移除的管理员的资源名称。accounts/{account_id}/admins/{admin_id}.

DeleteLocationAdminRequest

AccessControl.DeleteLocationAdmin 的请求消息。

字段
name	string 必需。要从营业地点中移除的管理员的资源名称。

GetAccountRequest

Accounts.GetAccount 的请求消息。

字段
name	string 必需。要获取的帐号的名称。

邀请

表示待处理的邀请。

字段
name	string 必需。邀请的资源名称。accounts/{account_id}/invitations/{invitation_id}.
role	AdminRole 仅供输出。帐号的受邀角色。
target_type	TargetType 仅供输出。指定响应中应显示的定位类型。
联合字段 target。指明此邀请针对的目标。target 只能是下列其中一项：
target_account	Account 此邀请所针对的稀疏填充的帐号。
target_location	TargetLocation 此邀请的目标地理位置。

TargetLocation

表示待处理邀请的目标地理位置。

字段
location_name	string 用户受邀前往的营业地点的名称。
address	string 用户受邀前往的营业地点的地址。

TargetType

邀请的目标类型。

枚举
TARGET_TYPE_UNSPECIFIED	在未指定目标类型时设置。
ACCOUNTS_ONLY	仅列出类型为“帐号”的目标的邀请。
LOCATIONS_ONLY	仅列出地理位置类型的目标的邀请。

ListAccountAdminsRequest

AccessControl.ListAccountAdmins 的请求消息。

字段
parent	string 必需。要从中检索管理员列表的帐号名称。accounts/{account_id}/admins.

ListAccountAdminsResponse

AccessControl.ListAccountAdmins 的响应消息。

字段
account_admins[]	Admin Admin 实例的集合。

ListAccountsRequest

Accounts.ListAccounts 的请求消息。

字段
parent_account	string 可选。要获取可直接访问的帐号列表的帐号的资源名称。这仅适用于组织和用户群组。如果为空，系统将针对经过身份验证的用户返回 ListAccounts。accounts/{account_id}.
page_size	int32 可选。每页可提取的帐号数量。默认值和最大值为 20。
page_token	string 可选。如果指定，则检索下一页帐号。调用 accounts.list 返回的结果数超过所请求的页面大小可以容纳的数量时，系统会返回 pageToken。
filter	string 可选。用于限制要返回的帐号的过滤条件。响应仅包含与过滤条件匹配的条目。如果 filter 为空，则系统不会应用任何限制条件，并检索所请求帐号的所有帐号（分页）。 例如，使用过滤条件 type=USER_GROUP 的请求将仅返回用户群组。 type 字段是唯一受支持的过滤条件。

ListAccountsResponse

Accounts.ListAccounts 的响应消息。

字段
accounts[]	Account 用户有访问权限的一组帐号。执行查询的用户的个人帐号将始终是结果的第一个项目，除非帐号被滤除。
next_page_token	string 如果帐号数量超过所请求的页面大小，系统会使用令牌填充此字段，以在后续调用 accounts.list 时获取下一页帐号。如果没有更多帐号，此字段不会出现在响应中。

ListInvitationsRequest

AccessControl.ListInvitations 的请求消息。

字段
parent	string 必需。从中检索邀请列表的帐号名称。accounts/{account_id}/invitations
filter	string 可选。支持通过 Invitation.target_type 字段过滤响应。

ListInvitationsResponse

AccessControl.ListInvitations 的响应消息。

字段
invitations[]	Invitation 帐号待处理的邀请集合。此处所列的邀请数量不得超过 1000。

ListLocationAdminsRequest

AccessControl.ListLocationAdmins 的请求消息。

字段
parent	string 必需。要列出其管理员的营业地点的名称。locations/{location_id}/admins.

ListLocationAdminsResponse

AccessControl.ListLocationAdmins 的响应消息。

字段
admins[]	Admin Admin 的集合。

TransferLocationRequest

AccessControl.TransferLocation 的请求消息。

字段
name	string 必需。要转让的营业地点的名称。locations/{location_id}.
destination_account	string 必需。要将营业地点转移到的帐号资源的名称（例如“accounts/{account}”）。

UpdateAccountAdminRequest

AccessControl.UpdateAccountAdmin 的请求消息。

字段
account_admin	Admin 必需。Admin 的更新版本。
update_mask	FieldMask 必需。应更新的特定字段。唯一可修改的字段是“role”（角色）。

UpdateAccountRequest

Accounts.UpdateAccount 的请求消息。

字段
account	Account 必需。已更新的帐号。
update_mask	FieldMask 必需。应更新的特定字段。唯一可修改的字段是 accountName。
validate_only	bool 可选。如果为 true，则验证请求，而不实际更新帐号。

UpdateLocationAdminRequest

AccessControl.UpdateLocationAdmin 的请求消息。

字段
location_admin	Admin 必需。Admin 的更新版本。
update_mask	FieldMask 必需。应更新的特定字段。唯一可修改的字段是“role”（角色）。