Google Ad Manager SOAP API का इस्तेमाल करके, ऐसे ऐप्लिकेशन बनाए जा सकते हैं जो इन्वेंट्री को मैनेज करते हैं, ऑर्डर बनाते हैं, रिपोर्ट जनरेट करते हैं, और अन्य काम करते हैं.
हम Java, .NET, Python, PHP, और Ruby के लिए क्लाइंट लाइब्रेरी उपलब्ध कराते हैं, ताकि आपको इसका इस्तेमाल शुरू करने में मदद मिल सके.
एपीआई का पहला अनुरोध करने के लिए, यह तरीका अपनाएं:
Ad Manager नेटवर्क का ऐक्सेस पाना
अगर आपके पास पहले से कोई खाता नहीं है, तो Ad Manager खाते के लिए साइन अप करें. अगर आपको एपीआई को किसी अलग एनवायरमेंट में टेस्ट करना है, तो टेस्ट नेटवर्क भी बनाया जा सकता है. ध्यान दें कि टेस्ट के लिए, AdSense खाते की ज़रूरत नहीं होती.
अपने नेटवर्क कोड को नोट करें. यह जानकारी आपको नेटवर्क में साइन इन करते समय यूआरएल में मिलेगी. उदाहरण के लिए, यूआरएल https://admanager.google.com/1234#home में, 1234 आपका नेटवर्क कोड है.
पुष्टि करने वाले क्रेडेंशियल बनाना
आपको OAuth 2.0 का इस्तेमाल करके, Ad Manager SOAP API के सभी अनुरोधों की पुष्टि करनी होगी. यहां दिए गए तरीके से, Ad Manager के अपने डेटा को ऐक्सेस किया जा सकता है. ज़्यादा जानकारी और अन्य विकल्पों के लिए, पुष्टि करना लेख पढ़ें.
प्रोजेक्ट मेन्यू में जाकर, प्रोजेक्ट बनाएं को चुनें. इसके बाद, प्रोजेक्ट का नाम डालें. इसके अलावा, आपके पास दिए गए प्रोजेक्ट आईडी में बदलाव करने का विकल्प भी होता है. बनाएं पर क्लिक करें.
क्रेडेंशियल पेज पर, क्रेडेंशियल बनाएं को चुनें. इसके बाद, सेवा खाते की कुंजी को चुनें.
नया सेवा खाता चुनें. इसके बाद, कुंजी के टाइप के तौर पर
JSONचुनें.निजी कुंजी वाली फ़ाइल डाउनलोड करने के लिए, बनाएं पर क्लिक करें.
Ad Manager नेटवर्क को कॉन्फ़िगर करना
Google Ad Manager में साइन इन करें.
साइडबार में, एडमिन > ग्लोबल सेटिंग पर क्लिक करें.
सामान्य सेटिंग > एपीआई ऐक्सेस में जाकर, स्लाइडर को चालू है पर क्लिक करें.
पेज पर सबसे नीचे मौजूद, सेव करें बटन पर क्लिक करें.
अपने क्लाइंट की सदस्यता सेट अप करना
Ad Manager की क्लाइंट लाइब्रेरी में से कोई एक लाइब्रेरी डाउनलोड करें. लाइब्रेरी में रैपर फ़ंक्शन और सुविधाएं होती हैं. इनकी मदद से, ऐप्लिकेशन को आसानी से और तेज़ी से डेवलप किया जा सकता है.
यहां दिए गए टैब में, उन सभी भाषाओं में कोडिंग करने के लिए क्विकस्टार्ट दिए गए हैं जिनके लिए क्लाइंट लाइब्रेरी उपलब्ध है.
Java
यहां एक बुनियादी उदाहरण दिया गया है, जिसमें Java क्लाइंट लाइब्रेरी का इस्तेमाल करने का तरीका दिखाया गया है. इस्तेमाल से जुड़ी ज़्यादा जानकारी के लिए, क्लाइंट लाइब्रेरी डिस्ट्रिब्यूशन में मौजूद README फ़ाइल देखें.
- अपने क्रेडेंशियल सेट अप करना
शेल में यह कमांड चलाएं:
curl https://raw.githubusercontent.com/googleads/googleads-java-lib/main/examples/admanager_axis/src/main/resources/ads.properties -o ~/ads.properties~/ads.propertiesफ़ाइल खोलें और इन फ़ील्ड में जानकारी भरें:[...] api.admanager.applicationName=INSERT_APPLICATION_NAME_HERE api.admanager.jsonKeyFilePath=INSERT_PATH_TO_JSON_KEY_FILE_HERE api.admanager.networkCode=INSERT_NETWORK_CODE_HERE [...]
-
डिपेंडेंसी तय करना
अपनी
pom.xmlफ़ाइल में बदलाव करें औरdependenciesटैग में यह जानकारी जोड़ें. आपको GitHub पर, सबसे नए वर्शन का नंबर मिल सकता है.<dependency> <groupId>com.google.api-ads</groupId> <artifactId>ads-lib</artifactId> <version>RELEASE</version> </dependency> <dependency> <groupId>com.google.api-ads</groupId> <artifactId>dfp-axis</artifactId> <version>RELEASE</version> </dependency>
-
कुछ कोड लिखें और अनुरोध करें!
import com.google.api.ads.common.lib.auth.OfflineCredentials; import com.google.api.ads.common.lib.auth.OfflineCredentials.Api; import com.google.api.ads.admanager.axis.factory.AdManagerServices; import com.google.api.ads.admanager.axis.v202608.Network; import com.google.api.ads.admanager.axis.v202608.NetworkServiceInterface; import com.google.api.ads.admanager.lib.client.AdManagerSession; import com.google.api.client.auth.oauth2.Credential; public class App { public static void main(String[] args) throws Exception { Credential oAuth2Credential = new OfflineCredentials.Builder() .forApi(Api.AD_MANAGER) .fromFile() .build() .generateCredential(); // Construct an AdManagerSession. AdManagerSession session = new AdManagerSession.Builder() .fromFile() .withOAuth2Credential(oAuth2Credential) .build(); // Construct a Google Ad Manager service factory, which can only be used once per // thread, but should be reused as much as possible. AdManagerServices adManagerServices = new AdManagerServices(); // Retrieve the appropriate service NetworkServiceInterface networkService = adManagerServices.get(session, NetworkServiceInterface.class); // Make a request Network network = networkService.getCurrentNetwork(); System.out.printf("Current network has network code '%s' and display" + " name '%s'.%n", network.getNetworkCode(), network.getDisplayName()); } }
Python
यहां एक बुनियादी उदाहरण दिया गया है. इसमें Python क्लाइंट लाइब्रेरी का इस्तेमाल करने का तरीका दिखाया गया है. Python क्लाइंट लाइब्रेरी, Python v3.6 और इसके बाद के वर्शन के साथ काम करती है. इस्तेमाल करने के बारे में ज़्यादा जानकारी पाने के लिए, क्लाइंट लाइब्रेरी डिस्ट्रिब्यूशन में मौजूद README फ़ाइल देखें.
- लाइब्रेरी इंस्टॉल करें और अपने क्रेडेंशियल सेट अप करें.
शेल में ये कमांड चलाएं:
python3 -m pip install googleadscurl https://raw.githubusercontent.com/googleads/googleads-python-lib/main/googleads.yaml \ -o ~/googleads.yaml - अपनी
~/googleads.yamlफ़ाइल सेट अप करें.यहां दिए गए फ़ील्ड में जानकारी भरें:
ad_manager: application_name: INSERT_APPLICATION_NAME_HERE network_code: INSERT_NETWORK_CODE_HERE path_to_private_key_file: INSERT_PATH_TO_FILE_HERE
-
कुछ कोड चलाएं और अनुरोध करें.
# Import the library. from googleads import ad_manager # Initialize a client object, by default uses the credentials in ~/googleads.yaml. client = ad_manager.AdManagerClient.LoadFromStorage() # Initialize a service. network_service = client.GetService('NetworkService', version='v202608') # Make a request. current_network = network_service.getCurrentNetwork() print("Current network has network code '%s' and display name '%s'." % (current_network['networkCode'], current_network['displayName']))
PHP
यहां एक बुनियादी उदाहरण दिया गया है, जिसमें PHP क्लाइंट लाइब्रेरी का इस्तेमाल करने का तरीका बताया गया है.
-
लाइब्रेरी इंस्टॉल करें और अपने क्रेडेंशियल सेट अप करें.
क्लाइंट लाइब्रेरी इंस्टॉल करने के लिए, शेल में ये कमांड चलाएं. साथ ही, adsapi_php.ini फ़ाइल को अपनी होम डायरेक्ट्री में डाउनलोड करें:
composer require googleads/googleads-php-libcurl https://raw.githubusercontent.com/googleads/googleads-php-lib/main/examples/AdManager/adsapi_php.ini -o ~/adsapi_php.ini -
अपनी
~/adsapi_php.iniफ़ाइल सेट अप करें.यहां दिए गए फ़ील्ड में जानकारी भरें:
[AD_MANAGER] networkCode = "INSERT_NETWORK_CODE_HERE" applicationName = "INSERT_APPLICATION_NAME_HERE" [OAUTH2] jsonKeyFilePath = "INSERT_ABSOLUTE_PATH_TO_OAUTH2_JSON_KEY_FILE_HERE" scopes = "https://www.googleapis.com/auth/dfp"
-
कुछ कोड चलाकर देखें और अनुरोध करें!
<?php require 'vendor/autoload.php'; use Google\AdsApi\AdManager\AdManagerSession; use Google\AdsApi\AdManager\AdManagerSessionBuilder; use Google\AdsApi\AdManager\v202608\ApiException; use Google\AdsApi\AdManager\v202608\ServiceFactory; use Google\AdsApi\Common\OAuth2TokenBuilder; // Generate a refreshable OAuth2 credential for authentication. $oAuth2Credential = (new OAuth2TokenBuilder()) ->fromFile() ->build(); // Construct an API session configured from a properties file and the OAuth2 // credentials above. $session = (new AdManagerSessionBuilder()) ->fromFile() ->withOAuth2Credential($oAuth2Credential) ->build(); // Get a service. $serviceFactory = new ServiceFactory(); $networkService = $serviceFactory->createNetworkService($session); // Make a request $network = $networkService->getCurrentNetwork(); printf( "Network with code %d and display name '%s' was found.\n", $network->getNetworkCode(), $network->getDisplayName() );
.NET
यहां एक बुनियादी उदाहरण दिया गया है, जिसमें .NET क्लाइंट लाइब्रेरी का इस्तेमाल करने का तरीका दिखाया गया है
- नया प्रोजेक्ट बनाना
Visual Studio खोलें और एक नया प्रोजेक्ट (Console Application) बनाएं.
- अपने प्रोजेक्ट में ज़रूरी लाइब्रेरी रेफ़रंस जोड़ना
Google.Dfp के लिए nuget डिपेंडेंसी जोड़ें.
- App.config फ़ाइल को सेटअप करना
src\App.config को अपनी प्रोजेक्ट डायरेक्ट्री में कॉपी करें और उसे अपने प्रोजेक्ट में जोड़ें. अगर आपके ऐप्लिकेशन का अपना App.config है, तो इन नोड को अपने App.config में कॉपी करें:
- configuration/AdManagerApi
- configuration/configSections/section[name="AdManagerApi"]
- configuration/system.net
- क्रेडेंशियल सेटअप करना
App.config खोलें और इन कुंजियों में बदलाव करें:
<add key="ApplicationName" value="INSERT_YOUR_APPLICATION_NAME_HERE" /> <add key="NetworkCode" value="INSERT_YOUR_NETWORK_CODE_HERE" /> <add key="OAuth2Mode" value="SERVICE_ACCOUNT" /> <add key="OAuth2SecretsJsonPath" value="INSERT_OAUTH2_SECRETS_JSON_FILE_PATH_HERE" />
- लाइब्रेरी को कॉल करना
लाइब्रेरी को कॉल करने के लिए, यहां दिए गए C# कोड के स्निपेट का इस्तेमाल करें
AdManagerUser user = new AdManagerUser(); using (InventoryService inventoryService = user.GetService<InventoryService>()) { // Create a statement to select ad units. int pageSize = StatementBuilder.SUGGESTED_PAGE_LIMIT; StatementBuilder statementBuilder = new StatementBuilder().OrderBy("id ASC").Limit(pageSize); // Retrieve a small amount of ad units at a time, paging through until all // ad units have been retrieved. int totalResultSetSize = 0; do { AdUnitPage page = inventoryService.getAdUnitsByStatement(statementBuilder.ToStatement()); // Print out some information for each ad unit. if (page.results != null) { totalResultSetSize = page.totalResultSetSize; int i = page.startIndex; foreach (AdUnit adUnit in page.results) { Console.WriteLine( "{0}) Ad unit with ID \"{1}\" and name \"{2}\" was found.", i++, adUnit.id, adUnit.name); } } statementBuilder.IncreaseOffsetBy(pageSize); } while (statementBuilder.GetOffset() < totalResultSetSize); Console.WriteLine("Number of results found: {0}", totalResultSetSize); }
अगर आपको App.config में अपने क्रेडेंशियल सेट नहीं करने हैं, तो AdManagerUser क्लास का इस्तेमाल करने के अन्य तरीकों के लिए, यह विकी लेख पढ़ें. .NET क्लाइंट लाइब्रेरी इस्तेमाल करने के बारे में ज़्यादा जानकारी के लिए, README देखें. अगर आपको क्लाइंट लाइब्रेरी के बिना .NET में डेवलप करना है, तो कृपया NoClientLibrary wiki लेख पढ़ें.
Ruby
यहां एक बुनियादी उदाहरण दिया गया है, जिसमें Ruby क्लाइंट लाइब्रेरी का इस्तेमाल करने का तरीका दिखाया गया है. Ruby क्लाइंट लाइब्रेरी के लिए, Ruby 2.1 या इसके बाद का वर्शन ज़रूरी है.
-
Ruby gem इंस्टॉल करें और कॉन्फ़िगरेशन फ़ाइल पाएं.
शेल में ये कमांड चलाएं:
gem install google-dfp-apicurl https://raw.githubusercontent.com/googleads/google-api-ads-ruby/main/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml -
अपने क्रेडेंशियल सेट अप करना
~/ad_manager_api.ymlफ़ाइल में ज़रूरी फ़ील्ड की जानकारी भरें. अगर आपके पास पहले से कोई OAuth2 कीफ़ाइल नहीं है, तो आपको OAuth2 क्रेडेंशियल बनाने के लिए, यह तरीका अपनाना होगा.:authentication: :oauth2_keyfile: INSERT_PATH_TO_JSON_KEY_FILE_HERE :application_name: INSERT_APPLICATION_NAME_HERE :network_code: INSERT_NETWORK_CODE_HERE
-
कुछ कोड लिखें और अनुरोध करें!
# Import the library. require 'ad_manager_api' # Initialize an Ad Manager client instance (uses credentials in ~/ad_manager_api.yml by default). ad_manager = AdManagerApi::Api.new # Get a service instance. network_service = ad_manager.service(:NetworkService, :v202608) # Make a request. network = network_service.get_current_network() puts "The current network is %s (%d)." % [network[:display_name], network[:network_code]]
शुरू करने के बारे में ज़्यादा जानकारी, Ruby क्लाइंट लाइब्रेरी के साथ डिस्ट्रिब्यूट की गई README फ़ाइल में देखी जा सकती है. साथ ही, Ruby के लिए उदाहरणों की पूरी लाइब्रेरी देखें.
अगले चरण
क्लाइंट लाइब्रेरी का इस्तेमाल शुरू करने के बाद, दिए गए उदाहरणों में बदलाव करें, ताकि उन्हें अपनी ज़रूरतों के हिसाब से इस्तेमाल किया जा सके.
एपीआई के बारे में ज़्यादा जानने के लिए, रेफ़रंस दस्तावेज़ ब्राउज़ करें.
अगर आपको मदद चाहिए, तो हमारे सहायता पेज पर जाएं.