क्या आपको REST API चाहिए? Ad Manager API (बीटा) अब उपलब्ध है.

इस पेज का अनुवाद 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 Ads में साइन इन करें मैनेजर.
साइडबार में, एडमिन > ग्लोबल सेटिंग.
सामान्य सेटिंग > एपीआई ऐक्सेस करने के लिए, स्लाइडर पर क्लिक करके चालू है पर जाएं.
पेज पर सबसे नीचे मौजूद, सेव करें बटन पर क्लिक करें.

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

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.v202408.Network;
import com.google.api.ads.admanager.axis.v202408.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='v202408')

# 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\v202408\ApiException;
use Google\AdsApi\AdManager\v202408\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 के लिए कोई नुगेट डिपेंडेंसी जोड़ें.
अपना 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# कोड स्निपेट में दिखाया गया है

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 में अपने क्रेडेंशियल सेट नहीं करना है, तो इस विकी लेख पर का इस्तेमाल करें. .NET क्लाइंट लाइब्रेरी का इस्तेमाल करने के बारे में ज़्यादा जानने के लिए, README तक . अगर आपको क्लाइंट लाइब्रेरी के बिना, .net में डेवलप करना है, तो कृपया NoClientLibrary विकी लेख.

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 डेवलपमेंट लाइब्रेरी इंस्टॉल करने की ज़रूरत पड़ सकती है, जैसे कि Ruy-dev, रूबी-डेवल, 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, :v202408)

# 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

अगले चरण