Method: projects.locations.list

แสดงรายการข้อมูลเกี่ยวกับสถานที่ที่สนับสนุนสำหรับบริการนี้

คำขอ HTTP

GET https://firestore.googleapis.com/v1/{name=projects/*}/locations

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

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

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

string

ทรัพยากรที่เป็นเจ้าของคอลเล็กชันตำแหน่ง หากมี

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

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

string

ตัวกรองเพื่อจำกัดผลลัพธ์ให้แคบลงเหลือเพียงชุดย่อยที่ต้องการ ภาษาที่กรองจะยอมรับสตริงอย่าง "displayName=tokyo" และได้รับการบันทึกรายละเอียดเพิ่มเติมใน AIP-160

pageSize

integer

จำนวนผลลัพธ์สูงสุดที่จะแสดง หากไม่ได้ตั้งค่า บริการจะเลือกค่าเริ่มต้น

pageToken

string

โทเค็นของหน้าเว็บที่ได้รับจากช่อง nextPageToken ในการตอบกลับ ส่งโทเค็นของหน้าเพื่อรับหน้าถัดไป

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

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

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

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

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

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

object (Location)

รายการสถานที่ตั้งที่ตรงกับตัวกรองที่ระบุในคําขอ

nextPageToken

string

โทเค็นหน้าถัดไปของรายการมาตรฐาน

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

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

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์