Nasze biblioteki klienckie zapewniają ogólne widoki i podstawowe elementy funkcje interfejsu Google Ads API, które ułatwiają szybkie tworzenie aplikacji; Jeśli dopiero zaczynasz korzystać z interfejsu API, zalecamy rozpoczęcie od użycia wzorców.
Biblioteka klienta | Źródło | Dystrybucja | Przykłady kodu |
---|---|---|---|
Java | google-ads-java | Maven, tar.gz | Wyświetl w GitHubie |
.NET | google-ads-dotnet | nuget, tar.gz, zip | Wyświetl w GitHubie |
PHP | google-ads-php | tar.gz | Wyświetl w GitHubie |
Python | google-ads-python | tar.gz, zip | Wyświetl w GitHubie |
Ruby | google-ads-ruby | gem, tar.gz, zip | Wyświetl w GitHubie |
Perl | google-ads-perl | tar.gz, zip | Wyświetl w GitHubie |
Obsługiwane wersje interfejsu API
Tabela pokazuje, które biblioteki klienta działają z którymi wersjami interfejsu API.
Java
Interfejs Google Ads API |
Biblioteka klienta dla języka Java |
v18 |
Min: 34.0.0 Max: – |
v17 |
Min: 32.0.0 Max: – |
v16 |
Min: 30.0.0 Max: – |
C#
Interfejs Google Ads API |
Biblioteka klienta dla .NET |
v18 |
Min: 21.1.0 Max: – |
v17 |
Min: 20.1.0 Max: - |
v16 |
Min: 18.1.0 Max: – |
PHP
Interfejs Google Ads API |
Biblioteka klienta dla PHP |
v18 |
Min: 25.0.0 Max: - |
v17 |
Min: 23.1.0 Max: - |
v16 |
Min: 22.1.0 Max: – |
Python
Interfejs Google Ads API |
Biblioteka klienta dla Pythona |
v18 |
Min: 25.1.0 Max: – |
v17 |
Min: 24.1.0 Max: – |
v16 |
Min: 23.1.0 Max: - |
Ruby
Interfejs Google Ads API |
Biblioteka klienta do języka Ruby |
v18 |
Min: 31.0.0 Max: - |
v17 |
Min: 29.0.0 Max: - |
v16 |
Min: 27.0.0 Max: - |
Perl
Interfejs Google Ads API |
Biblioteka klienta dla Perla |
v18 |
Min: 25.0.0 Max: - |
v17 |
Min: 23.0.0 Max: – |
v16 |
Min: 21.0.0 Max: – |
Konfiguracja
Każda biblioteka klienta interfejsu Ads API ma inne ustawienia konfiguracji za pomocą których możesz dostosować jej działanie.
Oto zmienne środowiskowe, które są wspólne dla wszystkich bibliotek klienta i które można załadować, aby określić ustawienia konfiguracji:
- Biblioteka klienta
GOOGLE_ADS_CONFIGURATION_FILE_PATH
: ścieżka do pliku konfiguracji.
- OAuth2
- Tryb aplikacji
GOOGLE_ADS_CLIENT_ID
: ustaw tę wartość na identyfikator klienta OAuth2.GOOGLE_ADS_CLIENT_SECRET
: ustaw tę wartość na tajny klucz klienta OAuth2.GOOGLE_ADS_REFRESH_TOKEN
: ustaw tę wartość na wstępnie wygenerowany token odświeżania OAuth2 jeśli chcesz 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 konfiguracji JSON OAuth2.GOOGLE_ADS_IMPERSONATED_EMAIL
: ustaw tę wartość na adres e-mail konta, którego chcesz udawać.
- Tryb aplikacji
- Interfejs Google Ads API.
GOOGLE_ADS_DEVELOPER_TOKEN
: ustaw ten token dewelopera.GOOGLE_ADS_LOGIN_CUSTOMER_ID
: to identyfikator klienta autoryzowanego do korzystania z żądania, bez łączników (-
).GOOGLE_ADS_LINKED_CUSTOMER_ID
: ten nagłówek jest wymagany tylko w przypadku metod, które aktualizują zasobów jednostki z uprawnieniami w sekcji Połączone konta, Interfejs Google Ads (zasóbAccountLink
w interfejsie Google Ads API). Ustaw tę wartość identyfikatorowi klienta dostawcy danych, który aktualizuje zasoby z określonym identyfikatorem klienta. Powinien być ustawiony bez łączników (-
). Aby dowiedzieć się więcej, 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 kilka podstawowych czynności związanych z definiowaniem 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.
src ~/.bashrc
Zmienne środowiskowe można też ustawić w terminalu bezpośrednio z poziomu 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
Wyszukaj podział na strony
GoogleAdsService.Search
to zwykle
używane w interaktywnych aplikacjach, które wyświetlają strony wyników. Rozmiar strony jest stały
nawet 10 000 wyników na stronie.
Nasza biblioteka klienta automatycznie implementuje strony podczas powtarzania wyników. Pozwala to sekwencyjnie pobierać i przetwarzać je wszystkie naraz, np.:
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.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; } }
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, 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.' )
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::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; }
Przykłady kodu
Zapoznaj się z przykładami kodu niektórych typowych funkcji interfejsu Google Ads API.