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
|
<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="dfareporting_v3_4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_4.customEvents.html">customEvents</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchinsert">batchinsert(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts custom events.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchinsert">batchinsert(profileId, body=None, x__xgafv=None)</code>
<pre>Inserts custom events.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body.
The object takes the form of:
{ # Insert Custom Events Request.
"customEvents": [ # The set of custom events to insert.
{ # Experimental feature (no support provided) A custom event represents a third party impression, a third party click, an annotation on a first party impression, or an annotation on a first party click.
"annotateClickEvent": { # Annotate a click event. # Annotate a click event. This field is mutually exclusive with insertEvent and annotateImpressionEvent. This or insertEvent and annotateImpressionEvent is a required field.
"gclid": "A String", # The Google click ID. Use this field to annotate the click associated with the gclid.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEventClickAnnotation".
},
"annotateImpressionEvent": { # Annotate an impression. # Annotate an impression. This field is mutually exclusive with insertEvent and annotateClickEvent. This or insertEvent and annotateClickEvent is a required field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEventImpressionAnnotation".
"pathImpressionId": "A String", # The path impression ID. Use this field to annotate the impression associated with the pathImpressionId.
},
"customVariables": [ # Custom variables associated with the event.
{ # Custom variable.
"index": "A String", # The index of the custom variable.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customVariable".
"value": "A String", # The value of the custom variable. The length of string must not exceed 50 characters.
},
],
"eventType": "A String", # The type of event. If INSERT, the fields in insertEvent need to be populated. If ANNOTATE, the fields in either annotateClickEvent or annotateImpressionEvent need to be populated.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of the advertiser the event is linked to. This is a required field.
"insertEvent": { # Custom event to be inserted. # Insert custom event. This field is mutually exclusive with annotateClickEvent and annotateImpressionEvent. This or annotateClickEvent and annotateImpressionEvent is a required field.
"cmDimensions": { # Campaign Manager IDs related to the custom event. # Campaign Manager dimensions associated with the event.
"adId": "A String", # Ad ID for Campaign Manager.
"campaignId": "A String", # Campaign ID for Campaign Manager.
"creativeId": "A String", # Creative ID for Campaign Manager.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignManagerIds".
"placementId": "A String", # Placement ID for Campaign Manager.
"siteId": "A String", # Site ID for Campaign Manager.
},
"dv3Dimensions": { # DV360 IDs related to the custom event. # DV360 dimensions associated with the event.
"dvCampaignId": "A String", # Campaign ID for DV360.
"dvCreativeId": "A String", # Creative ID for DV360.
"dvInsertionOrderId": "A String", # Insertion Order ID for DV360.
"dvLineItemId": "A String", # Line Item ID for DV360.
"dvSiteId": "A String", # Site ID for DV360.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dV3Ids".
},
"insertEventType": "A String", # The type of event to insert.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEventInsert".
"matchId": "A String", # The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with mobileDeviceId, and at least one of the two fields is required.
"mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with matchId, and at least one of the two fields is required.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEvent".
"ordinal": "A String", # The ordinal of this custom event. This is a required field.
"timestampMicros": "A String", # The timestamp of this custom event, in Unix epoch micros. This is a required field.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEventsBatchInsertRequest".
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Insert Custom Events Response.
"hasFailures": True or False, # Indicates that some or all custom events failed to insert.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEventsBatchInsertResponse".
"status": [ # The insert status of each custom event. Statuses are returned in the same order that conversions are inserted.
{ # The original custom event that was inserted and whether there were any errors.
"customEvent": { # Experimental feature (no support provided) A custom event represents a third party impression, a third party click, an annotation on a first party impression, or an annotation on a first party click. # The original custom event that was inserted.
"annotateClickEvent": { # Annotate a click event. # Annotate a click event. This field is mutually exclusive with insertEvent and annotateImpressionEvent. This or insertEvent and annotateImpressionEvent is a required field.
"gclid": "A String", # The Google click ID. Use this field to annotate the click associated with the gclid.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEventClickAnnotation".
},
"annotateImpressionEvent": { # Annotate an impression. # Annotate an impression. This field is mutually exclusive with insertEvent and annotateClickEvent. This or insertEvent and annotateClickEvent is a required field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEventImpressionAnnotation".
"pathImpressionId": "A String", # The path impression ID. Use this field to annotate the impression associated with the pathImpressionId.
},
"customVariables": [ # Custom variables associated with the event.
{ # Custom variable.
"index": "A String", # The index of the custom variable.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customVariable".
"value": "A String", # The value of the custom variable. The length of string must not exceed 50 characters.
},
],
"eventType": "A String", # The type of event. If INSERT, the fields in insertEvent need to be populated. If ANNOTATE, the fields in either annotateClickEvent or annotateImpressionEvent need to be populated.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of the advertiser the event is linked to. This is a required field.
"insertEvent": { # Custom event to be inserted. # Insert custom event. This field is mutually exclusive with annotateClickEvent and annotateImpressionEvent. This or annotateClickEvent and annotateImpressionEvent is a required field.
"cmDimensions": { # Campaign Manager IDs related to the custom event. # Campaign Manager dimensions associated with the event.
"adId": "A String", # Ad ID for Campaign Manager.
"campaignId": "A String", # Campaign ID for Campaign Manager.
"creativeId": "A String", # Creative ID for Campaign Manager.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignManagerIds".
"placementId": "A String", # Placement ID for Campaign Manager.
"siteId": "A String", # Site ID for Campaign Manager.
},
"dv3Dimensions": { # DV360 IDs related to the custom event. # DV360 dimensions associated with the event.
"dvCampaignId": "A String", # Campaign ID for DV360.
"dvCreativeId": "A String", # Creative ID for DV360.
"dvInsertionOrderId": "A String", # Insertion Order ID for DV360.
"dvLineItemId": "A String", # Line Item ID for DV360.
"dvSiteId": "A String", # Site ID for DV360.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dV3Ids".
},
"insertEventType": "A String", # The type of event to insert.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEventInsert".
"matchId": "A String", # The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with mobileDeviceId, and at least one of the two fields is required.
"mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with matchId, and at least one of the two fields is required.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEvent".
"ordinal": "A String", # The ordinal of this custom event. This is a required field.
"timestampMicros": "A String", # The timestamp of this custom event, in Unix epoch micros. This is a required field.
},
"errors": [ # A list of errors related to this custom event.
{ # The error code and description for a custom event that failed to insert.
"code": "A String", # The error code.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEventError".
"message": "A String", # A description of the error.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEventStatus".
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
</body></html>
|
