本指南需要在前述步驟中完成幾項必要設定。如果您尚未這麼做,請先從簡介開始著手。
本指南也會使用更新權杖。在這個工作流程中,具有 Google Ads 帳戶足夠存取權的使用者,可在單次設定中授權您的應用程式,對帳戶進行離線 API 呼叫,而不需要使用者進一步操作。您可以使用更新權杖建立離線工作流程,例如 Cron 工作或資料管道,以及互動式工作流程,例如網頁或行動應用程式。
擷取更新權杖
Google Ads API 使用 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 驗證步驟。登入時,請務必使用識別登入客戶 ID 的步驟中的電子郵件地址。
如果您的應用程式未經驗證,系統可能會顯示警告畫面。在這種情況下,您可以放心按一下「Show Advanced」連結,然後點選「Go to PROJECT_NAME (unauthenticate)」選項。
驗證範圍後,請按一下「Continue」按鈕授予權限。
瀏覽器會顯示一個含有以下文字的提示:
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 呼叫:
Java
用戶端程式庫成果會發布至 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());
}
}
}
}
C#
用戶端程式庫套件會發布到 Nuget.org 存放區。請先為 Google.Ads.GoogleAds
套件新增 Nuget 參照。
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
從 GitHub 存放區複製 google_ads_php.ini
檔案,並修改檔案以加入您的憑證。
[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
);
}
}
Python
您可以使用 pip
指令安裝在 PyPI 上發布用戶端程式庫,如下所示:
python -m pip install google-ads==21.3.0
從 GitHub 存放區複製 google-ads.yaml
檔案,並修改檔案以加入您的憑證。
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.load_from_storage
方法來建立 GoogleAdsClient
例項。呼叫 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
用戶端程式庫的 Ruby 寶石會發布到 Rubygems gem 託管網站。建議您使用 bundler 進行安裝。在 Gemfile 中新增一行:
gem 'google-ads-googleads', '~> 23.1.0'
接著執行:
bundle install
從 GitHub 存放區複製 google_ads_config.rb
檔案,並修改檔案以加入您的憑證。
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
Perl
程式庫發布於 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
從 GitHub 存放區複製 googleads.properties
檔案,並修改檔案以加入您的憑證。
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;
}
REST
首先,使用 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"
}