get_remarketing_audience: Remarketing Audiences

Description Usage Arguments Value References See Also

Description

Gets a remarketing audience to which the user has access.

Usage

1
get_remarketing_audience(accountId, webPropertyId, remarketingAudienceId, token)

Arguments

accountId

character. The account ID of the remarketing audience to retrieve.

webPropertyId

character. The web property ID of the remarketing audience to retrieve.

remarketingAudienceId

character. The ID of the remarketing audience to retrieve.

token

Token2.0 class object with a valid authorization data.

Value

kind

Collection type.

id

Remarketing Audience ID.

accountId

Account ID to which this remarketing audience belongs.

webPropertyId

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

internalWebPropertyId

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

created

Time this remarketing audience was created.

updated

Time this remarketing audience was last modified.

name

The name of this remarketing audience.

description

The description of this remarketing audience.

linkedAdAccounts

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

linkedViews

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

audienceType

The type of audience, either SIMPLE or STATE_BASED.

audienceDefinition

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

stateBasedAudienceDefinition

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

linkedAdAccounts.kind

Resource type for linked foreign account.

linkedAdAccounts.id

Entity ad account link ID.

linkedAdAccounts.accountId

Account ID to which this linked foreign account belongs.

linkedAdAccounts.webPropertyId

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

linkedAdAccounts.internalWebPropertyId

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

linkedAdAccounts.remarketingAudienceId

Remarketing audience ID to which this linked foreign account belongs.

linkedAdAccounts.linkedAccountId

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

linkedAdAccounts.type

The type of the foreign account. For example 'ADWORDS_LINKS'.

linkedAdAccounts.status

The status of this foreign account link.

linkedAdAccounts.eligibleForSearch

Boolean indicating whether this is eligible for search.

audienceDefinition.includeConditions.kind

Resource type for include conditions.

audienceDefinition.includeConditions.isSmartList

Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577

audienceDefinition.includeConditions.segment

The segment condition that will cause a user to be added to an audience.

audienceDefinition.includeConditions.membershipDurationDays

Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days.

audienceDefinition.includeConditions.daysToLookBack

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.

stateBasedAudienceDefinition.includeConditions.kind

Resource type for include conditions.

stateBasedAudienceDefinition.includeConditions.isSmartList

Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577

stateBasedAudienceDefinition.includeConditions.segment

The segment condition that will cause a user to be added to an audience.

stateBasedAudienceDefinition.includeConditions.membershipDurationDays

Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days.

stateBasedAudienceDefinition.includeConditions.daysToLookBack

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.

stateBasedAudienceDefinition.excludeConditions.segment

The segment condition that will cause a user to be removed from an audience.

stateBasedAudienceDefinition.excludeConditions.exclusionDuration

Whether to make the exclusion TEMPORARY or PERMANENT.

References

Management API - Remarketing Audiences Overview

See Also

Other Management API: get_custom_dimension, get_custom_metric, get_experiment, get_filter, get_goal, get_profile, get_unsampled_report, get_upload, get_webproperty, list_accounts, list_custom_data_sources, list_custom_dimensions, list_custom_metrics, list_experiments, list_filters, list_goals, list_profiles, list_remarketing_audiences, list_segments, list_unsampled_reports, list_uploads, list_webproperties


artemklevtsov/RGA documentation built on May 10, 2019, 1:50 p.m.