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

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

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

अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है वीडियो: पुष्टि करना

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

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

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

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

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

Google API कंसोल प्रोजेक्ट को कॉन्फ़िगर करने के लिए, Google Ads API. Client-ID रिकॉर्ड करें और क्लाइंट सीक्रेट चुनें. इसके बाद, इस पेज पर वापस आएं.

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

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

सेवा में सामान्य निर्देशों का पालन करें खाते गाइड देखें.

अपने 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

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

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

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

डेवलपर टोकन

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

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

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