Biblioteki klienta

Biblioteki klienta interfejsu Google Ads API zapewniają widoki wysokiego poziomu i podstawowe elementy funkcjonalności interfejsu Google Ads API, co ułatwia szybkie tworzenie aplikacji. Jeśli dopiero zaczynasz korzystać z interfejsu API, zacznij od biblioteki klienta.

biblioteki publiczne,

Znamy kilka bibliotek, które są utrzymywane przez społeczność open source. Prowadzimy tę listę, aby ułatwić zainteresowanym deweloperom ich znalezienie. Nie testujemy tych bibliotek, nie współtworzymy ich ani nie utrzymujemy. 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ć.

• Node.js: google-ads-api w npm
• Go: google-ads-pb na GitHubie

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 w przypadku głównej wersji interfejsu Google Ads API (np. v25). Aby sprawdzić wymaganą wersję biblioteki klienta w przypadku wersji podrzędnych, zapoznaj się z połączonym dziennikiem zmian.

Konfiguracja

Każda biblioteka klienta interfejsu Google Ads API udostępnia różne ustawienia konfiguracji i metody wczytywania, których możesz użyć do dostosowania 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 argumentu ścieżki w językach Java (fromPropertiesFile()), Perl (Client->new()), PHP (fromFile()), Python (load_from_storage(), sprawdzana też przez load_from_env()) i Ruby (GoogleAdsClient.new); w języku .NET wczytaj tę zmienną jawnie 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 wcześniej wygenerowany token odświeżania OAuth2, jeśli chcesz ponownie użyć 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ż OAuth2Mode domyślnie ma wartość APPLICATION; w wersjach PHP starszych niż v32.1.0 lub w przypadku używania zakresów niestandardowych 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, które jest imitowane podczas korzystania z delegowania 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ć się za pomocą domyślnego uwierzytelniania aplikacji (ADC). Obsługiwane w przypadku języków Java v41.1.0 i nowszych, Python v28.3.0 i nowszych oraz Ruby v36.1.0 i nowszych (w przypadku .NET v24.1.0 i nowszych LoadFromEnvironmentVariables() odczytuje zmienną bez prefiksu USE_APPLICATION_DEFAULT_CREDENTIALS lub ustawia UseApplicationDefaultCredentials = true w GoogleAdsConfig; w PHP OAuth2TokenBuilder automatycznie wraca do ADC, gdy nie są ustawione żadne jawne dane logowania OAuth2; Perl nie obsługuje ADC).
• Interfejs Google Ads API
  • GOOGLE_ADS_DEVELOPER_TOKEN: Opcjonalny w najnowszych wersjach (Java v46.0.0 i nowsze, .NET v27.3.0 i nowsze, PHP v35.0.0 i nowsze, Python v32.0.0 i nowsze, Ruby v45.0.0 i nowsze oraz Perl v35.0.0 i nowsze). Tokeny dewelopera zostały wycofane 9 września 2026 r., a serwery interfejsu API ignorują nagłówek developer-token niezależnie od wersji biblioteki klienta (do czasu, gdy przyszła wersja główna interfejsu Google Ads API go odrzuci). Starsze wersje biblioteki klienta nadal wymagają niepustej wartości w przypadku lokalnej weryfikacji po stronie klienta. Szczegółowe informacje dotyczące poszczególnych wersji znajdziesz w przewodniku po konfiguracji każdej biblioteki.
  • GOOGLE_ADS_LOGIN_CUSTOMER_ID: jest to identyfikator klienta uprawnionego do używania 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 są przyznawane za pomocą połączonych kont w interfejsie Google Ads (AccountLink zasób w interfejsie Google Ads API). Ustaw tę wartość na identyfikator klienta dostawcy danych, który aktualizuje zasoby określonego identyfikatora klienta. Powinien być ustawiony bez myślników (-). Więcej informacji o połączonych kontach znajdziesz w Centrum pomocy.

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

Oto podstawowe kroki definiowania zmiennej środowiskowej 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 służy zwykle do pobierania encji, a wyniki są zwracane jako strumień wierszy. Możesz też użyć GoogleAdsService.Search, aby pobrać jednostki przez niestabilne połączenie internetowe. GoogleAdsService.Search zwraca wyniki w postaci stron o stałym rozmiarze 10 000 wierszy na stronę.

Biblioteki klienta automatycznie wdrażają stronicowanie, gdy iterujesz wyniki, dzięki czemu możesz pobierać i przetwarzać je sekwencyjnie w tym samym czasie.

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.V25.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: 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.'
            )
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::V25::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
      

Przykłady kodu

Zapoznaj się z przykładami kodu niektórych typowych funkcji w interfejsie Google Ads API.