在多使用者驗證工作流程中,您會建構自己的 OAuth 流程來驗證使用者。Google Identity 說明文件中討論了多種應用程式類型,以及支援該應用程式類型所需的 Google Cloud 控制台專案設定。Google Ads API 支援所有這些應用程式類型。請注意下列額外技術細節:
如要存取 Google Ads API,請將應用程式設定為驗證下列範圍:
https://www.googleapis.com/auth/adwords
應用程式可能必須在使用者離線時,代表使用者發出 API 呼叫。常見情況是離線下載帳戶指標,以產生報表及執行帳戶分析。因此,我們建議您要求 OAuth 離線存取權。
您應完成 OAuth 應用程式驗證程序,並取得應用程式認證。
用戶端程式庫設定
授權使用者並取得 OAuth 2.0 憑證後,請按照程式設計語言對應分頁中的操作說明,設定用戶端程式庫。
Java
您可以在執行階段初始化 GoogleAdsClient
執行個體,方法是使用從使用者取得的憑證,並透過這些憑證對帳戶發出 API 呼叫。
UserCredentials credentials =
UserCredentials.newBuilder()
.setClientId(OAUTH_CLIENT_ID)
.setClientSecret(OAUTH_CLIENT_SECRET)
.setRefreshToken(REFRESH_TOKEN)
.build();
// Creates a GoogleAdsClient with the provided credentials.
GoogleAdsClient client =
GoogleAdsClient.newBuilder()
// Sets the developer token which enables API access.
.setDeveloperToken(DEVELOPER_TOKEN)
// Sets the OAuth credentials which provide Google Ads account access.
.setCredentials(credentials)
// Optional: sets the login customer ID.
.setLoginCustomerId(Long.valueOf(LOGIN_CUSTOMER_ID))
.build();
``` See the [configuration guide][java-config-guide] for additional options.
.NET
您可以在執行階段初始化 GoogleAdsClient
執行個體,方法是使用從使用者取得的憑證,並透過這些憑證對帳戶發出 API 呼叫。
GoogleAdsConfig googleAdsConfig = new GoogleAdsConfig()
{
DeveloperToken = DEVELOPER_TOKEN,
LoginCustomerId = LOGIN_CUSTOMER_ID,
OAuth2ClientId = OAUTH_CLIENT_ID,
OAuth2ClientSecret = OAUTH_CLIENT_SECRET,
OAuth2RefreshToken = REFRESH_TOKEN,
};
GoogleAdsClient googleAdsClient = new GoogleAdsClient(googleAdsConfig);
如需其他選項,請參閱設定指南。
Python
您可以在執行階段初始化 GoogleAdsClient
執行個體,方法是使用從使用者取得的憑證,並透過這些憑證對帳戶發出 API 呼叫。
from google.ads.googleads.client import GoogleAdsClient
credentials = {
"developer_token": "INSERT_DEVELOPER_TOKEN_HERE",
"login_customer_id": "INSERT_LOGIN_CUSTOMER_ID_HERE",
"refresh_token": "REFRESH_TOKEN",
"client_id": "OAUTH_CLIENT_ID",
"client_secret": "OAUTH_CLIENT_SECRET"}
client = GoogleAdsClient.load_from_dict(credentials)
如需其他選項,請參閱設定指南。
PHP
您可以在執行階段初始化 GoogleAdsClient
執行個體,方法是使用從使用者取得的憑證,並透過這些憑證對帳戶發出 API 呼叫。
$oAuth2Credential = (new OAuth2TokenBuilder())
->withClientId('INSERT_CLIENT_ID_HERE')
->withClientSecret('INSERT_CLIENT_SECRET_HERE')
->withRefreshToken('INSERT_REFRESH_TOKEN_HERE')
->build();
$googleAdsClient = (new GoogleAdsClientBuilder())
->withOAuth2Credential($oAuth2Credential)
->withDeveloperToken('INSERT_DEVELOPER_TOKEN_HERE')
->withLoginCustomerId('INSERT_LOGIN_CUSTOMER_ID_HERE')
->build();
如需其他選項,請參閱設定指南。
Ruby
您可以在執行階段初始化 GoogleAdsClient
執行個體,方法是使用從使用者取得的憑證,並透過這些憑證對帳戶發出 API 呼叫。
client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
config.client_id = 'INSERT_CLIENT_ID_HERE'
config.client_secret = 'INSERT_CLIENT_SECRET_HERE'
config.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'
config.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
config.developer_token = 'INSERT_DEVELOPER_TOKEN_HERE'
end
如需其他選項,請參閱設定指南。
Perl
您可以在執行階段初始化 GoogleAdsClient
執行個體,方法是使用從使用者取得的憑證,並透過這些憑證對帳戶發出 API 呼叫。
my $api_client = Google::Ads::GoogleAds::Client->new({
developer_token => "INSERT_DEVELOPER_TOKEN_HERE",
login_customer_id => "INSERT_LOGIN_CUSTOMER_ID_HERE"
});
my $oauth2_applications_handler = $api_client->get_oauth2_applications_handler();
$oauth2_applications_handler->set_client_id("INSERT_CLIENT_ID");
$oauth2_applications_handler->set_client_secret("INSERT_CLIENT_SECRET");
$oauth2_applications_handler->set_refresh_token("INSERT_REFRESH_TOKEN");
如需其他選項,請參閱設定指南。
curl
首先,請使用 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
現在您可以在 API 呼叫中使用存取權杖。以下範例說明如何使用 GoogleAdsService.SearchStream
方法,擷取帳戶中的廣告活動,並執行廣告活動報表。本指南未涵蓋報表的詳細資訊。
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"
query.json
的內容如下:
{
"query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}