FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
google-cloud-php/AdsDataManager/src/V1/Event.php at main · googleapis/google-cloud-php · GitHub
Uh oh!
There was an error while loading.
Please reload this page
.
googleapis
/
google-cloud-php
Public
Notifications
You must be signed in to change notification settings
Fork
464
Star
1.2k
Code
Issues
45
Pull requests
35
Discussions
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Discussions
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
google-cloud-php
/
AdsDataManager
/
src
/
V1
/
Event.php
Copy path
More file actions
More file actions
Latest commit
History
History
History
1027 lines (928 loc) · 36 KB
Breadcrumbs
google-cloud-php
/
AdsDataManager
/
src
/
V1
/
Event.php
Copy path
File metadata and controls
1027 lines (928 loc) · 36 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
# Generated by the protocol buffer compiler. DO NOT EDIT!
# source: google/ads/datamanager/v1/event.proto
namespace
Google
\
Ads
\
DataManager
\
V1
;
use
Google
\
Protobuf
\
Internal
\
GPBType
;
use
Google
\
Protobuf
\
Internal
\
GPBUtil
;
use
Google
\
Protobuf
\
RepeatedField
;
/**
* An event representing a user interaction with an advertiser's website or app.
*
* Generated from protobuf message <code>google.ads.datamanager.v1.Event</code>
*/
class
Event
extends
\
Google
\
Protobuf
\
Internal
\Message
{
/**
* Optional. Reference string used to determine the destination. If empty, the
* event will be sent to all
* [destinations][google.ads.datamanager.v1.IngestEventsRequest.destinations]
* in the request.
*
* Generated from protobuf field <code>repeated string destination_references = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
private
$
destination_references
;
/**
* Optional. The unique identifier for this event. Required for events sent as
* an additional data source for tag conversions.
*
* Generated from protobuf field <code>string transaction_id = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
transaction_id
=
''
;
/**
* Required. The time the event occurred.
*
* Generated from protobuf field <code>.google.protobuf.Timestamp event_timestamp = 3 [(.google.api.field_behavior) = REQUIRED];</code>
*/
protected
$
event_timestamp
=
null
;
/**
* Optional. The last time the event was updated.
*
* Generated from protobuf field <code>.google.protobuf.Timestamp last_updated_timestamp = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
last_updated_timestamp
=
null
;
/**
* Optional. Pieces of user provided data, representing the user the event is
* associated with.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.UserData user_data = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
user_data
=
null
;
/**
* Optional. Information about whether the associated user has provided
* different types of consent.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.Consent consent = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
consent
=
null
;
/**
* Optional. Identifiers and other information used to match the conversion
* event with other online activity (such as ad clicks).
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.AdIdentifiers ad_identifiers = 7 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
ad_identifiers
=
null
;
/**
* Optional. The currency code associated with all monetary values within this
* event.
*
* Generated from protobuf field <code>string currency = 8 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
currency
=
''
;
/**
* Optional. The conversion value associated with the event, for value-based
* conversions.
*
* Generated from protobuf field <code>optional double conversion_value = 9 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
conversion_value
=
null
;
/**
* Optional. The conversion quantity associated with the event, for
* counting-based conversions.
*
* Generated from protobuf field <code>optional double conversion_count = 23 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
conversion_count
=
null
;
/**
* Optional. Signal for where the event happened (web, app, in-store, etc.).
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.EventSource event_source = 10 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
event_source
=
0
;
/**
* Optional. Information gathered about the device being used (if any) when
* the event happened.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.DeviceInfo event_device_info = 11 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
event_device_info
=
null
;
/**
* Optional. Information about the transaction and items associated with the
* event.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.CartData cart_data = 12 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
cart_data
=
null
;
/**
* Optional. Additional key/value pair information to send to the conversion
* containers (conversion action or FL activity).
*
* Generated from protobuf field <code>repeated .google.ads.datamanager.v1.CustomVariable custom_variables = 13 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
private
$
custom_variables
;
/**
* Optional. A list of key/value pairs for experimental fields that may
* eventually be promoted to be part of the API.
*
* Generated from protobuf field <code>repeated .google.ads.datamanager.v1.ExperimentalField experimental_fields = 14 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
private
$
experimental_fields
;
/**
* Optional. Advertiser-assessed information about the user at the time that
* the event happened.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.UserProperties user_properties = 15 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
user_properties
=
null
;
/**
* Optional. The name of the event. Required for GA4 events.
*
* Generated from protobuf field <code>string event_name = 16 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
event_name
=
''
;
/**
* Optional. A unique identifier for the user instance of a web client for
* this GA4 web stream.
*
* Generated from protobuf field <code>string client_id = 17 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
client_id
=
''
;
/**
* Optional. A unique identifier for a user, as defined by the advertiser.
*
* Generated from protobuf field <code>string user_id = 18 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
user_id
=
''
;
/**
* Optional. A bucket of any [event
* parameters](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events)
* to be included within the event that were not already specified using other
* structured fields.
*
* Generated from protobuf field <code>repeated .google.ads.datamanager.v1.EventParameter additional_event_parameters = 19 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
private
$
additional_event_parameters
;
/**
* Optional. The same type of data provided in user_data, but explicitly
* flagged as being provided as owned by a third-party and not first-party
* advertiser data.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.UserData third_party_user_data = 20 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
third_party_user_data
=
null
;
/**
* Optional. Information gathered about the location of the user when this
* event occurred.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.EventLocation event_location = 21 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
event_location
=
null
;
/**
* Optional. A unique identifier for the user instance of an app client for
* this GA4 app stream.
*
* Generated from protobuf field <code>string app_instance_id = 22 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected
$
app_instance_id
=
''
;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string[] $destination_references
* Optional. Reference string used to determine the destination. If empty, the
* event will be sent to all
* [destinations][google.ads.datamanager.v1.IngestEventsRequest.destinations]
* in the request.
* @type string $transaction_id
* Optional. The unique identifier for this event. Required for events sent as
* an additional data source for tag conversions.
* @type \Google\Protobuf\Timestamp $event_timestamp
* Required. The time the event occurred.
* @type \Google\Protobuf\Timestamp $last_updated_timestamp
* Optional. The last time the event was updated.
* @type \Google\Ads\DataManager\V1\UserData $user_data
* Optional. Pieces of user provided data, representing the user the event is
* associated with.
* @type \Google\Ads\DataManager\V1\Consent $consent
* Optional. Information about whether the associated user has provided
* different types of consent.
* @type \Google\Ads\DataManager\V1\AdIdentifiers $ad_identifiers
* Optional. Identifiers and other information used to match the conversion
* event with other online activity (such as ad clicks).
* @type string $currency
* Optional. The currency code associated with all monetary values within this
* event.
* @type float $conversion_value
* Optional. The conversion value associated with the event, for value-based
* conversions.
* @type float $conversion_count
* Optional. The conversion quantity associated with the event, for
* counting-based conversions.
* @type int $event_source
* Optional. Signal for where the event happened (web, app, in-store, etc.).
* @type \Google\Ads\DataManager\V1\DeviceInfo $event_device_info
* Optional. Information gathered about the device being used (if any) when
* the event happened.
* @type \Google\Ads\DataManager\V1\CartData $cart_data
* Optional. Information about the transaction and items associated with the
* event.
* @type \Google\Ads\DataManager\V1\CustomVariable[] $custom_variables
* Optional. Additional key/value pair information to send to the conversion
* containers (conversion action or FL activity).
* @type \Google\Ads\DataManager\V1\ExperimentalField[] $experimental_fields
* Optional. A list of key/value pairs for experimental fields that may
* eventually be promoted to be part of the API.
* @type \Google\Ads\DataManager\V1\UserProperties $user_properties
* Optional. Advertiser-assessed information about the user at the time that
* the event happened.
* @type string $event_name
* Optional. The name of the event. Required for GA4 events.
* @type string $client_id
* Optional. A unique identifier for the user instance of a web client for
* this GA4 web stream.
* @type string $user_id
* Optional. A unique identifier for a user, as defined by the advertiser.
* @type \Google\Ads\DataManager\V1\EventParameter[] $additional_event_parameters
* Optional. A bucket of any [event
* parameters](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events)
* to be included within the event that were not already specified using other
* structured fields.
* @type \Google\Ads\DataManager\V1\UserData $third_party_user_data
* Optional. The same type of data provided in user_data, but explicitly
* flagged as being provided as owned by a third-party and not first-party
* advertiser data.
* @type \Google\Ads\DataManager\V1\EventLocation $event_location
* Optional. Information gathered about the location of the user when this
* event occurred.
* @type string $app_instance_id
* Optional. A unique identifier for the user instance of an app client for
* this GA4 app stream.
* }
*/
public
function
__construct
(
$
data
=
NULL
) {
\
GPBMetadata
\
Google
\
Ads
\
Datamanager
\
V1
\Event::
initOnce
();
parent
::
__construct
(
$
data
);
}
/**
* Optional. Reference string used to determine the destination. If empty, the
* event will be sent to all
* [destinations][google.ads.datamanager.v1.IngestEventsRequest.destinations]
* in the request.
*
* Generated from protobuf field <code>repeated string destination_references = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return RepeatedField<string>
*/
public
function
getDestinationReferences
()
{
return
$
this
->
destination_references
;
}
/**
* Optional. Reference string used to determine the destination. If empty, the
* event will be sent to all
* [destinations][google.ads.datamanager.v1.IngestEventsRequest.destinations]
* in the request.
*
* Generated from protobuf field <code>repeated string destination_references = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param string[] $var
* @return $this
*/
public
function
setDestinationReferences
(
$
var
)
{
$
arr
= GPBUtil::
checkRepeatedField
(
$
var
, \
Google
\
Protobuf
\
Internal
\GPBType::
STRING
);
$
this
->
destination_references
=
$
arr
;
return
$
this
;
}
/**
* Optional. The unique identifier for this event. Required for events sent as
* an additional data source for tag conversions.
*
* Generated from protobuf field <code>string transaction_id = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return string
*/
public
function
getTransactionId
()
{
return
$
this
->
transaction_id
;
}
/**
* Optional. The unique identifier for this event. Required for events sent as
* an additional data source for tag conversions.
*
* Generated from protobuf field <code>string transaction_id = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param string $var
* @return $this
*/
public
function
setTransactionId
(
$
var
)
{
GPBUtil::
checkString
(
$
var
,
True
);
$
this
->
transaction_id
=
$
var
;
return
$
this
;
}
/**
* Required. The time the event occurred.
*
* Generated from protobuf field <code>.google.protobuf.Timestamp event_timestamp = 3 [(.google.api.field_behavior) = REQUIRED];</code>
* @return \Google\Protobuf\Timestamp|null
*/
public
function
getEventTimestamp
()
{
return
$
this
->
event_timestamp
;
}
public
function
hasEventTimestamp
()
{
return
isset
(
$
this
->
event_timestamp
);
}
public
function
clearEventTimestamp
()
{
unset(
$
this
->
event_timestamp
);
}
/**
* Required. The time the event occurred.
*
* Generated from protobuf field <code>.google.protobuf.Timestamp event_timestamp = 3 [(.google.api.field_behavior) = REQUIRED];</code>
* @param \Google\Protobuf\Timestamp $var
* @return $this
*/
public
function
setEventTimestamp
(
$
var
)
{
GPBUtil::
checkMessage
(
$
var
, \
Google
\
Protobuf
\Timestamp::class);
$
this
->
event_timestamp
=
$
var
;
return
$
this
;
}
/**
* Optional. The last time the event was updated.
*
* Generated from protobuf field <code>.google.protobuf.Timestamp last_updated_timestamp = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return \Google\Protobuf\Timestamp|null
*/
public
function
getLastUpdatedTimestamp
()
{
return
$
this
->
last_updated_timestamp
;
}
public
function
hasLastUpdatedTimestamp
()
{
return
isset
(
$
this
->
last_updated_timestamp
);
}
public
function
clearLastUpdatedTimestamp
()
{
unset(
$
this
->
last_updated_timestamp
);
}
/**
* Optional. The last time the event was updated.
*
* Generated from protobuf field <code>.google.protobuf.Timestamp last_updated_timestamp = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param \Google\Protobuf\Timestamp $var
* @return $this
*/
public
function
setLastUpdatedTimestamp
(
$
var
)
{
GPBUtil::
checkMessage
(
$
var
, \
Google
\
Protobuf
\Timestamp::class);
$
this
->
last_updated_timestamp
=
$
var
;
return
$
this
;
}
/**
* Optional. Pieces of user provided data, representing the user the event is
* associated with.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.UserData user_data = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return \Google\Ads\DataManager\V1\UserData|null
*/
public
function
getUserData
()
{
return
$
this
->
user_data
;
}
public
function
hasUserData
()
{
return
isset
(
$
this
->
user_data
);
}
public
function
clearUserData
()
{
unset(
$
this
->
user_data
);
}
/**
* Optional. Pieces of user provided data, representing the user the event is
* associated with.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.UserData user_data = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param \Google\Ads\DataManager\V1\UserData $var
* @return $this
*/
public
function
setUserData
(
$
var
)
{
GPBUtil::
checkMessage
(
$
var
, \
Google
\
Ads
\
DataManager
\
V1
\UserData::class);
$
this
->
user_data
=
$
var
;
return
$
this
;
}
/**
* Optional. Information about whether the associated user has provided
* different types of consent.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.Consent consent = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return \Google\Ads\DataManager\V1\Consent|null
*/
public
function
getConsent
()
{
return
$
this
->
consent
;
}
public
function
hasConsent
()
{
return
isset
(
$
this
->
consent
);
}
public
function
clearConsent
()
{
unset(
$
this
->
consent
);
}
/**
* Optional. Information about whether the associated user has provided
* different types of consent.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.Consent consent = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param \Google\Ads\DataManager\V1\Consent $var
* @return $this
*/
public
function
setConsent
(
$
var
)
{
GPBUtil::
checkMessage
(
$
var
, \
Google
\
Ads
\
DataManager
\
V1
\Consent::class);
$
this
->
consent
=
$
var
;
return
$
this
;
}
/**
* Optional. Identifiers and other information used to match the conversion
* event with other online activity (such as ad clicks).
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.AdIdentifiers ad_identifiers = 7 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return \Google\Ads\DataManager\V1\AdIdentifiers|null
*/
public
function
getAdIdentifiers
()
{
return
$
this
->
ad_identifiers
;
}
public
function
hasAdIdentifiers
()
{
return
isset
(
$
this
->
ad_identifiers
);
}
public
function
clearAdIdentifiers
()
{
unset(
$
this
->
ad_identifiers
);
}
/**
* Optional. Identifiers and other information used to match the conversion
* event with other online activity (such as ad clicks).
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.AdIdentifiers ad_identifiers = 7 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param \Google\Ads\DataManager\V1\AdIdentifiers $var
* @return $this
*/
public
function
setAdIdentifiers
(
$
var
)
{
GPBUtil::
checkMessage
(
$
var
, \
Google
\
Ads
\
DataManager
\
V1
\AdIdentifiers::class);
$
this
->
ad_identifiers
=
$
var
;
return
$
this
;
}
/**
* Optional. The currency code associated with all monetary values within this
* event.
*
* Generated from protobuf field <code>string currency = 8 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return string
*/
public
function
getCurrency
()
{
return
$
this
->
currency
;
}
/**
* Optional. The currency code associated with all monetary values within this
* event.
*
* Generated from protobuf field <code>string currency = 8 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param string $var
* @return $this
*/
public
function
setCurrency
(
$
var
)
{
GPBUtil::
checkString
(
$
var
,
True
);
$
this
->
currency
=
$
var
;
return
$
this
;
}
/**
* Optional. The conversion value associated with the event, for value-based
* conversions.
*
* Generated from protobuf field <code>optional double conversion_value = 9 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return float
*/
public
function
getConversionValue
()
{
return
isset
(
$
this
->
conversion_value
) ?
$
this
->
conversion_value
:
0.0
;
}
public
function
hasConversionValue
()
{
return
isset
(
$
this
->
conversion_value
);
}
public
function
clearConversionValue
()
{
unset(
$
this
->
conversion_value
);
}
/**
* Optional. The conversion value associated with the event, for value-based
* conversions.
*
* Generated from protobuf field <code>optional double conversion_value = 9 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param float $var
* @return $this
*/
public
function
setConversionValue
(
$
var
)
{
GPBUtil::
checkDouble
(
$
var
);
$
this
->
conversion_value
=
$
var
;
return
$
this
;
}
/**
* Optional. The conversion quantity associated with the event, for
* counting-based conversions.
*
* Generated from protobuf field <code>optional double conversion_count = 23 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return float
*/
public
function
getConversionCount
()
{
return
isset
(
$
this
->
conversion_count
) ?
$
this
->
conversion_count
:
0.0
;
}
public
function
hasConversionCount
()
{
return
isset
(
$
this
->
conversion_count
);
}
public
function
clearConversionCount
()
{
unset(
$
this
->
conversion_count
);
}
/**
* Optional. The conversion quantity associated with the event, for
* counting-based conversions.
*
* Generated from protobuf field <code>optional double conversion_count = 23 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param float $var
* @return $this
*/
public
function
setConversionCount
(
$
var
)
{
GPBUtil::
checkDouble
(
$
var
);
$
this
->
conversion_count
=
$
var
;
return
$
this
;
}
/**
* Optional. Signal for where the event happened (web, app, in-store, etc.).
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.EventSource event_source = 10 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return int
*/
public
function
getEventSource
()
{
return
$
this
->
event_source
;
}
/**
* Optional. Signal for where the event happened (web, app, in-store, etc.).
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.EventSource event_source = 10 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param int $var
* @return $this
*/
public
function
setEventSource
(
$
var
)
{
GPBUtil::
checkEnum
(
$
var
, \
Google
\
Ads
\
DataManager
\
V1
\EventSource::class);
$
this
->
event_source
=
$
var
;
return
$
this
;
}
/**
* Optional. Information gathered about the device being used (if any) when
* the event happened.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.DeviceInfo event_device_info = 11 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return \Google\Ads\DataManager\V1\DeviceInfo|null
*/
public
function
getEventDeviceInfo
()
{
return
$
this
->
event_device_info
;
}
public
function
hasEventDeviceInfo
()
{
return
isset
(
$
this
->
event_device_info
);
}
public
function
clearEventDeviceInfo
()
{
unset(
$
this
->
event_device_info
);
}
/**
* Optional. Information gathered about the device being used (if any) when
* the event happened.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.DeviceInfo event_device_info = 11 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param \Google\Ads\DataManager\V1\DeviceInfo $var
* @return $this
*/
public
function
setEventDeviceInfo
(
$
var
)
{
GPBUtil::
checkMessage
(
$
var
, \
Google
\
Ads
\
DataManager
\
V1
\DeviceInfo::class);
$
this
->
event_device_info
=
$
var
;
return
$
this
;
}
/**
* Optional. Information about the transaction and items associated with the
* event.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.CartData cart_data = 12 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return \Google\Ads\DataManager\V1\CartData|null
*/
public
function
getCartData
()
{
return
$
this
->
cart_data
;
}
public
function
hasCartData
()
{
return
isset
(
$
this
->
cart_data
);
}
public
function
clearCartData
()
{
unset(
$
this
->
cart_data
);
}
/**
* Optional. Information about the transaction and items associated with the
* event.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.CartData cart_data = 12 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param \Google\Ads\DataManager\V1\CartData $var
* @return $this
*/
public
function
setCartData
(
$
var
)
{
GPBUtil::
checkMessage
(
$
var
, \
Google
\
Ads
\
DataManager
\
V1
\CartData::class);
$
this
->
cart_data
=
$
var
;
return
$
this
;
}
/**
* Optional. Additional key/value pair information to send to the conversion
* containers (conversion action or FL activity).
*
* Generated from protobuf field <code>repeated .google.ads.datamanager.v1.CustomVariable custom_variables = 13 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return RepeatedField<\Google\Ads\DataManager\V1\CustomVariable>
*/
public
function
getCustomVariables
()
{
return
$
this
->
custom_variables
;
}
/**
* Optional. Additional key/value pair information to send to the conversion
* containers (conversion action or FL activity).
*
* Generated from protobuf field <code>repeated .google.ads.datamanager.v1.CustomVariable custom_variables = 13 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param \Google\Ads\DataManager\V1\CustomVariable[] $var
* @return $this
*/
public
function
setCustomVariables
(
$
var
)
{
$
arr
= GPBUtil::
checkRepeatedField
(
$
var
, \
Google
\
Protobuf
\
Internal
\GPBType::
MESSAGE
, \
Google
\
Ads
\
DataManager
\
V1
\CustomVariable::class);
$
this
->
custom_variables
=
$
arr
;
return
$
this
;
}
/**
* Optional. A list of key/value pairs for experimental fields that may
* eventually be promoted to be part of the API.
*
* Generated from protobuf field <code>repeated .google.ads.datamanager.v1.ExperimentalField experimental_fields = 14 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return RepeatedField<\Google\Ads\DataManager\V1\ExperimentalField>
*/
public
function
getExperimentalFields
()
{
return
$
this
->
experimental_fields
;
}
/**
* Optional. A list of key/value pairs for experimental fields that may
* eventually be promoted to be part of the API.
*
* Generated from protobuf field <code>repeated .google.ads.datamanager.v1.ExperimentalField experimental_fields = 14 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param \Google\Ads\DataManager\V1\ExperimentalField[] $var
* @return $this
*/
public
function
setExperimentalFields
(
$
var
)
{
$
arr
= GPBUtil::
checkRepeatedField
(
$
var
, \
Google
\
Protobuf
\
Internal
\GPBType::
MESSAGE
, \
Google
\
Ads
\
DataManager
\
V1
\ExperimentalField::class);
$
this
->
experimental_fields
=
$
arr
;
return
$
this
;
}
/**
* Optional. Advertiser-assessed information about the user at the time that
* the event happened.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.UserProperties user_properties = 15 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return \Google\Ads\DataManager\V1\UserProperties|null
*/
public
function
getUserProperties
()
{
return
$
this
->
user_properties
;
}
public
function
hasUserProperties
()
{
return
isset
(
$
this
->
user_properties
);
}
public
function
clearUserProperties
()
{
unset(
$
this
->
user_properties
);
}
/**
* Optional. Advertiser-assessed information about the user at the time that
* the event happened.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.UserProperties user_properties = 15 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param \Google\Ads\DataManager\V1\UserProperties $var
* @return $this
*/
public
function
setUserProperties
(
$
var
)
{
GPBUtil::
checkMessage
(
$
var
, \
Google
\
Ads
\
DataManager
\
V1
\UserProperties::class);
$
this
->
user_properties
=
$
var
;
return
$
this
;
}
/**
* Optional. The name of the event. Required for GA4 events.
*
* Generated from protobuf field <code>string event_name = 16 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return string
*/
public
function
getEventName
()
{
return
$
this
->
event_name
;
}
/**
* Optional. The name of the event. Required for GA4 events.
*
* Generated from protobuf field <code>string event_name = 16 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param string $var
* @return $this
*/
public
function
setEventName
(
$
var
)
{
GPBUtil::
checkString
(
$
var
,
True
);
$
this
->
event_name
=
$
var
;
return
$
this
;
}
/**
* Optional. A unique identifier for the user instance of a web client for
* this GA4 web stream.
*
* Generated from protobuf field <code>string client_id = 17 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return string
*/
public
function
getClientId
()
{
return
$
this
->
client_id
;
}
/**
* Optional. A unique identifier for the user instance of a web client for
* this GA4 web stream.
*
* Generated from protobuf field <code>string client_id = 17 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param string $var
* @return $this
*/
public
function
setClientId
(
$
var
)
{
GPBUtil::
checkString
(
$
var
,
True
);
$
this
->
client_id
=
$
var
;
return
$
this
;
}
/**
* Optional. A unique identifier for a user, as defined by the advertiser.
*
* Generated from protobuf field <code>string user_id = 18 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return string
*/
public
function
getUserId
()
{
return
$
this
->
user_id
;
}
/**
* Optional. A unique identifier for a user, as defined by the advertiser.
*
* Generated from protobuf field <code>string user_id = 18 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param string $var
* @return $this
*/
public
function
setUserId
(
$
var
)
{
GPBUtil::
checkString
(
$
var
,
True
);
$
this
->
user_id
=
$
var
;
return
$
this
;
}
/**
* Optional. A bucket of any [event
* parameters](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events)
* to be included within the event that were not already specified using other
* structured fields.
*
* Generated from protobuf field <code>repeated .google.ads.datamanager.v1.EventParameter additional_event_parameters = 19 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return RepeatedField<\Google\Ads\DataManager\V1\EventParameter>
*/
public
function
getAdditionalEventParameters
()
{
return
$
this
->
additional_event_parameters
;
}
/**
* Optional. A bucket of any [event
* parameters](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events)
* to be included within the event that were not already specified using other
* structured fields.
*
* Generated from protobuf field <code>repeated .google.ads.datamanager.v1.EventParameter additional_event_parameters = 19 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param \Google\Ads\DataManager\V1\EventParameter[] $var
* @return $this
*/
public
function
setAdditionalEventParameters
(
$
var
)
{
$
arr
= GPBUtil::
checkRepeatedField
(
$
var
, \
Google
\
Protobuf
\
Internal
\GPBType::
MESSAGE
, \
Google
\
Ads
\
DataManager
\
V1
\EventParameter::class);
$
this
->
additional_event_parameters
=
$
arr
;
return
$
this
;
}
/**
* Optional. The same type of data provided in user_data, but explicitly
* flagged as being provided as owned by a third-party and not first-party
* advertiser data.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.UserData third_party_user_data = 20 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return \Google\Ads\DataManager\V1\UserData|null
*/
public
function
getThirdPartyUserData
()
{
return
$
this
->
third_party_user_data
;
}
public
function
hasThirdPartyUserData
()
{
return
isset
(
$
this
->
third_party_user_data
);
}
public
function
clearThirdPartyUserData
()
{
unset(
$
this
->
third_party_user_data
);
}
/**
* Optional. The same type of data provided in user_data, but explicitly
* flagged as being provided as owned by a third-party and not first-party
* advertiser data.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.UserData third_party_user_data = 20 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param \Google\Ads\DataManager\V1\UserData $var
* @return $this
*/
public
function
setThirdPartyUserData
(
$
var
)
{
GPBUtil::
checkMessage
(
$
var
, \
Google
\
Ads
\
DataManager
\
V1
\UserData::class);
$
this
->
third_party_user_data
=
$
var
;
return
$
this
;
}
/**
* Optional. Information gathered about the location of the user when this
* event occurred.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.EventLocation event_location = 21 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return \Google\Ads\DataManager\V1\EventLocation|null
*/
public
function
getEventLocation
()
{
return
$
this
->
event_location
;
}
public
function
hasEventLocation
()
{
return
isset
(
$
this
->
event_location
);
}
public
function
clearEventLocation
()
{
unset(
$
this
->
event_location
);
}
/**
* Optional. Information gathered about the location of the user when this
* event occurred.
*
* Generated from protobuf field <code>.google.ads.datamanager.v1.EventLocation event_location = 21 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param \Google\Ads\DataManager\V1\EventLocation $var
* @return $this
*/
public
function
setEventLocation
(
$
var
)
{
GPBUtil::
checkMessage
(
$
var
, \
Google
\
Ads
\
DataManager
\
V1
\EventLocation::class);
$
this
->
event_location
=
$
var
;
return
$
this
;
}
/**
* Optional. A unique identifier for the user instance of an app client for
* this GA4 app stream.
View remainder of file in raw view
Back
|
FazBrowse Home
|
New Git URL