Method: accounts.invitations.list

列出指定账号的待处理邀请。

HTTP 请求

GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。从中检索邀请列表的账号的名称。accounts/{account_id}/invitations

查询参数

参数
filter

string

可选。支持通过 Invitation.target_type 字段过滤响应。

请求正文

请求正文必须为空。

响应正文

AccessControl.ListInvitations 的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
字段
invitations[]

object (Invitation)

账号的待处理邀请集合。此处列出的邀请数量不得超过 1000。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/business.manage

如需了解详情，请参阅 OAuth 2.0 Overview。

邀请

表示待处理的邀请。

JSON 表示法 
{
  "name": string,
  "role": enum (AdminRole),
  "targetType": enum (TargetType),

  // Union field target can be only one of the following:
  "targetAccount": {
    object (Account)
  },
  "targetLocation": {
    object (TargetLocation)
  }
  // End of list of possible types for union field target.
}
字段
name

string

必需。邀请的资源名称。accounts/{account_id}/invitations/{invitation_id}。
role

enum (AdminRole)

仅限输出。账号的受邀角色。
targetType

enum (TargetType)

仅限输出。指定应在响应中显示的目标类型。
联合字段 target。指明此邀请所针对的目标。target 只能是下列其中一项：
targetAccount

object (Account)

此邀请所针对的账号（仅包含部分字段）。
targetLocation

object (TargetLocation)

此邀请所针对的目标营业地点。

TargetLocation

表示待处理邀请的目标营业地点。

JSON 表示法 
{
  "locationName": string,
  "address": string,
  "placeId": string
}
字段
locationName

string

用户受邀访问的营业地点的名称。
address

string

用户受邀访问的营业地点的地址。并非总是填充。
placeId

string

仅限输出。用户受邀访问的营业地点的地点 ID。并非总是填充。

TargetType

邀请所针对的目标类型。

枚举
TARGET_TYPE_UNSPECIFIED 在未指定目标类型时设置。
ACCOUNTS_ONLY 仅列出针对账号类型目标的邀请。
LOCATIONS_ONLY 仅列出针对营业地点类型目标的邀请。