शुरू करें

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

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

अपनी पसंद के IDE में एक नया Maven/gradle प्रोजेक्ट बनाएं. हमारे आर्टफ़ैक्ट 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 ऐप्लिकेशन डोमेन उपयोगकर्ताओं के लिए, 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 में मौजूद 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'