John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="doubleclicksearch_v2.html">DoubleClick Search API</a> . <a href="doubleclicksearch_v2.conversion.html">conversion</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, campaignId=None, adId=None, criterionId=None)</a></code></p> |
| 79 | <p class="firstline">Retrieves a list of conversions from a DoubleClick Search engine account.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#insert">insert(body)</a></code></p> |
| 82 | <p class="firstline">Inserts a batch of new conversions into DoubleClick Search.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#patch">patch(advertiserId, agencyId, endDate, engineAccountId, rowCount, startDate, startRow, body)</a></code></p> |
| 85 | <p class="firstline">Updates a batch of conversions in DoubleClick Search. This method supports patch semantics.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#update">update(body)</a></code></p> |
| 88 | <p class="firstline">Updates a batch of conversions in DoubleClick Search.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#updateAvailability">updateAvailability(body)</a></code></p> |
| 91 | <p class="firstline">Updates the availabilities of a batch of floodlight activities in DoubleClick Search.</p> |
| 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
| 94 | <code class="details" id="get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, campaignId=None, adId=None, criterionId=None)</code> |
| 95 | <pre>Retrieves a list of conversions from a DoubleClick Search engine account. |
| 96 | |
| 97 | Args: |
| 98 | agencyId: string, Numeric ID of the agency. (required) |
| 99 | advertiserId: string, Numeric ID of the advertiser. (required) |
| 100 | engineAccountId: string, Numeric ID of the engine account. (required) |
| 101 | endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required) |
| 102 | rowCount: integer, The number of conversions to return per call. (required) |
| 103 | startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required) |
| 104 | startRow: integer, The 0-based starting index for retrieving conversions results. (required) |
| 105 | adGroupId: string, Numeric ID of the ad group. |
| 106 | campaignId: string, Numeric ID of the campaign. |
| 107 | adId: string, Numeric ID of the ad. |
| 108 | criterionId: string, Numeric ID of the criterion. |
| 109 | |
| 110 | Returns: |
| 111 | An object of the form: |
| 112 | |
| 113 | { # A list of conversions. |
| 114 | "conversion": [ # The conversions being requested. |
| 115 | { # A conversion containing data relevant to DoubleClick Search. |
| 116 | "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. |
| 117 | { # A message containing the custome dimension. |
| 118 | "name": "A String", # Custom dimension name. |
| 119 | "value": "A String", # Custom dimension value. |
| 120 | }, |
| 121 | ], |
| 122 | "adGroupId": "A String", # DS ad group ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 123 | "attributionModel": "A String", # Attribution model name. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 124 | "campaignId": "A String", # DS campaign ID. |
| 125 | "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros. |
| 126 | "advertiserId": "A String", # DS advertiser ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 127 | "countMillis": "A String", # Conversion count in millis. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 128 | "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. |
| 129 | "clickId": "A String", # DS click ID for the conversion. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 130 | "dsConversionId": "A String", # DS conversion ID. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 131 | "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 132 | "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 133 | "adId": "A String", # DS ad ID. |
| 134 | "conversionId": "A String", # Advertiser-provided ID for the conversion, also known as the order ID. |
| 135 | "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. |
| 136 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 137 | "agencyId": "A String", # DS agency ID. |
| 138 | "quantityMillis": "A String", # The quantity of this conversion, in millis. |
| 139 | "criterionId": "A String", # DS criterion (keyword) ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 140 | "floodlightOrderId": "A String", # The advertiser-provided order id for the conversion. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 141 | "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT). |
| 142 | "customMetric": [ # Custom metrics for the conversion. |
| 143 | { # A message containing the custome metric. |
| 144 | "name": "A String", # Custom metric name. |
| 145 | "value": 3.14, # Custom metric numeric value. |
| 146 | }, |
| 147 | ], |
| 148 | "engineAccountId": "A String", # DS engine account ID. |
| 149 | "type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION). |
| 150 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 151 | }, |
| 152 | ], |
| 153 | "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. |
| 154 | }</pre> |
| 155 | </div> |
| 156 | |
| 157 | <div class="method"> |
| 158 | <code class="details" id="insert">insert(body)</code> |
| 159 | <pre>Inserts a batch of new conversions into DoubleClick Search. |
| 160 | |
| 161 | Args: |
| 162 | body: object, The request body. (required) |
| 163 | The object takes the form of: |
| 164 | |
| 165 | { # A list of conversions. |
| 166 | "conversion": [ # The conversions being requested. |
| 167 | { # A conversion containing data relevant to DoubleClick Search. |
| 168 | "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. |
| 169 | { # A message containing the custome dimension. |
| 170 | "name": "A String", # Custom dimension name. |
| 171 | "value": "A String", # Custom dimension value. |
| 172 | }, |
| 173 | ], |
| 174 | "adGroupId": "A String", # DS ad group ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 175 | "attributionModel": "A String", # Attribution model name. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 176 | "campaignId": "A String", # DS campaign ID. |
| 177 | "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros. |
| 178 | "advertiserId": "A String", # DS advertiser ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 179 | "countMillis": "A String", # Conversion count in millis. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 180 | "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. |
| 181 | "clickId": "A String", # DS click ID for the conversion. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 182 | "dsConversionId": "A String", # DS conversion ID. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 183 | "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 184 | "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 185 | "adId": "A String", # DS ad ID. |
| 186 | "conversionId": "A String", # Advertiser-provided ID for the conversion, also known as the order ID. |
| 187 | "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. |
| 188 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 189 | "agencyId": "A String", # DS agency ID. |
| 190 | "quantityMillis": "A String", # The quantity of this conversion, in millis. |
| 191 | "criterionId": "A String", # DS criterion (keyword) ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 192 | "floodlightOrderId": "A String", # The advertiser-provided order id for the conversion. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 193 | "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT). |
| 194 | "customMetric": [ # Custom metrics for the conversion. |
| 195 | { # A message containing the custome metric. |
| 196 | "name": "A String", # Custom metric name. |
| 197 | "value": 3.14, # Custom metric numeric value. |
| 198 | }, |
| 199 | ], |
| 200 | "engineAccountId": "A String", # DS engine account ID. |
| 201 | "type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION). |
| 202 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 203 | }, |
| 204 | ], |
| 205 | "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. |
| 206 | } |
| 207 | |
| 208 | |
| 209 | Returns: |
| 210 | An object of the form: |
| 211 | |
| 212 | { # A list of conversions. |
| 213 | "conversion": [ # The conversions being requested. |
| 214 | { # A conversion containing data relevant to DoubleClick Search. |
| 215 | "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. |
| 216 | { # A message containing the custome dimension. |
| 217 | "name": "A String", # Custom dimension name. |
| 218 | "value": "A String", # Custom dimension value. |
| 219 | }, |
| 220 | ], |
| 221 | "adGroupId": "A String", # DS ad group ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 222 | "attributionModel": "A String", # Attribution model name. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 223 | "campaignId": "A String", # DS campaign ID. |
| 224 | "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros. |
| 225 | "advertiserId": "A String", # DS advertiser ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 226 | "countMillis": "A String", # Conversion count in millis. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 227 | "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. |
| 228 | "clickId": "A String", # DS click ID for the conversion. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 229 | "dsConversionId": "A String", # DS conversion ID. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 230 | "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 231 | "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 232 | "adId": "A String", # DS ad ID. |
| 233 | "conversionId": "A String", # Advertiser-provided ID for the conversion, also known as the order ID. |
| 234 | "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. |
| 235 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 236 | "agencyId": "A String", # DS agency ID. |
| 237 | "quantityMillis": "A String", # The quantity of this conversion, in millis. |
| 238 | "criterionId": "A String", # DS criterion (keyword) ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 239 | "floodlightOrderId": "A String", # The advertiser-provided order id for the conversion. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 240 | "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT). |
| 241 | "customMetric": [ # Custom metrics for the conversion. |
| 242 | { # A message containing the custome metric. |
| 243 | "name": "A String", # Custom metric name. |
| 244 | "value": 3.14, # Custom metric numeric value. |
| 245 | }, |
| 246 | ], |
| 247 | "engineAccountId": "A String", # DS engine account ID. |
| 248 | "type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION). |
| 249 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 250 | }, |
| 251 | ], |
| 252 | "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. |
| 253 | }</pre> |
| 254 | </div> |
| 255 | |
| 256 | <div class="method"> |
| 257 | <code class="details" id="patch">patch(advertiserId, agencyId, endDate, engineAccountId, rowCount, startDate, startRow, body)</code> |
| 258 | <pre>Updates a batch of conversions in DoubleClick Search. This method supports patch semantics. |
| 259 | |
| 260 | Args: |
| 261 | advertiserId: string, Numeric ID of the advertiser. (required) |
| 262 | agencyId: string, Numeric ID of the agency. (required) |
| 263 | endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required) |
| 264 | engineAccountId: string, Numeric ID of the engine account. (required) |
| 265 | rowCount: integer, The number of conversions to return per call. (required) |
| 266 | startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required) |
| 267 | startRow: integer, The 0-based starting index for retrieving conversions results. (required) |
| 268 | body: object, The request body. (required) |
| 269 | The object takes the form of: |
| 270 | |
| 271 | { # A list of conversions. |
| 272 | "conversion": [ # The conversions being requested. |
| 273 | { # A conversion containing data relevant to DoubleClick Search. |
| 274 | "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. |
| 275 | { # A message containing the custome dimension. |
| 276 | "name": "A String", # Custom dimension name. |
| 277 | "value": "A String", # Custom dimension value. |
| 278 | }, |
| 279 | ], |
| 280 | "adGroupId": "A String", # DS ad group ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 281 | "attributionModel": "A String", # Attribution model name. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 282 | "campaignId": "A String", # DS campaign ID. |
| 283 | "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros. |
| 284 | "advertiserId": "A String", # DS advertiser ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 285 | "countMillis": "A String", # Conversion count in millis. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 286 | "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. |
| 287 | "clickId": "A String", # DS click ID for the conversion. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 288 | "dsConversionId": "A String", # DS conversion ID. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 289 | "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 290 | "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 291 | "adId": "A String", # DS ad ID. |
| 292 | "conversionId": "A String", # Advertiser-provided ID for the conversion, also known as the order ID. |
| 293 | "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. |
| 294 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 295 | "agencyId": "A String", # DS agency ID. |
| 296 | "quantityMillis": "A String", # The quantity of this conversion, in millis. |
| 297 | "criterionId": "A String", # DS criterion (keyword) ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 298 | "floodlightOrderId": "A String", # The advertiser-provided order id for the conversion. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 299 | "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT). |
| 300 | "customMetric": [ # Custom metrics for the conversion. |
| 301 | { # A message containing the custome metric. |
| 302 | "name": "A String", # Custom metric name. |
| 303 | "value": 3.14, # Custom metric numeric value. |
| 304 | }, |
| 305 | ], |
| 306 | "engineAccountId": "A String", # DS engine account ID. |
| 307 | "type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION). |
| 308 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 309 | }, |
| 310 | ], |
| 311 | "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. |
| 312 | } |
| 313 | |
| 314 | |
| 315 | Returns: |
| 316 | An object of the form: |
| 317 | |
| 318 | { # A list of conversions. |
| 319 | "conversion": [ # The conversions being requested. |
| 320 | { # A conversion containing data relevant to DoubleClick Search. |
| 321 | "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. |
| 322 | { # A message containing the custome dimension. |
| 323 | "name": "A String", # Custom dimension name. |
| 324 | "value": "A String", # Custom dimension value. |
| 325 | }, |
| 326 | ], |
| 327 | "adGroupId": "A String", # DS ad group ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 328 | "attributionModel": "A String", # Attribution model name. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 329 | "campaignId": "A String", # DS campaign ID. |
| 330 | "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros. |
| 331 | "advertiserId": "A String", # DS advertiser ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 332 | "countMillis": "A String", # Conversion count in millis. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 333 | "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. |
| 334 | "clickId": "A String", # DS click ID for the conversion. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 335 | "dsConversionId": "A String", # DS conversion ID. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 336 | "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 337 | "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 338 | "adId": "A String", # DS ad ID. |
| 339 | "conversionId": "A String", # Advertiser-provided ID for the conversion, also known as the order ID. |
| 340 | "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. |
| 341 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 342 | "agencyId": "A String", # DS agency ID. |
| 343 | "quantityMillis": "A String", # The quantity of this conversion, in millis. |
| 344 | "criterionId": "A String", # DS criterion (keyword) ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 345 | "floodlightOrderId": "A String", # The advertiser-provided order id for the conversion. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 346 | "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT). |
| 347 | "customMetric": [ # Custom metrics for the conversion. |
| 348 | { # A message containing the custome metric. |
| 349 | "name": "A String", # Custom metric name. |
| 350 | "value": 3.14, # Custom metric numeric value. |
| 351 | }, |
| 352 | ], |
| 353 | "engineAccountId": "A String", # DS engine account ID. |
| 354 | "type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION). |
| 355 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 356 | }, |
| 357 | ], |
| 358 | "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. |
| 359 | }</pre> |
| 360 | </div> |
| 361 | |
| 362 | <div class="method"> |
| 363 | <code class="details" id="update">update(body)</code> |
| 364 | <pre>Updates a batch of conversions in DoubleClick Search. |
| 365 | |
| 366 | Args: |
| 367 | body: object, The request body. (required) |
| 368 | The object takes the form of: |
| 369 | |
| 370 | { # A list of conversions. |
| 371 | "conversion": [ # The conversions being requested. |
| 372 | { # A conversion containing data relevant to DoubleClick Search. |
| 373 | "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. |
| 374 | { # A message containing the custome dimension. |
| 375 | "name": "A String", # Custom dimension name. |
| 376 | "value": "A String", # Custom dimension value. |
| 377 | }, |
| 378 | ], |
| 379 | "adGroupId": "A String", # DS ad group ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 380 | "attributionModel": "A String", # Attribution model name. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 381 | "campaignId": "A String", # DS campaign ID. |
| 382 | "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros. |
| 383 | "advertiserId": "A String", # DS advertiser ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 384 | "countMillis": "A String", # Conversion count in millis. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 385 | "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. |
| 386 | "clickId": "A String", # DS click ID for the conversion. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 387 | "dsConversionId": "A String", # DS conversion ID. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 388 | "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 389 | "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 390 | "adId": "A String", # DS ad ID. |
| 391 | "conversionId": "A String", # Advertiser-provided ID for the conversion, also known as the order ID. |
| 392 | "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. |
| 393 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 394 | "agencyId": "A String", # DS agency ID. |
| 395 | "quantityMillis": "A String", # The quantity of this conversion, in millis. |
| 396 | "criterionId": "A String", # DS criterion (keyword) ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 397 | "floodlightOrderId": "A String", # The advertiser-provided order id for the conversion. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 398 | "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT). |
| 399 | "customMetric": [ # Custom metrics for the conversion. |
| 400 | { # A message containing the custome metric. |
| 401 | "name": "A String", # Custom metric name. |
| 402 | "value": 3.14, # Custom metric numeric value. |
| 403 | }, |
| 404 | ], |
| 405 | "engineAccountId": "A String", # DS engine account ID. |
| 406 | "type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION). |
| 407 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 408 | }, |
| 409 | ], |
| 410 | "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. |
| 411 | } |
| 412 | |
| 413 | |
| 414 | Returns: |
| 415 | An object of the form: |
| 416 | |
| 417 | { # A list of conversions. |
| 418 | "conversion": [ # The conversions being requested. |
| 419 | { # A conversion containing data relevant to DoubleClick Search. |
| 420 | "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. |
| 421 | { # A message containing the custome dimension. |
| 422 | "name": "A String", # Custom dimension name. |
| 423 | "value": "A String", # Custom dimension value. |
| 424 | }, |
| 425 | ], |
| 426 | "adGroupId": "A String", # DS ad group ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 427 | "attributionModel": "A String", # Attribution model name. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 428 | "campaignId": "A String", # DS campaign ID. |
| 429 | "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros. |
| 430 | "advertiserId": "A String", # DS advertiser ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 431 | "countMillis": "A String", # Conversion count in millis. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 432 | "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. |
| 433 | "clickId": "A String", # DS click ID for the conversion. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 434 | "dsConversionId": "A String", # DS conversion ID. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 435 | "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 436 | "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 437 | "adId": "A String", # DS ad ID. |
| 438 | "conversionId": "A String", # Advertiser-provided ID for the conversion, also known as the order ID. |
| 439 | "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. |
| 440 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 441 | "agencyId": "A String", # DS agency ID. |
| 442 | "quantityMillis": "A String", # The quantity of this conversion, in millis. |
| 443 | "criterionId": "A String", # DS criterion (keyword) ID. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame^] | 444 | "floodlightOrderId": "A String", # The advertiser-provided order id for the conversion. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 445 | "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT). |
| 446 | "customMetric": [ # Custom metrics for the conversion. |
| 447 | { # A message containing the custome metric. |
| 448 | "name": "A String", # Custom metric name. |
| 449 | "value": 3.14, # Custom metric numeric value. |
| 450 | }, |
| 451 | ], |
| 452 | "engineAccountId": "A String", # DS engine account ID. |
| 453 | "type": "A String", # The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION). |
| 454 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 455 | }, |
| 456 | ], |
| 457 | "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. |
| 458 | }</pre> |
| 459 | </div> |
| 460 | |
| 461 | <div class="method"> |
| 462 | <code class="details" id="updateAvailability">updateAvailability(body)</code> |
| 463 | <pre>Updates the availabilities of a batch of floodlight activities in DoubleClick Search. |
| 464 | |
| 465 | Args: |
| 466 | body: object, The request body. (required) |
| 467 | The object takes the form of: |
| 468 | |
| 469 | { # The request to update availability. |
| 470 | "availabilities": [ # The availabilities being requested. |
| 471 | { # A message containing availability data relevant to DoubleClick Search. |
| 472 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 473 | "agencyId": "A String", # DS agency ID. |
| 474 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 475 | "availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC. |
| 476 | "advertiserId": "A String", # DS advertiser ID. |
| 477 | "segmentationType": "A String", # The segmentation type that this availability is for (its default value is FLOODLIGHT). |
| 478 | }, |
| 479 | ], |
| 480 | } |
| 481 | |
| 482 | |
| 483 | Returns: |
| 484 | An object of the form: |
| 485 | |
| 486 | { # The response to a update availability request. |
| 487 | "availabilities": [ # The availabilities being returned. |
| 488 | { # A message containing availability data relevant to DoubleClick Search. |
| 489 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 490 | "agencyId": "A String", # DS agency ID. |
| 491 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 492 | "availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC. |
| 493 | "advertiserId": "A String", # DS advertiser ID. |
| 494 | "segmentationType": "A String", # The segmentation type that this availability is for (its default value is FLOODLIGHT). |
| 495 | }, |
| 496 | ], |
| 497 | }</pre> |
| 498 | </div> |
| 499 | |
| 500 | </body></html> |