चेतावनी: आप एपीआई के REST इंटरफ़ेस के बारे में दस्तावेज़ देख रहे हैं. हमारी ज़्यादातर आधिकारिक क्लाइंट लाइब्रेरी, gRPC का इस्तेमाल करती हैं. ज़्यादा जानकारी के लिए, REST के बारे में जानकारी देखें.

इस पेज का अनुवाद Cloud Translation API से किया गया है.

ऑथराइज़ेशन और एचटीटीपी हेडर

वीडियो: पुष्टि करना

Google Ads API को कॉल करते समय, आपके पास OAuth 2.0 ऐप्लिकेशन क्रेडेंशियल और डेवलपर टोकन, दोनों होने चाहिए. अगर Google Ads मैनेजर खाते का इस्तेमाल करके एपीआई कॉल किए जा रहे हैं, तो आपको हर अनुरोध के लिए login-customer-id हेडर भी तय करना होगा. इस पेज पर इन वैल्यू को सेट करने का तरीका बताया गया है. साथ ही, REST इंटरफ़ेस का इस्तेमाल करते समय भेजे और पाए गए कई और एपीआई खास एचटीटीपी हेडर की जानकारी दी गई है.

OAuth 2.0 क्रेडेंशियल

Google Ads API, एपीआई अनुरोधों की पहचान करने और उन्हें अनुमति देने के लिए, ऐप्लिकेशन क्रेडेंशियल का इस्तेमाल करता है. OAuth 2.0 क्लाइंट और सेवा खातों, दोनों को कॉन्फ़िगर किया जा सकता है. क्लाइंट-साइड ऑथराइज़ेशन को कॉन्फ़िगर करने के बारे में ज़्यादा जानकारी के लिए, Google Ads API में OAuth2 देखें.

अगर आपने Google API का इस्तेमाल पहले कभी नहीं किया है, तो अपने ऐप्लिकेशन के लिए कोड लिखने से पहले, ऐप्लिकेशन क्रेडेंशियल और Google Ads API के साथ प्रयोग करने के लिए oauth2l या OAuth 2.0 प्लेग्राउंड का इस्तेमाल किया जा सकता है.

डेस्कटॉप या वेब ऐप्लिकेशन फ़्लो का इस्तेमाल करना

Google Ads API के लिए Google API Console प्रोजेक्ट कॉन्फ़िगर करने का तरीका अपनाएं. क्लाइंट आईडी और क्लाइंट सीक्रेट रिकॉर्ड करें. इसके बाद, इस पेज पर वापस आएं.

OAuth क्लाइंट बनाने के बाद, रीफ़्रेश टोकन और ऐक्सेस टोकन जनरेट करने के लिए, डेस्कटॉप ऐप्लिकेशन के फ़्लो से जुड़े निर्देशों या वेब ऐप्लिकेशन के फ़्लो से जुड़े निर्देशों का पालन करें.

सेवा खातों का इस्तेमाल किया जा रहा है

Google Ads API के लिए सेवा खाते का ऐक्सेस सेट अप करने के लिए, सेवा खाता गाइड में दिए गए सामान्य निर्देशों का पालन करें.

अपना Google Ads खाता ऐक्सेस करने के लिए सेवा खाता सेट अप करने के बाद, सर्वर टू सर्वर ऐप्लिकेशन के लिए OAuth 2.0 का इस्तेमाल करना गाइड पढ़ें और HTTP/REST टैब को चुनना न भूलें. Google Ads API ऐक्सेस के लिए इस्तेमाल किया जाने वाला scope https://www.googleapis.com/auth/adwords है.

नए ऐक्सेस टोकन जनरेट किए जा रहे हैं

क्लाइंट आईडी, क्लाइंट सीक्रेट, और रीफ़्रेश टोकन मिलने के बाद, curl कमांड लाइन टूल की मदद से एपीआई कॉल में इस्तेमाल करने के लिए, नया ऐक्सेस टोकन जनरेट किया जा सकता है:

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

इसके बाद, Google Ads API को किए गए हर एपीआई कॉल के Authorization एचटीटीपी हेडर में, कर्ल अनुरोध से मिले ऐक्सेस टोकन का इस्तेमाल करें:

GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

अनुरोध के हेडर

डेवलपर टोकन

एपीआई को कॉल करने के लिए, Google Ads API को डेवलपर टोकन की भी ज़रूरत होती है. अपने मैनेजर खाते के लिए, टोकन के लिए सीधे Google Ads के यूज़र इंटरफ़ेस (यूआई) से आवेदन किया जा सकता है. डेवलपर टोकन के साथ सेट अप करने के बारे में ज़्यादा जानकारी के लिए, अपना डेवलपर टोकन पाना देखें.

आपको Google Ads API को भेजे जाने वाले हर एपीआई कॉल के developer-token एचटीटीपी हेडर में, डेवलपर टोकन की वैल्यू शामिल करनी होगी:

GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

लॉगिन ग्राहक आईडी

मैनेजर खाते से क्लाइंट खाते में किए जाने वाले Google Ads API कॉल (यानी कि अपने किसी क्लाइंट खाते को एपीआई कॉल करने के लिए मैनेजर के तौर पर लॉग इन करने पर) के लिए, आपको login-customer-id एचटीटीपी हेडर भी देना होगा. यह वैल्यू, एपीआई कॉल करने वाले मैनेजर का Google Ads ग्राहक आईडी दिखाती है.

इस हेडर को शामिल करने का मतलब है, साइन इन करने के बाद या पेज के ऊपरी दाएं कोने में मौजूद अपनी प्रोफ़ाइल इमेज पर क्लिक करने के बाद, Google Ads यूज़र इंटरफ़ेस (यूआई) में कोई खाता चुनना. ग्राहक आईडी की जानकारी देते समय, सभी हाइफ़न (—) हटाना न भूलें, उदाहरण के लिए: 1234567890, न कि 123-456-7890.

GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

जोड़ा गया ग्राहक आईडी

इस हेडर का इस्तेमाल सिर्फ़ तीसरे पक्ष के ऐप्लिकेशन ऐनलिटिक्स प्रोवाइडर से तब किया जाता है, जब लिंक किए गए Google Ads खाते में कन्वर्ज़न अपलोड किए जाते हैं. ज़्यादा जानकारी के लिए, एपीआई कॉल के स्ट्रक्चर से जुड़ी गाइड देखें.

...
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
linked-customer-id: LINKED_CUSTOMER_ID

रिस्पॉन्स हेडर

एपीआई से एचटीटीपी रिस्पॉन्स में नीचे दिए गए हेडर दिखाए जाते हैं.

अनुरोध का आईडी

request-id एक स्ट्रिंग है, जो एपीआई अनुरोध की खास तौर पर पहचान करती है. किसी एपीआई कॉल से जुड़ी समस्याओं को डीबग करने या उन्हें हल करने के दौरान, request-id एक अहम आइडेंटिफ़ायर होता है. यह Google के डेवलपर सहायता केंद्र से संपर्क करते समय आसानी से इस्तेमाल किया जा सकता है.

request-id: 2a5Cj89VV7CNhya1DZjjrC