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

מידע נוסף זמין בסקירה הכללית על אימות.