Синтаксис фильтра

На этой странице объясняется синтаксис, который необходимо использовать для фильтрации учетных записей .

Синтаксис

Все значения, отличные от целых чисел, должны быть заключены в двойные кавычки ("). Чтобы узнать, какие значения принимает конкретное поле, см. справочную документацию по этому полю.

Вы можете использовать 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 .

Примечание: фильтрация по accountIdAlias ​​или externalAccountId возможна только в том случае, если в качестве этих полей также задан providerId . Использование этих полей имеет смысл только в контексте определенного providerId .

Дополнительные пробелы игнорируются. Например, 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.v1beta.ListAccountsRequest , как показано в следующем примере.

Ява

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
    : " = " | " != "
    ;