इस पेज का अनुवाद Cloud Translation API से किया गया है.

शुरू करें

आप Google Ad Manager API का इस्तेमाल ऐसे ऐप्लिकेशन बनाने के लिए कर सकते हैं जो इन्वेंट्री मैनेज करते हैं, ऑर्डर बनाते हैं, रिपोर्ट बनाते हैं, और दूसरे कई काम करते हैं.

Ad Manager API, एसओएपी का इस्तेमाल करता है. शुरू करने में आपकी मदद करने के लिए, हम Java, .NET, Python, PHP, और Ruby के लिए क्लाइंट लाइब्रेरी ऑफ़र करते हैं.

अपना पहला एपीआई अनुरोध करने के लिए, यह तरीका अपनाएं:

अगर आपके पास पहले से Ad Manager खाता नहीं है, तो Ad Manager खाते के लिए साइन अप करें. अगर आपको किसी अलग एनवायरमेंट में एपीआई की जांच करनी है, तो टेस्ट नेटवर्क भी बनाया जा सकता है. ध्यान दें कि टेस्ट के लिए, आपको AdSense खाते की ज़रूरत नहीं होती.

अपने नेटवर्क कोड को नोट कर लें. अपने नेटवर्क में साइन इन करने पर आपको यह यूआरएल में दिखेगा. उदाहरण के लिए, यूआरएल https://admanager.google.com/1234#home में, 1234 आपका नेटवर्क कोड है.

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

आपको OAuth 2.0 का इस्तेमाल करके, Ad Manager API के सभी अनुरोधों की पुष्टि करनी होगी. नीचे दिए गए चरणों में, Ad Manager के अपने डेटा को ऐक्सेस करने के इस्तेमाल के उदाहरण के बारे में बताया गया है. ज़्यादा जानकारी और अन्य विकल्पों के लिए, पुष्टि करें देखें.

Google API कंसोल क्रेडेंशियल पेज खोलें
प्रोजेक्ट मेन्यू में जाकर, प्रोजेक्ट बनाएं चुनें और प्रोजेक्ट का नाम डालें. आप चाहें, तो दिए गए प्रोजेक्ट आईडी में बदलाव करें. बनाएं पर क्लिक करें.
क्रेडेंशियल पेज पर, क्रेडेंशियल बनाएं चुनें. इसके बाद, सेवा खाता कुंजी चुनें.
नई सेवा खाता चुनें और कुंजी टाइप के तौर पर JSON को चुनें.
निजी कुंजी वाली फ़ाइल डाउनलोड करने के लिए, बनाएं पर क्लिक करें.

अपना Ad Manager नेटवर्क कॉन्फ़िगर करना

Google Ad Manager में साइन इन करें.
साइडबार में, एडमिन > ग्लोबल सेटिंग पर क्लिक करें.
सामान्य सेटिंग > Api ऐक्सेस में, स्लाइडर पर क्लिक करके चालू किया गया पर क्लिक करें.
पेज पर सबसे नीचे, सेव करें बटन पर क्लिक करें.

अपना क्लाइंट सेट अप करें

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.v202402.Network;
import com.google.api.ads.admanager.axis.v202402.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());
  }
}

GitHub पर देखें

Python

यहां एक बुनियादी उदाहरण दिया गया है, जिसमें Python क्लाइंट लाइब्रेरी को इस्तेमाल करने का तरीका दिखाया गया है. Python क्लाइंट लाइब्रेरी, Python v3.6+ के साथ काम करती है. इस्तेमाल की ज़्यादा जानकारी के लिए, क्लाइंट लाइब्रेरी डिस्ट्रिब्यूशन में README फ़ाइल देखें.

लाइब्रेरी इंस्टॉल करें और अपने क्रेडेंशियल सेट अप करें.
किसी शेल में इन निर्देशों को चलाएं:
```
pip install googleads
curl 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='v202402')

# 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']))

GitHub पर देखें

PHP

यहां एक सामान्य उदाहरण दिया गया है, जिसमें PHP क्लाइंट लाइब्रेरी को इस्तेमाल करने का तरीका दिखाया गया है.

लाइब्रेरी इंस्टॉल करें और अपने क्रेडेंशियल सेट अप करें.
क्लाइंट लाइब्रेरी को इंस्टॉल करने के लिए, किसी शेल में नीचे दिए गए निर्देश चलाएं और adsapi_php.ini फ़ाइल को अपनी होम डायरेक्ट्री में डाउनलोड करें:
```
composer require googleads/googleads-php-lib
curl 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"

कुछ कोड चलाएं और अनुरोध करें!

यह उदाहरण कोड कमांड लाइन से चलाया जाना चाहिए, न कि ब्राउज़र से. इस कोड वाली फ़ाइल उस प्रोजेक्ट डायरेक्ट्री के रूट में होनी चाहिए जहां composer require चलाया गया था.

<?php
require 'vendor/autoload.php';
use Google\AdsApi\AdManager\AdManagerSession;
use Google\AdsApi\AdManager\AdManagerSessionBuilder;
use Google\AdsApi\AdManager\v202402\ApiException;
use Google\AdsApi\AdManager\v202402\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()
);

GitHub पर देखें

.NET

यहां .NET क्लाइंट लाइब्रेरी को इस्तेमाल करने का बुनियादी उदाहरण दिया गया है

नया प्रोजेक्ट बनाना
Visual Studio खोलें और एक नया प्रोजेक्ट (कंसोल ऐप्लिकेशन) बनाएं.
अपने प्रोजेक्ट में लाइब्रेरी के ज़रूरी रेफ़रंस जोड़ना
Google.Dfp के लिए nuget डिपेंडेंसी जोड़ें.
अपना App.config सेट अप करें
src\App.config को अपनी प्रोजेक्ट डायरेक्ट्री में कॉपी करें और उसे अपने प्रोजेक्ट में जोड़ें. अगर आपके ऐप्लिकेशन का अपना App.config है, तो इन नोड को अपने App.config में कॉपी किया जा सकता है:
- कॉन्फ़िगरेशन/AdManagerApi
- configuration/configSections/section[name="AdManagerApi"]
- कॉन्फ़िगरेशन/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" />

लाइब्रेरी को कॉल करना

इस सी# कोड स्निपेट में दिखाए गए तरीके का इस्तेमाल करके, लाइब्रेरी को कॉल किया जा सकता है

GitHub पर देखें

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 विकी लेख पढ़ें.

Ruby

यहां एक बुनियादी उदाहरण दिया गया है, जिसमें Ruby क्लाइंट लाइब्रेरी को इस्तेमाल करने का तरीका बताया गया है. Ruby क्लाइंट लाइब्रेरी के लिए Ruby 2.1 या इसके बाद का वर्शन होना ज़रूरी है.

Ruby जेम इंस्टॉल करें और कॉन्फ़िगरेशन फ़ाइल पाएं.
किसी शेल में इन निर्देशों को चलाएं:
```
gem install google-dfp-api
curl https://raw.githubusercontent.com/googleads/google-api-ads-ruby/main/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml
```
अगर आपको अपने जेम इंस्टॉल करते समय किसी भी समय "cannot load such file -- mkmf (LoadError)" जैसी गड़बड़ी मिलती है, तो आपको अपने खास एनवायरमेंट के लिए, अन्य Ruby डेवलपमेंट लाइब्रेरी, जैसे कि Ruby-dev, ruby-devel, xcode-select वगैरह इंस्टॉल करनी पड़ सकती है.
अपने क्रेडेंशियल सेट अप करना
~/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, :v202402)

# Make a request.
network = network_service.get_current_network()

puts "The current network is %s (%d)." %
        [network[:display_name], network[:network_code]]

GitHub पर देखें

शुरू करने के बारे में ज़्यादा जानकारी, README फ़ाइल में मिल सकती है, जिसे Ruby क्लाइंट लाइब्रेरी में उपलब्ध कराया जाता है. साथ ही, रूबी के लिए हमारी पूरी उदाहरण लाइब्रेरी देखें.

अगले चरण

क्लाइंट लाइब्रेरी के चालू होने के बाद, दिए गए उदाहरणों में बदलाव करें, ताकि आप उन्हें अपनी ज़रूरत के हिसाब से बढ़ा सकें.

एपीआई के बारे में ज़्यादा जानने के लिए, रेफ़रंस दस्तावेज़ ब्राउज़ करें.

अगर आपको मदद चाहिए, तो हमारे सहायता पेज पर जाएं.

शुरू करें

Ad Manager नेटवर्क का ऐक्सेस पाना

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

अपना Ad Manager नेटवर्क कॉन्फ़िगर करना

अपना क्लाइंट सेट अप करें

Java

Python

PHP

.NET

Ruby

अगले चरण