Method: accounts.locations.list

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

คำขอ HTTP

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations

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

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

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

string

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

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

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

integer

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

string

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

string

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

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

string

รหัสภาษา BCP 47 ที่จะใช้รับพร็อพเพอร์ตี้สถานที่ตั้งที่แสดง หากไม่มีภาษานี้ ก็จะมีการระบุเป็นภาษาของสถานที่ตั้ง หากไม่มีทั้งสองตัวเลือก จะมีให้เป็นภาษาอังกฤษ

เลิกใช้งานแล้ว หลังจากวันที่ 15 สิงหาคม 2020 ระบบจะไม่ใช้ช่องนี้อีกต่อไป แต่จะใช้ภาษาของตำแหน่งเสมอ
orderBy

string

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

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

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

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

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

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

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

object (Location)

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

string

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

integer

จำนวนตำแหน่งโดยประมาณในรายการโดยไม่คำนึงถึงการใส่เลขหน้า

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

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

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

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