Method: projects.locations.list

اطلاعات مربوط به مکان های پشتیبانی شده برای این سرویس را فهرست می کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.