- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- OrderUpdate
- स्ट्रीम किस तरह की है
- UserNotification
ऑर्डर को 3p से AOG में अपडेट करें. अगर ऑर्डर की आईडी खाली है या किसी मौजूदा ऑर्डर के बराबर नहीं है, तो यह INVALID_googleplay दिखाता है.
एचटीटीपी अनुरोध
PATCH https://actions.googleapis.com/v3/orders/{orderUpdate.order.merchantOrderId}
यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ के पैरामीटर
पैरामीटर | |
---|---|
orderUpdate.order.merchantOrderId |
ज़रूरी: व्यापारी/कंपनी का असाइन किया गया अंदरूनी ऑर्डर आईडी. यह आईडी यूनीक होना चाहिए. साथ ही, ऑर्डर को बाद में अपडेट करने से जुड़ी कार्रवाइयों के लिए इसकी ज़रूरत होती है. इस आईडी को दिए गए googleOrderId या किसी अन्य यूनीक मान पर सेट किया जा सकता है. ध्यान दें कि उपयोगकर्ताओं को दिखाई गई आईडी, uservisibleOrderId होती है. यह वैल्यू, उस वैल्यू से अलग हो सकती है जो उपयोगकर्ता के लिए ज़्यादा आसान होती है. ज़्यादा से ज़्यादा 64 वर्ण हो सकते हैं. |
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में इस तरह का डेटा शामिल होता है:
जेएसओएन के काेड में दिखाना | |
---|---|
{ "header": { object ( |
फ़ील्ड | ||
---|---|---|
header |
ऑर्डर को अपडेट करने के अनुरोध का हेडर. |
|
orderUpdate.type |
अब काम नहीं करता: इसके बजाय, OrderUpdate.update_mask का इस्तेमाल करें. अगर टाइप = SNAPSHOT है, तो OrderUpdate.order पूरा ऑर्डर होना चाहिए. अगर टाइप = ORDER_STATUS है, तो यह ऑर्डर के लेवल की स्थिति में हुआ बदलाव है. सिर्फ़ order.last_update_time और इस वर्टिकल स्टेटस को चुना जाता है. ध्यान दें: type.ORDER_STATUS सिर्फ़ PucahaseOrderExtension स्थिति अपडेट के साथ काम करता है. साथ ही, इस मदद की सुविधा देने की कोई योजना नहीं है. इसके बजाय, हम UpdateMask का इस्तेमाल करने का सुझाव देते हैं, क्योंकि यह ज़्यादा जेनरिक और एक्सटेंसिबल है. साथ ही, इसका इस्तेमाल सभी वर्टिकल के लिए किया जा सकता है. |
|
orderUpdate.order.googleOrderId |
Google की ओर से असाइन किया गया ऑर्डर आईडी. |
|
orderUpdate.order.userVisibleOrderId |
मौजूदा ऑर्डर का रेफ़रंस देने वाला उपयोगकर्ता आईडी. यह आईडी, वेबसाइटों, ऐप्लिकेशन, और ईमेल सहित अन्य कॉन्टेक्स्ट में इस ऑर्डर के लिए दिखाए गए आईडी से मेल खाना चाहिए. |
|
orderUpdate.order.userVisibleStateLabel |
अब इस्तेमाल नहीं किया जा सकता: इसके बजाय, ऑर्डर एक्सटेंशन की स्थिति का इस्तेमाल करें. इस ऑर्डर की स्थिति के लिए उपयोगकर्ता को दिखने वाला लेबल. |
|
orderUpdate.order.buyerInfo |
खरीदार के बारे में जानकारी. |
|
orderUpdate.order.image |
ऑर्डर से जुड़ी इमेज. |
|
orderUpdate.order.createTime |
ज़रूरी: ऑर्डर बनाने की तारीख और समय. आरएफ़सी3339 यूटीसी के "Zulu" फ़ॉर्मैट में एक टाइमस्टैंप, नैनोसेकंड तक सटीक होता है. उदाहरण: |
|
orderUpdate.order.lastUpdateTime |
ऑर्डर को आखिरी बार अपडेट करने की तारीख और समय. OrderUpdate के लिए ज़रूरी है. आरएफ़सी3339 यूटीसी के "Zulu" फ़ॉर्मैट में एक टाइमस्टैंप, नैनोसेकंड तक सटीक होता है. उदाहरण: |
|
orderUpdate.order.transactionMerchant |
वह व्यापारी/कंपनी जिसने चेकआउट की सुविधा दी. यह लाइन आइटम के लेवल की सेवा देने वाली कंपनी से अलग हो सकता है. उदाहरण: ANA से मिला लाइन आइटम वाला Expedia ऑर्डर. |
|
orderUpdate.order.contents |
ज़रूरी: ऑर्डर का कॉन्टेंट, जो लाइन आइटम का ग्रुप है. |
|
orderUpdate.order.priceAttributes[] |
कीमत, छूट, टैक्स वगैरह. |
|
orderUpdate.order.followUpActions[] |
ऑर्डर लेवल पर फ़ॉलो अप कार्रवाइयां. |
|
orderUpdate.order.paymentData |
ऑर्डर के लिए पेमेंट से जुड़ा डेटा. |
|
orderUpdate.order.termsOfServiceUrl |
सेवा की शर्तों का एक लिंक जो ऑर्डर/प्रपोज़्ड ऑर्डर पर लागू होता है. |
|
orderUpdate.order.note |
ऑर्डर से जुड़े नोट. |
|
orderUpdate.order.promotions[] |
इस ऑर्डर से जुड़े सभी प्रमोशन. |
|
orderUpdate.order.disclosures[] |
इस ऑर्डर से जुड़ी जानकारी. |
|
orderUpdate.order.vertical |
अब सेवा में नहीं है: इसके बजाय वर्टिकल का इस्तेमाल करें. ये प्रॉपर्टी सभी लाइन आइटम पर लागू होंगी, जब तक कि कुछ लाइन आइटम में ओवरराइड न हो जाए. यह वर्टिकल, लाइन आइटम के लेवल वाले वर्टिकल टाइप से मेल खाना चाहिए. संभावित वैल्यू: एक ऑब्जेक्ट, जिसमें आर्बिट्रेरी टाइप के फ़ील्ड शामिल हैं. एक और फ़ील्ड |
|
orderUpdate.updateMask |
ध्यान दें: नीचे दिए गए खास फ़ील्ड के लिए, यहां सुझाव दिए गए हैं: 1. order.last_update_time को अपडेट करने के अनुरोध के तौर पर हमेशा अपडेट किया जाएगा. 2. अगर updateMask के भाग के रूप में दिया गया है, तो order.create_time, order.google_order_id और order.merchant_order_id को अनदेखा कर दिया जाएगा. फ़ील्ड के पूरी तरह क्वालिफ़ाइड नामों की कॉमा-सेपरेटेड लिस्ट. उदाहरण: |
|
orderUpdate.userNotification |
बताए जाने पर, उपयोगकर्ता को बताए गए टाइटल और टेक्स्ट के साथ एक सूचना दिखाता है. सूचना देना, सूचना देने का सुझाव है. हालांकि, इस बात की कोई गारंटी नहीं है कि आपको सूचना दी जाए. |
|
orderUpdate.reason |
बदलाव/अपडेट का कारण. |
|
यूनियन फ़ील्ड verticals . ये प्रॉपर्टी सभी लाइन आइटम पर लागू होंगी, जब तक कि कुछ लाइन आइटम में ओवरराइड न हो जाए. यह वर्टिकल, लाइन आइटम के लेवल वाले वर्टिकल टाइप से मेल खाना चाहिए. verticals इनमें से सिर्फ़ एक हो सकता है: |
||
orderUpdate.order.purchase |
परचेज़ ऑर्डर (पीओ) |
|
orderUpdate.order.ticket |
टिकट ऑर्डर |
जवाब का मुख्य भाग
कामयाब रहने पर, जवाब के मुख्य हिस्से में Order
का एक इंस्टेंस शामिल किया जाता है.
OrderUpdate
ऑर्डर में अपडेट करें.
जेएसओएन के काेड में दिखाना | |
---|---|
{ "type": enum ( |
फ़ील्ड | |
---|---|
type |
अब काम नहीं करता: इसके बजाय, OrderUpdate.update_mask का इस्तेमाल करें. अगर टाइप = SNAPSHOT है, तो OrderUpdate.order पूरा ऑर्डर होना चाहिए. अगर टाइप = ORDER_STATUS है, तो यह ऑर्डर के लेवल की स्थिति में हुआ बदलाव है. सिर्फ़ order.last_update_time और इस वर्टिकल स्टेटस को चुना जाता है. ध्यान दें: type.ORDER_STATUS सिर्फ़ PucahaseOrderExtension स्थिति अपडेट के साथ काम करता है. साथ ही, इस मदद की सुविधा देने की कोई योजना नहीं है. इसके बजाय, हम UpdateMask का इस्तेमाल करने का सुझाव देते हैं, क्योंकि यह ज़्यादा जेनरिक और एक्सटेंसिबल है. साथ ही, इसका इस्तेमाल सभी वर्टिकल के लिए किया जा सकता है. |
order |
|
updateMask |
ध्यान दें: नीचे दिए गए खास फ़ील्ड के लिए, यहां सुझाव दिए गए हैं: 1. order.last_update_time को अपडेट करने के अनुरोध के तौर पर हमेशा अपडेट किया जाएगा. 2. अगर updateMask के भाग के रूप में दिया गया है, तो order.create_time, order.google_order_id और order.merchant_order_id को अनदेखा कर दिया जाएगा. फ़ील्ड के पूरी तरह क्वालिफ़ाइड नामों की कॉमा-सेपरेटेड लिस्ट. उदाहरण: |
userNotification |
बताए जाने पर, उपयोगकर्ता को बताए गए टाइटल और टेक्स्ट के साथ एक सूचना दिखाता है. सूचना देना, सूचना देने का सुझाव है. हालांकि, इस बात की कोई गारंटी नहीं है कि आपको सूचना दी जाए. |
reason |
बदलाव/अपडेट का कारण. |
Type
अब काम नहीं करता: इसके बजाय, OrderUpdate.update_mask का इस्तेमाल करें. किसी ऑर्डर के लिए अपडेट की अनुमति है.
Enums | |
---|---|
TYPE_UNSPECIFIED |
टाइप तय नहीं है, इसे साफ़ तौर पर सेट नहीं करना चाहिए. |
ORDER_STATUS |
सिर्फ़ ऑर्डर की स्थिति अपडेट करें. |
SNAPSHOT |
ऑर्डर का स्नैपशॉट अपडेट करें. |
UserNotification
ऑर्डर अपडेट के हिस्से के तौर पर दिखाने के लिए उपयोगकर्ता से जुड़ी वैकल्पिक सूचना.
जेएसओएन के काेड में दिखाना | |
---|---|
{ "title": string, "text": string } |
फ़ील्ड | |
---|---|
title |
उपयोगकर्ता को भेजी जाने वाली सूचना का टाइटल. ज़्यादा से ज़्यादा 30 वर्ण हो सकते हैं. |
text |
सूचना का कॉन्टेंट. ज़्यादा से ज़्यादा 100 वर्ण डाले जा सकते हैं. |