Requires authorization
Lists webProperty-Google Ads links for a given web property. Try it now or see an example.
Request
HTTP request
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
accountId |
string |
ID of the account which the given web property belongs to. |
webPropertyId |
string |
Web property ID to retrieve the Google Ads links for. |
Optional query parameters | ||
max-results |
integer |
The maximum number of webProperty-Google Ads links to include in this response. |
start-index |
integer |
An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
Authorization
This request requires authorization with at least one of the following scopes (read more about authentication and authorization).
Scope |
---|
https://www.googleapis.com/auth/analytics.edit |
https://www.googleapis.com/auth/analytics.readonly |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind": "analytics#entityAdWordsLinks", "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.webPropertyAdWordsLinks Resource ] }
Property name | Value | Description | Notes |
---|---|---|---|
kind |
string |
Collection type. | |
totalResults |
integer |
The total number of results for the query, regardless of the number of results in the response. | |
startIndex |
integer |
The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. | |
itemsPerPage |
integer |
The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. | |
previousLink |
string |
Previous link for this Google Ads link collection. | |
nextLink |
string |
Next link for this Google Ads link collection. | |
items[] |
list |
A list of entity Google Ads links. |
Examples
Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).
Java
Uses the Java client library.
/* * 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
Uses the PHP client library.
/** * 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
Uses the Python client library.
# 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
Uses the JavaScript client library.
/* * 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); } } } }
Try it!
Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.