API OmnichannelSettings — это точка входа для настройки программ рекламы местного инвентаря (LIA) и бесплатных локальных объявлений (FLL).
Используйте его для программирования
- Управление (создание и обновление) многоканальными настройками
- Извлечь (получить и перечислить) настройки омниканальности
- Запросить проверку инвентаря для соответствующих требованиям торговцев
Для получения дополнительной информации см. Обзор объявлений о местном инвентаре и бесплатных местных листингах .
Предпосылки
Тебе следовало бы
счет Merchant Center
Бизнес-профиль. Если у вас его нет, вы можете его создать. См. Регистрация для бизнес-профиля .
Связь между вашим бизнес-профилем и аккаунтом Merchant Center. Чтобы создать связь, вы можете использовать пользовательский интерфейс Merchant Center или API Merchant (см. Связать бизнес-профиль Google ).
Создайте многоканальную настройку
Вы можете использовать метод omnichannelSettings.create для создания настройки omnichannel. Метод create принимает ресурс omnichannelSetting в качестве входных данных и возвращает созданную настройку omnichannel в случае успеха.
При создании необходимо заполнить поля regionCode и LsfType :
- OmnichannelSetting настраивается на основе страны.
RegionCodeопределяет целевую страну. После создания вы не можете его изменить.RegionCodeдолжен соответствовать правилу именования, определенному проектом Common Locale Data Repository (CLDR) . -
LsfTypeоснован на странице вашего продукта. Подробности см. вLsfType.
Более подробную информацию см. в разделе Изменение интерфейса страницы продукта для рекламы местного ассортимента .
Вам не обязательно заполнять все поля на этапе создания, но вы можете настроить их позже. Чтобы обновить существующий omnichannelSetting , см. Обновление omnichannel setting .
Вот пример запроса, если бы вы выбрали 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 Merchant-Hosted и указываете поле URI в InStock, вы показываете свое намерение обслуживать продукты с доступностью на складе. Мы начнем проверку на основе предоставленного URI.
Если вы выбираете тип GHLSF , вам необходимо предоставить пустое поле InStock в запросе. В отличие от типов LSF, размещенных Merchant, для завершения онбординга вам необходимо завершить процесс Inventory Verification .
В этом примере кода создается 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 , вы показываете свое намерение обслуживать продукты с SLA для самовывоза. Мы начнем проверку на основе предоставленного URI.
Вот пример запроса, который создает omnichannel настройку с помощью Pickup :
POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/omnichannelSettings
{
"regionCode": "{REGION_CODE}",
"lsfType: "MHLSF_BASIC",
"pickup": {
"uri: "{URI}"
}
}
На дисплее для заказа
С функцией on display to order вы можете показывать товары, которые выставлены в вашем физическом магазине, но не доступны для немедленной покупки. Например, крупная мебель:
- Клиенты, которые ищут похожие товары в 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 только для чтения показывает ваш статус партнерства Local Feeds. Чтобы привязаться к партнерству, используйте 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]
Обновите многоканальные настройки
Для обновления конфигурации существующей настройки omnichannel используйте метод 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, если вы хотите сделать запрос раньше.
Узнать больше
Более подробную информацию можно найти в разделе «Реклама местного инвентаря и бесплатные локальные объявления» Справочного центра .