Method: accounts.locations.list

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

คำขอ HTTP

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

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

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

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

string

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

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

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

integer

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

string

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

string

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

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

string

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

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

string

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

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

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

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

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

ข้อความตอบกลับสำหรับ 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