ไวยากรณ์ตัวกรอง

หน้านี้จะอธิบายไวยากรณ์ที่คุณต้องใช้เพื่อกรองบัญชี

ไวยากรณ์

ค่าทั้งหมดที่ไม่ใช่จำนวนเต็มต้องอยู่ในเครื่องหมายคำพูดแบบคู่ (") หากต้องการดูค่าที่ช่องหนึ่งๆ ยอมรับ โปรดดูเอกสารอ้างอิงของช่องนั้น

คุณสามารถใช้ 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 เพื่อกรองฟิลด์ 2 รายการในการค้นหาเดียวกันได้ ใส่วงเล็บเหลี่ยมครอบเกณฑ์การกรองด้านข้างโอเปอเรเตอร์ OR เช่น (accountName = "storeA") OR (accountName = "storeB")

คุณใช้ OR เพื่อรวม 2 ช่องได้เท่านั้น เช่น คุณจะใช้ (accountName = "storeA") OR (accountName = "storeB") OR (accountName = "storeC") ไม่ได้

ไม่อนุญาตให้ใช้วงเล็บ ยกเว้นกับโอเปอเรเตอร์ AND และ OR รวมถึงในการเรียกใช้ฟังก์ชัน เช่น relationship(...) และ service(...)

สําหรับช่องสตริง เช่น accountName และ accountIdAlias คุณสามารถกรองค่าที่มีคําหรือลําดับอักขระที่ต้องการได้โดยใส่เครื่องหมายดอกจัน (*) ล้อมรอบลําดับนั้น เช่น accountName = "*foo*" จะแสดงผลบัญชีทั้งหมดที่มี accountName ที่มี foo เช่น "storeFoo"

คุณกรองหาค่าที่ไม่มีลําดับที่เฉพาะเจาะจงได้โดยใช้ != และ * เช่น accountName != "*foo*" จะแสดงบัญชีทั้งหมดที่มี accountName ที่ไม่มี foo

หมายเหตุ: การกรองตาม accountIdAlias หรือ externalAccountId จะทําได้ก็ต่อเมื่อมีการกําหนด providerId เป็นช่องเหล่านี้ด้วย การใช้ฟิลด์เหล่านี้เท่านั้นจะเหมาะสมในบริบทของ providerId ที่เฉพาะเจาะจง

ระบบจะไม่สนใจการเว้นวรรคเกินจำเป็น เช่น foo AND bar เหมือนกับ foo AND bar

หากต้องการกรองบัญชีที่ผู้ใช้ที่ส่งคำขอมีสิทธิ์เข้าถึง ให้ใช้เมธอด google.shopping.merchant.accounts.v1beta.ListAccountsRequest ดังที่แสดงในตัวอย่างต่อไปนี้

Java

import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1beta.Account;
import com.google.shopping.merchant.accounts.v1beta.AccountsServiceClient;
import com.google.shopping.merchant.accounts.v1beta.AccountsServiceClient.ListAccountsPagedResponse;
import com.google.shopping.merchant.accounts.v1beta.AccountsServiceSettings;
import com.google.shopping.merchant.accounts.v1beta.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
    : " = " | " != "
    ;