Pembaruan inventaris inkremental v1

Bagian ini menjelaskan cara mengirim pembaruan feed yang sensitif terhadap waktu ke Google. API Pembaruan Inkremental memungkinkan Anda memperbarui dan menghapus entity di feed secara hampir real time.

Fungsi ini terutama ditujukan untuk pembaruan yang tidak dapat Anda antisipasi, seperti penutupan darurat. Biasanya, setiap perubahan yang dikirimkan melalui API Pembaruan Inkremental harus berupa perubahan yang harus ditayangkan tidak lebih dari satu minggu. Jika perubahan Anda tidak perlu segera dicerminkan, Anda dapat menggunakan batch update sebagai gantinya. Pembaruan inkremental diproses dalam waktu tidak lebih dari lima menit.

Penyiapan

Untuk mengimplementasikan update inkremental, lakukan hal berikut:

  1. Ikuti langkah-langkah yang diuraikan dalam Membuat dan menyiapkan project untuk membuat proyek.
  2. Ikuti langkah-langkah yang diuraikan dalam Menyiapkan akun layanan untuk membuat akun layanan. Perhatikan bahwa Anda harus menjadi "Pemilik" dari menambahkan "Editor" peran untuk akun layanan
  3. (Opsional, tetapi direkomendasikan) Instal Library Klien Google dalam bahasa pilihan Anda untuk memfasilitasi penggunaan OAuth 2.0 saat memanggil Compute Engine API. Contoh kode yang disertakan di bawah ini menggunakan library ini. Jika tidak, Anda akan harus menangani pertukaran token secara manual seperti yang dijelaskan dalam Menggunakan OAuth 2.0 untuk Mengakses Google API.

Endpoint

Untuk memberi tahu Google tentang pembaruan, buat permintaan HTTP POST ke Inkrementalitas Update API dan menyertakan payload update dan penambahan. Skema inventaris yang Anda gunakan menentukan endpoint yang akan membuat permintaan Anda:

inventaris v2

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

inventaris v1

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

Untuk menghapus entity, buat permintaan HTTP DELETE ke endpoint berikut yang sesuai dengan skema inventaris yang Anda gunakan:

inventaris v2

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

inventaris v1

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

Dalam permintaan di atas, ganti kode berikut:

  • PROJECT_ID: Project ID Google Cloud yang terkait dengan project yang Anda yang dibuat di Membuat dan menyiapkan project.
  • TYPE (khusus skema inventaris v2): Jenis entitas (properti @type) pada objek di feed data yang ingin Anda perbarui.
  • ENTITY_ID: ID entitas yang disertakan dalam payload. Pastikan untuk URL mengenkode ID entitas Anda.
  • DELETE_TIME (hapus hanya endpoint): Kolom opsional untuk menunjukkan waktu entitas dihapus di sistem Anda (defaultnya adalah saat permintaan yang diterima). Nilai waktu tidak boleh di masa mendatang. Saat mengirim entity melalui panggilan inkremental, pembuatan versi entitas juga menggunakan kolom delete_time jika terjadi panggilan hapus. Format ini nilai sebagai yyyy-mm-ddTHH:mm:ssZ

Misalnya, Anda memiliki project dengan ID "delivery-provider-id" yang menggunakan skema inventaris v2. Anda ingin membuat perubahan pada restoran dengan jenis entitas restoran "MenuSection" dan ID entitas "menuSection_122". Endpoint untuk pembaruan data Anda adalah sebagai berikut:

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

Untuk menghapus entitas yang sama ini, Anda harus membuat panggilan HTTP DELETE API ini:

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

Permintaan sandbox

Untuk permintaan sandbox, ikuti panduan di Endpoint di atas, tetapi membuat permintaan ke /v2/sandbox/apps/, bukan ke /v2/apps/. Misalnya, struktur permintaan penghapusan sandbox untuk skema inventaris v2 adalah sebagai berikut:

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

Pembaruan dan penambahan

Feed batch harian Anda juga harus berisi setiap perubahan yang dikirimkan melalui Compute Engine API. Jika tidak, kumpulan update Anda akan menimpa perubahan inkremental.

Payload

Setiap permintaan POST harus menyertakan parameter permintaan bersama dengan JSON payload yang berisi data terstruktur dari jenis entitas apa pun yang tercantum dalam skema inventaris Anda.

JSON akan terlihat sama seperti yang ada di feed batch, dengan perbedaan berikut:

  • Isi payload tidak boleh melebihi 5 MB. Serupa dengan batch feed, sebaiknya hapus spasi kosong demi mendapatkan lebih banyak data.
  • Amplopnya adalah sebagai berikut:
{
  "entity": {
    "data":"ENTITY_DATA",
    "vertical":"FOODORDERING"
  },
  "update_time":"UPDATE_TIMESTAMP"
}

Dalam payload di atas, ganti kode berikut:

  • ENTITY_DATA: Entitas dalam format JSON diserialisasi sebagai string. Tujuan Entitas JSON-LD harus diteruskan sebagai string di kolom data.
  • UPDATE_TIMESTAMP (opsional): Stempel waktu saat entitas diperbarui sistem-sistem Anda. Nilai waktu tidak boleh di masa mendatang. Stempel waktu default adalah saat Google akan menerima permintaan tersebut. Saat mengirim entitas melalui permintaan, pembuatan versi entitas juga menggunakan update_time jika ada permintaan tambahkan/pembaruan.

Memperbarui entity

Contoh 1: Memperbarui restoran

Misalkan Anda sangat perlu memperbarui nomor telepon sebuah restoran. Nama berisi JSON untuk seluruh restoran.

Pertimbangkan feed batch yang terlihat seperti berikut:

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

Maka update inkremental Anda melalui HTTP POST akan menjadi seperti berikut:

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

Contoh 2: Memperbarui harga item menu

Misalkan Anda perlu mengubah harga item menu. Seperti di Contoh 1, harus berisi JSON untuk seluruh entitas level teratas (menu), dan menggunakan skema inventaris v1.

Pertimbangkan feed batch yang terlihat seperti berikut:

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

Maka pembaruan inkremental Anda melalui POST akan menjadi sebagai berikut:

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

Menambahkan entity

Untuk menambahkan entitas, hindari penggunaan pembaruan inventaris. Sebagai gantinya, gunakan feed batch seperti yang dijelaskan untuk skema inventaris v2.

Menghapus entity

Untuk menghapus entitas tingkat teratas, gunakan endpoint yang sedikit diubah, dan gunakan HTTP DELETE, bukan HTTP POST dalam permintaan.

Jangan gunakan HTTP DELETE untuk menghapus sub-entitas dalam entitas level teratas, seperti item menu dalam menu. Sebaliknya, perlakukan penghapusan subentitas sebagai pembaruan entitas tingkat teratas tempat sub-entitas dihapus dari daftar atau parameter yang relevan.

Contoh 1: Menghapus entitas tingkat teratas

Pertimbangkan situasi di mana Anda ingin menghapus restoran di feed yang menggunakan skema inventaris v1. Anda juga harus menghapus layanan dan menunya.

Contoh endpoint untuk entity menu dengan 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

Contoh endpoint untuk entitas restoran dengan 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

Contoh endpoint untuk entitas layanan dengan 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
}

Contoh 2: Menghapus sub-entitas

Untuk menghapus sub-entitas dari dalam entitas level teratas, kirim entitas level teratas entitas dengan sub-entitas yang dihapus dari kolom yang sesuai. Hal berikut dengan asumsi bahwa feed menggunakan skema inventaris v1.

Misalnya, untuk menghapus area layanan, perbarui layanan dengan area layanan dihapus dari daftar 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"
  }
}

Kode respons API

Panggilan yang berhasil tidak berarti feed valid atau benar, hanya saja Panggilan API telah dilakukan. Panggilan yang berhasil akan menerima kode respons HTTP 200, beserta dengan isi respons kosong:

{}

Jika gagal, kode respons HTTP tidak akan 200, dan isi respons menunjukkan adanya kesalahan.

Misalnya, jika pengguna telah menetapkan "vertikal" nilai di amplop untuk FAKE_VERTICAL, Anda akan menerima pesan di bawah ini:

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

Contoh kode

Berikut adalah beberapa contoh cara menggunakan API Pembaruan Inkremental dalam berbagai bahasa. Contoh ini menggunakan Library Google Auth, dan mengasumsikan feed menggunakan skema inventaris v1. Untuk solusi alternatif, lihat Menggunakan OAuth 2.0 untuk Aplikasi Server ke Server.

Mengupdate entity

Node.js

Kode ini menggunakan library autentikasi Google untuk 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

Kode ini menggunakan library autentikasi Google untuk 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

Kode ini menggunakan library autentikasi Google untuk 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);
}

Menghapus entity

Node.js

Kode ini menggunakan library autentikasi Google untuk 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

Kode ini menggunakan library autentikasi Google untuk 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

Kode ini menggunakan library autentikasi Google untuk 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));
}

Kasus penggunaan

Kasus penggunaan berikut adalah contoh pembaruan inkremental, pembaruan feed lengkap, dan konten di level tinggi dalam panggilan API:

Skenario Entitas tingkat teratas Deskripsi dan efek
Menonaktifkan layanan DisabledService

Anda perlu menonaktifkan layanan karena alasan yang tidak terduga.

Update inkremental: Mengirim entity Service di pertanyaan dengan @type diubah menjadi DisabledService, tetapi pertahankan properti lainnya.

Feed lengkap: Pastikan untuk memperbarui entitas dari feed lengkap agar @type ditetapkan ke DisabledService sebelum pengambilan berikutnya oleh Google. Jika tidak, entitas tersebut akan diaktifkan kembali.

Stok item tertentu habis Menu Update inkremental: Mengirim enkapsulasi Menu entity dengan offer.inventoryLevel ditetapkan ke 0 untuk nilai yang diberikan MenuItem, dan semua data lainnya tidak berubah.
Perubahan harga item menu Menu Update inkremental: Mengirim enkapsulasi Menu entitas dengan offer.price ditetapkan ke harga terbaru untuk item yang diberikan MenuItem, dan semua data lainnya tidak berubah.

Tambahkan entitas tingkat teratas baru

Hanya berlaku untuk entity jenis Menu, Restaurant, dan Service.

Menu, Restaurant, Service

Misalnya, Anda perlu menambahkan menu baru ke restoran.

Pembaruan inkremental: Mengirim entitas menu baru, bersama dengan restoran dengan kolom hasMenu-nya juga akan diupdate.

Menghapus entity tingkat teratas secara permanen

Hanya berlaku untuk entity jenis Menu, Restaurant, dan Service.

Menu, Restaurant, Service

Update inkremental: Mengirim penghapusan eksplisit.

Feed lengkap: Pastikan untuk menghapus entitas dari feed lengkap sebelum pengambilan berikutnya oleh Google, jika tidak, entitas akan ditambahkan kembali.

Tambahkan area pengiriman baru di Service spesifik Service Feed inkremental: Mengirim entitas Service yang dimaksud bersama semua kolom tetap utuh, seperti yang biasa Anda lakukan dalam feed lengkap, dengan area pengiriman baru yang ditentukan dalam areaServed dari Service.
Perbarui perkiraan waktu tiba pengiriman di Service Service Feed inkremental: Kirim Service sama seperti di feed, kecuali hoursAvailable.deliveryHours-nya diperbarui sebagaimana mestinya.
Perbarui harga pengiriman di Service Service Feed inkremental: Kirim Service lengkap dengan offers.priceSpecification.price diperbarui.
Perbarui jam buka pengiriman atau bawa pulang di Service Service Feed inkremental: Kirim Service sama seperti di feed, kecuali hoursAvailable-nya diperbarui sebagaimana mestinya.
Service (mengubah jumlah pesanan minimum) Service Feed inkremental: Kirim Service lengkap dengan Service.offers.priceSpecification.eligibleTransactionVolume diperbarui
Hapus MenuItem secara permanen Menu Feed inkremental: Kirim Menu sama seperti yang ada di feed, namun dengan MenuItem ini dihapus dari Daftar hasMenuItems.

SLO tentang waktu pemrosesan untuk tugas batch dan update inkremental

Entity yang ditambahkan melalui update batch atau inkremental akan diproses dalam 1-2 hari. Entitas yang diperbarui atau dihapus melalui batch akan diproses di 2 jam, sedangkan entitas yang diperbarui melalui pembaruan inkremental akan diproses dalam 5 menit. Entitas yang sudah tidak berlaku akan dihapus dalam 7 hari.

Anda dapat mengirim:

  • Beberapa tugas batch per hari untuk memastikan inventaris Anda selalu terbaru, ATAU
  • Satu tugas batch per hari dan API Inkremental untuk menjaga inventaris Anda tetap terbaru.