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. 123 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). 124 "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. 125 "campaignId": "A String", # DS campaign ID. 126 "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request. 127 "advertiserId": "A String", # DS advertiser ID. 128 "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. 129 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. 130 "clickId": "A String", # DS click ID for the conversion. 131 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. 132 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. 133 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. 134 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. 135 "deviceType": "A String", # The type of device on which the conversion occurred. 136 "adId": "A String", # DS ad ID. 137 "conversionId": "A String", # For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. 138 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. 139 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. 140 "channel": "A String", # Sales channel for the product. Acceptable values are: 141 # - "local": a physical store 142 # - "online": an online store 143 "productId": "A String", # The product ID (SKU). 144 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). 145 "agencyId": "A String", # DS agency ID. 146 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local". 147 "quantityMillis": "A String", # The quantity of this conversion, in millis. 148 "criterionId": "A String", # DS criterion (keyword) ID. 149 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion. 150 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT). 151 "customMetric": [ # Custom metrics for the conversion. 152 { # A message containing the custome metric. 153 "name": "A String", # Custom metric name. 154 "value": 3.14, # Custom metric numeric value. 155 }, 156 ], 157 "engineAccountId": "A String", # DS engine account ID. 158 "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). 159 "productGroupId": "A String", # DS product group ID. 160 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product. 161 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. 162 }, 163 ], 164 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. 165 }</pre> 166 </div> 167 168 <div class="method"> 169 <code class="details" id="insert">insert(body)</code> 170 <pre>Inserts a batch of new conversions into DoubleClick Search. 171 172 Args: 173 body: object, The request body. (required) 174 The object takes the form of: 175 176 { # A list of conversions. 177 "conversion": [ # The conversions being requested. 178 { # A conversion containing data relevant to DoubleClick Search. 179 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. 180 { # A message containing the custome dimension. 181 "name": "A String", # Custom dimension name. 182 "value": "A String", # Custom dimension value. 183 }, 184 ], 185 "adGroupId": "A String", # DS ad group ID. 186 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). 187 "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. 188 "campaignId": "A String", # DS campaign ID. 189 "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request. 190 "advertiserId": "A String", # DS advertiser ID. 191 "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. 192 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. 193 "clickId": "A String", # DS click ID for the conversion. 194 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. 195 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. 196 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. 197 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. 198 "deviceType": "A String", # The type of device on which the conversion occurred. 199 "adId": "A String", # DS ad ID. 200 "conversionId": "A String", # For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. 201 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. 202 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. 203 "channel": "A String", # Sales channel for the product. Acceptable values are: 204 # - "local": a physical store 205 # - "online": an online store 206 "productId": "A String", # The product ID (SKU). 207 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). 208 "agencyId": "A String", # DS agency ID. 209 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local". 210 "quantityMillis": "A String", # The quantity of this conversion, in millis. 211 "criterionId": "A String", # DS criterion (keyword) ID. 212 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion. 213 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT). 214 "customMetric": [ # Custom metrics for the conversion. 215 { # A message containing the custome metric. 216 "name": "A String", # Custom metric name. 217 "value": 3.14, # Custom metric numeric value. 218 }, 219 ], 220 "engineAccountId": "A String", # DS engine account ID. 221 "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). 222 "productGroupId": "A String", # DS product group ID. 223 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product. 224 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. 225 }, 226 ], 227 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. 228 } 229 230 231 Returns: 232 An object of the form: 233 234 { # A list of conversions. 235 "conversion": [ # The conversions being requested. 236 { # A conversion containing data relevant to DoubleClick Search. 237 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. 238 { # A message containing the custome dimension. 239 "name": "A String", # Custom dimension name. 240 "value": "A String", # Custom dimension value. 241 }, 242 ], 243 "adGroupId": "A String", # DS ad group ID. 244 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). 245 "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. 246 "campaignId": "A String", # DS campaign ID. 247 "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request. 248 "advertiserId": "A String", # DS advertiser ID. 249 "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. 250 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. 251 "clickId": "A String", # DS click ID for the conversion. 252 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. 253 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. 254 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. 255 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. 256 "deviceType": "A String", # The type of device on which the conversion occurred. 257 "adId": "A String", # DS ad ID. 258 "conversionId": "A String", # For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. 259 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. 260 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. 261 "channel": "A String", # Sales channel for the product. Acceptable values are: 262 # - "local": a physical store 263 # - "online": an online store 264 "productId": "A String", # The product ID (SKU). 265 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). 266 "agencyId": "A String", # DS agency ID. 267 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local". 268 "quantityMillis": "A String", # The quantity of this conversion, in millis. 269 "criterionId": "A String", # DS criterion (keyword) ID. 270 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion. 271 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT). 272 "customMetric": [ # Custom metrics for the conversion. 273 { # A message containing the custome metric. 274 "name": "A String", # Custom metric name. 275 "value": 3.14, # Custom metric numeric value. 276 }, 277 ], 278 "engineAccountId": "A String", # DS engine account ID. 279 "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). 280 "productGroupId": "A String", # DS product group ID. 281 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product. 282 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. 283 }, 284 ], 285 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. 286 }</pre> 287 </div> 288 289 <div class="method"> 290 <code class="details" id="patch">patch(advertiserId, agencyId, endDate, engineAccountId, rowCount, startDate, startRow, body)</code> 291 <pre>Updates a batch of conversions in DoubleClick Search. This method supports patch semantics. 292 293 Args: 294 advertiserId: string, Numeric ID of the advertiser. (required) 295 agencyId: string, Numeric ID of the agency. (required) 296 endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required) 297 engineAccountId: string, Numeric ID of the engine account. (required) 298 rowCount: integer, The number of conversions to return per call. (required) 299 startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required) 300 startRow: integer, The 0-based starting index for retrieving conversions results. (required) 301 body: object, The request body. (required) 302 The object takes the form of: 303 304 { # A list of conversions. 305 "conversion": [ # The conversions being requested. 306 { # A conversion containing data relevant to DoubleClick Search. 307 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. 308 { # A message containing the custome dimension. 309 "name": "A String", # Custom dimension name. 310 "value": "A String", # Custom dimension value. 311 }, 312 ], 313 "adGroupId": "A String", # DS ad group ID. 314 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). 315 "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. 316 "campaignId": "A String", # DS campaign ID. 317 "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request. 318 "advertiserId": "A String", # DS advertiser ID. 319 "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. 320 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. 321 "clickId": "A String", # DS click ID for the conversion. 322 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. 323 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. 324 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. 325 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. 326 "deviceType": "A String", # The type of device on which the conversion occurred. 327 "adId": "A String", # DS ad ID. 328 "conversionId": "A String", # For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. 329 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. 330 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. 331 "channel": "A String", # Sales channel for the product. Acceptable values are: 332 # - "local": a physical store 333 # - "online": an online store 334 "productId": "A String", # The product ID (SKU). 335 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). 336 "agencyId": "A String", # DS agency ID. 337 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local". 338 "quantityMillis": "A String", # The quantity of this conversion, in millis. 339 "criterionId": "A String", # DS criterion (keyword) ID. 340 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion. 341 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT). 342 "customMetric": [ # Custom metrics for the conversion. 343 { # A message containing the custome metric. 344 "name": "A String", # Custom metric name. 345 "value": 3.14, # Custom metric numeric value. 346 }, 347 ], 348 "engineAccountId": "A String", # DS engine account ID. 349 "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). 350 "productGroupId": "A String", # DS product group ID. 351 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product. 352 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. 353 }, 354 ], 355 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. 356 } 357 358 359 Returns: 360 An object of the form: 361 362 { # A list of conversions. 363 "conversion": [ # The conversions being requested. 364 { # A conversion containing data relevant to DoubleClick Search. 365 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. 366 { # A message containing the custome dimension. 367 "name": "A String", # Custom dimension name. 368 "value": "A String", # Custom dimension value. 369 }, 370 ], 371 "adGroupId": "A String", # DS ad group ID. 372 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). 373 "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. 374 "campaignId": "A String", # DS campaign ID. 375 "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request. 376 "advertiserId": "A String", # DS advertiser ID. 377 "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. 378 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. 379 "clickId": "A String", # DS click ID for the conversion. 380 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. 381 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. 382 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. 383 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. 384 "deviceType": "A String", # The type of device on which the conversion occurred. 385 "adId": "A String", # DS ad ID. 386 "conversionId": "A String", # For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. 387 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. 388 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. 389 "channel": "A String", # Sales channel for the product. Acceptable values are: 390 # - "local": a physical store 391 # - "online": an online store 392 "productId": "A String", # The product ID (SKU). 393 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). 394 "agencyId": "A String", # DS agency ID. 395 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local". 396 "quantityMillis": "A String", # The quantity of this conversion, in millis. 397 "criterionId": "A String", # DS criterion (keyword) ID. 398 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion. 399 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT). 400 "customMetric": [ # Custom metrics for the conversion. 401 { # A message containing the custome metric. 402 "name": "A String", # Custom metric name. 403 "value": 3.14, # Custom metric numeric value. 404 }, 405 ], 406 "engineAccountId": "A String", # DS engine account ID. 407 "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). 408 "productGroupId": "A String", # DS product group ID. 409 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product. 410 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. 411 }, 412 ], 413 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. 414 }</pre> 415 </div> 416 417 <div class="method"> 418 <code class="details" id="update">update(body)</code> 419 <pre>Updates a batch of conversions in DoubleClick Search. 420 421 Args: 422 body: object, The request body. (required) 423 The object takes the form of: 424 425 { # A list of conversions. 426 "conversion": [ # The conversions being requested. 427 { # A conversion containing data relevant to DoubleClick Search. 428 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. 429 { # A message containing the custome dimension. 430 "name": "A String", # Custom dimension name. 431 "value": "A String", # Custom dimension value. 432 }, 433 ], 434 "adGroupId": "A String", # DS ad group ID. 435 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). 436 "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. 437 "campaignId": "A String", # DS campaign ID. 438 "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request. 439 "advertiserId": "A String", # DS advertiser ID. 440 "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. 441 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. 442 "clickId": "A String", # DS click ID for the conversion. 443 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. 444 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. 445 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. 446 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. 447 "deviceType": "A String", # The type of device on which the conversion occurred. 448 "adId": "A String", # DS ad ID. 449 "conversionId": "A String", # For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. 450 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. 451 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. 452 "channel": "A String", # Sales channel for the product. Acceptable values are: 453 # - "local": a physical store 454 # - "online": an online store 455 "productId": "A String", # The product ID (SKU). 456 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). 457 "agencyId": "A String", # DS agency ID. 458 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local". 459 "quantityMillis": "A String", # The quantity of this conversion, in millis. 460 "criterionId": "A String", # DS criterion (keyword) ID. 461 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion. 462 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT). 463 "customMetric": [ # Custom metrics for the conversion. 464 { # A message containing the custome metric. 465 "name": "A String", # Custom metric name. 466 "value": 3.14, # Custom metric numeric value. 467 }, 468 ], 469 "engineAccountId": "A String", # DS engine account ID. 470 "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). 471 "productGroupId": "A String", # DS product group ID. 472 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product. 473 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. 474 }, 475 ], 476 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. 477 } 478 479 480 Returns: 481 An object of the form: 482 483 { # A list of conversions. 484 "conversion": [ # The conversions being requested. 485 { # A conversion containing data relevant to DoubleClick Search. 486 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. 487 { # A message containing the custome dimension. 488 "name": "A String", # Custom dimension name. 489 "value": "A String", # Custom dimension value. 490 }, 491 ], 492 "adGroupId": "A String", # DS ad group ID. 493 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). 494 "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. 495 "campaignId": "A String", # DS campaign ID. 496 "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request. 497 "advertiserId": "A String", # DS advertiser ID. 498 "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. 499 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. 500 "clickId": "A String", # DS click ID for the conversion. 501 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. 502 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. 503 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. 504 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. 505 "deviceType": "A String", # The type of device on which the conversion occurred. 506 "adId": "A String", # DS ad ID. 507 "conversionId": "A String", # For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. 508 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. 509 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. 510 "channel": "A String", # Sales channel for the product. Acceptable values are: 511 # - "local": a physical store 512 # - "online": an online store 513 "productId": "A String", # The product ID (SKU). 514 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). 515 "agencyId": "A String", # DS agency ID. 516 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local". 517 "quantityMillis": "A String", # The quantity of this conversion, in millis. 518 "criterionId": "A String", # DS criterion (keyword) ID. 519 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion. 520 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT). 521 "customMetric": [ # Custom metrics for the conversion. 522 { # A message containing the custome metric. 523 "name": "A String", # Custom metric name. 524 "value": 3.14, # Custom metric numeric value. 525 }, 526 ], 527 "engineAccountId": "A String", # DS engine account ID. 528 "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). 529 "productGroupId": "A String", # DS product group ID. 530 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product. 531 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. 532 }, 533 ], 534 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. 535 }</pre> 536 </div> 537 538 <div class="method"> 539 <code class="details" id="updateAvailability">updateAvailability(body)</code> 540 <pre>Updates the availabilities of a batch of floodlight activities in DoubleClick Search. 541 542 Args: 543 body: object, The request body. (required) 544 The object takes the form of: 545 546 { # The request to update availability. 547 "availabilities": [ # The availabilities being requested. 548 { # A message containing availability data relevant to DoubleClick Search. 549 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). 550 "agencyId": "A String", # DS agency ID. 551 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). 552 "availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC. 553 "advertiserId": "A String", # DS advertiser ID. 554 "segmentationType": "A String", # The segmentation type that this availability is for (its default value is FLOODLIGHT). 555 }, 556 ], 557 } 558 559 560 Returns: 561 An object of the form: 562 563 { # The response to a update availability request. 564 "availabilities": [ # The availabilities being returned. 565 { # A message containing availability data relevant to DoubleClick Search. 566 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). 567 "agencyId": "A String", # DS agency ID. 568 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). 569 "availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC. 570 "advertiserId": "A String", # DS advertiser ID. 571 "segmentationType": "A String", # The segmentation type that this availability is for (its default value is FLOODLIGHT). 572 }, 573 ], 574 }</pre> 575 </div> 576 577 </body></html>
