Search Ads 360 Reporting API का नया वर्शन अब उपलब्ध है. आने वाले समय में किए जाने वाले बदलावों और रिलीज़ के बारे में अप-टू-डेट रहने के लिए, searchads-api-announcements Google ग्रुप में शामिल हों.

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

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

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

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

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

अगर आपने पहले कभी Google API का इस्तेमाल नहीं किया है, तो अपने ऐप्लिकेशन का कोड लिखने से पहले, oauth2l या OAuth 2.0 प्लेग्राउंड का इस्तेमाल करके, ऐप्लिकेशन क्रेडेंशियल और Search Ads 360 Reporting API के साथ प्रयोग किया जा सकता है. इसके अलावा, दी गई उपयोगकर्ता क्रेडेंशियल जनरेशन स्क्रिप्ट को चलाकर, OAuth रीफ़्रेश टोकन भी जनरेट किया जा सकता है.

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

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

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

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN

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

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

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

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

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

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

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

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

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

request-id: 2a5Cj89VV7CNhya1DZjjrC