Administra la configuración de Omnichannel

La API de Omnichannel Settings es el punto de entrada para configurar tus programas de anuncios del inventario local (LIA) y fichas locales gratuitas (FLL).

Úsala para hacer lo siguiente de forma programática:

  • Administrar (crear y actualizar) la configuración de varios canales
  • Recuperar (obtener y enumerar) la configuración de varios canales
  • Solicitar la verificación del inventario para los comercios aptos

Para obtener más información, consulta Descripción general de los anuncios del inventario local y las fichas locales gratuitas.

Requisitos previos

Debes tener lo siguiente:

Crea una configuración de varios canales

Puedes usar el método omnichannelSettings.create para crear una configuración de varios canales. El método create toma un recurso omnichannelSetting como entrada y muestra la configuración de varios canales creada, si la operación se realiza correctamente.

Cuando crees una configuración, debes completar regionCode y LsfType:

  • La configuración de varios canales se realiza por país. RegionCode define el país objetivo. Una vez que se crea, no se puede cambiar. RegionCode debe seguir la regla de nomenclatura definida por el proyecto Common Locale Data Repository (CLDR).
  • LsfType se basa en tu página de productos. Para obtener detalles, consulta LsfType.

Para obtener más detalles, consulta Cambia la experiencia en la página de producto para tus anuncios del inventario local.

No es necesario que completes todos los campos en la etapa de creación, pero puedes configurarlos más adelante. Para actualizar un omnichannelSetting existente, consulta Actualiza una configuración de varios canales.

A continuación, se muestra una solicitud de ejemplo si eliges MHLSF_BASIC y registras inStock:

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

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

Reemplaza lo siguiente:

  • {ACCOUNT_ID}: El identificador único de tu cuenta de Merchant Center
  • {REGION_CODE}: Un código de región según lo define CLDR
  • {URI}: Un URI válido que se usa para la revisión determinada. Un URI no apto puede impedir la aprobación.

Después de que la solicitud se ejecute correctamente, deberías ver la siguiente respuesta:

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

El registro de diferentes funciones de LIA/FLL con campos omnichannelSetting activa revisiones manuales que suelen demorar entre un par de horas y un par de días. Te recomendamos que vuelvas a verificar tus entradas para evitar tiempos de espera innecesarios debido a datos no aptos.

Para ver la configuración de varios canales que creaste recientemente o verificar el estado de las revisiones, usa accounts.omnichannelSettings.get o accounts.omnichannelSettings.list y especifica el país.

Tipo de vidriera local (LSF)

Según la página de productos que planeas usar, elige un LsfType:

Tipo de página de productos LsfType Valor enumerado
Páginas de productos con información de disponibilidad en tienda Vidriera local alojada por el comerciante (básica) MHLSF_BASIC
Páginas de productos específicas de la tienda con disponibilidad y precio Vidriera local alojada por el comerciante (completa) MHLSF_FULL
Páginas de productos sin disponibilidad en la tienda Vidriera local alojada en Google (GHLSF) GHLSF

Si eliges tipos de vidriera local alojada por el comerciante, también debes completar el campo URI para al menos uno de los siguientes: inStock o pickup.

InStock

Puedes usar InStock para proporcionar más información sobre tu página de productos.

Si eliges tipos de LSF alojada por el comerciante y especificas el campo URI en InStock, estás mostrando tu intención de publicar productos con disponibilidad en la tienda. Comenzaremos una revisión en función del URI proporcionado.

Si eliges el tipo GHLSF, debes proporcionar un campo InStock vacío en la solicitud. A diferencia de los tipos de LSF alojada por el comerciante, para completar la incorporación, debes completar el proceso de verificación del inventario.

En este ejemplo de código, se crea un omnichannelSetting con 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)

Retiro

Además de la disponibilidad en la tienda, también puedes mejorar tus productos en la tienda con la función de retiro, que solo es apta para los tipos de LSF alojada por el comerciante.

Cuando un producto está marcado para retiro, significa que un cliente puede comprarlo en línea y retirarlo en la tienda. Si configuras el campo Pickup, estás mostrando tu intención de publicar productos con un ANS de retiro. Comenzaremos una revisión en función del URI proporcionado.

A continuación, se muestra una solicitud de ejemplo que crea una configuración omnichannel con Pickup:

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

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

En exhibición para pedido

Con la en exhibición para pedido función, puedes exhibir productos que se muestran en tu tienda física, pero que no están disponibles para comprarse de inmediato. Por ejemplo, muebles grandes:

  • Los clientes que busquen productos similares en Google verán estos anuncios con la anotación “en la tienda” en los resultados de la búsqueda.
  • Los clientes que exploren la tienda en una página de resultados de la Búsqueda de Google verán estos productos marcados como “disponibles para pedidos”.

Pueden elegir tu anuncio del inventario local o ficha local gratuita para ver el artículo. Si desean comprar el artículo, pueden visitar tu tienda física, verlo y hacer un pedido con envío a domicilio o retiro en tienda.

Acerca de (Alemania, Austria y Suiza)

Si publicas anuncios en Alemania y Austria y eliges GHLSF, debes enviar una página Acerca de.

Si publicas anuncios en Suiza, debes enviar una página “Acerca de” independientemente de LsfType.

Hasta que se verifique la URL de la página Acerca de, los comercios de GHLSF no pueden solicitar la verificación manual del inventario a Google.

Para todos los comercios de estos tres países, el servicio no habilita las funciones de FLL/LIA hasta que se apruebe tu página Acerca de.

Verificación del inventario

La verificación del inventario solo es obligatoria para los comercios de GHLSF. No es compatible con los tipos de MHLSF.

Antes o después de agregar datos de productos y datos de inventario (ya sea con accounts.products.localInventories.insert o la interfaz de usuario de Merchant Center), debes verificar tu contacto. Proporciona un contacto de verificación del inventario (nombre y dirección de correo electrónico) con el método create o update. El contacto recibirá un correo electrónico enviado por Google y la posibilidad de verificar su estado haciendo clic en un botón del mensaje.

Una vez que hayas completado este proceso, podrás solicitar la verificación del inventario. Para obtener más información, consulta Acerca de la verificación del inventario.

Puedes cambiar tu contacto durante el proceso de verificación o después de la verificación con omnichannelSetting.update.

Una vez que se complete este proceso, Google validará la exactitud de la información proporcionada.

Obtén una configuración de varios canales

Para recuperar la configuración de omnichannelSetting en un país determinado o verificar el estado actual de tus revisiones, usa el método omnichannelSettings.get.

Aquí encontrarás un ejemplo de solicitud:

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

Reemplaza lo siguiente:

  • {ACCOUNT_ID}: El identificador único de tu cuenta de Merchant Center
  • {OMNICHANNEL_SETTING}: El código de región de tu país objetivo

El estado ACTIVE indica que se aprobó la revisión.

Si el estado es FAILED, soluciona los problemas y activa una nueva revisión llamando a omnichannelSetting.update.

El campo LFP de solo lectura muestra el estado de tu asociación de feeds locales. Para vincularte a la asociación, usa lfpProviders.linkLfpProvider.

Para obtener más información sobre cómo verificar los estados y sus significados, consulta Consulta el estado de una configuración de varios canales.

Enumera la configuración de varios canales

Para recuperar toda la información de omnichannelSetting de tu cuenta, usa el omnichannelSettings.list método.

A continuación, se muestra un ejemplo de código:

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)

Actualiza una configuración de varios canales

Para actualizar la configuración de una configuración de varios canales existente, usa el método omnichannelSettings.update.

Para actualizar, debes agregar la función que deseas a la máscara de actualización y completar los campos correspondientes en el campo omnichannelSetting de la solicitud de actualización. Puedes actualizar cualquiera de las siguientes opciones:

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

Si un atributo no se incluye en la máscara de actualización, no se actualizará.

Si un atributo se incluye en la máscara de actualización, pero no se configura en la solicitud, se borrará.

En la siguiente muestra de código, se muestra cómo actualizar el campo de verificación del inventario.

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)

Solicita la verificación del inventario

omnichannelSettings.requestInventoryVerification solo es relevante para los comercios de GHLSF.

Antes de llamar a este RPC, debes haber realizado lo siguiente:

  • Subir los datos de tus productos y de tu inventario
  • Verificar un contacto de verificación del inventario
  • Para los comercios de Alemania, Austria o Suiza, completar una About revisión de la página

Para determinar tu elegibilidad, llama a omnichannelSettings.get y verifica omnichannelSetting.inventoryVerification.state. Si muestra INACTIVE, puedes llamar a 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);
  }
}

Consulta el estado de una configuración de varios canales

Para verificar el estado de revisión de las revisiones de incorporación de LIA, consulta ReviewState para los atributos correspondientes de omnichannelSetting que muestran los omnichannelSettings.get o omnichannelSettings.list métodos.

El campo ReviewState se aplica a todas las revisiones de incorporación, excepto al proceso de verificación del inventario, y puede tener los siguientes valores:

  • ACTIVE: Se aprobó.
  • FAILED: Se rechazó.
  • RUNNING: Aún está en proceso de revisión.
  • ACTION_REQUIRED: Solo existe en InStock.state para los comercios de GHLSF. Significa que debes solicitar la verificación del inventario para que se publiquen los LIA.

InventoryVerification.State tiene los siguientes valores:

  • SUCCEEDED: Se aprobó.
  • INACTIVE: Puedes solicitar la verificación del inventario.
  • RUNNING: Está en proceso de revisión.
  • SUSPENDED: No se pudo realizar demasiadas veces la verificación del inventario (por lo general, 5 veces) y debes esperar antes de poder volver a solicitarla.
  • ACTION_REQUIRED: Debes realizar acciones adicionales antes de solicitar la verificación del inventario.

Soluciona problemas relacionados con Omnichannel Settings API

En esta sección, se describe cómo solucionar problemas conocidos.

Crea una configuración de varios canales

  • Asegúrate de configurar LsfType y RegionCode.
  • Si eliges GHLSF, proporciona un InStock vacío en la solicitud.
  • Si eliges tipos de LSF alojada por el comerciante, proporciona al menos un URI en InStock o Pickup.

Actualiza una configuración de varios canales

El método de actualización para este recurso requiere las siguientes reglas adicionales:

  • No puedes modificar el código de región.
  • No puedes realizar actualizaciones mientras la función de LIA/FLL esté en ejecución o se haya aprobado.
  • Cuando cambies de tipos de LSF alojada por el comerciante a GHLSF, si InStock y Pickup se configuraron anteriormente, debes incluirlos en la máscara de actualización junto con la actualización de LsfType.

Por ejemplo, si aplicaste MHLSF_BASIC y Pickup antes y se rechazaron, puedes cambiar a GHLSF enviando una solicitud como esta:

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

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

Reemplaza lo siguiente:

  • {ACCOUNT_ID}: El identificador único de tu cuenta de Merchant Center
  • {REGION_CODE}: Un código de región según lo define CLDR

Solicita la verificación del inventario

Si, a pesar de actualizar los feeds de productos o de inventario y confirmar el contacto, InventoryVerification.state es diferente de INACTIVE, haz lo siguiente:

  • Para los comercios de Alemania, Austria y Suiza, asegúrate de haber completado una revisión de la página Acerca de.
  • Habrá una demora de aproximadamente 48 horas.
  • En caso de fallas repetidas en la verificación del inventario (más de cinco), el servicio aplica un período de inactividad de treinta días antes de permitir otra solicitud. Comunícate con el equipo de asistencia de Google si quieres solicitarla antes.

Más información

Para obtener más detalles, consulta el Centro de ayuda de los anuncios del inventario local y las fichas locales gratuitas.

Anterior
Manage shipping settings
Siguiente
Manage business identity