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

v2 の在庫増分更新

このセクションでは、広告枠エンティティのタイムリーな更新を Google に送信する方法について説明します。増分更新 API を使用すると、サンドボックスまたは本番環境の広告枠で更新をプッシュしたり、エンティティを削除したりできます。この処理はほぼリアルタイムで実行されます。

この機能は主に、緊急の閉鎖など、予測できない更新を対象としています。原則として、Incremental Update API を介して送信される変更は、1 時間以内に公開される必要があります。変更をすぐに反映する必要がない場合は、代わりにバッチ取り込みを使用できます。増分更新は 5 分以内に処理されます。

前提条件

増分アップデートを実装する前に、次の準備が必要です。

Actions プロジェクトに対する編集者のロールを持つサービスアカウントが作成されます。詳細については、プロジェクトを作成して設定するをご覧ください。
本番環境またはサンドボックスのデータフィードがホストされ、取り込まれます。詳細については、バッチ取り込みをご覧ください。
（省略可、推奨）API の呼び出し時に OAuth 2.0 の使用を容易にするため、任意の言語で Google クライアントライブラリをインストールします。以下のコードサンプルでは、これらのライブラリを使用しています。それ以外の場合は、OAuth 2.0 を使用して Google API にアクセスするで説明されているように、トークン交換を手動で処理する必要があります。

エンドポイント

以下のリクエストで、次のように置き換えます。

PROJECT_ID: プロジェクトを作成して設定するで作成したプロジェクトに関連付けられている Google Cloud プロジェクト ID。
TYPE: 更新するデータフィード内のオブジェクトのエンティティタイプ（@type プロパティ）。
ENTITY_ID（削除エンドポイントのみ）: 削除するエンティティの ID。エンティティ ID を URL エンコードしてください。
DELETE_TIME（削除エンドポイントのみ）: システムでエンティティが削除された時刻を示すオプションフィールド（デフォルトはリクエストの受信時）。時間値に将来の日付を指定することはできません。増分呼び出しでエンティティを送信する場合、エンティティのバージョニングは、削除呼び出しの場合にも delete_time フィールドを使用します。この値を yyyy-mm-ddTHH:mm:ssZ としてフォーマットする

エンドポイントの更新

エンティティを変更するには、次のエンドポイントに対して HTTP POST リクエストを行い、更新と追加のペイロードを含めます。1 回の API 呼び出しで最大 1,000 個のエンティティを更新できます。

https://actions.googleapis.com/v2/apps/PROJECT_ID/entities:batchPush

たとえば、ID が「delivery-provider-id」のプロジェクト内のエンティティを更新する場合、エンドポイントは次のようになります。

https://actions.googleapis.com/v2/apps/delivery-provider-id/entities:batchpush

エンドポイントの削除

インベントリ内のエンティティを削除するには、次のエンドポイントに HTTP DELETE リクエストを送信します。

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

たとえば、ID が「menuSection_122」の「MenuSection」エンティティを「delivery-provider-id」プロジェクトから削除するには、次の HTTP DELETE API 呼び出しを行います。

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

サンドボックス環境

サンドボックスインベントリで Incremental Update API を使用するには、上記のエンドポイントのガイダンスに沿って、/v2/apps/ ではなく /v2/sandbox/apps/ にリクエストを送信します。

https://actions.googleapis.com/v2/sandbox/apps/PROJECT_ID/entities:batchPush

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

エンティティの更新

各 POST リクエストには、リクエストパラメータと、在庫スキーマにリストされているエンティティタイプの構造化データを含む JSON ペイロードを含める必要があります。

ペイロードを更新する

JSON はバッチフィードと同じように表示されますが、次の点が異なります。

ペイロード本文のサイズは 5 MB を超えないようにしてください。バッチフィードと同様に、より多くのデータを収集できるように空白文字を削除することをおすすめします。
エンベロープは次のとおりです。

{
  "requests": [
    {
      "entity": {
        "data":"ENTITY_DATA",
        "name": "apps/project_id>/entities/type/entity_id"
      },
      "update_time":"UPDATE_TIMESTAMP"
    },
  ],
  "vertical": "FOODORDERING"
}

上記のペイロードで、次のように置き換えます。

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/sandbox/apps/provider-project/entities:batchPush
Host: actions.googleapis.com
Content-Type: application/ld+json
{
  "requests": [
    {
      "entity": {
        "name": "apps/provider-project/entities/restaurant/restaurant12345",
        "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 回の API 呼び出しで 2 つのレストランエンティティを更新するには、HTTP POST リクエストは次のようになります。

POST v2/sandbox/apps/provider-project/entities:batchPush
Host: actions.googleapis.com
Content-Type: application/ld+json
{
  "requests": [
    {
      "entity": {
        "name": "apps/provider-project/entities/restaurant/restaurant12345",
        "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
        }
      }
    },
    {
      "entity": {
        "name": "apps/provider-project/entities/restaurant/restaurant123",
        "data": {
          "@type": "Restaurant",
          "@id": "restaurant123",
          "name": "Some Other Restaurant",
          "url": "https://www.provider.com/somerestaurant",
          "telephone": "+16501231235",
          "streetAddress": "385 Spear St",
          "addressLocality": "San Mateo",
          "addressRegion": "CA",
          "postalCode": "94115",
          "addressCountry": "US"
        }
      }
    }
  ]
  "vertical": "FOODORDERING"
}

例 3: メニューアイテムの価格を更新する

メニューアイテムの価格を変更する必要がある場合を考えてみましょう。例 1 と同様に、更新には最上位エンティティ（メニュー）全体の JSON が含まれる必要があり、フィードは v1 広告在庫スキーマを使用します。

次のようなバッチフィードを検討してください。

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

次に、POST による増分更新は次のようになります。

POST v2/sandbox/apps/provider-project/entities:batchPush
Host: actions.googleapis.com
Content-Type: application/ld+json
{
  "requests": [
    {
      "entity": {
        "name": "apps/provider-project/entities/menuitemoffer/menuitemoffer6680262",
        "data": {
          "@type": "MenuItemOffer",
          "@id": "menuitemoffer6680262",
          "sku": "offer-cola",
          "menuItemId": "menuitem896532",
          "price": 1.00,
          "priceCurrency": "USD"
        },
        "vertical": "FOODORDERING"
      }
    }
  ]
  "vertical": "FOODORDERING"
}

エンティティの追加

エンティティを追加する場合は、広告枠の更新を使用しないでください。代わりに、v2 広告枠スキーマで説明されているように、バッチフィードプロセスを使用してください。

エンティティの削除

最上位エンティティを削除するには、少し変更したエンドポイントを使用し、リクエストで HTTP POST ではなく HTTP DELETE を使用します。

最上位エンティティの削除

フィードのレストランを削除するとします。サービスとメニューも削除する必要があります。

ID が「provider/restaurant/menu/nr」のメニューエンティティのサンプルエンドポイント:

DELETE v2/apps/delivery-provider-id/entities/menu/provider%2Frestaurant%2Fmenu%2Fnr?entity.vertical=FOODORDERING
Host: actions.googleapis.com

ID が「https://www.provider.com/restaurant/nr」のレストランエンティティのサンプルエンドポイント:

DELETE v2/apps/delivery-provider-id/entities/restaurant/provider%2Frestaurant%2Fnr?entity.vertical=FOODORDERING
Host: actions.googleapis.com

ID が「https://www.provider.com/restaurant/service/nr」のサービスエンティティのサンプルエンドポイント:

DELETE v2/apps/delivery-provider-id/entities/service/provider%2Frestaurant%2Fservice%2Fnr?entity.vertical=FOODORDERING
Host: actions.googleapis.com
}

サブエンティティの削除

HTTP DELETE を使用して、トップレベルエンティティ内のサブエンティティ（メニュー内のメニュー項目など）を削除しないでください。代わりに、サブエンティティの削除を、サブエンティティが関連リストまたはreverseReference から削除される最上位エンティティの更新として扱います。

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 Update 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 = 'your/entity/id'
const PROJECT_ID = 'type/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(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:batchPush`,
    body: {
      requests: [
        {
          entity: {
            data: JSON.stringify(entity)
            name: `apps/${PROJECT_ID}/entities/${ENTITY_ID}`
          }
        }
      ],
      vertical: 'FOODORDERING'
    },
    json: true
  },
  (err, res, body) => {
    if (err) { return console.log(err); }
    console.log(`Response: ${JSON.stringify(res)}`)
  })
}

updateEntity(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 = 'type/your/entity/id'

ENDPOINT = 'https://actions.googleapis.com/v2/apps/%s/entities:batchPush' % (
    PROJECT_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()

entity = {}
entity['data'] = data #entity JSON-LD serialized as string
entity['name'] = 'apps/%s/entities/%s' % (PROJECT_ID, urllib.quote(ENTITY_ID, '') )

# Populating the request
request = {}
request['entity'] = entity
requestArray = [request]

# Populating the payload
payload = {}
payload['requests'] = requestArray
payload['vertical'] = 'FOODORDERING'

response = authed_session.post(ENDPOINT, json=payload)

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 = "type/your-entity-id";

/**
 * 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 data) {
  String authToken = getAuthToken();
  String endpoint = String.format("https://actions.googleapis.com/v2/apps/%s/entities/:batchPush", PROJECT_ID);

  JSONObject entity = new JSONObject();
  entity.put("data", data.toString());
  entity.put("name", String.format("apps/%s/entities/%s", PROJECT_ID, URLEncoder.encode(ENTITY_ID, "UTF-8")));

  JSONObject request = new JSONObject();
  request.put("entity", entity);

  JSONArray requestArray = new JSONArray();
  requestArray.put(request);

  JSONObject payload = new JSONObject();
  payload.put("requests", requestArray);
  payload.put("vertical", FOODORDERING);

  // Execute POST request
  executePostRequest(endpoint, authToken, payload);
}

エンティティの削除

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 呼び出しの概要のコンテンツの例です。

シナリオ	更新するエンティティ	説明と影響
サービスの無効化	`Service`	予期しない理由でサービスを無効にする必要があります。増分更新: 対象の `Service` エンティティの `isDisabled` プロパティを `true` に設定して更新しますが、他のプロパティは変更しません。完全なフィード: Google による次回の取得前に、完全なフィードからエンティティを更新して `isDisabled` を `true` に設定してください。設定しない場合、エンティティは再度有効になります。
特定の商品が在庫切れである	`MenuItemOffer`	増分アップデート: 指定された `MenuItem` の `inventoryLevel` を 0 に設定し、他のすべてのデータを変更せずに、カプセル化された `MenuItemOffer` エンティティを送信します。
メニュー項目の価格変更	`MenuItemOffer`	増分更新: `price` を特定の `MenuItem` の更新された価格に設定し、他のすべてのデータを変更せずに、カプセル化された `MenuItemOffer` エンティティを送信します。
新しいトップレベルエンティティを追加する `Menu`、`Restaurant`、`Service` タイプのエンティティにのみ適用されます。	`Menu`、`Restaurant`、`Service`	たとえば、レストランに新しいメニューを追加する必要がある場合です。完全なフィード: データフィードにエンティティを追加し、バッチ取り込みを待機します。
最上位エンティティを完全に削除する `Menu`、`Restaurant`、`Service` タイプのエンティティにのみ適用されます。	`Menu`、`Restaurant`、`Service`	増分アップデート: 明示的な削除を送信します。完全なフィード: Google による次回の取得の前に、完全なフィードからエンティティを削除してください。削除しないと、エンティティが再び追加されます。
特定の `Service` に新しい配送エリアを追加する	`ServiceArea`	増分フィード: 通常の完全なフィード内と同様に、対象の `ServiceArea` エンティティをすべてのフィールドをそのまま送信します。`polygon`、`geoRadius`、または `postalCode` 内に新しい配信エリアを指定します。
`Service` の配達予定日時を更新する	`ServiceHours`	増分フィード: `leadTimeMin` が適宜更新される点を除き、フィードと同じ `ServiceHours` を送信します。
`Service` の配送料を更新する	`Fee`	増分フィード: `price` が更新された完全配信 `Fee` を送信します。
`Service` でデリバリーまたはテイクアウトの営業時間を更新する	`ServiceHours`	増分フィード: `opens` プロパティと `closes` プロパティが適宜更新される点を除き、フィードと同じ `ServiceHours` を送信します。
`Service`（最小注文金額を変更）	`Fee`	増分フィード: `minPrice` が更新された完全な `Fee` を送信します。
`MenuItem` を完全に削除する	`Menu`	増分フィード: フィードと同じ `MenuItem` を送信しますが、`parentMenuSectionId` は空にします。

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

バッチで更新または削除されたエンティティは、ベストエフォートモードで 2 時間以内に処理されます。一方、増分更新で更新されたエンティティは 5 分で処理されます。古いエンティティは 7 日後に削除されます。

Google に送信できる書類は次のとおりです。

在庫を最新の状態に保つために 1 日に複数のバッチジョブを実行する、または
1 日 1 回のバッチジョブと増分 API を使用して、在庫を最新の状態に保つ。

v2 の在庫増分更新

前提条件

エンドポイント

エンドポイントの更新

エンドポイントの削除

サンドボックス環境

エンティティの更新

ペイロードを更新する

例

例 1: レストランの更新

例 2: 複数のレストランを更新する

例 3: メニューアイテムの価格を更新する

エンティティの追加

エンティティの削除

最上位エンティティの削除

サブエンティティの削除

API レスポンス コード

コードサンプル

エンティティの更新

Node.js

Python

Java

エンティティの削除

Node.js

Python

Java

ユースケース

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

API レスポンスコード