Google Ads API, पुष्टि और अनुमति देने के लिए OAuth 2.0 प्रोटोकॉल का इस्तेमाल करता है. यह प्रोटोकॉल, Google के अन्य एपीआई के लिए भी इस्तेमाल किया जाता है. OAuth 2.0 की मदद से, Google Ads API का क्लाइंट ऐप्लिकेशन, उपयोगकर्ता की लॉगिन जानकारी को मैनेज या सेव किए बिना, उसके Google Ads खाते को ऐक्सेस कर सकता है.
Google Ads के ऐक्सेस मॉडल के बारे में जानकारी
Google Ads API के साथ बेहतर तरीके से काम करने के लिए, आपको Google Ads के ऐक्सेस मॉडल के काम करने के तरीके के बारे में पता होना चाहिए. हमारा सुझाव है कि Google Ads के ऐक्सेस मॉडल के बारे में बताने वाली गाइड पढ़ें.
OAuth के वर्कफ़्लो
Google Ads API के साथ काम करते समय, आम तौर पर तीन वर्कफ़्लो इस्तेमाल किए जाते हैं.
सेवा खाते का वर्कफ़्लो
अगर आपके वर्कफ़्लो में, किसी व्यक्ति के इंटरैक्शन की ज़रूरत नहीं है, तो हमारा सुझाव है कि आप इस वर्कफ़्लो का इस्तेमाल करें. इस वर्कफ़्लो के लिए, कॉन्फ़िगरेशन का एक चरण ज़रूरी है. इसमें उपयोगकर्ता, अपने Google Ads खाते में एक सेवा खाता जोड़ता है. इसके बाद, ऐप्लिकेशन, सेवा खाते के क्रेडेंशियल का इस्तेमाल करके, उपयोगकर्ता के Google Ads खाते को मैनेज कर सकता है. लाइब्रेरी को इस तरह कॉन्फ़िगर किया जाता है:
// Initialize a GoogleAdsConfig class.
GoogleAdsConfig config = new GoogleAdsConfig()
{
DeveloperToken = "******",
OAuth2Mode = OAuth2Flow.SERVICE_ACCOUNT,
OAuth2SecretsJsonPath = "PATH_TO_CREDENTIALS_JSON",
LoginCustomerId = ******
};
// Initialize a GoogleAdsClient class.
GoogleAdsClient client = new GoogleAdsClient(config);
ज़्यादा जानने के लिए, सेवा खाते के वर्कफ़्लो के बारे में बताने वाली गाइड देखें.
एक उपयोगकर्ता की पुष्टि करने का वर्कफ़्लो
अगर सेवा खातों का इस्तेमाल नहीं किया जा सकता, तो इस वर्कफ़्लो का इस्तेमाल किया जा सकता है. इस वर्कफ़्लो के लिए, कॉन्फ़िगरेशन के दो चरण ज़रूरी हैं:
- Google Ads API का इस्तेमाल करके मैनेज किए जाने वाले सभी खातों का ऐक्सेस, किसी एक उपयोगकर्ता को दें. आम तौर पर, उपयोगकर्ता को Google Ads API के मैनेजर खाते का ऐक्सेस दिया जाता है. इसके बाद, उस मैनेजर खाते से सभी Google Ads खातों को लिंक किया जाता है.
- उपयोगकर्ता, gcloud जैसे कमांड-लाइन टूल या
GenerateUserCredentialsकोड के उदाहरण को चलाकर, आपके ऐप्लिकेशन को अपने सभी Google Ads खातों को मैनेज करने की अनुमति देता है.
लाइब्रेरी को, उपयोगकर्ता के OAuth 2.0 क्रेडेंशियल का इस्तेमाल करके, इस तरह शुरू किया जा सकता है:
GoogleAdsConfig googleAdsConfig = new GoogleAdsConfig()
{
DeveloperToken = DEVELOPER_TOKEN,
LoginCustomerId = LOGIN_CUSTOMER_ID,
OAuth2ClientId = OAUTH_CLIENT_ID,
OAuth2ClientSecret = OAUTH_CLIENT_SECRET,
OAuth2RefreshToken = REFRESH_TOKEN,
};
GoogleAdsClient googleAdsClient = new GoogleAdsClient(googleAdsConfig);
ज़्यादा जानने के लिए, एक उपयोगकर्ता की पुष्टि करने के वर्कफ़्लो के बारे में बताने वाली गाइड देखें.
डिवाइस के एक से ज़्यादा उपयोगकर्ताओं की पुष्टि करने का वर्कफ़्लो
अगर आपका ऐप्लिकेशन, उपयोगकर्ताओं को साइन इन करने और आपके ऐप्लिकेशन को अपने Google Ads खातों को मैनेज करने की अनुमति देने की सुविधा देता है, तो हमारा सुझाव है कि आप इस वर्कफ़्लो का इस्तेमाल करें. आपका ऐप्लिकेशन, OAuth 2.0 के उपयोगकर्ता क्रेडेंशियल बनाता और मैनेज करता है. लाइब्रेरी को, उपयोगकर्ता के क्रेडेंशियल का इस्तेमाल करके, इस तरह शुरू किया जा सकता है:
GoogleAdsConfig googleAdsConfig = new GoogleAdsConfig()
{
DeveloperToken = DEVELOPER_TOKEN,
LoginCustomerId = LOGIN_CUSTOMER_ID,
OAuth2ClientId = OAUTH_CLIENT_ID,
OAuth2ClientSecret = OAUTH_CLIENT_SECRET,
OAuth2RefreshToken = REFRESH_TOKEN,
};
GoogleAdsClient googleAdsClient = new GoogleAdsClient(googleAdsConfig);
ज़्यादा जानने के लिए, डिवाइस के एक से ज़्यादा उपयोगकर्ताओं की पुष्टि करने के वर्कफ़्लो के बारे में बताने वाली गाइड देखें. .NET क्लाइंट लाइब्रेरी में, रेफ़रंस के लिए कोड के दो उदाहरण शामिल हैं:
AuthenticateInAspNetCoreApplicationकोड के उदाहरण से पता चलता है कि वेब ऐप्लिकेशन कैसे बनाया जाता है. यह ऐप्लिकेशन, उपयोगकर्ता के Google Ads खातों को मैनेज करने के लिए, रनटाइम पर उपयोगकर्ता की पुष्टि करता है. ऐप्लिकेशन, उपयोगकर्ता के OAuth 2.0 क्रेडेंशियल का इस्तेमाल करके, उसके Google Ads खाते में मौजूद कैंपेन को वापस पाता है.GenerateUserCredentials, कमांड लाइन कोड का एक उदाहरण है. इससे पता चलता है कि रनटाइम पर उपयोगकर्ता की पुष्टि कैसे की जाती है, ताकि उसके Google Ads खातों को मैनेज किया जा सके. डेस्कटॉप ऐप्लिकेशन बनाने के लिए, इस कोड के उदाहरण को रेफ़रंस के तौर पर इस्तेमाल किया जा सकता है. इन ऐप्लिकेशन के लिए, उपयोगकर्ता की पुष्टि करना ज़रूरी है.
अगर मेरा उपयोगकर्ता, एक से ज़्यादा खाते मैनेज करता है, तो क्या होगा?
आम तौर पर, कोई उपयोगकर्ता एक से ज़्यादा Google Ads खाते मैनेज करता है. ऐसा सीधे तौर पर खातों को ऐक्सेस करके या Google Ads के मैनेजर खाते के ज़रिए किया जाता है. .NET क्लाइंट लाइब्रेरी में, कोड के ये उदाहरण दिए गए हैं. इनसे पता चलता है कि ऐसे मामलों को कैसे हैंडल किया जाता है.
- GetAccountHierarchy कोड के उदाहरण से पता चलता है कि Google Ads मैनेजर खाते के तहत मौजूद सभी खातों की सूची कैसे वापस पाई जाती है.
- ListAccessibleCustomers कोड के उदाहरण से पता चलता है
कि उन सभी खातों की सूची कैसे वापस पाई जाती है जिन्हें उपयोगकर्ता सीधे तौर पर ऐक्सेस कर सकता है.
इसके बाद, इन खातों को
LoginCustomerIdसेटिंग के लिए मान्य वैल्यू के तौर पर इस्तेमाल किया जा सकता है.
ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल
.NET क्लाइंट लाइब्रेरी, ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल से पुष्टि करने की सुविधा भी देती है.
यह सुविधा, स्थानीय डेवलपमेंट या Google के अलग-अलग एपीआई के लिए डेवलपमेंट के दौरान खास तौर पर काम आती है. ऐसा इसलिए, क्योंकि एक ही क्रेडेंशियल को फिर से इस्तेमाल किया जा सकता है. हालांकि, इसके लिए यह ज़रूरी है कि वे सही OAuth 2.0 दायरे को ऐक्सेस कर सकें.
Google Ads API के लिए, पक्का करें कि आपके ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल, https://www.googleapis.com/auth/adwords OAuth2.0 दायरे को ऐक्सेस कर सकें.
ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल का इस्तेमाल करने के लिए, अपने GoogleAdsConfig में UseApplicationDefaultCredentials विकल्प को true पर सेट करें. ऐसा क्लाइंट लाइब्रेरी में, कॉन्फ़िगरेशन की अन्य प्रॉपर्टी सेट करने के तरीके से किया जा सकता है. जैसे, अपने कोड में, कॉन्फ़िगरेशन फ़ाइल में या एनवायरमेंट वैरिएबल का इस्तेमाल करके.
.NET क्लाइंट लाइब्रेरी को कॉन्फ़िगर करने के लिए उपलब्ध विकल्पों के बारे में ज़्यादा जानने के लिए, कॉन्फ़िगरेशन पेज देखें.