इन्वेंट्री के अपडेट के लिए, v2 वर्शन

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

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

ज़रूरी शर्तें

इंक्रीमेंटल अपडेट लागू करने से पहले, इन चीज़ों की ज़रूरत होती है:

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

एंडपॉइंट

नीचे दिए गए अनुरोधों में, इनकी जगह ये डालें:

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

एंडपॉइंट अपडेट करना

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

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

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

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

एंडपॉइंट को मिटाएं

अपनी इन्वेंट्री में किसी इकाई को मिटाने के लिए, नीचे दिए गए एंडपॉइंट पर एचटीटीपी DELETE अनुरोध करें.

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

उदाहरण के लिए, अपने "delivery-provider-id" प्रोजेक्ट से, आईडी "menuSection_122" वाली "MenuSection" इकाई को मिटाने के लिए, आपको एचटीटीपी DELETE API कॉल करना होगा:

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

सैंडबॉक्स एनवायरमेंट

अपनी सैंडबॉक्स इन्वेंट्री में इंक्रीमेंटल अपडेट एपीआई का इस्तेमाल करने के लिए, ऊपर दिए गए एंडपॉइंट में दिए गए दिशा-निर्देशों का पालन करें. हालांकि, /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 एमबी से ज़्यादा नहीं होना चाहिए. बैच फ़ीड की तरह ही, हमारा सुझाव है कि ज़्यादा डेटा फ़िट करने के लिए, खाली जगहों को हटाएं.
  • लिफाफा इस तरह का होना चाहिए:
{
  "requests": [
    {
      "entity": {
        "data":"ENTITY_DATA",
        "name": "apps/project_id>/entities/type/entity_id"
      },
      "update_time":"UPDATE_TIMESTAMP"
    },
  ],
  "vertical": "FOODORDERING"
}

ऊपर दिए गए पेलोड में, इनकी जगह ये डालें:

  • ENTITY_DATA: JSON फ़ॉर्मैट में मौजूद इकाई, स्ट्रिंग के तौर पर सीरियलाइज़ की गई. data फ़ील्ड में, JSON-LD इकाई को स्ट्रिंग के तौर पर पास किया जाना चाहिए.
  • UPDATE_TIMESTAMP (ज़रूरी नहीं): आपके सिस्टम में इकाई को अपडेट किए जाने का टाइमस्टैंप. समय की वैल्यू, आगे की नहीं होनी चाहिए. डिफ़ॉल्ट टाइमस्टैंप वह समय होता है जब Google को अनुरोध मिलता है. इंक्रीमेंटल अनुरोध के ज़रिए इकाई भेजते समय, इकाई के वर्शन में जोड़ने/अपडेट करने के अनुरोध के मामले में भी update_time फ़ील्ड का इस्तेमाल किया जाता है.

उदाहरण

पहला उदाहरण: रेस्टोरेंट की जानकारी अपडेट करना

मान लें कि आपको किसी रेस्टोरेंट का फ़ोन नंबर तुरंत अपडेट करना है. आपके अपडेट में, पूरे रेस्टोरेंट का 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/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"
}

दूसरा उदाहरण: एक से ज़्यादा रेस्टोरेंट की जानकारी अपडेट करना

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

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

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

मान लें कि आपको मेन्यू के किसी आइटम की कीमत बदलनी है. पहले उदाहरण की तरह, आपके अपडेट में पूरी टॉप-लेवल इकाई (मेन्यू) का JSON शामिल होना चाहिए. साथ ही, फ़ीड में इन्वेंट्री स्कीमा का वर्शन 1 इस्तेमाल किया जाना चाहिए.

मान लें कि आपके पास ऐसा बैच फ़ीड है जो इस तरह दिखता है:

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

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

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

इकाई हटाना

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

टॉप-लेवल की इकाई मिटाना

मान लें कि आपको किसी फ़ीड में मौजूद रेस्टोरेंट को मिटाना है. आपको इसकी सेवाओं और मेन्यू को भी मिटाना होगा.

आईडी "provider/restaurant/menu/nr" वाली मेन्यू इकाई के लिए सैंपल एंडपॉइंट:

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

आईडी "https://www.provider.com/restaurant/nr" वाले रेस्टोरेंट की इकाई के लिए सैंपल एंडपॉइंट:

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

आईडी "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
}

सब-इकाइयां हटाना

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

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

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

यह कोड, 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 के लिए 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 = '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 के लिए 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.jsPythonJava

यह कोड, 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 के लिए 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 के लिए 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));
}

उपयोग के उदाहरण

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

स्थिति अपडेट की जाने वाली इकाई जानकारी और असर
किसी सेवा को बंद करना Service

आपको किसी अनचाहे बदलाव की वजह से, किसी सेवा को बंद करना हो.

इंक्रीमेंटल अपडेट: Service इकाई की isDisabled प्रॉपर्टी को true पर सेट करके, उसमें बदलाव करें. हालांकि, अन्य प्रॉपर्टी को पहले जैसा ही रखें.

पूरे फ़ीड: पक्का करें कि Google के अगले फ़ेच से पहले, isDisabled को true पर सेट करने के लिए, पूरे फ़ीड से इकाई को अपडेट किया गया हो. ऐसा न करने पर, इकाई फिर से चालू हो जाएगी.

कोई आइटम स्टॉक में नहीं है MenuItemOffer बढ़ोतरी वाले अपडेट: MenuItem के लिए inventoryLevel को 0 पर सेट करके, MenuItemOffer इकाई को कैप्सुलेट करके भेजें. साथ ही, बाकी डेटा में कोई बदलाव न करें.
मेन्यू आइटम की कीमत में बदलाव MenuItemOffer इंक्रीमेंटल अपडेट: MenuItem के लिए अपडेट की गई कीमत पर सेट की गई price के साथ, MenuItemOffer एजेंट को भेजें. साथ ही, बाकी डेटा में कोई बदलाव न करें.

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

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

Menu, Restaurant, Service

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

पूरे फ़ीड: अपने डेटा फ़ीड में इकाई जोड़ें और एक साथ कई इकाइयों को डालने का इंतज़ार करें.

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

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

Menu, Restaurant, Service

इंक्रीमेंटल अपडेट: साफ़ तौर पर मिटाएं मैसेज भेजें.

पूरे फ़ीड: Google के अगले फ़ेच से पहले, इकाई को पूरे फ़ीड से हटाना न भूलें. ऐसा न करने पर, इकाई फिर से जुड़ जाएगी.

किसी खास Service में डिलीवरी के लिए नया इलाका जोड़ना ServiceArea इंक्रीमेंटल फ़ीड: ServiceArea इकाई को उसके सभी फ़ील्ड के साथ भेजें, जैसे कि आम तौर पर पूरे फ़ीड में किया जाता है. साथ ही, polygon, geoRadius या postalCode में डिलीवरी के लिए तय किए गए नए इलाके की जानकारी भी दें.
Service में डिलीवरी के अनुमानित समय को अपडेट करना ServiceHours इंक्रीमेंटल फ़ीड: ServiceHours को वैसा ही भेजें जैसा कि फ़ीड में है. हालांकि, इसकी leadTimeMin वैसे ही अपडेट की जाती है.
Service में डिलीवरी की कीमतें अपडेट करना Fee बढ़ते फ़ीड: अपडेट किए गए price के साथ पूरी डिलीवरी Fee भेजें.
Service में डिलीवरी या टेकआउट के समय अपडेट करना ServiceHours इंक्रीमेंटल फ़ीड: ServiceHours को वैसे ही भेजें जैसे कि फ़ीड में भेजा जाता है. हालांकि, इसकी opens और closes प्रॉपर्टी को इसके हिसाब से अपडेट किया जाता है.
Service (ऑर्डर की कम से कम रकम बदलना) Fee बढ़ते हुए फ़ीड: minPrice के साथ पूरा Fee भेजें अपडेट किया गया
किसी MenuItem को हमेशा के लिए मिटाना Menu इंक्रीमेंटल फ़ीड: MenuItem को वैसे ही भेजें जैसे फ़ीड में भेजा जाता है, लेकिन parentMenuSectionId को खाली छोड़ दें.

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

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

Google को इनमें से कोई एक ईमेल भेजा जा सकता है:

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