Method: accounts.invitations.list

Liệt kê các 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

Tham số
parent

string

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

Tham số truy vấn

Thông số
filter

string

Không bắt buộc. Bạn có thể lọc phản hồi thông qua trường Invitation.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.ListInvitations.

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)
    }
  ]
}
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 OAuth 2.0 Overview.

Thư mời

Đại diện cho một 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.
}
Trường
name

string

Bắt buộc. Tên tài nguyên của 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 những loại mục tiêu 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:
targetAccount

object (Account)

Tài khoản có ít dữ liệu mà lời mời này dành cho.
targetLocation

object (TargetLocation)

Vị trí mục tiêu mà lời mời này dành cho.

TargetLocation

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

Biểu diễn dưới dạng JSON 
{
  "locationName": string,
  "address": string,
  "placeId": string
}
Trường
locationName

string

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

string

Địa chỉ của vị trí mà người dùng được mời. Không phải lúc nào cũng được điền sẵn.
placeId

string

Chỉ có đầu ra. Mã địa điểm của vị trí mà người dùng được mời đến. Không phải lúc nào cũng được điền sẵn.

TargetType

Loại mục tiêu mà lời mời hướng đến.

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 thuộc loại Tài khoản.
LOCATIONS_ONLY Chỉ liệt kê lời mời cho các mục tiêu thuộc loại Vị trí.