Метод accounts.list
позволяет получить список ресурсов Account
, к которым имеет доступ аутентифицированный пользователь. Вы можете использовать параметр запроса filter
для сужения результатов по различным критериям, например:
- Свойства учетной записи
- Взаимоотношения с другими учетными записями (например, поставщики в расширенной структуре учетных записей)
- Услуги, связанные с аккаунтами
Это может быть полезно для управления несколькими аккаунтами или поиска конкретных бизнес-аккаунтов, соответствующих определенным условиям.
Для фильтрации на уровне account
можно использовать следующие поля:
-
access
: Фильтрация по типу доступа пользователя кaccount
. Этот фильтр принимает следующие значения:-
DIRECT
: Возвращает только те учетные записи, к которым у пользователя есть прямой доступ. -
INDIRECT
: Возвращает только учетные записи, к которым пользователь имеет косвенный доступ. -
ALL
: возвращает все учётные записи, к которым у пользователя есть доступ (как прямой, так и косвенный). Это поведение по умолчанию, если фильтр не указан.
-
-
capabilities
: фильтрация поcapabilities
ресурсаaccount
(обратите внимание, что это поле недоступно для самого ресурса). Поддерживается только возможностьCAN_UPLOAD_PRODUCTS
. Это поле поддерживает отрицание и использует синтаксис коллекций. -
relationship(...)
: Фильтрация по типу связи между учётной записью и другой учётной записью. Вы можете включить несколько фильтровrelationship(...)
в один запрос. -
accountName
: Фильтрация поaccountName
ресурсаaccount
.
Более подробную информацию о синтаксисе фильтра см. в руководстве по синтаксису фильтра .
Примеры
В следующих примерах объясняется, как формировать наиболее типичные запросы. Во всех примерах используется метод accounts.list
. Подробнее см. в справочной документации accounts.list
.
Найти субсчета определенного поставщика
Метод accounts.listSubaccounts
предоставляет прямой способ вывести список дочерних учётных записей. Вы также можете использовать возможности фильтрации, описанные в следующих разделах. Если вы управляете расширенной учётной записью, вы можете вывести список всех её дочерних учётных записей, отфильтровав данные по providerId
. Замените PROVIDER_ID
на идентификатор вашей расширенной учётной записи.
Например, используйте relationship(providerId=123)
, если идентификатор поставщика — 123
.
Это полезно для управления структурой ваших счетов.
GET https://merchantapi.googleapis.com/accounts/v1/accounts?filter=relationship(providerId%20%3D%20PROVIDER_ID)
Успешный запрос возвращает код статуса 200 и тело ответа со списком соответствующих субсчетов:
{
"accounts": [
{
"name": "accounts/77777",
"accountId": "77777",
"accountName": "SubAccount A of Provider",
"adultContent": false,
"languageCode": "fr",
"timeZone": {
"id": "Europe/Paris"
}
},
{
"name": "accounts/88888",
"accountId": "88888",
"accountName": "SubAccount B of Provider",
"adultContent": false,
"languageCode": "de",
"timeZone": {
"id": "Europe/Berlin"
}
}
],
"nextPageToken": "XYZ123abcDEF..."
}
Найдите учетные записи, которые не могут загружать продукты
Вы можете объединить несколько условий фильтрации для создания более конкретных поисковых запросов.
Фильтр accountName=*store* AND -capabilities:CAN_UPLOAD_PRODUCTS
находит все учётные записи со словом «store» в названии, которые не настроены на прямую загрузку товаров. Символ -
перед словом capabilities
действует как оператор отрицания. Это может быть полезно для поиска только расширенных учётных записей.
GET https://merchantapi.googleapis.com/accounts/v1/accounts?filter=accountName%20%3D%20%22*store*%22%20AND%20-capabilities%3ACAN_UPLOAD_PRODUCTS
Успешный запрос возвращает код статуса 200 и тело ответа со списком соответствующих учетных записей:
{
"accounts": [
{
"name": "accounts/54321",
"accountId": "54321",
"accountName": "Partner Store - US",
"adultContent": false,
"languageCode": "en",
"timeZone": {
"id": "America/New_York"
}
},
{
"name": "accounts/98765",
"accountId": "98765",
"accountName": "Auxiliary Brand Store",
"adultContent": false,
"languageCode": "fr",
"timeZone": {
"id": "Europe/Paris"
}
}
],
"nextPageToken": "CDEfghIJKlmnOPQ..."
}
Найти аккаунты по имени
Вы можете искать учетные записи, отображаемое имя которых соответствует определенному шаблону.
Например, accountName=*store*
найдет все учетные записи, в названии которых есть слово «store».
Это помогает быстро находить нужные бизнес-аккаунты.
GET https://merchantapi.googleapis.com/accounts/v1/accounts?filter=accountName%20%3D%20%22*store*%22
Успешный запрос возвращает код статуса 200 и тело ответа со списком соответствующих учетных записей:
{
"accounts": [
{
"name": "accounts/12345",
"accountId": "12345",
"accountName": "My Awesome Store",
"adultContent": false,
"languageCode": "en",
"timeZone": {
"id": "America/Los_Angeles"
}
},
{
"name": "accounts/67890",
"accountId": "67890",
"accountName": "Another Store Online",
"adultContent": false,
"languageCode": "en",
"timeZone": {
"id": "Europe/London"
}
}
],
"nextPageToken": "ABSdefGHIjklMNO..."
}
Найти учетные записи, связанные с поставщиком определенной услуги
Вы можете найти учётные записи, имеющие определённые сервисные отношения с провайдером. Например, чтобы найти все учётные записи, агрегированные по идентификатору поставщика PROVIDER_ID
, используйте фильтр relationship(providerId= PROVIDER_ID ) AND service(type="ACCOUNT_AGGREGATION")
.
GET https://merchantapi.googleapis.com/accounts/v1/accounts?filter=relationship(providerId%20%3D%20PROVIDER_ID%20AND%20service(type%20%3D%20%22ACCOUNT_AGGREGATION%22))
Успешный запрос возвращает код статуса 200 и тело ответа со списком соответствующих учетных записей:
{
"accounts": [
{
"name": "accounts/54321",
"accountId": "54321",
"accountName": "Aggregated Account X",
"adultContent": false,
"languageCode": "en",
"timeZone": {
"id": "America/New_York"
}
}
]
}
Найти учетные записи на основе состояния утверждения сервисных отношений
Вы можете фильтровать учётные записи по статусу их сервисных отношений с поставщиком. Например, чтобы найти все учётные записи, которые не приняли запрос на привязку учётной записи (handshakeState = "PENDING")
от определённого поставщика PROVIDER_ID
.
Например, чтобы найти учетные записи, где идентификатор поставщика — 123
, тип службы — ACCOUNT_MANAGEMENT
, а статус — PENDING
, используйте relationship(service(handshakeState = "PENDING" AND type = "ACCOUNT_MANAGEMENT") AND providerId = 123)
.
GET https://merchantapi.googleapis.com/accounts/v1/accounts?filter=relationship(service(handshakeState%20%3D%20%22PENDING%22%20AND%20type%20%3D%20%22ACCOUNT_MANAGEMENT%22)%20AND%20providerId%20%3D%20PROVIDER_ID)
Успешный запрос возвращает код статуса 200 и тело ответа со списком соответствующих учетных записей:
{
"accounts": [
{
"name": "accounts/98765",
"accountId": "98765",
"accountName": "Managed Account Y",
"adultContent": false,
"languageCode": "es",
"timeZone": {
"id": "Europe/Madrid"
}
}
]
}
Фильтрация учетных записей с использованием клиентских библиотек
В следующих примерах показано, как использовать клиентские библиотеки для фильтрации учётных записей по комбинированным критериям, таким как имя учётной записи и связь с поставщиком. В этих примерах используется метод accounts.list
. Подробнее см. в справочной документации accounts.list
.
Ява
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);
}
}
PHP
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1\Client\AccountsServiceClient;
use Google\Shopping\Merchant\Accounts\V1\ListAccountsRequest;
/**
* This class demonstrates how to filter the accounts the user making the request has access to.
*/
class FilterAccounts
{
public static function filterAccounts(array $config): void
{
// Gets the OAuth credentials to make the request.
$credentials = Authentication::useServiceAccountOrTokenFile();
// Creates options config containing credentials for the client to use.
$options = ['credentials' => $credentials];
// Creates a client.
$accountsServiceClient = new AccountsServiceClient($options);
// Calls the API and catches and prints any network failures/errors.
try {
// Filter for accounts with display names containing "store" and a provider with the ID "123":
$filter = "accountName = \"*store*\" AND relationship(providerId = 123)";
// Filter for all subaccounts of account "123":
// $filter = "relationship(providerId = 123 AND service(type = \"ACCOUNT_AGGREGATION\"))";
// $filter = "relationship(service(handshakeState = \"APPROVED\" AND type =
// \"ACCOUNT_MANAGEMENT\") AND providerId = 123)";
$request = new ListAccountsRequest(['filter' => $filter]);
print "Sending list accounts request with filter:\n";
$response = $accountsServiceClient->listAccounts($request);
$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.
foreach ($response->iterateAllElements() as $account) {
print_r($account);
$count++;
}
print "The following count of elements were returned: ";
print $count . PHP_EOL;
} catch (ApiException $e) {
print $e->getMessage();
}
}
public function callSample(): void
{
$config = Config::generateConfig();
self::filterAccounts($config);
}
}
$sample = new FilterAccounts();
$sample->callSample();
Питон
from examples.authentication import generate_user_credentials
from google.shopping.merchant_accounts_v1 import AccountsServiceClient
from google.shopping.merchant_accounts_v1 import ListAccountsRequest
def filter_accounts():
"""Filters the accounts the user making the request has access to."""
# Get OAuth credentials.
credentials = generate_user_credentials.main()
# Create a client.
client = AccountsServiceClient(credentials=credentials)
# Create the filter string.
filter_string = 'accountName = "*store*" AND relationship(providerId = 123)'
# Create the request.
request = ListAccountsRequest(filter=filter_string)
# Make the request and print the response.
try:
print("Sending list accounts request with filter:")
response = client.list_accounts(request=request)
count = 0
for account in response:
print(account)
count += 1
print(f"The following count of elements were returned: {count}")
except RuntimeError as e:
print(e)
if __name__ == "__main__":
filter_accounts()
AppsScript
/**
* Filters and lists accounts for which the logged-in user has access to
*/
function filterAccounts() {
// IMPORTANT:
// Enable the Merchant API Accounts sub-API Advanced Service and call it
// "MerchantApiAccounts"
// Create the filter string.
// Documentation can be found at
// https://developers.google.com/merchant/api/guides/accounts/filter-syntax
const filter = 'accountName = "*store*" AND relationship(providerId = 123)';
try {
console.log('Sending filter Accounts request');
let pageToken;
let pageSize = 500;
// Call the Accounts.list API method with a filter. Use the pageToken to iterate through
// all pages of results.
do {
response =
MerchantApiAccounts.Accounts.list({pageSize, pageToken, filter});
for (const account of response.accounts) {
console.log(account);
}
pageToken = response.nextPageToken;
} while (pageToken); // Exits when there is no next page token.
} catch (e) {
console.log('ERROR!');
console.log(e);
}
}
cURL
curl --location 'https://merchantapi.googleapis.com/accounts/v1/accounts?filter=accountName%20%3D%20%22*store*%22%20AND%20relationship(providerId%20%3D%20PROVIDER_ID)' \
--header 'Authorization: Bearer <API_TOKEN>'