API OmnichannelSettings — это точка входа для настройки ваших программ Local Inventory Ads (LIA) и Free Local Listings (FLL).
Используйте его для программного обеспечения.
- Управление (создание и обновление) настройками омниканальной сети.
- Получение (получение и перечисление) настроек многоканальной сети.
- Запросите проверку наличия товаров у соответствующих продавцов.
Для получения дополнительной информации см. раздел «Обзор объявлений о продаже недвижимости в вашем районе и бесплатных местных объявлений» .
Предварительные требования
Вам следовало бы
учетная запись Merchant Center
Бизнес-профиль. Если у вас его нет, вы можете его создать. См. раздел «Регистрация бизнес-профиля» .
Связывание вашего бизнес-профиля с вашей учетной записью Merchant Center. Для создания связи вы можете использовать пользовательский интерфейс Merchant Center или Merchant API (см. раздел «Связывание бизнес-профиля Google »).
Создайте многоканальную настройку.
Для создания многоканальной настройки можно использовать метод ` omnichannelSettings.create . Метод `create` принимает в качестве входных данных ресурс ` omnichannelSetting и в случае успеха возвращает созданную многоканальную настройку.
При создании необходимо заполнить поля regionCode и LsfType :
- Параметр OmnichannelSetting применяется к каждой стране отдельно.
RegionCodeопределяет целевую страну. После создания его изменить нельзя.RegionCodeдолжен соответствовать правилам именования, определенным проектом Common Locale Data Repository (CLDR) . -
LsfTypeопределяется на основе страницы вашего товара. Подробнее см.LsfType.
Для получения более подробной информации см. раздел «Изменение внешнего вида страницы товара для объявлений о наличии товара в вашем регионе» .
Заполнять все поля на этапе создания необязательно, их можно настроить позже. Чтобы обновить существующий параметр omnichannelSetting , см. раздел «Обновление параметра omnichannelSetting» .
Вот пример запроса, если вы выберете MHLSF_BASIC и зарегистрируетесь inStock :
POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/omnichannelSettings
{
"regionCode": "{REGION_CODE}",
"lsfType: "MHLSF_BASIC",
"inStock": {
"uri": "{URI}"
}
}
Замените следующее:
-
{ACCOUNT_ID}: Уникальный идентификатор вашей учетной записи в Merchant Center. -
{REGION_CODE}: Код региона, определенный CLDR. -
{URI}: Действительный URI, используемый для данного обзора. Недопустимый URI может помешать одобрению.
После успешного выполнения запроса вы должны увидеть следующий ответ:
{
"name": "accounts/{ACCOUNT_ID}/omnichannelSettings/{omnichannel_setting}",
"regionCode": "{REGION_CODE}",
"lsfType: "MHLSF_BASIC",
"inStock": {
"uri": "{URI}",
"state": "RUNNING"
}
}
Регистрация различных функций LIA/FLL с использованием полей omnichannelSetting запускает ручную проверку, которая обычно занимает от нескольких часов до нескольких дней. Мы рекомендуем дважды проверить введенные данные, чтобы избежать ненужного ожидания из-за неподходящих данных.
Чтобы просмотреть созданные вами настройки омниканального взаимодействия или проверить состояние отзывов, используйте accounts.omnichannelSettings.get или accounts.omnichannelSettings.list , указав страну.
Тип местного магазина (LSF)
В зависимости от страницы продукта, который вы планируете использовать, выберите тип LsfType :
| Тип страницы товара | LsfType | Значение перечисления |
|---|---|---|
| Страницы товаров с информацией о наличии в магазинах | Базовый формат местного магазина, обслуживаемого продавцом. | MHLSF_BASIC |
| Страницы товаров, доступные в конкретном магазине, с указанием наличия и цены. | Торговая площадка местного магазина, полностью занятая товарами. | MHLSF_FULL |
| Страницы товаров, недоступных в магазинах. | Локальный интернет-магазин, размещенный на платформе Google (GHLSF) | GHLSF |
Если вы выбираете тип локального магазина, размещенного на сервере продавца, вам также необходимо заполнить поле URI хотя бы для одного из вариантов: inStock или pickup .
В наличии
Вы можете использовать InStock, чтобы предоставить более подробную информацию о странице вашего товара.
Если вы выберете типы LSF, размещаемые продавцом, и укажете поле URI в поле InStock, вы покажете свое намерение показывать товары, имеющиеся в наличии. Мы начнем проверку на основе предоставленного URI.
Если вы выберете тип GHLSF , вам необходимо указать пустое поле InStock в запросе. В отличие от типов LSF, размещаемых продавцом, для завершения процесса подключения вам необходимо пройти процедуру проверки наличия товара .
Этот пример кода создает объект omnichannelSetting с использованием GHLSF :
package shopping.merchant.samples.accounts.v1;
// [START merchantapi_create_omnichannel_setting]
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1.AccountName;
import com.google.shopping.merchant.accounts.v1.CreateOmnichannelSettingRequest;
import com.google.shopping.merchant.accounts.v1.InStock;
import com.google.shopping.merchant.accounts.v1.OmnichannelSetting;
import com.google.shopping.merchant.accounts.v1.OmnichannelSetting.LsfType;
import com.google.shopping.merchant.accounts.v1.OmnichannelSettingsServiceClient;
import com.google.shopping.merchant.accounts.v1.OmnichannelSettingsServiceSettings;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/**
* This class demonstrates how to create an omnichannel setting for a given Merchant Center account
* in a given country
*/
public class CreateOmnichannelSettingSample {
public static void createOmnichannelSetting(Config config, String regionCode) throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the retrieved credentials.
OmnichannelSettingsServiceSettings omnichannelSettingsServiceSettings =
OmnichannelSettingsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Calls the API and catches and prints any network failures/errors.
try (OmnichannelSettingsServiceClient omnichannelSettingsServiceClient =
OmnichannelSettingsServiceClient.create(omnichannelSettingsServiceSettings)) {
String accountId = config.getAccountId().toString();
String parent = AccountName.newBuilder().setAccount(accountId).build().toString();
// Creates an omnichannel setting with GHLSF type in the given country.
CreateOmnichannelSettingRequest request =
CreateOmnichannelSettingRequest.newBuilder()
.setParent(parent)
.setOmnichannelSetting(
OmnichannelSetting.newBuilder()
.setRegionCode(regionCode)
.setLsfType(LsfType.GHLSF)
.setInStock(InStock.getDefaultInstance())
.build())
.build();
System.out.println("Sending create omnichannel setting request:");
OmnichannelSetting response =
omnichannelSettingsServiceClient.createOmnichannelSetting(request);
System.out.println("Inserted Omnichannel Setting below:");
System.out.println(response);
} catch (Exception e) {
System.out.println("An error has occurred: ");
System.out.println(e);
}
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
// The country which you're targeting at.
String regionCode = "{REGION_CODE}";
createOmnichannelSetting(config, regionCode);
}
}
// [END merchantapi_list_omnichannel_settings]
Подобрать
Помимо наличия товара в магазине, вы также можете расширить ассортимент товаров, доступных в магазине, с помощью функции самовывоза, которая доступна только для товаров типа LSF, размещенных продавцом.
Если товар помечен как «Самовывоз», это означает, что покупатель может приобрести его онлайн и забрать в магазине. Указав поле Pickup , вы демонстрируете свое намерение предоставлять товары с условием самовывоза. Мы начнем проверку на основе предоставленного URI.
Вот пример запроса, который создает omnichannel конфигурацию с Pickup :
POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/omnichannelSettings
{
"regionCode": "{REGION_CODE}",
"lsfType: "MHLSF_BASIC",
"pickup": {
"uri: "{URI}"
}
}
Выставляется на продажу по предварительному заказу.
Функция «Выставка под заказ» позволяет демонстрировать товары, которые есть в вашем физическом магазине, но недоступны для немедленной покупки. Например, крупная мебель:
- Покупатели, ищущие похожие товары в Google, увидят эти объявления с пометкой «в магазине» в результатах поиска.
- Покупатели, просматривающие магазин на странице результатов поиска Google, увидят эти товары с пометкой «Доступно для заказа».
Они могут выбрать ваше местное рекламное объявление или бесплатное местное объявление, чтобы посмотреть товар. Чтобы купить товар, они могут посетить ваш физический магазин, посмотреть его, а затем заказать доставку или доставку в ваш магазин для самовывоза.
О Германии, Австрии и Швейцарии
Если вы проходите службу в Австрии или Германии и выбираете GHLSF , вам необходимо заполнить страницу «О нас» .
Если вы проходите службу в Швейцарии, вы должны предоставить страницу «О нас» независимо от LsfType .
До подтверждения URL-адреса страницы «О нас» продавцы GHLSF не могут запрашивать у Google ручную проверку наличия товаров на складе.
Для всех продавцов в этих трех странах функция FLL/LIA не будет активирована до тех пор, пока ваша страница «О нас» не получит одобрение.
Проверка инвентаризации
Проверка инвентаризации требуется только для продавцов, GHLSF . Для продавцов, использующих MHLSF она не поддерживается.
Перед добавлением данных о товарах и складских запасах (с помощью accounts.products.localInventories.insert или пользовательского интерфейса Merchant Center) или после этого необходимо подтвердить контактные данные. Укажите контактные данные для подтверждения наличия товара (имя и адрес электронной почты) с помощью метода create или update . Контакт получит электронное письмо от Google, и сможет подтвердить свой статус, нажав кнопку в сообщении.
После завершения этой процедуры вы можете запросить проверку инвентаризации . Для получения дополнительной информации см. раздел «О проверке инвентаризации» .
Вы можете изменить свои контактные данные во время процесса верификации или после верификации, используя omnichannelSetting.update .
После завершения этого процесса Google проверяет точность предоставленной информации.
Настройте многоканальную систему
Чтобы получить конфигурацию omnichannelSetting для конкретной страны или проверить текущий статус ваших отзывов, используйте метод omnichannelSettings.get .
Вот пример запроса:
GET https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/omnichannelSettings/{OMNICHANNEL_SETTING}
Замените следующее:
-
{ACCOUNT_ID}: Уникальный идентификатор вашей учетной записи в Merchant Center. -
{OMNICHANNEL_SETTING}: Код региона вашей целевой страны
Статус ACTIVE означает, что проверка получила одобрение.
Если статус FAILED , устраните проблемы и запустите новую проверку, вызвав функцию omnichannelSetting.update .
Поле LFP (только для чтения) отображает статус вашего партнерства с локальными источниками данных. Для привязки к партнерству используйте lfpProviders.linkLfpProvider .
Для получения дополнительной информации о проверке статусов и их значениях см. раздел «Просмотр статуса многоканальной настройки» .
Список настроек многоканальной сети
Чтобы получить всю информацию omnichannelSetting для вашей учетной записи, используйте метод omnichannelSettings.list .
Вот пример кода:
package shopping.merchant.samples.accounts.v1;
// [START merchantapi_list_omnichannel_settings]
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1.AccountName;
import com.google.shopping.merchant.accounts.v1.ListOmnichannelSettingsRequest;
import com.google.shopping.merchant.accounts.v1.OmnichannelSetting;
import com.google.shopping.merchant.accounts.v1.OmnichannelSettingsServiceClient;
import com.google.shopping.merchant.accounts.v1.OmnichannelSettingsServiceClient.ListOmnichannelSettingsPagedResponse;
import com.google.shopping.merchant.accounts.v1.OmnichannelSettingsServiceSettings;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/**
* This class demonstrates how to get the list of omnichannel settings for a given Merchant Center
* account
*/
public class ListOmnichannelSettingsSample {
public static void omnichannelSettings(Config config) throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the retrieved credentials.
OmnichannelSettingsServiceSettings omnichannelSettingsServiceSettings =
OmnichannelSettingsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
String accountId = config.getAccountId().toString();
String parent = AccountName.newBuilder().setAccount(accountId).build().toString();
// Calls the API and catches and prints any network failures/errors.
try (OmnichannelSettingsServiceClient omnichannelSettingsServiceClient =
OmnichannelSettingsServiceClient.create(omnichannelSettingsServiceSettings)) {
ListOmnichannelSettingsRequest request =
ListOmnichannelSettingsRequest.newBuilder().setParent(parent).build();
System.out.println("Sending list omnichannel setting request:");
ListOmnichannelSettingsPagedResponse response =
omnichannelSettingsServiceClient.listOmnichannelSettings(request);
int count = 0;
// Iterates over all the entries in the response.
for (OmnichannelSetting omnichannelSetting : response.iterateAll()) {
System.out.println(omnichannelSetting);
count++;
}
System.out.println(String.format("The following count of elements were returned: %d", count));
} catch (Exception e) {
System.out.println("An error has occurred: ");
System.out.println(e);
}
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
omnichannelSettings(config);
}
}
// [END merchantapi_list_omnichannel_settings]
Обновите настройки многоканальной сети.
Для обновления конфигурации существующей многоканальной настройки используйте метод omnichannelSettings.update .
Для обновления необходимо добавить нужную функцию в маску обновления и заполнить соответствующие поля в поле omnichannelSetting в запросе на обновление. Вы можете обновить любой из следующих компонентов:
-
lsfType -
inStock -
pickup -
odo -
about -
inventoryVerification
Если атрибут не включен в маску обновления, он не будет обновлен.
Если атрибут включен в маску обновления, но не задан в запросе, он будет очищен.
Приведенный ниже пример кода демонстрирует, как обновить поле проверки инвентаризации.
package shopping.merchant.samples.accounts.v1;
// [START merchantapi_update_omnichannel_setting]
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.protobuf.FieldMask;
import com.google.shopping.merchant.accounts.v1.InventoryVerification;
import com.google.shopping.merchant.accounts.v1.OmnichannelSetting;
import com.google.shopping.merchant.accounts.v1.OmnichannelSettingName;
import com.google.shopping.merchant.accounts.v1.OmnichannelSettingsServiceClient;
import com.google.shopping.merchant.accounts.v1.OmnichannelSettingsServiceSettings;
import com.google.shopping.merchant.accounts.v1.UpdateOmnichannelSettingRequest;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/**
* This class demonstrates how to update an omnichannel setting for a given Merchant Center account
* in a given country
*/
public class UpdateOmnichannelSettingSample {
public static void updateOmnichannelSettings(
Config config, String regionCode, String contact, String email) throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the retrieved credentials.
OmnichannelSettingsServiceSettings omnichannelSettingsServiceSettings =
OmnichannelSettingsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Calls the API and catches and prints any network failures/errors.
try (OmnichannelSettingsServiceClient omnichannelSettingsServiceClient =
OmnichannelSettingsServiceClient.create(omnichannelSettingsServiceSettings)) {
String accountId = config.getAccountId().toString();
String name =
OmnichannelSettingName.newBuilder()
.setAccount(accountId)
.setOmnichannelSetting(regionCode)
.build()
.toString();
OmnichannelSetting omnichannelSetting =
OmnichannelSetting.newBuilder()
.setName(name)
.setInventoryVerification(
InventoryVerification.newBuilder()
.setContact(contact)
.setContactEmail(email)
.build())
.build();
FieldMask fieldMask = FieldMask.newBuilder().addPaths("inventory_verification").build();
UpdateOmnichannelSettingRequest request =
UpdateOmnichannelSettingRequest.newBuilder()
.setOmnichannelSetting(omnichannelSetting)
.setUpdateMask(fieldMask)
.build();
System.out.println("Sending update omnichannel setting request:");
OmnichannelSetting response =
omnichannelSettingsServiceClient.updateOmnichannelSetting(request);
System.out.println("Updated Omnichannel Setting below:");
System.out.println(response);
} catch (Exception e) {
System.out.println("An error has occurred: ");
System.out.println(e);
}
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
// The country which you're targeting at.
String regionCode = "{REGION_CODE}";
// The name of the inventory verification contact you want to update.
String contact = "{NAME}";
// The address of the inventory verification email you want to update.
String email = "{EMAIL}";
updateOmnichannelSettings(config, regionCode, contact, email);
}
}
// [END merchantapi_update_omnichannel_setting]
Запросить проверку наличия товара на складе
omnichannelSettings.requestInventoryVerification актуален только для продавцов GHLSF .
Перед вызовом этого RPC-вызова необходимо выполнить следующие действия:
- Загрузите данные о вашей продукции и складских запасах.
- Подтвердите контакт для проверки инвентаризации.
- Для продавцов из Австрии, Германии или Швейцарии необходимо заполнить отзыв на странице
About.
Чтобы определить, соответствуете ли вы требованиям, вызовите метод omnichannelSettings.get и проверьте значение omnichannelSetting.inventoryVerification.state . Если оно показывает INACTIVE , вы можете вызвать omnichannelSettings.requestInventoryVerification .
package shopping.merchant.samples.accounts.v1;
// [START merchantapi_request_inventory_verification]
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1.OmnichannelSettingName;
import com.google.shopping.merchant.accounts.v1.OmnichannelSettingsServiceClient;
import com.google.shopping.merchant.accounts.v1.OmnichannelSettingsServiceSettings;
import com.google.shopping.merchant.accounts.v1.RequestInventoryVerificationRequest;
import com.google.shopping.merchant.accounts.v1.RequestInventoryVerificationResponse;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/**
* This class demonstrates how to request inventory verification for a given Merchant Center account
* in a given country
*/
public class RequestInventoryVerificationSample {
public static void requestInventoryVerification(Config config, String regionCode)
throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the retrieved credentials.
OmnichannelSettingsServiceSettings omnichannelSettingsServiceSettings =
OmnichannelSettingsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Calls the API and catches and prints any network failures/errors.
try (OmnichannelSettingsServiceClient omnichannelSettingsServiceClient =
OmnichannelSettingsServiceClient.create(omnichannelSettingsServiceSettings)) {
String accountId = config.getAccountId().toString();
String name =
OmnichannelSettingName.newBuilder()
.setAccount(accountId)
.setOmnichannelSetting(regionCode)
.build()
.toString();
RequestInventoryVerificationRequest request =
RequestInventoryVerificationRequest.newBuilder().setName(name).build();
System.out.println("Sending request inventory verification request:");
RequestInventoryVerificationResponse response =
omnichannelSettingsServiceClient.requestInventoryVerification(request);
System.out.println("Omnichannel Setting after inventory verification request below:");
System.out.println(response);
} catch (Exception e) {
System.out.println("An error has occurred: ");
System.out.println(e);
}
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
// The country which you're targeting at.
String regionCode = "{REGION_CODE}";
requestInventoryVerification(config, regionCode);
}
}
// [END merchantapi_request_inventory_verification]
Просмотрите статус настройки многоканального взаимодействия.
Чтобы проверить статус проверки отзывов о процессе адаптации в LIA, проверьте ReviewState для соответствующих атрибутов omnichannelSetting , возвращаемых методами omnichannelSettings.get или omnichannelSettings.list .
Поле ReviewState применяется ко всем проверкам при приеме на работу, за исключением процесса инвентаризации, и может принимать следующие значения:
-
ACTIVE: Одобрено. -
FAILED: Заявка отклонена. -
RUNNING: Вопрос все еще находится на рассмотрении. -
ACTION_REQUIRED: Эта опция существует только вInStock.stateдля продавцов GHLSF. Она означает, что вам необходимо запросить проверку наличия товара, чтобы LIA могла выполнить заказ.
InventoryVerification.State имеет следующие значения:
-
SUCCEEDED: Заявка одобрена. -
INACTIVE: Вы готовы запросить проверку инвентаризации. -
RUNNING: Находится на рассмотрении. -
SUSPENDED: Вы слишком много раз (обычно 5 раз) не прошли проверку инвентаря и должны подождать, прежде чем сможете запросить ее снова. -
ACTION_REQUIRED: Перед запросом на проверку инвентаризации необходимо выполнить дополнительные действия.
Устранение неполадок, связанных с API OmnichannelSettings
В этом разделе описывается, как устранять распространенные неполадки.
Создайте многоканальную настройку.
- Обязательно укажите значения
LsfTypeиRegionCode. - Если вы выберете
GHLSF, укажите в запросе пустоеInStock"В наличии". - Если вы выбираете типы LSF, размещаемые продавцом, укажите как минимум один URI в
InStockилиPickup.
Обновите настройки многоканальной сети.
Для обновления данного ресурса требуются следующие дополнительные правила:
- Изменить код региона невозможно.
- Вносить обновления невозможно, пока функция LIA/FLL работает или была одобрена.
- При переходе с типов LSF, размещаемых продавцом, на
GHLSF, если ранее были настроеныInStockиPickup, необходимо включить их в маску обновления вместе с обновлениемLsfType.
Например, если вы ранее применяли MHLSF_BASIC и Pickup , и они были отклонены, вы можете переключиться на GHLSF , отправив запрос следующего вида:
PATCH https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/omnichannelSettings/{REGION_CODE}?update_mask=lsf_type,in_stock,pickup
{
"lsfType: "GHLSF",
"inStock": {},
}
Замените следующее:
-
{ACCOUNT_ID}: Уникальный идентификатор вашей учетной записи в Merchant Center. -
{REGION_CODE}: Код региона, определенный в CLDR.
Запросить проверку наличия товара на складе
Если, несмотря на обновление данных о товарах или складских запасах и подтверждение контакта, значение InventoryVerification.state отличается от INACTIVE :
- Для продавцов из Австрии, Германии и Швейцарии: убедитесь, что вы завершили проверку страницы «О нас».
- Возможна задержка примерно на 48 часов.
- В случае повторных сбоев проверки инвентаризации (более пяти) сервис устанавливает тридцатидневный период ожидания, прежде чем разрешить повторный запрос. Для более раннего запроса обратитесь в службу поддержки Google.
Узнать больше
Для получения более подробной информации см. раздел «Объявления о наличии товаров на местном рынке и бесплатные местные объявления» в Справочном центре .