Başlama

Envanteri yöneten, sipariş oluşturan, raporları alan ve daha fazlasını yapan uygulamalar oluşturmak için Google Ad Manager SOAP API'yi kullanabilirsiniz.

Başlamanıza yardımcı olmak için Java, .NET, Python, PHP ve Ruby için istemci kitaplıkları sunuyoruz.

İlk API isteğinizi göndermek için aşağıdaki adımları uygulayın:

Ad Manager ağına erişim elde etme

Henüz bir hesabınız yoksa Ad Manager hesabı için kaydolun. API'yi ayrı bir ortamda test etmek istiyorsanız test ağı da oluşturabilirsiniz. Test amacıyla AdSense hesabına ihtiyacınız olmadığını unutmayın.

Ağ kodunuzu not edin. Ağınızda oturum açtığınızda bunu URL'de bulabilirsiniz. Örneğin, https://admanager.google.com/1234#home URL'sinde 1234 ağ kodunuzdur.

Kimlik doğrulama bilgileri oluşturma

Tüm Ad Manager SOAP API isteklerinin kimliğini OAuth 2.0 kullanarak doğrulamanız gerekir. Aşağıdaki adımlarda, kendi Ad Manager verilerinize erişme kullanım alanı ele alınmaktadır. Daha fazla bilgi ve diğer seçenekler için Kimlik doğrulama başlıklı makaleyi inceleyin.

  1. Google API Konsolu Kimlik Bilgileri sayfasını açın.

  2. Proje menüsünden Proje oluştur'u seçin, proje için bir ad girin ve isteğe bağlı olarak, sağlanan proje kimliğini düzenleyin. Oluştur'u tıklayın.

  3. Kimlik Bilgileri sayfasında Kimlik bilgileri oluştur'u ve ardından Hizmet hesabı anahtarı'nı seçin.

  4. Yeni hizmet hesabı'nı seçin ve anahtar türü olarak JSON değerini belirleyin.

  5. Özel anahtar içeren bir dosya indirmek için Oluştur'u tıklayın.

Ad Manager ağınızı yapılandırma

  1. Google Ad Manager'da oturum açın.

  2. Kenar çubuğunda Yönetici > Genel ayarlar'ı tıklayın.

  3. Genel ayarlar > API erişimi bölümünde kaydırma çubuğunu Etkin konumuna getirin.

  4. Sayfanın alt kısmındaki Kaydet düğmesini tıklayın.

İstemcinizi ayarlama

Ad Manager istemci kitaplıklarından birini indirin. Kitaplıklar, uygulama geliştirmeyi daha kolay ve hızlı hale getiren sarmalayıcı işlevler ve özellikler sunar.

Aşağıdaki sekmelerde, istemci kitaplığı bulunan dillerin her birinde kodlama için hızlı başlangıç kılavuzları sunulmaktadır.

Java

Java istemci kitaplığının nasıl kullanılacağını gösteren basit bir örneği aşağıda bulabilirsiniz. Daha ayrıntılı kullanım bilgileri için istemci kitaplığı dağıtımındaki README dosyasına bakın.

  1. Kimlik bilgilerinizi ayarlama

    Kabukta aşağıdaki komutu çalıştırın:

    curl https://raw.githubusercontent.com/googleads/googleads-java-lib/main/examples/admanager_axis/src/main/resources/ads.properties -o ~/ads.properties
     ~/ads.properties dosyasını açın ve aşağıdaki alanları doldurun: 
    [...]
api.admanager.applicationName=INSERT_APPLICATION_NAME_HERE
api.admanager.jsonKeyFilePath=INSERT_PATH_TO_JSON_KEY_FILE_HERE
api.admanager.networkCode=INSERT_NETWORK_CODE_HERE
[...]

  2. Bağımlılıkları belirtme

    pom.xml dosyanızı düzenleyin ve dependencies etiketine aşağıdakileri ekleyin. En yeni sürüm numarasını GitHub'da bulabilirsiniz. 

    <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>

  3. Kod yazıp istek gönderin.

    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 istemci kitaplığının nasıl kullanılacağını gösteren basit bir örneği aşağıda bulabilirsiniz. Python istemci kitaplığı, Python v3.6 ve sonraki sürümleri destekler. Daha ayrıntılı kullanım bilgileri için istemci kitaplığı dağıtımındaki README dosyasına bakın.

  1. Kitaplığı yükleyin ve kimlik bilgilerinizi ayarlayın.

    Kabukta aşağıdaki komutları çalıştırın:

    python3 -m pip install googleads
curl https://raw.githubusercontent.com/googleads/googleads-python-lib/main/googleads.yaml \
     -o ~/googleads.yaml
  2. ~/googleads.yaml dosyanızı oluşturun.

    Aşağıdaki alanları doldurun:

    ad_manager:
  application_name: INSERT_APPLICATION_NAME_HERE
  network_code: INSERT_NETWORK_CODE_HERE
  path_to_private_key_file: INSERT_PATH_TO_FILE_HERE
  3. Kod çalıştırıp istekte bulunun. 
    # 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 istemci kitaplığının nasıl kullanılacağını gösteren basit bir örneği aşağıda bulabilirsiniz.

  1. Kitaplığı yükleyin ve kimlik bilgilerinizi ayarlayın.

    İstemci kitaplığını yüklemek ve adsapi_php.ini dosyasını ana dizininize indirmek için bir kabukta aşağıdaki komutları çalıştırın:

    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
  2. ~/adsapi_php.ini dosyanızı oluşturun.

    Aşağıdaki alanları doldurun:

    [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"
  3. Kod çalıştırıp istekte bulunun. 
    <?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 istemci kitaplığının nasıl kullanılacağını gösteren basit bir örneği aşağıda bulabilirsiniz.

  1. Yeni proje oluşturma

    Visual Studio'yu açın ve yeni bir proje (Konsol Uygulaması) oluşturun.

  2. Gerekli kitaplık referanslarını projenize ekleme

    Google.Dfp için bir nuget bağımlılığı ekleyin.

  3. App.config dosyanızı ayarlama

    src\App.config dosyasını proje dizininize kopyalayın ve projenize ekleyin. Uygulamanızın kendi App.config dosyası varsa aşağıdaki düğümleri App.config dosyanıza kopyalayabilirsiniz:

    • configuration/AdManagerApi
    • configuration/configSections/section[name="AdManagerApi"]
    • configuration/system.net
  4. Kimlik bilgilerini ayarlama

    App.config dosyasını açın ve aşağıdaki anahtarları düzenleyin: 

    <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" />
  5. Kitaplığı arama

    Kitaplığı aşağıdaki C# kod snippet'inde gösterildiği gibi çağırabilirsiniz. 

    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);
            }

Kimlik bilgilerinizi App.config dosyanızda ayarlamak istemiyorsanız AdManagerUser sınıfını kullanmanın alternatif yolları için bu wiki makalesine bakın. .NET istemci kitaplığını kullanma hakkında daha ayrıntılı bilgi için README dosyasını inceleyin. İstemci kitaplığı olmadan .NET'te geliştirme yapmak istiyorsanız lütfen NoClientLibrary wiki makalesine bakın.

Ruby

Ruby istemci kitaplığının nasıl kullanılacağını gösteren basit bir örneği aşağıda bulabilirsiniz. Ruby istemci kitaplığı için Ruby 2.1 veya sonraki bir sürüm gerekir.

  1. Ruby gem'i yükleyin ve yapılandırma dosyasını alın.

    Kabukta aşağıdaki komutları çalıştırın:

    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
  2. Kimlik bilgilerinizi ayarlama

    ~/ad_manager_api.yml dosyasındaki zorunlu alanları doldurun. OAuth2 anahtar dosyanız yoksa OAuth2 kimlik bilgilerinizi oluşturma adımlarını uygulamanız gerekir.

    :authentication:
  :oauth2_keyfile: INSERT_PATH_TO_JSON_KEY_FILE_HERE
  :application_name: INSERT_APPLICATION_NAME_HERE
  :network_code: INSERT_NETWORK_CODE_HERE
  3. Kod yazıp istek gönderin. 
    # 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]]

Başlamak için daha ayrıntılı adımları, Ruby istemci kitaplığıyla birlikte dağıtılan README dosyasında bulabilirsiniz. Ayrıca Ruby için örnek kitaplığımızın tamamına göz atın.

Sonraki adımlar

İstemci kitaplığınız hazır olduğunda, sağlanan örnekleri ihtiyaçlarınıza göre genişletmek için değiştirin.

API hakkında daha fazla bilgi edinmek için referans belgelerine göz atın.

Yardıma ihtiyacınız olursa destek sayfamızı ziyaret edin.