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: insert

Requires authorization

Creates a new remarketing audience. See an example.

Request

HTTP request

POST https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences

Parameters

Parameter name Value Description
Path parameters
accountId string The account ID for which to create the remarketing audience.
webPropertyId string Web property ID for which to create the remarketing audience.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/analytics.edit

Request body

In the request body, supply a Remarketing Audiences resource.

Response

If successful, this method returns a Remarketing Audiences resource in the response body.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

Java

Uses the Java client library.

/*
 * This request creates a new STATE_BASED Remarketing Audience.
 */
LinkedForeignAccount linkedAdAccount = new LinkedForeignAccount();
linkedAdAccount.setType("ADWORDS_LINKS");
linkedAdAccount.setLinkedAccountId(linkedAccountId);

// Create the IncludeConditions object.
IncludeConditions includeConditions = new IncludeConditions();
includeConditions.setIsSmartList(false);
includeConditions.setMembershipDurationDays(30);
includeConditions.setSegment("users::condition::ga:browser==Chrome");
includeConditions.setDaysToLookBack(30);

// Create the ExcludeConditions object.
ExcludeConditions excludeConditions = new ExcludeConditions();
excludeConditions.setExclusionDuration("PERMANENT");
excludeConditions.setSegment("sessions::condition::ga:city==London");

// Create the AudienceDefinition object.
StateBasedAudienceDefinition stateBasedAudienceDefinition = new StateBasedAudienceDefinition();
stateBasedAudienceDefinition.setIncludeConditions(includeConditions);
stateBasedAudienceDefinition.setExcludeConditions(excludeConditions);

//Create the RemarketingAudience object.
RemarketingAudience audience = new RemarketingAudience();
audience.setName("State Based Audience");
audience.setLinkedViews(Arrays.asList(viewId));
audience.setLinkedAdAccounts(Arrays.asList(linkedAdAccount));
audience.setAudienceType("STATE_BASED");
audience.setStateBasedAudienceDefinition(stateBasedAudienceDefinition);

try {
  analytics
      .management()
      .remarketingAudience()
      .insert(accountId, propertyId, audience)
      .execute();
} catch (GoogleJsonResponseException e) {
  System.err.println(
      "There was a service error: "
          + e.getDetails().getCode()
          + " : "
          + e.getDetails().getMessage());
}


/*
 * This request creates a new SIMPLE Remarketing Audience.
 */

// Create the LinkedForeignAccount object.
LinkedForeignAccount linkedAdAccount = new LinkedForeignAccount();
linkedAdAccount.setType("ADWORDS_LINKS");
linkedAdAccount.setLinkedAccountId(linkedAccountId);

// Create the IncludeConditions object.
IncludeConditions includeConditions = new IncludeConditions();
includeConditions.setIsSmartList(false);
includeConditions.setMembershipDurationDays(30);
includeConditions.setSegment("users::condition::ga:browser==Chrome");
includeConditions.setDaysToLookBack(7);

// Create the AudienceDefinition object.
AudienceDefinition simpleAudienceDefinition = new AudienceDefinition();
simpleAudienceDefinition.setIncludeConditions(includeConditions);

//Create the RemarketingAudience object.
RemarketingAudience audience = new RemarketingAudience();
audience.setName("Simple Audience");
audience.setLinkedViews(Arrays.asList(viewId));
audience.setLinkedAdAccounts(Arrays.asList(linkedAdAccount));
audience.setAudienceType("SIMPLE");
audience.setAudienceDefinition(simpleAudienceDefinition);

try {
  analytics
      .management()
      .remarketingAudience()
      .insert(accountId, propertyId, audience)
      .execute();
} catch (GoogleJsonResponseException e) {
  System.err.println(
      "There was a service error: "
          + e.getDetails().getCode()
          + " : "
          + e.getDetails().getMessage());
}

PHP

Uses the PHP client library.

/*
 * This request creates a new STATE_BASED Remarketing Audience.
 */
Google_Service_Analytics_LinkedForeignAccount $linkedAdAccount = new Google_Service_Analytics_LinkedForeignAccount();
$linkedAdAccount->setType("ADWORDS_LINKS");
$linkedAdAccount->setLinkedAccountId(linkedAccountId);

// Create the IncludeConditions object.
Google_Service_Analytics_IncludeConditions $includeConditions = new Google_Service_Analytics_IncludeConditions();
$includeConditions->setIsSmartList(false);
$includeConditions->setMembershipDurationDays(30);
$includeConditions->setSegment("users::condition::ga:browser==Chrome");
$includeConditions->setDaysToLookBack(30);

// Create the ExcludeConditions object.
Google_Service_Analytics_RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions $excludeConditions = new Google_Service_Analytics_RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions();
$excludeConditions->setExclusionDuration("PERMANENT");
$excludeConditions->setSegment("sessions::condition::ga:city==London");

// Create the AudienceDefinition object.
Google_Service_Analytics_RemarketingAudienceStateBasedAudienceDefinition $stateBasedAudienceDefinition = new Google_Service_Analytics_RemarketingAudienceStateBasedAudienceDefinition();
$stateBasedAudienceDefinition->setIncludeConditions($includeConditions);
$stateBasedAudienceDefinition->setExcludeConditions($excludeConditions);

//Create the RemarketingAudience object.
Google_Service_Analytics_RemarketingAudience $audience = new Google_Service_Analytics_RemarketingAudience();
$audience->setName("State Based Audience");
$audience->setLinkedViews(Arrays.asList(viewId));
$audience->setLinkedAdAccounts(Arrays.asList($linkedAdAccount));
$audience->setAudienceType("STATE_BASED");
$audience->setStateBasedAudienceDefinition($stateBasedAudienceDefinition);

try {
  $analytics->management_remarketingAudience->insert($accountId, $propertyId, $audience);
} catch (apiServiceException $e) {
  print 'There was an Analytics API service error '
      . $e->getCode() . ':' . $e->getMessage();

} catch (apiException $e) {
  print 'There was a general API error '
      . $e->getCode() . ':' . $e->getMessage();
}


/*
 * This request creates a new SIMPLE Remarketing Audience.
 */

// Create the LinkedForeignAccount object.
Google_Service_Analytics_LinkedForeignAccount $linkedAdAccount = new Google_Service_Analytics_LinkedForeignAccount();
$linkedAdAccount->setType("ADWORDS_LINKS");
$linkedAdAccount->setLinkedAccountId(linkedAccountId);

// Create the IncludeConditions object.
Google_Service_Analytics_IncludeConditions $includeConditions = new Google_Service_Analytics_IncludeConditions();
$includeConditions->setIsSmartList(false);
$includeConditions->setMembershipDurationDays(30);
$includeConditions->setSegment("users::condition::ga:browser==Chrome");
$includeConditions->setDaysToLookBack(7);

// Create the AudienceDefinition object.
Google_Service_Analytics_RemarketingAudienceAudienceDefinition $simpleAudienceDefinition = new Google_Service_Analytics_RemarketingAudienceAudienceDefinition();
$simpleAudienceDefinition->setIncludeConditions($includeConditions);

//Create the RemarketingAudience object.
Google_Service_Analytics_RemarketingAudience $audience = new Google_Service_Analytics_RemarketingAudience();
$audience->setName("Simple Audience");
$audience->setLinkedViews(Arrays.asList(viewId));
$audience->setLinkedAdAccounts(Arrays.asList($linkedAdAccount));
$audience->setAudienceType("SIMPLE");
$audience->setAudienceDefinition($simpleAudienceDefinition);

try {
  $analytics->management_remarketingAudience->insert($accountId, $propertyId, $audience);
} catch (apiServiceException $e) {
  print 'There was an Analytics API service error '
      . $e->getCode() . ':' . $e->getMessage();

} catch (apiException $e) {
  print 'There was a general API error '
      . $e->getCode() . ':' . $e->getMessage();
}

Python

Uses the Python client library.

# Note: This code assumes you have an authorized Analytics service object.
# See the Remarketing Audiences Developer Guide for details.

# This request creates a new STATE_BASED Remarketing Audience.
try:
  response = analytics.management().remarketingAudience().insert(
      accountId=accountId,
      webPropertyId=propertyId,
      body={
        'name': 'State Based Audience',
        'linkedViews': [viewId],
        'linkedAdAccounts': [{
            'type': 'ADWORDS_LINKS',
            'linkedAccountId': linkedAccountId
        }],
        'audienceType': 'STATE_BASED',
        'stateBasedAudienceDefinition': {
          'includeConditions': {
            'daysToLookBack': 30,
            'segment': 'users::condition::ga:browser==Chrome',
            'membershipDurationDays': 30,
            'isSmartList': False
          },
          'excludeConditions': {
            'exclusionDuration': 'PERMANENT',
            'segment': 'sessions::condition::ga:city==London'
          }
        }
      }
    ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

# This request creates a new SIMPLE Remarketing Audience.
try:
  response = analytics.management().remarketingAudience().insert(
      accountId=accountId,
      webPropertyId=propertyId,
      body={
        'name': 'Simple Audience',
        'linkedViews': [viewId],
        'linkedAdAccounts': [{
            'type': 'ADWORDS_LINKS',
            'linkedAccountId': linkedAccountId
        }],
        'audienceType': 'SIMPLE',
        'audienceDefinition': {
          'includeConditions': {
            'isSmartList': False,
            'daysToLookBack': 7,
            'membershipDurationDays': 30,
            'segment': 'users::condition::ga:browser==Chrome'
          }
        }
      }
    ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

JavaScript

Uses the JavaScript client library.

/**
 * Note: This code assumes you have an authorized Analytics client object.
 * See the Unsampled Reports Developer Guide for details.
 */

/**
 * This request creates a new STATE_BASED Remarketing Audience.
 */
function insertRemarketingAudience(accountId, propertyId) {
  let request = gapi.client.analytics.management.remarketingAudience.insert(
    {
      'accountId': accountId,
      'webPropertyId': propertyId,
      'resource': {
        'name': 'State Based Audience',
        'linkedViews': [viewId],
        'linkedAdAccounts': [{
            'type': 'ADWORDS_LINKS',
            'linkedAccountId': linkedAccountId
        }],
        'audienceType': 'STATE_BASED',
        'stateBasedAudienceDefinition': {
          'includeConditions': {
            'daysToLookBack': 30,
            'segment': 'users::condition::ga:browser==Chrome',
            'membershipDurationDays': 30,
            'isSmartList': False
          },
          'excludeConditions': {
            'exclusionDuration': 'PERMANENT',
            'segment': 'sessions::condition::ga:city==London'
          }
        }
      }
    });
  request.execute(function (response) { /* Handle the response. */ });
}


// This request creates a new SIMPLE Remarketing Audience.
function insertSIMPLEAudience(accountId, propertyId) {
  let request = gapi.client.analytics.management.remarketingAudience.insert(
    {
      'accountId': accountId,
      'webPropertyId': propertyId,
      'resource': {
        'name': 'Simple Audience',
        'linkedViews': [viewId],
        'linkedAdAccounts': [{
            'type': 'ADWORDS_LINKS',
            'linkedAccountId': linkedAccountId
        }],
        'audienceType': 'SIMPLE',
        'audienceDefinition': {
          'includeConditions': {
            'isSmartList': False,
            'daysToLookBack': 7,
            'membershipDurationDays': 30,
            'segment': 'users::condition::ga:browser==Chrome'
          }
        }
      }
    });
  request.execute(function (response) { // Handle the response. });
}