/management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences

Lists remarketing audiences to which the user has access.

{ "items": [ { "accountId": "string", "audienceDefinition": { "includeConditions": { "daysToLookBack": 0, "isSmartList": true, "kind": "analytics#includeConditions", "membershipDurationDays": 0, "segment": "string" } }, "audienceType": "string", "created": "2019-08-24T14:15:22Z", "description": "string", "id": "string", "internalWebPropertyId": "string", "kind": "analytics#remarketingAudience", "linkedAdAccounts": [ { "accountId": "string", "eligibleForSearch": true, "id": "string", "internalWebPropertyId": "string", "kind": "analytics#linkedForeignAccount", "linkedAccountId": "string", "remarketingAudienceId": "string", "status": "string", "type": "string", "webPropertyId": "string" } ], "linkedViews": [ "string" ], "name": "string", "stateBasedAudienceDefinition": { "excludeConditions": { "exclusionDuration": "string", "segment": "string" }, "includeConditions": { "daysToLookBack": 0, "isSmartList": true, "kind": "analytics#includeConditions", "membershipDurationDays": 0, "segment": "string" } }, "updated": "2019-08-24T14:15:22Z", "webPropertyId": "string" } ], "itemsPerPage": 0, "kind": "analytics#remarketingAudiences", "nextLink": "string", "previousLink": "string", "startIndex": 0, "totalResults": 0, "username": "string" }

Request

Path Params

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.

Query Params

max-results

integer

optional

The maximum number of remarketing audiences to include in this response.

start-index

integer

optional

An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

type

string

optional

Responses

🟢200Successful response

application/json

Body

A remarketing audience collection lists Analytics remarketing audiences to which the user has access. Each resource in the collection corresponds to a single Analytics remarketing audience.

items

array[object (RemarketingAudience) {14}]

optional

A list of remarketing audiences.

accountId

string

optional

Account ID to which this remarketing audience belongs.

audienceDefinition

object

optional

The simple audience definition that will cause a user to be added to an audience.

audienceType

string

optional

The type of audience, either SIMPLE or STATE_BASED.

created

string <date-time>

read-onlyoptional

Time this remarketing audience was created.

description

string

read-onlyoptional

The description of this remarketing audience.

string

optional

Remarketing Audience ID.

internalWebPropertyId

string

read-onlyoptional

Internal ID for the web property to which this remarketing audience belongs.

kind

string

optional

Collection type.

Default:

analytics#remarketingAudience

linkedAdAccounts

array[object (LinkedForeignAccount) {10}]

optional

The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.

linkedViews

array[string]

optional

The views (profiles) that this remarketing audience is linked to.

name

string

optional

The name of this remarketing audience.

stateBasedAudienceDefinition

object

optional

A state based audience definition that will cause a user to be added or removed from an audience.

updated

string <date-time>

read-onlyoptional

Time this remarketing audience was last modified.

webPropertyId

string

optional

Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.

itemsPerPage

integer <int32>

optional

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

optional

Collection type.

Default:

analytics#remarketingAudiences

nextLink

string

optional

Link to next page for this remarketing audience collection.

previousLink

string

optional

Link to previous page for this view (profile) collection.

startIndex

integer <int32>

optional

The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.

totalResults

integer <int32>

optional

The total number of results for the query, regardless of the number of results in the response.

username

string

optional

Email ID of the authenticated user