- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- इसे आज़माएं!
इससे, बताई गई ईमेल के लेबल और क्लासिफ़िकेशन लेबल की वैल्यू में बदलाव होता है. अगर एडमिन, अपने संगठन के उपयोगकर्ताओं के लिए ईमेल में बदलाव करते हैं, तो अनुरोधों के लिए, ऐसे सेवा खाते से अनुमति की ज़रूरत होती है जिसके पास डोमेन-वाइड डेलिगेशन अथॉरिटी हो. इससे, https://www.googleapis.com/auth/gmail.modify.restricted स्कोप के साथ उपयोगकर्ताओं के तौर पर काम किया जा सकता है.
एचटीटीपी अनुरोध
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchModify
यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ पैरामीटर
| पैरामीटर | |
|---|---|
userId |
उपयोगकर्ता का ईमेल पता. ऑथेंटिकेट किए गए उपयोगकर्ता को दिखाने के लिए, खास वैल्यू |
अनुरोध का मुख्य हिस्सा
अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:
| JSON के काेड में दिखाना |
|---|
{
"ids": [
string
],
"addLabelIds": [
string
],
"removeLabelIds": [
string
],
"addClassificationLabels": [
{
object ( |
| फ़ील्ड | |
|---|---|
ids[] |
जिन ईमेल में बदलाव करना है उनके आईडी. हर अनुरोध के लिए, ज़्यादा से ज़्यादा 1,000 आईडी इस्तेमाल किए जा सकते हैं. |
addLabelIds[] |
ईमेल में जोड़े जाने वाले लेबल आईडी की सूची. |
removeLabelIds[] |
ईमेल से हटाए जाने वाले लेबल आईडी की सूची. |
addClassificationLabels[] |
जोड़े जाने वाले क्लासिफ़िकेशन लेबल की वैल्यू की सूची. अगर ईमेल पर, एक ही लेबल आईडी वाला क्लासिफ़िकेशन लेबल पहले से लागू है, तो मौजूदा फ़ील्ड आईडी वाले फ़ील्ड अपडेट हो जाएंगे. साथ ही, नए फ़ील्ड आईडी वाले फ़ील्ड जुड़ जाएंगे. हर अनुरोध के लिए, ज़्यादा से ज़्यादा 20 क्लासिफ़िकेशन लेबल की वैल्यू इस्तेमाल की जा सकती हैं. अगर ईमेल को पहले से ही क्लासिफ़ाई किया गया है और क्लासिफ़िकेशन लेबल की वैल्यू की कुल संख्या, हर ईमेल के लिए क्लासिफ़िकेशन लेबल की वैल्यू की तय सीमा से ज़्यादा है, तो बदलाव नहीं किया जा सकेगा. |
removeClassificationLabelIds[] |
ईमेल से हटाए जाने वाले क्लासिफ़िकेशन लेबल की वैल्यू की सूची. |
जवाब का मुख्य हिस्सा
अनुरोध सही से काम करने पर, जवाब का मुख्य हिस्सा खाली होता है.
अनुमति पाने के लिंक
इसके लिए, इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:
https://mail.google.com/https://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.modify.restricted
ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.