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

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

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 का इस्तेमाल नहीं किया है, तो अपने ऐप्लिकेशन के लिए कोड लिखने से पहले, oauth2l या OAuth 2.0 प्लेग्राउंड का इस्तेमाल करके, ऐप्लिकेशन क्रेडेंशियल और Google Ads API के साथ प्रयोग किया जा सकता है.

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

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 कमांड-लाइन टूल का इस्तेमाल करके, एपीआई कॉल में इस्तेमाल करने के लिए नया ऐक्सेस टोकन जनरेट किया जा सकता है:

ध्यान दें: OAuth एंडपॉइंट यूआरएल में मौजूद वर्शन v3, Google Ads API के वर्शन से अलग होता है. साथ ही, Google Ads API के नए वर्शन पर माइग्रेट करते समय, इसमें कोई बदलाव नहीं होना चाहिए.

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 एचटीटीपी हेडर में, curl अनुरोध से मिले ऐक्सेस टोकन का इस्तेमाल किया जाता है:

GET /v19/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 /v19/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 /v19/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

अहम जानकारी: अगर मैनेजर खाते के तौर पर अनुमति नहीं दी जा रही है, तो इसका मतलब है कि आपके OAuth 2.0 क्रेडेंशियल, टारगेट किए गए Google Ads क्लाइंट खाते के उपयोगकर्ता के लिए हैं. ऐसे में, आपको login-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