Google Analytics Admin V1alpha Client - Class SKAdNetworkConversionValueSchema (0.18.1)

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class SKAdNetworkConversionValueSchema.

SKAdNetwork conversion value schema of an iOS stream.

Generated from protobuf message google.analytics.admin.v1alpha.SKAdNetworkConversionValueSchema

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ 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

↳ postback_window_one Google\Analytics\Admin\V1alpha\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.

↳ postback_window_two Google\Analytics\Admin\V1alpha\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 postback_window_one will be used.

↳ postback_window_three Google\Analytics\Admin\V1alpha\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 postback_window_two.

↳ apply_conversion_values bool

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.

getName

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

Returns
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPostbackWindowOne

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.

Returns
TypeDescription
Google\Analytics\Admin\V1alpha\PostbackWindow|null

hasPostbackWindowOne

clearPostbackWindowOne

setPostbackWindowOne

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.

Parameter
NameDescription
var Google\Analytics\Admin\V1alpha\PostbackWindow
Returns
TypeDescription
$this

getPostbackWindowTwo

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 postback_window_one will be used.

Returns
TypeDescription
Google\Analytics\Admin\V1alpha\PostbackWindow|null

hasPostbackWindowTwo

clearPostbackWindowTwo

setPostbackWindowTwo

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 postback_window_one will be used.

Parameter
NameDescription
var Google\Analytics\Admin\V1alpha\PostbackWindow
Returns
TypeDescription
$this

getPostbackWindowThree

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

Returns
TypeDescription
Google\Analytics\Admin\V1alpha\PostbackWindow|null

hasPostbackWindowThree

clearPostbackWindowThree

setPostbackWindowThree

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

Parameter
NameDescription
var Google\Analytics\Admin\V1alpha\PostbackWindow
Returns
TypeDescription
$this

getApplyConversionValues

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.

Returns
TypeDescription
bool

setApplyConversionValues

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.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this