Reference documentation and code samples for the Google Analytics Admin V1alpha Client class ConversionValues.
Conversion value settings for a postback window for SKAdNetwork conversion value schema.
Generated from protobuf message google.analytics.admin.v1alpha.ConversionValues
Namespace
Google \ Analytics \ Admin \ V1alphaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ display_name |
string
Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units. |
↳ fine_value |
int
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. |
↳ coarse_value |
int
Required. A coarse grained conversion value. This value is not guaranteed to be unique. |
↳ event_mappings |
array<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. |
↳ lock_enabled |
bool
If true, the SDK should lock to this conversion value for the current postback window. |
getDisplayName
Display name of the SKAdNetwork conversion value.
The max allowed display name length is 50 UTF-16 code units.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Display name of the SKAdNetwork conversion value.
The max allowed display name length is 50 UTF-16 code units.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFineValue
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.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasFineValue
clearFineValue
setFineValue
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCoarseValue
Required. A coarse grained conversion value.
This value is not guaranteed to be unique.
| Returns | |
|---|---|
| Type | Description |
int |
|
setCoarseValue
Required. A coarse grained conversion value.
This value is not guaranteed to be unique.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEventMappings
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setEventMappings
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<EventMapping>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLockEnabled
If true, the SDK should lock to this conversion value for the current postback window.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setLockEnabled
If true, the SDK should lock to this conversion value for the current postback window.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|