Method: accounts.invitations.list

Liệt kê những lời mời đang chờ xử lý cho tài khoản được chỉ định.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Các tham số
parent

string

Bắt buộc. Tên của tài khoản mà từ đó danh sách lời mời được truy xuất. accounts/{account_id}/invitations

Tham số truy vấn

Các tham số
filter

string

Không bắt buộc. Tính năng lọc phản hồi được hỗ trợ thông qua trườngInvite.target_type.

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

Thông báo phản hồi cho AccessControl.ListInvitess.

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:

Biểu diễn dưới dạng JSON 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
Các trường
invitations[]

object (Invitation)

Một tập hợp các lời mời đ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á 1.000.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

Thư mời

Đại diện cho lời mời đang chờ xử lý.

Biểu diễn dưới dạng 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.
}
Các trường
name

string

Bắt buộc. Tên tài nguyên cho lời mời. accounts/{account_id}/invitations/{invitation_id}.
role

enum (AdminRole)

Chỉ có đầu ra. Vai trò được mời trên tài khoản.
targetType

enum (TargetType)

Chỉ có đầu ra. Chỉ định loại mục tiêu nào sẽ xuất hiện trong phản hồi.
Trường nhóm target. Cho biết mục tiêu của lời mời này. target chỉ có thể là một trong những trạng thái sau đây:
targetAccount

object (Account)

Tài khoản có thư viện gửi lời mời này là dành cho tài khoản.
targetLocation

object (TargetLocation)

Vị trí mục tiêu của lời mời này.

TargetLocation

Đại diện cho vị trí mục tiêu cho lời mời đang chờ xử lý.

Biểu diễn dưới dạng JSON 
{
  "locationName": string,
  "address": string
}
Các trường
locationName

string

Tên của vị trí mà người dùng được mời.
address

string

Địa chỉ của vị trí mà người dùng được mời.

TargetType

Loại mục tiêu của lời mời.

Enum
TARGET_TYPE_UNSPECIFIED Đặt khi loại mục tiêu chưa được chỉ đị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í.