Method: accounts.locations.list

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

درخواست HTTP

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

نشانی وب از نحو تراتبدیل gRPC استفاده می‌کند.

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

پارامترها
parent

string

الزامی. نام حسابی که مکان‌ها از آن واکشی می‌شود.

  • شناسه حساب خاص: اگر حساب از نوع AccountType.PERSONAL باشد، پاسخ فقط مکان‌هایی را برمی‌گرداند که مستقیماً تحت مالکیت آن حساب هستند. برای همه انواع دیگر (مثلاً AccountType.LOCATION_GROUP)، همه مکان‌های دردسترس را برمی‌گرداند.

  • جای‌بان (-): استفاده از accounts/- کاربر اصالت‌سنجی‌شده را شناسایی می‌کند. این گستره به‌طور پیش‌فرض AccountType.PERSONAL است اما شامل مکان‌های تحت مالکیت مستقیم و غیرمستقیم (مثلاً مکان‌های قابل‌دسترسی ازطریق گروه‌های عضو) می‌شود.

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

پارامترها
pageSize

integer

اختیاری. تعداد مکان‌هایی که در هر صفحه واکشی می‌شود. اگر تنظیم نشده باشد، مقدار پیش‌فرض ۱۰ است. حداقل ۱ و حداکثر اندازه صفحه ۱۰۰ است.
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 Overview مراجعه کنید.