İstemci Kitaplıkları

İstemci kitaplıklarımız, Google Ads API işlevinin üst düzey görünümlerini ve temel yapı taşlarını sağlayarak uygulamaları hızlı bir şekilde geliştirmeyi kolaylaştırır. API'de yeniyseniz biriyle başlamanızı öneririz.

İstemci kitaplığı Kaynak Dağıtım Kod örnekleri
Java google-ads-java Maven, tar.gz GitHub'da göster
.NET google-ads-dotnet nuget, tar.gz, zip GitHub'da göster
PHP google-ads-php tar.gz GitHub'da göster
Python google-ads-python tar.gz, zip GitHub'da göster
Ruby google-ads-ruby gem, tar.gz, zip GitHub'da göster
Perl google-ads-perl tar.gz, zip GitHub'da göster

Topluluk Kütüphaneleri

Açık kaynak topluluğu tarafından yönetilen çeşitli kitaplıklar olduğunu biliyoruz. İlgili geliştiricilerin bu ürünleri bulmasına yardımcı olmak için bu listeyi tutuyoruz. Bu kitaplıklar test edilmez, bunlara katkıda bulunulmaz veya bunlarla ilgili bakım yapılmaz. Bu kitaplıkları kendi sorumluluğunuzda kullanın. Sorularınızı açık kaynak projelerin sahiplerine yönlendirebilirsiniz.

Eksik olduğunu düşündüğünüz bir kitaplık varsa sayfanın üst kısmındaki Geri bildirim gönder'i tıklayarak bize bildirin.

Desteklenen API sürümleri

Tabloda, hangi istemci kitaplıklarının hangi API sürümleriyle çalıştığı gösterilmektedir.

Java

Java için istemci kitaplığı
v18 Min: 34.0.0
Max: -
v17 Min: 32.0.0
Max: -
v16 Min: 30.0.0
Max: -

C#

.NET için istemci kitaplığı
v18 Min: 21.1.0
Max: -
v17 Min: 20.1.0
Max: -
v16 Min: 18.1.0
Max: -

PHP

PHP için istemci kitaplığı
v18 Min: 25.0.0
Max: -
v17 Min: 23.1.0
Max: -
v16 Min: 22.1.0
Max: -

Python

Python için istemci kitaplığı
v18 Min: 25.1.0
Max: -
v17 Min: 24.1.0
Max: -
v16 Min: 23.1.0
Max: -

Ruby

Ruby için istemci kitaplığı
v18 Min: 31.0.0
Max: -
v17 Min: 29.0.0
Max: -
v16 Min: 27.0.0
Max: -

Perl

Perl için istemci kitaplığı
v18 Min: 25.0.1
Max: -
v17 Min: 23.0.0
Max: -
v16 Min: 21.0.0
Max: -

Yapılandırma

Her Ads API istemci kitaplığı, davranışını özelleştirmek için kullanabileceğiniz farklı yapılandırma ayarları ve yükleme yöntemleri sağlar.

Tüm istemci kitaplıklarında ortak olan ve yapılandırma ayarlarını belirlemek için yüklenebilen ortam değişkenleri aşağıda verilmiştir:

  • İstemci kitaplığı
    • GOOGLE_ADS_CONFIGURATION_FILE_PATH: Yapılandırma dosyasının yolu.
  • OAuth2
    • Uygulama Modu
      • GOOGLE_ADS_CLIENT_ID : Bu değeri OAuth2 istemci kimliğinizle ayarlayın.
      • GOOGLE_ADS_CLIENT_SECRET : Bu değeri OAuth2 istemci gizli anahtarınızla ayarlayın.
      • GOOGLE_ADS_REFRESH_TOKEN : OAuth2 jetonlarını yeniden kullanmak istiyorsanız bu değeri önceden oluşturulmuş bir OAuth2 yenileme jetonuna ayarlayın. Bu ayar isteğe bağlıdır.
    • Hizmet Hesabı Modu
      • GOOGLE_ADS_JSON_KEY_FILE_PATH : Bu değeri OAuth2 JSON yapılandırma dosyasının yoluna ayarlayın.
      • GOOGLE_ADS_IMPERSONATED_EMAIL : Bu değeri, kimliğine büründüğünüz hesabın e-posta adresine ayarlayın.
  • Google Ads API
    • GOOGLE_ADS_DEVELOPER_TOKEN : Bunu geliştirici jetonunuza ayarlayın.
    • GOOGLE_ADS_LOGIN_CUSTOMER_ID : Yetkili müşterinin istekte kullanacağı müşteri kimliğidir. Kısa çizgi (-) içermez.
    • GOOGLE_ADS_LINKED_CUSTOMER_ID : Bu başlık yalnızca Google Ads kullanıcı arayüzündeki Bağlı Hesaplar üzerinden izin verildiğinde bir öğenin kaynaklarını güncelleyen yöntemler için gereklidir (Google Ads API'deki AccountLink kaynağı). Bu değeri, belirtilen müşteri kimliğinin kaynaklarını güncelleyen veri sağlayıcının müşteri kimliği olarak ayarlayın. Tire işareti olmadan (-) ayarlanmalıdır. Bağlı hesaplar hakkında daha fazla bilgi edinmek için Yardım Merkezi'ni ziyaret edin.

Ortam değişkenleri genellikle $HOME dizininde bulunan bir .bashrc veya .bash_profile dosyası gibi bir bash yapılandırma dosyasında tanımlanır. Bunlar komut satırı kullanılarak da tanımlanabilir.

Terminalde bir .bashrc dosyası kullanarak ortam değişkeni tanımlamak için bazı temel adımları aşağıda bulabilirsiniz:

# Append the line "export GOOGLE_ADS_CLIENT_ID=1234567890" to
# the bottom of your .bashrc file.
echo "export GOOGLE_ADS_CLIENT_ID=1234567890" >> ~/.bashrc

# Update your bash environment to use the most recently updated
# version of your .bashrc file.
src ~/.bashrc

Ortam değişkenleri, terminal örneğinizde doğrudan komut satırından da ayarlanabilir:

export GOOGLE_ADS_CLIENT_ID=1234567890

Diğer bir alternatif de, ortam değişkenlerini kullanan komutu çağırırken ayarlamaktır:

GOOGLE_ADS_CLIENT_ID=1234567890 php /path/to/script/that/uses/envvar.php

Öğeleri getirme

GoogleAdsService.SearchStream genellikle öğeleri getirmek için kullanılır ve sonuçlar bir satır akışı olarak döndürülür. Alternatif olarak, güvenilir olmayan bir internet bağlantısı üzerinden öğe almak için GoogleAdsService.Search kullanabilirsiniz. GoogleAdsService.Search sonuçları sayfa başına 10.000 satırlık sabit sayfa boyutlarında döndürür.

İstemci kitaplığımız, sonuçları iterlediğinizde sonuçları sırayla indirip tek seferde işleyebilmeniz için otomatik olarak sayfalama uygular.

Java

private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
  try (GoogleAdsServiceClient googleAdsServiceClient =
      googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
    String query = "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id";
    // Constructs the SearchGoogleAdsStreamRequest.
    SearchGoogleAdsStreamRequest request =
        SearchGoogleAdsStreamRequest.newBuilder()
            .setCustomerId(Long.toString(customerId))
            .setQuery(query)
            .build();

    // Creates and issues a search Google Ads stream request that will retrieve all campaigns.
    ServerStream<SearchGoogleAdsStreamResponse> stream =
        googleAdsServiceClient.searchStreamCallable().call(request);

    // Iterates through and prints all of the results in the stream response.
    for (SearchGoogleAdsStreamResponse response : stream) {
      for (GoogleAdsRow googleAdsRow : response.getResultsList()) {
        System.out.printf(
            "Campaign with ID %d and name '%s' was found.%n",
            googleAdsRow.getCampaign().getId(), googleAdsRow.getCampaign().getName());
      }
    }
  }
}
GetCampaigns.java

C#

public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V18.GoogleAdsService);

    // Create a query that will retrieve all campaigns.
    string query = @"SELECT
                    campaign.id,
                    campaign.name,
                    campaign.network_settings.target_content_network
                FROM campaign
                ORDER BY campaign.id";

    try
    {
        // Issue a search request.
        googleAdsService.SearchStream(customerId.ToString(), query,
            delegate (SearchGoogleAdsStreamResponse resp)
            {
                foreach (GoogleAdsRow googleAdsRow in resp.Results)
                {
                    Console.WriteLine("Campaign with ID {0} and name '{1}' was found.",
                        googleAdsRow.Campaign.Id, googleAdsRow.Campaign.Name);
                }
            }
        );
    }
    catch (GoogleAdsException e)
    {
        Console.WriteLine("Failure:");
        Console.WriteLine($"Message: {e.Message}");
        Console.WriteLine($"Failure: {e.Failure}");
        Console.WriteLine($"Request ID: {e.RequestId}");
        throw;
    }
}
GetCampaigns.cs

PHP

public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
    $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
    // Creates a query that retrieves all campaigns.
    $query = 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id';
    // Issues a search stream request.
    /** @var GoogleAdsServerStreamDecorator $stream */
    $stream = $googleAdsServiceClient->searchStream(
        SearchGoogleAdsStreamRequest::build($customerId, $query)
    );

    // Iterates over all rows in all messages and prints the requested field values for
    // the campaign in each row.
    foreach ($stream->iterateAllElements() as $googleAdsRow) {
        /** @var GoogleAdsRow $googleAdsRow */
        printf(
            "Campaign with ID %d and name '%s' was found.%s",
            $googleAdsRow->getCampaign()->getId(),
            $googleAdsRow->getCampaign()->getName(),
            PHP_EOL
        );
    }
}
GetCampaigns.php

Python

def main(client, customer_id):
    ga_service = client.get_service("GoogleAdsService")

    query = """
        SELECT
          campaign.id,
          campaign.name
        FROM campaign
        ORDER BY campaign.id"""

    # Issues a search request using streaming.
    stream = ga_service.search_stream(customer_id=customer_id, query=query)

    for batch in stream:
        for row in batch.results:
            print(
                f"Campaign with ID {row.campaign.id} and name "
                f'"{row.campaign.name}" was found.'
            )
get_campaigns.py

Ruby

def get_campaigns(customer_id)
  # GoogleAdsClient will read a config file from
  # ENV['HOME']/google_ads_config.rb when called without parameters
  client = Google::Ads::GoogleAds::GoogleAdsClient.new

  responses = client.service.google_ads.search_stream(
    customer_id: customer_id,
    query: 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id',
  )

  responses.each do |response|
    response.results.each do |row|
      puts "Campaign with ID #{row.campaign.id} and name '#{row.campaign.name}' was found."
    end
  end
end
get_campaigns.rb

Perl

sub get_campaigns {
  my ($api_client, $customer_id) = @_;

  # Create a search Google Ads stream request that will retrieve all campaigns.
  my $search_stream_request =
    Google::Ads::GoogleAds::V18::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
    ->new({
      customerId => $customer_id,
      query      =>
        "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id"
    });

  # Get the GoogleAdsService.
  my $google_ads_service = $api_client->GoogleAdsService();

  my $search_stream_handler =
    Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
      service => $google_ads_service,
      request => $search_stream_request
    });

  # Issue a search request and process the stream response to print the requested
  # field values for the campaign in each row.
  $search_stream_handler->process_contents(
    sub {
      my $google_ads_row = shift;
      printf "Campaign with ID %d and name '%s' was found.\n",
        $google_ads_row->{campaign}{id}, $google_ads_row->{campaign}{name};
    });

  return 1;
}
get_campaigns.pl

Kod örnekleri

Google Ads API'deki bazı yaygın işlevlerle ilgili kod örneklerimize göz atın.