REST Resource: properties.dataStreams.sKAdNetworkConversionValueSchema

Resource: SKAdNetworkConversionValueSchema

SKAdNetwork conversion value schema of an iOS stream.

JSON representation 
{
  "name": string,
  "postbackWindowOne": {
    object (PostbackWindow)
  },
  "postbackWindowTwo": {
    object (PostbackWindow)
  },
  "postbackWindowThree": {
    object (PostbackWindow)
  },
  "applyConversionValues": boolean
}
Fields
name

string

Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema
postbackWindowOne

object (PostbackWindow)

Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value).

Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled.
postbackWindowTwo

object (PostbackWindow)

The conversion value settings for the second postback window.

This field should only be configured if there is a need to define different conversion values for this postback window.

If enable_postback_window_settings is set to false for this postback window, the values from postbackWindowOne will be used.
postbackWindowThree

object (PostbackWindow)

The conversion value settings for the third postback window.

This field should only be set if the user chose to define different conversion values for this postback window. It is allowed to configure window 3 without setting window 2. In case window 1 & 2 settings are set and enable_postback_window_settings for this postback window is set to false, the schema will inherit settings from postbackWindowTwo.
applyConversionValues

boolean

If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads.

PostbackWindow

Settings for a SKAdNetwork conversion postback window.

JSON representation 
{
  "conversionValues": [
    {
      object (ConversionValues)
    }
  ],
  "postbackWindowSettingsEnabled": boolean
}
Fields
conversionValues[]

object (ConversionValues)

Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
postbackWindowSettingsEnabled

boolean

If enable_postback_window_settings is true, conversionValues must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postbackWindowOne.

ConversionValues

Conversion value settings for a postback window for SKAdNetwork conversion value schema.

JSON representation 
{
  "displayName": string,
  "coarseValue": enum (CoarseValue),
  "eventMappings": [
    {
      object (EventMapping)
    }
  ],
  "lockEnabled": boolean,
  "fineValue": integer
}
Fields
displayName

string

Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
coarseValue

enum (CoarseValue)

Required. A coarse grained conversion value.

This value is not guaranteed to be unique.
eventMappings[]

object (EventMapping)

Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
lockEnabled

boolean

If true, the SDK should lock to this conversion value for the current postback window.
fineValue

integer

The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique.

If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.

CoarseValue

The coarse conversion value set on the updatePostbackConversionValue SDK call when a ConversionValues.event_mappings conditions are satisfied. For more information, see SKAdNetwork.CoarseConversionValue.

Enums
COARSE_VALUE_UNSPECIFIED Coarse value not specified.
COARSE_VALUE_LOW Coarse value of low.
COARSE_VALUE_MEDIUM Coarse value of medium.
COARSE_VALUE_HIGH Coarse value of high.

EventMapping

Event setting conditions to match an event.

JSON representation 
{
  "eventName": string,
  "minEventCount": string,
  "maxEventCount": string,
  "minEventValue": number,
  "maxEventValue": number
}
Fields
eventName

string

Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
minEventCount

string (int64 format)

At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
maxEventCount

string (int64 format)

The maximum number of times the event occurred. If not set, maximum event count won't be checked.
minEventValue

number

The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
maxEventValue

number

The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.

Methods

create

 Creates a SKAdNetworkConversionValueSchema.

delete

 Deletes target SKAdNetworkConversionValueSchema.

get

 Looks up a single SKAdNetworkConversionValueSchema.

list

 Lists SKAdNetworkConversionValueSchema on a stream.

patch

 Updates a SKAdNetworkConversionValueSchema.