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

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

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

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

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

अगर Google APIs का इस्तेमाल पहली बार किया जा रहा है, तो gcloud CLI या OAuth 2.0 Playground का इस्तेमाल करके, OAuth 2.0 क्रेडेंशियल और Google Ads API को आज़माया जा सकता है. इसके बाद, अपने ऐप्लिकेशन के लिए कोड लिखा जा सकता है.

हमारा सुझाव है कि OAuth 2.0 ऑथराइज़ेशन वर्कफ़्लो लागू करने के लिए, https://oauth.net/code/ पर उपलब्ध OAuth 2.0 लाइब्रेरी में से किसी एक का इस्तेमाल करें. हालांकि, अगर आपको इसे खुद लागू करना है, तो हमने curl के निर्देश दिए हैं.

सेवा खाते

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

उपयोगकर्ता की पुष्टि

Google Ads API के लिए, Google Cloud Console प्रोजेक्ट को कॉन्फ़िगर करने के लिए यह तरीका अपनाएं. क्लाइंट आईडी और क्लाइंट सीक्रेट रिकॉर्ड करें. इसके बाद, डेस्कटॉप ऐप्लिकेशन के फ़्लो के निर्देशों या वेब ऐप्लिकेशन के फ़्लो के निर्देशों का पालन करके रीफ़्रेश टोकन और ऐक्सेस टोकन जनरेट करें. Google Ads API के ऐक्सेस के लिए इस्तेमाल किया जाने वाला scope यह है: https://www.googleapis.com/auth/adwords.

नए ऐक्सेस टोकन जनरेट करना

सेवा खाते

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

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

GET /v26/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN

उपयोगकर्ता की पुष्टि

OAuth 2.0 क्लाइंट आईडी, क्लाइंट सीक्रेट, और रीफ़्रेश टोकन मिलने के बाद, एपीआई कॉल में इस्तेमाल करने के लिए नया ऐक्सेस टोकन जनरेट किया जा सकता है. इसके लिए, 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 HTTP हेडर में, curl के अनुरोध से मिले ऐक्सेस टोकन का इस्तेमाल करें:

GET /v26/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN

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

यहां दिए गए सेक्शन में, Google Ads API को अनुरोध भेजते समय ज़रूरी या इस्तेमाल किए जाने वाले HTTP हेडर के बारे में बताया गया है.

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

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

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

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

अहम जानकारी: अगर ऑथराइज़ेशन, मैनेजर खाते के तौर पर नहीं किया जा रहा है, तो आपको login-customer-id हेडर देने की ज़रूरत नहीं है. दूसरे शब्दों में कहें, तो अगर OAuth 2.0 क्रेडेंशियल, टारगेट किए गए Google Ads के क्लाइंट खाते के किसी उपयोगकर्ता के लिए हैं, तो आपको यह हेडर देने की ज़रूरत नहीं है.

लिंक किया गया ग्राहक आईडी

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

Authorization: Bearer ACCESS_TOKEN
login-customer-id: PARTNER_CUSTOMER_ID
linked-customer-id: ADVERTISER_CUSTOMER_ID

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

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

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

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

अहम जानकारी: curl का इस्तेमाल करते समय, रिस्पॉन्स हेडर देखने के लिए, अपने कमांड में -i या --include फ़्लैग जोड़ें. इनमें google-ads-request-id भी शामिल है.

request-id: 2a5Cj89VV7CNhya1DZjjrC