Se usó la API de Cloud Translation para traducir esta página.

Actualizaciones incrementales del inventario de la versión 2

En esta sección, se describe cómo puedes enviar actualizaciones urgentes de tus entidades de inventario a Google. La API de actualización incremental te permite enviar actualizaciones y borrar entidades en tu inventario de producción o zona de pruebas casi en tiempo real.

Esta función está orientada principalmente a actualizaciones que no puedes prever, como cierres de emergencia. Como regla general, cualquier cambio enviado a través de la API de actualización incremental debe ser un cambio que se publique en no más de una hora. Si tu cambio no necesita reflejarse de inmediato, puedes usar la transferencia por lotes. Las actualizaciones incrementales se procesan en no más de cinco minutos.

Requisitos previos

Para implementar actualizaciones incrementales, se requieren los siguientes elementos:

Se crea una cuenta de servicio con la función de editor en tu proyecto de acciones. Para obtener más detalles, consulta Crea y configura un proyecto.
Los feeds de datos de producción o de zona de pruebas están alojados y transferidos. Para obtener más detalles, consulta Transferencia por lotes.
(Opcional, pero recomendado) Instala la biblioteca cliente de Google en el lenguaje que elijas para facilitar el uso de OAuth 2.0 cuando llames a la API. Las muestras de código incluidas a continuación usan estas bibliotecas. De lo contrario, deberás manejar los intercambios de tokens de forma manual, como se describe en Usar OAuth 2.0 para acceder a las API de Google.

Extremos

En las siguientes solicitudes, reemplaza lo siguiente:

PROJECT_ID: Es el ID del proyecto de Google Cloud asociado al proyecto que creaste en Crea y configura un proyecto.
TYPE: Es el tipo de entidad (propiedad @type) del objeto en el feed de datos que deseas actualizar.
ENTITY_ID (solo extremo de eliminación): ID de la entidad que se borrará. Asegúrate de que la URL codifique tu ID de entidad.
DELETE_TIME (solo borrar extremos): campo opcional para indicar la hora en que se borró la entidad en tus sistemas (el valor predeterminado es cuando se recibe la solicitud). El valor de tiempo no debe ser futuro. Cuando envías una entidad a través de una llamada incremental, el control de versiones de la entidad también usa el campo delete_time en el caso de una llamada de eliminación. Formatea este valor como yyyy-mm-ddTHH:mm:ssZ

Actualizar extremo

Para modificar una entidad, realiza una solicitud HTTP POST al siguiente extremo y, luego, incluye una carga útil de actualizaciones y adiciones. Puedes realizar actualizaciones de hasta 1,000 entidades en una sola llamada a la API.

https://actions.googleapis.com/v2/apps/PROJECT_ID/entities:batchPush

Por ejemplo, si quieres actualizar entidades en un proyecto con un ID &delivery-provider-id&quot, el extremo sería el siguiente:

https://actions.googleapis.com/v2/apps/delivery-provider-id/entities:batchpush

Borrar extremo

Para borrar una entidad en tu inventario, realiza una solicitud HTTP DELETE al siguiente extremo.

https://actions.googleapis.com/v2/apps/PROJECT_ID/entities/TYPE/ENTITY_ID?entity.vertical=FOODORDERING&delete_time=DELETE_TIME

Por ejemplo, para eliminar una entidad "MenuSection&quot con ID "menuSection_122" de tu proyecto &delivery-provider-id&quot, harías una llamada HTTP API DELETE a:

https://actions.googleapis.com/v2/apps/delivery-provider-id/entities/MenuSection/menuSection_122?entity.vertical=FOODORDERING

Entorno de zona de pruebas

Para usar la API de actualización incremental en tu inventario de zona de pruebas, sigue las instrucciones de Endpoints anteriores, pero realiza solicitudes a /v2/sandbox/apps/ en lugar de a /v2/apps/.

https://actions.googleapis.com/v2/sandbox/apps/PROJECT_ID/entities:batchPush

https://actions.googleapis.com/v2/sandbox/apps/PROJECT_ID/entities/TYPE/ENTITY_ID?entity.vertical=FOODORDERING&delete_time=DELETE_TIME

Actualiza entidades

Cada solicitud POST debe incluir los parámetros de la solicitud junto con la carga útil JSON que contiene los datos estructurados de cualquier tipo de entidad que se enumera en el esquema de inventario.

Actualizar carga útil

El JSON debe aparecer de la misma manera que lo haría en el feed por lotes, con las siguientes diferencias:

El cuerpo de la carga útil no debe superar los 5 MB. Al igual que con los feeds de lotes, te sugerimos que quites los espacios en blanco para que se adapten más datos.
El sobre es el siguiente:

{
  "requests": [
    {
      "entity": {
        "data":"ENTITY_DATA",
        "name": "apps/project_id>/entities/type/entity_id"
      },
      "update_time":"UPDATE_TIMESTAMP"
    },
  ],
  "vertical": "FOODORDERING"
}

En la carga útil anterior, reemplaza lo siguiente:

ENTITY_DATA: Entidad en formato JSON serializado como una string. La entidad JSON-LD debe pasarse como una string en el campo data.
UPDATE_TIMESTAMP (opcional): Marca de tiempo de cuando se actualizó la entidad en tus sistemas. El valor de tiempo no debe ser futuro. La marca de tiempo predeterminada corresponde al momento en que Google recibe la solicitud. Cuando envías una entidad a través de una solicitud incremental, el control de versiones de la entidad también usa el campo update_time en el caso de una solicitud para agregar o actualizar.

Ejemplos

Ejemplo 1: Actualiza un restaurante

Supongamos que necesitas actualizar el número de teléfono de un restaurante con urgencia. Tu actualización contiene el JSON para todo el restaurante.

Considere un feed por lotes similar al siguiente:

{
  "@type": "Restaurant",
  "@id": "restaurant12345",
  "name": "Some Restaurant",
  "url": "https://www.provider.com/somerestaurant",
  "telephone": "+16501234567",
  "streetAddress": "345 Spear St",
  "addressLocality": "San Francisco",
  "addressRegion": "CA",
  "postalCode": "94105",
  "addressCountry": "US",
  "latitude": 37.472842,
  "longitude": -122.217144
}

La actualización incremental por HTTP POST sería la siguiente:

POST v2/sandbox/apps/provider-project/entities:batchPush
Host: actions.googleapis.com
Content-Type: application/ld+json
{
  "requests": [
    {
      "entity": {
        "name": "apps/provider-project/entities/restaurant/restaurant12345",
        "data": {
          "@type": "Restaurant",
          "@id": "restaurant12345",
          "name": "Some Restaurant",
          "url": "https://www.provider.com/somerestaurant",
          "telephone": "+16501235555",
          "streetAddress": "345 Spear St",
          "addressLocality": "San Francisco",
          "addressRegion": "CA",
          "postalCode": "94105",
          "addressCountry": "US",
          "latitude": 37.472842,
          "longitude": -122.217144
        }
      }
    }
  "vertical": "FOODORDERING"
}

Ejemplo 2: Actualiza varios restaurantes

Para actualizar dos entidades de restaurante en una sola llamada a la API, la solicitud HTTP POST sería la siguiente:

POST v2/sandbox/apps/provider-project/entities:batchPush
Host: actions.googleapis.com
Content-Type: application/ld+json
{
  "requests": [
    {
      "entity": {
        "name": "apps/provider-project/entities/restaurant/restaurant12345",
        "data": {
          "@type": "Restaurant",
          "@id": "restaurant12345",
          "name": "Some Restaurant",
          "url": "https://www.provider.com/somerestaurant",
          "telephone": "+16501235555",
          "streetAddress": "345 Spear St",
          "addressLocality": "San Francisco",
          "addressRegion": "CA",
          "postalCode": "94105",
          "addressCountry": "US",
          "latitude": 37.472842,
          "longitude": -122.217144
        }
      }
    },
    {
      "entity": {
        "name": "apps/provider-project/entities/restaurant/restaurant123",
        "data": {
          "@type": "Restaurant",
          "@id": "restaurant123",
          "name": "Some Other Restaurant",
          "url": "https://www.provider.com/somerestaurant",
          "telephone": "+16501231235",
          "streetAddress": "385 Spear St",
          "addressLocality": "San Mateo",
          "addressRegion": "CA",
          "postalCode": "94115",
          "addressCountry": "US"
        }
      }
    }
  ]
  "vertical": "FOODORDERING"
}

Ejemplo 3: Actualiza el precio de un elemento de menú

Supongamos que necesitas cambiar el precio de un elemento de menú. Al igual que en el ejemplo 1, tu actualización debe contener el JSON para toda la entidad de nivel superior (el menú) y el feed usa el esquema de inventario v1.

Considere un feed por lotes similar al siguiente:

{
  "@type": "MenuItemOffer",
  "@id": "menuitemoffer6680262",
  "sku": "offer-cola",
  "menuItemId": "menuitem896532",
  "price": 3.00,
  "priceCurrency": "USD"
}

La actualización incremental a través de POST sería la siguiente:

POST v2/sandbox/apps/provider-project/entities:batchPush
Host: actions.googleapis.com
Content-Type: application/ld+json
{
  "requests": [
    {
      "entity": {
        "name": "apps/provider-project/entities/menuitemoffer/menuitemoffer6680262",
        "data": {
          "@type": "MenuItemOffer",
          "@id": "menuitemoffer6680262",
          "sku": "offer-cola",
          "menuItemId": "menuitem896532",
          "price": 1.00,
          "priceCurrency": "USD"
        },
        "vertical": "FOODORDERING"
      }
    }
  ]
  "vertical": "FOODORDERING"
}

Agrega una entidad

Para agregar entidades, evite usar actualizaciones de inventario. En su lugar, usa el proceso de los feeds por lotes como se describe en el esquema de inventario de la versión 2.

Quita una entidad

Para quitar entidades de nivel superior, usa un extremo ligeramente modificado y usa HTTP DELETE en lugar de HTTP POST en la solicitud.

Borra una entidad de nivel superior

Considera una situación en la que deseas borrar un restaurante en un feed. También debes borrar sus servicios y menús.

Un extremo de muestra para una entidad de menú con ID "provider/restaurant/menu/nr":

DELETE v2/apps/delivery-provider-id/entities/menu/provider%2Frestaurant%2Fmenu%2Fnr?entity.vertical=FOODORDERING
Host: actions.googleapis.com

Un extremo de muestra para una entidad de restaurante con el ID https://www.provider.com/restaurant/nr":

DELETE v2/apps/delivery-provider-id/entities/restaurant/provider%2Frestaurant%2Fnr?entity.vertical=FOODORDERING
Host: actions.googleapis.com

Un extremo de muestra para una entidad de servicio con ID https://www.provider.com/restaurant/service/nr":

DELETE v2/apps/delivery-provider-id/entities/service/provider%2Frestaurant%2Fservice%2Fnr?entity.vertical=FOODORDERING
Host: actions.googleapis.com
}

Quitar subentidades

No uses HTTP DELETE para quitar una subentidad dentro de una entidad de nivel superior, como un elemento de menú. En cambio, trata la eliminación de subentidades como una actualización a una entidad de nivel superior en la que la subentidad se quita de la lista relevante o de reverseReference.

Códigos de respuesta de la API

Una llamada correcta no significa que el feed sea válido o correcto, sino que se realizó la llamada a la API. Las llamadas exitosas reciben un código de respuesta HTTP 200, junto con un cuerpo de respuesta vacío:

{}

Para las fallas, el código de respuesta HTTP no será 200 y el cuerpo de la respuesta indicará qué salió mal.

Por ejemplo, si el usuario configuró el valor de la vertical del sobre en FAKE_VERTICAL, recibirás el siguiente mensaje:

{
  "error": {
    "code": 400,
    "message": "Invalid value at 'entity.vertical' (TYPE_ENUM), \"FAKE_VERTICAL\"",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.BadRequest",
        "fieldViolations": [
          {
            "field": "entity.vertical",
            "description": "Invalid value at 'entity.vertical' (TYPE_ENUM), \"FAKE_VERTICAL\""
          }
        ]
      }
    ]
  }
}

Ejemplo de código

A continuación, se muestran algunos ejemplos de cómo usar la API de Actualización incremental en varios lenguajes. Estas muestras usan las bibliotecas de Google Auth y suponen un feed que usa el esquema de inventario v1. Si quieres obtener soluciones alternativas, consulta Usa OAuth 2.0 para aplicaciones de servidor a servidor.

Actualiza entidades

Node.js

Este código usa la biblioteca de autenticación de Google para Node.js.

const {auth} = require('google-auth-library')
const request = require('request');
// The service account client secret file downloaded from the Google Cloud Console
const serviceAccountJson = require('./service-account.json')
// entity.json is a file that contains the entity data in json format
const entity = require('./entity.json')

const ENTITY_ID = 'your/entity/id'
const PROJECT_ID = 'type/your-project-id'

/**
 * Get the authorization token using a service account.
 */
async function getAuthToken() {
  let client = auth.fromJSON(serviceAccountJson)
  client.scopes = ['https://www.googleapis.com/auth/assistant']
  const tokens = await client.authorize()
  return tokens.access_token;
}

/**
 * Send an incremental update to update or add an entity
 */
async function updateEntity(entity) {
  const token = await getAuthToken()
  request.post({
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${token}`
    },
    url: `https://actions.googleapis.com/v2/apps/${PROJECT_ID}/entities:batchPush`,
    body: {
      requests: [
        {
          entity: {
            data: JSON.stringify(entity)
            name: `apps/${PROJECT_ID}/entities/${ENTITY_ID}`
          }
        }
      ],
      vertical: 'FOODORDERING'
    },
    json: true
  },
  (err, res, body) => {
    if (err) { return console.log(err); }
    console.log(`Response: ${JSON.stringify(res)}`)
  })
}

updateEntity(entity)

Python

Este código usa la biblioteca de autenticación de Google para Python.

from google.oauth2 import service_account
from google.auth.transport.requests import AuthorizedSession
import json
import urllib

PROJECT_ID = 'your-project-id'
ENTITY_ID = 'type/your/entity/id'

ENDPOINT = 'https://actions.googleapis.com/v2/apps/%s/entities:batchPush' % (
    PROJECT_ID)

# service-account.json is the service account client secret file downloaded from the
# Google Cloud Console
credentials = service_account.Credentials.from_service_account_file(
    'service-account.json')

scoped_credentials = credentials.with_scopes(
    ['https://www.googleapis.com/auth/assistant'])

authed_session = AuthorizedSession(scoped_credentials)

# Retrieving the entity
update_file = open("entity.json")  #JSON file containing entity data in json format.
data = update_file.read()

entity = {}
entity['data'] = data #entity JSON-LD serialized as string
entity['name'] = 'apps/%s/entities/%s' % (PROJECT_ID, urllib.quote(ENTITY_ID, '') )

# Populating the request
request = {}
request['entity'] = entity
requestArray = [request]

# Populating the payload
payload = {}
payload['requests'] = requestArray
payload['vertical'] = 'FOODORDERING'

response = authed_session.post(ENDPOINT, json=payload)

print(response.text) #if successful, will be '{}'

Java

Este código usa la biblioteca de autenticación de Google para Java.

private static final String PROJECT_ID = "your-project-id";
private static final String ENTITY_ID = "type/your-entity-id";

/**
 * Get the authorization token using a service account.
 */
private static String getAuthToken() {
  InputStream serviceAccountFile =
      Example.class.getClassLoader().getResourceAsStream("service-account.json");
  ServiceAccountCredentials.Builder credentialsSimpleBuilder =
      ServiceAccountCredentials.fromStream(serviceAccountFile).toBuilder();
  credentialsSimpleBuilder.setScopes(ImmutableList.of("https://www.googleapis.com/auth/assistant"));
  AccessToken accessToken = credentialsSimpleBuilder.build().refreshAccessToken();
  return accessToken.getTokenValue();
}

/**
 * Send an incremental update to update or add an entity.
 * @param entityId The id of the entity to update.
 * @param entity the json of the entity to be updated.
 */
public void updateEntity(String entityId, JSONObject data) {
  String authToken = getAuthToken();
  String endpoint = String.format("https://actions.googleapis.com/v2/apps/%s/entities/:batchPush", PROJECT_ID);

  JSONObject entity = new JSONObject();
  entity.put("data", data.toString());
  entity.put("name", String.format("apps/%s/entities/%s", PROJECT_ID, URLEncoder.encode(ENTITY_ID, "UTF-8")));

  JSONObject request = new JSONObject();
  request.put("entity", entity);

  JSONArray requestArray = new JSONArray();
  requestArray.put(request);

  JSONObject payload = new JSONObject();
  payload.put("requests", requestArray);
  payload.put("vertical", FOODORDERING);

  // Execute POST request
  executePostRequest(endpoint, authToken, payload);
}

Quita entidades

Node.js

Este código usa la biblioteca de autenticación de Google para Node.js.

const {auth} = require('google-auth-library')
const request = require('request');
// The service account client secret file downloaded from the Google Cloud Console
const serviceAccountJson = require('./service-account.json')
// entity.json is a file that contains the entity data in json format
const entity = require('./entity.json')

const ENTITY_ID = 'restaurant/http://www.provider.com/somerestaurant'
const PROJECT_ID = 'your-project-id'

/**
 * Get the authorization token using a service account.
 */
async function getAuthToken() {
  let client = auth.fromJSON(serviceAccountJson)
  client.scopes = ['https://www.googleapis.com/auth/assistant']
  const tokens = await client.authorize()
  return tokens.access_token;
}

/**
 * Send an incremental update to delete an entity
 */
async function deleteEntity(entityId) {
  const token = await getAuthToken()
  request.delete({
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${token}`
    },
    url: `https://actions.googleapis.com/v2/apps/${PROJECT_ID}/entities/${encodeURIComponent(entityId)}?entity.vertical=FOODORDERING`,
    body: {},
    json: true
  },
  (err, res, body) => {
    if (err) { return console.log(err); }
    console.log(`Response: ${JSON.stringify(res)}`)
  })
}

deleteEntity(ENTITY_ID)

Python

Este código usa la biblioteca de autenticación de Google para Python.

from google.oauth2 import service_account
from google.auth.transport.requests import AuthorizedSession
import json
import urllib

# Service config
PROJECT_ID = 'your-project-id'
ENTITY_ID = 'restaurant/http://www.provider.com/somerestaurant'
DELETE_TIME = '2018-04-07T14:30:00-07:00'
ENDPOINT = 'https://actions.googleapis.com/v2/apps/%s/entities/%s?entity.vertical=FOODORDERING&delete_time=%s' % (
    PROJECT_ID, urllib.quote(ENTITY_ID, ''), urllib.quote(DELETE_TIME, ''))

# service-account.json is the service account client secret file downloaded from the
# Google Cloud Console
credentials = service_account.Credentials.from_service_account_file(
    'service-account.json')

scoped_credentials = credentials.with_scopes(
    ['https://www.googleapis.com/auth/assistant'])

authed_session = AuthorizedSession(scoped_credentials)
response = authed_session.delete(ENDPOINT)

print(response.text) #if successful, will be '{}'

Java

Este código usa la biblioteca de autenticación de Google para Java.

private static final String PROJECT_ID = "your-project-id";
private static final String ENTITY_ID = "restaurant/http://www.provider.com/somerestaurant";

/**
 * Get the authorization token using a service account.
 */
private static String getAuthToken() {
  InputStream serviceAccountFile = Example.class.getClassLoader().getResourceAsStream("service-account.json");
  ServiceAccountCredentials.Builder credentialsSimpleBuilder =
      ServiceAccountCredentials.fromStream(serviceAccountFile).toBuilder();
  credentialsSimpleBuilder.setScopes(ImmutableList.of("https://www.googleapis.com/auth/assistant"));
  AccessToken accessToken = credentialsSimpleBuilder.build().refreshAccessToken();
  return accessToken.getTokenValue();
}

/**
 * Send an incremental update to delete an entity.
 * @param entityId The id of the entity to delete.
 */
public void deleteEntity(String entityId) {
  String authToken = getAuthToken();
  String endpoint = String.format(
      "https://actions.googleapis.com/v2/apps/%s/entities/%s?entity.vertical=FOODORDERING",
      PROJECT_ID, URLEncoder.encode(entityId, "UTF-8"));
  // Execute DELETE request
  System.out.println(executeDeleteRequest(endpoint, authToken));
}

Casos de uso

Los siguientes casos de uso son ejemplos de actualizaciones incrementales, actualizaciones de feed completas y el contenido en un nivel alto en la llamada a la API:

Situación	Entidad para actualizar	Descripción y efectos
Inhabilita un servicio	`Service`	Debe inhabilitar un servicio por una razón imprevista. Actualizaciones incrementales: Para actualizar la entidad `Service` en cuestión, establece su propiedad `isDisabled` en `true`, pero mantén las demás propiedades iguales. Feeds completos: Asegúrate de actualizar la entidad de los feeds completos para que `isDisabled` se establezca en `true` antes de que Google realice la siguiente recuperación; de lo contrario, la entidad se volverá a habilitar.
Un artículo específico está agotado	`MenuItemOffer`	Actualizaciones incrementales: Envía la entidad `MenuItemOffer` de encapsulamiento con `inventoryLevel` establecido en 0 para el `MenuItem` determinado y todos los demás datos sin cambios.
Cambio en el precio del elemento del menú	`MenuItemOffer`	Actualizaciones incrementales: Envía la entidad `MenuItemOffer` de encapsulamiento con `price` establecido en el precio actualizado para el `MenuItem` determinado y todos los demás datos sin cambios.
Agregar nueva entidad de nivel superior Solo se aplica a entidades de tipos `Menu`, `Restaurant` y `Service`.	`Menu`, `Restaurant`, `Service`	Por ejemplo, debes agregar un menú nuevo a un restaurante. Feeds completos: Agregue la entidad a sus feeds de datos y espere la transferencia por lotes.
Borrar la entidad de nivel superior de forma permanente Solo se aplica a entidades de tipos `Menu`, `Restaurant` y `Service`.	`Menu`, `Restaurant`, `Service`	Actualizaciones incrementales: Envía una eliminación explícita. Feeds completos: Asegúrate de quitar la entidad de los feeds completos antes de que Google vuelva a realizarla. De lo contrario, la entidad volverá a agregarse.
Agregue un área de entrega nueva en un `Service` específico	`ServiceArea`	Feeds incrementales: Envía la entidad `ServiceArea` en cuestión con todos sus campos intactos, como lo harías normalmente en los feeds completos, con el nuevo área de entrega especificado en `polygon`, `geoRadius` o `postalCode`.
Actualizar la hora de entrega estimada de entrega en `Service`	`ServiceHours`	Feeds incrementales: Envía el `ServiceHours` de la misma manera que en los feeds, excepto que su `leadTimeMin` se actualiza según corresponda.
Actualiza los precios de entrega en `Service`	`Fee`	Feeds incrementales: Envía la entrega completa `Fee` con `price` actualizado.
Actualiza el horario de entrega o comida para llevar en `Service`	`ServiceHours`	Feeds incrementales: Envía el mismo `ServiceHours` que en los feeds, excepto que sus propiedades `opens` y `closes` se actualizan según corresponda.
`Service` (cambiar el importe mínimo de pedido)	`Fee`	Feeds incrementales: Envía el `Fee` completo con `minPrice` actualizado
Borrar un `MenuItem` de forma permanente	`Menu`	Feeds incrementales: Envía el `MenuItem` de la misma manera que en los feeds, pero con `parentMenuSectionId` vacío.

SLO en el tiempo de procesamiento para trabajos por lotes y actualizaciones incrementales

Una entidad actualizada o borrada a través de un lote se procesará en un plazo de 2 horas con el mejor esfuerzo, mientras que una entidad actualizada a través de una actualización incremental se procesará en 5 minutos. Una entidad inactiva se borra en 7 días.

Puedes enviar a Google:

Varios trabajos por lotes por día para mantener tu inventario actualizado
Un trabajo por lotes por día y API incrementales para mantener tu inventario actualizado.