Method: accounts.list

แสดงบัญชีทั้งหมดของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว ซึ่งรวมทั้งบัญชีทั้งหมดที่ผู้ใช้เป็นเจ้าของ รวมถึงบัญชีที่ผู้ใช้มีสิทธิ์การจัดการ

คำขอ HTTP

GET https://mybusiness.googleapis.com/v4/accounts

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

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

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

integer

จำนวนบัญชีที่จะดึงข้อมูลต่อหน้า ค่าเริ่มต้นคือ 20 ขั้นต่ำคือ 2 และขนาดสูงสุดคือ 20
pageToken

string

หากระบุไว้ ระบบจะเรียกดูหน้าถัดไปของบัญชี ระบบจะแสดงผล pageToken เมื่อการเรียก accounts.list ให้ผลลัพธ์มากเกินกว่าจะพอดีกับขนาดหน้าเว็บที่ขอ
name

string

ชื่อทรัพยากรของบัญชีที่ต้องการเรียกดูรายการบัญชีที่เข้าถึงได้โดยตรง ซึ่งวิธีการนี้เหมาะสำหรับองค์กรและกลุ่มผู้ใช้เท่านั้น หากเว้นว่างไว้ ระบบจะแสดงผล accounts.list สำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
filter

string

ตัวกรองที่จํากัดบัญชีที่จะแสดง การตอบกลับจะมีเฉพาะรายการที่ตรงกับตัวกรอง หาก filter ว่างเปล่า ระบบจะไม่ใช้ข้อจำกัดและจะดึงข้อมูลบัญชีทั้งหมด (ใส่เลขหน้า) สำหรับบัญชีที่ขอ

เช่น คำขอที่มีตัวกรอง type=USER_GROUP จะแสดงผลกลุ่มผู้ใช้เท่านั้น

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

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

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

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

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

การแสดง JSON 
{
  "accounts": [
    {
      object (Account)
    }
  ],
  "nextPageToken": string
}
ช่อง
accounts[]

object (Account)

กลุ่มของบัญชีที่ผู้ใช้มีสิทธิ์เข้าถึง บัญชีส่วนตัวของผู้ใช้ที่ทำการค้นหาจะเป็นรายการแรกของผลการค้นหาเสมอ เว้นแต่จะมีการกรองออก
nextPageToken

string

หากจำนวนบัญชีเกินขนาดหน้าเว็บที่ขอ ระบบจะป้อนข้อมูลในช่องนี้ด้วยโทเค็นเพื่อดึงข้อมูลหน้าถัดไปของบัญชีในการเรียก accounts.list ในภายหลัง หากไม่มีบัญชีแล้ว ระบบจะไม่แสดงช่องนี้ในการตอบกลับ

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

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0