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

GET

management

Gets a remarketing audience to which the user has access.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://analytics.googleapis.com/analytics/v3/management/accounts//webproperties//remarketingAudiences/'

Response Example

{
  "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"
}

Request

Path Params

accountId

string

required

The account ID of the remarketing audience to retrieve.

webPropertyId

string

required

The web property ID of the remarketing audience to retrieve.

remarketingAudienceId

string

required

The ID of the remarketing audience to retrieve.

Responses

🟢200Successful response

application/json

Body

JSON template for an Analytics remarketing audience.

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.

includeConditions

object (IncludeConditions)

optional

Defines the conditions to include users to the 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.

accountId

string

optional

Account ID to which this linked foreign account belongs.

eligibleForSearch

boolean

read-onlyoptional

Boolean indicating whether this is eligible for search.

string

optional

Entity ad account link ID.

internalWebPropertyId

string

read-onlyoptional

Internal ID for the web property to which this linked foreign account belongs.

kind

string

optional

Resource type for linked foreign account.

Default:

analytics#linkedForeignAccount

linkedAccountId

string

optional

The foreign account ID. For example the an Google Ads linkedAccountId has the following format XXX-XXX-XXXX.

remarketingAudienceId

string

optional

Remarketing audience ID to which this linked foreign account belongs.

status

string

optional

The status of this foreign account link.

type

string

optional

The type of the foreign account. For example, ADWORDS_LINKS, DBM_LINKS, MCC_LINKS or OPTIMIZE.

webPropertyId

string

optional

Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.

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.

excludeConditions

object

optional

Defines the conditions to exclude users from the audience.

includeConditions

object (IncludeConditions)

optional

Defines the conditions to include users to the 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.

Modified at 2023-08-15 05:39:07

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