このセクションでは、時間に敏感なフィードの更新を Google に送信する方法について説明します。Incremental Updates API を使用すると、フィードのエンティティをほぼリアルタイムで更新および削除できます。
この機能は主に、緊急の閉鎖など、予測できない更新を対象としています。原則として、Incremental Updates API を介して送信される変更は、1 週間以内に公開される必要があります。変更をすぐに反映する必要がない場合は、代わりにバッチ更新を使用できます。増分更新は 5 分以内に処理されます。
セットアップ
増分更新を実装する手順は次のとおりです。
- プロジェクトを作成して設定するの手順に沿ってプロジェクトを作成します。
- サービス アカウントを設定するの手順に沿って、サービス アカウントを作成します。サービス アカウントに「編集者」ロールを追加するには、プロジェクトの「オーナー」である必要があります。
- (省略可、推奨)API の呼び出し時に OAuth 2.0 の使用を容易にするため、任意の言語で Google クライアント ライブラリをインストールします。以下のコードサンプルでは、これらのライブラリを使用しています。それ以外の場合は、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(v2 インベントリ スキーマのみ): 更新するデータフィード内のオブジェクトのエンティティ タイプ(
@type
プロパティ)。 - ENTITY_ID: ペイロードに含まれるエンティティの ID。エンティティ ID を URL エンコードしてください。
- DELETE_TIME(削除エンドポイントのみ): システムでエンティティが削除された時刻を示すオプション フィールド(デフォルトはリクエストの受信時)。時間値に将来の日付を指定することはできません。増分呼び出しでエンティティを送信する場合、エンティティのバージョニングは、削除呼び出しの場合にも
delete_time
フィールドを使用します。この値をyyyy-mm-ddTHH:mm:ssZ
としてフォーマットする
たとえば、v2 広告枠スキーマを使用する ID が「delivery-provider-id」のプロジェクトがあるとします。レストランのエンティティ タイプが「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/apps/
ではなく /v2/sandbox/apps/
にリクエストを送信します。たとえば、v2 インベントリ スキーマのサンドボックス削除リクエストの構造は次のとおりです。
https://actions.googleapis.com/v2/sandbox/apps/PROJECT_ID/entities/TYPE/ENTITY_ID?entity.vertical=FOODORDERING&delete_time=DELETE_TIME
更新と追加
1 日のバッチフィードには、この API を通じて送信された変更も含める必要があります。そうしないと、バッチ更新によって増分変更が上書きされます。
ペイロード
各 POST リクエストには、リクエスト パラメータと、在庫スキーマにリストされているエンティティ タイプの構造化データを含む 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 が含まれる必要があり、フィードは v1 広告在庫スキーマを使用します。
次のようなバッチフィードを検討してください。
{ "@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" } }
エンティティの追加
エンティティを追加する場合は、広告枠の更新を使用しないでください。代わりに、v2 広告枠スキーマで説明されているように、バッチフィード プロセスを使用してください。
エンティティの削除
最上位エンティティを削除するには、少し変更したエンドポイントを使用し、リクエストで HTTP POST ではなく HTTP DELETE を使用します。
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: サブエンティティの削除
最上位エンティティ内からサブエンティティを削除するには、対応するフィールドからサブエンティティを削除した最上位エンティティを送信します。次の例では、フィードで v1 広告枠スキーマが使用されていることを前提としています。
たとえば、サービス提供地域を削除するには、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\""
}
]
}
]
}
}
コードサンプル
以下に、さまざまな言語で Incremental Updates API を使用する方法のサンプルを示します。これらのサンプルでは Google Auth ライブラリを使用しており、v1 広告枠スキーマを使用したフィードを前提としています。その他のソリューションについては、サーバー間アプリケーションに 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 Auth ライブラリを使用します。
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 Auth ライブラリを使用します。
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 |
予期しない理由でサービスを無効にする必要があります。 増分更新: 問題の 完全なフィード: Google による次回の取得前に、完全なフィードからエンティティを更新して |
特定の商品が在庫切れである | Menu |
増分アップデート: 指定された MenuItem の offer.inventoryLevel を 0 に設定し、他のすべてのデータを変更せずに、カプセル化された Menu エンティティを送信します。 |
メニュー項目の価格変更 | Menu |
増分更新: offer.price を特定の MenuItem の更新された価格に設定し、他のすべてのデータを変更せずに、カプセル化された Menu エンティティを送信します。 |
新しいトップレベル エンティティを追加する
|
Menu 、Restaurant 、Service |
たとえば、レストランに新しいメニューを追加する必要がある場合です。 増分更新: 新しいメニュー エンティティと、フィールド |
最上位エンティティを完全に削除する
|
Menu 、Restaurant 、Service |
増分アップデート: 明示的な削除を送信します。 完全なフィード: Google による次回の取得の前に、完全なフィードからエンティティを削除してください。削除しないと、エンティティが再び追加されます。 |
特定の Service に新しい配送エリアを追加する |
Service |
増分フィード: 通常の完全なフィード内と同様に、対象の Service エンティティをすべてのフィールドをそのまま送信します。新しい配信エリアは Service の areaServed 内に指定します。 |
Service の配達予定日時を更新する |
Service |
増分フィード: hoursAvailable.deliveryHours が適宜更新される点を除き、フィードと同じ Service を送信します。 |
Service の配送料を更新する |
Service |
増分フィード: offers.priceSpecification.price が更新された完全な Service を送信します。 |
Service でデリバリーまたはテイクアウトの営業時間を更新する |
Service |
増分フィード: hoursAvailable が適宜更新される点を除き、フィードと同じ Service を送信します。 |
Service (最小注文金額を変更) |
Service |
増分フィード: Service.offers.priceSpecification.eligibleTransactionVolume が更新された完全な Service を送信します。 |
MenuItem を完全に削除 |
Menu |
増分フィード: フィードと同じ Menu を送信しますが、この MenuItem は hasMenuItems リストから削除します。 |
バッチジョブと増分更新の処理時間に関する SLO
バッチまたは増分更新で追加されたエンティティは、1 ~ 2 日以内に処理されます。バッチで更新または削除されたエンティティは 2 時間で処理されますが、増分更新で更新されたエンティティは 5 分で処理されます。古いエンティティは 7 日後に削除されます。
Google に送信できる書類は次のとおりです。
- 在庫を最新の状態に保つために 1 日に複数のバッチジョブを実行する、または
- 1 日 1 回のバッチジョブと増分 API を使用して、在庫を最新の状態に保つ。