Method: accounts.locations.list

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

درخواست HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations

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

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

پارامترها
parent

string

مورد نیاز. نام حساب برای واکشی مکان‌ها از آن. اگر [حساب] والدین [google.mybusiness.accountmanagement.v1.Account] از [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL باشد، فقط مکان‌هایی که مستقیماً متعلق به حساب هستند برگردانده می‌شوند، در غیر این صورت همه مکان های قابل دسترسی را از حساب، به طور مستقیم یا غیرمستقیم، برمی گرداند.

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

پارامترها
pageSize

integer

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

pageToken

string

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

filter

string

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

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

orderBy

string

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

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 مراجعه کنید.