Take our developer survey. We want your feedback so we can learn how to improve Google Analytics, and make it an even better tool for you.

Remarketing Audiences

For a list of methods for this resource, see the end of this page.

Resource representations

JSON template for an Analytics remarketing audience.

{
  "kind": "analytics#remarketingAudience",
  "id": string,
  "accountId": string,
  "webPropertyId": string,
  "internalWebPropertyId": string,
  "created": datetime,
  "updated": datetime,
  "name": string,
  "description": string,
  "linkedAdAccounts": [
    {
      "kind": "analytics#linkedForeignAccount",
      "id": string,
      "accountId": string,
      "webPropertyId": string,
      "internalWebPropertyId": string,
      "remarketingAudienceId": string,
      "linkedAccountId": string,
      "type": string,
      "status": string,
      "eligibleForSearch": boolean
    }
  ],
  "linkedViews": [
    string
  ],
  "audienceType": string,
  "audienceDefinition": {
    "includeConditions": {
      "kind": "analytics#includeConditions",
      "isSmartList": boolean,
      "segment": string,
      "membershipDurationDays": integer,
      "daysToLookBack": integer
    }
  },
  "stateBasedAudienceDefinition": {
    "includeConditions": {
      "kind": "analytics#includeConditions",
      "isSmartList": boolean,
      "segment": string,
      "membershipDurationDays": integer,
      "daysToLookBack": integer
    },
    "excludeConditions": {
      "segment": string,
      "exclusionDuration": string
    }
  }
}
Property name Value Description Notes
accountId string Account ID to which this remarketing audience belongs.
audienceDefinition object The simple audience definition that will cause a user to be added to an audience. writable
audienceDefinition.includeConditions nested object Defines the conditions to include users to the audience. writable
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. writable
audienceDefinition.includeConditions.isSmartList boolean Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 writable
audienceDefinition.includeConditions.kind string Resource type for include conditions.
audienceDefinition.includeConditions.membershipDurationDays integer Number of days (in the range 1 to 540) a user remains in the audience. writable
audienceDefinition.includeConditions.segment string The segment condition that will cause a user to be added to an audience. writable
audienceType string The type of audience, either SIMPLE or STATE_BASED.

Acceptable values are:
  • "SIMPLE"
  • "STATE_BASED"
writable
created datetime Time this remarketing audience was created.
description string The description of this remarketing audience.
id string Remarketing Audience ID.
internalWebPropertyId string Internal ID for the web property to which this remarketing audience belongs.
kind string Collection type.
linkedAdAccounts[] list The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. writable
linkedAdAccounts[].accountId string Account ID to which this linked foreign account belongs.
linkedAdAccounts[].eligibleForSearch boolean Boolean indicating whether this is eligible for search.
linkedAdAccounts[].id string Entity ad account link ID.
linkedAdAccounts[].internalWebPropertyId string Internal ID for the web property to which this linked foreign account belongs.
linkedAdAccounts[].kind string Resource type for linked foreign account.
linkedAdAccounts[].linkedAccountId string The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX. writable
linkedAdAccounts[].remarketingAudienceId string Remarketing audience ID to which this linked foreign account belongs.
linkedAdAccounts[].status string The status of this foreign account link.

Acceptable values are:
  • "CLOSED"
  • "OPEN"
linkedAdAccounts[].type string The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`. writable
linkedAdAccounts[].webPropertyId string Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
linkedViews[] list The views (profiles) that this remarketing audience is linked to. writable
name string The name of this remarketing audience. writable
stateBasedAudienceDefinition object A state based audience definition that will cause a user to be added or removed from an audience. writable
stateBasedAudienceDefinition.excludeConditions object Defines the conditions to exclude users from the audience. writable
stateBasedAudienceDefinition.excludeConditions.exclusionDuration string Whether to make the exclusion TEMPORARY or PERMANENT.

Acceptable values are:
  • "PERMANENT"
  • "TEMPORARY"
writable
stateBasedAudienceDefinition.excludeConditions.segment string The segment condition that will cause a user to be removed from an audience. writable
stateBasedAudienceDefinition.includeConditions nested object Defines the conditions to include users to the audience. writable
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. writable
stateBasedAudienceDefinition.includeConditions.isSmartList boolean Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 writable
stateBasedAudienceDefinition.includeConditions.kind string Resource type for include conditions.
stateBasedAudienceDefinition.includeConditions.membershipDurationDays integer Number of days (in the range 1 to 540) a user remains in the audience. writable
stateBasedAudienceDefinition.includeConditions.segment string The segment condition that will cause a user to be added to an audience. writable
updated datetime Time this remarketing audience was last modified.
webPropertyId string Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.

Methods

delete
Delete a remarketing audience.
get
Gets a remarketing audience to which the user has access.
insert
Creates a new remarketing audience.
list
Lists remarketing audiences to which the user has access.
patch
Updates an existing remarketing audience. This method supports patch semantics.
update
Updates an existing remarketing audience.