Для этого руководства требуется несколько предварительных настроек, которые были настроены на предыдущих шагах. Начните с введения , если вы еще этого не сделали.
В этом руководстве также используются токены обновления — рабочий процесс, при котором пользователь с достаточным доступом к аккаунту Google Рекламы может авторизовать ваше приложение при однократной настройке для выполнения автономных вызовов API к аккаунту без какого-либо дальнейшего вмешательства пользователя. Вы можете использовать токены обновления для создания как автономных рабочих процессов, таких как задания cron или конвейеры данных, так и интерактивных рабочих процессов, таких как веб-приложения или мобильные приложения.
Получить токен обновления
API Google Рекламы использует OAuth 2.0 в качестве механизма авторизации. По умолчанию проверка подлинности OAuth 2.0 выдает токен доступа , срок действия которого истекает через ограниченное время. Чтобы автоматически обновить токен доступа, вместо этого вам следует выдать токен обновления .
Создайте токен обновления, запустив инструмент oauth2l :
oauth2l fetch --credentials credentials.json --scope adwords \ --output_format refresh_token
Файл
credentials.json
взят из предыдущего шага .Команда
oauth2l
открывает окно входа в учетную запись Google в новом окне браузера и проведет вас через этапы аутентификации OAuth 2.0.Убедитесь, что вы входите в систему, используя адрес электронной почты, указанный на этапе, когда вы определили свой идентификатор клиента для входа .
Если ваше приложение не проверено, вы можете увидеть экран с предупреждением. В таких случаях можно безопасно щелкнуть ссылку «Показать дополнительные параметры» и выбрать параметр «Перейти к PROJECT_NAME (не проверено)» .
После проверки областей предоставьте разрешение, нажав кнопку «Продолжить» .
В браузере отображается приглашение со следующим текстом:
Authorization code granted. Please close this tab.
Команда
oauth2l
выводит следующий фрагмент JSON:{ "client_id": "******.apps.googleusercontent.com", "client_secret": "******", "token_uri": "https://oauth2.googleapis.com/token", "auth_uri": "https://accounts.google.com/o/oauth2/auth", "refresh_token": "******", "type": "authorized_user" }
Сделать вызов API
Выберите предпочитаемый вами клиент, чтобы получить инструкции о том, как выполнить вызов API:
Ява
Артефакты клиентской библиотеки публикуются в центральном репозитории Maven . Добавьте клиентскую библиотеку в качестве зависимости к вашему проекту следующим образом:
Зависимость Maven:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>33.0.0</version>
</dependency>
Зависимость Gradle:
implementation 'com.google.api-ads:google-ads:33.0.0'
Создайте файл ~/ads.properties
со следующим содержимым:
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
Создайте объект 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);
}
Затем запустите отчет о кампании, используя метод GoogleAdsService.SearchStream
, чтобы получить данные о кампаниях в вашей учетной записи. В этом руководстве не рассматриваются детали отчетности .
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());
}
}
}
}
С#
Пакеты клиентской библиотеки публикуются в репозитории Nuget.org . Начните с добавления ссылки nuget в пакет Google.Ads.GoogleAds
.
dotnet add package Google.Ads.GoogleAds --version 18.1.0
Создайте объект GoogleAdsConfig
с соответствующими настройками и используйте его для создания объекта GoogleAdsClient
.
GoogleAdsConfig config = new GoogleAdsConfig()
{
DeveloperToken = "******",
OAuth2Mode = "APPLICATION",
OAuth2ClientId = "******.apps.googleusercontent.com",
OAuth2ClientSecret = "******",
OAuth2RefreshToken = "******",
LoginCustomerId = ******
};
GoogleAdsClient client = new GoogleAdsClient(config);
Затем запустите отчет о кампании, используя метод GoogleAdsService.SearchStream
, чтобы получить данные о кампаниях в вашей учетной записи. В этом руководстве не рассматриваются детали отчетности .
public void Run(GoogleAdsClient client, long customerId)
{
// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
Services.V17.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
Пакеты клиентской библиотеки публикуются в репозитории Packagist . Перейдите в корневой каталог вашего проекта и выполните следующую команду, чтобы установить библиотеку и все ее зависимости в vendor/
корневого каталога вашего проекта.
composer require googleads/google-ads-php:22.0.0
Создайте копию файла google_ads_php.ini
из репозитория GitHub и измените его, включив в него свои учетные данные.
[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"
Создайте экземпляр объекта 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();
Затем запустите отчет о кампании, используя метод GoogleAdsService.SearchStream
, чтобы получить данные о кампаниях в вашей учетной записи. В этом руководстве не рассматриваются детали отчетности .
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
);
}
}
Питон
Клиентскую библиотеку, распространяемую на PyPI, можно установить с помощью команды pip
следующим образом:
python -m pip install google-ads==21.3.0
Создайте копию файла google-ads.yaml
из репозитория GitHub и измените его, включив в него свои учетные данные.
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
Создайте экземпляр GoogleAdsClient
, вызвав метод GoogleAdsClient.load_from_storage
. Передайте путь к вашему google-ads.yaml
в виде строки методу при его вызове:
from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage("path/to/google-ads.yaml")
Затем запустите отчет о кампании, используя метод GoogleAdsService.SearchStream
, чтобы получить данные о кампаниях в вашей учетной записи. В этом руководстве не рассматриваются детали отчетности .
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 для клиентской библиотеки публикуются на сайте хостинга гем Rubygems . Рекомендуемый способ установки — использование бандлера. Добавьте строку в свой Gemfile:
gem 'google-ads-googleads', '~> 30.0.0'
Затем запустите:
bundle install
Создайте копию файла google_ads_config.rb
из репозитория GitHub и измените его, включив в него свои учетные данные.
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
Создайте экземпляр GoogleAdsClient
, передав путь к тому месту, где вы храните этот файл.
client = Google::Ads::GoogleAds::GoogleAdsClient.new('path/to/google_ads_config.rb')
Затем запустите отчет о кампании, используя метод GoogleAdsService.SearchStream
, чтобы получить данные о кампаниях в вашей учетной записи. В этом руководстве не рассматриваются детали отчетности .
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
Перл
Библиотека распространяется на CPAN . Начните с клонирования репозитория google-ads-perl
в выбранный вами каталог.
git clone https://github.com/googleads/google-ads-perl.git
Перейдите в каталог google-ads-perl
и выполните следующую команду в командной строке, чтобы установить все зависимости, необходимые для использования библиотеки.
cd google-ads-perl
cpan install Module::Build
perl Build.PL
perl Build installdeps
Создайте копию файла googleads.properties
из репозитория GitHub и измените его, включив в него свои учетные данные.
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
Создайте экземпляр Client
, передав путь к тому месту, где вы храните этот файл.
my $properties_file = "/path/to/googleads.properties";
my $api_client = Google::Ads::GoogleAds::Client->new({
properties_file => $properties_file
});
Затем запустите отчет о кампании, используя метод GoogleAdsService.SearchStream
, чтобы получить данные о кампаниях в вашей учетной записи. В этом руководстве не рассматриваются детали отчетности .
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::V17::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;
}
ОТДЫХ
Начните с использования HTTP-клиента для получения токена доступа OAuth 2.0. В этом руководстве используется команда 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
Затем запустите отчет о кампании, используя метод GoogleAdsService.SearchStream
, чтобы получить данные о кампаниях в вашей учетной записи. В этом руководстве не рассматриваются детали отчетности .
curl -i -X POST https://googleads.googleapis.com/v17/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"
Содержимое query.json
следующее:
{
"query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}