在多用户身份验证工作流中,您需要构建自己的 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"
}