Method: accounts.locations.list

مکان های حساب مشخص شده را فهرست می کند.

درخواست HTTP

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations

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

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

پارامترها
parent

string

نام حساب برای واکشی مکان‌ها از آن. اگر Account از AccountType شخصی باشد، فقط مکان‌هایی که مستقیماً متعلق به حساب هستند بازگردانده می‌شوند، در غیر این صورت همه مکان‌های قابل دسترسی را از حساب، چه به‌طور مستقیم یا غیرمستقیم، برمی‌گرداند.

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

پارامترها
pageSize

integer

چند مکان برای واکشی در هر صفحه. پیش فرض 100، حداقل 1 و حداکثر اندازه صفحه 100 است.

pageToken

string

اگر مشخص شده باشد، page بعدی مکان ها را واکشی می کند. نشانه صفحه با تماس های قبلی به locations.list برگردانده می شود، زمانی که مکان های بیشتری از اندازه صفحه درخواستی وجود داشته باشد.

filter

string

فیلتری که مکان ها را برای بازگشت محدود می کند. پاسخ فقط شامل ورودی هایی می شود که با فیلتر مطابقت دارند. اگر filter خالی باشد، محدودیت ها اعمال می شود و همه مکان ها (صفحه بندی شده) برای حساب درخواستی بازیابی می شوند.

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

languageCode
(deprecated)

string

کد زبان BCP 47 برای دریافت ویژگی‌های مکان نمایشی. اگر این زبان در دسترس نباشد، به زبان مکان ارائه می‌شود. اگر هیچکدام در دسترس نباشد، به زبان انگلیسی ارائه خواهند شد.

منسوخ شده است. پس از 15 آگوست 2020، این فیلد دیگر اعمال نخواهد شد. در عوض، زبان مکان همیشه استفاده خواهد شد.

orderBy

string

ترتیب مرتب سازی برای درخواست چندین فیلد باید با کاما از هم جدا شوند، به دنبال نحو SQL. ترتیب مرتب سازی پیش فرض صعودی است. برای تعیین ترتیب نزولی، پسوند "desc" باید اضافه شود. فیلدهای معتبر برای orderBy، locationName و storeCode هستند. به عنوان مثال: "locationName, storeCode desc" یا "locationName" یا "storeCode desc"

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

پیام پاسخ برای Locations.ListLocations.

نمایندگی JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
فیلدها
locations[]

object ( Location )

مکان ها

nextPageToken

string

اگر تعداد مکان‌ها از اندازه صفحه درخواستی بیشتر باشد، این فیلد با یک نشانه پر می‌شود تا صفحه بعدی مکان‌ها را در تماس بعدی با locations.list واکشی کند. اگر مکان دیگری وجود نداشته باشد، این فیلد در پاسخ وجود ندارد.

totalSize

integer

تعداد تقریبی مکان‌ها در فهرست صرف نظر از صفحه‌بندی.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.