Method: accounts.locations.list

แสดงสถานที่สำหรับบัญชีที่ระบุ

คำขอ HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations

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

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

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

string

ต้องระบุ ชื่อบัญชีที่จะดึงข้อมูลสถานที่ หาก [บัญชี] [google.mybusiness.accountmanagement.v1.Account] ระดับบนสุดเป็น [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL ระบบจะแสดงเฉพาะสถานที่ตั้งที่เป็นของบัญชีโดยตรง มิฉะนั้นจะแสดงสถานที่ตั้งที่เข้าถึงได้ทั้งหมดจากบัญชี ไม่ว่าจะโดยทางตรงหรือทางอ้อม

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

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

integer

ไม่บังคับ จำนวนสถานที่ที่จะดึงข้อมูลต่อหน้า ค่าเริ่มต้นคือ 10 หากไม่ได้ตั้งค่าไว้ ค่าต่ำสุดคือ 1 และขนาดสูงสุดของหน้าเว็บคือ 100
pageToken

string

ไม่บังคับ หากระบุไว้ ระบบจะดึงข้อมูลสถานที่ page ถัดไป โทเค็นของหน้าเว็บถูกส่งคืนโดยการเรียกไปยัง locations.list ก่อนหน้านี้ เมื่อมีพื้นที่จำนวนมากเกินกว่าที่จะพอดีกับขนาดหน้าเว็บที่ขอ
filter

string

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

โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับช่องที่ถูกต้องและตัวอย่างการใช้งานที่หัวข้อคู่มือการใช้งานข้อมูลตำแหน่ง
orderBy

string

ไม่บังคับ กำลังจัดเรียงคำขอ ช่องหลายช่องควรคั่นด้วยคอมมาตามไวยากรณ์ SQL ลำดับการจัดเรียงเริ่มต้นจะเป็นจากน้อยไปมาก หากต้องการระบุลำดับจากมากไปน้อย ให้เพิ่มคำต่อท้าย " มากไปน้อย" ช่องที่ถูกต้องสำหรับ orderBy คือ title และ storeCode ตัวอย่างเช่น "title, storeCode desc" หรือ "title" หรือ "storeCode desc"
readMask

string (FieldMask format)

ต้องระบุ อ่านมาสก์เพื่อระบุช่องที่จะส่งคืนในการตอบกลับ

ซึ่งเป็นรายการชื่อฟิลด์ที่คั่นด้วยคอมมา ตัวอย่าง: "user.displayName,photo"

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

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

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

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

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

การแสดง JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
ช่อง
locations[]

object (Location)

สถานที่ตั้ง
nextPageToken

string

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

integer

จำนวนตำแหน่งโดยประมาณในรายการโดยไม่คำนึงถึงการใส่เลขหน้า ระบบจะแสดงช่องนี้เฉพาะในกรณีที่ใช้ filter เป็นพารามิเตอร์การค้นหา

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

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

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