- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- OrderUpdate
- स्ट्रीम किस तरह की है
- UserNotification
ऑर्डर को तीसरे पक्ष से ऑर्डर करने की सुविधा से, ऑर्डर करने की सुविधा में अपडेट करें. अगर ऑर्डर का आईडी खाली है या किसी मौजूदा ऑर्डर के बराबर नहीं है, तो यह वैल्यू हिस्से में नहीं मिलेगी.
एचटीटीपी अनुरोध
PATCH https://actions.googleapis.com/v3/orders/{orderUpdate.order.merchantOrderId}
यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ पैरामीटर
पैरामीटर | |
---|---|
orderUpdate.order.merchantOrderId |
ज़रूरी है: कारोबारी या कंपनी का असाइन किया गया इंटरनल ऑर्डर आईडी. यह आईडी यूनीक होना चाहिए. साथ ही, ऑर्डर को अपडेट करने के लिए बाद में इसकी ज़रूरत होती है. यह आईडी, दिए गए googleOrderId या किसी दूसरे यूनीक मान पर सेट हो सकता है. ध्यान दें कि उपयोगकर्ताओं को दिखाया जाने वाला आईडी, userVisibleOrderId होता है. यह एक अलग और ज़्यादा उपयोगकर्ता-अनुकूल वैल्यू हो सकती है. ज़्यादा से ज़्यादा 64 वर्ण इस्तेमाल किए जा सकते हैं. |
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, यहां दिए गए स्ट्रक्चर का डेटा शामिल होता है:
JSON के काेड में दिखाना | |
---|---|
{ "header": { object ( |
फ़ील्ड | ||
---|---|---|
header |
ऑर्डर अपडेट करने के अनुरोध का हेडर. |
|
orderUpdate.type |
बहिष्कृत: इसके बजाय OrderUpdate.update_mask इस्तेमाल करें. अगर टाइप = स्नैपशॉट है, तो OrderUpdate.order में पूरा ऑर्डर होना चाहिए. अगर प्रकार = ORDER_STATUS, तो यह ऑर्डर स्तर की स्थिति में बदलाव है. सिर्फ़ order.last_update_time और इस वर्टिकल का स्टेटस चुना जाता है. ध्यान दें: type.ORDER_STATUS, सिर्फ़ PucahaseOrderExtension स्थिति अपडेट के साथ काम करने की सुविधा देता है. फ़िलहाल, इस सुविधा को बढ़ाने का कोई प्लान नहीं है. इसके बजाय, हम updatedMask का इस्तेमाल करने का सुझाव देते हैं, क्योंकि यह ज़्यादा सामान्य और विस्तार से काम करने लायक है. साथ ही, इसका इस्तेमाल सभी वर्टिकल के लिए किया जा सकता है. |
|
orderUpdate.order.googleOrderId |
Google को असाइन किया गया ऑर्डर आईडी. |
|
orderUpdate.order.userVisibleOrderId |
उपयोगकर्ता को दिखने वाला आईडी, जो मौजूदा ऑर्डर का रेफ़रंस देता है. यह आईडी, वेबसाइटों, ऐप्लिकेशन, और ईमेल सहित दूसरे कॉन्टेक्स्ट में इस ऑर्डर के लिए दिखाए गए आईडी से मेल खाना चाहिए. |
|
orderUpdate.order.userVisibleStateLabel |
इस्तेमाल नहीं किया जा सकता: इसके बजाय, OrderExtensions status का इस्तेमाल करें. इस ऑर्डर की स्थिति के लिए, उपयोगकर्ता को दिखने वाला लेबल. |
|
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. अगर updatedMask के हिस्से के रूप में ऑर्डर दिया जाता है, तो ऑर्डर.create_time, order.google_order_id, और order.merchant_order_id को अनदेखा कर दिया जाएगा. फ़ील्ड के पूरी तरह क्वालिफ़ाइड नामों की कॉमा-सेपरेटेड लिस्ट. उदाहरण: |
|
orderUpdate.userNotification |
अगर बताया गया है, तो उपयोगकर्ता को किसी खास टाइटल और टेक्स्ट के साथ सूचना दिखाता है. सूचना देना, सूचना देने का सुझाव है. इस बात की कोई गारंटी नहीं है कि आपको सूचना मिलेगी. |
|
orderUpdate.reason |
बदलाव/अपडेट का कारण. |
|
यूनियन फ़ील्ड verticals . ये प्रॉपर्टी सभी लाइन आइटम पर लागू होंगी, बशर्ते कुछ लाइन आइटम में इन्हें ओवरराइड न किया गया हो. यह वर्टिकल, लाइन आइटम के लेवल के वर्टिकल टाइप से मेल खाना चाहिए. verticals इनमें से सिर्फ़ एक हो सकता है: |
||
orderUpdate.order.purchase |
क्रय आदेश |
|
orderUpdate.order.ticket |
टिकट का ऑर्डर |
जवाब का मुख्य भाग
कामयाब रहने पर, जवाब के मुख्य हिस्से में Order
का एक इंस्टेंस शामिल किया जाता है.
OrderUpdate
किसी ऑर्डर में बदलाव करना.
JSON के काेड में दिखाना | |
---|---|
{ "type": enum ( |
फ़ील्ड | |
---|---|
type |
बहिष्कृत: इसके बजाय OrderUpdate.update_mask इस्तेमाल करें. अगर टाइप = SNAPSHOT है, तो OrderUpdate.order पूरा ऑर्डर होना चाहिए. अगर टाइप = ORDER_STATUS है, तो यह ऑर्डर लेवल पर स्टेटस में बदलाव है. सिर्फ़ Order.last_update_time और इस वर्टिकल स्टेटस को चुना जाता है. ध्यान दें: type.ORDER_STATUS, सिर्फ़ PucahaseOrderExtension स्थिति अपडेट के साथ काम करने की सुविधा देता है. फ़िलहाल, इस सुविधा को बढ़ाने का कोई प्लान नहीं है. इसके बजाय, हम updatedMask का इस्तेमाल करने का सुझाव देते हैं, क्योंकि यह ज़्यादा सामान्य और विस्तार से काम करने लायक है. साथ ही, इसका इस्तेमाल सभी वर्टिकल के लिए किया जा सकता है. |
order |
|
updateMask |
ध्यान दें: इन खास फ़ील्ड के लिए, यहां दिए गए सुझाव/ध्यान देने वाली बातें देखें: 1. order.last_update_time को हमेशा अपडेट करने के अनुरोध के हिस्से के तौर पर अपडेट किया जाएगा. 2. अगर updatedMask के हिस्से के रूप में ऑर्डर दिया जाता है, तो ऑर्डर.create_time, order.google_order_id, और order.merchant_order_id को अनदेखा कर दिया जाएगा. फ़ील्ड के पूरी तरह क्वालिफ़ाइड नामों की कॉमा-सेपरेटेड लिस्ट. उदाहरण: |
userNotification |
अगर बताया गया है, तो उपयोगकर्ता को किसी खास टाइटल और टेक्स्ट के साथ सूचना दिखाता है. सूचना देना, सूचना देने का सुझाव है. इस बात की कोई गारंटी नहीं है कि आपको सूचना मिलेगी. |
reason |
बदलाव/अपडेट का कारण. |
टाइप
बहिष्कृत: इसके बजाय OrderUpdate.update_mask इस्तेमाल करें. किसी ऑर्डर में बदलाव करने की अनुमति दी गई.
Enums | |
---|---|
TYPE_UNSPECIFIED |
'जानकारी नहीं है' टाइप करें, इसे साफ़ तौर पर सेट नहीं करना चाहिए. |
ORDER_STATUS |
सिर्फ़ ऑर्डर का स्टेटस अपडेट करें. |
SNAPSHOT |
ऑर्डर का स्नैपशॉट अपडेट करें. |
UserNotification
ऑर्डर अपडेट के हिस्से के रूप में दिखाने के लिए उपयोगकर्ता के लिए वैकल्पिक सूचना.
JSON के काेड में दिखाना | |
---|---|
{ "title": string, "text": string } |
फ़ील्ड | |
---|---|
title |
उपयोगकर्ता को मिलने वाली सूचना का टाइटल. ज़्यादा से ज़्यादा 30 वर्ण डाले जा सकते हैं. |
text |
सूचना का कॉन्टेंट. ज़्यादा से ज़्यादा 100 वर्ण इस्तेमाल किए जा सकते हैं. |