शुरू करें

हमारा सुझाव है कि आप Apache Maven या Gradle के साथ क्लाइंट लाइब्रेरी का इस्तेमाल करें.

नया Maven/Gredle प्रोजेक्ट बनाएं

अपनी पसंद के IDE में नया Maven/Gradle प्रोजेक्ट बनाएं. हमारे आर्टफ़ैक्ट, Maven सेंट्रल रिपॉज़िटरी में पब्लिश किए गए हैं.

Maven डिपेंडेंसी:

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>google-ads</artifactId>
  <version>31.0.0</version>
</dependency>

Gradle डिपेंडेंसी:

implementation 'com.google.api-ads:google-ads:31.0.0'

सोर्स से भी बिल्ड भी किया जा सकता है. इस गाइड के लिए, यह माना गया है कि आपके पास ज़रूरी डिपेंडेंसी के साथ एक प्रोजेक्ट सेट अप है.

एपीआई से पुष्टि करने के लिए क्रेडेंशियल पाएं

Google Ads API को ऐक्सेस करने के लिए, OAuth क्रेडेंशियल और Google Ads API डेवलपर टोकन की ज़रूरत होती है. इस सेक्शन में बताया गया है कि ये क्या हैं, इनका इस्तेमाल कैसे किया जाता है, और ये कैसे हासिल की जाती हैं.

डेवलपर टोकन (एपीआई ऐक्सेस करने के लिए)

डेवलपर टोकन किसी मैनेजर खाते से लिंक होता है और Google Ads वेब इंटरफ़ेस में देखा जा सकता है.

हालांकि डेवलपर टोकन किसी मैनेजर खाते से लिंक होता है, लेकिन यह उस खाते का ऐक्सेस नहीं देता. इसके बजाय, डेवलपर टोकन, एपीआई को सामान्य तौर पर ऐक्सेस देता है और खाता लेवल का ऐक्सेस, OAuth के ज़रिए कॉन्फ़िगर किया जाता है.

OAuth क्रेडेंशियल (Google Ads खातों को ऐक्सेस करने के लिए)

Google Ads खातों का ऐक्सेस रखने वाले Google खाते के उपयोगकर्ता के तौर पर अनुमति देने के लिए, आपको OAuth क्रेडेंशियल का एक सेट देना होगा.

आम तौर पर, दो OAuth फ़्लो इस्तेमाल किए जाते हैं: डेस्कटॉप (इंस्टॉल किए गए) ऐप्लिकेशन या वेब ऐप्लिकेशन. दोनों में मुख्य अंतर यह है कि डेस्कटॉप ऐप्लिकेशन को सिस्टम ब्राउज़र खोलना होगा और Google के ऑथराइज़ेशन सर्वर से मिले जवाबों को मैनेज करने के लिए, एक लोकल रीडायरेक्ट यूआरआई उपलब्ध कराना होगा. वहीं, वेब ऐप्लिकेशन अनुमति देने और क्रेडेंशियल को आपके सर्वर पर वापस भेजने के लिए, तीसरे पक्ष के किसी भी ब्राउज़र को रीडायरेक्ट कर सकते हैं. यह लाइब्रेरी, आम तौर पर कम इस्तेमाल होने वाले सेवा खाते के फ़्लो के साथ भी काम करती है.

अपने क्रेडेंशियल का इस्तेमाल करके अनुमति देने पर (डेस्कटॉप ऐप्लिकेशन का फ़्लो)
OAuth डेस्कटॉप ऐप्लिकेशन फ़्लो देखें. इसमें वह सारी जानकारी शामिल है जिसकी ज़रूरत आपको अपने क्रेडेंशियल से देने के लिए होती है.
तीसरे पक्ष के Google उपयोगकर्ता के तौर पर अनुमति देने पर (वेब फ़्लो)
OAuth वेब ऐप्लिकेशन फ़्लो देखें. यहां एक उदाहरण में बताया गया है कि तीसरे पक्ष के आर्बिट्रेरी उपयोगकर्ताओं के लिए, OAuth की अनुमति कैसे सेट अप की जाती है.
यदि आप Google Apps डोमेन उपयोगकर्ता (सेवा खाता प्रवाह) के रूप में अधिकृत करते हैं
OAuth सेवा खाते के फ़्लो के बारे में जानें. इससे, Google Apps डोमेन उपयोगकर्ताओं के लिए OAuth की मदद से पुष्टि करने की सुविधा सेट अप करने के तरीके का उदाहरण दिया गया है.

अगर आपको Google Ads ग्राहक खाते का ऐक्सेस, Google Ads मैनेजर खाते के ज़रिए मिला है, तो आपको एक लॉगिन ग्राहक आईडी भी बताना होगा. इसका तरीका नीचे बताया गया है.

लॉगिन ग्राहक आईडी (मैनेजर खाते से Google Ads खातों को ऐक्सेस करने के लिए)

इसके अलावा, आपके पास उस मैनेजर खाते का ग्राहक आईडी बताने का विकल्प भी है जो विज्ञापन दिखाने वाले खाते का ऐक्सेस देता है. अगर ग्राहक खाते को आपका ऐक्सेस, मैनेजर खाते के ज़रिए मिला है, तो आपको यह बताना होगा. ग्राहक आईडी वाले पाथ पर मौजूद सभी मैनेजर खातों के बारे में बताने की ज़रूरत नहीं है. यह सिर्फ़ सबसे ऊपर मौजूद मैनेजर आईडी है, जिसका इस्तेमाल ऐक्सेस अनुमतियों के लिए किया जा रहा है. ज़्यादा जानकारी के लिए, इसी विषय से जुड़े दस्तावेज़ देखें.

अपने क्रेडेंशियल की मदद से क्लाइंट लाइब्रेरी कॉन्फ़िगर करना

क्लाइंट लाइब्रेरी को कॉन्फ़िगरेशन फ़ाइल, एनवायरमेंट वैरिएबल या प्रोग्राम की मदद से कॉन्फ़िगर किया जा सकता है. इस गाइड के लिए, हम कॉन्फ़िगरेशन फ़ाइल वाले तरीके का इस्तेमाल करेंगे. साथ ही, डेस्कटॉप और वेब फ़्लो पर फ़ोकस करेंगे. अगर आपके पास क्रेडेंशियल का सिर्फ़ एक सेट है, तो आम तौर पर कॉन्फ़िगरेशन फ़ाइल का इस्तेमाल करना बेहतर होता है. उदाहरण के लिए, एक ही मैनेजर से खाते मैनेज किए जा सकते हैं.

इस कॉन्टेंट के साथ ~/ads.properties फ़ाइल बनाएं:

api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE

प्लेसहोल्डर को पिछले चरण में मिले क्रेडेंशियल से बदलें.

इसके अलावा, अगर आपका रीफ़्रेश टोकन किसी मैनेजर खाते के लिए है, तो आपको लॉगिन ग्राहक के तौर पर इस खाते का ग्राहक आईडी बताना होगा:

api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

क्रेडेंशियल की पुष्टि करें

यह पक्का करने के लिए कि सब कुछ सही तरीके से सेटअप हो गया है, हम GetCampaign उदाहरण चलाएंगे.

सबसे पहले, google-ads-examples डायरेक्ट्री पर जाएं.

$ cd google-ads-examples

इस उदाहरण में --customerId पैरामीटर होना ज़रूरी है. इसकी वैल्यू, बिना डैश के आपके Google Ads खाते का ग्राहक आईडी है.

Gradle के साथ चलाने के लिए:

$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"

अन्य उदाहरण देखें

google-ads-examples में मौजूद उदाहरण पैकेज में कई उपयोगी उदाहरण शामिल हैं. ज़्यादातर उदाहरणों में, पैरामीटर की ज़रूरत होती है. पैरामीटर को आर्ग्युमेंट (सुझाया गया) के तौर पर पास किया जा सकता है या सोर्स कोड में INSERT_XXXXX_HERE वैल्यू में बदलाव किया जा सकता है. उदाहरण के लिए, इस्तेमाल स्टेटमेंट देखने के लिए, सिर्फ़ --help को तर्क के तौर पर पास करें.

Gradle के साथ:

$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --help"

Gradle में listExamples टास्क का इस्तेमाल करके, सभी उदाहरणों, सबडायरेक्ट्री के उदाहरण या ऐसे उदाहरण भी शामिल किए जा सकते हैं जिनमें खोज के लिए इस्तेमाल हुए शब्द शामिल हों.

# List all examples:
$ ./gradlew -q listExamples
# List examples in the 'basicoperations' subdirectory:
$ ./gradlew -q listExamples --subdirectory='basicoperations'
# Search for examples where the description includes 'Performance Max':
$ ./gradlew -q listExamples --searchTerm='Performance Max'