# Google Analytics Create Custom Dimension (`google-analytics.create_custom_dimension`)

Creates a custom dimension in a Google Analytics 4 property from an event parameter, user property or item parameter (a change to the connected account).

Docs: https://primaryapi.com/docs/api-reference/google-analytics/create_custom_dimension

- Endpoint: `POST https://api.primaryapi.com/v1/run/google-analytics.create_custom_dimension`
- Category: Web Intelligence · Platform: `google-analytics` · Kind: lookup · Status: live
- Price: 1 credit per call. Every call costs the same, including calls that were retried automatically.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=google-analytics.create_custom_dimension`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `propertyId` | string | yes |  | pattern: ^(?:properties\/)?(\d{1,20})$ | GA4 property id, e.g. "123456789" (or "properties/123456789"), as google-analytics.properties lists it. |
| `parameterName` | string | yes |  | max 40 chars; pattern: ^[A-Za-z][A-Za-z0-9_]*$ | The event parameter (EVENT), user property (USER) or item parameter (ITEM) to report on, e.g. "plan_type". Max 40 characters, 24 for USER. |
| `displayName` | string | yes |  | max 82 chars; pattern: ^[A-Za-z][A-Za-z0-9_ ]*$ | Name shown in Google Analytics reports, e.g. "Plan type" (max 82 characters). |
| `description` | string | no |  | max 150 chars | Optional description (max 150 characters). |
| `scope` | enum | yes |  | one of: EVENT, USER, ITEM | EVENT (an event parameter), USER (a user property) or ITEM (an e-commerce item parameter). Cannot be changed later. |
| `disallowAdsPersonalization` | boolean | no |  |  | USER scope only: exclude this dimension from ads personalization. |
| `connection` | string | no |  | max 200 chars | Which connected account to use when the workspace has several for this provider: the customId you gave it (exact), its connection id ("con_…"), its handle (login, email or @handle) or its name. Optional; prefer the customId or id, which never match two accounts. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `id` | string | Custom dimension id (last part of name) |
| `name` | string | "properties/123/customDimensions/456" |
| `parameterName` | string | The event parameter (or user property / item parameter) it reads |
| `displayName` | string \| null |  |
| `description` | string \| null |  |
| `scope` | string \| null | EVENT, USER or ITEM |
| `apiName` | string \| null | Name to use in google-analytics.report: customEvent:<parameter>, customUser:<parameter> or customItem:<parameter> |
| `disallowAdsPersonalization` | boolean |  |
| `propertyId` | string |  |
| `created` | boolean | False when the property already had this dimension (nothing was changed) |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/google-analytics.create_custom_dimension" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"propertyId":"312345678","parameterName":"article_author","displayName":"Article author","description":"Author of the article viewed","scope":"EVENT"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "propertyId": "312345678",
      "id": "11229900",
      "name": "properties/312345678/customDimensions/11229900",
      "parameterName": "article_author",
      "displayName": "Article author",
      "description": "Author of the article viewed",
      "scope": "EVENT",
      "apiName": "customEvent:article_author",
      "disallowAdsPersonalization": false,
      "created": true
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: the usual price, even when a call is retried. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=google-analytics.create_custom_dimension`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

WRITE: changes the connected Google Analytics property. Needs the Manage Google Analytics capability (analytics_manage) and edit access to the property. A custom dimension cannot be deleted through the API, only archived, and properties have a limited number of them, so create only what you will report on. scope and parameterName cannot be changed later. Safe to repeat: an existing dimension with the same scope and parameterName is returned unchanged with created: false. A property the account cannot change is a miss with reason no_access and nothing changes.

