ফিল্টার সিনট্যাক্স

Merchant API-তে কিছু list পদ্ধতির জন্য, যেমন account.list আপনি ফিল্টার করতে পারবেন যাতে শুধুমাত্র আপনার আগ্রহের ফলাফলই পান। ফলাফল ফিল্টার করতে, আপনাকে filter প্যারামিটার ব্যবহার করতে হবে, যার সিনট্যাক্স EBNF ব্যাকরণে সংজ্ঞায়িত করা আছে। এই পৃষ্ঠায় কীভাবে সিনট্যাক্স ব্যবহার করে অ্যাকাউন্ট ফিল্টার করতে হয় তা ব্যাখ্যা করা হয়েছে।

সিন্ট্যাক্স

পূর্ণসংখ্যা ছাড়া অন্য সব মান ডবল কোট (")-এর মধ্যে লিখতে হবে। নির্দিষ্ট ফিল্ডে কী কী মান লেখা যায় তা জানতে, সেই ফিল্ডের রেফারেন্স ডকুমেন্টেশন দেখুন।

একই কোয়েরিতে একাধিক ফিল্ডের জন্য ফিল্টার করতে আপনি AND ব্যবহার করতে পারেন। এছাড়াও, আপনি একাধিক relationship(...) ও service(...) ফিল্টার একত্রিত করতে AND ব্যবহার করতে পারেন। এখানে একাধিক relationship(...) ও service(...) ফিল্টার একত্রিত করার একটি উদাহরণ দেওয়া হল:

(relationship(service(type = "ACCOUNT_MANAGEMENT") AND service(handshakeState = "PENDING"))) OR (accountName = "store" AND relationship(...))

এই উদাহরণ থেকে নিম্নলিখিত অ্যাকাউন্টগুলি পাওয়া যায়:

  • অন্য অ্যাকাউন্টের সাথে অ্যাকাউন্ট ম্যানেজমেন্ট সম্পর্ক আছে এমন সব অ্যাকাউন্ট এবং অতিরিক্ত সম্পর্ক যা এখনও গ্রহণ করা হয়নি।

  • "store" ডিসপ্লে নাম সহ সেইসব অ্যাকাউন্ট, যাদের সাথে অন্যান্য অ্যাকাউন্টের সম্পর্ক আছে।

একই ফিল্ডে একাধিক ভ্যালু ফিল্টার করার জন্য আপনি AND ব্যবহার করতে পারবেন না। যেমন, আপনি accountName = "*A*" AND accountName = "*B*" ব্যবহার করতে পারবেন না।

একই কোয়েরিতে দুটি ফিল্ডের জন্য ফিল্টার করতে আপনি OR ব্যবহার করতে পারেন। OR অপারেটরের দুই দিকে ফিল্টার মানদণ্ডকে প্যারেন্থেসিসের মধ্যে রাখুন। যেমন, (accountName = "storeA") OR (accountName = "storeB").

দুটি ফিল্ড একত্রিত করতে আপনি শুধুমাত্র OR ব্যবহার করতে পারবেন। যেমন, আপনি (accountName = "storeA") OR (accountName = "storeB") OR (accountName = "storeC") ব্যবহার করতে পারবেন না।

AND ও OR অপারেটর এবং ফাংশন ইনভোকেশন ছাড়া অন্য কোথাও প্যারেন্থেসিস ব্যবহার করা যাবে না, যেমন relationship(...) ও service(...)।

accountName ও accountIdAlias-এর মতো স্ট্রিং ফিল্ডের জন্য, আপনি এমন ভ্যালু ফিল্টার করতে পারেন যাতে অ্যাস্টেরিস্কের (*) মধ্যে থাকা নির্দিষ্ট শব্দ বা অক্ষরের ক্রম থাকে। যেমন, accountName = "*foo*" এমন সব অ্যাকাউন্ট রিটার্ন করে যেগুলির accountName-এ foo আছে, যেমন "storeFoo"।

!= এবং * ব্যবহার করে আপনি এমন ভ্যালু ফিল্টার করতে পারবেন যেগুলিতে নির্দিষ্ট কোনও সিকোয়েন্স নেই। যেমন, accountName != "*foo*" এমন সব অ্যাকাউন্ট দেখায় যেগুলিতে accountName আছে কিন্তু foo নেই।

অতিরিক্ত হোয়াইট স্পেস উপেক্ষা করা হয়। যেমন, foo AND bar ও foo AND bar একই।

account.list মেথড ব্যবহার করে অ্যাকাউন্ট ফিল্টার করার কয়েকটি উদাহরণ এখানে দেওয়া হল:

  • "স্টোর" শব্দ থাকা উন্নত অ্যাকাউন্টের সব সাব-অ্যাকাউন্ট:
accountName = "*store*" AND relationship(service(type = "ACCOUNT_AGGREGATION"))
  • প্রোভাইডার 123456-এর ম্যানেজ করা সব অ্যাকাউন্ট:
relationship(service(type = "ACCOUNT_MANAGEMENT") AND providerId = 123456)
  • যেসব অ্যাকাউন্ট ১২৩৪৫৬ পরিষেবা প্রদানকারীকে আমন্ত্রণ পাঠিয়েছে অথবা এই পরিষেবা প্রদানকারীর থেকে আমন্ত্রণ গ্রহণ করতে হবে:
relationship(service(handshakeState = "PENDING" AND type ="ACCOUNT_MANAGEMENT")
AND providerId = 123456)

অনুরোধকারী ব্যবহারকারী অ্যাক্সেস করতে পারেন এমন অ্যাকাউন্ট ফিল্টার করতে, নিম্নলিখিত নমুনায় দেখানো google.shopping.merchant.accounts.v1.ListAccountsRequest পদ্ধতি ব্যবহার করুন।

Java

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);
  }
}

স্পেসিফিকেশন

ফিল্টারগুলি AIP ফিল্টার স্পেসিফিকেশনের একটি সাবসেট এবং এর আনুষ্ঠানিক EBNF ব্যাকাস-নউর ফর্ম মেনে চলে:

filter
    : accountFilterDisj
    | accountFilterConj

accountFilterDisj
    : "(" accountFilterConj " OR " accountFilterConj ")"
    ;
accountFilterConj
    : accountFilter {" AND " accountFilter}
    ;

accountFilter
    : accountNameFilter | capabilityFilter | relationshipFn | accessFilter
    ;

accountNameFilter
    : "accountName" comparator value
    ;

capabilityFilter
    : "capabilities:" capabilityValue
    | "-capabilities:" capabilityValue
    | "NOT capabilities:" capabilityValue
    ;
capabilityValue
    : "CAN_UPLOAD_PRODUCTS"
    ;

accessFilter
    : "access = " accessType
    ;

accessType
    : "DIRECT"
    | "INDIRECT"
    | "ALL"
    ;

relationshipFn
    : "relationship(" relationshipConj ")"
    ;
relationshipConj
    : relationshipFilter {" AND " relationshipFilter}
    ;
relationshipFilter
    : "providerId = " numValue
    | "accountIdAlias" comparator value
    | serviceFn
    ;

serviceFn
    : "service(" serviceConj ")"
    ;
serviceConj
    : serviceFilter {" AND " serviceFilter}
    ;
serviceFilter
    : "externalAccountId" comparator value
    | "handshakeState = " handshakeState
    | "type = " serviceType
    ;

handshakeState
    : "PENDING"
    | "WAITING"
    | "ESTABLISHED"
    | "REJECTED"
    ;
serviceType
    : "ACCOUNT_AGGREGATION"
    | "ACCOUNT_MANAGEMENT"
    ;

comparator
    : " = "
    | " != "
    ;