Ten przewodnik wymaga kilku ustawień wstępnych, które zostały skonfigurowane w poprzednich krokach. Jeśli jeszcze tego nie zrobisz, zacznij od Wprowadzenia.
W tym przewodniku używamy też tokenów odświeżania, czyli przepływu pracy, w którym użytkownik z odpowiednim dostępem do konta Google Ads może w ramach jednorazowej konfiguracji autoryzować aplikację do wykonywania wywołań interfejsu API offline na tym koncie bez dalszej interwencji użytkownika. Tokenów odświeżania możesz używać do tworzenia zarówno przepływów pracy offline, takich jak zadania cron lub potoki danych, jak i interaktywnych przepływów pracy, takich jak aplikacje internetowe lub mobilne.
Pobieranie tokena odświeżania
Interfejs Google Ads API używa protokołu OAuth 2.0 jako mechanizmu autoryzacji. Domyślnie uwierzytelnianie OAuth 2.0 wydaje token dostępu, który wygasa po określonym czasie. Aby automatycznie odnawiać token dostępu, zamiast tego wydaj token odświeżania.
interfejs wiersza poleceń gcloud
Wygeneruj token odświeżania, uruchamiając gcloud CLI:
gcloud auth application-default \ login --scopes=https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform \ --client-id-file=<path_to_credentials.json>
Plik
credentials.json
pochodzi z poprzedniego kroku.Polecenie
gcloud
otwiera okno logowania na konto Google w nowym oknie przeglądarki i przeprowadza Cię przez proces uwierzytelniania OAuth 2.0. Zaloguj się, używając adresu e-mail z kroku, w którym został określony identyfikator klienta logowania. Jeśli Twoja aplikacja nie jest zweryfikowana, może pojawić się ekran ostrzeżenia. W takich przypadkach możesz bezpiecznie kliknąć link Pokaż zaawansowane i opcję Przejdź do PROJECT_NAME (niezweryfikowano).Po sprawdzeniu zakresów kliknij przycisk Dalej, aby przyznać uprawnienia. Przeglądarka przechodzi na stronę
https://cloud.google.com/sdk/auth_success
, co oznacza, że uwierzytelnianie się powiodło. Na stronie wyświetla się ten komunikat:Authorization code granted. Close this tab.
Polecenie
gcloud
wyświetla ten komunikat:Credentials saved to file: [/****/.config/gcloud/application_default_credentials.json]
Teraz otwórz plik
application_default_credentials.json
. Jego zawartość powinna być podobna do tej:{ "account": "", "client_id": "******.apps.googleusercontent.com", "client_secret": "******", "refresh_token": "******", "type": "authorized_user", "universe_domain": "googleapis.com" }
Inne
Jeśli wolisz używać curl
lub własnego klienta HTTP, zapoznaj się z przykładem w
przewodniku po OAuth 2.0 w aplikacjach mobilnych i komputerowych.
Wywoływanie interfejsu API
Wybierz klienta, aby wyświetlić instrukcje dotyczące wywoływania interfejsu API:
Java
Artefakty biblioteki klienta są publikowane w centralnym repozytorium Maven. Dodaj bibliotekę klienta jako zależność do projektu w ten sposób:
Zależność Maven to:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>40.0.0</version>
</dependency>
Zależność Gradle to:
implementation 'com.google.api-ads:google-ads:40.0.0'
Utwórz plik ~/ads.properties
z tą zawartością:
api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Utwórz obiekt GoogleAdsClient
w ten sposób:
GoogleAdsClient googleAdsClient = null;
try {
googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (FileNotFoundException fnfe) {
System.err.printf(
"Failed to load GoogleAdsClient configuration from file. Exception: %s%n",
fnfe);
System.exit(1);
} catch (IOException ioe) {
System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
System.exit(1);
}
Następnie uruchom raport kampanii, korzystając z metody GoogleAdsService.SearchStream
, aby pobrać kampanie na koncie. Ten przewodnik nie zawiera szczegółowych informacji o raportowaniu.
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#
Pakiety biblioteki klienta są publikowane w repozytorium Nuget.org. Zacznij od dodania odwołania do pakietu NuGet do pakietu Google.Ads.GoogleAds
.
dotnet add package Google.Ads.GoogleAds --version 18.1.0
Utwórz obiekt GoogleAdsConfig
z odpowiednimi ustawieniami i użyj go do utworzenia obiektu GoogleAdsClient
.
GoogleAdsConfig config = new GoogleAdsConfig()
{
DeveloperToken = "******",
OAuth2Mode = "APPLICATION",
OAuth2ClientId = "******.apps.googleusercontent.com",
OAuth2ClientSecret = "******",
OAuth2RefreshToken = "******",
LoginCustomerId = ******
};
GoogleAdsClient client = new GoogleAdsClient(config);
Następnie uruchom raport kampanii, korzystając z metody GoogleAdsService.SearchStream
, aby pobrać kampanie na koncie. Ten przewodnik nie zawiera szczegółowych informacji o raportowaniu.
public void Run(GoogleAdsClient client, long customerId)
{
// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
Services.V21.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
Pakiety biblioteki klienta są publikowane w repozytorium Packagist. Przejdź do katalogu głównego projektu i uruchom to polecenie, aby zainstalować bibliotekę i wszystkie jej zależności w katalogu vendor/
w katalogu głównym projektu.
composer require googleads/google-ads-php:31.0.0
Utwórz kopię pliku
google_ads_php.ini
z repozytorium GitHub i zmodyfikuj go, aby zawierał Twoje dane logowania.
[GOOGLE_ADS]
developerToken = "INSERT_DEVELOPER_TOKEN_HERE"
loginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE"
[OAUTH2]
clientId = "INSERT_OAUTH2_CLIENT_ID_HERE"
clientSecret = "INSERT_OAUTH2_CLIENT_SECRET_HERE"
refreshToken = "INSERT_OAUTH2_REFRESH_TOKEN_HERE"
Utwórz instancję obiektu GoogleAdsClient
.
$oAuth2Credential = (new OAuth2TokenBuilder())
->fromFile('/path/to/google_ads_php.ini')
->build();
$googleAdsClient = (new GoogleAdsClientBuilder())
->fromFile('/path/to/google_ads_php.ini')
->withOAuth2Credential($oAuth2Credential)
->build();
Następnie uruchom raport kampanii, korzystając z metody GoogleAdsService.SearchStream
, aby pobrać kampanie na koncie. Ten przewodnik nie zawiera szczegółowych informacji o raportowaniu.
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
Biblioteka klienta jest rozpowszechniana w PyPI i można ją zainstalować za pomocą polecenia pip
:
python -m pip install google-ads==21.3.0
Utwórz kopię pliku google-ads.yaml
z repozytorium GitHub i zmodyfikuj ją, aby uwzględnić swoje dane logowania.
client_id: INSERT_OAUTH2_CLIENT_ID_HERE
client_secret: INSERT_OAUTH2_CLIENT_SECRET_HERE
refresh_token: INSERT_REFRESH_TOKEN_HERE
developer_token: INSERT_DEVELOPER_TOKEN_HERE
login_customer_id: INSERT_LOGIN_CUSTOMER_ID_HERE
Utwórz instancję GoogleAdsClient
, wywołując metodę GoogleAdsClient.load_from_storage
. Podczas wywoływania metody przekaż ścieżkę do google-ads.yaml
jako ciąg znaków:
from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage("path/to/google-ads.yaml")
Dodaj do rejestratora biblioteki moduł obsługi, który określa, gdzie mają być drukowane logi.
Poniższy kod spowoduje, że rejestrator biblioteki będzie zapisywać dane w konsoli (stdout
).
import logging
import sys
logger = logging.getLogger('google.ads.googleads.client')
logger.addHandler(logging.StreamHandler(sys.stdout))
Następnie uruchom raport kampanii, korzystając z metody GoogleAdsService.SearchStream
, aby pobrać kampanie na koncie. Ten przewodnik nie zawiera szczegółowych informacji o raportowaniu.
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
Gemy Ruby dla biblioteki klienta są publikowane w witrynie hostingowej gemów Rubygems. Zalecany sposób instalacji to użycie narzędzia bundler. Dodaj wiersz do pliku Gemfile:
gem 'google-ads-googleads', '~> 35.2.0'
Następnie uruchom polecenie:
bundle install
Utwórz kopię pliku
google_ads_config.rb
z repozytorium GitHub i zmodyfikuj go, aby zawierał Twoje dane logowania.
ruby
Google::Ads::GoogleAds::Config.new do |c|
c.client_id = 'INSERT_CLIENT_ID_HERE'
c.client_secret = 'INSERT_CLIENT_SECRET_HERE'
c.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'
c.developer_token = 'INSERT_DEVELOPER_TOKEN_HERE'
c.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
end
Utwórz instancję GoogleAdsClient
, przekazując ścieżkę do miejsca, w którym przechowujesz ten plik.
client = Google::Ads::GoogleAds::GoogleAdsClient.new('path/to/google_ads_config.rb')
Następnie uruchom raport kampanii, korzystając z metody GoogleAdsService.SearchStream
, aby pobrać kampanie na koncie. Ten przewodnik nie zawiera szczegółowych informacji o raportowaniu.
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
Biblioteka jest rozpowszechniana w ramach CPAN. Zacznij od sklonowania repozytorium google-ads-perl
w wybranym katalogu.
git clone https://github.com/googleads/google-ads-perl.git
Przejdź do katalogu google-ads-perl
i uruchom w wierszu poleceń to polecenie, aby zainstalować wszystkie zależności potrzebne do korzystania z biblioteki.
cd google-ads-perl
cpan install Module::Build
perl Build.PL
perl Build installdeps
Utwórz kopię pliku
googleads.properties
z repozytorium GitHub i zmodyfikuj go, aby zawierał Twoje dane logowania.
clientId=INSERT_OAUTH2_CLIENT_ID_HERE
clientSecret=INSERT_OAUTH2_CLIENT_SECRET_HERE
refreshToken=INSERT_OAUTH2_REFRESH_TOKEN_HERE
developerToken=INSERT_DEVELOPER_TOKEN_HERE
loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Utwórz instancję Client
, przekazując ścieżkę do miejsca, w którym przechowujesz ten plik.
my $properties_file = "/path/to/googleads.properties";
my $api_client = Google::Ads::GoogleAds::Client->new({
properties_file => $properties_file
});
Następnie uruchom raport kampanii, korzystając z metody GoogleAdsService.SearchStream
, aby pobrać kampanie na koncie. Ten przewodnik nie zawiera szczegółowych informacji o raportowaniu.
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::V21::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;
}
REST
Zacznij od użycia klienta HTTP do pobrania tokena dostępu OAuth 2.0. W tym przewodniku używamy polecenia curl
.
curl \
--data "grant_type=refresh_token" \
--data "client_id=CLIENT_ID" \
--data "client_secret=CLIENT_SECRET" \
--data "refresh_token=REFRESH_TOKEN" \
https://www.googleapis.com/oauth2/v3/token
Następnie uruchom raport kampanii, korzystając z metody GoogleAdsService.SearchStream
, aby pobrać kampanie na koncie. Ten przewodnik nie zawiera szczegółowych informacji o raportowaniu.
curl -i -X POST https://googleads.googleapis.com/v21/customers/CUSTOMER_ID/googleAds:searchStream \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "developer-token: DEVELOPER_TOKEN" \
-H "login-customer-id: LOGIN_CUSTOMER_ID" \
--data-binary "@query.json"
Zawartość pliku query.json
jest następująca:
{
"query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}