Ten przewodnik wymaga kilku ustawień wstępnych, które zostały skonfigurowane w poprzednich krokach. Jeśli jeszcze tego nie zrobiono, zacznij od Wprowadzenia.
Wywoływanie interfejsu API
Wybierz klienta, aby uzyskać instrukcje dotyczące wywoływania interfejsu API:
Java
Elementy biblioteki klienta są publikowane w centralnym repozytorium Maven. Dodaj bibliotekę klienta jako zależność do projektu w ten sposób:
Zależność Maven:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>38.0.0</version>
</dependency>
Zależność Gradle:
implementation 'com.google.api-ads:google-ads:38.0.0'
api.googleads.serviceAccountSecretsPath=JSON_KEY_FILE_PATH
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Aby utworzyć obiekt GoogleAdsClient
:
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 o kampaniach, używając metody GoogleAdsService.SearchStream
, aby pobrać kampanie z konta. Ten przewodnik nie zawiera szczegółowych informacji na temat raportowania.
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 bibliotek klienta są publikowane w repozytorium Nuget.org. Zacznij od dodania odwołania do pakietu nuget 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 = OAuth2Flow.SERVICE_ACCOUNT,
OAuth2SecretsJsonPath = "PATH_TO_CREDENTIALS_JSON",
LoginCustomerId = ******
};
GoogleAdsClient client = new GoogleAdsClient(config);
Następnie uruchom raport o kampaniach, używając metody GoogleAdsService.SearchStream
, aby pobrać kampanie z konta. Ten przewodnik nie zawiera szczegółowych informacji na temat raportowania.
public void Run(GoogleAdsClient client, long customerId)
{
// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
Services.V20.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 bibliotek klienta są publikowane w repertuarium Packagist. Przejdź do głównego katalogu projektu i uruchom podane niżej polecenie, aby zainstalować bibliotekę i wszystkie jej zależności w katalogu vendor/
w katalogu głównym projektu.
composer require googleads/google-ads-php:26.2.0
Utwórz kopię pliku google_ads_php.ini
z repozytorium GitHub i zmień go, aby zawierał Twoje dane logowania.
[GOOGLE_ADS]
developerToken = "INSERT_DEVELOPER_TOKEN_HERE"
loginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE"
[OAUTH2]
jsonKeyFilePath = "INSERT_ABSOLUTE_PATH_TO_OAUTH2_JSON_KEY_FILE_HERE"
scopes = "https://www.googleapis.com/auth/adwords"
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 o kampaniach, używając metody GoogleAdsService.SearchStream
, aby pobrać kampanie z konta. Ten przewodnik nie zawiera szczegółowych informacji na temat raportowania.
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 na stronie PyPI. Można ją zainstalować, używając polecenia pip
w ten sposób:
python -m pip install google-ads==21.3.0
Utwórz kopię pliku google-ads.yaml
z repozytorium GitHub i zmodyfikuj go, aby zawierał Twoje dane logowania.
developer_token: INSERT_DEVELOPER_TOKEN_HERE
login_customer_id: INSERT_LOGIN_CUSTOMER_ID_HERE
json_key_file_path: JSON_KEY_FILE_PATH_HERE
Utwórz instancję GoogleAdsClient
, wywołując metodę GoogleAdsClient.load_from_storage
. Podczas wywoływania metody prześlij ś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 dzienniki.
Poniższy kod spowoduje, że rejestrator biblioteki będzie drukować dane do konsoli (stdout
).
import logging
import sys
logger = logging.getLogger('google.ads.googleads.client')
logger.addHandler(logging.StreamHandler(sys.stdout))
Następnie uruchom raport o kampaniach, korzystając z metody GoogleAdsService.SearchStream
, aby pobrać kampanie z konta. Ten przewodnik nie zawiera szczegółowych informacji na temat raportowania.
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
Pakiety Ruby dla biblioteki klienta są publikowane w witrynie Rubygems hostingu pakietów Ruby. Zalecane jest instalowanie za pomocą narzędzia do łączenia. Dodaj wiersz do pliku Gemfile:
gem 'google-ads-googleads', '~> 34.0.0'
Następnie uruchom:
bundle install
Utwórz kopię pliku google_ads_config.rb
z repozytorium GitHub i zmień go, aby zawierał Twoje dane logowania.
Google::Ads::GoogleAds::Config.new do |c|
c.developer_token = 'INSERT_DEVELOPER_TOKEN_HERE'
c.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
c.keyfile = 'JSON_KEY_FILE_PATH'
end
Utwórz instancję GoogleAdsClient
, podając ścieżkę do tego pliku.
client = Google::Ads::GoogleAds::GoogleAdsClient.new('path/to/google_ads_config.rb')
Następnie uruchom raport o kampaniach, używając metody GoogleAdsService.SearchStream
, aby pobrać kampanie z konta. Ten przewodnik nie zawiera szczegółowych informacji na temat raportowania.
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 dystrybuowana w ramach CPAN. Zacznij od sklonowania repozytorium google-ads-perl
do wybranego katalogu.
git clone https://github.com/googleads/google-ads-perl.git
Przejdź do katalogu google-ads-perl
i w menu wiersza poleceń uruchom 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 zmień go, aby zawierał Twoje dane logowania.
jsonKeyFilePath=JSON_KEY_FILE_PATH
developerToken=INSERT_DEVELOPER_TOKEN_HERE
loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Utwórz instancję Client
, podając ścieżkę do tego pliku.
my $properties_file = "/path/to/googleads.properties";
my $api_client = Google::Ads::GoogleAds::Client->new({
properties_file => $properties_file
});
Następnie uruchom raport o kampaniach, używając metody GoogleAdsService.SearchStream
, aby pobrać kampanie z konta. Ten przewodnik nie zawiera szczegółowych informacji na temat raportowania.
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::V20::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 ustawienia konta usługi jako aktywnych danych logowania w gcloudCLI.
gcloud auth login --cred-file=PATH_TO_CREDENTIALS_JSON
Następnie pobierz token dostępu OAuth 2.0 dla interfejsu Google Ads API.
gcloud auth \
print-access-token \
--scopes='https://www.googleapis.com/auth/adwords'
Następnie uruchom raport o kampaniach, używając metody GoogleAdsService.SearchStream
, aby pobrać kampanie z konta. Ten przewodnik nie zawiera szczegółowych informacji na temat raportowania.
curl -i -X POST https://googleads.googleapis.com/v20/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
:
{
"query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}