आरंभ करना

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

नया Maven/Gradle प्रोजेक्ट बनाना

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

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

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

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

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

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

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

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

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

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

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

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

Google खाते के उपयोगकर्ताओं को Google Ads खातों का ऐक्सेस देने के लिए, आपको 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

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

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

सबसे पहले, 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'