İ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'da yeniyseniz bir ile başlayın.

Desteklenen API sürümleri

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

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ğerler:

• İ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 Yardım Merkezi'ni 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. şekilde tanımlar:

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.

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

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
      

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
      

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
      

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
      

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
      

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
      

Kullanım alanına bağlı olarak şunları yapmanız gerekebilir:

• Kaç sayfanın getirileceğini optimize edin.
• Tek seferde ne kadar sonucun depolanacağını optimize edin.
• Belirli bir sıralamaya sahip sonuçların sayfalarını indirme ve işleme.

Bu işlem, sonuçlar yerine sayfa jetonları saklanarak yapılabilir. Bu işlem, daha karmaşık hale getirebilirsiniz.

Kod örnekleri

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