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
|
<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_v2_8.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_8.conversions.html">conversions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchinsert">batchinsert(profileId, body)</a></code></p>
<p class="firstline">Inserts conversions.</p>
<p class="toc_element">
<code><a href="#batchupdate">batchupdate(profileId, body)</a></code></p>
<p class="firstline">Updates existing conversions.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchinsert">batchinsert(profileId, body)</code>
<pre>Inserts conversions.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Insert Conversions Request.
"conversions": [ # The set of conversions to insert.
{ # A Conversion represents when a user successfully performs a desired action after seeing an ad.
"ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
"kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
"childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
"encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
"customVariables": [ # Custom floodlight variables.
{ # A custom floodlight variable.
"kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
"type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
"value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
},
],
"floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
"mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
"value": 3.14, # The value of the conversion.
"limitAdTracking": True or False, # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.
"quantity": "A String", # The quantity of the conversion.
"floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
"encryptedUserIdCandidates": [ # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId and mobileDeviceId. This or encryptedUserId or mobileDeviceId is a required field.
"A String",
],
},
],
"kind": "dfareporting#conversionsBatchInsertRequest", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest".
"encryptionInfo": { # A description of how user IDs are encrypted. # Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used.
"kind": "dfareporting#encryptionInfo", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo".
"encryptionEntityId": "A String", # The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
"encryptionSource": "A String", # Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.
"encryptionEntityType": "A String", # The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.
},
}
Returns:
An object of the form:
{ # Insert Conversions Response.
"status": [ # The insert status of each conversion. Statuses are returned in the same order that conversions are inserted.
{ # The original conversion that was inserted or updated and whether there were any errors.
"conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
"ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
"kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
"childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
"encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
"customVariables": [ # Custom floodlight variables.
{ # A custom floodlight variable.
"kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
"type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
"value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
},
],
"floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
"mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
"value": 3.14, # The value of the conversion.
"limitAdTracking": True or False, # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.
"quantity": "A String", # The quantity of the conversion.
"floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
"encryptedUserIdCandidates": [ # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId and mobileDeviceId. This or encryptedUserId or mobileDeviceId is a required field.
"A String",
],
},
"errors": [ # A list of errors related to this conversion.
{ # The error code and description for a conversion that failed to insert or update.
"kind": "dfareporting#conversionError", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
"code": "A String", # The error code.
"message": "A String", # A description of the error.
},
],
"kind": "dfareporting#conversionStatus", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus".
},
],
"hasFailures": True or False, # Indicates that some or all conversions failed to insert.
"kind": "dfareporting#conversionsBatchInsertResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse".
}</pre>
</div>
<div class="method">
<code class="details" id="batchupdate">batchupdate(profileId, body)</code>
<pre>Updates existing conversions.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Update Conversions Request.
"conversions": [ # The set of conversions to update.
{ # A Conversion represents when a user successfully performs a desired action after seeing an ad.
"ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
"kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
"childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
"encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
"customVariables": [ # Custom floodlight variables.
{ # A custom floodlight variable.
"kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
"type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
"value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
},
],
"floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
"mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
"value": 3.14, # The value of the conversion.
"limitAdTracking": True or False, # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.
"quantity": "A String", # The quantity of the conversion.
"floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
"encryptedUserIdCandidates": [ # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId and mobileDeviceId. This or encryptedUserId or mobileDeviceId is a required field.
"A String",
],
},
],
"kind": "dfareporting#conversionsBatchUpdateRequest", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest".
"encryptionInfo": { # A description of how user IDs are encrypted. # Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used.
"kind": "dfareporting#encryptionInfo", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo".
"encryptionEntityId": "A String", # The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
"encryptionSource": "A String", # Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.
"encryptionEntityType": "A String", # The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.
},
}
Returns:
An object of the form:
{ # Update Conversions Response.
"status": [ # The update status of each conversion. Statuses are returned in the same order that conversions are updated.
{ # The original conversion that was inserted or updated and whether there were any errors.
"conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
"ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
"kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
"childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
"encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
"customVariables": [ # Custom floodlight variables.
{ # A custom floodlight variable.
"kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
"type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
"value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
},
],
"floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
"mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
"value": 3.14, # The value of the conversion.
"limitAdTracking": True or False, # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.
"quantity": "A String", # The quantity of the conversion.
"floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
"encryptedUserIdCandidates": [ # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId and mobileDeviceId. This or encryptedUserId or mobileDeviceId is a required field.
"A String",
],
},
"errors": [ # A list of errors related to this conversion.
{ # The error code and description for a conversion that failed to insert or update.
"kind": "dfareporting#conversionError", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
"code": "A String", # The error code.
"message": "A String", # A description of the error.
},
],
"kind": "dfareporting#conversionStatus", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus".
},
],
"hasFailures": True or False, # Indicates that some or all conversions failed to update.
"kind": "dfareporting#conversionsBatchUpdateResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse".
}</pre>
</div>
</body></html>
|
