Method: accounts.invitations.list
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Liệt kê các lời mời đang chờ xử lý cho tài khoản đã chỉ định.
Yêu cầu HTTP
GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/invitations
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Tham số |
parent |
string
Tên của tài khoản mà danh sách lời mời được truy xuất từ đó.
|
Tham số truy vấn
Tham số |
targetType |
enum (TargetType )
Chỉ định những loại mục tiêu sẽ xuất hiện trong phản hồi.
|
Nội dung yêu cầu
Nội dung yêu cầu phải trống.
Nội dung phản hồi
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Thông báo phản hồi cho AccessControl.ListInvitations.
Biểu diễn dưới dạng JSON |
{
"invitations": [
{
object (Invitation )
}
]
} |
Trường |
invitations[] |
object (Invitation )
Bộ sưu tập lời mời tham gia địa điểm đang chờ xử lý cho tài khoản. Số lượng lời mời được liệt kê ở đây không được vượt quá 1000.
|
Phạm vi cấp phép
Yêu cầu một trong các phạm vi OAuth sau:
https://www.googleapis.com/auth/plus.business.manage
https://www.googleapis.com/auth/business.manage
Để biết thêm thông tin, hãy xem bài viết Tổng quan về OAuth 2.0.
TargetType
Loại mục tiêu của lời mời.
Enum |
ALL |
Liệt kê lời mời cho tất cả các loại mục tiêu. Đây là tuỳ chọn mặc định. |
ACCOUNTS_ONLY |
Chỉ liệt kê lời mời cho các mục tiêu của loại Tài khoản. |
LOCATIONS_ONLY |
Chỉ liệt kê lời mời cho các mục tiêu của loại Vị trí. |
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-07-25 UTC.
[null,null,["Cập nhật lần gần đây nhất: 2025-07-25 UTC."],[[["\u003cp\u003eThis endpoint retrieves pending invitations for a specified Google My Business account.\u003c/p\u003e\n"],["\u003cp\u003eIt allows filtering by target type (Account or Location) using the \u003ccode\u003etargetType\u003c/code\u003e query parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of invitations with details, limited to a maximum of 1000.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required using specific OAuth scopes related to business management.\u003c/p\u003e\n"],["\u003cp\u003eThis endpoint is deprecated; consider using the Account Management API instead.\u003c/p\u003e\n"]]],["This document outlines the process of listing pending invitations for a specified account using the deprecated API. It uses a `GET` request to `https://mybusiness.googleapis.com/v4/{parent=accounts/*}/invitations`. The `parent` path parameter specifies the account. The `targetType` query parameter filters invitation types. An empty request body is required. The response returns a JSON array of `invitations`, each represented as an object. The request needs either the `plus.business.manage` or `business.manage` authorization scope. Three types are available: ALL, ACCOUNTS_ONLY and LOCATIONS_ONLY.\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- [TargetType](#TargetType)\n\n| Deprecated. Please use the [Account Management API](https://developers.google.com/my-business/reference/accountmanagement/rest/v1/accounts.invitations/list) instead.\nLists pending invitations for the specified account.\n\n### HTTP request\n\n`GET https://mybusiness.googleapis.com/v4/{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` The name of the account from which the list of invitations is being retrieved. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `targetType` | `enum (`[TargetType](/my-business/reference/rest/v4/accounts.invitations/list#TargetType)`)` Specifies which target types should appear in the response. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse message for AccessControl.ListInvitations.\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"invitations\": [ { object (/my-business/reference/rest/v4/accounts.invitations#Invitation) } ] } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `invitations[]` | `object (`[Invitation](/my-business/reference/rest/v4/accounts.invitations#Invitation)`)` A collection of location invitations that are pending for the account. The number of invitations listed here cannot exceed 1000. |\n\n### Authorization Scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/plus.business.manage`\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\nTargetType\n----------\n\nThe type of target an invitation is for.\n\n| Enums ||\n|------------------|-------------------------------------------------------------|\n| `ALL` | List invitations for all target types. This is the default. |\n| `ACCOUNTS_ONLY` | List invitations only for targets of type Account. |\n| `LOCATIONS_ONLY` | List invitations only for targets of type Location. |"]]