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.conversionValueRules

Resource: ConversionValueRule

A conversion value rule

JSON representation
{
  "resourceName": string,
  "id": string,
  "action": {
    object (ValueRuleAction)
  },
  "geoLocationCondition": {
    object (ValueRuleGeoLocationCondition)
  },
  "deviceCondition": {
    object (ValueRuleDeviceCondition)
  },
  "audienceCondition": {
    object (ValueRuleAudienceCondition)
  },
  "ownerCustomer": string,
  "status": enum (ConversionValueRuleStatus)
}
Fields
resourceName

string

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

customers/{customerId}/conversionValueRules/{conversion_value_rule_id}

id

string (int64 format)

Output only. The ID of the conversion value rule.

action

object (ValueRuleAction)

Action applied when the rule is triggered.

geoLocationCondition

object (ValueRuleGeoLocationCondition)

Condition for Geo location that must be satisfied for the value rule to apply.

deviceCondition

object (ValueRuleDeviceCondition)

Condition for device type that must be satisfied for the value rule to apply.

audienceCondition

object (ValueRuleAudienceCondition)

Condition for audience that must be satisfied for the value rule to apply.

ownerCustomer

string

Output only. The resource name of the conversion value rule's owner customer. When the value rule 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 **

status

enum (ConversionValueRuleStatus)

The status of the conversion value rule.

ValueRuleAction

Action applied when rule is applied.

JSON representation
{
  "operation": enum (ValueRuleOperation),
  "value": number
}
Fields
operation

enum (ValueRuleOperation)

Specifies applied operation.

value

number

Specifies applied value.

ValueRuleOperation

Possible operations of the action of a conversion value rule.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ADD Add provided value to conversion value.
MULTIPLY Multiply conversion value by provided value.
SET Set conversion value to provided value.

ValueRuleGeoLocationCondition

Condition on Geo dimension.

JSON representation
{
  "excludedGeoTargetConstants": [
    string
  ],
  "excludedGeoMatchType": enum (ValueRuleGeoLocationMatchType),
  "geoTargetConstants": [
    string
  ],
  "geoMatchType": enum (ValueRuleGeoLocationMatchType)
}
Fields
excludedGeoTargetConstants[]

string

Geo locations that advertisers want to exclude.

excludedGeoMatchType

enum (ValueRuleGeoLocationMatchType)

Excluded Geo location match type.

geoTargetConstants[]

string

Geo locations that advertisers want to include.

geoMatchType

enum (ValueRuleGeoLocationMatchType)

Included Geo location match type.

ValueRuleGeoLocationMatchType

Possible geographic location matching types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ANY Either Area of Interest or Location of Presence can be used to match.
LOCATION_OF_PRESENCE Only Location of Presence can be used to match.

ValueRuleDeviceCondition

Condition on Device dimension.

JSON representation
{
  "deviceTypes": [
    enum (ValueRuleDeviceType)
  ]
}
Fields
deviceTypes[]

enum (ValueRuleDeviceType)

Value for device type condition.

ValueRuleDeviceType

Possible device types used in conversion value rule.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
MOBILE Mobile device.
DESKTOP Desktop device.
TABLET Tablet device.

ValueRuleAudienceCondition

Condition on Audience dimension.

JSON representation
{
  "userLists": [
    string
  ],
  "userInterests": [
    string
  ]
}
Fields
userLists[]

string

User Lists.

userInterests[]

string

User Interests.

ConversionValueRuleStatus

Possible statuses of a conversion value rule.

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

Methods

get

Returns the requested conversion value rule.

mutate

Creates, updates, or removes conversion value rules.