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 概览。
邀请
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
} |
字段 |
locationName |
string
用户受邀前往的营业地点的名称。
|
address |
string
用户受邀前往的营业地点的地址。
|
TargetType
枚举 |
TARGET_TYPE_UNSPECIFIED |
未指定目标类型时设置。 |
ACCOUNTS_ONLY |
仅针对“账号”类型的目标列出邀请。 |
LOCATIONS_ONLY |
仅列出针对“地理位置”类型的目标的邀请。 |
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[[["\u003cp\u003eLists pending invitations, up to 1000, for a specified Google My Business account.\u003c/p\u003e\n"],["\u003cp\u003eFilter results by invitation target type (Account or Location).\u003c/p\u003e\n"],["\u003cp\u003eResponse includes invitation details such as name, role, target type, and target information.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/business.manage\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eInvitations can be targeted towards either a Google My Business account or a specific location.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.invitations.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListInvitationsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Invitation](#Invitation)\n - [JSON representation](#Invitation.SCHEMA_REPRESENTATION)\n- [TargetLocation](#TargetLocation)\n - [JSON representation](#TargetLocation.SCHEMA_REPRESENTATION)\n- [TargetType](#TargetType)\n\nLists pending invitations for the specified account.\n\n### HTTP request\n\n`GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The name of the account from which the list of invitations is being retrieved. `accounts/{account_id}/invitations` |\n\n### Query parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------|\n| `filter` | `string` Optional. Filtering the response is supported via the Invitation.target_type field. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for AccessControl.ListInvitations.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"invitations\": [ { object (/my-business/reference/accountmanagement/rest/v1/accounts.invitations/list#Invitation) } ] } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `invitations[]` | `object (`[Invitation](/my-business/reference/accountmanagement/rest/v1/accounts.invitations/list#Invitation)`)` A collection of invitations that are pending for the account. The number of invitations listed here cannot exceed 1000. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/business.manage`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nInvitation\n----------\n\nRepresents a pending invitation.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"role\": enum (/my-business/reference/accountmanagement/rest/v1/accounts.admins#Admin.AdminRole), \"targetType\": enum (/my-business/reference/accountmanagement/rest/v1/accounts.invitations/list#TargetType), // Union field `target` can be only one of the following: \"targetAccount\": { object (/my-business/reference/accountmanagement/rest/v1/accounts#Account) }, \"targetLocation\": { object (/my-business/reference/accountmanagement/rest/v1/accounts.invitations/list#TargetLocation) } // End of list of possible types for union field `target`. } ``` |\n\n| Fields ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The resource name for the invitation. `accounts/{account_id}/invitations/{invitation_id}`. |\n| `role` | `enum (`[AdminRole](/my-business/reference/accountmanagement/rest/v1/accounts.admins#Admin.AdminRole)`)` Output only. The invited role on the account. |\n| `targetType` | `enum (`[TargetType](/my-business/reference/accountmanagement/rest/v1/accounts.invitations/list#TargetType)`)` Output only. Specifies which target types should appear in the response. |\n| Union field `target`. Indicates the target this invitation is for. `target` can be only one of the following: ||\n| `targetAccount` | `object (`[Account](/my-business/reference/accountmanagement/rest/v1/accounts#Account)`)` The sparsely populated account this invitation is for. |\n| `targetLocation` | `object (`[TargetLocation](/my-business/reference/accountmanagement/rest/v1/accounts.invitations/list#TargetLocation)`)` The target location this invitation is for. |\n\nTargetLocation\n--------------\n\nRepresents a target location for a pending invitation.\n\n| JSON representation |\n|-------------------------------------------------------|\n| ``` { \"locationName\": string, \"address\": string } ``` |\n\n| Fields ||\n|----------------|--------------------------------------------------------------------|\n| `locationName` | `string` The name of the location to which the user is invited. |\n| `address` | `string` The address of the location to which the user is invited. |\n\nTargetType\n----------\n\nThe type of target an invitation is for.\n\n| Enums ||\n|---------------------------|-----------------------------------------------------|\n| `TARGET_TYPE_UNSPECIFIED` | Set when target type is unspecified. |\n| `ACCOUNTS_ONLY` | List invitations only for targets of type Account. |\n| `LOCATIONS_ONLY` | List invitations only for targets of type Location. |"]]