Method: accounts.list

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

คำขอ HTTP

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

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

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

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

integer

จำนวนบัญชีที่จะดึงข้อมูลต่อ 1 หน้า ค่าเริ่มต้นคือ 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