Method: accounts.locations.list

নির্দিষ্ট অ্যাকাউন্টের জন্য লোকেশনের তালিকা দেখায়।

HTTP অনুরোধ

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

URL-এ 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 দেখুন।