篩選器語法

在 Merchant API 中，您可以篩選部分 list 方法 (例如 account.list)，只取得感興趣的結果。如要篩選結果，請使用 filter 參數，並搭配 EBNF 文法中定義的語法。本頁說明如何使用語法篩選帳戶。

語法

除了整數以外，所有值都必須以雙引號 (") 括住。如要瞭解特定欄位接受的值，請參閱該欄位的參考文件。

您可以使用 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 的所有帳戶。

注意： 只有在 providerId 也設為這些欄位時，才能依 accountIdAlias 或 externalAccountId 篩選。只有在特定 providerId 的情境下，使用這些欄位才有意義。

系統會忽略多餘的空格。例如，foo AND bar 與 foo AND bar 相同。

以下列舉幾個使用 account.list 方法篩選帳戶的範例：

• 進階帳戶中包含「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 | 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
    : " = "
    | " != "
    ;