需要授权
列出给定网络媒体资源的 webProperty-Google Ads 关联。 立即试用或查看示例。
请求
HTTP 请求
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks
参数
参数名称 | 值 | 说明 |
---|---|---|
路径参数 | ||
accountId |
string |
给定网络媒体资源所属帐号的 ID。 |
webPropertyId |
string |
要为其提取 Google Ads 关联的网络媒体资源 ID。 |
可选的查询参数 | ||
max-results |
integer |
此响应所能包含的网络媒体资源-Google Ads 关联数量上限。 |
start-index |
integer |
要提取的首个网络媒体资源-Google Ads 关联的索引。此参数可与 max-results 参数搭配使用,作为分页机制。 |
授权
此请求需要获得以下至少一个范围的授权(详细了解身份验证和授权)。
范围 |
---|
https://www.googleapis.com/auth/analytics.edit |
https://www.googleapis.com/auth/analytics.readonly |
请求正文
使用此方法时请勿提供请求正文。
响应
如果成功,此方法将返回采用以下结构的响应正文:
{ "kind": "analytics#entityAdWordsLinks", "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.webPropertyAdWordsLinks Resource ] }
属性名称 | 值 | 说明 | 备注 |
---|---|---|---|
kind |
string |
集合类型。 | |
totalResults |
integer |
查询的结果总数,与响应中的结果数无关。 | |
startIndex |
integer |
条目的起始索引,默认为 1,或者通过 start-index 查询参数指定。 | |
itemsPerPage |
integer |
响应所能包含的最大条目数,与返回的实际条目数无关。其值的范围为 1 至 1000,默认值为 1000,或者通过 max-results 查询参数指定。 | |
previousLink |
string |
此 Google Ads 关联集合的上一个关联。 | |
nextLink |
string |
此 Google Ads 关联集合的下一个关联。 | |
items[] |
list |
实体 Google Ads 关联列表。 |
示例
注意:此方法的代码示例并未列出所有受支持的编程语言(请参阅客户端库页面,查看受支持的语言列表)。
Java
使用 Java 客户端库。
/* * Note: This code assumes you have an authorized Analytics service object. * See the Google Ads Links Developer Guide for details. */ /* * Example #1: * Requests a list of all Google Ads links for the authorized user. */ try { EntityAdWordsLinks adWordsLinks = analytics.management(). webPropertyAdWordsLinks().list("123456", "UA-123456-1").execute(); } catch (GoogleJsonResponseException e) { System.err.println("There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); } /* * Example 2: * The results of the list method are stored in the adWordsLinks object. * The following code shows how to iterate through them. */ for (EntityAdWordsLink link : adWordsLinks.getItems()) { System.out.println("Link Id = " + link.getId()); System.out.println("Link Kind = " + link.getKind()); System.out.println("Link Name = " + link.getName()); // Get the web property reference from the entity. WebPropertyRef property = link.getEntity().getWebPropertyRef(); System.out.println("Property Id = " + property.getId()); System.out.println("Property Kind = " + property.getKind()); System.out.println("Property Name = " + property.getName()); System.out.println("Property Account Id = " + property.getAccountId()); // Get the Google Ads accounts. List<AdWordsAccount> adWordsAccounts = link.getAdWordsAccounts(); for (AdWordsAccount account : adWordsAccounts) { System.out.println("Account Kind = " + account.getKind()); System.out.println("Account Id = " + account.getCustomerId()); System.out.println("Auto Tagging Enabled = " + account.getAutoTaggingEnabled()); } }
PHP
使用 PHP 客户端库。
/** * Note: This code assumes you have an authorized Analytics service object. * See the Google Ads Links Developer Guide for details. */ /** * Example #1: * Requests a list of all Google Ads links for the authorized user. */ try { $adWordsLinks = $analytics->management_webPropertyAdWordsLinks ->listManagementwebPropertyAdWordsLinks('123456', 'UA-123456-1'); } catch (apiServiceException $e) { print 'There was an Analytics API service error ' . $e->getCode() . ':' . $e->getMessage(); } catch (apiException $e) { print 'There was a general API error ' . $e->getCode() . ':' . $e->getMessage(); } /** * Example #2: * The results of the list method are stored in the adWordsLinks object. * The following code shows how to iterate through them. */ foreach ($adWordsLinks->getItems() as $link) { $html = <<<HTML <pre> Link Id = {$link->getId()} Link Kind = {$link->getKind()} Link Name = {$link->getName()} HTML; // Get the web property reference from the entity. $property = $link->getEntity()->getWebPropertyRef(); $html = <<<HTML Property Id = {$property->getId()} Property Kind = {$property->getKind()} Property Name = {$property->getName()} Property Account Id = {$property->getAccountId()} HTML; // Get the Google Ads accounts. foreach ($link->getAdWordsAccounts as $account) { $html = <<<HTML Account Kind = {$account->getKind()} Account Id = {$account->getCustomerId()} Auto Tagging Enabled = {$account->getAutoTaggingEnabled()} HTML; } $html .= '</pre>'; print $html; }
Python
使用 Python 客户端库。
# Note: This code assumes you have an authorized Analytics service object. # See the Google Ads Links Developer Guide for details. # Example #1: # Requests a list of all Google Ads links for the authorized user. try: adWordsLinks = analytics.management().webPropertyAdWordsLinks().list( accountId='123456', webPropertyId='UA-123456-1' ).execute() except TypeError, error: # Handle errors in constructing a query. print 'There was an error in constructing your query : %s' % error except HttpError, error: # Handle API errors. print ('There was an API error : %s : %s' % (error.resp.status, error.resp.reason)) # Example #2: # The results of the list method are stored in the adWordsLinks object. # The following code shows how to iterate through them. for link in adWordsLinks.get('items', []): print 'Link Id = %s' % link.get('id') print 'Link Kind = %s' % link.get('kind') print 'Link Name = %s' % link.get('name') # Get the property reference from the entity. property = link.get('entity', {}).get('webPropertyRef', {}) print 'Property Id = %s' % property.get('id') print 'Property Kind = %s' % property.get('kind') print 'Property Name = %s' % property.get('name') print 'Property Account id = %s' % property.get('accountId') # Get the Google Ads accounts. adWordsAccounts = link.get('adWordsAccounts', []) for account in adWordsAccounts: print 'Account Id = %s' % account.get('id') print 'Account Kind = %s' % account.get('kind') print 'Auto Tagging Enabled = %s' % account.get('autoTaggingEnabled')
JavaScript
使用 JavaScript 客户端库。
/* * Note: This code assumes you have an authorized Analytics client object. * See the Google Ads Links Developer Guide for details. */ /* * Example 1: * Requests a list of all Google Ads links for the authorized user. */ function listAdWordsLinks() { var request = gapi.client.analytics.management.webPropertyAdWordsLinks.list({ 'accountId': '123456', 'webPropertyId': 'UA-123456-1' }); request.execute(printViews); } /* * Example 2: * The results of the list method are passed as the results object. * The following code shows how to iterate through them. */ function printViews(results) { if (results && !results.error) { var adWordsLinks = results.items; for (var i = 0, link; link = adWordsLinks[i]; i++) { console.log('Link Id: ' + link.id); console.log('Link Kind: ' + link.kind); console.log('Link Name: ' + link.name); // Get the property reference from the entity. var property = link.entity.webPropertyRef; console.log('Property Id: ' + property.id); console.log('Property Kind: ' + property.kind); console.log('Property Name: ' + property.name); console.log('Property Account id: ' + property.accountId); // Get the Google Ads accounts. var adWordsAccounts = link.adWordsAccounts; for (var j = 0, account; account = adWordsAccounts[j]; j++) { console.log('Account Id: ' + account.customerId); console.log('Account Kind: ' + account.kind); console.log('Auto Tagging Enabled: ' + account.autoTaggingEnabled); } } } }
试试看!
请使用下面的 API Explorer 对实际数据调用此方法,并查看响应。或者,您也可以尝试使用独立的 Explorer。