v1 इंक्रीमेंटल इन्वेंट्री अपडेट

इस सेक्शन में बताया गया है कि Google को, किसी फ़ीड के ऐसे अपडेट कैसे भेजे जा सकते हैं जो किसी तय समय पर अपडेट किए जा सकते हैं. इंक्रीमेंटल अपडेट एपीआई से आपको करीब-करीब रीयल टाइम में अपने फ़ीड में मौजूद इकाइयों को अपडेट करने और मिटाने की सुविधा मिलती है.

यह सुविधा मुख्य रूप से ऐसे अपडेट के लिए है जिनका पता नहीं लगाया जा सकता. जैसे, आपातकाल में बंद होना. नियम के मुताबिक, इंक्रीमेंटल अपडेट एपीआई की मदद से सबमिट किया गया कोई भी बदलाव, एक हफ़्ते से ज़्यादा समय तक लाइव होने चाहिए. अगर आपके बदलाव को तुरंत दिखाने की ज़रूरत नहीं है, तो बैच अपडेट का इस्तेमाल किया जा सकता है. इंक्रीमेंटल अपडेट पांच मिनट से ज़्यादा में प्रोसेस नहीं किए जाते.

सेटअप

बढ़ते हुए अपडेट लागू करने के लिए, ये काम करें:

  1. प्रोजेक्ट बनाने के लिए, प्रोजेक्ट बनाएं और उसे सेट अप करना में बताया गया तरीका अपनाएं.
  2. सेवा खाता बनाने के लिए, सेवा खाता सेट अप करें में बताए गए तरीके अपनाएं. ध्यान दें, सेवा खाते में "एडिटर" की भूमिका जोड़ने के लिए, यह ज़रूरी है कि आप प्रोजेक्ट के "मालिक" हों
  3. (ज़रूरी नहीं, लेकिन इसका सुझाव दिया जाता है) एपीआई को कॉल करते समय, OAuth 2.0 का इस्तेमाल करने की सुविधा देने के लिए, अपनी पसंद की भाषा में Google क्लाइंट लाइब्रेरी इंस्टॉल करें. नीचे दिए गए कोड सैंपल, इन लाइब्रेरी का इस्तेमाल करते हैं. अगर ऐसा नहीं है, तो आपको Google API ऐक्सेस करने के लिए OAuth 2.0 का इस्तेमाल करना में बताए गए तरीके से टोकन एक्सचेंज को मैन्युअल तरीके से मैनेज करना होगा.

एंडपॉइंट

Google को किसी अपडेट के बारे में सूचना देने के लिए, इंक्रीमेंटल अपडेट एपीआई को एचटीटीपी पोस्ट अनुरोध भेजें और अपडेट और नई चीज़ें जोड़ने का पेलोड शामिल करें. आपके इस्तेमाल किए जाने वाले इन्वेंट्री स्कीमा से यह तय होता है कि आपको किस एंडपॉइंट पर अनुरोध करना है:

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

किसी इकाई को हटाने के लिए, नीचे दिए गए एंडपॉइंट से एचटीटीपी मिटाने का अनुरोध करें. यह अनुरोध, इस्तेमाल किए जा रहे इन्वेंट्री स्कीमा से मेल खाता है:

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 प्रोजेक्ट आईडी.
  • TYPE (सिर्फ़ v2 इन्वेंट्री स्कीमा के लिए): आपके डेटा फ़ीड में मौजूद उस ऑब्जेक्ट का इकाई टाइप (@type प्रॉपर्टी) जिसे आपको अपडेट करना है.
  • ENTITY_ID: पेलोड में शामिल इकाई का आईडी. पक्का करें कि यूआरएल को इकाई आईडी को कोड में बदला गया हो.
  • DELETE_TIME (सिर्फ़ एंडपॉइंट मिटाएं): यह वैकल्पिक फ़ील्ड है. यह फ़ील्ड आपके सिस्टम पर इकाई के मिटाए जाने का समय बताता है (अनुरोध मिलने पर डिफ़ॉल्ट रूप से इसे मिटाया जाता है). समय का मान भविष्य में नहीं होना चाहिए. इंक्रीमेंटल (बढ़ने वाले) कॉल से कोई इकाई भेजते समय, इकाई का वर्शन बनाने की प्रक्रिया, मिटाए गए कॉल के मामले में भी delete_time फ़ील्ड का इस्तेमाल करती है. इस वैल्यू को yyyy-mm-ddTHH:mm:ssZ के तौर पर फ़ॉर्मैट करें

उदाहरण के लिए, आपके पास "delivery-provider-id" आईडी वाला एक प्रोजेक्ट है, जो v2 इन्वेंट्री स्कीमा का इस्तेमाल करता है. आपको रेस्टोरेंट में बदलाव करने के लिए, "मेन्यूसेक्शन" का एक टाइप और "मेन्यूसेक्शन_122" का इकाई आईडी होने पर, रेस्टोरेंट की इकाई में बदलाव करने होंगे. आपके डेटा के अपडेट का एंडपॉइंट यह होगा:

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

इस इकाई को हटाने के लिए, आपको यह एचटीटीपी DELETE API कॉल करना होगा:

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

सैंडबॉक्स से जुड़े अनुरोध

सैंडबॉक्स अनुरोधों के लिए, ऊपर दिए गए Endpoint में दिए गए दिशा-निर्देशों का पालन करें. हालांकि, /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

अपडेट और जोड़ी गई चीज़ें

आपके रोज़ाना के बैच फ़ीड में भी, इस एपीआई की मदद से सबमिट किए गए बदलाव शामिल होने चाहिए. ऐसा न करने पर, आपके बैच अपडेट, बदलावों को ओवरराइट कर देंगे.

पेलोड

हर पीओएसटी अनुरोध में, JSON पेलोड के साथ अनुरोध पैरामीटर भी शामिल होने चाहिए. इन पेलोड में, इन्वेंट्री स्कीमा में शामिल किसी भी तरह की इकाई का स्ट्रक्चर्ड डेटा शामिल होना चाहिए.

JSON, नीचे दिए गए अंतर के साथ बैच फ़ीड में वैसा ही दिखना चाहिए जैसा कि बैच में दिखता है:

  • पेलोड के मुख्य हिस्से का साइज़ 5 एमबी से ज़्यादा नहीं होना चाहिए. इसी तरह बैच फ़ीड के लिए, हमारा सुझाव है कि ज़्यादा डेटा लगाने के लिए, आप खाली सफ़ेद जगहों को हटा दें.
  • लिफ़ाफ़ा इस तरह का है:
{
  "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
}

फिर एचटीटीपी पोस्ट के ज़रिए इंक्रीमेंटल अपडेट इस तरह से होगा:

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

दूसरा उदाहरण: मेन्यू आइटम की कीमत अपडेट करना

मान लें कि आपको एक मेन्यू आइटम की कीमत बदलनी है. उदाहरण 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 इन्वेंट्री स्कीमा में बताए गए तरीके से बैच फ़ीड प्रोसेस इस्तेमाल करें.

किसी इकाई को हटाना

टॉप-लेवल इकाइयों को हटाने के लिए, आपको अनुरोध में थोड़ा बदलाव करके बनाए गए एंडपॉइंट का इस्तेमाल करना चाहिए. साथ ही, एचटीटीपी पोस्ट के बजाय एचटीटीपी DELETE का इस्तेमाल करना चाहिए.

किसी टॉप लेवल इकाई, जैसे कि मेन्यू में मेन्यू आइटम, में मौजूद किसी सब-इकाई को हटाने के लिए एचटीटीपी डिलीट का इस्तेमाल न करें. इसके बजाय, उप-इकाइयों को हटाए जाने को किसी टॉप-लेवल इकाई के अपडेट के तौर पर देखें, जिसमें उप-इकाई को उससे जुड़ी सूची या पैरामीटर से हटा दिया गया हो.

पहला उदाहरण: टॉप लेवल की इकाई मिटाना

ऐसी स्थिति के बारे में सोचें जिसमें आप फ़ीड में मौजूद ऐसे रेस्टोरेंट को मिटाना चाहें जो v1 इन्वेंट्री स्कीमा का इस्तेमाल करता हो. आपको इसकी सेवाएं और मेन्यू भी मिटाने होंगे.

किसी मेन्यू इकाई के लिए आईडी वाला सैंपल एंडपॉइंट "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

किसी रेस्टोरेंट की इकाई के लिए आईडी वाला सैंपल एंडपॉइंट "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

आईडी वाली सेवा इकाई के लिए सैंपल एंडपॉइंट "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"
  }
}

एपीआई रिस्पॉन्स कोड

कॉल हो जाने का यह मतलब नहीं है कि फ़ीड मान्य या सही है. इसका मतलब सिर्फ़ एपीआई कॉल किया गया है. पूरे होने वाले कॉल को खाली रिस्पॉन्स वाले हिस्से के साथ एचटीटीपी रिस्पॉन्स कोड 200 मिलता है:

{}

गड़बड़ी होने पर, एचटीटीपी रिस्पॉन्स कोड 200 नहीं होगा. साथ ही, रिस्पॉन्स का मुख्य हिस्सा दिखाता है कि क्या गड़बड़ी हुई है.

उदाहरण के लिए, अगर उपयोगकर्ता ने लिफ़ाफ़े में "वर्टिकल" वैल्यू को 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\""
          }
        ]
      }
    ]
  }
}

कोड सैंपल

नीचे अलग-अलग भाषाओं में इंक्रीमेंटल अपडेट एपीआई को इस्तेमाल करने के कुछ नमूने दिए गए हैं. ये नमूने 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 की पुष्टि करने वाली लाइब्रेरी का इस्तेमाल करता है.

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

इस्तेमाल के उदाहरण

इस्तेमाल के उदाहरण यहां दिए गए हैं: समय के साथ अपडेट होने, फ़ीड के पूरे अपडेट, और एपीआई कॉल में बड़े लेवल पर कॉन्टेंट के उदाहरण:

स्थिति टॉप-लेवल की इकाई ब्यौरा और इफ़ेक्ट
किसी सेवा को बंद करना DisabledService

आपको किसी वजह से सेवा बंद करनी होगी.

इंक्रीमेंटल अपडेट: जिस Service इकाई की शिकायत की गई है उसे DisabledService में बदलकर DisabledService पर भेजें. हालांकि, दूसरी प्रॉपर्टी में कोई बदलाव न करें.@type

पूरी फ़ीड: Google से अगली बार फ़ेच किए जाने से पहले @type को DisabledService पर सेट करने के लिए, पूरे फ़ीड में मौजूद इकाई को अपडेट करना न भूलें. ऐसा न करने पर, इकाई फिर से चालू हो जाएगी.
कोई खास आइटम, स्टॉक में नहीं है Menu इंक्रीमेंटल अपडेट: एनकैप्सुलेटिंग Menu इकाई को भेजें, जिसमें दिए गए MenuItem के लिए offer.inventoryLevel को 0 पर सेट किया गया हो और बाकी डेटा में कोई बदलाव न हुआ हो.
मेन्यू आइटम की कीमत में बदलाव Menu इंक्रीमेंटल अपडेट: एनकैप्सुलेट करने वाली Menu इकाई को offer.price के साथ, दिए गए MenuItem के लिए, अपडेट की गई कीमत पर सेट करें और बाकी डेटा में कोई बदलाव न करें.

टॉप-लेवल की नई इकाई जोड़ें

सिर्फ़ Menu, Restaurant, और Service टाइप की इकाई के लिए लागू है.

 Menu, Restaurant, Service

उदाहरण के लिए, आपको किसी रेस्टोरेंट में नया मेन्यू जोड़ना होगा.

इंक्रीमेंटल अपडेट: नए मेन्यू की इकाई भेजें और रेस्टोरेंट की इकाई और उसके फ़ील्ड hasMenu को भी उसी हिसाब से अपडेट किया जाता है.

टॉप-लेवल की इकाई को हमेशा के लिए मिटाएं

सिर्फ़ Menu, Restaurant, और Service टाइप की इकाई के लिए लागू है.

 Menu, Restaurant, Service

इंक्रीमेंटल अपडेट: किसी अश्लील कॉन्टेंट को मिटाने की सूचना भेजें.

पूरी फ़ीड: Google से अगली बार फ़ेच किए जाने से पहले, इकाई को सभी फ़ीड से ज़रूर हटा दें. ऐसा न करने पर, इकाई को फिर से जोड़ दिया जाएगा.
किसी खास Service में, डिलीवरी की नई जगह जोड़ें Service इंक्रीमेंटल फ़ीड: जिस Service इकाई की शिकायत की गई है उसे उसके सभी फ़ील्ड में बदलाव करके भेजें. ठीक वैसे ही जैसे आप आम तौर पर पूरे फ़ीड में करते हैं. डिलीवरी की जगह की जानकारी Service के areaServed में दी जाती है.
Service में, डिलीवरी का अनुमानित समय अपडेट करें Service इंक्रीमेंटल फ़ीड: Service को वैसा ही भेजें जैसा कि फ़ीड में किया गया है. हालांकि, इसके hoursAvailable.deliveryHours को उसी हिसाब से अपडेट किया जाता है.
Service में डिलीवरी वाली कीमतों को अपडेट करें Service इंक्रीमेंटल फ़ीड: offers.priceSpecification.price अपडेट करके, पूरा Service भेजें.
Service में, डिलीवरी या खाना पैक कराकर ले जाने की सुविधा के खुले होने का समय अपडेट करें Service इंक्रीमेंटल फ़ीड: Service को वैसा ही भेजें जैसा कि फ़ीड में किया गया है. हालांकि, इसके hoursAvailable को उसी हिसाब से अपडेट किया जाता है.
Service (ऑर्डर की कम से कम रकम बदलें) Service इंक्रीमेंटल फ़ीड: अपडेट किए गए Service.offers.priceSpecification.eligibleTransactionVolume साथ ही, पूरा Service भेजें
MenuItem को हमेशा के लिए मिटाएं Menu इंक्रीमेंटल फ़ीड: Menu को फ़ीड की तरह ही भेजें. हालांकि, इस MenuItem को hasMenuItems सूची से हटा दिया जाएगा.

बैच जॉब और इंंक्रीमेंटल अपडेट के लिए, प्रोसेसिंग टाइम में एसएलओ

बैच या इंंक्रीमेंटल अपडेट की मदद से जोड़ी गई इकाई को प्रोसेस करने में, एक से दो दिन लग सकते हैं. किसी इकाई को बैच की मदद से अपडेट किया जाएगा या मिटाया जाएगा, तो उसे दो घंटे में प्रोसेस किया जाएगा. वहीं, इंंक्रीमेंटल अपडेट से अपडेट की गई इकाई को पांच मिनट में प्रोसेस किया जाएगा. पुरानी इकाई को सात दिनों में मिटा दिया जाता है.

Google को इनमें से कोई एक दस्तावेज़ भेजा जा सकता है:

  • आपकी इन्वेंट्री को अप-टू-डेट रखने के लिए, हर दिन एक से ज़्यादा बैच जॉब, या
  • हर दिन एक बैच जॉब और इंक्रीमेंटल एपीआई, जिससे आपकी इन्वेंट्री अप-टू-डेट रहती है.