列出指定帐号的待处理邀请。
HTTP 请求
GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
parent |
必需。从中检索邀请列表的帐号名称。 |
查询参数
参数 | |
---|---|
filter |
可选。支持通过 Invitation.target_type 字段过滤响应。 |
请求正文
请求正文必须为空。
响应正文
AccessControl.ListInvitations 的响应消息。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"invitations": [
{
object ( |
字段 | |
---|---|
invitations[] |
帐号待处理的邀请集合。此处所列的邀请数量不得超过 1000。 |
授权范围
需要以下 OAuth 作用域:
https://www.googleapis.com/auth/business.manage
有关详情,请参阅 OAuth 2.0 概览。
邀请
表示待处理的邀请。
JSON 表示法 |
---|
{ "name": string, "role": enum ( |
字段 | |
---|---|
name |
必需。邀请的资源名称。 |
role |
仅供输出。帐号的受邀角色。 |
targetType |
仅供输出。指定响应中应显示的定位类型。 |
联合字段 target 。指明此邀请针对的目标。target 只能是下列其中一项: |
|
targetAccount |
此邀请所针对的稀疏填充的帐号。 |
targetLocation |
此邀请的目标地理位置。 |
TargetLocation
表示待处理邀请的目标地理位置。
JSON 表示法 |
---|
{ "locationName": string, "address": string } |
字段 | |
---|---|
locationName |
用户受邀前往的营业地点的名称。 |
address |
用户受邀前往的营业地点的地址。 |
TargetType
邀请的目标类型。
枚举 | |
---|---|
TARGET_TYPE_UNSPECIFIED |
在未指定目标类型时设置。 |
ACCOUNTS_ONLY |
仅列出类型为“帐号”的目标的邀请。 |
LOCATIONS_ONLY |
仅列出地理位置类型的目标的邀请。 |