Zarządzanie ustawieniami Omnichannel

Interfejs Omnichannel Settings API to punkt wejścia do konfigurowania programów Reklamy lokalnego asortymentu produktów (LIA) i Bezpłatne lokalne informacje (FLL).

Możesz go używać do programowego

  • Zarządzanie ustawieniami Omnichannel (tworzenie i aktualizowanie)
  • Pobieranie (pobieranie i wyświetlanie listy) ustawień Omnichannel
  • Przesyłanie prośby o weryfikację asortymentu w przypadku kwalifikujących się sprzedawców

Więcej informacji znajdziesz w artykule Reklamy lokalnego asortymentu produktów i bezpłatne lokalne informacje – omówienie.

Wymagania wstępne

Powinieneś(-aś) mieć

Tworzenie ustawienia wielokanałowego

Do utworzenia ustawienia wielokanałowego możesz użyć metody omnichannelSettings.create. Metoda create przyjmuje jako dane wejściowe zasób omnichannelSetting i w przypadku powodzenia zwraca utworzone ustawienie wielokanałowe.

Podczas tworzenia musisz wypełnić zarówno pole regionCode, jak i LsfType:

  • Ustawienie OmnichannelSetting jest określane dla każdego kraju z osobna. Element RegionCode określa kraj docelowy. Po utworzeniu nie można go zmienić. RegionCode powinna być zgodna z regułą nazewnictwa określoną w projekcie Common Locale Data Repository (CLDR).
  • LsfType jest oparta na stronie produktu. Więcej informacji znajdziesz w LsfType.

Więcej informacji znajdziesz w artykule Zmiana jakości strony produktu dla reklam lokalnego asortymentu produktów.

Nie musisz wypełniać wszystkich pól na etapie tworzenia, ale możesz skonfigurować je później. Aby zaktualizować istniejące ustawienie omnichannelSetting, zapoznaj się z artykułem Aktualizowanie ustawienia wielokanałowego.

Oto przykładowa prośba, jeśli wybierzesz MHLSF_BASIC i zarejestrujesz się inStock:

POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/omnichannelSettings

{
  "regionCode": "{REGION_CODE}",
  "lsfType: "MHLSF_BASIC",
  "inStock": {
      "uri": {URI}"
  }
}

Zastąp następujące elementy:

  • {ACCOUNT_ID}: unikalny identyfikator konta Merchant Center.
  • {REGION_CODE}: kod regionu zdefiniowany przez CLDR.
  • {URI}: prawidłowy identyfikator URI używany w przypadku danej opinii. Nieprawidłowy identyfikator URI może uniemożliwić zatwierdzenie.

Po uruchomieniu żądania powinna pojawić się taka odpowiedź:

{
  "name": "accounts/{ACCOUNT_ID}/omnichannelSettings/{omnichannel_setting}",
  "regionCode": "{REGION_CODE}",
  "lsfType: "MHLSF_BASIC",
  "inStock": {
      "uri": "{URI}",
      "state": "RUNNING"
  }
}

Włączenie różnych funkcji LIA/FLL za pomocą pól omnichannelSetting powoduje ręczną weryfikację, która zwykle trwa od kilku godzin do kilku dni. Zalecamy dokładne sprawdzenie wprowadzonych danych, aby uniknąć niepotrzebnego czasu oczekiwania z powodu niekwalifikujących się danych.

Aby wyświetlić nowo utworzone ustawienie wielokanałowe lub sprawdzić stan opinii, użyj accounts.omnichannelSettings.get lub accounts.omnichannelSettings.list, podając kraj.

Typ lokalnej witryny sklepowej

W zależności od strony produktu, której chcesz używać, wybierz LsfType:

Typ strony produktu LsfType Wartość typu wyliczeniowego
Strony produktów z danymi o dostępności w sklepie Lokalna witryna sklepowa sprzedawcy w ramach podstawowej implementacji MHLSF_BASIC
Strony produktów w konkretnym sklepie z informacjami o dostępności i cenie Lokalna witryna sklepowa sprzedawcy (w ramach pełnej implementacji) MHLSF_FULL
Strony produktów bez informacji o dostępności w sklepie Lokalna witryna sklepowa na serwerze Google GHLSF

Jeśli wybierzesz typy lokalnej witryny sklepowej sprzedawcy, musisz też wypełnić pole URI dla co najmniej jednego z tych typów: inStock lub pickup.

InStock (na stanie)

Za pomocą InStock możesz podać więcej informacji o stronie produktu.

Jeśli wybierzesz typy LSF hostowane przez sprzedawcę i określisz pole URI w atrybucie InStock, pokażesz, że chcesz wyświetlać produkty z dostępnością w magazynie. Rozpoczniemy weryfikację na podstawie podanego URI.

Jeśli wybierzesz typ GHLSF, musisz podać w żądaniu puste pole InStock. W przeciwieństwie do typów lokalnych witryn sklepowych sprzedawcy, aby dokończyć proces dołączania do programu, musisz przejść proces weryfikacji asortymentu.

Ten przykładowy kod tworzy element omnichannelSetting z elementem GHLSF:

Java

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 credentials retrieved above.
    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 occured: ");
      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);
  }
}

PHP

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1\Client\OmnichannelSettingsServiceClient;
use Google\Shopping\Merchant\Accounts\V1\CreateOmnichannelSettingRequest;
use Google\Shopping\Merchant\Accounts\V1\InStock;
use Google\Shopping\Merchant\Accounts\V1\OmnichannelSetting;
use Google\Shopping\Merchant\Accounts\V1\OmnichannelSetting\LsfType;

/**
 * This class demonstrates how to create an omnichannel setting for a given
 * Merchant Center account in a given country.
 */
class CreateOmnichannelSetting
{
    /**
     * Helper to create the parent string.
     *
     * @param string $accountId The merchant account ID.
     * @return string The parent string in the format `accounts/{account}`.
     */
    private static function getParent(string $accountId): string
    {
        return sprintf('accounts/%s', $accountId);
    }

    /**
     * Creates an omnichannel setting for a given Merchant Center account.
     *
     * @param array $config The configuration file for authentication.
     * @param string $regionCode The country for the omnichannel setting.
     */
    public static function createOmnichannelSettingSample(
        array $config,
        string $regionCode
    ): void {
        // Obtains OAuth credentials from the configuration file.
        $credentials = Authentication::useServiceAccountOrTokenFile();

        // Creates a client.
        $omnichannelSettingsServiceClient = new OmnichannelSettingsServiceClient([
            'credentials' => $credentials
        ]);

        // Constructs the parent resource name.
        $parent = self::getParent($config['accountId']);

        // Creates the omnichannel setting with GHLSF type in the given country.
        $omnichannelSetting = new OmnichannelSetting([
            'region_code' => $regionCode,
            'lsf_type' => LsfType::GHLSF,
            'in_stock' => new InStock()
        ]);

        // Creates the request.
        $request = new CreateOmnichannelSettingRequest([
            'parent' => $parent,
            'omnichannel_setting' => $omnichannelSetting
        ]);

        // Calls the API and prints the response.
        try {
            printf("Sending create omnichannel setting request:%s", PHP_EOL);
            $response = $omnichannelSettingsServiceClient->createOmnichannelSetting($request);
            printf("Inserted Omnichannel Setting below:%s", PHP_EOL);
            print $response->serializeToJsonString(true) . PHP_EOL;
        } catch (ApiException $e) {
            printf("An error has occured: %s", $e->getMessage());
        }
    }

    /**
     * Executes the sample.
     */
    public function callSample(): void
    {
        $config = Config::generateConfig();
        // The country which you're targeting.
        $regionCode = '{REGION_CODE}';
        self::createOmnichannelSettingSample($config, $regionCode);
    }
}

// Runs the script.
$sample = new CreateOmnichannelSetting();
$sample->callSample();

Python

from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping.merchant_accounts_v1 import CreateOmnichannelSettingRequest
from google.shopping.merchant_accounts_v1 import InStock
from google.shopping.merchant_accounts_v1 import OmnichannelSetting
from google.shopping.merchant_accounts_v1 import OmnichannelSettingsServiceClient


def create_omnichannel_setting(account_id: str, region_code: str) -> None:
  """Creates an omnichannel setting for a given Merchant Center account.

  Args:
      account_id: The ID of the Merchant Center account.
      region_code: The country for which you're creating the setting.
  """
  # Gets OAuth Credentials.
  credentials = generate_user_credentials.main()

  # Creates a client.
  client = OmnichannelSettingsServiceClient(credentials=credentials)

  # The parent account under which to create the setting.
  parent = f"accounts/{account_id}"

  # Creates an omnichannel setting with GHLSF type in the given country.
  omnichannel_setting = OmnichannelSetting()
  omnichannel_setting.region_code = region_code
  omnichannel_setting.lsf_type = OmnichannelSetting.LsfType.GHLSF
  omnichannel_setting.in_stock = InStock()

  # Creates the request.
  request = CreateOmnichannelSettingRequest(
      parent=parent, omnichannel_setting=omnichannel_setting
  )

  # Makes the request and catches and prints any error messages.
  try:
    print("Sending create omnichannel setting request:")
    response = client.create_omnichannel_setting(request=request)
    print("Inserted Omnichannel Setting below:")
    print(response)
  except RuntimeError as e:
    print("An error has occured: ")
    print(e)


if __name__ == "__main__":
  # The ID of the account to get the omnichannel settings for.
  _ACCOUNT = configuration.Configuration().read_merchant_info()

  # The country which you're targeting.
  _REGION_CODE = "{REGION_CODE}"

  create_omnichannel_setting(_ACCOUNT, _REGION_CODE)

Odbiór

Oprócz danych o dostępności w sklepie możesz też dodać do produktów dostępnych w sklepie funkcję odbioru, która jest dostępna tylko w przypadku typów LSF hostowanych przez sprzedawcę.

Gdy produkt jest oznaczony jako dostępny do odbioru, oznacza to, że klient może kupić go online i odebrać w sklepie. Ustawiając pole Pickup, pokazujesz, że chcesz wyświetlać produkty z gwarantowaną dostępnością produktu do odbioru. Rozpoczniemy sprawdzanie na podstawie podanego URI.

Oto przykładowe żądanie, które tworzy ustawienie omnichannel z wartością Pickup:

POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/omnichannelSettings

{
  "regionCode": "{REGION_CODE}",
  "lsfType: "MHLSF_BASIC",
  "pickup": {
     "uri: "{URI}"
  }
}

W sklepie, dostępny na zamówienie

Dzięki funkcji dostępności na zamówienie możesz wyświetlać produkty, które są wystawione w Twoim sklepie stacjonarnym, ale nie są dostępne do natychmiastowego zakupu. Na przykład duże meble:

  • Klienci, którzy szukają podobnych produktów w Google, zobaczą te reklamy z adnotacją „w sklepie” w wynikach wyszukiwania.
  • Klienci, którzy przeglądają asortyment sklepu na stronie wyników wyszukiwania Google, zobaczą te produkty z oznaczeniem „Dostępne na zamówienie”.

Aby wyświetlić te produkty, klienci mogą kliknąć reklamę lokalnego asortymentu produktów lub bezpłatne lokalne informacje o produkcie. Aby kupić produkt, użytkownicy mogą odwiedzić sklep stacjonarny, obejrzeć go, a następnie zamówić produkt z dostawą do domu lub możliwością odbioru w sklepie.

Informacje (Niemcy, Austria i Szwajcaria)

Jeśli wyświetlasz reklamy w Austrii i Niemczech i wybierzesz GHLSF, musisz przesłać stronę Informacje.

Jeśli wyświetlasz reklamy w Szwajcarii, musisz przesłać stronę „O firmie” niezależnie od tego, czyLsfType.

Dopóki adres URL strony Informacje nie zostanie zweryfikowany, GHLSF sprzedawcy nie mogą poprosić Google o ręczną weryfikację asortymentu.

W przypadku wszystkich sprzedawców w tych 3 krajach usługa nie włącza funkcji FLL/LIA, dopóki strona „O nas” nie zostanie zatwierdzona.

Weryfikacja asortymentu

Weryfikacja asortymentu jest wymagana tylko w przypadku sprzedawców GHLSF. Nie jest obsługiwany w przypadku typów MHLSF.

Przed dodaniem danych o produktach i danych o asortymencie lub po ich dodaniu (za pomocą accounts.products.localInventories.insert lub interfejsu użytkownika Merchant Center) musisz zweryfikować osobę kontaktową. Podaj dane kontaktowe osoby odpowiedzialnej za weryfikację asortymentu (imię i nazwisko oraz adres e-mail) za pomocą metody create lub update. Osoba kontaktowa otrzyma e-maila wysłanego przez Google i będzie mogła potwierdzić swój status, klikając przycisk w wiadomości.

Po wykonaniu tych czynności możesz poprosić o weryfikację asortymentu. Więcej informacji znajdziesz w artykule Weryfikacja asortymentu.

Możesz zmienić osobę kontaktową podczas procesu weryfikacji lub po jego zakończeniu, korzystając z ikony omnichannelSetting.update.

Po zakończeniu tego procesu Google sprawdza dokładność podanych informacji.

Pobieranie ustawienia wielokanałowego

Aby pobrać konfigurację omnichannelSetting w danym kraju lub sprawdzić bieżący stan opinii, użyj metody omnichannelSettings.get.

Przykładowe żądanie:

GET https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/omnichannelSettings/{OMNICHANNEL_SETTING}

Zastąp następujące elementy:

  • {ACCOUNT_ID}: unikalny identyfikator konta Merchant Center.
  • {OMNICHANNEL_SETTING}: kod regionu kraju docelowego.

Stan ACTIVE oznacza, że opinia została zatwierdzona.

Jeśli stan to FAILED, rozwiąż problemy i wywołaj nowe sprawdzenie, wywołując funkcję omnichannelSetting.update.

Pole LFP tylko do odczytu pokazuje stan partnerstwa w zakresie lokalnych plików danych. Aby połączyć się z partnerstwem, użyj lfpProviders.linkLfpProvider.

Więcej informacji o sprawdzaniu stanów i ich znaczeniu znajdziesz w artykule Wyświetlanie stanu ustawienia omnichannel.

Wyświetlanie listy ustawień wielokanałowych

Aby pobrać wszystkie informacje omnichannelSetting dotyczące konta, użyj metody omnichannelSettings.list.

Oto przykładowy kod:

Java

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 credentials retrieved above.
    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 occured: ");
      System.out.println(e);
    }
  }

  public static void main(String[] args) throws Exception {
    Config config = Config.load();

    omnichannelSettings(config);
  }
}

PHP

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1\Client\OmnichannelSettingsServiceClient;
use Google\Shopping\Merchant\Accounts\V1\ListOmnichannelSettingsRequest;

/**
 * This class demonstrates how to get the list of omnichannel settings for a
 * given Merchant Center account.
 */
class ListOmnichannelSettings
{
    /**
     * Helper to create the parent string.
     *
     * @param string $accountId The merchant account ID.
     * @return string The parent string in the format `accounts/{account}`.
     */
    private static function getParent(string $accountId): string
    {
        return sprintf('accounts/%s', $accountId);
    }

    /**
     * Lists the omnichannel settings for a given Merchant Center account.
     *
     * @param array $config The configuration file for authentication.
     */
    public static function listOmnichannelSettingsSample(array $config): void
    {
        // Obtains OAuth credentials from the configuration file.
        $credentials = Authentication::useServiceAccountOrTokenFile();

        // Creates a client.
        $omnichannelSettingsServiceClient = new OmnichannelSettingsServiceClient([
            'credentials' => $credentials
        ]);

        // Constructs the parent resource name.
        $parent = self::getParent($config['accountId']);

        // Creates the request.
        $request = new ListOmnichannelSettingsRequest(['parent' => $parent]);

        // Calls the API and prints the response.
        try {
            printf("Sending list omnichannel setting request:%s", PHP_EOL);
            $response = $omnichannelSettingsServiceClient->listOmnichannelSettings($request);

            $count = 0;
            // Iterates over all the omnichannel settings and prints them.
            foreach ($response->iterateAllElements() as $omnichannelSetting) {
                print $omnichannelSetting->serializeToJsonString(true) . PHP_EOL;
                $count++;
            }
            printf("The following count of elements were returned: %d%s", $count, PHP_EOL);
        } catch (ApiException $e) {
            printf("An error has occured: %s", $e->getMessage());
        }
    }

    /**
     * Executes the sample.
     */
    public function callSample(): void
    {
        $config = Config::generateConfig();
        self::listOmnichannelSettingsSample($config);
    }
}

// Runs the script.
$sample = new ListOmnichannelSettings();
$sample->callSample();

Python

from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping.merchant_accounts_v1 import ListOmnichannelSettingsRequest
from google.shopping.merchant_accounts_v1 import OmnichannelSettingsServiceClient


def list_omnichannel_settings(account_id: str) -> None:
  """Lists the omnichannel settings for a given Merchant Center account.

  Args:
      account_id: The ID of the Merchant Center account.
  """
  # Gets OAuth Credentials.
  credentials = generate_user_credentials.main()

  # Creates a client.
  client = OmnichannelSettingsServiceClient(credentials=credentials)

  # The parent account for which to list the settings.
  parent = f"accounts/{account_id}"

  # Creates the request.
  request = ListOmnichannelSettingsRequest(parent=parent)

  # Makes the request and catches and prints any error messages.
  try:
    print("Sending list omnichannel setting request:")
    response = client.list_omnichannel_settings(request=request)

    count = 0
    # Iterates over all the entries in the response.
    for omnichannel_setting in response:
      print(omnichannel_setting)
      count += 1
    print(f"The following count of elements were returned: {count}")
  except RuntimeError as e:
    print("An error has occured: ")
    print(e)


if __name__ == "__main__":
  # The ID of the account to get the omnichannel settings for.
  _ACCOUNT = configuration.Configuration().read_merchant_info()

  list_omnichannel_settings(_ACCOUNT)

Aktualizowanie ustawienia omnichannel

Aby zaktualizować konfigurację istniejącego ustawienia omnichannel, użyj metody omnichannelSettings.update.

Aby zaktualizować funkcję, musisz dodać ją do maski aktualizacji i wypełnić odpowiednie pola w polu omnichannelSetting w żądaniu aktualizacji. Możesz zaktualizować dowolne z tych pól:

  • lsfType
  • inStock
  • pickup
  • odo
  • about
  • inventoryVerification

Jeśli atrybut nie jest uwzględniony w masce aktualizacji, nie zostanie zaktualizowany.

Jeśli atrybut jest uwzględniony w masce aktualizacji, ale nie jest ustawiony w żądaniu, zostanie wyczyszczony.

Poniższy przykładowy kod pokazuje, jak zaktualizować pole weryfikacji asortymentu.

Java

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 credentials retrieved above.
    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 occured: ");
      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);
  }
}

PHP

use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;
use Google\Shopping\Merchant\Accounts\V1\Client\OmnichannelSettingsServiceClient;
use Google\Shopping\Merchant\Accounts\V1\InventoryVerification;
use Google\Shopping\Merchant\Accounts\V1\OmnichannelSetting;
use Google\Shopping\Merchant\Accounts\V1\UpdateOmnichannelSettingRequest;

/**
 * This class demonstrates how to update an omnichannel setting for a given
 * Merchant Center account in a given country.
 */
class UpdateOmnichannelSetting
{
    /**
     * Helper to create the name string.
     *
     * @param string $accountId The merchant account ID.
     * @param string $regionCode The region code of the setting.
     * @return string The name string in the format
     *     `accounts/{account}/omnichannelSettings/{omnichannelSetting}`.
     */
    private static function getName(string $accountId, string $regionCode): string
    {
        return sprintf('accounts/%s/omnichannelSettings/%s', $accountId, $regionCode);
    }

    /**
     * Updates an omnichannel setting for a given Merchant Center account.
     *
     * @param array $config The configuration file for authentication.
     * @param string $regionCode The country of the omnichannel setting.
     * @param string $contact The name of the inventory verification contact.
     * @param string $email The email of the inventory verification contact.
     */
    public static function updateOmnichannelSettingSample(
        array $config,
        string $regionCode,
        string $contact,
        string $email
    ): void {
        // Obtains OAuth credentials from the configuration file.
        $credentials = Authentication::useServiceAccountOrTokenFile();

        // Creates a client.
        $omnichannelSettingsServiceClient = new OmnichannelSettingsServiceClient([
            'credentials' => $credentials
        ]);

        // Constructs the resource name.
        $name = self::getName($config['accountId'], $regionCode);

        // Creates the omnichannel setting with the updated fields.
        $omnichannelSetting = new OmnichannelSetting([
            'name' => $name,
            'inventory_verification' => new InventoryVerification([
                'contact' => $contact,
                'contact_email' => $email
            ])
        ]);

        // Creates the field mask to specify which fields to update.
        $fieldMask = new FieldMask([
            'paths' => ['inventory_verification']
        ]);

        // Creates the request.
        $request = new UpdateOmnichannelSettingRequest([
            'omnichannel_setting' => $omnichannelSetting,
            'update_mask' => $fieldMask
        ]);

        // Calls the API and prints the response.
        try {
            printf("Sending update omnichannel setting request:%s", PHP_EOL);
            $response = $omnichannelSettingsServiceClient->updateOmnichannelSetting($request);
            printf("Updated Omnichannel Setting below:%s", PHP_EOL);
            print $response->serializeToJsonString(true) . PHP_EOL;
        } catch (ApiException $e) {
            printf("An error has occured: %s", $e->getMessage());
        }
    }

    /**
     * Executes the sample.
     */
    public function callSample(): void
    {
        $config = Config::generateConfig();
        // The country which you're targeting.
        $regionCode = '{REGION_CODE}';
        // The name of the inventory verification contact you want to update.
        $contact = '{NAME}';
        // The address of the inventory verification email you want to update.
        $email = '{EMAIL}';
        self::updateOmnichannelSettingSample($config, $regionCode, $contact, $email);
    }
}

// Runs the script.
$sample = new UpdateOmnichannelSetting();
$sample->callSample();

Python

from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.protobuf import field_mask_pb2
from google.shopping.merchant_accounts_v1 import InventoryVerification
from google.shopping.merchant_accounts_v1 import OmnichannelSetting
from google.shopping.merchant_accounts_v1 import OmnichannelSettingsServiceClient
from google.shopping.merchant_accounts_v1 import (
    UpdateOmnichannelSettingRequest,
)


def update_omnichannel_setting(
    account_id: str, region_code: str, contact: str, email: str
) -> None:
  """Updates an omnichannel setting for a given Merchant Center account.

  Args:
      account_id: The ID of the Merchant Center account.
      region_code: The country for which you're updating the setting.
      contact: The name of the inventory verification contact.
      email: The email of the inventory verification contact.
  """
  # Gets OAuth Credentials.
  credentials = generate_user_credentials.main()

  # Creates a client.
  client = OmnichannelSettingsServiceClient(credentials=credentials)

  # The name of the omnichannel setting to update.
  name = f"accounts/{account_id}/omnichannelSettings/{region_code}"

  # Creates an omnichannel setting with the updated values.
  omnichannel_setting = OmnichannelSetting()
  omnichannel_setting.name = name
  omnichannel_setting.inventory_verification = InventoryVerification(
      contact=contact, contact_email=email
  )

  # Creates a field mask to specify which fields to update.
  field_mask = field_mask_pb2.FieldMask(paths=["inventory_verification"])

  # Creates the request.
  request = UpdateOmnichannelSettingRequest(
      omnichannel_setting=omnichannel_setting, update_mask=field_mask
  )

  # Makes the request and catches and prints any error messages.
  try:
    print("Sending update omnichannel setting request:")
    response = client.update_omnichannel_setting(request=request)
    print("Updated Omnichannel Setting below:")
    print(response)
  except RuntimeError as e:
    print("An error has occured: ")
    print(e)


if __name__ == "__main__":
  # The ID of the account to get the omnichannel settings for.
  _ACCOUNT = configuration.Configuration().read_merchant_info()

  # The country which you're targeting.
  _REGION_CODE = "{REGION_CODE}"
  # The name of the inventory verification contact you want to update.
  _CONTACT = "{NAME}"
  # The address of the inventory verification email you want to update.
  _EMAIL = "{EMAIL}"

  update_omnichannel_setting(_ACCOUNT, _REGION_CODE, _CONTACT, _EMAIL)

Przesyłanie prośby o weryfikację asortymentu

omnichannelSettings.requestInventoryVerification dotyczy tylko GHLSFsprzedawców.

Zanim wywołasz ten RPC, musisz wykonać te czynności:

  • Prześlij dane o produktach i asortymencie.
  • Zweryfikuj osobę kontaktową ds. weryfikacji asortymentu.
  • Sprzedawcy w Austrii, Niemczech i Szwajcarii muszą przejść weryfikację strony About.

Aby sprawdzić, czy się kwalifikujesz, zadzwoń pod numer omnichannelSettings.get i sprawdź omnichannelSetting.inventoryVerification.state. Jeśli pojawi się INACTIVE, możesz zadzwonić pod numer omnichannelSettings.requestInventoryVerification.

Java

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 credentials retrieved above.
    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 occured: ");
      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);
  }
}

Wyświetlanie stanu ustawienia wielokanałowego.

Aby sprawdzić stan weryfikacji wdrożenia reklam lokalnego asortymentu produktów, sprawdź ReviewStateodpowiednie atrybuty omnichannelSetting zwracane przez metody omnichannelSettings.get lub omnichannelSettings.list.

Pole ReviewState dotyczy wszystkich opinii o procesie wprowadzania z wyjątkiem procesu weryfikacji asortymentu i może mieć te wartości:

  • ACTIVE: jest zatwierdzony.
  • FAILED: zostanie odrzucona.
  • RUNNING: jest nadal w trakcie sprawdzania.
  • ACTION_REQUIRED: ten warunek dotyczy tylko InStock.statesprzedawców korzystających z GHLSF. Oznacza to, że musisz poprosić o weryfikację asortymentu, aby włączyć reklamy produktów dostępnych lokalnie.

InventoryVerification.State ma te wartości:

  • SUCCEEDED: jest zatwierdzony.
  • INACTIVE: możesz poprosić o weryfikację asortymentu.
  • RUNNING: jest w trakcie sprawdzania
  • SUSPENDED: zbyt wiele razy nie udało Ci się przejść weryfikacji asortymentu (zwykle 5). Musisz poczekać, zanim będziesz mieć możliwość ponownego przesłania prośby.
  • ACTION_REQUIRED: Zanim poprosisz o weryfikację asortymentu, musisz wykonać dodatkowe czynności.

Rozwiązywanie problemów związanych z Omnichannel Settings API

W tej sekcji znajdziesz informacje o tym, jak rozwiązywać typowe problemy.

Tworzenie ustawienia wielokanałowego

  • Pamiętaj, aby ustawić zarówno LsfType, jak i RegionCode.
  • Jeśli wybierzesz GHLSF, w żądaniu podaj pusty element InStock.
  • Jeśli wybierzesz typy LSF hostowane przez sprzedawcę, podaj co najmniej 1 URI w InStock lub Pickup.

Aktualizowanie ustawienia omnichannel

Metoda aktualizacji tego zasobu wymaga spełnienia tych dodatkowych reguł:

  • Nie możesz zmienić kodu regionu.
  • Nie możesz wprowadzać zmian, gdy funkcja LIA/FLL jest aktywna lub została zatwierdzona.
  • Jeśli zmieniasz typy LSF hostowane przez sprzedawcę na GHLSF, a wcześniej skonfigurowano InStock i Pickup, musisz uwzględnić je w masce aktualizacji wraz z aktualizacją LsfType.

Jeśli na przykład wcześniej zastosowano MHLSF_BASIC i Pickup, a zostały one odrzucone, możesz przejść na GHLSF, wysyłając takie żądanie:

PATCH https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/omnichannelSettings/{REGION_CODE}?update_mask=lsf_type,in_stock,pickup

{
  "lsfType": "GHLSF",
  "inStock": {},
}

Zastąp następujące elementy:

  • {ACCOUNT_ID}: unikalny identyfikator konta Merchant Center.
  • {REGION_CODE}: kod regionu zdefiniowany w CLDR.

Przesyłanie prośby o weryfikację asortymentu

Jeśli pomimo zaktualizowania plików danych o produktach lub asortymencie i potwierdzenia kontaktu wartość InventoryVerification.state jest inna niż INACTIVE:

  • W przypadku sprzedawców w Austrii, Niemczech i Szwajcarii: upewnij się, że strona Informacje została zweryfikowana.
  • Opóźnienie wyniesie około 48 godzin.
  • W przypadku wielokrotnych niepowodzeń weryfikacji asortymentu (więcej niż 5 razy) usługa wymusza 30-dniowy okres oczekiwania przed zezwoleniem na kolejną prośbę. Jeśli chcesz poprosić o wcześniejszy zwrot środków, skontaktuj się z zespołem pomocy Google.

Więcej informacji

Więcej informacji znajdziesz w Centrum pomocy dotyczącym reklam lokalnego asortymentu produktów i bezpłatnych lokalnych informacji.

Wstecz
Manage shipping settings
Dalej
Manage business identity