Blame - docs/dyn/doubleclicksearch_v2.conversion.html - platform/external/python/google-api-python-client

2014-04-24 15:46:26 -0400

[diff] [blame]

79

<p class="firstline">Retrieves a list of conversions from a DoubleClick Search engine account.</p>

80

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

81

<code><a href="#insert">insert(body=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

82

<p class="firstline">Inserts a batch of new conversions into DoubleClick Search.</p>

83

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

84

<code><a href="#update">update(body=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

85

<p class="firstline">Updates a batch of conversions in DoubleClick Search.</p>

86

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

87

<code><a href="#updateAvailability">updateAvailability(body=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

88

<p class="firstline">Updates the availabilities of a batch of floodlight activities in DoubleClick Search.</p>

89

<h3>Method Details</h3>

90

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

91

<code class="details" id="get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, campaignId=None, criterionId=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

92

<pre>Retrieves a list of conversions from a DoubleClick Search engine account.

93

94

Args:

95

agencyId: string, Numeric ID of the agency. (required)

96

advertiserId: string, Numeric ID of the advertiser. (required)

97

engineAccountId: string, Numeric ID of the engine account. (required)

98

endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)

99

rowCount: integer, The number of conversions to return per call. (required)

100

startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)

101

startRow: integer, The 0-based starting index for retrieving conversions results. (required)

102

adGroupId: string, Numeric ID of the ad group.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

103

adId: string, Numeric ID of the ad.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

104

campaignId: string, Numeric ID of the campaign.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

105

criterionId: string, Numeric ID of the criterion.

106

107

Returns:

108

An object of the form:

109

110

{ # A list of conversions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

111

"conversion": [ # The conversions being requested.

112

{ # A conversion containing data relevant to DoubleClick Search.

113

"adGroupId": "A String", # DS ad group ID.

114

"adId": "A String", # DS ad ID.

115

"advertiserId": "A String", # DS advertiser ID.

116

"agencyId": "A String", # DS agency ID.

117

"attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.

118

"campaignId": "A String", # DS campaign ID.

119

"channel": "A String", # Sales channel for the product. Acceptable values are:

120

# - "local": a physical store

121

# - "online": an online store

122

"clickId": "A String", # DS click ID for the conversion.

123

"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.

124

# For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.

125

"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.

126

"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.

127

"countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.

128

"criterionId": "A String", # DS criterion (keyword) ID.

129

"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.

130

"customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.

131

{ # A message containing the custome dimension.

132

"name": "A String", # Custom dimension name.

133

"value": "A String", # Custom dimension value.

134

},

135

],

136

"customMetric": [ # Custom metrics for the conversion.

137

{ # A message containing the custome metric.

138

"name": "A String", # Custom metric name.

139

"value": 3.14, # Custom metric numeric value.

140

},

141

],

142

"deviceType": "A String", # The type of device on which the conversion occurred.

143

"dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.

144

"engineAccountId": "A String", # DS engine account ID.

145

"floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.

146

"inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.

147

"productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.

148

"productGroupId": "A String", # DS product group ID.

149

"productId": "A String", # The product ID (SKU).

150

"productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.

151

"quantityMillis": "A String", # The quantity of this conversion, in millis.

152

"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.

153

"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).

154

"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).

155

"segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).

156

"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.

157

"storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".

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

},

160

],

161

"kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.

162

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

166

<code class="details" id="insert">insert(body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

167

<pre>Inserts a batch of new conversions into DoubleClick Search.

168

169

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

170

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

171

The object takes the form of:

172

173

{ # A list of conversions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

174

"conversion": [ # The conversions being requested.

175

{ # A conversion containing data relevant to DoubleClick Search.

176

"adGroupId": "A String", # DS ad group ID.

177

"adId": "A String", # DS ad ID.

178

"advertiserId": "A String", # DS advertiser ID.

179

"agencyId": "A String", # DS agency ID.

180

"attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.

181

"campaignId": "A String", # DS campaign ID.

182

"channel": "A String", # Sales channel for the product. Acceptable values are:

183

# - "local": a physical store

184

# - "online": an online store

185

"clickId": "A String", # DS click ID for the conversion.

186

"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.

187

# For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.

188

"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.

189

"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.

190

"countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.

191

"criterionId": "A String", # DS criterion (keyword) ID.

192

"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.

193

"customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.

194

{ # A message containing the custome dimension.

195

"name": "A String", # Custom dimension name.

196

"value": "A String", # Custom dimension value.

197

},

198

],

199

"customMetric": [ # Custom metrics for the conversion.

200

{ # A message containing the custome metric.

201

"name": "A String", # Custom metric name.

202

"value": 3.14, # Custom metric numeric value.

203

},

204

],

205

"deviceType": "A String", # The type of device on which the conversion occurred.

206

"dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.

207

"engineAccountId": "A String", # DS engine account ID.

208

"floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.

209

"inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.

210

"productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.

211

"productGroupId": "A String", # DS product group ID.

212

"productId": "A String", # The product ID (SKU).

213

"productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.

214

"quantityMillis": "A String", # The quantity of this conversion, in millis.

215

"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.

216

"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).

217

"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).

218

"segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).

219

"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.

220

"storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".

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

},

223

],

224

"kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.

225

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

Returns:

An object of the form:

230

231

{ # A list of conversions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

232

"conversion": [ # The conversions being requested.

233

{ # A conversion containing data relevant to DoubleClick Search.

234

"adGroupId": "A String", # DS ad group ID.

235

"adId": "A String", # DS ad ID.

236

"advertiserId": "A String", # DS advertiser ID.

237

"agencyId": "A String", # DS agency ID.

238

"attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.

239

"campaignId": "A String", # DS campaign ID.

240

"channel": "A String", # Sales channel for the product. Acceptable values are:

241

# - "local": a physical store

242

# - "online": an online store

243

"clickId": "A String", # DS click ID for the conversion.

244

"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.

245

# For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.

246

"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.

247

"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.

248

"countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.

249

"criterionId": "A String", # DS criterion (keyword) ID.

250

"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.

251

"customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.

252

{ # A message containing the custome dimension.

253

"name": "A String", # Custom dimension name.

254

"value": "A String", # Custom dimension value.

255

},

256

],

257

"customMetric": [ # Custom metrics for the conversion.

258

{ # A message containing the custome metric.

259

"name": "A String", # Custom metric name.

260

"value": 3.14, # Custom metric numeric value.

261

},

262

],

263

"deviceType": "A String", # The type of device on which the conversion occurred.

264

"dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.

265

"engineAccountId": "A String", # DS engine account ID.

266

"floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.

267

"inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.

268

"productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.

269

"productGroupId": "A String", # DS product group ID.

270

"productId": "A String", # The product ID (SKU).

271

"productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.

272

"quantityMillis": "A String", # The quantity of this conversion, in millis.

273

"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.

274

"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).

275

"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).

276

"segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).

277

"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.

278

"storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".

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

},

281

],

282

"kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.

283

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

287

<code class="details" id="update">update(body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

288

<pre>Updates a batch of conversions in DoubleClick Search.

289

290

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

291

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

292

The object takes the form of:

293

294

{ # A list of conversions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

295

"conversion": [ # The conversions being requested.

296

{ # A conversion containing data relevant to DoubleClick Search.

297

"adGroupId": "A String", # DS ad group ID.

298

"adId": "A String", # DS ad ID.

299

"advertiserId": "A String", # DS advertiser ID.

300

"agencyId": "A String", # DS agency ID.

301

"attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.

302

"campaignId": "A String", # DS campaign ID.

303

"channel": "A String", # Sales channel for the product. Acceptable values are:

304

# - "local": a physical store

305

# - "online": an online store

306

"clickId": "A String", # DS click ID for the conversion.

307

"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.

308

# For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.

309

"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.

310

"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.

311

"countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.

312

"criterionId": "A String", # DS criterion (keyword) ID.

313

"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.

314

"customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.

315

{ # A message containing the custome dimension.

316

"name": "A String", # Custom dimension name.

317

"value": "A String", # Custom dimension value.

318

},

319

],

320

"customMetric": [ # Custom metrics for the conversion.

321

{ # A message containing the custome metric.

322

"name": "A String", # Custom metric name.

323

"value": 3.14, # Custom metric numeric value.

324

},

325

],

326

"deviceType": "A String", # The type of device on which the conversion occurred.

327

"dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.

328

"engineAccountId": "A String", # DS engine account ID.

329

"floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.

330

"inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.

331

"productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.

332

"productGroupId": "A String", # DS product group ID.

333

"productId": "A String", # The product ID (SKU).

334

"productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.

335

"quantityMillis": "A String", # The quantity of this conversion, in millis.

336

"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.

337

"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).

338

"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).

339

"segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).

340

"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.

341

"storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".

342

"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).

343

},

344

],

345

"kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.

346

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

Returns:

An object of the form:

351

352

{ # A list of conversions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

353

"conversion": [ # The conversions being requested.

354

{ # A conversion containing data relevant to DoubleClick Search.

355

"adGroupId": "A String", # DS ad group ID.

356

"adId": "A String", # DS ad ID.

357

"advertiserId": "A String", # DS advertiser ID.

358

"agencyId": "A String", # DS agency ID.

359

"attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.

360

"campaignId": "A String", # DS campaign ID.

361

"channel": "A String", # Sales channel for the product. Acceptable values are:

362

# - "local": a physical store

363

# - "online": an online store

364

"clickId": "A String", # DS click ID for the conversion.

365

"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.

366

# For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.

367

"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.

368

"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.

369

"countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.

370

"criterionId": "A String", # DS criterion (keyword) ID.

371

"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.

372

"customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.

373

{ # A message containing the custome dimension.

374

"name": "A String", # Custom dimension name.

375

"value": "A String", # Custom dimension value.

376

},

377

],

378

"customMetric": [ # Custom metrics for the conversion.

379

{ # A message containing the custome metric.

380

"name": "A String", # Custom metric name.

381

"value": 3.14, # Custom metric numeric value.

382

},

383

],

384

"deviceType": "A String", # The type of device on which the conversion occurred.

385

"dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.

386

"engineAccountId": "A String", # DS engine account ID.

387

"floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.

388

"inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.

389

"productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.

390

"productGroupId": "A String", # DS product group ID.

391

"productId": "A String", # The product ID (SKU).

392

"productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.

393

"quantityMillis": "A String", # The quantity of this conversion, in millis.

394

"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.

395

"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).

396

"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).

397

"segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).

398

"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.

399

"storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".

400

"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).

401

},

402

],

403

"kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.

404

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

408

<code class="details" id="updateAvailability">updateAvailability(body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

409

<pre>Updates the availabilities of a batch of floodlight activities in DoubleClick Search.

410

411

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

412

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

413

The object takes the form of:

414

415

{ # The request to update availability.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

416

"availabilities": [ # The availabilities being requested.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

417

{ # A message containing availability data relevant to DoubleClick Search.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

418

"advertiserId": "A String", # DS advertiser ID.

419

"agencyId": "A String", # DS agency ID.

420

"availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC.

421

"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).

422

"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).

423

"segmentationType": "A String", # The segmentation type that this availability is for (its default value is FLOODLIGHT).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

},

],

}

Returns:

An object of the form:

431

432

{ # The response to a update availability request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

433

"availabilities": [ # The availabilities being returned.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

434

{ # A message containing availability data relevant to DoubleClick Search.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

435

"advertiserId": "A String", # DS advertiser ID.

436

"agencyId": "A String", # DS agency ID.

437

"availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC.

438

"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).

439

"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).

440

"segmentationType": "A String", # The segmentation type that this availability is for (its default value is FLOODLIGHT).

John Asmuth