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