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.

Custom Dimensions: insert

Requires authorization

Create a new custom dimension. Try it now or see an example.

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string Account ID for the custom dimension to create.
webPropertyId string Web property ID for the custom dimension to create.

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 management.customDimension resource.

Response

If successful, this method returns a management.customDimension 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.

/*
 * Note: This code assumes you have an authorized Analytics service object.
 */

/*
 * This request creates a new custom dimension.
 */

// Construct the body of the request and set its properties.
CustomDimension body = new CustomDimension();
body.setName("Campaign Group");
body.setScope("SESSION");
body.setActive(true);

try {
  analytics.management().customDimensions()
      .insert("123456", "UA-123456-1", body).execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

Python

Uses the Python client library.

# Note: This code assumes you have an authorized Analytics service object.

# This request creates a new custom dimension.
try:
  analytics.management().customDimensions().insert(
      accountId='123456',
      webPropertyId='UA-123456-1',
      body={
          'name': 'Campaign Group',
          'scope': 'SESSION',
          'active': True
      }
  ).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))

Try it!

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.