List
|
|||||
|
|
||||
Lists webProperty-Google Ads links for a given web property
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Edit Google Analytics management entities
- View your Google Analytics data
Input
This building block consumes 4 input parameters
| Name | Format | Description |
|---|---|---|
accountId Required |
STRING |
ID of the account which the given web property belongs to |
webPropertyId Required |
STRING |
Web property ID to retrieve the Google Ads links for |
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 |
= Parameter name
= Format
|
accountId STRING Required ID of the account which the given web property belongs to |
|
webPropertyId STRING Required Web property ID to retrieve the Google Ads links for |
|
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 |
Output
This building block provides 24 output parameters
| Name | Format | Description |
|---|---|---|
items[] |
OBJECT |
JSON template for Analytics Entity Google Ads Link |
items[].adWordsAccounts[] |
OBJECT |
JSON template for an Google Ads account |
items[].adWordsAccounts[].autoTaggingEnabled |
BOOLEAN |
True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation |
items[].adWordsAccounts[].customerId |
STRING |
Customer ID. This field is required when creating a Google Ads link |
items[].adWordsAccounts[].kind |
STRING |
Resource type for Google Ads account |
items[].entity |
OBJECT |
Web property being linked |
items[].entity.webPropertyRef |
OBJECT |
JSON template for a web property reference |
items[].entity.webPropertyRef.accountId |
STRING |
Account ID to which this web property belongs |
items[].entity.webPropertyRef.href |
STRING |
Link for this web property |
items[].entity.webPropertyRef.id |
STRING |
Web property ID of the form UA-XXXXX-YY |
items[].entity.webPropertyRef.internalWebPropertyId |
STRING |
Internal ID for this web property |
items[].entity.webPropertyRef.kind |
STRING |
Analytics web property reference |
items[].entity.webPropertyRef.name |
STRING |
Name of this web property |
items[].id |
STRING |
Entity Google Ads link ID |
items[].kind |
STRING |
Resource type for entity Google Ads link |
items[].name |
STRING |
Name of the link. This field is required when creating a Google Ads link |
items[].profileIds[] |
STRING |
|
items[].selfLink |
STRING |
URL link for this Google Analytics - Google Ads link |
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 |
kind |
STRING |
Collection type |
nextLink |
STRING |
Next link for this Google Ads link collection |
previousLink |
STRING |
Previous link for this Google Ads link collection |
startIndex |
INTEGER |
The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter |
totalResults |
INTEGER |
The total number of results for the query, regardless of the number of results in the response |
= Parameter name
= Format
|
items[] OBJECT JSON template for Analytics Entity Google Ads Link |
|
items[].adWordsAccounts[] OBJECT JSON template for an Google Ads account |
|
items[].adWordsAccounts[].autoTaggingEnabled BOOLEAN True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation |
|
items[].adWordsAccounts[].customerId STRING Customer ID. This field is required when creating a Google Ads link |
|
items[].adWordsAccounts[].kind STRING Resource type for Google Ads account |
|
items[].entity OBJECT Web property being linked |
|
items[].entity.webPropertyRef OBJECT JSON template for a web property reference |
|
items[].entity.webPropertyRef.accountId STRING Account ID to which this web property belongs |
|
items[].entity.webPropertyRef.href STRING Link for this web property |
|
items[].entity.webPropertyRef.id STRING Web property ID of the form UA-XXXXX-YY |
|
items[].entity.webPropertyRef.internalWebPropertyId STRING Internal ID for this web property |
|
items[].entity.webPropertyRef.kind STRING Analytics web property reference |
|
items[].entity.webPropertyRef.name STRING Name of this web property |
|
items[].id STRING Entity Google Ads link ID |
|
items[].kind STRING Resource type for entity Google Ads link |
|
items[].name STRING Name of the link. This field is required when creating a Google Ads link |
|
items[].profileIds[] STRING |
|
items[].selfLink STRING URL link for this Google Analytics - Google Ads link |
|
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 |
|
kind STRING Collection type |
|
nextLink STRING Next link for this Google Ads link collection |
|
previousLink STRING Previous link for this Google Ads link collection |
|
startIndex INTEGER The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter |
|
totalResults INTEGER The total number of results for the query, regardless of the number of results in the response |