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 | |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 75 | <h1><a href="doubleclicksearch_v2.html">Search Ads 360 API</a> . <a href="doubleclicksearch_v2.conversion.html">conversion</a></h1> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 81 | <code><a href="#get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, campaignId=None, criterionId=None, x__xgafv=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 82 | <p class="firstline">Retrieves a list of conversions from a DoubleClick Search engine account.</p> |
| 83 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 84 | <code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 85 | <p class="firstline">Inserts a batch of new conversions into DoubleClick Search.</p> |
| 86 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 87 | <code><a href="#update">update(body=None, x__xgafv=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 88 | <p class="firstline">Updates a batch of conversions in DoubleClick Search.</p> |
| 89 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 90 | <code><a href="#updateAvailability">updateAvailability(body=None, x__xgafv=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 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"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 94 | <code class="details" id="close">close()</code> |
| 95 | <pre>Close httplib2 connections.</pre> |
| 96 | </div> |
| 97 | |
| 98 | <div class="method"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 99 | <code class="details" id="get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, campaignId=None, criterionId=None, x__xgafv=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 100 | <pre>Retrieves a list of conversions from a DoubleClick Search engine account. |
| 101 | |
| 102 | Args: |
| 103 | agencyId: string, Numeric ID of the agency. (required) |
| 104 | advertiserId: string, Numeric ID of the advertiser. (required) |
| 105 | engineAccountId: string, Numeric ID of the engine account. (required) |
| 106 | endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required) |
| 107 | rowCount: integer, The number of conversions to return per call. (required) |
| 108 | startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required) |
| 109 | startRow: integer, The 0-based starting index for retrieving conversions results. (required) |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 110 | adGroupId: string, Numeric ID of the ad group. |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 111 | adId: string, Numeric ID of the ad. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 112 | campaignId: string, Numeric ID of the campaign. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 113 | criterionId: string, Numeric ID of the criterion. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 114 | x__xgafv: string, V1 error format. |
| 115 | Allowed values |
| 116 | 1 - v1 error format |
| 117 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 118 | |
| 119 | Returns: |
| 120 | An object of the form: |
| 121 | |
| 122 | { # A list of conversions. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 123 | "conversion": [ # The conversions being requested. |
| 124 | { # A conversion containing data relevant to DoubleClick Search. |
| 125 | "adGroupId": "A String", # DS ad group ID. |
| 126 | "adId": "A String", # DS ad ID. |
| 127 | "advertiserId": "A String", # DS advertiser ID. |
| 128 | "agencyId": "A String", # DS agency ID. |
| 129 | "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. |
| 130 | "campaignId": "A String", # DS campaign ID. |
| 131 | "channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store |
| 132 | "clickId": "A String", # DS click ID for the conversion. |
| 133 | "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. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser's Floodlight instructions. |
| 134 | "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. |
| 135 | "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. |
| 136 | "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. |
| 137 | "criterionId": "A String", # DS criterion (keyword) ID. |
| 138 | "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. |
| 139 | "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. |
| 140 | { # A message containing the custom dimension. |
| 141 | "name": "A String", # Custom dimension name. |
| 142 | "value": "A String", # Custom dimension value. |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 143 | }, |
| 144 | ], |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 145 | "customMetric": [ # Custom metrics for the conversion. |
| 146 | { # A message containing the custom metric. |
| 147 | "name": "A String", # Custom metric name. |
| 148 | "value": 3.14, # Custom metric numeric value. |
| 149 | }, |
| 150 | ], |
| 151 | "deviceType": "A String", # The type of device on which the conversion occurred. |
| 152 | "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. |
| 153 | "engineAccountId": "A String", # DS engine account ID. |
| 154 | "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion. |
| 155 | "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product. |
| 156 | "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. |
| 157 | "productGroupId": "A String", # DS product group ID. |
| 158 | "productId": "A String", # The product ID (SKU). |
| 159 | "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. |
| 160 | "quantityMillis": "A String", # The quantity of this conversion, in millis. |
| 161 | "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. |
| 162 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 163 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 164 | "segmentationType": "A String", # The segmentation type of this conversion (for example, `FLOODLIGHT`). |
| 165 | "state": "A String", # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated. |
| 166 | "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "`local`". |
| 167 | "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`). |
| 168 | }, |
| 169 | ], |
| 170 | "kind": "A String", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. |
| 171 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 172 | </div> |
| 173 | |
| 174 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 175 | <code class="details" id="insert">insert(body=None, x__xgafv=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 176 | <pre>Inserts a batch of new conversions into DoubleClick Search. |
| 177 | |
| 178 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 179 | body: object, The request body. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 180 | The object takes the form of: |
| 181 | |
| 182 | { # A list of conversions. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 183 | "conversion": [ # The conversions being requested. |
| 184 | { # A conversion containing data relevant to DoubleClick Search. |
| 185 | "adGroupId": "A String", # DS ad group ID. |
| 186 | "adId": "A String", # DS ad ID. |
| 187 | "advertiserId": "A String", # DS advertiser ID. |
| 188 | "agencyId": "A String", # DS agency ID. |
| 189 | "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. |
| 190 | "campaignId": "A String", # DS campaign ID. |
| 191 | "channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store |
| 192 | "clickId": "A String", # DS click ID for the conversion. |
| 193 | "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. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser's Floodlight instructions. |
| 194 | "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. |
| 195 | "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. |
| 196 | "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. |
| 197 | "criterionId": "A String", # DS criterion (keyword) ID. |
| 198 | "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. |
| 199 | "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. |
| 200 | { # A message containing the custom dimension. |
| 201 | "name": "A String", # Custom dimension name. |
| 202 | "value": "A String", # Custom dimension value. |
| 203 | }, |
| 204 | ], |
| 205 | "customMetric": [ # Custom metrics for the conversion. |
| 206 | { # A message containing the custom metric. |
| 207 | "name": "A String", # Custom metric name. |
| 208 | "value": 3.14, # Custom metric numeric value. |
| 209 | }, |
| 210 | ], |
| 211 | "deviceType": "A String", # The type of device on which the conversion occurred. |
| 212 | "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. |
| 213 | "engineAccountId": "A String", # DS engine account ID. |
| 214 | "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion. |
| 215 | "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product. |
| 216 | "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. |
| 217 | "productGroupId": "A String", # DS product group ID. |
| 218 | "productId": "A String", # The product ID (SKU). |
| 219 | "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. |
| 220 | "quantityMillis": "A String", # The quantity of this conversion, in millis. |
| 221 | "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. |
| 222 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 223 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 224 | "segmentationType": "A String", # The segmentation type of this conversion (for example, `FLOODLIGHT`). |
| 225 | "state": "A String", # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated. |
| 226 | "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "`local`". |
| 227 | "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`). |
| 228 | }, |
| 229 | ], |
| 230 | "kind": "A String", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. |
| 231 | } |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 232 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 233 | x__xgafv: string, V1 error format. |
| 234 | Allowed values |
| 235 | 1 - v1 error format |
| 236 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 237 | |
| 238 | Returns: |
| 239 | An object of the form: |
| 240 | |
| 241 | { # A list of conversions. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 242 | "conversion": [ # The conversions being requested. |
| 243 | { # A conversion containing data relevant to DoubleClick Search. |
| 244 | "adGroupId": "A String", # DS ad group ID. |
| 245 | "adId": "A String", # DS ad ID. |
| 246 | "advertiserId": "A String", # DS advertiser ID. |
| 247 | "agencyId": "A String", # DS agency ID. |
| 248 | "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. |
| 249 | "campaignId": "A String", # DS campaign ID. |
| 250 | "channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store |
| 251 | "clickId": "A String", # DS click ID for the conversion. |
| 252 | "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. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser's Floodlight instructions. |
| 253 | "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. |
| 254 | "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. |
| 255 | "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. |
| 256 | "criterionId": "A String", # DS criterion (keyword) ID. |
| 257 | "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. |
| 258 | "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. |
| 259 | { # A message containing the custom dimension. |
| 260 | "name": "A String", # Custom dimension name. |
| 261 | "value": "A String", # Custom dimension value. |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 262 | }, |
| 263 | ], |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 264 | "customMetric": [ # Custom metrics for the conversion. |
| 265 | { # A message containing the custom metric. |
| 266 | "name": "A String", # Custom metric name. |
| 267 | "value": 3.14, # Custom metric numeric value. |
| 268 | }, |
| 269 | ], |
| 270 | "deviceType": "A String", # The type of device on which the conversion occurred. |
| 271 | "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. |
| 272 | "engineAccountId": "A String", # DS engine account ID. |
| 273 | "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion. |
| 274 | "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product. |
| 275 | "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. |
| 276 | "productGroupId": "A String", # DS product group ID. |
| 277 | "productId": "A String", # The product ID (SKU). |
| 278 | "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. |
| 279 | "quantityMillis": "A String", # The quantity of this conversion, in millis. |
| 280 | "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. |
| 281 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 282 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 283 | "segmentationType": "A String", # The segmentation type of this conversion (for example, `FLOODLIGHT`). |
| 284 | "state": "A String", # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated. |
| 285 | "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "`local`". |
| 286 | "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`). |
| 287 | }, |
| 288 | ], |
| 289 | "kind": "A String", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. |
| 290 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 291 | </div> |
| 292 | |
| 293 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 294 | <code class="details" id="update">update(body=None, x__xgafv=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 295 | <pre>Updates a batch of conversions in DoubleClick Search. |
| 296 | |
| 297 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 298 | body: object, The request body. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 299 | The object takes the form of: |
| 300 | |
| 301 | { # A list of conversions. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 302 | "conversion": [ # The conversions being requested. |
| 303 | { # A conversion containing data relevant to DoubleClick Search. |
| 304 | "adGroupId": "A String", # DS ad group ID. |
| 305 | "adId": "A String", # DS ad ID. |
| 306 | "advertiserId": "A String", # DS advertiser ID. |
| 307 | "agencyId": "A String", # DS agency ID. |
| 308 | "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. |
| 309 | "campaignId": "A String", # DS campaign ID. |
| 310 | "channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store |
| 311 | "clickId": "A String", # DS click ID for the conversion. |
| 312 | "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. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser's Floodlight instructions. |
| 313 | "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. |
| 314 | "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. |
| 315 | "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. |
| 316 | "criterionId": "A String", # DS criterion (keyword) ID. |
| 317 | "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. |
| 318 | "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. |
| 319 | { # A message containing the custom dimension. |
| 320 | "name": "A String", # Custom dimension name. |
| 321 | "value": "A String", # Custom dimension value. |
| 322 | }, |
| 323 | ], |
| 324 | "customMetric": [ # Custom metrics for the conversion. |
| 325 | { # A message containing the custom metric. |
| 326 | "name": "A String", # Custom metric name. |
| 327 | "value": 3.14, # Custom metric numeric value. |
| 328 | }, |
| 329 | ], |
| 330 | "deviceType": "A String", # The type of device on which the conversion occurred. |
| 331 | "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. |
| 332 | "engineAccountId": "A String", # DS engine account ID. |
| 333 | "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion. |
| 334 | "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product. |
| 335 | "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. |
| 336 | "productGroupId": "A String", # DS product group ID. |
| 337 | "productId": "A String", # The product ID (SKU). |
| 338 | "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. |
| 339 | "quantityMillis": "A String", # The quantity of this conversion, in millis. |
| 340 | "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. |
| 341 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 342 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 343 | "segmentationType": "A String", # The segmentation type of this conversion (for example, `FLOODLIGHT`). |
| 344 | "state": "A String", # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated. |
| 345 | "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "`local`". |
| 346 | "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`). |
| 347 | }, |
| 348 | ], |
| 349 | "kind": "A String", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. |
| 350 | } |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 351 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 352 | x__xgafv: string, V1 error format. |
| 353 | Allowed values |
| 354 | 1 - v1 error format |
| 355 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 356 | |
| 357 | Returns: |
| 358 | An object of the form: |
| 359 | |
| 360 | { # A list of conversions. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 361 | "conversion": [ # The conversions being requested. |
| 362 | { # A conversion containing data relevant to DoubleClick Search. |
| 363 | "adGroupId": "A String", # DS ad group ID. |
| 364 | "adId": "A String", # DS ad ID. |
| 365 | "advertiserId": "A String", # DS advertiser ID. |
| 366 | "agencyId": "A String", # DS agency ID. |
| 367 | "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. |
| 368 | "campaignId": "A String", # DS campaign ID. |
| 369 | "channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store |
| 370 | "clickId": "A String", # DS click ID for the conversion. |
| 371 | "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. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser's Floodlight instructions. |
| 372 | "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. |
| 373 | "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. |
| 374 | "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support. |
| 375 | "criterionId": "A String", # DS criterion (keyword) ID. |
| 376 | "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. |
| 377 | "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report. |
| 378 | { # A message containing the custom dimension. |
| 379 | "name": "A String", # Custom dimension name. |
| 380 | "value": "A String", # Custom dimension value. |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 381 | }, |
| 382 | ], |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 383 | "customMetric": [ # Custom metrics for the conversion. |
| 384 | { # A message containing the custom metric. |
| 385 | "name": "A String", # Custom metric name. |
| 386 | "value": 3.14, # Custom metric numeric value. |
| 387 | }, |
| 388 | ], |
| 389 | "deviceType": "A String", # The type of device on which the conversion occurred. |
| 390 | "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion. |
| 391 | "engineAccountId": "A String", # DS engine account ID. |
| 392 | "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion. |
| 393 | "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product. |
| 394 | "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. |
| 395 | "productGroupId": "A String", # DS product group ID. |
| 396 | "productId": "A String", # The product ID (SKU). |
| 397 | "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. |
| 398 | "quantityMillis": "A String", # The quantity of this conversion, in millis. |
| 399 | "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. |
| 400 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 401 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 402 | "segmentationType": "A String", # The segmentation type of this conversion (for example, `FLOODLIGHT`). |
| 403 | "state": "A String", # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated. |
| 404 | "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "`local`". |
| 405 | "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`). |
| 406 | }, |
| 407 | ], |
| 408 | "kind": "A String", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. |
| 409 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 410 | </div> |
| 411 | |
| 412 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 413 | <code class="details" id="updateAvailability">updateAvailability(body=None, x__xgafv=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 414 | <pre>Updates the availabilities of a batch of floodlight activities in DoubleClick Search. |
| 415 | |
| 416 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 417 | body: object, The request body. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 418 | The object takes the form of: |
| 419 | |
| 420 | { # The request to update availability. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 421 | "availabilities": [ # The availabilities being requested. |
| 422 | { # A message containing availability data relevant to DoubleClick Search. |
| 423 | "advertiserId": "A String", # DS advertiser ID. |
| 424 | "agencyId": "A String", # DS agency ID. |
| 425 | "availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC. |
| 426 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 427 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 428 | "segmentationType": "A String", # The segmentation type that this availability is for (its default value is `FLOODLIGHT`). |
| 429 | }, |
| 430 | ], |
| 431 | } |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 432 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 433 | x__xgafv: string, V1 error format. |
| 434 | Allowed values |
| 435 | 1 - v1 error format |
| 436 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 437 | |
| 438 | Returns: |
| 439 | An object of the form: |
| 440 | |
| 441 | { # The response to a update availability request. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 442 | "availabilities": [ # The availabilities being returned. |
| 443 | { # A message containing availability data relevant to DoubleClick Search. |
| 444 | "advertiserId": "A String", # DS advertiser ID. |
| 445 | "agencyId": "A String", # DS agency ID. |
| 446 | "availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC. |
| 447 | "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). |
| 448 | "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). |
| 449 | "segmentationType": "A String", # The segmentation type that this availability is for (its default value is `FLOODLIGHT`). |
| 450 | }, |
| 451 | ], |
| 452 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 453 | </div> |
| 454 | |
| 455 | </body></html> |