ফিল্টার অ্যাকাউন্ট আপনি অ্যাক্সেস করতে পারেন

accounts.list মেথডটি আপনাকে Account রিসোর্সগুলোর একটি তালিকা পেতে দেয়, যেগুলো প্রমাণীকৃত ব্যবহারকারী অ্যাক্সেস করতে পারে। আপনি বিভিন্ন মানদণ্ডের উপর ভিত্তি করে ফলাফলকে সীমিত করতে filter কোয়েরি প্যারামিটার ব্যবহার করতে পারেন, যেমন:

  • অ্যাকাউন্টের বৈশিষ্ট্য
  • অন্যান্য অ্যাকাউন্টের সাথে সম্পর্ক (যেমন, উন্নত অ্যাকাউন্ট কাঠামোর প্রদানকারীগণ)
  • অ্যাকাউন্টগুলির সাথে সম্পর্কিত পরিষেবাগুলি

এটি একাধিক অ্যাকাউন্ট পরিচালনা করতে অথবা নির্দিষ্ট শর্ত পূরণ করে এমন বিশেষ ব্যবসায়িক অ্যাকাউন্ট খুঁজে বের করতে সহায়ক হতে পারে।

account পর্যায়ে ফিল্টার করার জন্য আপনি নিম্নলিখিত ফিল্ডগুলো ব্যবহার করতে পারেন:

  • capabilities ): account রিসোর্সের capabilities অনুযায়ী ফিল্টার করে (উল্লেখ্য যে, এই ফিল্ডটি রিসোর্সটির নিজের মধ্যে উপলব্ধ নয়)। শুধুমাত্র CAN_UPLOAD_PRODUCTS ক্যাপাবিলিটিটি সমর্থিত। এই ফিল্ডটি নেগেশন সমর্থন করে এবং কালেকশন সিনট্যাক্স ব্যবহার করে।
  • relationship(...) : একটি অ্যাকাউন্টের সাথে অন্য অ্যাকাউন্টের সম্পর্কের ধরন অনুযায়ী ফিল্টার করে। আপনি একটি অনুরোধে একাধিক relationship(...) ফিল্টার অন্তর্ভুক্ত করতে পারেন।
  • accountName : account রিসোর্সের accountName অনুযায়ী ফিল্টার করে।

ফিল্টার সিনট্যাক্স সম্পর্কে আরও বিস্তারিত তথ্যের জন্য, ফিল্টার সিনট্যাক্স গাইডটি দেখুন।

উদাহরণ

নিম্নলিখিত উদাহরণগুলিতে সবচেয়ে প্রচলিত কোয়েরিগুলি কীভাবে তৈরি করতে হয় তা ব্যাখ্যা করা হয়েছে। নিম্নলিখিত সমস্ত উদাহরণে accounts.list মেথডটি ব্যবহার করা হয়েছে। আরও তথ্যের জন্য, accounts.list রেফারেন্স ডকুমেন্টেশন দেখুন।

একটি নির্দিষ্ট প্রদানকারীর সাব-অ্যাকাউন্ট খুঁজুন

accounts.listSubaccounts মেথডটি সাব-অ্যাকাউন্টগুলোর তালিকা দেখার একটি সরাসরি উপায় প্রদান করে। আপনি পরবর্তী সেকশনগুলোতে বর্ণিত ফিল্টারিং সুবিধাগুলোও ব্যবহার করতে পারেন। আপনি যদি একটি অ্যাডভান্সড অ্যাকাউন্ট পরিচালনা করেন, তবে providerId এর উপর ফিল্টার করে এর সমস্ত সাব-অ্যাকাউন্টের তালিকা দেখতে পারেন। PROVIDER_ID জায়গায় আপনার অ্যাডভান্সড অ্যাকাউন্টের ID বসান।

উদাহরণস্বরূপ, যদি প্রোভাইডারের আইডি 123 হয়, তাহলে relationship(providerId=123) ব্যবহার করুন।

এটি আপনার অ্যাকাউন্টগুলোর কাঠামো ব্যবস্থাপনার জন্য উপযোগী।

GET https://merchantapi.googleapis.com/accounts/v1/accounts?filter=relationship(providerId%20%3D%20PROVIDER_ID)

একটি সফল অনুরোধ ২০০ স্ট্যাটাস কোড এবং মিলে যাওয়া সাব-অ্যাকাউন্টগুলোর তালিকা সহ একটি রেসপন্স বডি ফেরত দেয়:

{
  "accounts": [
    {
      "name": "accounts/77777",
      "accountId": "77777",
      "accountName": "SubAccount A of Provider",
      "adultContent": false,
      "languageCode": "fr",
      "timeZone": {
        "id": "Europe/Paris"
      }
    },
    {
      "name": "accounts/88888",
      "accountId": "88888",
      "accountName": "SubAccount B of Provider",
      "adultContent": false,
      "languageCode": "de",
      "timeZone": {
        "id": "Europe/Berlin"
      }
    }
  ],
  "nextPageToken": "XYZ123abcDEF..."
}

যেসব অ্যাকাউন্ট পণ্য আপলোড করতে পারে না, সেগুলো খুঁজুন।

আরও সুনির্দিষ্ট অনুসন্ধান তৈরি করতে আপনি একাধিক ফিল্টার শর্ত একত্রিত করতে পারেন।

accountName=*store* AND -capabilities:CAN_UPLOAD_PRODUCTS ফিল্টারটি সেইসব অ্যাকাউন্ট খুঁজে বের করে, যাদের নামে "store" শব্দটি রয়েছে কিন্তু সরাসরি প্রোডাক্ট আপলোড করার জন্য কনফিগার করা নেই। ` capabilities এর আগে থাকা হাইফেনটি - একটি নেগেশন অপারেটর হিসেবে কাজ করে। শুধুমাত্র অ্যাডভান্সড অ্যাকাউন্টগুলো খুঁজে বের করার জন্য এটি কার্যকর হতে পারে।

GET https://merchantapi.googleapis.com/accounts/v1/accounts?filter=accountName%20%3D%20%22*store*%22%20AND%20-capabilities%3ACAN_UPLOAD_PRODUCTS

একটি সফল অনুরোধ ২০০ স্ট্যাটাস কোড এবং মিলে যাওয়া অ্যাকাউন্টগুলোর তালিকা সহ একটি রেসপন্স বডি ফেরত দেয়:

{
  "accounts": [
    {
      "name": "accounts/54321",
      "accountId": "54321",
      "accountName": "Partner Store - US",
      "adultContent": false,
      "languageCode": "en",
      "timeZone": {
        "id": "America/New_York"
      }
    },
    {
      "name": "accounts/98765",
      "accountId": "98765",
      "accountName": "Auxiliary Brand Store",
      "adultContent": false,
      "languageCode": "fr",
      "timeZone": {
        "id": "Europe/Paris"
      }
    }
  ],
  "nextPageToken": "CDEfghIJKlmnOPQ..."
}

নাম অনুসারে অ্যাকাউন্ট খুঁজুন

আপনি এমন অ্যাকাউন্টগুলো অনুসন্ধান করতে পারেন, যেগুলোর প্রদর্শিত নাম একটি নির্দিষ্ট প্যাটার্নের সাথে মেলে।

উদাহরণস্বরূপ, accountName=*store* লিখলে সেইসব অ্যাকাউন্ট খুঁজে পাওয়া যাবে যাদের নামে "store" শব্দটি রয়েছে।

এর ফলে নির্দিষ্ট ব্যবসায়িক অ্যাকাউন্টগুলো দ্রুত খুঁজে পাওয়া যায়।

GET https://merchantapi.googleapis.com/accounts/v1/accounts?filter=accountName%20%3D%20%22*store*%22

একটি সফল অনুরোধ ২০০ স্ট্যাটাস কোড এবং মিলে যাওয়া অ্যাকাউন্টগুলোর তালিকা সহ একটি রেসপন্স বডি ফেরত দেয়:

{
  "accounts": [
    {
      "name": "accounts/12345",
      "accountId": "12345",
      "accountName": "My Awesome Store",
      "adultContent": false,
      "languageCode": "en",
      "timeZone": {
        "id": "America/Los_Angeles"
      }
    },
    {
      "name": "accounts/67890",
      "accountId": "67890",
      "accountName": "Another Store Online",
      "adultContent": false,
      "languageCode": "en",
      "timeZone": {
        "id": "Europe/London"
      }
    }
  ],
  "nextPageToken": "ABSdefGHIjklMNO..."
}

একটি নির্দিষ্ট পরিষেবার জন্য কোনো প্রদানকারীর সাথে সংযুক্ত অ্যাকাউন্টগুলি খুঁজুন।

আপনি এমন অ্যাকাউন্টগুলো খুঁজে পেতে পারেন যেগুলোর কোনো প্রোভাইডারের সাথে একটি নির্দিষ্ট পরিষেবা সম্পর্ক রয়েছে। উদাহরণস্বরূপ, অ্যাকাউন্ট অ্যাগ্রিগেশনের জন্য প্রোভাইডার PROVIDER_ID এর অধীনে একত্রিত সমস্ত অ্যাকাউন্ট খুঁজে পেতে, relationship(providerId= PROVIDER_ID ) AND service(type="ACCOUNT_AGGREGATION") ফিল্টারটি ব্যবহার করুন।

GET https://merchantapi.googleapis.com/accounts/v1/accounts?filter=relationship(providerId%20%3D%20PROVIDER_ID%20AND%20service(type%20%3D%20%22ACCOUNT_AGGREGATION%22))

একটি সফল অনুরোধ ২০০ স্ট্যাটাস কোড এবং মিলে যাওয়া অ্যাকাউন্টগুলোর তালিকা সহ একটি রেসপন্স বডি ফেরত দেয়:

{
  "accounts": [
    {
      "name": "accounts/54321",
      "accountId": "54321",
      "accountName": "Aggregated Account X",
      "adultContent": false,
      "languageCode": "en",
      "timeZone": {
        "id": "America/New_York"
      }
    }
  ]
}

পরিষেবা সম্পর্ক অনুমোদনের অবস্থার উপর ভিত্তি করে অ্যাকাউন্ট খুঁজুন

আপনি কোনো প্রোভাইডারের সাথে তাদের পরিষেবা সম্পর্কের স্থিতির উপর ভিত্তি করে অ্যাকাউন্টগুলি ফিল্টার করতে পারেন। উদাহরণস্বরূপ, একটি নির্দিষ্ট প্রোভাইডার PROVIDER_ID থেকে অ্যাকাউন্ট লিঙ্ক অনুরোধ (handshakeState = "PENDING") গ্রহণ করেনি এমন সমস্ত অ্যাকাউন্ট খুঁজে বের করতে।

উদাহরণস্বরূপ, সেই অ্যাকাউন্টগুলি খুঁজে বের করতে যেখানে প্রোভাইডার আইডি 123 , সার্ভিসের ধরণ ACCOUNT_MANAGEMENT এবং স্ট্যাটাস PENDING , relationship(service(handshakeState = "PENDING" AND type = "ACCOUNT_MANAGEMENT") AND providerId = 123) ব্যবহার করুন।

GET https://merchantapi.googleapis.com/accounts/v1/accounts?filter=relationship(service(handshakeState%20%3D%20%22PENDING%22%20AND%20type%20%3D%20%22ACCOUNT_MANAGEMENT%22)%20AND%20providerId%20%3D%20PROVIDER_ID)

একটি সফল অনুরোধ ২০০ স্ট্যাটাস কোড এবং মিলে যাওয়া অ্যাকাউন্টগুলোর তালিকা সহ একটি রেসপন্স বডি ফেরত দেয়:

{
  "accounts": [
    {
      "name": "accounts/98765",
      "accountId": "98765",
      "accountName": "Managed Account Y",
      "adultContent": false,
      "languageCode": "es",
      "timeZone": {
        "id": "Europe/Madrid"
      }
    }
  ]
}

ক্লায়েন্ট লাইব্রেরি ব্যবহার করে অ্যাকাউন্ট ফিল্টার করুন

নিম্নলিখিত উদাহরণগুলি দেখায় কিভাবে ক্লায়েন্ট লাইব্রেরি ব্যবহার করে সম্মিলিত মানদণ্ডের (যেমন অ্যাকাউন্টের নাম এবং কোনো প্রোভাইডারের সাথে সম্পর্ক) উপর ভিত্তি করে অ্যাকাউন্ট ফিল্টার করা যায়। এই উদাহরণগুলিতে accounts.list মেথডটি ব্যবহার করা হয়েছে। আরও তথ্যের জন্য, accounts.list রেফারেন্স ডকুমেন্টেশন দেখুন।

জাভা

import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1.Account;
import com.google.shopping.merchant.accounts.v1.AccountsServiceClient;
import com.google.shopping.merchant.accounts.v1.AccountsServiceClient.ListAccountsPagedResponse;
import com.google.shopping.merchant.accounts.v1.AccountsServiceSettings;
import com.google.shopping.merchant.accounts.v1.ListAccountsRequest;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;

/** This class demonstrates how to filter the accounts the user making the request has access to. */
public class FilterAccountsSample {

  public static void filterAccounts(Config config) throws Exception {

    // Obtains OAuth token based on the user's configuration.
    GoogleCredentials credential = new Authenticator().authenticate();

    // Creates service settings using the credentials retrieved above.
    AccountsServiceSettings accountsServiceSettings =
        AccountsServiceSettings.newBuilder()
            .setCredentialsProvider(FixedCredentialsProvider.create(credential))
            .build();

    // Calls the API and catches and prints any network failures/errors.
    try (AccountsServiceClient accountsServiceClient =
        AccountsServiceClient.create(accountsServiceSettings)) {

      // Filter for accounts with display names containing "store" and a provider with the ID "123":
      String filter = "accountName = \"*store*\" AND relationship(providerId = 123)";

      // Filter for all subaccounts of account "123":
      // String filter2 = "relationship(providerId = 123 AND service(type =
      // \"ACCOUNT_AGGREGATION\"))";

      // String filter3 = "relationship(service(handshakeState = \"APPROVED\" AND type =
      // \"ACCOUNT_MANAGEMENT\") AND providerId = 123)";

      ListAccountsRequest request = ListAccountsRequest.newBuilder().setFilter(filter).build();

      System.out.println("Sending list accounts request with filter:");
      ListAccountsPagedResponse response = accountsServiceClient.listAccounts(request);

      int count = 0;

      // Iterates over all rows in all pages and prints the sub-account
      // in each row.
      // `response.iterateAll()` automatically uses the `nextPageToken` and recalls the
      // request to fetch all pages of data.
      for (Account account : response.iterateAll()) {
        System.out.println(account);
        count++;
      }
      System.out.print("The following count of elements were returned: ");
      System.out.println(count);
    } catch (Exception e) {
      System.out.println(e);
    }
  }

  public static void main(String[] args) throws Exception {
    Config config = Config.load();

    filterAccounts(config);
  }
}

পিএইচপি

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1\Client\AccountsServiceClient;
use Google\Shopping\Merchant\Accounts\V1\ListAccountsRequest;

/**
 * This class demonstrates how to filter the accounts the user making the request has access to.
 */
class FilterAccounts
{
    public static function filterAccounts(array $config): void
    {

        // Gets the OAuth credentials to make the request.
        $credentials = Authentication::useServiceAccountOrTokenFile();

        // Creates options config containing credentials for the client to use.
        $options = ['credentials' => $credentials];

        // Creates a client.
        $accountsServiceClient = new AccountsServiceClient($options);

        // Calls the API and catches and prints any network failures/errors.
        try {

            // Filter for accounts with display names containing "store" and a provider with the ID "123":
            $filter = "accountName = \"*store*\" AND relationship(providerId = 123)";

            // Filter for all subaccounts of account "123":
            // $filter = "relationship(providerId = 123 AND service(type = \"ACCOUNT_AGGREGATION\"))";

            // $filter = "relationship(service(handshakeState = \"APPROVED\" AND type =
            // \"ACCOUNT_MANAGEMENT\") AND providerId = 123)";

            $request = new ListAccountsRequest(['filter' => $filter]);

            print "Sending list accounts request with filter:\n";
            $response = $accountsServiceClient->listAccounts($request);

            $count = 0;

            // Iterates over all rows in all pages and prints the sub-account
            // in each row.
            // `response.iterateAll()` automatically uses the `nextPageToken` and recalls the
            // request to fetch all pages of data.
            foreach ($response->iterateAllElements() as $account) {
                print_r($account); 
                $count++;
            }
            print "The following count of elements were returned: ";
            print $count . PHP_EOL;
        } catch (ApiException $e) {
            print $e->getMessage();
        }
    }

    public function callSample(): void
    {
        $config = Config::generateConfig();
        self::filterAccounts($config);
    }
}

$sample = new FilterAccounts();
$sample->callSample();

পাইথন

from examples.authentication import generate_user_credentials
from google.shopping.merchant_accounts_v1 import AccountsServiceClient
from google.shopping.merchant_accounts_v1 import ListAccountsRequest


def filter_accounts():
  """Filters the accounts the user making the request has access to."""

  # Get OAuth credentials.
  credentials = generate_user_credentials.main()

  # Create a client.
  client = AccountsServiceClient(credentials=credentials)

  # Create the filter string.
  filter_string = 'accountName = "*store*" AND relationship(providerId = 123)'

  # Create the request.
  request = ListAccountsRequest(filter=filter_string)

  # Make the request and print the response.
  try:
    print("Sending list accounts request with filter:")
    response = client.list_accounts(request=request)

    count = 0
    for account in response:
      print(account)
      count += 1

    print(f"The following count of elements were returned: {count}")

  except RuntimeError as e:
    print(e)


if __name__ == "__main__":
  filter_accounts()

অ্যাপসস্ক্রিপ্ট


/**
 * Filters and lists accounts for which the logged-in user has access to
 */
function filterAccounts() {
  // IMPORTANT:
  // Enable the Merchant API Accounts sub-API Advanced Service and call it
  // "MerchantApiAccounts"

  // Create the filter string.
  // Documentation can be found at
  // https://developers.google.com/merchant/api/guides/accounts/filter-syntax
  const filter = 'accountName = "*store*" AND relationship(providerId = 123)';
  try {
    console.log('Sending filter Accounts request');
    let pageToken;
    const pageSize = 500;
    // Call the Accounts.list API method with a filter. Use the pageToken to iterate through
    // all pages of results.
    do {
      const response =
          MerchantApiAccounts.Accounts.list({pageSize, pageToken, filter});
      for (const account of response.accounts) {
        console.log(account);
      }
      pageToken = response.nextPageToken;
    } while (pageToken); // Exits when there is no next page token.
  } catch (e) {
    console.log('ERROR!');
    console.log(e);
  }
}

cURL

curl --location 'https://merchantapi.googleapis.com/accounts/v1/accounts?filter=accountName%20%3D%20%22*store*%22%20AND%20relationship(providerId%20%3D%20PROVIDER_ID)' \
--header 'Authorization: Bearer API_TOKEN'