Gmail Postmaster Tools API

Postmaster Tools API एक RESTful API है. यह ईमेल ट्रैफ़िक मेट्रिक (जैसे, स्पैम रिपोर्ट, डिलीवरी से जुड़ी गड़बड़ियां वगैरह) को प्रोग्राम के हिसाब से ऐक्सेस करने की सुविधा देता है. फ़िलहाल, यह सुविधा Gmail Postmaster Tools के यूज़र इंटरफ़ेस (यूआई) के ज़रिए उपलब्ध है.

सेवा: gmailpostmastertools.googleapis.com

इस सेवा को कॉल करने के लिए, हमारा सुझाव है कि आप Google की ओर से उपलब्ध कराई गई क्लाइंट लाइब्रेरी का इस्तेमाल करें. अगर आपके ऐप्लिकेशन को इस सेवा को कॉल करने के लिए, अपनी लाइब्रेरी का इस्तेमाल करना है, तो एपीआई अनुरोध करते समय यहां दी गई जानकारी का इस्तेमाल करें.

खोज से जुड़ा दस्तावेज़

जानकारी देने वाला दस्तावेज़, मशीन से पढ़े जा सकने वाले फ़ॉर्मैट में होता है. इसमें REST API के बारे में जानकारी दी जाती है और उन्हें इस्तेमाल करने का तरीका बताया जाता है. इसका इस्तेमाल क्लाइंट लाइब्रेरी, आईडीई प्लगिन, और Google API के साथ इंटरैक्ट करने वाले अन्य टूल बनाने के लिए किया जाता है. एक सेवा, एपीआई के बारे में ज़रूरी जानकारी देने वाले कई दस्तावेज़ उपलब्ध करा सकती है. यह सेवा, एपीआई के बारे में ज़रूरी जानकारी देने वाला यह दस्तावेज़ उपलब्ध कराती है:

सेवा का एंडपॉइंट

सेवा एंडपॉइंट एक बेस यूआरएल होता है. यह किसी एपीआई सेवा का नेटवर्क पता बताता है. एक सेवा के कई सेवा एंडपॉइंट हो सकते हैं. इस सेवा का एंडपॉइंट यह है. यहां दिए गए सभी यूआरआई, इस सेवा एंडपॉइंट से जुड़े हुए हैं:

  • https://gmailpostmastertools.googleapis.com

REST रिसॉर्स: v2beta.domainStats

तरीके
batchQuery POST /v2beta/domainStats:batchQuery
यह एक से ज़्यादा डोमेन के लिए, QueryDomainStats अनुरोधों का बैच लागू करता है.

REST रिसॉर्स: v2beta.domains

तरीके
create POST /v2beta/domains
इससे उपयोगकर्ता के खाते में कोई डोमेन जोड़ा जाता है.
delete DELETE /v2beta/{name=domains/*}
इससे उपयोगकर्ता के खाते से कोई डोमेन मिटाया जाता है.
get GET /v2beta/{name=domains/*}
इससे आपके रजिस्टर किए गए डोमेन के बारे में पूरी जानकारी मिलती है.
getComplianceStatus GET /v2beta/{name=domains/*/complianceStatus}
यह फ़ंक्शन, किसी डोमेन के लिए नीति के पालन की स्थिति को वापस लाता है.
getVerificationToken GET /v2beta/{name=domains/*/verificationToken}
यह फ़ंक्शन, पुष्टि करने वाला टोकन हासिल करता है. इसका इस्तेमाल, किसी डोमेन पर उपयोगकर्ता के मालिकाना हक की पुष्टि करने के लिए किया जाता है.
list GET /v2beta/domains
इससे आपके रजिस्टर किए गए सभी डोमेन की सूची मिलती है. साथ ही, उनसे जुड़ा मेटाडेटा भी मिलता है.
verify POST /v2beta/{name=domains/*}:verify
इससे डीएनएस लेवल पर, किसी उपयोगकर्ता के डोमेन के मालिकाना हक की पुष्टि होती है.

REST रिसॉर्स: v2beta.domains.domainStats

तरीके
query POST /v2beta/{parent=domains/*}/domainStats:query
यह फ़ंक्शन, किसी दिए गए डोमेन और समयावधि के लिए, डोमेन के आंकड़ों की सूची वापस लाता है.

REST रिसॉर्स: v2beta.domains.users

तरीके
create POST /v2beta/{parent=domains/*}/users
यह एक ऐसा उपयोगकर्ता बनाता है जिसके पास किसी डोमेन का ऐक्सेस होता है.
delete DELETE /v2beta/{name=domains/*/users/*}
इस कमांड से, किसी डोमेन से उपयोगकर्ता को मिटाया जाता है.
get GET /v2beta/{name=domains/*/users/*}
इस फ़ंक्शन से, उस उपयोगकर्ता के बारे में ज़्यादा जानकारी मिलती है जिसके पास किसी डोमेन का ऐक्सेस है.
list GET /v2beta/{parent=domains/*}/users
यह उन उपयोगकर्ताओं की सूची बनाता है जिनके पास किसी डोमेन का ऐक्सेस है.
patch PATCH /v2beta/{user.name=domains/*/users/*}
यह किसी डोमेन के लिए उपयोगकर्ता की जानकारी अपडेट करता है.