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

Requires authorization

Updates an existing remarketing audience. See an example.

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string The account ID of the remarketing audience to update.
remarketingAudienceId string The ID of the remarketing audience to update.
webPropertyId string The web property ID of the remarketing audience to update.

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 updates an existing Remarketing Audience.
 */
// Create the LinkedForeignAccount object.
LinkedForeignAccount linkedAdAccount = new LinkedForeignAccount();
linkedAdAccount.setType("ADWORDS_LINKS");
linkedAdAccount.setAccountId(linkedAccountId);

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

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

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

try {
  analytics
      .management()
      .remarketingAudience()
      .update(accountId, propertyId, remarketingAudienceId, 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 updates an existing Remarketing Audience.
 */
// Create the LinkedForeignAccount object.
Google_Service_Analytics_LinkedForeignAccount $linkedAdAccount = new Google_Service_Analytics_LinkedForeignAccount();
$linkedAdAccount->setType("ADWORDS_LINKS");
$linkedAdAccount->setAccountId(linkedAccountId);

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

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

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

try {
  $analytics->management_remarketingAudience->update($accountId, $propertyId, remarketingAudienceId, $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 updates an existing Remarketing Audience.
try:
  analytics.management().remarketingAudience().update(
      accountId=accountId,
      webPropertyId=propertyId,
      remarketingAudienceId=remarketingAudienceId,
      body={
        'name': 'Update 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 updates an existing Remarketing Audience.
 */
function updateRemarketingAudience(accountId, propertyId, viewId, audienceId) {
  let request = gapi.client.analytics.management.remarketingAudience.update(
    {
      'accountId': accountId,
      'webPropertyId': propertyId,
      'remarketingAudienceId': audienceId
      'resource': {
        'name': 'Update Simple Audience',
        'linkedViews': [viewId],
        'linkedAdAccounts': [{
            'type': 'ADWORDS_LINKS',
            'linkedAccountId': '202-867-5309'
        }],
        'audienceType': 'SIMPLE',
        'audienceDefinition': {
          'includeConditions': {
            'isSmartList': False,
            'daysToLookBack': 7,
            'membershipDurationDays': 30,
            'segment': 'users::condition::ga:browser==Chrome'
          }
        }
      }
    });
  request.execute(function (response) { /* handle the response */ });
}