List
|
|||||
|
|
||||
Lists remarketing audiences to which the user has access
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 5 input parameters
| Name | Format | Description |
|---|---|---|
accountId Required |
STRING |
The account ID of the remarketing audiences to retrieve |
webPropertyId Required |
STRING |
The web property ID of the remarketing audiences to retrieve |
max-results |
INTEGER |
The maximum number of remarketing audiences to include in this response |
start-index |
INTEGER |
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter |
type |
STRING |
= Parameter name
= Format
|
accountId STRING Required The account ID of the remarketing audiences to retrieve |
|
webPropertyId STRING Required The web property ID of the remarketing audiences to retrieve |
|
max-results INTEGER The maximum number of remarketing audiences to include in this response |
|
start-index INTEGER An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter |
|
type STRING |
Output
This building block provides 47 output parameters
| Name | Format | Description |
|---|---|---|
items[] |
OBJECT |
JSON template for an Analytics remarketing audience |
items[].accountId |
STRING |
Account ID to which this remarketing audience belongs |
items[].audienceDefinition |
OBJECT |
The simple audience definition that will cause a user to be added to an audience |
items[].audienceDefinition.includeConditions |
OBJECT |
JSON template for an Analytics Remarketing Include Conditions |
items[].audienceDefinition.includeConditions.daysToLookBack |
INTEGER |
The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience |
items[].audienceDefinition.includeConditions.isSmartList |
BOOLEAN |
Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 |
items[].audienceDefinition.includeConditions.kind |
STRING |
Resource type for include conditions |
items[].audienceDefinition.includeConditions.membershipDurationDays |
INTEGER |
Number of days (in the range 1 to 540) a user remains in the audience |
items[].audienceDefinition.includeConditions.segment |
STRING |
The segment condition that will cause a user to be added to an audience |
items[].audienceType |
STRING |
The type of audience, either SIMPLE or STATE_BASED |
items[].created |
DATE_TIME |
Time this remarketing audience was created |
items[].description |
STRING |
The description of this remarketing audience |
items[].id |
STRING |
Remarketing Audience ID |
items[].internalWebPropertyId |
STRING |
Internal ID for the web property to which this remarketing audience belongs |
items[].kind |
STRING |
Collection type |
items[].linkedAdAccounts[] |
OBJECT |
JSON template for an Analytics Remarketing Audience Foreign Link |
items[].linkedAdAccounts[].accountId |
STRING |
Account ID to which this linked foreign account belongs |
items[].linkedAdAccounts[].eligibleForSearch |
BOOLEAN |
Boolean indicating whether this is eligible for search |
items[].linkedAdAccounts[].id |
STRING |
Entity ad account link ID |
items[].linkedAdAccounts[].internalWebPropertyId |
STRING |
Internal ID for the web property to which this linked foreign account belongs |
items[].linkedAdAccounts[].kind |
STRING |
Resource type for linked foreign account |
items[].linkedAdAccounts[].linkedAccountId |
STRING |
The foreign account ID. For example the an Google Ads |
items[].linkedAdAccounts[].remarketingAudienceId |
STRING |
Remarketing audience ID to which this linked foreign account belongs |
items[].linkedAdAccounts[].status |
STRING |
The status of this foreign account link |
items[].linkedAdAccounts[].type |
STRING |
The type of the foreign account. For example, |
items[].linkedAdAccounts[].webPropertyId |
STRING |
Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs |
items[].linkedViews[] |
STRING |
|
items[].name |
STRING |
The name of this remarketing audience |
items[].stateBasedAudienceDefinition |
OBJECT |
A state based audience definition that will cause a user to be added or removed from an audience |
items[].stateBasedAudienceDefinition.excludeConditions |
OBJECT |
Defines the conditions to exclude users from the audience |
items[].stateBasedAudienceDefinition.excludeConditions.exclusionDuration |
STRING |
Whether to make the exclusion TEMPORARY or PERMANENT |
items[].stateBasedAudienceDefinition.excludeConditions.segment |
STRING |
The segment condition that will cause a user to be removed from an audience |
items[].stateBasedAudienceDefinition.includeConditions |
OBJECT |
JSON template for an Analytics Remarketing Include Conditions |
items[].stateBasedAudienceDefinition.includeConditions.daysToLookBack |
INTEGER |
The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience |
items[].stateBasedAudienceDefinition.includeConditions.isSmartList |
BOOLEAN |
Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 |
items[].stateBasedAudienceDefinition.includeConditions.kind |
STRING |
Resource type for include conditions |
items[].stateBasedAudienceDefinition.includeConditions.membershipDurationDays |
INTEGER |
Number of days (in the range 1 to 540) a user remains in the audience |
items[].stateBasedAudienceDefinition.includeConditions.segment |
STRING |
The segment condition that will cause a user to be added to an audience |
items[].updated |
DATE_TIME |
Time this remarketing audience was last modified |
items[].webPropertyId |
STRING |
Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs |
itemsPerPage |
INTEGER |
The maximum number of resources the response can contain, regardless of the actual number of resources 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 |
Link to next page for this remarketing audience collection |
previousLink |
STRING |
Link to previous page for this view (profile) collection |
startIndex |
INTEGER |
The starting index of the resources, 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 |
username |
STRING |
Email ID of the authenticated user |
= Parameter name
= Format
|
items[] OBJECT JSON template for an Analytics remarketing audience |
|
items[].accountId STRING Account ID to which this remarketing audience belongs |
|
items[].audienceDefinition OBJECT The simple audience definition that will cause a user to be added to an audience |
|
items[].audienceDefinition.includeConditions OBJECT JSON template for an Analytics Remarketing Include Conditions |
|
items[].audienceDefinition.includeConditions.daysToLookBack INTEGER The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience |
|
items[].audienceDefinition.includeConditions.isSmartList BOOLEAN Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 |
|
items[].audienceDefinition.includeConditions.kind STRING Resource type for include conditions |
|
items[].audienceDefinition.includeConditions.membershipDurationDays INTEGER Number of days (in the range 1 to 540) a user remains in the audience |
|
items[].audienceDefinition.includeConditions.segment STRING The segment condition that will cause a user to be added to an audience |
|
items[].audienceType STRING The type of audience, either SIMPLE or STATE_BASED |
|
items[].created DATE_TIME Time this remarketing audience was created |
|
items[].description STRING The description of this remarketing audience |
|
items[].id STRING Remarketing Audience ID |
|
items[].internalWebPropertyId STRING Internal ID for the web property to which this remarketing audience belongs |
|
items[].kind STRING Collection type |
|
items[].linkedAdAccounts[] OBJECT JSON template for an Analytics Remarketing Audience Foreign Link |
|
items[].linkedAdAccounts[].accountId STRING Account ID to which this linked foreign account belongs |
|
items[].linkedAdAccounts[].eligibleForSearch BOOLEAN Boolean indicating whether this is eligible for search |
|
items[].linkedAdAccounts[].id STRING Entity ad account link ID |
|
items[].linkedAdAccounts[].internalWebPropertyId STRING Internal ID for the web property to which this linked foreign account belongs |
|
items[].linkedAdAccounts[].kind STRING Resource type for linked foreign account |
|
items[].linkedAdAccounts[].linkedAccountId STRING The foreign account ID. For example the an Google Ads |
|
items[].linkedAdAccounts[].remarketingAudienceId STRING Remarketing audience ID to which this linked foreign account belongs |
|
items[].linkedAdAccounts[].status STRING The status of this foreign account link |
|
items[].linkedAdAccounts[].type STRING The type of the foreign account. For example, |
|
items[].linkedAdAccounts[].webPropertyId STRING Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs |
|
items[].linkedViews[] STRING |
|
items[].name STRING The name of this remarketing audience |
|
items[].stateBasedAudienceDefinition OBJECT A state based audience definition that will cause a user to be added or removed from an audience |
|
items[].stateBasedAudienceDefinition.excludeConditions OBJECT Defines the conditions to exclude users from the audience |
|
items[].stateBasedAudienceDefinition.excludeConditions.exclusionDuration STRING Whether to make the exclusion TEMPORARY or PERMANENT |
|
items[].stateBasedAudienceDefinition.excludeConditions.segment STRING The segment condition that will cause a user to be removed from an audience |
|
items[].stateBasedAudienceDefinition.includeConditions OBJECT JSON template for an Analytics Remarketing Include Conditions |
|
items[].stateBasedAudienceDefinition.includeConditions.daysToLookBack INTEGER The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience |
|
items[].stateBasedAudienceDefinition.includeConditions.isSmartList BOOLEAN Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 |
|
items[].stateBasedAudienceDefinition.includeConditions.kind STRING Resource type for include conditions |
|
items[].stateBasedAudienceDefinition.includeConditions.membershipDurationDays INTEGER Number of days (in the range 1 to 540) a user remains in the audience |
|
items[].stateBasedAudienceDefinition.includeConditions.segment STRING The segment condition that will cause a user to be added to an audience |
|
items[].updated DATE_TIME Time this remarketing audience was last modified |
|
items[].webPropertyId STRING Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs |
|
itemsPerPage INTEGER The maximum number of resources the response can contain, regardless of the actual number of resources 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 Link to next page for this remarketing audience collection |
|
previousLink STRING Link to previous page for this view (profile) collection |
|
startIndex INTEGER The starting index of the resources, 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 |
|
username STRING Email ID of the authenticated user |