דף זה תורגם על ידי Cloud Translation API.

סינון תחביר

בדף הזה מוסבר התחביר שבו צריך להשתמש כדי לסנן חשבונות.

תחביר

כל הערכים שאינם מספרים שלמים צריכים להיות מוקפים במירכאות כפולות ("). כדי לדעת אילו ערכים מתקבלים בשדה מסוים, אפשר לעיין במסמכי העזר של השדה.

אפשר להשתמש ב-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:

‫* כל החשבונות המשניים בחשבון MCA שמכילים את המילה Store

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);
  }
}FilterAccountsSample.java

מפרט

המסננים פועלים לפי קבוצת משנה של מסנן 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
    : " = " | " != "
    ;

סינון תחביר קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

תחביר

Java

מפרט

סינון תחביר