Create a product rule
Adds a product rule that sets the segment or category priority of the products its conditions match (action =), or locks their current segment (action keep with active_until).
POST /properties/{propertyId}/product-rules
Scope write · Access Changes data · Operation id product_rules.create
Try it
productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $PROPERTY_ID first.
productmetrics product-rules create \
--property-id $PROPERTY_ID \
--name 'Lock Stars during the winter sale' \
--when-cols custom_label_0 \
--when-ops == \
--when-vals Shoes \
--target-cols product_segment \
--action = \
--action-value stars \
--jsonResponse
API response (200), shortened:
{
"data": {
"rule": {
"id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"property_id": "8c1f4d2e-7a3b-4c5d-9e6f-0a1b2c3d4e5f",
"google_ads_property_feed_id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"user_id": "3e9b5c71-2f4a-4d8e-b6c0-1a2b3c4d5e6f",
"name": "Lock Stars during the winter sale",
"description": "Keeps winter jackets as Stars until the sale ends."
// … 14 more fields
}
},
"request_id": "req_01JT18WSEVKMB9PRCED5VA6FWR"
}CLI output: productmetrics product-rules create --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.
Before you call
The rule applies after the existing ones. Check the conditions with product_rules.preview first. The change reaches the feed at the nightly run, or now with feed.generate. Needs an editor or admin.
Path parameters
| Name | Type | Description |
|---|---|---|
propertyId | string (uuid) | A property_id from properties.list. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
feed_scope | string | No | Which feed of the property: a feed id, or all for the property-wide settings. Omitted: the property’s default scope. |
Body
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The rule’s name, shown in the product rules list. |
description | string or null | No | An optional note on what the rule is for. |
enabled | boolean | No | Whether the rule applies; a disabled rule is kept but does nothing. Default true. |
when_cols | array of string | Yes | The product column each condition reads (for example custom_label_0 or brand), one per condition. At least 1 item. |
when_ops | array of enum | Yes | The operator of each condition, in the order of when_cols. Each one of ==, !=, <, <=, >, >=, contains, not_contains, in, not_in, regex, is_empty, is_not_empty. |
when_vals | array of string | Yes | The value each condition compares with, in the order of when_cols. |
when_logic | array of enum or null | No | How each condition joins the next (AND or OR), in the order of when_cols. Each one of AND, OR. |
when_tree | object | No | The conditions as a tree: match all or any of items, which can hold nested groups. |
when_tree.match | enum | Yes | all: every item must match; any: one is enough. One of all, any. |
when_tree.items | array of object | Yes | The conditions and nested groups at this level. At least 1 item. |
when_tree.items[].column | string | No | The product column the condition reads. |
when_tree.items[].operator | enum | No | How the column is compared with value. One of ==, !=, <, <=, >, >=, contains, not_contains, in, not_in, regex, is_empty, is_not_empty. |
when_tree.items[].value | string | No | The value the column is compared with. |
when_tree.items[].match | enum | No | In a nested group: all or any of its items. One of all, any. |
when_tree.items[].items | array of object | No | In a nested group: its conditions. At least 1 item. |
target_cols | array of enum | Yes | The feed columns the rule writes: the product segment label, the category priority label, or both. Each one of product_segment, category_priority. At least 1 item. |
action | enum | Yes | = writes action_value; keep locks the products’ current segment until active_until. One of =, keep. |
action_value | string | Yes | The value written to target_cols with action =, for example the segment stars. |
active_until | string (date-time) or null | No | With action keep: when the lock ends (ISO 8601). |
Errors
A failure answers with its HTTP status and { error: { code, message, details? }, request_id }. Branch on code (stable, lower_snake); show message to the person. The CLI prints the same error with "ok": false.
{
"error": {
"code": "insufficient_scope",
"message": "This operation needs the write scope; connect again and allow it.",
"details": {
"required_scope": "write"
}
},
"request_id": "req_01JP6RW1HAJHBK9XAK101N4K0X"
}| Status | Code | When |
|---|---|---|
| 400 | invalid_request | A path, query or body value does not match this page. details.issues lists each location, path and message. |
| 401 | invalid_token | The token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why. |
| 403 | insufficient_scope | The token lacks the write scope (details.required_scope): sign in again and allow it. |
| 404 | not_found | An id in the path does not exist, or the signed-in person cannot open it. |
| 429 | rate_limited | More than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry. |