Hướng dẫn này yêu cầu một số chế độ cài đặt tiên quyết đã được định cấu hình trong các bước trước. Bắt đầu với phần Giới thiệu nếu bạn chưa làm như vậy.
Thực hiện lệnh gọi API
Chọn ứng dụng mà bạn muốn để xem hướng dẫn về cách thực hiện lệnh gọi API:
Java
Cấu phần phần mềm thư viện ứng dụng được phát hành vào kho lưu trữ trung tâm Maven. Thêm thư viện ứng dụng làm phần phụ thuộc vào dự án của bạn như sau:
Phần phụ thuộc Maven là:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>35.0.0</version>
</dependency>
Phần phụ thuộc Gradle là:
implementation 'com.google.api-ads:google-ads:35.0.0'
api.googleads.serviceAccountSecretsPath=JSON_KEY_FILE_PATH
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Tạo đối tượng GoogleAdsClient
như sau:
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);
}
Tiếp theo, hãy chạy báo cáo chiến dịch bằng phương thức GoogleAdsService.SearchStream
để truy xuất các chiến dịch trong tài khoản của bạn. Hướng dẫn này không đề cập đến thông tin chi tiết về việc báo cáo.
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#
Các gói thư viện ứng dụng được phát hành lên kho lưu trữ Nuget.org. Bắt đầu bằng cách thêm tham chiếu nuget vào gói Google.Ads.GoogleAds
.
dotnet add package Google.Ads.GoogleAds --version 18.1.0
Tạo đối tượng GoogleAdsConfig
có các chế độ cài đặt liên quan và sử dụng đối tượng đó để tạo đối tượng GoogleAdsClient
.
GoogleAdsConfig config = new GoogleAdsConfig()
{
DeveloperToken = "******",
OAuth2Mode = OAuth2Flow.SERVICE_ACCOUNT,
OAuth2SecretsJsonPath = "PATH_TO_CREDENTIALS_JSON",
LoginCustomerId = ******
};
GoogleAdsClient client = new GoogleAdsClient(config);
Tiếp theo, hãy chạy báo cáo chiến dịch bằng phương thức GoogleAdsService.SearchStream
để truy xuất các chiến dịch trong tài khoản của bạn. Hướng dẫn này không đề cập đến thông tin chi tiết về việc báo cáo.
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
Các gói thư viện ứng dụng được phát hành lên kho lưu trữ Packagist. Chuyển sang thư mục gốc của dự án và chạy lệnh sau để cài đặt thư viện và tất cả phần phụ thuộc của thư viện trong thư mục vendor/
của thư mục gốc của dự án.
composer require googleads/google-ads-php:25.0.0
Tạo bản sao của tệp google_ads_php.ini
từ kho lưu trữ GitHub và sửa đổi tệp đó để thêm thông tin xác thực của bạn.
[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"
Tạo một bản sao của đối tượng 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();
Tiếp theo, hãy chạy báo cáo chiến dịch bằng phương thức GoogleAdsService.SearchStream
để truy xuất các chiến dịch trong tài khoản của bạn. Hướng dẫn này không đề cập đến thông tin chi tiết về việc báo cáo.
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
Thư viện ứng dụng được phân phối trên PyPI. Bạn có thể cài đặt thư viện này bằng lệnh pip
như sau:
python -m pip install google-ads==21.3.0
Tạo bản sao của tệp google-ads.yaml
từ kho lưu trữ GitHub và sửa đổi tệp đó để thêm thông tin xác thực của bạn.
developer_token: INSERT_DEVELOPER_TOKEN_HERE
login_customer_id: INSERT_LOGIN_CUSTOMER_ID_HERE
json_key_file_path: JSON_KEY_FILE_PATH_HERE
Tạo một thực thể GoogleAdsClient
bằng cách gọi phương thức GoogleAdsClient.load_from_storage
. Truyền đường dẫn đến google-ads.yaml
dưới dạng chuỗi đến phương thức khi gọi phương thức đó:
from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage("path/to/google-ads.yaml")
Tiếp theo, hãy chạy báo cáo chiến dịch bằng phương thức GoogleAdsService.SearchStream
để truy xuất các chiến dịch trong tài khoản của bạn. Hướng dẫn này không đề cập đến thông tin chi tiết về hoạt động báo cáo.
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
Các viên ngọc Ruby cho thư viện ứng dụng được phát hành trên trang web lưu trữ viên ngọc Rubygems. Bạn nên cài đặt bằng trình tạo gói. Thêm một dòng vào Gemfile:
gem 'google-ads-googleads', '~> 30.0.0'
Sau đó, hãy chạy:
bundle install
Tạo bản sao của tệp google_ads_config.rb
từ kho lưu trữ GitHub và sửa đổi tệp đó để thêm thông tin xác thực của bạn.
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
Tạo một thực thể GoogleAdsClient
bằng cách truyền đường dẫn đến nơi bạn lưu trữ tệp này.
client = Google::Ads::GoogleAds::GoogleAdsClient.new('path/to/google_ads_config.rb')
Tiếp theo, hãy chạy báo cáo chiến dịch bằng phương thức GoogleAdsService.SearchStream
để truy xuất các chiến dịch trong tài khoản của bạn. Hướng dẫn này không đề cập đến thông tin chi tiết về việc báo cáo.
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
Thư viện này được phân phối trên CPAN. Bắt đầu bằng cách nhân bản
kho lưu trữ google-ads-perl
trong thư mục bạn chọn.
git clone https://github.com/googleads/google-ads-perl.git
Chuyển sang thư mục google-ads-perl
và chạy lệnh sau tại lời nhắc lệnh để cài đặt tất cả phần phụ thuộc cần thiết cho việc sử dụng thư viện.
cd google-ads-perl
cpan install Module::Build
perl Build.PL
perl Build installdeps
Tạo bản sao của tệp googleads.properties
từ kho lưu trữ GitHub và sửa đổi tệp đó để thêm thông tin xác thực của bạn.
jsonKeyFilePath=JSON_KEY_FILE_PATH
developerToken=INSERT_DEVELOPER_TOKEN_HERE
loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Tạo một thực thể Client
bằng cách truyền đường dẫn đến nơi bạn lưu trữ tệp này.
my $properties_file = "/path/to/googleads.properties";
my $api_client = Google::Ads::GoogleAds::Client->new({
properties_file => $properties_file
});
Tiếp theo, hãy chạy một báo cáo chiến dịch bằng phương thức GoogleAdsService.SearchStream
để truy xuất các chiến dịch trong tài khoản của bạn. Hướng dẫn này không đề cập đến thông tin chi tiết về hoạt động báo cáo.
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;
}
REST
Bắt đầu bằng cách sử dụng ứng dụng HTTP để tìm nạp mã truy cập OAuth 2.0.
gcloud auth \
print-access-token \
--scopes='https://www.googleapis.com/auth/adwords'
Tiếp theo, hãy chạy báo cáo chiến dịch bằng phương thức GoogleAdsService.SearchStream
để truy xuất các chiến dịch trong tài khoản của bạn. Hướng dẫn này không đề cập đến thông tin chi tiết về hoạt động báo cáo.
curl -i -X POST https://googleads.googleapis.com/v18/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"
Nội dung của query.json
như sau:
{
"query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}