এই পৃষ্ঠায় অ্যাকাউন্ট ফিল্টার করার জন্য প্রয়োজনীয় সিনট্যাক্স ব্যাখ্যা করা হয়েছে।
সিনট্যাক্স
পূর্ণসংখ্যা ব্যতীত অন্য সকল মান অবশ্যই ডবল কোট (") এর মধ্যে রাখতে হবে। কোনো নির্দিষ্ট ফিল্ড কী কী মান গ্রহণ করে তা জানতে, সেই ফিল্ডের রেফারেন্স ডকুমেন্টেশন দেখুন।
আপনি একই কোয়েরিতে একাধিক ফিল্ড ফিল্টার করতে 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 মেথড ব্যবহার করে অ্যাকাউন্ট ফিল্টার করার কয়েকটি উদাহরণ নিচে দেওয়া হলো:
* "স্টোর" ধারণকারী সমস্ত MCA সাব-অ্যাকাউন্ট
accountName = "*store*" AND relationship(service(type = "ACCOUNT_AGGREGATION"))
- প্রোভাইডার 123456 দ্বারা পরিচালিত সমস্ত অ্যাকাউন্ট
relationship(service(type = "ACCOUNT_MANAGEMENT") AND providerId = 123456)
- যেসব অ্যাকাউন্ট প্রোভাইডার 123456-কে আমন্ত্রণ পাঠিয়েছে অথবা এই প্রোভাইডারের কাছ থেকে আমন্ত্রণ গ্রহণ করতে হবে, তাদের সকলের জন্য।
relationship(service(handshakeState = "PENDING" AND type ="ACCOUNT_MANAGEMENT")
AND providerId = 123456)
অনুরোধকারী ব্যবহারকারী যে অ্যাকাউন্টগুলোতে অ্যাক্সেস করতে পারেন, সেগুলো ফিল্টার করার জন্য, নিচের নমুনায় দেখানো অনুযায়ী google.shopping.merchant.accounts.v1.ListAccountsRequest মেথডটি ব্যবহার করুন।
জাভা
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
;
accountNameFilter
: "accountName" comparator value
;
capabilityFilter
: "capabilities:" capabilityValue
| "-capabilities:" capabilityValue
| "NOT capabilities:" capabilityValue
;
capabilityValue
: "CAN_UPLOAD_PRODUCTS"
;
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
: " = " | " != "
;