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

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

string

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

string

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

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

string

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