Updates an existing custom dimension.

Scopes

You will need authorization for the https://www.googleapis.com/auth/analytics.edit scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/analytics.edit. You can set the scope for this method like this: analytics3 --scope <scope> management custom-dimensions-update ...

Required Scalar Arguments

  • <account-id> (string)
    • Account ID for the custom dimension to update.
  • <web-property-id> (string)
    • Web property ID for the custom dimension to update.
  • <custom-dimension-id> (string)
    • Custom dimension ID for the custom dimension to update.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

CustomDimension:
  account-id: string
  active: boolean
  created: string
  id: string
  index: integer
  kind: string
  name: string
  parent-link:
    href: string
    type: string
  scope: string
  self-link: string
  updated: string
  web-property-id: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . account-id=consetetur
    • Account ID.
  • active=true
    • Boolean indicating whether the custom dimension is active.
  • created=et
    • Time the custom dimension was created.
  • id=accusam
    • Custom dimension ID.
  • index=23
    • Index of the custom dimension.
  • kind=dolore
    • Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
  • name=dolore
    • Name of the custom dimension.
  • parent-link href=dolore
    • Link to the property to which the custom dimension belongs.

  • type=voluptua.

    • Type of the parent link. Set to "analytics#webproperty".

  • .. scope=amet.

    • Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
  • self-link=ea
    • Link for the custom dimension
  • updated=sadipscing
    • Time the custom dimension was last modified.
  • web-property-id=lorem
    • Property ID.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p ignore-custom-data-source-links=boolean
    • Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p alt=string

    • Data format for the response.

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • -p user-ip=string

    • Deprecated. Please use quotaUser instead.