İstemci Kitaplıkları

İstemci kitaplıklarımızda yüksek düzey görünümler ve temel yapı taşları olan Uygulamaları hızlı bir şekilde geliştirmeyi kolaylaştıran Google Ads API işlevi. Önerilerimiz: ve API kullanmaya yeni başladıysanız bir taneyle başlayın.

İ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

Desteklenen API sürümleri

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

Java

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

C#

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

PHP

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

Python

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

Ruby

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

Perl

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

Yapılandırma

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

Tüm istemci kitaplıklarında ortak olan ortam değişkenleri yapılandırma ayarlarını yapmak için yüklenebilecek değer:

  • İ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ğinize ayarlayın.
      • GOOGLE_ADS_CLIENT_SECRET : Bu değeri OAuth2 istemci gizli anahtarınız olarak ayarlayın.
      • GOOGLE_ADS_REFRESH_TOKEN : Bu değeri önceden oluşturulmuş bir OAuth2 yenileme jetonu olarak ayarlayın. OAuth2 jetonlarını yeniden kullanmak istiyorsanız. Bu ayar isteğe bağlıdır.
    • Hizmet Hesabı Modu
      • GOOGLE_ADS_JSON_KEY_FILE_PATH : Bu değeri OAuth2 JSON yapılandırmasına ayarlayın dosya yolu.
      • GOOGLE_ADS_IMPERSONATED_EMAIL : Bu değeri kullandığınız bir hesaptır.
  • Google Ads API
    • GOOGLE_ADS_DEVELOPER_TOKEN : Bunu geliştirici jetonunuz olarak ayarlayın.
    • GOOGLE_ADS_LOGIN_CUSTOMER_ID : Bu, kullanma yetkisine sahip müşterinin müşteri kimliğidir. kısa çizgi (-) olmadan istekte bulunabilirsiniz.
    • GOOGLE_ADS_LINKED_CUSTOMER_ID : Bu üstbilgi yalnızca Bağlı Hesaplar üzerinden izin verildiğinde tüzel kişinin kaynakları Google Ads kullanıcı arayüzü (Google Ads API'de AccountLink kaynağı). Bu değeri ayarla verilerini güncelleyen veri sağlayıcısının müşteri kimliğine belirtilen müşteri kimliği. Kısa çizgi (-) olmadan ayarlanmalıdır. Daha fazla bilgi edinmek için hakkında daha fazla bilgi için Yardım Merkezi'ni ziyaret edin.
ziyaret edin.

Ortam değişkenleri genellikle $HOME dizininde bulunan bir .bashrc veya .bash_profile dosyası olarak. Onlar komut satırı kullanılarak da tanımlanabilir.

.bashrc kullanarak ortam değişkeni tanımlamaya yönelik bazı temel adımları burada bulabilirsiniz. dosyayı yükleyin:

# 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, doğrudan terminal örneğinizde komut satırından ekleyin:

export GOOGLE_ADS_CLIENT_ID=1234567890

Bir diğer alternatif de komutu çağırırken ortam değişkenlerini ayarlamaktır. vardır:

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

Sayfalara ayırma

GoogleAdsService.Search genellikle sonuç sayfalarını görüntüleyen etkileşimli uygulamalarda kullanılır. Sayfa boyutu sabittir. sayfa başına 10.000 sonuç.

İstemci kitaplığımız sonuçları yinelerken sayfa oluşturma sırayla indirin ve hepsini aynı anda işleyin. Örneğin:

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.V17.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::V17::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

Şuradaki bazı yaygın işlevlere ait kod örneklerimize göz atın: Google Ads API'si.