संग्रह की मदद से व्यवस्थित रहें
अपनी प्राथमिकताओं के आधार पर, कॉन्टेंट को सेव करें और कैटगरी में बांटें.
इस सेक्शन में बताया गया है कि आप अपनी इन्वेंट्री की इकाइयों के समय-संवेदनशील अपडेट, Google को कैसे भेज सकते हैं. रीयल-टाइम अपडेट एपीआई से, आपको करीब-करीब रीयल टाइम में अपडेट भेजने और अपने सैंडबॉक्स या प्रोडक्शन इन्वेंट्री में मौजूद इकाइयों को मिटाने में मदद मिलती है.
यह सुविधा मुख्य रूप से उन अपडेट के लिए है जिनका पता
नहीं लगाया जा सकता. उदाहरण के लिए, आपातकालीन स्थिति में बंद होने, मेन्यू से आइटम हटाने या किसी मेन्यू आइटम
की कीमत अपडेट करने के लिए, जो Google यूज़र इंटरफ़ेस (यूआई) में तुरंत दिखनी चाहिए. अगर आपके किए गए बदलाव को तुरंत दिखाने की ज़रूरत नहीं है, तो बैच इंजेशन का इस्तेमाल किया जा सकता है. रीयल-टाइम अपडेट पांच मिनट से ज़्यादा में प्रोसेस नहीं किए जाते.
ज़रूरी शर्तें
रीयल-टाइम अपडेट लागू करने से पहले, इन आइटम की ज़रूरत होती है:
Maps बुकिंग एपीआई चालू है:
GCP में, एपीआई और सेवाएं > लाइब्रेरी पर जाएं
“Google Maps का बुकिंग एपीआई” खोजें
सैंडबॉक्स इंस्टेंस (“Google Maps बुकिंग एपीआई (Dev)”) ढूंढें और
चालू करें पर क्लिक करें
प्रोडक्शन इंस्टेंस (“Google Maps Booking API”) ढूंढें और
चालू करें पर क्लिक करें
आपके GCP प्रोजेक्ट में एडिटर की भूमिका के साथ, एक सेवा खाता बनाया जाता है. ज़्यादा
जानकारी के लिए, खाता सेटअप देखें.
प्रोडक्शन या सैंडबॉक्स डेटा फ़ीड होस्ट किए जाते हैं और इंजेस्ट किए जाते हैं. ज़्यादा जानकारी के लिए,
एक साथ कई डिवाइसों पर डेटा डालना देखें.
एपीआई की पुष्टि करने के लिए, हमारा सुझाव है कि आप
Google क्लाइंट लाइब्रेरी को अपनी पसंद की भाषा में इंस्टॉल करें. OAuth स्कोप के तौर पर “https://www.googleapis.com/auth/mapsbooking” इस्तेमाल करें. नीचे दिए गए कोड सैंपल, इन लाइब्रेरी का इस्तेमाल करते हैं. अगर ऐसा नहीं है, तो Google API ऐक्सेस करने के लिए OAuth 2.0 का इस्तेमाल करना में बताए गए तरीके का इस्तेमाल करके, आपको टोकन एक्सचेंज को मैन्युअल तरीके से मैनेज करना होगा.
खास जानकारी
रीयल-टाइम अपडेट एपीआई दो तरह से काम करता है. पहला कार्रवाई, मौजूदा
इकाइयों को अपडेट करने के लिए होती है. दूसरी कार्रवाई, 'मिटाएं' है, ताकि इन्वेंट्री से इकाइयों को हटाया जा सके. दोनों कार्रवाइयां, अनुरोध वाले लेख में बताई गई कई इकाइयों पर की जाती हैं. एक एपीआई कॉल में, ज़्यादा से ज़्यादा 1,000 इकाइयों को अपडेट किया जा सकता है. एपीआई, आने वाले सभी अनुरोधों को स्वीकार करता है और उन्हें आगे की प्रक्रिया के लिए, एक सूची में रखता है.
इसलिए, आरटीयू अनुरोधों को एसिंक्रोनस तरीके से प्रोसेस किया जाता है.
रीयल-टाइम अपडेट एपीआई दो एनवायरमेंट में काम करता है: सैंडबॉक्स और प्रोडक्शन.
सैंडबॉक्स एनवायरमेंट का इस्तेमाल, एपीआई अनुरोधों और प्रोडक्शन एनवायरमेंट की जांच के लिए किया जाता है. इससे ऑर्डरिंग के असली उपयोगकर्ताओं को दिखने वाले कॉन्टेंट को अपडेट किया जाता है. दोनों परिवेशों के
होस्टनाम:
सैंडबॉक्स - partnerdev-mapsbooking.googleapis.com
प्रोडक्शन - mapsbooking.googleapis.com
एंडपॉइंट
रीयल-टाइम अपडेट एपीआई इन्वेंट्री अपडेट के लिए आने वाले अनुरोधों को हैंडल करने के लिए दो एंडपॉइंट दिखाता है:
पैरामीटर PARTNER_ID को देखने के लिए, कार्रवाई केंद्र पर जाएं. इसे खाता और उपयोगकर्ता पेज पर, पार्टनर आईडी के तौर पर दिखाया गया है. नीचे दिए गए स्क्रीनशॉट में यह जानकारी देखी जा सकती है.
ऊपर दिए गए स्क्रीनशॉट से उदाहरण के तौर पर, PARTNER_ID की वैल्यू के तौर पर 10,00,001 को लेते हुए, सैंडबॉक्स और प्रोडक्शन में एपीआई अनुरोध भेजने के लिए पूरा यूआरएल, नीचे दिए गए उदाहरणों में जैसे दिखेंगे.
# Production UPSERT
https://mapsbooking.googleapis.com/v1alpha/inventory/partners/10000001/feeds/owg.v2/record:batchPush
# Production DELETE
https://mapsbooking.googleapis.com/v1alpha/inventory/partners/10000001/feeds/owg.v2/record:batchDelete
इकाइयां अपडेट की जा रही हैं
अपनी इन्वेंट्री में इकाइयों को अपडेट करने के लिए, UPSERTएंडपॉइंट का इस्तेमाल करें और एचटीटीपी पोस्ट अनुरोध भेजें. हर POST अनुरोध में
PARTNER_ID पैरामीटर के साथ-साथ, JSON पेलोड भी शामिल होना चाहिए. इस पेलोड में, इन्वेंट्री स्कीमा में शामिल किसी भी तरह की इकाई का स्ट्रक्चर्ड डेटा शामिल होना चाहिए.
अपसर्ट अनुरोध पेलोड
अनुरोध का मुख्य हिस्सा एक JSON ऑब्जेक्ट है, जिसमें रिकॉर्ड की सूची होती है. हर रिकॉर्ड, अपडेट होने वाली इकाई के हिसाब से होता है. इसमें data_record फ़ील्ड होता है, जिसमें Base64 में एन्कोड किया गया इकाई पेलोड होता है. साथ ही, generation_timestamp में इकाई के अपडेट के समय की जानकारी होती है:
BASE_64_ENCODED_ENTITY: इकाई की Base64 कोड में बदली गई JSON स्ट्रिंग. डिकोड की गई इकाई JSON का स्ट्रक्चर, फ़ीड की खास बातों के जैसा होना चाहिए. उदाहरण के लिए:
{"@type":"MenuSection","name":"My Updated Menu Section","menuId":{"@id":"10824","displayOrder":1},"@id":"853705"}
UPDATE_TIMESTAMP: आपके बैकएंड सिस्टम में इकाई जनरेट होने के समय का टाइमस्टैंप शामिल करना न भूलें. इस टाइमस्टैंप का इस्तेमाल, इन्वेंट्री अपडेट का सही क्रम तय करने के लिए किया जाता है. अगर यह फ़ील्ड शामिल नहीं है,
तो इसे उस समय पर सेट किया जाएगा, जब Google को अनुरोध मिलेगा. batchPush अनुरोध की मदद से इकाई अपडेट करते समय, generation_timestamp फ़ील्ड का इस्तेमाल इकाई का वर्शन बनाने के लिए किया जाता है. रिलेशनल इन्वेंट्री स्कीमा में, समय की वैल्यू का सही फ़ॉर्मैट देखें.
रीयल-टाइम में अपडेट करने का हर अनुरोध, इन शर्तों को पूरा करना होगा:
पेलोड के मुख्य हिस्से का साइज़ 5 एमबी से ज़्यादा नहीं होना चाहिए. इसी तरह बैच
फ़ीड के लिए, हमारा सुझाव है कि ज़्यादा डेटा लगाने के लिए, आप खाली सफ़ेद जगहों को हटा दें.
batchPush के किसी अनुरोध में 1,000 इकाइयां शामिल की जा सकती हैं.
उदाहरण
उदाहरण 1: किसी रेस्टोरेंट की जानकारी अपडेट करना
मान लें कि आपको किसी रेस्टोरेंट का फ़ोन नंबर तुरंत अपडेट करने की ज़रूरत है. आपके अपडेट में पूरे रेस्टोरेंट का JSON फ़ॉर्मैट शामिल है.
नई इकाइयां जोड़ने के लिए, रीयल-टाइम अपडेट का इस्तेमाल न करें. इसकी वजह से, डेटा में अंतर हो सकता है. इसके बजाय, बैच डेटा डालने के लिए बताए गए तरीके से बैच फ़ीड प्रोसेस इस्तेमाल करें.
इकाइयां मिटाना
अपनी इन्वेंट्री से इकाइयों को मिटाने के लिए, मिटाएंएंडपॉइंट का इस्तेमाल करें और एचटीटीपी पोस्ट अनुरोध भेजें. हर पीओएसटी अनुरोध में, JSON पेलोड के साथ PARTNER_ID पैरामीटर भी शामिल होना चाहिए. इस पेलोड में आपकी इन्वेंट्री में मौजूद किसी भी इकाई का आइडेंटिफ़ायर शामिल होना चाहिए.
अनुरोध पेलोड मिटाएं
डेटा मिटाने के अनुरोध का मुख्य हिस्सा, अपडेट के अनुरोध की तरह ही तैयार किया जाता है.
इसमें data_record और delete_time फ़ील्ड वाले रिकॉर्ड की सूची भी है:
BASE_64_ENCODED_REFERENCE: हटाई जा रही इकाई के रेफ़रंस की Base64 कोड में बदली गई JSON स्ट्रिंग. रेफ़रंस में सिर्फ़ इकाई के टाइप और आइडेंटिफ़ायर की जानकारी शामिल होती है. उदाहरण के लिए, MenuSection के रेफ़रंस को JSON फ़ॉर्मैट में दिखाया जाता है:
{"@type":"MenuSection","@id":"853705"}
DELETE_TIMESTAMP: आपके बैकएंड सिस्टम में इकाई को मिटाए जाने के समय का टाइमस्टैंप शामिल करना न भूलें. इस टाइमस्टैंप का इस्तेमाल करके यह तय किया जाता है कि इन्वेंट्री को किस क्रम में मिटाया जाएगा.
batchDelete के किसी अनुरोध में 1,000 इकाइयां शामिल की जा सकती हैं.
उदाहरण
उदाहरण 1: MenuItem की दो इकाइयां हटाना
एक एपीआई कॉल में दो मेन्यू आइटम हटाने के लिए, एचटीटीपी पोस्ट अनुरोध इस तरह होगा:
ऐसी स्थिति के बारे में सोचें जिसमें आपको बैच फ़ीड में मौजूद किसी रेस्टोरेंट को मिटाना हो.
आपको सिर्फ़ रेस्टोरेंट की इकाई को मिटाना चाहिए. सेवाएं और मेन्यू जैसी उप-इकाइयां न मिटाएं, क्योंकि उन्हें अपने-आप हटा दिया जाएगा.
https://www.provider.com/restaurant/12345 आईडी वाली रेस्टोरेंट इकाई को मिटाने के अनुरोध का सैंपल:
रीयल-टाइम अपडेट वाले एपीआई कॉल में दो तरह की पुष्टि की जाती है:
अनुरोध के लेवल पर - पुष्टि करने के इन तरीकों से यह जांच की जाती है कि पेलोड, अपरर्ट या मिटाएं स्कीमा के मुताबिक है या नहीं. साथ ही, हर data_record में @id और @type, दोनों फ़ील्ड शामिल हैं या नहीं.
ये जांच सिंक्रोनस होती हैं और नतीजे, एपीआई
रिस्पॉन्स बॉडी में दिखाए जाते हैं. रिस्पॉन्स कोड 200 और JSON बॉडी {} खाली होने का मतलब है कि पुष्टि की ये प्रोसेस पास हो गई हैं. साथ ही, उस अनुरोध में शामिल इकाइयां प्रोसेस करने के लिए सूची में मौजूद थीं. 200 से अलग रिस्पॉन्स कोड का मतलब है कि इनमें से एक या इससे ज़्यादा पुष्टि नहीं की जा सकीं और पूरा अनुरोध अस्वीकार कर दिया गया (इसमें पेलोड में शामिल सभी इकाइयां भी शामिल हैं). उदाहरण के लिए, अगर किसी data_record में @type मौजूद नहीं है, तो यह गड़बड़ी का रिस्पॉन्स मिलेगा:
{
"error": {
"code": 400,
"message": "Record:{\"@id\":\"2717/86853/DELIVERY\",\"applicableServiceType\":[\"DELIVERY\",\"TAKEOUT\"],\"menuId\":[{\"@id\":\"2717/DELIVERY\",\"displayOrder\":1},{\"@id\":\"2717/TAKEOUT\",\"displayOrder\":2}],\"name\":\"Salad\",\"offeredById\":[\"2717\"]} has following errors: \nThe entity type could not be extracted from the entity value.\n",
"status": "INVALID_ARGUMENT",
"details": [
{
"@type": "type.googleapis.com/google.rpc.DebugInfo",
"detail": "[ORIGINAL ERROR] generic::invalid_argument: Failed to parse one or more rtu records. Record:{\"@id\":\"2717/86853/DELIVERY\",\"applicableServiceType\":[\"DELIVERY\",\"TAKEOUT\"],\"menuId\":[{\"@id\":\"2717/DELIVERY\",\"displayOrder\":1},{\"@id\":\"2717/TAKEOUT\",\"displayOrder\":2}],\"name\":\"Salad\",\"offeredById\":[\"2717\"]} has following errors: \nThe entity type could not be extracted from the entity value.\n [google.rpc.error_details_ext] { message: \"Record:{\\\"@id\\\":\\\"2717/86853/DELIVERY\\\",\\\"applicableServiceType\\\":[\\\"DELIVERY\\\",\\\"TAKEOUT\\\"],\\\"menuId\\\":[{\\\"@id\\\":\\\"2717/DELIVERY\\\",\\\"displayOrder\\\":1},{\\\"@id\\\":\\\"2717/TAKEOUT\\\",\\\"displayOrder\\\":2}],\\\"name\\\":\\\"Salad\\\",\\\"offeredById\\\":[\\\"2717\\\"]} has following errors: \\nThe entity type could not be extracted from the entity value.\\n\" }"
}
]
}
}
इकाई-लेवल - पेलोड में मौजूद हर इकाई की पुष्टि रिलेशनल स्कीमा के हिसाब से की जाती है.
पुष्टि के इस चरण में मिली समस्याओं की जानकारी एपीआई
रिस्पॉन्स में नहीं दी जाती. इनकी रिपोर्ट सिर्फ़ आरटीयू रिपोर्टिंग डैशबोर्ड में होती है.
एपीआई कोटा
रीयल-टाइम एपीआई अपडेट के लिए,हर 60 सेकंड में 1, 500 अनुरोध या औसतन 25 अनुरोध प्रति सेकंड होते हैं. कोटा पार होने पर Google, गड़बड़ी का यह मैसेज दिखाता है:
इसे मैनेज करने के लिए, बड़ी संख्या में बड़े इंटरवल पर फिर से कॉल करने की कोशिश करें. ऐसा तब तक करें, जब तक कि कॉल सफल न हो जाए. अगर नियमित तौर पर कोटा खत्म हो जाता है, तो एक एपीआई अनुरोध में
और इकाइयों को शामिल करें. एक एपीआई कॉल में 1,000 इकाइयां शामिल की जा सकती हैं.
कोड सैंपल
अलग-अलग भाषाओं में रीयल-टाइम अपडेट एपीआई को इस्तेमाल करने के कुछ तरीके नीचे दिए गए हैं. ये नमूने, खाता सेटअप के दौरान जनरेट की गई सेवा खाता कुंजी का इस्तेमाल करके पुष्टि करने के लिए, Google Auth लाइब्रेरी का इस्तेमाल करते हैं.
अन्य तरीकों के बारे में जानने के लिए, सर्वर से सर्वर ऐप्लिकेशन के लिए OAuth 2.0 का इस्तेमाल करना देखें.
इन्वेंट्री और रीयल-टाइम अपडेट वाले ऑब्जेक्ट टाइप के लिए सोर्स कोड जनरेट करने के लिए, क्लाइंट लाइब्रेरी जनरेट करें में मौजूद स्कीमा का इस्तेमाल करें.
/* Sample code for Real-time update batchPush implementation.
*
* Required libraries:
* - google-auth-library
*/
const {JWT} = require('google-auth-library');
// ACTION REQUIRED: Change this to the path of the service account client secret
// file downloaded from the Google Cloud Console.
const serviceAccountJson = require('./service-account.json');
// ACTION REQUIRED: Change this to your Partner ID received from Google.
// The Partner ID is available on the Partner Portal.
const PARTNER_ID = 1234;
const HOST = {
prod: 'https://mapsbooking.googleapis.com',
sandbox: 'https://partnerdev-mapsbooking.googleapis.com'
};
// ACTION REQUIRED: Change to 'prod' for production
const ENV = 'sandbox';
// Feed name for Order with Google including the version.
const FEED_NAME = 'owg.v2';
// Endpoint url
const url = `${HOST[ENV]}/v1alpha/inventory/partners/${PARTNER_ID}/feeds/${
FEED_NAME}/record:batchPush`;
/**
* Send a Real-time update request to update/insert entities
*/
async function batchUpsert(entities) {
/**
* Sign JWT token using private key from service account secret file
* provided. The client can be created without providing a service account
* secret file by implementing Application Default Credentials.
* https://github.com/googleapis/google-auth-library-nodejs
*/
const client = new JWT({
email: serviceAccountJson.client_email,
key: serviceAccountJson.private_key,
scopes: ['https://www.googleapis.com/auth/mapsbooking'],
});
const request = {records: toPushRecords(entities)};
const body = JSON.stringify(request);
try {
const response = await client.request({
method: 'POST',
url,
data: body,
headers: {'Content-Type': 'application/json'}
});
console.log('request body:', body);
console.log('response status:', response.status);
console.log(
'response data:', response.data); // successful response returns '{}'
} catch (error) {
console.log('error:', error);
}
}
/**
* Maps array of entities to records for batch push requests
*/
const toPushRecords = (entities) => {
return entities.map((entity) => {
// Using dateModified to set generation_timestamp. Defaulting to the
// current timestamp for records that do not have dateModified.
const generation_timestamp =
entity.dateModified ? entity.dateModified : new Date().toISOString();
return {data_record: btoa(JSON.stringify(entity)), generation_timestamp};
});
};
// Call batchUpsert with example entities. dateModified is optional and is
// used to hold the actual timestamp when the entity was updated/created.
batchUpsert([
{
'@type': 'MenuItemOffer',
'@id': '6680261',
'menuItemId': '18931508',
'price': 15.5,
'priceCurrency': 'USD',
'applicableServiceType': ['DELIVERY', 'TAKEOUT'],
'inventoryLevel': 0,
'dateModified': '2022-06-19T15:43:50.970Z'
},
{
'@type': 'MenuItemOffer',
'@id': '6680262',
'menuItemId': '18931509',
'price': 25.5,
'priceCurrency': 'USD',
'applicableServiceType': ['DELIVERY', 'TAKEOUT'],
'inventoryLevel': 0,
'dateModified': '2022-06-19T15:43:50.970Z'
}
]);
"""Sample code for the Real-time update batchPush implementation."""
# Required libraries:
# - google-auth
import base64
import datetime
import json
from google.auth.transport.requests import AuthorizedSession
from google.oauth2 import service_account
# ACTION REQUIRED: Change this to the Partner ID received from Google.
# Partner ID is available on the Partner Portal.
# https://partnerdash.google.com/apps/reservewithgoogle
_PARTNER_ID = '1234'
# ACTION REQUIRED: Change this to the path of the service account client secret
# file downloaded from the Google Cloud Console.
_SERVICE_ACCOUNT_KEY_JSON_FILE = 'service-account-creds.json'
_HOST_MAP = {
'sandbox': 'https://partnerdev-mapsbooking.googleapis.com',
'prod': 'https://mapsbooking.googleapis.com'
}
# ACTION REQUIRED: Change to 'prod' for production
_ENV = 'sandbox'
# Feed name for Order with Google including the version.
_FEED_NAME = 'owg.v2'
_ENDPOINT = '{}/v1alpha/inventory/partners/{}/feeds/{}/record:batchPush'.format(
_HOST_MAP[_ENV], _PARTNER_ID, _FEED_NAME)
def batch_upsert(entities):
"""Makes a batchPush request using the Real-time updates REST service.
Args:
entities: The list of entity objects to update or add.
"""
# Creates credentials by providing a json file. Credentials can also be
# provided by implementing Application Default Credentials.
# https://googleapis.dev/python/google-auth/latest/user-guide.html
credentials = service_account.Credentials.from_service_account_file(
_SERVICE_ACCOUNT_KEY_JSON_FILE,
scopes=['https://www.googleapis.com/auth/mapsbooking'])
authorized_session = AuthorizedSession(credentials)
# JSON request object
batch_request = {'records': [create_push_record(x) for x in entities]}
response = authorized_session.post(_ENDPOINT, json=batch_request)
print('request body:', json.dumps(batch_request))
print('response status:', response.status_code)
print('response data:', response.text) # successful response returns '{}'
def create_push_record(entity):
"""Creates a record from an entity for batchPush requests.
Args:
entity: The entity object to create the record from.
Returns:
The constructed record for the batchPush request payload.
"""
data_bytes = json.dumps(entity).encode('utf-8')
base64_bytes = base64.b64encode(data_bytes)
# Using dateModified to set generation_timestamp. Defaulting to the
# current timestamp for records that do not have dateModified.
generation_timestamp = entity.dateModified if 'dateModified' in entity else datetime.datetime.now(
).strftime('%Y-%m-%dT%H:%M:%S.%fZ')
return {
'generation_timestamp': generation_timestamp,
'data_record': base64_bytes.decode('utf-8')
}
# Call batch_upsert with example entities. dateModified is optional and is
# used to hold the actual timestamp when the entity was updated/created.
batch_upsert([{
'@type': 'MenuItemOffer',
'@id': '6680261',
'menuItemId': '18931508',
'price': 15.5,
'priceCurrency': 'USD',
'applicableServiceType': ['DELIVERY', 'TAKEOUT'],
'inventoryLevel': 0,
'dateModified': '2022-06-19T15:43:50.970Z'
}, {
'@type': 'MenuItemOffer',
'@id': '6680262',
'menuItemId': '18931509',
'price': 25.5,
'priceCurrency': 'USD',
'applicableServiceType': ['DELIVERY', 'TAKEOUT'],
'inventoryLevel': 0,
'dateModified': '2022-06-19T15:43:50.970Z'
}])
rtusamples.inventory और rtusamples.realtime पैकेज में मौजूद क्लाइंट सोर्स कोड के मॉडल, क्लाइंट लाइब्रेरी जनरेट करें में दिया गया तरीका अपनाकर बनाए गए हैं.
/*
* Required Libraries:
* - JDK >= 11
* - google-auth-library-oauth2-http
*/
package rtusamples;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.auth.oauth2.AccessToken;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.FileInputStream;
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpRequest.BodyPublishers;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.nio.charset.Charset;
import java.time.Clock;
import java.time.OffsetDateTime;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Base64;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import rtusamples.inventory.MenuItemOffer;
import rtusamples.inventory.MenuItemOfferType;
import rtusamples.inventory.ServiceTypeElement;
import rtusamples.realtime.BatchPushGenericRecordRequest;
import rtusamples.realtime.GenericRecord;
/** Sample code for Real-time update batchPush implementation. */
public final class BasicPush {
// ACTION REQUIRED: Change this to your Partner ID received from Google. The Partner ID is
// available on the Partner Portal.
private static final long PARTNER_ID = 12345678;
// ACTION REQUIRED: Change this to the path of the service account client secret file downloaded
// from the Google Cloud Console.
private static final String JSON_KEY_FULL_PATH =
"<path to your JSON credentials>/credentials.json";
// ACTION REQUIRED: Change this to the endpoint that is needed.
private static final String ENDPOINT =
// "https://partnerdev-mapsbooking.googleapis.com"; // for sandbox
"https://mapsbooking.googleapis.com"; // for prod
// Feed name for Order with Google including the version.
private static final String FEED_NAME = "owg.v2";
private static final ObjectMapper objectMapper = new ObjectMapper();
private static final DateTimeFormatter TIMESTAMP_FORMATTER =
DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss[.SSS]'Z'");
private static final Charset UTF_8 = Charset.forName("UTF-8");
public static void main(String[] args) throws Exception {
/**
* Create credentials from service account secret file. Alternatively, the credentials can be
* created by implementing Application Default Credentials.
* https://github.com/googleapis/google-auth-library-java
*/
// GoogleCredentials sourceCredentials =
// GoogleCredentials.getApplicationDefault()
// .createScoped(Arrays.asList("https://www.googleapis.com/auth/mapsbooking"));
// ImpersonatedCredentials credentials =
// ImpersonatedCredentials.create(
// sourceCredentials,
// "fo-test@projectname.iam.gserviceaccount.com",
// null,
// Arrays.asList("https://www.googleapis.com/auth/mapsbooking"),
// 300);
GoogleCredentials credentials =
GoogleCredentials.fromStream(new FileInputStream(JSON_KEY_FULL_PATH))
.createScoped(Arrays.asList("https://www.googleapis.com/auth/mapsbooking"));
// Create example MenuItemOffer entities, dateModified is optional and is used to hold
// the actual timestamp when the entity was updated/created.
MenuItemOffer menuItemOfferPizza = new MenuItemOffer();
menuItemOfferPizza.setID("6680261");
menuItemOfferPizza.setType(MenuItemOfferType.MENU_ITEM_OFFER);
menuItemOfferPizza.setMenuItemID("18931508");
menuItemOfferPizza.setPrice(15.5);
menuItemOfferPizza.setPriceCurrency("USD");
menuItemOfferPizza.setApplicableServiceType(
new ServiceTypeElement[] {ServiceTypeElement.TAKEOUT, ServiceTypeElement.DELIVERY});
menuItemOfferPizza.setInventoryLevel(0.0);
menuItemOfferPizza.setDateModified("2022-10-07T13:00:00.000Z");
MenuItemOffer menuItemOfferSalad = new MenuItemOffer();
menuItemOfferSalad.setID("6680262");
menuItemOfferSalad.setType(MenuItemOfferType.MENU_ITEM_OFFER);
menuItemOfferSalad.setMenuItemID("18931509");
menuItemOfferSalad.setPrice(25.5);
menuItemOfferSalad.setPriceCurrency("USD");
menuItemOfferSalad.setApplicableServiceType(
new ServiceTypeElement[] {ServiceTypeElement.TAKEOUT, ServiceTypeElement.DELIVERY});
menuItemOfferSalad.setInventoryLevel(0.0);
menuItemOfferSalad.setDateModified("2022-10-07T13:00:00.000Z");
// Example array of MenuItemOffer entities to update.
List<MenuItemOffer> menuItemOffers = Arrays.asList(menuItemOfferPizza, menuItemOfferSalad);
// Create list of GenericRecord from menuItemOffers.
List<GenericRecord> menuItemOfferGenericRecords =
menuItemOffers.stream()
.map(
(menuItemOffer) ->
toBatchPushRecord(menuItemOffer, menuItemOffer.getDateModified()))
.collect(Collectors.toList());
// List of records to be updated/created.
List<GenericRecord> recordsToBeUpdated = new ArrayList<>();
// Add list of menuItemOffer generic records.
recordsToBeUpdated.addAll(menuItemOfferGenericRecords);
// Request object that contains all records.
BatchPushGenericRecordRequest batchPushRequest = new BatchPushGenericRecordRequest();
batchPushRequest.setRecords(recordsToBeUpdated.toArray(new GenericRecord[0]));
// Execute batchPush request.
BasicPush basicPush = new BasicPush();
basicPush.batchPush(batchPushRequest, credentials);
}
public void batchPush(
BatchPushGenericRecordRequest batchPushRequest, GoogleCredentials credentials)
throws IOException {
credentials.refreshIfExpired();
AccessToken token = credentials.getAccessToken();
String requestBody = objectMapper.writeValueAsString(batchPushRequest);
HttpClient client = HttpClient.newHttpClient();
HttpRequest request =
HttpRequest.newBuilder()
.uri(
URI.create(
String.format(
"%s/v1alpha/inventory/partners/%s/feeds/%s/record:batchPush",
ENDPOINT, PARTNER_ID, FEED_NAME)))
.header("Content-Type", "application/json")
.header("Authorization", String.format("Bearer %s", token.getTokenValue()))
.POST(BodyPublishers.ofString(requestBody))
.build();
HttpResponse<String> response = null;
try {
response = client.send(request, BodyHandlers.ofString());
System.out.println("Request body:" + requestBody);
System.out.println("Response status:" + response.statusCode());
System.out.println("Response body:" + response.body());
} catch (IOException | InterruptedException e) {
e.printStackTrace();
}
}
public static <T> GenericRecord toBatchPushRecord(T entity, String dateModified) {
GenericRecord genericRecord = new GenericRecord();
try {
String json = objectMapper.writeValueAsString(entity);
genericRecord.setDataRecord(Base64.getEncoder().encodeToString(json.getBytes(UTF_8)));
// Using dateModified to set generation_timestamp. Defaulting to the
// current timestamp for records that do not have dateModified.
String generationTimestamp =
Optional.ofNullable(dateModified)
.orElse(OffsetDateTime.now(Clock.systemUTC()).format(TIMESTAMP_FORMATTER));
genericRecord.setGenerationTimestamp(generationTimestamp);
} catch (JsonProcessingException e) {
System.out.println(e.getMessage());
}
return genericRecord;
}
}
/* Sample code for Real-time update batchDelete implementation.
*
* Required libraries:
* - google-auth-library
*/
const {JWT} = require('google-auth-library');
// ACTION REQUIRED: Change this to the path of the service account client secret
// file downloaded from the Google Cloud Console.
const serviceAccountJson = require('./service-account.json');
// ACTION REQUIRED: Change this to your Partner ID received from Google.
// The Partner ID is available on the Partner Portal.
const PARTNER_ID = 1234;
const HOST = {
prod: 'https://mapsbooking.googleapis.com',
sandbox: 'https://partnerdev-mapsbooking.googleapis.com'
};
// ACTION REQUIRED: Change to 'prod' for production
const ENV = 'sandbox';
// Feed name for Order with Google including the version.
const FEED_NAME = 'owg.v2';
// Endpoint url
const url = `${HOST[ENV]}/v1alpha/inventory/partners/${PARTNER_ID}/feeds/${
FEED_NAME}/record:batchDelete`;
/**
* Send a Real-time update request to delete entities
*/
async function batchDelete(entities) {
try {
/**
* Sign JWT token using private key from service account secret file
* provided. The client can be created without providing a service account
* secret file by implementing Application Default Credentials.
* https://github.com/googleapis/google-auth-library-nodejs
*/
const client = new JWT({
email: serviceAccountJson.client_email,
key: serviceAccountJson.private_key,
scopes: ['https://www.googleapis.com/auth/mapsbooking'],
});
const request = {
records: toDeleteRecords(entities)
};
const body = JSON.stringify(request);
try {
const response = await client.request({
method: 'POST',
url,
data: body,
headers: {'Content-Type': 'application/json'}
});
console.log('request body:', body);
console.log('response status:', response.status);
console.log('response data:', response.data); // successful response returns '{}'
} catch (error) {
console.log('error:', error);
}
}
/**
* Maps array of entities to records for batch delete requests
*/
const toDeleteRecords = (entities) => {
return entities.map((entity) => {
// Using dateModified to set delete_time. Defaulting to the current
// timestamp for records that do not have dateModified.
const delete_time =
entity.dateModified ? entity.dateModified : new Date().toISOString();
return {data_record: btoa(JSON.stringify(entity)), delete_time};
});
};
// Call batchDelete with example entities. dateModified is optional and is
// used to hold the actual timestamp when the entity was deleted.
batchDelete([
{
'@type': 'Menu',
'@id': '853706',
'dateModified': '2022-06-19T15:43:50.970Z'
},
{
'@type': 'Menu',
'@id': '853705',
'dateModified': '2022-06-19T15:13:00.280Z'
}
]);
"""Sample code for the Real-time update batchDelete implementation."""
# Required libraries:
# - google-auth
import base64
import datetime
import json
from google.auth.transport.requests import AuthorizedSession
from google.oauth2 import service_account
# ACTION REQUIRED: Change this to the Partner ID received from Google.
# Partner ID is available on the Partner Portal.
# https://partnerdash.google.com/apps/reservewithgoogle
_PARTNER_ID = '1234'
# ACTION REQUIRED: Change this to the path of the service account client secret
# file downloaded from the Google Cloud Console.
_SERVICE_ACCOUNT_KEY_JSON_FILE = 'service-account-creds.json'
_HOST_MAP = {
'sandbox': 'https://partnerdev-mapsbooking.googleapis.com',
'prod': 'https://mapsbooking.googleapis.com'
}
# ACTION REQUIRED: Change to 'prod' for production
_ENV = 'sandbox'
# Feed name for Order with Google including the version.
_FEED_NAME = 'owg.v2'
_ENDPOINT = '{}/v1alpha/inventory/partners/{}/feeds/{}/record:batchDelete'.format(
_HOST_MAP[_ENV], _PARTNER_ID, _FEED_NAME)
def batch_delete(entities):
"""Makes a batch delete request using the Real-time updates REST service.
Args:
entities: The list of entity objects to delete.
"""
# Creates credentials by providing a json file. Credentials can also be
# provided by implementing Application Default Credentials.
# https://googleapis.dev/python/google-auth/latest/user-guide.html
credentials = service_account.Credentials.from_service_account_file(
_SERVICE_ACCOUNT_KEY_JSON_FILE,
scopes=['https://www.googleapis.com/auth/mapsbooking'])
authorized_session = AuthorizedSession(credentials)
# JSON request object
batch_request = {'records': [create_delete_record(x) for x in entities]}
response = authorized_session.post(_ENDPOINT, json=batch_request)
print('request body:', json.dumps(batch_request))
print('response status:', response.status_code)
print('response data:', response.text) # successful response returns '{}'
def create_delete_record(entity):
"""Creates a record from an entity for batchDelete requests.
Args:
entity: The entity object to create the record from.
Returns:
The constructed record for the batchDelete request payload.
"""
data_bytes = json.dumps(entity).encode('utf-8')
base64_bytes = base64.b64encode(data_bytes)
# Using dateModified to set delete_time. Defaulting to the current
# timestamp for records that do not have dateModified.
delete_time = entity.dateModified if 'dateModified' in entity else datetime.datetime.now(
).strftime('%Y-%m-%dT%H:%M:%S.%fZ')
return {
'delete_time': delete_time,
'data_record': base64_bytes.decode('utf-8')
}
# Call batch_delete with example entities. dateModified is optional and is
# used to hold the actual timestamp when the entity was deleted.
batch_delete([{
'@type': 'Menu',
'@id': '853706',
'dateModified': '2022-06-19T13:10:00.000Z'
}, {
'@type': 'Menu',
'@id': '853705',
'dateModified': '2022-06-19T13:30:10.000Z'
}])
rtusamples.inventory और rtusamples.realtime पैकेज में मौजूद क्लाइंट सोर्स कोड के मॉडल, क्लाइंट लाइब्रेरी जनरेट करें में दिया गया तरीका अपनाकर बनाए गए हैं.
/*
* Required Libraries:
* - JDK >= 11
* - google-auth-library-oauth2-http
*/
package rtusamples;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.auth.oauth2.AccessToken;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.FileInputStream;
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpRequest.BodyPublishers;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.nio.charset.Charset;
import java.time.Clock;
import java.time.OffsetDateTime;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Base64;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import rtusamples.inventory.Menu;
import rtusamples.inventory.MenuType;
import rtusamples.realtime.BatchDeleteGenericRecordsRequest;
import rtusamples.realtime.GenericDeleteRecord;
/** Sample code for the Real-time update batchDelete implementation. */
public final class BasicDelete {
// ACTION REQUIRED: Change this to your Partner ID received from Google. The Partner ID is
// available on the Partner Portal.
private static final long PARTNER_ID = 123456789;
// ACTION REQUIRED: Change this to the path of the service account client secret file downloaded
// from the Google Cloud Console.
private static final String JSON_KEY_FULL_PATH =
"<path to your JSON credentials>/credentials.json";
// ACTION REQUIRED: Change this to the endpoint that is needed.
private static final String ENDPOINT =
"https://partnerdev-mapsbooking.googleapis.com"; // for sandbox
// "https://mapsbooking.googleapis.com" // for prod
// Feed name for Order with Google including the version.
private static final String FEED_NAME = "owg.v2";
private static final ObjectMapper objectMapper = new ObjectMapper();
private static final DateTimeFormatter TIMESTAMP_FORMATTER =
DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss[.SSS]'Z'");
private static final Charset UTF_8 = Charset.forName("UTF-8");
public static void main(String[] args) throws Exception {
/**
* Create credentials from service account secret file. Alternatively, the credentials can be
* created by implementing Application Default Credentials.
* https://github.com/googleapis/google-auth-library-java
*/
// GoogleCredentials sourceCredentials =
// GoogleCredentials.getApplicationDefault()
// .createScoped(Arrays.asList("https://www.googleapis.com/auth/mapsbooking"));
// ImpersonatedCredentials credentials =
// ImpersonatedCredentials.create(
// sourceCredentials,
// "fo-test@projectname.iam.gserviceaccount.com",
// null,
// Arrays.asList("https://www.googleapis.com/auth/mapsbooking"),
// 300);
GoogleCredentials credentials =
GoogleCredentials.fromStream(new FileInputStream(JSON_KEY_FULL_PATH))
.createScoped(Arrays.asList("https://www.googleapis.com/auth/mapsbooking"));
// Create example Menu entities, dateModified is optional and is used to hold
// the actual timestamp when the entity was deleted.
Menu menuLunch = new Menu();
menuLunch.setID("853705");
menuLunch.setType(MenuType.MENU);
menuLunch.setDateModified("2022-09-19T13:10:00.000Z");
Menu menuDinner = new Menu();
menuDinner.setID("853706");
menuDinner.setType(MenuType.MENU);
menuDinner.setDateModified("2022-09-19T13:13:10.000Z");
// Example array of Menu entities to update.
List<Menu> menus = Arrays.asList(menuLunch, menuDinner);
// Create list of GenericDeleteRecord from menus.
List<GenericDeleteRecord> menuGenericDeleteRecords =
menus.stream()
.map((menu) -> toBatchDeleteRecord(menu, menu.getDateModified()))
.collect(Collectors.toList());
// List of records to be deleted.
List<GenericDeleteRecord> recordsToBeDeleted = new ArrayList<>();
// Add list of menu generic records.
recordsToBeDeleted.addAll(menuGenericDeleteRecords);
// Request object that contains all records.
BatchDeleteGenericRecordsRequest batchDeleteRequest = new BatchDeleteGenericRecordsRequest();
batchDeleteRequest.setRecords(recordsToBeDeleted.toArray(new GenericDeleteRecord[0]));
// Execute batchDelete request.
BasicDelete basicDelete = new BasicDelete();
basicDelete.batchDelete(batchDeleteRequest, credentials);
}
public void batchDelete(
BatchDeleteGenericRecordsRequest batchDeleteRequest, GoogleCredentials credentials)
throws IOException {
credentials.refreshIfExpired();
AccessToken token = credentials.getAccessToken();
String requestBody = objectMapper.writeValueAsString(batchDeleteRequest);
HttpClient client = HttpClient.newHttpClient();
HttpRequest request =
HttpRequest.newBuilder()
.uri(
URI.create(
String.format(
"%s/v1alpha/inventory/partners/%s/feeds/%s/record:batchDelete",
ENDPOINT, PARTNER_ID, FEED_NAME)))
.header("Content-Type", "application/json")
.header("Authorization", String.format("Bearer %s", token.getTokenValue()))
.POST(BodyPublishers.ofString(requestBody))
.build();
HttpResponse<String> response = null;
try {
response = client.send(request, BodyHandlers.ofString());
System.out.println("Request body:" + requestBody);
System.out.println("Response status:" + response.statusCode());
System.out.println("Response body:" + response.body());
} catch (IOException | InterruptedException e) {
e.printStackTrace();
}
}
public static <T> GenericDeleteRecord toBatchDeleteRecord(T entity, String dateModified) {
GenericDeleteRecord genericRecord = new GenericDeleteRecord();
try {
String json = objectMapper.writeValueAsString(entity);
genericRecord.setDataRecord(Base64.getEncoder().encodeToString(json.getBytes(UTF_8)));
// Using dateModified to set delete_time. Defaulting to the current
// timestamp for records that do not have dateModified.
String deleteTime =
Optional.ofNullable(dateModified)
.orElse(OffsetDateTime.now(Clock.systemUTC()).format(TIMESTAMP_FORMATTER));
genericRecord.setDeleteTime(deleteTime);
} catch (JsonProcessingException e) {
System.out.println(e.getMessage());
}
return genericRecord;
}
}
इस्तेमाल के उदाहरण
रीयल-टाइम अपडेट, बैच फ़ीड अपडेट, और एपीआई कॉल में बड़े लेवल पर कॉन्टेंट के उदाहरण नीचे दिए गए हैं:
स्थिति
अपडेट की जाने वाली इकाई
ब्यौरा और इफ़ेक्ट
किसी सेवा को बंद करना
Service
आपको किसी वजह से सेवा बंद करनी होगी.
रीयल-टाइम अपडेट: जिस इकाई के बारे में शिकायत करनी है उसे अपडेट करने के लिए,
Service इकाई की isDisabled प्रॉपर्टी को true पर सेट करें.
हालांकि, दूसरी प्रॉपर्टी में कोई बदलाव न करें.
पूरी फ़ीड: Google से अगली बार फ़ेच किए जाने से पहले isDisabled को true पर सेट करने के लिए, पूरे फ़ीड में मौजूद इकाई को अपडेट करना न भूलें. ऐसा न करने पर, इकाई फिर से चालू हो जाएगी.
कोई खास आइटम, स्टॉक में नहीं है
MenuItemOffer
रीयल-टाइम अपडेट: एनकैप्सुलेट करने वाली MenuItemOffer
इकाई को भेजें, जिसमें दिए गए
MenuItem के लिए inventoryLevel को 0 पर सेट किया गया हो और बाकी डेटा में कोई बदलाव न हुआ हो.
मेन्यू आइटम की कीमत में बदलाव
MenuItemOffer
रीयल-टाइम अपडेट: एनकैप्सुलेट करने वाली MenuItemOffer
इकाई को price के साथ, दिए गए
MenuItem की अपडेट की गई कीमत पर सेट करें. साथ ही, बाकी डेटा में कोई बदलाव न करें.
टॉप-लेवल की नई इकाई जोड़ें
सिर्फ़ 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 खाली रखें.
बैच जॉब और रीयल-टाइम अपडेट के प्रोसेस होने में लगने वाला समय
बैच फ़ीड से अपडेट की गई या मिटाई गई इकाई को दो घंटे में प्रोसेस किया जाएगा, जबकि रीयल-टाइम अपडेट से अपडेट की गई इकाई को पांच मिनट में प्रोसेस किया जाएगा. किसी पुरानी इकाई को 14 दिनों में मिटा दिया जाता है.
Google को इनमें से कोई एक दस्तावेज़ भेजा जा सकता है:
आपकी इन्वेंट्री को अप-टू-डेट रखने के लिए, हर दिन एक से ज़्यादा बैच जॉब, या
हर दिन एक बैच जॉब और रीयल-टाइम अपडेट, ताकि आपकी इन्वेंट्री अप-टू-डेट रहे.
