Cette page a été traduite par l'API Cloud Translation.

Mises à jour incrémentielles de l'inventaire en version 1

Cette section explique comment envoyer à Google des mises à jour urgentes de vos flux. L'API Incremental Updates vous permet de mettre à jour et de supprimer des entités dans vos flux en temps quasi réel.

Cette fonctionnalité est principalement destinée aux mises à jour que vous ne pouvez pas prévoir, comme les fermetures d'urgence. En règle générale, toute modification envoyée via l'API Incremental Updates doit être mise en ligne dans un délai maximum d'une semaine. Si votre modification n'a pas besoin d'être reflétée immédiatement, vous pouvez utiliser une mise à jour par lot à la place. Les mises à jour incrémentielles sont traitées en cinq minutes maximum.

Configuration

Pour implémenter des mises à jour incrémentielles, procédez comme suit:

Pour créer un projet, suivez les étapes décrites dans la section Créer et configurer un projet.
Suivez la procédure décrite dans Configurer un compte de service pour créer un compte de service. Notez que vous devez être "propriétaire" du projet pour ajouter un rôle "Éditeur" au compte de service.
(Facultatif, mais recommandé) Installez la bibliothèque cliente Google dans la langue de votre choix pour faciliter l'utilisation d'OAuth 2.0 lors de l'appel de l'API. Les exemples de code ci-dessous utilisent ces bibliothèques. Sinon, vous devrez gérer manuellement les échanges de jetons, comme décrit dans la section Utiliser OAuth 2.0 pour accéder aux API Google.

Point de terminaison

Pour informer Google d'une mise à jour, envoyez une requête HTTP POST à l'API Incremental Updates et incluez une charge utile de mises à jour et d'ajouts. Le schéma d'inventaire que vous utilisez détermine le point de terminaison auquel envoyer votre requête:

Inventaire v2

https://actions.googleapis.com/v2/apps/PROJECT_ID/entities/TYPE/ENTITY_ID:push

Inventaire v1

https://actions.googleapis.com/v2/apps/PROJECT_ID/entities/ENTITY_ID:push

Pour supprimer une entité, envoyez une requête HTTP DELETE au point de terminaison suivant, qui correspond au schéma d'inventaire que vous utilisez:

Inventaire v2

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

Inventaire v1

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

Dans les requêtes ci-dessus, remplacez les éléments suivants:

PROJECT_ID: ID de projet Google Cloud associé au projet que vous avez créé dans Créer et configurer un projet.
TYPE (schéma d'inventaire v2 uniquement): type d'entité (propriété @type) de l'objet de votre flux de données que vous souhaitez mettre à jour.
ENTITY_ID: ID de l'entité incluse dans la charge utile. Veillez à encoder votre ID d'entité en URL.
DELETE_TIME (point de terminaison de suppression uniquement): champ facultatif permettant d'indiquer le moment où l'entité a été supprimée sur vos systèmes (par défaut, lors de la réception de la requête). La valeur de l'heure ne doit pas se situer dans le futur. Lorsque vous envoyez une entité via un appel incrémentiel, la gestion des versions des entités utilise également le champ delete_time en cas d'appel de suppression. Formater cette valeur au format yyyy-mm-ddTHH:mm:ssZ

Par exemple, vous avez un projet dont l'ID est "delivery-provider-id" et qui utilise le schéma d'inventaire v2. Vous souhaitez modifier le restaurant dont le type d'entité est "MenuSection" et dont l'ID d'entité est "menuSection_122". Le point de terminaison pour les mises à jour de vos données est le suivant:

https://actions.googleapis.com/v2/apps/delivery-provider-id/entities/MenuSection/menuSection_122:push

Pour supprimer cette même entité, vous devez effectuer cet appel d'API HTTP DELETE:

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

Requêtes de bac à sable

Pour les requêtes en mode bac à sable, suivez les instructions de la section Point de terminaison ci-dessus, mais envoyez des requêtes à /v2/sandbox/apps/ au lieu de /v2/apps/. Par exemple, une requête de suppression dans l'environnement de simulation pour le schéma d'inventaire v2 est structurée comme suit:

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

Mises à jour et ajouts

Vos flux de lot quotidiens doivent également contenir toutes les modifications envoyées via cette API. Sinon, vos mises à jour par lot écraseront vos modifications incrémentielles.

Charge utile

Chaque requête POST doit inclure les paramètres de requête ainsi que la charge utile JSON contenant les données structurées de tout type d'entité listé dans le schéma d'inventaire.

Le fichier JSON doit se présenter de la même manière que dans le flux par lot, avec les différences suivantes:

Le corps de la charge utile ne doit pas dépasser 5 Mo. Comme pour les flux par lot, nous vous suggérons de supprimer les espaces blancs afin de pouvoir insérer plus de données.
L'enveloppe est la suivante:

{
  "entity": {
    "data":"ENTITY_DATA",
    "vertical":"FOODORDERING"
  },
  "update_time":"UPDATE_TIMESTAMP"
}

Dans la charge utile ci-dessus, remplacez les éléments suivants:

ENTITY_DATA: entité au format JSON sérialisée en tant que chaîne. L'entité JSON-LD doit être transmise sous forme de chaîne dans le champ data.
UPDATE_TIMESTAMP (facultatif): code temporel de la mise à jour de l'entité dans vos systèmes. La valeur de l'heure ne doit pas se situer dans le futur. L'horodatage par défaut correspond au moment où Google reçoit la requête. Lorsque vous envoyez une entité via une requête incrémentielle, le gestion des versions des entités utilise également le champ update_time en cas de requête d'ajout/de mise à jour.

Mettre à jour une entité

Exemple 1: Modifier un restaurant

Supposons que vous deviez modifier de toute urgence le numéro de téléphone d'un restaurant. Votre mise à jour contient le fichier JSON de l'ensemble du restaurant.

Prenons l'exemple d'un flux par lot qui se présente comme suit:

{
  "@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
}

Votre mise à jour incrémentielle par HTTP POST se présente alors comme suit:

POST v2/apps/provider-project/entities/Restaurant/restaurant12345:push
Host: actions.googleapis.com
Content-Type: application/ld+json
{
  "entity": {
    "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"
  }
}

Exemple 2: Modifier le prix d'un élément de menu

Supposons que vous deviez modifier le prix d'un élément de menu. Comme dans l'exemple 1, votre mise à jour doit contenir le code JSON de l'ensemble de l'entité de niveau supérieur (le menu), et le flux utilise le schéma d'inventaire v1.

Prenons l'exemple d'un flux par lot qui se présente comme suit:

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

Votre mise à jour incrémentielle via POST se présente alors comme suit:

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

Ajouter une entité

Pour ajouter des entités, évitez d'utiliser des mises à jour d'inventaire. Utilisez plutôt le processus de flux par lot, comme décrit pour le schéma d'inventaire v2.

Supprimer une entité

Pour supprimer des entités de premier niveau, vous devez utiliser un point de terminaison légèrement modifié et HTTP DELETE au lieu de HTTP POST dans la requête.

N'utilisez pas la méthode HTTP DELETE pour supprimer une sous-entité dans une entité de niveau supérieur, comme un élément de menu dans un menu. Traitez plutôt la suppression des sous-entités comme une mise à jour d'une entité de niveau supérieur dans laquelle la sous-entité est supprimée de la liste ou du paramètre appropriés.

Exemple 1: Supprimer une entité de niveau supérieur

Imaginons que vous souhaitiez supprimer un restaurant d'un flux qui utilise le schéma d'inventaire v1. Vous devez également supprimer ses services et ses menus.

Exemple de point de terminaison pour une entité de menu avec l'ID "https://www.provider.com/restaurant/menu/nr":

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

Exemple de point de terminaison pour une entité de restaurant avec l'ID "https://www.provider.com/restaurant/nr":

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

Exemple de point de terminaison pour une entité de service avec l'ID "https://www.provider.com/restaurant/service/nr":

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

Exemple 2: Supprimer des sous-entités

Pour supprimer une sous-entité d'une entité de niveau supérieur, vous envoyez l'entité de niveau supérieur en supprimant la sous-entité du champ correspondant. L'exemple suivant suppose que le flux utilise le schéma d'inventaire v1.

Par exemple, pour supprimer une zone desservie, mettez à jour le service en supprimant la zone desservie de la liste areaServed.

POST v2/apps/delivery-provider-id/entities/https%3A%2F%2Fwww.provider.com%2Frestaurant%2Fservice%2Fnr:push
Host: actions.googleapis.com
Content-Type: application/ld+json
{
  "entity": {
    // Note: "data" is not serialized as a string in our example for readability.
    "data": {
      "@type": "Service",
      "provider": {
        "@type": "Restaurant",
        "@id": "https://www.provider.com/restaurant/nr"
      },
      "areaServed": [
        {
          "@type": "GeoCircle",
          "geoMidpoint": {
            "@type": "GeoCoordinates",
            "latitude": "42.362757",
            "longitude": "-71.087109"
          },
          "geoRadius": "10000"
        }
        // area2 is removed.
      ]
      ...
    },
    "vertical": "FOODORDERING"
  }
}

Codes de réponse de l'API

Un appel réussi ne signifie pas que le flux est valide ou correct, mais seulement que l'appel d'API a été effectué. Les appels réussis reçoivent un code de réponse HTTP 200, ainsi qu'un corps de réponse vide:

{}

En cas d'échec, le code de réponse HTTP ne sera pas 200, et le corps de la réponse indiquera ce qui s'est mal passé.

Par exemple, si l'utilisateur a défini la valeur "vertical" dans l'enveloppe sur FAKE_VERTICAL, vous recevrez le message ci-dessous:

{
  "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\""
          }
        ]
      }
    ]
  }
}

Exemple de code

Vous trouverez ci-dessous quelques exemples d'utilisation de l'API Incremental Updates dans différentes langues. Ces exemples utilisent les bibliothèques Google Auth et supposent un flux utilisant le schéma d'inventaire v1. Pour connaître d'autres solutions, consultez la page Utiliser OAuth 2.0 pour les applications de serveur à serveur.

Mettre à jour des entités

Node.js

Ce code utilise la bibliothèque Google Auth pour 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 update or add an entity
 */
async function updateEntity(entityId, 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/${encodeURIComponent(entityId)}:push`,
    body: {
      entity: {
        data: JSON.stringify(entity),
        vertical: 'FOODORDERING',
      }
    },
    json: true
  },
  (err, res, body) => {
    if (err) { return console.log(err); }
    console.log(`Response: ${JSON.stringify(res)}`)
  })
}

updateEntity(ENTITY_ID, entity)

Python

Ce code utilise la bibliothèque Google Auth pour 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 = 'restaurant/http://www.provider.com/somerestaurant'
ENDPOINT = 'https://actions.googleapis.com/v2/apps/%s/entities/%s:push' % (
    PROJECT_ID, urllib.quote(ENTITY_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()

# Populating the entity with wrapper
entity = {}
entity['data'] = data #entity JSON-LD serialized as string
entity['vertical'] = 'FOODORDERING'

request = {}
request['entity'] = entity

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

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

Java

Ce code utilise la bibliothèque Google Auth pour Java.

private static final String PROJECT_ID = "your-project-id";
private static final String ENTITY_ID = "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 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 entity) {
  String authToken = getAuthToken();
  String endpoint = String.format(
      "https://actions.googleapis.com/v2/apps/%s/entities/%s:push",
      PROJECT_ID, URLEncoder.encode(entityId, "UTF-8"));
  JSONObject data = new JSONObject();
  data.put("data", entity.toString());
  data.put("vertical", "FOODORDERING");
  JSONObject jsonBody = new JSONObject();
  jsonBody.put("entity", data);
  // Execute POST request
  executePostRequest(endpoint, authToken, jsonBody);
}

Supprimer des entités

Node.js

Ce code utilise la bibliothèque Google Auth pour 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

Ce code utilise la bibliothèque Google Auth pour 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

Ce code utilise la bibliothèque Google Auth pour 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));
}

Cas d'utilisation

Les cas d'utilisation suivants sont des exemples de mises à jour incrémentielles, de mises à jour complètes du flux et du contenu à un niveau élevé dans l'appel d'API:

Scénario	Entité de premier niveau	Description et effets
Désactiver un service	`DisabledService`	Vous devez désactiver un service pour une raison imprévue. Mises à jour incrémentielles:envoyez l'entité `Service` en question en remplaçant `@type` par `DisabledService`, mais en laissant les autres propriétés inchangées. Flux complets:veillez à mettre à jour l'entité à partir des flux complets pour que `@type` soit défini sur `DisabledService` avant la prochaine récupération par Google, sinon l'entité sera réactivée.
Article spécifique non disponible	`Menu`	Mises à jour incrémentielles:envoyez l'entité `Menu` encapsulante avec `offer.inventoryLevel` défini sur 0 pour le `MenuItem` donné, et toutes les autres données inchangées.
Changement de prix d'un élément de menu	`Menu`	Mises à jour incrémentielles:envoyez l'entité `Menu` encapsulante avec `offer.price` défini sur le prix mis à jour pour le `MenuItem` donné, et toutes les autres données inchangées.
Ajouter une entité de niveau supérieur Ne s'applique qu'aux entités de types `Menu`, `Restaurant` et `Service`.	`Menu`, `Restaurant`, `Service`	Par exemple, vous devez ajouter un nouveau menu à un restaurant. Mises à jour incrémentielles:envoyez la nouvelle entité de menu, ainsi que l'entité de restaurant avec son champ `hasMenu` mis à jour en conséquence.
Supprimer définitivement une entité de niveau supérieur Ne s'applique qu'aux entités de types `Menu`, `Restaurant` et `Service`.	`Menu`, `Restaurant`, `Service`	Mises à jour incrémentielles:envoyez une suppression explicite. Flux complets:assurez-vous de supprimer l'entité des flux complets avant la prochaine récupération par Google, sinon elle sera de nouveau ajoutée.
Ajouter une zone de livraison dans une `Service` spécifique	`Service`	Flux incrémentaux:envoyez l'entité `Service` en question avec tous ses champs intacts, comme vous le feriez normalement dans les flux complets, avec la nouvelle zone de diffusion spécifiée dans `areaServed` de la `Service`.
Modifier l'heure d'arrivée estimée de la livraison dans `Service`	`Service`	Flux incrémentaux:envoyez le `Service` de la même manière que dans les flux, à l'exception de son `hoursAvailable.deliveryHours`, qui est mis à jour en conséquence.
Mettre à jour les tarifs de livraison dans `Service`	`Service`	Flux incrémentiels:envoyez un `Service` complet avec `offers.priceSpecification.price` mis à jour.
Modifier les horaires de livraison ou de vente à emporter dans `Service`	`Service`	Flux incrémentaux:envoyez le `Service` de la même manière que dans les flux, sauf que son `hoursAvailable` est mis à jour en conséquence.
`Service` (modifier le montant minimal de la commande)	`Service`	Flux incrémentaux:envoyez un `Service` complet avec `Service.offers.priceSpecification.eligibleTransactionVolume` mis à jour.
Supprimer `MenuItem` définitivement	`Menu`	Flux incrémentaux:envoyez le `Menu` de la même manière que dans les flux, mais en supprimant ce `MenuItem` de la liste `hasMenuItems`.

Contrat de niveau de service sur le temps de traitement des jobs par lot et des mises à jour incrémentielles

Une entité ajoutée via une mise à jour par lot ou incrémentielle sera traitée sous un à deux jours. Une entité mise à jour ou supprimée via un lot sera traitée en deux heures, tandis qu'une entité mise à jour via une mise à jour incrémentielle sera traitée en cinq minutes. Une entité obsolète est supprimée au bout de sept jours.

Vous pouvez envoyer à Google:

Plusieurs tâches par lot par jour pour mettre à jour votre inventaire OU
Une tâche par lot par jour et des API incrémentielles pour mettre à jour votre inventaire.