Biblioteki klienta

Biblioteki klienta interfejsu Google Ads API udostępniają widoki wysokiego poziomu i podstawowe elementy składowe funkcji interfejsu Google Ads API, co ułatwia szybkie tworzenie aplikacji. Jeśli dopiero zaczynasz korzystać z interfejsu API, zacznij od biblioteki klienta.

W tabeli poniżej znajdziesz listę oficjalnych bibliotek klienta oraz linki do przewodników po konfiguracji, repozytoriów źródłowych, pakietów i przykładów kodu:

Biblioteka klienta Przewodniki po konfiguracji i użytkowaniu Źródło Rozkład Przykłady kodu
Java Podstawowe zastosowanie, Konfiguracja, Uwierzytelnianie, Logowanie, Maski pól, Nazwy zasobów google-ads-java Maven, tar.gz, zip Wyświetl w GitHubie
.NET Podstawowe zastosowanie, Konfiguracja, Uwierzytelnianie, Logowanie, Maski pól, Nazwy zasobów google-ads-dotnet NuGet, tar.gz, zip Wyświetl w GitHubie
PHP Podstawowe zastosowanie, Konfiguracja, Uwierzytelnianie, Logowanie, Maski pól, Nazwy zasobów google-ads-php Composer, tar.gz, zip Wyświetl w GitHubie
Python Instalacja, konfiguracja, uwierzytelnianie, logowanie, maski pól, nazwy zasobów google-ads-python PyPI, tar.gz, zip Wyświetl w GitHubie
Ruby Podstawowe zastosowanie, Konfiguracja, Uwierzytelnianie, Logowanie, Maski pól, Nazwy zasobów google-ads-ruby RubyGems, tar.gz, zip Wyświetl w GitHubie
Perl Podstawowe zastosowanie, Konfiguracja, Uwierzytelnianie, Logowanie, Maski pól, Nazwy zasobów google-ads-perl CPAN, tar.gz, zip Wyświetl w GitHubie

Biblioteki społeczności

Znamy kilka bibliotek, które są utrzymywane przez społeczność open source. Udostępniamy tę listę, aby ułatwić zainteresowanym deweloperom znalezienie tych firm. Nie testujemy, nie rozwijamy ani nie utrzymujemy tych bibliotek. Korzystasz z nich na własne ryzyko. Wszelkie pytania należy kierować do właścicieli projektów open source.

Jeśli znasz bibliotekę, której nie uwzględniliśmy, kliknij Prześlij opinię u góry strony i daj nam znać.

Obsługiwane wersje interfejsu API

Tabela pokazuje, które biblioteki klienta działają z którymi wersjami interfejsu API.

Podana minimalna wersja biblioteki klienta jest wystarczająca dla głównej wersji interfejsu Google Ads API (np. v26). Aby sprawdzić wymaganą wersję biblioteki klienta w przypadku wersji podrzędnych, zapoznaj się z połączoną listą zmian.

Java

Lista zmian

Biblioteka klienta dla Javy
v26 Min: 48.0.0
Max: –
v25 Min: 44.0.0
Max: –
v24 Min: 43.0.0
Max: –
v23 Min: 42.0.0
Max: –

C#

Lista zmian

Biblioteka klienta dla .NET
v26 Min: 27.5.0
Max: –
v25 Min: 26.1.0
Max: –
v24 Min: 25.3.0
Max: –
v23 Min: 25.1.0
Max: –

PHP

Lista zmian

Biblioteka klienta dla języka PHP
v26 Min: 35.2.0
Max: –
v25 Min: 33.6.0
Max: –
v24 Min: 33.3.0
Max: –
v23 Min: 32.2.0
Max: –

Python

Lista zmian

Biblioteka klienta dla Pythona
v26 Min: 34.0.0
Max: –
v25 Min: 31.2.0
Max: –
v24 Min: 30.1.0
Max: –
v23 Min: 29.2.0
Max: –

Ruby

Lista zmian

Biblioteka klienta dla języka Ruby
v26 Min: 46.0.0
Max: –
v25 Min: 43.0.0
Max: –
v24 Min: 40.0.0
Max: –
v23 Min: 38.0.0
Max: –

Perl

Lista zmian

Biblioteka klienta dla Perla
v26 Min: 36.0.0
Max: –
v25 Min: 33.0.0
Max: –
v24 Min: 32.0.0
Max: –
v23 Min: 31.0.0
Max: –

Konfiguracja

Każda biblioteka klienta interfejsu Google Ads API udostępnia różne ustawienia konfiguracji i metody wczytywania, których możesz używać do dostosowywania jej działania.

Oto standardowe zmienne środowiskowe, których możesz używać do konfigurowania bibliotek klienta:

  • Biblioteka klienta
    • GOOGLE_ADS_CONFIGURATION_FILE_PATH: ścieżka do pliku konfiguracji (odczytywana automatycznie podczas wczytywania z pliku konfiguracji bez podania ścieżki w argumentach w przypadku Javy (fromPropertiesFile()), Perla (Client->new()), PHP (fromFile()), Pythona (load_from_storage(), sprawdzana też przez load_from_env()) i Ruby (GoogleAdsClient.new); w przypadku .NET wczytaj tę zmienną bezpośrednio za pomocą config.TryLoadFromEnvironmentFilePath lub wczytaj pliki konfiguracji za pomocą LoadFromSettingsJson, LoadFromConfigurationSection lub LoadFromConfigurationRoot).
  • OAuth2
    • Tryb aplikacji
      • GOOGLE_ADS_CLIENT_ID: ustaw tę wartość na identyfikator klienta OAuth2.
      • GOOGLE_ADS_CLIENT_SECRET: ustaw tę wartość na klucz tajny klienta OAuth2.
      • GOOGLE_ADS_REFRESH_TOKEN: ustaw tę wartość na wstępnie wygenerowany token odświeżania OAuth2, jeśli chcesz ponownie używać tokenów OAuth2. To ustawienie jest opcjonalne.
    • Tryb konta usługi
      • GOOGLE_ADS_JSON_KEY_FILE_PATH: ustaw tę wartość na ścieżkę do pliku klucza JSON OAuth2 (w .NET ustaw też GOOGLE_ADS_OAUTH2_MODE na SERVICE_ACCOUNT, ponieważ domyślną wartością OAuth2Mode jest APPLICATION; w wersjach PHP starszych niż v32.1.0 lub w przypadku korzystania z niestandardowych zakresów ustaw też [OAUTH2] scopes w google_ads_php.ini lub wywołaj withScopes(), ponieważ fromEnvironmentVariables() nie odczytuje zakresów OAuth2 ze zmiennej środowiskowej).
      • GOOGLE_ADS_IMPERSONATED_EMAIL: ustaw tę wartość na adres e-mail konta, pod które się podszywasz, gdy używasz przekazywania dostępu w całej domenie Google Workspace. To ustawienie jest opcjonalne.
    • Tryb domyślnego uwierzytelniania aplikacji
      • GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS: ustaw tę wartość na true, aby uwierzytelniać za pomocą domyślnego uwierzytelniania aplikacji (ADC). Obsługiwane w języku Java w wersji v41.1.0 i nowszych, Python w wersji v28.3.0 i nowszych oraz Ruby w wersji v36.1.0 i nowszych (w .NET w wersji v24.1.0 i nowszych LoadFromEnvironmentVariables() odczytuje zmienną USE_APPLICATION_DEFAULT_CREDENTIALS bez prefiksu lub ustawia UseApplicationDefaultCredentials = true na GoogleAdsConfig; w PHP OAuth2TokenBuilder automatycznie przełącza się na ADC, gdy nie są ustawione żadne dane logowania OAuth2; Perl nie obsługuje ADC).
  • Interfejs Google Ads API
    • GOOGLE_ADS_LOGIN_CUSTOMER_ID: jest to identyfikator klienta upoważnionego do użycia w żądaniu, bez łączników (-).
    • GOOGLE_ADS_LINKED_CUSTOMER_ID: ten nagłówek jest wymagany tylko w przypadku metod, które aktualizują zasoby podmiotu, gdy uprawnienia zostały przyznane za pomocą połączonych kont w interfejsie Google Ads (zasób AccountLink w interfejsie Google Ads API). Ustaw tę wartość na identyfikator klienta dostawcy danych, który aktualizuje zasoby określonego identyfikatora klienta. Należy go ustawić bez łączników (-). Więcej informacji o połączonych kontach znajdziesz w Centrum pomocy.

Zmienne środowiskowe są zwykle definiowane w pliku konfiguracji powłoki bash, takim jak plik .bashrc lub .bash_profile znajdujący się w katalogu $HOME. Można je też zdefiniować za pomocą wiersza poleceń.

Oto kilka podstawowych kroków, które należy wykonać, aby zdefiniować zmienną środowiskową za pomocą pliku .bashrc w terminalu:

# 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.
source ~/.bashrc

Zmienne środowiskowe można też ustawić w instancji terminala bezpośrednio z wiersza poleceń:

export GOOGLE_ADS_CLIENT_ID=1234567890

Inną opcją jest ustawienie zmiennych środowiskowych podczas wywoływania polecenia, które ich używa:

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

Pobieranie encji

GoogleAdsService.SearchStream jest zwykle używana do pobierania encji, a wyniki są zwracane jako strumień wierszy. Możesz też użyć GoogleAdsService.Search, aby pobrać encje przez niestabilne połączenie z internetem. GoogleAdsService.Search zwraca wyniki w postaci stałych rozmiarów stron po 10 000 wierszy na stronę.

Biblioteki klienta automatycznie implementują stronicowanie podczas iteracji wyników, dzięki czemu możesz je pobierać i przetwarzać sekwencyjnie wszystkie naraz.

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

C#

public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V26.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;
    }
}

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

Python

def main(client: GoogleAdsClient, customer_id: str) -> None:
    ga_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService")

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

    # Issues a search request using streaming.
    stream: Iterator[SearchGoogleAdsStreamResponse] = ga_service.search_stream(
        customer_id=customer_id, query=query
    )

    for batch in stream:
        rows: List[GoogleAdsRow] = batch.results
        for row in rows:
            print(
                f"Campaign with ID {row.campaign.id} and name "
                f'"{row.campaign.name}" was found.'
            )

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

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::V26::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;
}

curl

Przykłady kodu

Zapoznaj się z przykładami kodu dotyczącymi niektórych typowych funkcji interfejsu Google Ads API.