Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.conversionValueRuleSets

Resource: ConversionValueRuleSet

A conversion value rule set

JSON representation
{
  "resourceName": string,
  "id": string,
  "conversionValueRules": [
    string
  ],
  "dimensions": [
    enum (ValueRuleSetDimension)
  ],
  "ownerCustomer": string,
  "attachmentType": enum (ValueRuleSetAttachmentType),
  "campaign": string,
  "status": enum (ConversionValueRuleSetStatus)
}
Fields
resourceName

string

Immutable. The resource name of the conversion value rule set. Conversion value rule set resource names have the form:

customers/{customerId}/conversionValueRuleSets/{conversion_value_rule_set_id}

id

string (int64 format)

Output only. The ID of the conversion value rule set.

conversionValueRules[]

string

Resource names of rules within the rule set.

dimensions[]

enum (ValueRuleSetDimension)

Defines dimensions for Value Rule conditions. The condition types of value rules within this value rule set must be of these dimensions. The first entry in this list is the primary dimension of the included value rules. When using value rule primary dimension segmentation, conversion values will be segmented into the values adjusted by value rules and the original values, if some value rules apply.

ownerCustomer

string

Output only. The resource name of the conversion value rule set's owner customer. When the value rule set is inherited from a manager customer, ownerCustomer will be the resource name of the manager whereas the customer in the resourceName will be of the requesting serving customer. ** Read-only **

attachmentType

enum (ValueRuleSetAttachmentType)

Defines the scope where the conversion value rule set is attached.

campaign

string

The resource name of the campaign when the conversion value rule set is attached to a campaign.

status

enum (ConversionValueRuleSetStatus)

Output only. The status of the conversion value rule set. ** Read-only **

ValueRuleSetDimension

Possible dimensions of a conversion value rule set.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
GEO_LOCATION Dimension for geo location.
DEVICE Dimension for device type.
AUDIENCE Dimension for audience.

ValueRuleSetAttachmentType

Possible level where a value rule set is attached.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
CUSTOMER Attached to the customer.
CAMPAIGN Attached to a campaign.

ConversionValueRuleSetStatus

Possible statuses of a conversion value rule set.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Conversion Value Rule Set is enabled and can be applied.
REMOVED Conversion Value Rule Set is permanently deleted and can't be applied.
PAUSED Conversion Value Rule Set is paused and won't be applied. It can be enabled again.

Methods

get

Returns the requested conversion value rule set.

mutate

Creates, updates or removes conversion value rule sets.