Bagian ini menjelaskan cara mengirim pembaruan feed yang sensitif terhadap waktu ke Google. Dengan Inkremental Updates API, Anda dapat mengupdate dan menghapus entity di feed secara hampir real time.
Fungsi ini utamanya ditujukan untuk pembaruan yang tidak dapat Anda perkirakan, seperti penutupan darurat. Sebagai aturan, setiap perubahan yang dikirim melalui inkrementment Updates API harus menjadi perubahan yang harus diterapkan dalam waktu tidak lebih dari satu minggu. Jika perubahan tidak perlu segera diterapkan, Anda dapat menggunakan update batch. Update inkremental diproses dalam waktu tidak lebih dari lima menit.
Penyiapan
Untuk menerapkan update inkremental, lakukan hal berikut:
- Ikuti langkah-langkah yang diuraikan di bagian Membuat dan menyiapkan project untuk membuat project.
- Ikuti langkah-langkah yang diuraikan di bagian Menyiapkan akun layanan untuk membuat akun layanan. Perhatikan bahwa Anda harus menjadi "Pemilik" project agar dapat menambahkan peran "Editor" untuk akun layanan
- (Opsional, tetapi direkomendasikan) Instal library Klien Google dalam bahasa pilihan Anda untuk memfasilitasi penggunaan OAuth 2.0 saat memanggil API. Contoh kode yang disertakan di bawah ini menggunakan library ini. Jika tidak, Anda harus menangani pertukaran token secara manual seperti yang dijelaskan dalam Menggunakan OAuth 2.0 untuk Mengakses Google API.
Endpoint
Untuk memberi tahu Google tentang update, buat permintaan HTTP POST ke Introduction Updates API dan sertakan payload update dan penambahan. Skema inventaris yang Anda gunakan menentukan endpoint yang menjadi tujuan 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
Pada permintaan di atas, ganti hal berikut:
- PROJECT_ID: Project ID Google Cloud yang terkait dengan project yang Anda buat di Membuat dan menyiapkan project.
- TYPE (khusus skema inventaris v2): Jenis entity (properti
@type
) objek di feed data yang ingin Anda perbarui. - ENTITY_ID: ID entity yang disertakan dalam payload. Pastikan untuk mengenkode ID entitas Anda ke URL.
- DELETE_TIME (hapus endpoint saja): Kolom opsional untuk menunjukkan
waktu penghapusan entity di sistem Anda (defaultnya adalah saat permintaan
diterima). Nilai waktu tidak boleh di masa yang akan datang. Saat mengirim entity
melalui panggilan inkremental, pembuatan versi entity
juga menggunakan kolom
delete_time
dalam kasus panggilan penghapusan. Format nilai ini sebagaiyyyy-mm-ddTHH:mm:ssZ
Misalnya, Anda memiliki project dengan ID "delivery-provider-id" yang menggunakan skema inventaris v2. Anda ingin melakukan 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, lakukan panggilan HTTP DELETE API:
https://actions.googleapis.com/v2/apps/delivery-provider-id/entities/MenuSection/menuSection_122?entity.vertical=FOODORDERING
Permintaan sandbox
Untuk permintaan sandbox, ikuti panduan pada Endpoint di atas, tetapi buat permintaan ke /v2/sandbox/apps/
, bukan ke /v2/apps/
. Misalnya, permintaan penghapusan sandbox untuk skema inventaris v2 disusun 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 perubahan yang dikirimkan melalui API ini. Jika tidak, update batch Anda akan menimpa perubahan inkremental.
Payload
Setiap permintaan POST harus menyertakan parameter permintaan beserta payload JSON yang berisi data terstruktur dari jenis entity apa pun yang tercantum dalam skema inventaris.
JSON akan muncul sama seperti di feed batch, dengan perbedaan berikut:
- Ukuran isi payload tidak boleh melebihi 5 MB. Demikian pula dengan feed batch, sebaiknya Anda menghapus spasi kosong untuk menyesuaikan lebih banyak data.
- Amplopnya adalah sebagai berikut:
{ "entity": { "data":"ENTITY_DATA", "vertical":"FOODORDERING" }, "update_time":"UPDATE_TIMESTAMP" }
Pada payload di atas, ganti hal berikut:
- ENTITY_DATA: Entitas dalam format JSON diserialisasi sebagai string. Entity JSON-LD harus diteruskan sebagai string di kolom
data
. - UPDATE_TIMESTAMP (opsional): Stempel waktu saat entity diupdate di
sistem Anda. Nilai waktu tidak boleh di masa yang akan datang. Stempel waktu default adalah saat
Google menerima permintaan. Saat mengirim entity melalui permintaan
inkremental, pembuatan versi entity juga menggunakan
kolom
update_time
dalam kasus permintaan penambahan/update.
Memperbarui entity
Contoh 1: Memperbarui restoran
Misalkan Anda perlu segera memperbarui nomor telepon sebuah restoran. Update Anda 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 }
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
Misalnya, Anda perlu mengubah harga item menu. Seperti pada Contoh 1, update Anda harus berisi JSON untuk seluruh entity level teratas (menu), dan feed 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 update inkremental Anda melalui POST akan menjadi seperti 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 proses feed batch seperti yang dijelaskan untuk skema inventaris v2.
Menghapus entitas
Untuk menghapus entity level teratas, gunakan endpoint yang sedikit dimodifikasi, dan gunakan HTTP DELETE, bukan HTTP POST dalam permintaan.
Jangan gunakan HTTP DELETE untuk menghapus sub-entity dalam entity level teratas, seperti item menu dalam menu. Sebagai gantinya, perlakukan penghapusan sub-entitas sebagai update untuk entity level teratas tempat sub-entity dihapus dari daftar atau parameter yang relevan.
Contoh 1: Menghapus entitas level teratas
Pertimbangkan situasi saat Anda ingin menghapus restoran dalam 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 entity 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 entity 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-entity dari dalam entity level teratas, Anda mengirim entity level teratas dengan sub-entity yang dihapus dari kolom yang sesuai. Contoh berikut menganggap bahwa feed menggunakan skema inventaris v1.
Misalnya, untuk menghapus area layanan, perbarui layanan dengan area layanan tersebut
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 bukan berarti feed valid atau benar, hanya berarti panggilan API dilakukan. Panggilan yang berhasil akan menerima kode respons HTTP 200, beserta isi respons kosong:
{}
Jika terjadi kegagalan, kode respons HTTP tidaklah 200, dan isi respons menunjukkan masalahnya.
Misalnya, jika pengguna telah menetapkan nilai "vertikal" dalam amplop ke
FAKE_VERTICAL
, Anda akan menerima pesan di bawah:
{
"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 inkrement Updates API 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 entitas
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 update inkremental, update feed lengkap, dan konten level tinggi dalam panggilan API:
Skenario | Entitas level teratas | Deskripsi dan efek |
---|---|---|
Menonaktifkan layanan | DisabledService |
Anda perlu menonaktifkan layanan karena alasan yang tidak terduga. Update inkremental: Mengirim entity Feed lengkap: Pastikan untuk memperbarui entity dari feed lengkap agar |
Stok item tertentu habis | Menu |
Update inkremental: Mengirim entity Menu yang dienkapsulasi dengan offer.inventoryLevel yang ditetapkan ke 0 untuk MenuItem yang ditentukan, dan semua data lainnya yang tidak berubah. |
Perubahan harga item menu | Menu |
Update inkremental: Kirim entity Menu
yang dienkapsulasi dengan offer.price yang ditetapkan ke harga yang diperbarui untuk
MenuItem yang ditentukan, dan semua data lainnya yang tidak berubah. |
Tambahkan entity level teratas baru Hanya berlaku untuk entity jenis |
Menu , Restaurant , Service |
Misalnya, Anda perlu menambahkan menu baru ke restoran. Pembaruan inkremental: Kirim entitas menu baru, beserta entitas
restoran beserta kolom |
Menghapus entity level teratas secara permanen Hanya berlaku untuk entity jenis |
Menu , Restaurant , Service |
Pembaruan inkremental: Mengirim penghapusan eksplisit. Feed lengkap: Pastikan untuk menghapus entity dari feed lengkap sebelum pengambilan berikutnya oleh Google. Jika tidak, entity akan ditambahkan kembali. |
Tambahkan area pengiriman baru di Service tertentu |
Service |
Feed inkremental: Kirim entity Service yang dimaksud dengan semua kolomnya 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 dalam feed, kecuali hoursAvailable.deliveryHours -nya diperbarui sebagaimana mestinya. |
Perbarui harga pengiriman di Service |
Service |
Feed inkremental: Kirim Service lengkap dengan
offers.priceSpecification.price yang diperbarui. |
Perbarui jam buka pesan antar atau bawa pulang di Service |
Service |
Feed inkremental: Kirim Service sama seperti dalam feed, kecuali hoursAvailable -nya diperbarui sebagaimana mestinya. |
Service (ubah 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 dalam feed, tetapi 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 waktu 1-2 hari. Entity yang diperbarui atau dihapus melalui batch akan diproses dalam 2 jam, sedangkan entity yang diupdate melalui update inkremental akan diproses dalam waktu 5 menit. Entitas yang sudah tidak berlaku akan dihapus dalam 7 hari.
Anda dapat mengirim:
- Beberapa tugas batch per hari untuk menjaga inventaris Anda tetap terbaru, ATAU
- Satu tugas batch per hari dan API inkremental untuk menjaga inventaris Anda tetap terbaru.