以 v1 版累加型商品目錄更新

本節說明如何將時間敏感的動態饋給更新內容傳送給 Google。透過「增量更新」API,您幾乎可以即時更新及刪除動態饋給中的實體。

這項功能主要用於處理你無法預測的更新內容,例如緊急關閉。一般來說,透過增量更新 API 提交的任何變更,都必須在一個星期內生效。如果變更不需要立即反映,您可以改用批次更新。分批更新的處理時間不超過五分鐘。

設定

如要實作增量更新,請按照下列步驟操作:

  1. 請按照「建立及設定專案」一文中的步驟建立專案。
  2. 請按照「設定服務帳戶」一節的步驟建立服務帳戶。請注意,您必須是專案的「擁有者」,才能為服務帳戶新增「編輯者」角色
  3. (選用,但建議安裝) 以您選擇的語言安裝 Google 用戶端程式庫,方便在呼叫 API 時使用 OAuth 2.0。下方程式碼範例使用這些程式庫。否則,您必須手動處理符記交換,如「使用 OAuth 2.0 存取 Google API」一文所述。

端點

如要通知 Google 更新,請向 Incremental Updates API 發出 HTTP POST 要求,並附上更新和新增項目的酬載。您使用的廣告空間結構定義會決定要向哪個端點提出要求:

v2 廣告空間

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

v1 廣告空間

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

如要移除實體,請針對您使用的目錄結構定義,向下列端點傳送 HTTP DELETE 要求:

v2 廣告空間

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

v1 廣告空間

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

在上述要求中,請替換下列項目:

  • PROJECT_ID:與您在「建立及設定專案」中建立的專案相關聯的 Google Cloud 專案 ID。
  • TYPE (僅限第 2 版商品目錄架構):您要更新的資料動態饋給中物件的實體類型 (@type 屬性)。
  • ENTITY_ID:酬載中包含的實體 ID。請務必將實體 ID 編碼為網址格式。
  • DELETE_TIME (僅限刪除端點):選用欄位,用於表示實體在系統中刪除的時間 (預設為收到要求時)。時間值不得在未來,透過增量呼叫傳送實體時,實體版本控制也會在刪除呼叫的情況下使用 delete_time 欄位。將這個值格式化為 yyyy-mm-ddTHH:mm:ssZ

舉例來說,假設您有一個 ID 為「delivery-provider-id」的專案,且使用的是 v2 廣告空間結構定義。您想變更餐廳,餐廳實體類型為「MenuSection」,實體 ID 為「menuSection_122」。資料更新的端點如下:

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

如要移除同一個實體,請發出以下 HTTP DELETE API 呼叫:

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

沙箱要求

如要提出沙箱要求,請按照上述「端點」一節的說明操作,但請向 /v2/sandbox/apps/ 提出要求,而非向 /v2/apps/ 提出要求。舉例來說,v2 商品目錄結構定義的沙箱刪除要求結構如下:

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

更新和新增

每日批次動態饋給也應包含透過此 API 提交的任何變更。否則,批次更新會覆寫增量變更。

酬載

每個 POST 要求都必須包含要求參數,以及含有廣告空間結構定義中列出的任何實體類型的結構化資料的 JSON 酬載。

JSON 應與批次動態饋給中的 JSON 相同,但有以下差異:

  • 酬載內容不得超過 5 MB。與批次動態饋給類似,建議您為塞入更多資料而移除空格。
  • 信封如下:
{
  "entity": {
    "data":"ENTITY_DATA",
    "vertical":"FOODORDERING"
  },
  "update_time":"UPDATE_TIMESTAMP"
}

在上述酬載中,請替換下列項目:

  • ENTITY_DATA:以字串序列化的 JSON 格式實體。JSON-LD 實體必須以字串形式傳遞至 data 欄位。
  • UPDATE_TIMESTAMP (選用):實體在系統中更新的時間戳記。時間值不得在未來,預設時間戳記是 Google 收到要求的時間。透過增量要求傳送實體時,實體版本控制也會在新增/更新要求的情況下使用 update_time 欄位。

更新實體

範例 1:更新餐廳

假設你需要緊急更新餐廳的電話號碼,更新內容包含整個餐廳的 JSON。

請參考以下批次動態饋給:

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

因此,透過 HTTP POST 進行的增量更新會如下所示:

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

示例 2:更新菜單價格

假設您需要變更菜單項目的價格。如同範例 1 所示,更新內容必須包含整個頂層實體 (選單) 的 JSON,且動態饋給使用第 1 版廣告空間結構定義。

請參考以下批次動態饋給:

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

透過 POST 進行的增量更新會如下所示:

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

新增實體

如要新增實體,請避免使用商品目錄更新功能。請改用批次動態饋給程序,如第 2 版廣告空間結構定義所述。

移除實體

如要移除頂層實體,請使用經過稍微修改的端點,並在要求中使用 HTTP DELETE 而非 HTTP POST。

請勿使用 HTTP DELETE 移除頂層實體中的子實體,例如選單中的選單項目。請改為將子實體移除作業視為頂層實體的更新作業,在該作業中,子實體會從相關清單或參數中移除。

範例 1:刪除頂層實體

舉例來說,假設你想在使用 v1 商品目錄結構定義的動態饋給中刪除餐廳,您也必須刪除相關服務和選單。

以下是 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

餐廳實體的 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

服務實體 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
}

範例 2:移除子實體

如要從頂層實體中移除子實體,請傳送頂層實體,並從對應欄位移除子實體。以下範例假設動態饋給使用第 1 版廣告空間結構定義。

舉例來說,如要移除服務範圍,請更新服務,並從 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"
  }
}

API 回應代碼

成功的呼叫不代表動態饋給有效或正確,只表示已發出 API 呼叫。成功的呼叫會收到 HTTP 回應代碼 200,以及空白的回應主體:

{}

如果是失敗,HTTP 回應碼就不會是 200,回應主體會指出發生錯誤。

舉例來說,如果使用者已將信封中的「vertical」值設為 FAKE_VERTICAL,您就會收到以下訊息:

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

程式碼範例

以下是一些範例,說明如何在各種語言中使用增量更新 API。這些範例會使用 Google 驗證程式庫,並假設動態饋給使用第 1 版廣告空間結構定義。如需其他解決方案,請參閱「針對伺服器對伺服器應用程式使用 OAuth 2.0」。

更新實體

Node.js

本程式碼使用 Node.js 適用的 Google 驗證程式庫

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

這段程式碼使用 Python 專用的 Google 驗證程式庫

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

此程式碼使用 Java 專用的 Google 授權程式庫

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);
}

移除實體

Node.js

本程式碼使用 Node.js 適用的 Google 驗證程式庫

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

這個程式碼使用 Python 專用的 Google 驗證程式庫

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

此程式碼使用 Java 專用的 Google 授權程式庫

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));
}

用途

以下是增量更新、完整動態饋給更新,以及 API 呼叫中高層級內容的範例:

情境 頂層實體 說明和影響
停用服務 DisabledService

您需要基於不可預測的原因停用服務。

逐步更新:傳送問題中的 Service 實體,並將 @type 變更為 DisabledService,但其他屬性保持不變。

完整動態饋給:請務必在 Google 下次擷取前,從完整動態饋給更新實體,將 @type 設為 DisabledService,否則系統會重新啟用實體。

特定商品缺貨 Menu 增量更新:傳送封裝的 Menu 實體,其中 offer.inventoryLevel 已設為給定 MenuItem 的 0,所有其他資料均保持不變。
菜單項目價格異動 Menu 增量更新:傳送封裝的 Menu 實體,其中 offer.price 設為指定 MenuItem 的更新價格,所有其他資料均保持不變。

新增頂層實體

僅適用於 MenuRestaurantService 類型的實體。

MenuRestaurantService

例如,你需要為餐廳新增菜單。

逐步更新:傳送新的選單實體,以及餐廳實體,並相應更新其欄位 hasMenu

永久刪除頂層實體

僅適用於 MenuRestaurantService 類型的實體。

MenuRestaurantService

分批更新:傳送明確刪除

完整動態饋給:請務必在 Google 下次擷取前,從完整動態饋給中移除實體,否則系統會重新加入實體。

在特定 Service 中新增運送區域 Service 動態饋給增量資料:傳送相關 Service 實體,並保留所有欄位,就像在完整動態饋給中傳送資料一樣。在 ServiceareaServed 中指定新的放送區域。
更新 Service 的預估送達時間 Service 漸進式動態饋給:傳送的 Service 與動態饋給中的相同,但其 hoursAvailable.deliveryHours 會依據情況更新。
更新 Service 中的運送價格 Service 增量動態饋給:傳送完整的 Service,並更新 offers.priceSpecification.price
Service 中更新外送或外帶營業時間 Service 漸進式動態饋給:傳送的 Service 與動態饋給中的相同,但其 hoursAvailable 會依據情況更新。
Service (變更最低訂單金額) Service 動態饋給增量資料:傳送已更新的 Service.offers.priceSpecification.eligibleTransactionVolume 和完整 Service
永久刪除 MenuItem Menu 漸進式動態饋給:傳送的 Menu 與動態饋給中的相同,但此 MenuItem 已從 hasMenuItems 清單中移除。

批次工作和增量更新的處理時間服務等級目標

透過批次或增量更新新增的實體會在 1 到 2 天內處理完畢。透過批次更新或刪除的實體會在 2 小時內處理完畢,而透過增量更新的實體則會在 5 分鐘內處理完畢。過時實體會在 7 天內刪除。

您可以傳送下列資料給 Google:

  • 每天執行多個批次工作,以便隨時更新商品目錄,或
  • 每天執行一次批次作業和增量 API,確保商品目錄保持最新狀態。