Google Ads API को कॉल करने के लिए, OAuth 2.0 क्रेडेंशियल और डेवलपर टोकन
, दोनों की ज़रूरत होती है. अगर Google Ads मैनेजर खाते से एपीआई कॉल किए जा रहे हैं, तो हर अनुरोध के साथ login-customer-id हेडर भी देना होगा. इस पेज पर, इन वैल्यू को सेट करने का तरीका बताया गया है. साथ ही, इसमें एपीआई के लिए खास तौर पर इस्तेमाल किए जाने वाले कई अन्य एचटीटीपी हेडर के बारे में भी बताया गया है. REST इंटरफ़ेस का इस्तेमाल करते समय, ये हेडर भेजे और पाए जाते हैं.
OAuth 2.0 क्रेडेंशियल
Google Ads API, एपीआई के अनुरोधों को अनुमति देने के लिए OAuth 2.0 का इस्तेमाल करता है. OAuth 2.0 के उपयोगकर्ता की पुष्टि करने वाले फ़्लो और सेवा खाते के फ़्लो, दोनों के लिए सहायता उपलब्ध है. ज़्यादा जानकारी के लिए, Google Ads API में OAuth 2.0 देखें.
अगर Google API का इस्तेमाल पहली बार किया जा रहा है, तो अपने ऐप्लिकेशन के लिए कोड लिखने से पहले, 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 एचटीटीपी हेडर में, ऐक्सेस टोकन का इस्तेमाल करें:
GET /v24/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
उपयोगकर्ता की पुष्टि
OAuth 2.0 क्लाइंट आईडी, क्लाइंट सीक्रेट, और रीफ़्रेश
टोकन मिलने के बाद, एपीआई कॉल में इस्तेमाल करने के लिए नया ऐक्सेस टोकन जनरेट किया जा सकता है. इसके लिए,
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 एचटीटीपी हेडर में, curl के अनुरोध से मिले ऐक्सेस टोकन का इस्तेमाल करें:
GET /v24/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
अनुरोध का हेडर
यहां दिए गए सेक्शन में, Google Ads API को अनुरोध भेजते समय ज़रूरी या इस्तेमाल किए जाने वाले एचटीटीपी हेडर के बारे में बताया गया है.
डेवलपर टोकन
Google Ads API को कॉल करने के लिए, डेवलपर टोकन की भी ज़रूरत होती है. अगर आपके पास पहले से कोई डेवलपर टोकन है, तो https://ads.google.com/aw/apicenter पर जाकर, उसे ढूंढा जा सकता है. अगर आपसे कहा जाए, तो अपने Google Ads मैनेजर खाते में साइन इन करें. अगर आपके पास कोई डेवलपर टोकन नहीं है, तो डेवलपर टोकन के लिए साइन अप करने के निर्देश देखें.
Google Ads API को किए जाने वाले हर एपीआई कॉल के developer-token एचटीटीपी हेडर में, आपको अपने डेवलपर टोकन की वैल्यू शामिल करनी होगी:
GET /v24/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. लॉगिन करने वाले ग्राहक आईडी के बारे में ज़्यादा जानने के लिए, Google Ads के ऐक्सेस मॉडल
की गाइड देखें.
GET /v24/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