このページは Cloud Translation API によって翻訳されました。

v1 の増分在庫の更新

このセクションでは、時間的制約のあるフィードの更新を GoogleIncremental Updates API を使用すると、フィードをほぼリアルタイムで提供します。

この機能は主に、予測できないアップデート、防ぐことができます原則として、 Incremental Updates API は、最大 1 週間。変更を直ちに反映する必要がない場合は、バッチアップデートを使用してください。増分アップデートはできます。

セットアップ

増分アップデートを実装する手順は次のとおりです。

プロジェクトの作成と設定の手順に沿って、以下を行います。プロジェクトを作成します。
サービスアカウントを設定するで説明されている手順に沿って操作します。サービスアカウントを作成します。なお、管理者は「オーナー」である必要があります「編集者」ロールを追加サービスアカウントのロール
（省略可、推奨）Google クライアントライブラリをインストールします。を呼び出して、OAuth 2.0 を API以下のコードサンプルでは、これらのライブラリを使用しています。そうでない場合は、 OAuth 2.0 を使用した Google API へのアクセスで説明されているように、トークン交換を手動で処理する必要がある。

エンドポイント

Google にアップデートを通知するには、増分リクエストに対する HTTP POST リクエストを API を更新し、更新と追加のペイロードを含めます。使用するインベントリスキーマによって、リクエストを行うエンドポイントが決まります。

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 呼び出しの場合に delete_time フィールドも使用します。これをフォーマット yyyy-mm-ddTHH:mm:ssZ の値

たとえば、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

更新と追加

毎日のバッチフィードには、このフォームを通じて送信される変更も含める必要があります。 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: レストランの更新

レストランの電話番号を緊急に更新する必要があるとします。お客様の update にはレストラン全体の 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 と同様に、 update には、トップレベルエンティティ全体（メニュー）の 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: 最上位エンティティを削除する

たとえば、使用します。このサービスとメニューも削除する必要があります。

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

コードサンプル

以下に、増分アップデート API をさまざまなアプリケーションで使用する方法を示すサンプルを示します。対応しています。このサンプルでは Google Auth ライブラリを使用します。使用します。その他の解決策については、サーバー間アプリケーションに 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` ですが、他のプロパティは変更しないでください。完全なフィード: 完全なフィードからエンティティを更新してください `@type` を `DisabledService` に設定する行われない場合、エンティティは再び有効になります。
特定の商品が在庫切れの場合	`Menu`	増分アップデート: カプセル化されている `Menu` を送信する特定のエンティティに対して `offer.inventoryLevel` が 0 に設定されている `MenuItem`、その他すべてのデータは変更されていません。
メニュー項目の価格変更	`Menu`	増分アップデート: カプセル化されている `Menu` を送信する指定された商品の更新価格を `offer.price` に設定したエンティティ `MenuItem`、その他すべてのデータは変更されていません。
新しいトップレベルエンティティを追加 `Menu` タイプのエンティティにのみ適用されます。 `Restaurant`、`Service`。	`Menu`、`Restaurant`、`Service`	たとえば、レストランに新しいメニューを追加する必要があるとします。増分更新: レストランとともに新しいメニューエンティティを送信するフィールド `hasMenu` を持つエンティティが、適宜更新されます。
最上位エンティティを完全に削除する `Menu` タイプのエンティティにのみ適用されます。 `Restaurant`、`Service`。	`Menu`、`Restaurant`、`Service`	増分アップデート: 明示的な削除。完全なフィード: 完全なフィードからエンティティを削除する前に、取得されない場合、エンティティは再度追加されます。
特定の`Service`に新しい配送地域を追加する	`Service`	増分フィード: 該当する `Service` エンティティとそのすべてのエンティティをフィールドはそのままにします。完全なフィードの場合と同様に、新しい配送地域 `Service` の `areaServed` 内で指定されます。
配達予定到着時刻（`Service`）を更新します	`Service`	増分フィード: 以前と同じように `Service` を送信します。フィード（`hoursAvailable.deliveryHours` が更新された場合を除く）必要があります。
`Service`の送料を更新	`Service`	増分フィード: 次の形式で完全な `Service` を送信します: `offers.priceSpecification.price` を更新しました。
`Service`のデリバリーまたはテイクアウトの営業時間を更新	`Service`	増分フィード: 以前と同じように `Service` を送信します。フィード（`hoursAvailable` が更新された場合を除く）必要があります。
`Service`（最低注文額を変更）	`Service`	増分フィード: 次の形式で完全な `Service` を送信します: `Service.offers.priceSpecification.eligibleTransactionVolume` 更新
`MenuItem` を完全に削除	`Menu`	増分フィード:`Menu` フィードですが、この `MenuItem` は `hasMenuItems` リスト。

バッチジョブと増分更新の処理時間に関する SLO

バッチアップデートまたは増分アップデートで追加されたエンティティは、 1 ～ 2 日。バッチで更新または削除されたエンティティは 2 秒で処理されます増分更新によって更新されたエンティティは 5 分で終わります古いエンティティは 7 日後に削除されます。

次のいずれかの方法で Google に送信してください。

在庫を最新の状態に保つために、1 日あたり複数のバッチジョブ。または
1 日に 1 つのバッチジョブと、インベントリを最新の状態に保つ増分 API があります。

v1 の増分在庫の更新

セットアップ

エンドポイント

v2 広告枠

v1 広告枠

v2 広告枠

v1 広告枠

サンドボックス リクエスト

更新と追加

ペイロード

エンティティの更新

例 1: レストランの更新

例 2: メニュー項目の価格を更新する

エンティティの追加

エンティティの削除

例 1: 最上位エンティティを削除する

例 2: サブエンティティの削除

API レスポンス コード

コードサンプル

エンティティの更新

Node.js

Python

Java

エンティティの削除

Node.js

Python

Java

ユースケース

バッチジョブと増分更新の処理時間に関する SLO

サンドボックスリクエスト

API レスポンスコード