Method: accounts.invitations.list

แสดงรายการคำเชิญที่รอดำเนินการสำหรับบัญชีที่ระบุ

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
parent

string

ต้องระบุ ชื่อของบัญชีที่จะดึงรายการคำเชิญ accounts/{account_id}/invitations

พารามิเตอร์การค้นหา

พารามิเตอร์
filter

string

ไม่บังคับ ระบบรองรับการกรองการตอบกลับผ่านช่อง Invitation.target_type

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

ข้อความตอบกลับสำหรับ AccessControl.ListInvitations

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
ช่อง
invitations[]

object (Invitation)

คอลเล็กชันคำเชิญที่รอดำเนินการสำหรับบัญชี จำนวนคำเชิญที่แสดงที่นี่ต้องไม่เกิน 1,000 รายการ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต 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)

เอาต์พุตเท่านั้น ระบุประเภทเป้าหมายที่ควรปรากฏในการตอบกลับ
ฟิลด์ Union target ระบุเป้าหมายของคำเชิญนี้ target มีได้เพียงค่าใดค่าหนึ่งต่อไปนี้
targetAccount

object (Account)

บัญชีที่มีข้อมูลไม่ครบถ้วนซึ่งคำเชิญนี้มีไว้ให้
targetLocation

object (TargetLocation)

สถานที่เป้าหมายซึ่งคำเชิญนี้มีไว้ให้

TargetLocation

แสดงสถานที่เป้าหมายสำหรับคำเชิญที่รอดำเนินการ

การแสดง JSON 
{
  "locationName": string,
  "address": string,
  "placeId": string
}
ช่อง
locationName

string

ชื่อสถานที่ที่เชิญผู้ใช้
address

string

ที่อยู่ของสถานที่ที่เชิญผู้ใช้ อาจไม่มีข้อมูล
placeId

string

เอาต์พุตเท่านั้น รหัสสถานที่ของสถานที่ที่เชิญผู้ใช้ อาจไม่มีข้อมูล

TargetType

ประเภทเป้าหมายของคำเชิญ

Enum
TARGET_TYPE_UNSPECIFIED ตั้งค่าเมื่อไม่ได้ระบุประเภทเป้าหมาย
ACCOUNTS_ONLY แสดงรายการคำเชิญสำหรับเป้าหมายประเภทบัญชีเท่านั้น
LOCATIONS_ONLY แสดงรายการคำเชิญสำหรับเป้าหมายประเภทสถานที่เท่านั้น