1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analyticsadmin_v1alpha.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1alpha.properties.html">properties</a> . <a href="analyticsadmin_v1alpha.properties.dataStreams.html">dataStreams</a> . <a href="analyticsadmin_v1alpha.properties.dataStreams.sKAdNetworkConversionValueSchema.html">sKAdNetworkConversionValueSchema</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a SKAdNetworkConversionValueSchema.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes target SKAdNetworkConversionValueSchema.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Looks up a single SKAdNetworkConversionValueSchema.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists SKAdNetworkConversionValueSchema on a stream. Properties can have at most one SKAdNetworkConversionValueSchema.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a SKAdNetworkConversionValueSchema.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a SKAdNetworkConversionValueSchema.
Args:
parent: string, Required. The parent resource where this schema will be created. Format: properties/{property}/dataStreams/{dataStream} (required)
body: object, The request body.
The object takes the form of:
{ # SKAdNetwork conversion value schema of an iOS stream.
"applyConversionValues": True or False, # 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.
"name": "A 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": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
"postbackWindowThree": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
"postbackWindowTwo": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # SKAdNetwork conversion value schema of an iOS stream.
"applyConversionValues": True or False, # 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.
"name": "A 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": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
"postbackWindowThree": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
"postbackWindowTwo": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes target SKAdNetworkConversionValueSchema.
Args:
name: string, Required. The name of the SKAdNetworkConversionValueSchema to delete. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Looks up a single SKAdNetworkConversionValueSchema.
Args:
name: string, Required. The resource name of SKAdNetwork conversion value schema to look up. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # SKAdNetwork conversion value schema of an iOS stream.
"applyConversionValues": True or False, # 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.
"name": "A 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": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
"postbackWindowThree": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
"postbackWindowTwo": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists SKAdNetworkConversionValueSchema on a stream. Properties can have at most one SKAdNetworkConversionValueSchema.
Args:
parent: string, Required. The DataStream resource to list schemas for. Format: properties/{property_id}/dataStreams/{dataStream} Example: properties/1234/dataStreams/5678 (required)
pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
pageToken: string, A page token, received from a previous `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSKAdNetworkConversionValueSchema` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ListSKAdNetworkConversionValueSchemas RPC
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. Currently, Google Analytics supports only one SKAdNetworkConversionValueSchema per dataStream, so this will never be populated.
"skadnetworkConversionValueSchemas": [ # List of SKAdNetworkConversionValueSchemas. This will have at most one value.
{ # SKAdNetwork conversion value schema of an iOS stream.
"applyConversionValues": True or False, # 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.
"name": "A 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": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
"postbackWindowThree": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
"postbackWindowTwo": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a SKAdNetworkConversionValueSchema.
Args:
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 (required)
body: object, The request body.
The object takes the form of:
{ # SKAdNetwork conversion value schema of an iOS stream.
"applyConversionValues": True or False, # 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.
"name": "A 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": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
"postbackWindowThree": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
"postbackWindowTwo": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
}
updateMask: string, Required. The list of fields to be updated. Omitted fields will not be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # SKAdNetwork conversion value schema of an iOS stream.
"applyConversionValues": True or False, # 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.
"name": "A 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": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
"postbackWindowThree": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
"postbackWindowTwo": { # Settings for a SKAdNetwork conversion postback window. # 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.
"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.
{ # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
"coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
"displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
"eventMappings": [ # 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.
{ # Event setting conditions to match an event.
"eventName": "A String", # Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
"maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
"maxEventValue": 3.14, # 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.
"minEventCount": "A String", # 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.
"minEventValue": 3.14, # 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.
},
],
"fineValue": 42, # 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.
"lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
},
],
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values 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 postback_window_one.
},
}</pre>
</div>
</body></html>
|
