Method: accounts.locations.list

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

คำขอ HTTP

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

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

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

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

string

ต้องระบุ ชื่อบัญชีที่จะดึงข้อมูลสถานที่ตั้ง

  • รหัสบัญชีที่เฉพาะเจาะจง: หากบัญชีเป็นประเภท AccountType.PERSONAL การตอบกลับจะแสดงเฉพาะสถานที่ที่บัญชีนั้นเป็นเจ้าของโดยตรง สำหรับประเภทอื่นๆ ทั้งหมด (เช่น AccountType.LOCATION_GROUP) ระบบจะแสดงสถานที่ตั้งที่เข้าถึงได้ทั้งหมด

  • ไวลด์การ์ด (-): การใช้ accounts/- จะระบุผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว ขอบเขตนี้มีค่าเริ่มต้นเป็น AccountType.PERSONAL แต่รวมทั้งสถานที่ที่เป็นเจ้าของโดยตรงและโดยอ้อม (เช่น สถานที่ที่เข้าถึงได้ผ่านกลุ่มสมาชิก)

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

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

integer

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

string

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

string

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

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

string

ไม่บังคับ ลำดับการจัดเรียงสำหรับคำขอ หลายฟิลด์ควรคั่นด้วยคอมมาตามไวยากรณ์ SQL ลำดับการจัดเรียงเริ่มต้นคือจากน้อยไปมาก หากต้องการระบุลำดับจากมากไปน้อย ควรเพิ่มคำต่อท้าย " desc" ฟิลด์ที่ถูกต้องสำหรับ 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 Overview