بنية الفلتر

توضّح هذه الصفحة بنية الجملة التي يجب استخدامها لفلترة الحسابات.

البنية

يجب إحاطة جميع القيم غير الأعداد الصحيحة بعلامات اقتباس مزدوجة ("). لمعرفة القيم التي يقبلها حقل معيّن، راجِع مستندات المراجع الخاصة بهذا الحقل.

يمكنك استخدام AND لفلترة حقول متعددة في طلب البحث نفسه. يمكنك أيضًا استخدام AND للجمع بين فلاتر relationship(...) وservice(...) متعددة. في ما يلي مثال يجمع بين عدة فلاتر 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)
  • جميع الحسابات التي أرسلت دعوة إلى مقدّم الخدمة 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
    ;

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"
    | "APPROVED"
    | "REJECTED"
    ;
serviceType
    : "ACCOUNT_AGGREGATION"
    | "ACCOUNT_MANAGEMENT"
    ;

comparator
    : " = " | " != "
    ;