इस सेक्शन में बताया गया है कि Google को अपनी इन्वेंट्री इकाइयों के समय-संवेदनशील अपडेट कैसे भेजे जा सकते हैं. रीयल-टाइम अपडेट एपीआई की मदद से, अपने सैंडबॉक्स या प्रोडक्शन इन्वेंट्री में, रीयल टाइम में अपडेट किए जा सकते हैं और इकाइयों को मिटाया जा सकता है.
यह सुविधा मुख्य रूप से उन अपडेट के लिए है जिनके बारे में पहले से पता नहीं चलता. जैसे, आपातकालीन स्थिति में कारोबार बंद करना, मेन्यू से आइटम हटाना या मेन्यू आइटम की कीमत अपडेट करना. इन अपडेट को Google के यूज़र इंटरफ़ेस (यूआई) में तुरंत दिखाया जाना चाहिए. अगर आपको अपने बदलाव को तुरंत दिखाने की ज़रूरत नहीं है, तो इसके बजाय एक साथ कई डेटा फ़ीड डालने की सुविधा का इस्तेमाल करें. रीयल-टाइम अपडेट को प्रोसेस होने में ज़्यादा से ज़्यादा पांच मिनट लगते हैं.
ज़रूरी शर्तें
रीयल-टाइम अपडेट लागू करने से पहले, ये चीज़ें ज़रूरी हैं:
Maps Booking API चालू है:
GCP में, एपीआई और सेवाएं > लाइब्रेरी पर जाएं
“Google Maps Booking API” खोजें
सैंडबॉक्स इंस्टेंस (“Google Maps Booking API (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, Actions Center में खाता और उपयोगकर्ता पेज पर पार्टनर आईडी के तौर पर दिखता है. इसकी जानकारी, नीचे दिए गए स्क्रीनशॉट में दी गई है.
ऊपर दिए गए स्क्रीनशॉट में, PARTNER_ID की वैल्यू के तौर पर 10000001 को उदाहरण के तौर पर लेते हुए, सैंडबॉक्स और प्रोडक्शन में एपीआई अनुरोध भेजने के लिए पूरे यूआरएल, नीचे दिए गए उदाहरणों की तरह दिखेंगे.
# 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 इकाइयां हो सकती हैं.
उदाहरण
पहला उदाहरण: रेस्टोरेंट की जानकारी अपडेट करना
मान लें कि आपको किसी रेस्टोरेंट का फ़ोन नंबर तुरंत अपडेट करना है. आपके अपडेट में, पूरे रेस्टोरेंट का JSON शामिल होता है.
मान लें कि आपके पास ऐसा बैच फ़ीड है जो इस तरह दिखता है:
नई इकाइयां जोड़ने के लिए, रीयल-टाइम अपडेट का इस्तेमाल न करें. ऐसा करने से डेटा में अंतर हो सकता है. इसके बजाय, एक साथ कई फ़ीड डालने के लिए बताई गई प्रोसेस का इस्तेमाल करके, एक साथ कई फ़ीड डालें.
इकाइयां मिटाना
अपनी इन्वेंट्री से इकाइयों को मिटाने के लिए, DELETEएंडपॉइंट का इस्तेमाल करें और एचटीटीपी पोस्ट अनुरोध भेजें. हर पोस्ट अनुरोध में, PARTNER_ID पैरामीटर के साथ-साथ JSON पेलोड शामिल होना चाहिए. इसमें आपकी इन्वेंट्री की किसी भी इकाई का आइडेंटिफ़ायर शामिल होना चाहिए.
अनुरोध पेलोड मिटाएं
मिटाने के अनुरोध का मुख्य हिस्सा, अपडेट करने के अनुरोध की तरह ही होता है.
इसमें data_record और delete_time फ़ील्ड वाले रिकॉर्ड की सूची भी होती है:
BASE_64_ENCODED_REFERENCE: हटाई जा रही इकाई के रेफ़रंस की, Base64 में एन्कोड की गई JSON स्ट्रिंग. रेफ़रंस में सिर्फ़ इकाई टाइप और आइडेंटिफ़ायर होता है. उदाहरण के लिए, MenuSection के रेफ़रंस का JSON फ़ॉर्मैट:
{"@type":"MenuSection","@id":"853705"}
DELETE_TIMESTAMP: पक्का करें कि आपने बैकएंड सिस्टम में इकाई को मिटाए जाने के समय का टाइमस्टैंप शामिल किया हो. इस टाइमस्टैंप का इस्तेमाल, यह तय करने के लिए किया जाता है कि इन्वेंट्री में मिटाने की कार्रवाई किस क्रम में लागू की जाएगी.
batchDelete अनुरोध में ज़्यादा से ज़्यादा 1,000 इकाइयां हो सकती हैं.
उदाहरण
पहला उदाहरण: दो 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.constserviceAccountJson=require('./service-account.json');// ACTION REQUIRED: Change this to your Partner ID received from Google.// The Partner ID is available on the Partner Portal.constPARTNER_ID=1234;constHOST={prod:'https://mapsbooking.googleapis.com',sandbox:'https://partnerdev-mapsbooking.googleapis.com'};// ACTION REQUIRED: Change to 'prod' for productionconstENV='sandbox';// Feed name for Order with Google including the version.constFEED_NAME='owg.v2';// Endpoint urlconsturl=`${HOST[ENV]}/v1alpha/inventory/partners/${PARTNER_ID}/feeds/${FEED_NAME}/record:batchPush`;/** * Send a Real-time update request to update/insert entities */asyncfunctionbatchUpsert(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 */constclient=newJWT({email:serviceAccountJson.client_email,key:serviceAccountJson.private_key,scopes:['https://www.googleapis.com/auth/mapsbooking'],});constrequest={records:toPushRecords(entities)};constbody=JSON.stringify(request);try{constresponse=awaitclient.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 */consttoPushRecords=(entities)=>{returnentities.map((entity)=>{// Using dateModified to set generation_timestamp. Defaulting to the// current timestamp for records that do not have dateModified.constgeneration_timestamp=entity.dateModified?entity.dateModified:newDate().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-authimportbase64importdatetimeimportjsonfromgoogle.auth.transport.requestsimportAuthorizedSessionfromgoogle.oauth2importservice_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)defbatch_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.htmlcredentials=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 objectbatch_request={'records':[create_push_record(x)forxinentities]}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 '{}'defcreate_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.dateModifiedif'dateModified'inentityelsedatetime.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 */packagertusamples;importcom.fasterxml.jackson.core.JsonProcessingException;importcom.fasterxml.jackson.databind.ObjectMapper;importcom.google.auth.oauth2.AccessToken;importcom.google.auth.oauth2.GoogleCredentials;importjava.io.FileInputStream;importjava.io.IOException;importjava.net.URI;importjava.net.http.HttpClient;importjava.net.http.HttpRequest;importjava.net.http.HttpRequest.BodyPublishers;importjava.net.http.HttpResponse;importjava.net.http.HttpResponse.BodyHandlers;importjava.nio.charset.Charset;importjava.time.Clock;importjava.time.OffsetDateTime;importjava.time.format.DateTimeFormatter;importjava.util.ArrayList;importjava.util.Arrays;importjava.util.Base64;importjava.util.List;importjava.util.Optional;importjava.util.stream.Collectors;importrtusamples.inventory.MenuItemOffer;importrtusamples.inventory.MenuItemOfferType;importrtusamples.inventory.ServiceTypeElement;importrtusamples.realtime.BatchPushGenericRecordRequest;importrtusamples.realtime.GenericRecord;/** Sample code for Real-time update batchPush implementation. */publicfinalclassBasicPush{// ACTION REQUIRED: Change this to your Partner ID received from Google. The Partner ID is// available on the Partner Portal.privatestaticfinallongPARTNER_ID=12345678;// ACTION REQUIRED: Change this to the path of the service account client secret file downloaded// from the Google Cloud Console.privatestaticfinalStringJSON_KEY_FULL_PATH="<path to your JSON credentials>/credentials.json";// ACTION REQUIRED: Change this to the endpoint that is needed.privatestaticfinalStringENDPOINT=// "https://partnerdev-mapsbooking.googleapis.com"; // for sandbox"https://mapsbooking.googleapis.com";// for prod// Feed name for Order with Google including the version.privatestaticfinalStringFEED_NAME="owg.v2";privatestaticfinalObjectMapperobjectMapper=newObjectMapper();privatestaticfinalDateTimeFormatterTIMESTAMP_FORMATTER=DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss[.SSS]'Z'");privatestaticfinalCharsetUTF_8=Charset.forName("UTF-8");publicstaticvoidmain(String[]args)throwsException{/** * 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);GoogleCredentialscredentials=GoogleCredentials.fromStream(newFileInputStream(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.MenuItemOffermenuItemOfferPizza=newMenuItemOffer();menuItemOfferPizza.setID("6680261");menuItemOfferPizza.setType(MenuItemOfferType.MENU_ITEM_OFFER);menuItemOfferPizza.setMenuItemID("18931508");menuItemOfferPizza.setPrice(15.5);menuItemOfferPizza.setPriceCurrency("USD");menuItemOfferPizza.setApplicableServiceType(newServiceTypeElement[]{ServiceTypeElement.TAKEOUT,ServiceTypeElement.DELIVERY});menuItemOfferPizza.setInventoryLevel(0.0);menuItemOfferPizza.setDateModified("2022-10-07T13:00:00.000Z");MenuItemOffermenuItemOfferSalad=newMenuItemOffer();menuItemOfferSalad.setID("6680262");menuItemOfferSalad.setType(MenuItemOfferType.MENU_ITEM_OFFER);menuItemOfferSalad.setMenuItemID("18931509");menuItemOfferSalad.setPrice(25.5);menuItemOfferSalad.setPriceCurrency("USD");menuItemOfferSalad.setApplicableServiceType(newServiceTypeElement[]{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=newArrayList<>();// Add list of menuItemOffer generic records.recordsToBeUpdated.addAll(menuItemOfferGenericRecords);// Request object that contains all records.BatchPushGenericRecordRequestbatchPushRequest=newBatchPushGenericRecordRequest();batchPushRequest.setRecords(recordsToBeUpdated.toArray(newGenericRecord[0]));// Execute batchPush request.BasicPushbasicPush=newBasicPush();basicPush.batchPush(batchPushRequest,credentials);}publicvoidbatchPush(BatchPushGenericRecordRequestbatchPushRequest,GoogleCredentialscredentials)throwsIOException{credentials.refreshIfExpired();AccessTokentoken=credentials.getAccessToken();StringrequestBody=objectMapper.writeValueAsString(batchPushRequest);HttpClientclient=HttpClient.newHttpClient();HttpRequestrequest=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|InterruptedExceptione){e.printStackTrace();}}publicstatic<T>GenericRecordtoBatchPushRecord(Tentity,StringdateModified){GenericRecordgenericRecord=newGenericRecord();try{Stringjson=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.StringgenerationTimestamp=Optional.ofNullable(dateModified).orElse(OffsetDateTime.now(Clock.systemUTC()).format(TIMESTAMP_FORMATTER));genericRecord.setGenerationTimestamp(generationTimestamp);}catch(JsonProcessingExceptione){System.out.println(e.getMessage());}returngenericRecord;}}
/* 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.constserviceAccountJson=require('./service-account.json');// ACTION REQUIRED: Change this to your Partner ID received from Google.// The Partner ID is available on the Partner Portal.constPARTNER_ID=1234;constHOST={prod:'https://mapsbooking.googleapis.com',sandbox:'https://partnerdev-mapsbooking.googleapis.com'};// ACTION REQUIRED: Change to 'prod' for productionconstENV='sandbox';// Feed name for Order with Google including the version.constFEED_NAME='owg.v2';// Endpoint urlconsturl=`${HOST[ENV]}/v1alpha/inventory/partners/${PARTNER_ID}/feeds/${FEED_NAME}/record:batchDelete`;/** * Send a Real-time update request to delete entities */asyncfunctionbatchDelete(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 */constclient=newJWT({email:serviceAccountJson.client_email,key:serviceAccountJson.private_key,scopes:['https://www.googleapis.com/auth/mapsbooking'],});constrequest={records:toDeleteRecords(entities)};constbody=JSON.stringify(request);try{constresponse=awaitclient.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 */consttoDeleteRecords=(entities)=>{returnentities.map((entity)=>{// Using dateModified to set delete_time. Defaulting to the current// timestamp for records that do not have dateModified.constdelete_time=entity.dateModified?entity.dateModified:newDate().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-authimportbase64importdatetimeimportjsonfromgoogle.auth.transport.requestsimportAuthorizedSessionfromgoogle.oauth2importservice_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)defbatch_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.htmlcredentials=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 objectbatch_request={'records':[create_delete_record(x)forxinentities]}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 '{}'defcreate_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.dateModifiedif'dateModified'inentityelsedatetime.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 */packagertusamples;importcom.fasterxml.jackson.core.JsonProcessingException;importcom.fasterxml.jackson.databind.ObjectMapper;importcom.google.auth.oauth2.AccessToken;importcom.google.auth.oauth2.GoogleCredentials;importjava.io.FileInputStream;importjava.io.IOException;importjava.net.URI;importjava.net.http.HttpClient;importjava.net.http.HttpRequest;importjava.net.http.HttpRequest.BodyPublishers;importjava.net.http.HttpResponse;importjava.net.http.HttpResponse.BodyHandlers;importjava.nio.charset.Charset;importjava.time.Clock;importjava.time.OffsetDateTime;importjava.time.format.DateTimeFormatter;importjava.util.ArrayList;importjava.util.Arrays;importjava.util.Base64;importjava.util.List;importjava.util.Optional;importjava.util.stream.Collectors;importrtusamples.inventory.Menu;importrtusamples.inventory.MenuType;importrtusamples.realtime.BatchDeleteGenericRecordsRequest;importrtusamples.realtime.GenericDeleteRecord;/** Sample code for the Real-time update batchDelete implementation. */publicfinalclassBasicDelete{// ACTION REQUIRED: Change this to your Partner ID received from Google. The Partner ID is// available on the Partner Portal.privatestaticfinallongPARTNER_ID=123456789;// ACTION REQUIRED: Change this to the path of the service account client secret file downloaded// from the Google Cloud Console.privatestaticfinalStringJSON_KEY_FULL_PATH="<path to your JSON credentials>/credentials.json";// ACTION REQUIRED: Change this to the endpoint that is needed.privatestaticfinalStringENDPOINT="https://partnerdev-mapsbooking.googleapis.com";// for sandbox// "https://mapsbooking.googleapis.com" // for prod// Feed name for Order with Google including the version.privatestaticfinalStringFEED_NAME="owg.v2";privatestaticfinalObjectMapperobjectMapper=newObjectMapper();privatestaticfinalDateTimeFormatterTIMESTAMP_FORMATTER=DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss[.SSS]'Z'");privatestaticfinalCharsetUTF_8=Charset.forName("UTF-8");publicstaticvoidmain(String[]args)throwsException{/** * 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);GoogleCredentialscredentials=GoogleCredentials.fromStream(newFileInputStream(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.MenumenuLunch=newMenu();menuLunch.setID("853705");menuLunch.setType(MenuType.MENU);menuLunch.setDateModified("2022-09-19T13:10:00.000Z");MenumenuDinner=newMenu();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=newArrayList<>();// Add list of menu generic records.recordsToBeDeleted.addAll(menuGenericDeleteRecords);// Request object that contains all records.BatchDeleteGenericRecordsRequestbatchDeleteRequest=newBatchDeleteGenericRecordsRequest();batchDeleteRequest.setRecords(recordsToBeDeleted.toArray(newGenericDeleteRecord[0]));// Execute batchDelete request.BasicDeletebasicDelete=newBasicDelete();basicDelete.batchDelete(batchDeleteRequest,credentials);}publicvoidbatchDelete(BatchDeleteGenericRecordsRequestbatchDeleteRequest,GoogleCredentialscredentials)throwsIOException{credentials.refreshIfExpired();AccessTokentoken=credentials.getAccessToken();StringrequestBody=objectMapper.writeValueAsString(batchDeleteRequest);HttpClientclient=HttpClient.newHttpClient();HttpRequestrequest=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|InterruptedExceptione){e.printStackTrace();}}publicstatic<T>GenericDeleteRecordtoBatchDeleteRecord(Tentity,StringdateModified){GenericDeleteRecordgenericRecord=newGenericDeleteRecord();try{Stringjson=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.StringdeleteTime=Optional.ofNullable(dateModified).orElse(OffsetDateTime.now(Clock.systemUTC()).format(TIMESTAMP_FORMATTER));genericRecord.setDeleteTime(deleteTime);}catch(JsonProcessingExceptione){System.out.println(e.getMessage());}returngenericRecord;}}
उपयोग के उदाहरण
यहां दिए गए इस्तेमाल के उदाहरण, रीयल-टाइम अपडेट, एक साथ कई फ़ीड अपडेट करने, और एपीआई कॉल में हाई लेवल के कॉन्टेंट के उदाहरण हैं:
स्थिति
अपडेट की जाने वाली इकाई
जानकारी और असर
किसी सेवा को बंद करना
Service
आपको किसी अनचाहे बदलाव की वजह से, किसी सेवा को बंद करना हो.
रीयल-टाइम अपडेट:Service इकाई की isDisabled प्रॉपर्टी को true पर सेट करके, उसमें बदलाव करें. हालांकि, अन्य प्रॉपर्टी को पहले जैसा ही रखें.
पूरे फ़ीड: पक्का करें कि Google के अगले फ़ेच से पहले, isDisabled को true पर सेट करने के लिए, पूरे फ़ीड से इकाई को अपडेट किया गया हो. ऐसा न करने पर, इकाई फिर से चालू हो जाएगी.
कोई आइटम स्टॉक में नहीं है
MenuItemOffer
रीयल-टाइम अपडेट: दिए गए MenuItem के लिए, inventoryLevel को 0 पर सेट करके, MenuItemOffer
इकाई को एन्कैप्सुलेट करके भेजें. साथ ही, बाकी डेटा में कोई बदलाव न करें.
मेन्यू आइटम की कीमत में बदलाव
MenuItemOffer
रीयल-टाइम अपडेट:MenuItemOffer को price के साथ पैकेज करके भेजें. price को दिए गए MenuItem की अपडेट की गई कीमत पर सेट करें. साथ ही, बाकी डेटा में कोई बदलाव न करें.
नई टॉप-लेवल इकाई जोड़ना
सिर्फ़ Menu,
Restaurant, और Service टाइप की इकाई के लिए लागू होता है.
Menu, Restaurant, Service
उदाहरण के लिए, आपको किसी रेस्टोरेंट में नया मेन्यू जोड़ना है.
पूरे फ़ीड: अपने डेटा फ़ीड में इकाई जोड़ें और एक साथ कई इकाइयों को डालने का इंतज़ार करें.
टॉप-लेवल की इकाई को हमेशा के लिए मिटाना
सिर्फ़ Menu,
Restaurant, और Service टाइप की इकाई के लिए लागू होता है.
पूरे फ़ीड: Google के अगले फ़ेच से पहले, इकाई को पूरे फ़ीड से हटाना न भूलें. ऐसा न करने पर, इकाई फिर से जुड़ जाएगी.
किसी खास Service में डिलीवरी के लिए नया इलाका जोड़ना
ServiceArea
बैच फ़ीड:ServiceArea इकाई को उसके सभी फ़ील्ड के साथ भेजें, जैसे कि आम तौर पर पूरे फ़ीड में किया जाता है. साथ ही, polygon, geoRadius या postalCode में डिलीवरी के लिए तय किए गए नए इलाके की जानकारी दें.
Service में डिलीवरी के अनुमानित समय को अपडेट करना
ServiceHours
एक साथ कई फ़ीड:ServiceHours को वैसे ही भेजें जैसे कि फ़ीड में भेजा जाता है. हालांकि, leadTimeMin को इसके हिसाब से अपडेट किया जाता है.
Service में डिलीवरी की कीमतें अपडेट करना
Fee
एक साथ कई फ़ीड: पूरी डिलीवरी Fee भेजें, जिसमें
price अपडेट किया गया हो.
Service में डिलीवरी या टेकआउट के समय अपडेट करना
ServiceHours
बैच फ़ीड:ServiceHours को वैसे ही भेजें जैसे फ़ीड में भेजा जाता है. हालांकि, इसकी opens और closes प्रॉपर्टी को तदनुसार अपडेट किया जाता है.
Service (ऑर्डर की कम से कम रकम बदलना)
Fee
एक साथ कई फ़ीड भेजना:minPrice के साथ पूरा Fee भेजें, जिसमें अपडेट की गई
किसी MenuItem को हमेशा के लिए मिटाना
Menu
बैच फ़ीड:MenuItem को वैसे ही भेजें जैसे फ़ीड में भेजा जाता है, लेकिन parentMenuSectionId को खाली छोड़ें.
एक साथ कई प्रोसेस करने की सुविधा और रीयल-टाइम अपडेट के लिए प्रोसेसिंग में लगने वाला समय
किसी इकाई को बैच फ़ीड की मदद से अपडेट करने या मिटाने पर, उसे दो घंटे के अंदर प्रोसेस कर दिया जाएगा. वहीं, रीयल-टाइम अपडेट की मदद से अपडेट की गई इकाई को पांच मिनट में प्रोसेस कर दिया जाएगा. पुरानी इकाई को 14 दिनों में मिटा दिया जाता है.
Google को इनमें से कोई एक ईमेल भेजा जा सकता है:
अपनी इन्वेंट्री को अप-टू-डेट रखने के लिए, हर दिन कई बैच जॉब या
हर दिन एक बैच जॉब और रीयल-टाइम अपडेट, ताकि आपकी इन्वेंट्री अप-टू-डेट रहे.
[null,null,["आखिरी बार 2024-11-26 (UTC) को अपडेट किया गया."],[[["This API enables partners to send time-sensitive inventory updates to Google, reflecting changes in the Google UI within five minutes."],["It supports `upsert` and `delete` operations for up to 1,000 entities per API call, processing requests asynchronously via a queue."],["Include changes made via real-time updates in your daily data feeds to maintain data consistency and avoid overwrites."],["For adding new entities, use batch ingestion instead of real-time updates, as it is not designed for this purpose."],["The `generation_timestamp` field ensures updates within a `batchPush` request are applied in the correct order, facilitating entity versioning."]]],[]]
