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

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

Bu Sun Kim

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

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

[diff] [blame]

85

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

86

Bu Sun Kim

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

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

[diff] [blame]

88

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

89

Bu Sun Kim

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

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

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>

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

99

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

John Asmuth

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

2020-12-09 08:56:03 -0800

[diff] [blame]

110

adGroupId: string, Numeric ID of the ad group.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

111

criterionId: string, Numeric ID of the criterion.

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

112

adId: string, Numeric ID of the ad.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

113

campaignId: string, Numeric ID of the campaign.

Bu Sun Kim

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

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

2020-12-09 08:56:03 -0800

[diff] [blame]

123

"conversion": [ # The conversions being requested.

124

{ # A conversion containing data relevant to DoubleClick Search.

125

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

126

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

127

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

128

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

129

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

130

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

131

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

132

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

133

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

134

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

135

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

136

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

137

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

138

{ # A message containing the custom dimension.

139

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

140

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

141

},

142

],

143

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

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

{ # A message containing the custom metric.

154

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

155

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

156

},

157

],

158

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

159

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

160

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

161

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

162

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

163

"channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store

164

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

165

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

166

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

167

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

168

},

169

],

170

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

171

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

175

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

John Asmuth

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

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

2020-12-09 08:56:03 -0800

[diff] [blame]

183

"conversion": [ # The conversions being requested.

184

{ # A conversion containing data relevant to DoubleClick Search.

185

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

186

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

187

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

188

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

189

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

190

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

191

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

192

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

193

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

194

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

195

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

196

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

197

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

198

{ # A message containing the custom dimension.

199

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

200

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

201

},

202

],

203

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

204

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

205

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

206

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

207

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

208

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

209

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

210

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

211

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

212

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

213

{ # A message containing the custom metric.

214

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

215

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

216

},

217

],

218

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

219

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

220

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

221

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

222

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

223

"channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store

224

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

225

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

226

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

227

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

228

},

229

],

230

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

231

}

John Asmuth

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

[diff] [blame]

232

Bu Sun Kim

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

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

2020-12-09 08:56:03 -0800

[diff] [blame]

242

"conversion": [ # The conversions being requested.

243

{ # A conversion containing data relevant to DoubleClick Search.

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

{ # A message containing the custom dimension.

258

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

259

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

260

},

261

],

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

{ # A message containing the custom metric.

273

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

274

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

275

},

276

],

277

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

278

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

279

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

280

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

281

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

282

"channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store

283

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

284

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

285

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

286

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

287

},

288

],

289

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

290

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

294

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

John Asmuth

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

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

2020-12-09 08:56:03 -0800

[diff] [blame]

302

"conversion": [ # The conversions being requested.

303

{ # A conversion containing data relevant to DoubleClick Search.

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

{ # A message containing the custom dimension.

318

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

319

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

320

},

321

],

322

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

323

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

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

{ # A message containing the custom metric.

333

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

334

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

335

},

336

],

337

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

338

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

339

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

340

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

341

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

342

"channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store

343

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

344

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

345

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

346

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

347

},

348

],

349

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

350

}

John Asmuth

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

[diff] [blame]

351

Bu Sun Kim

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

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

2020-12-09 08:56:03 -0800

[diff] [blame]

361

"conversion": [ # The conversions being requested.

362

{ # A conversion containing data relevant to DoubleClick Search.

363

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

364

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

365

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

366

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

367

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

368

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

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

{ # A message containing the custom dimension.

377

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

378

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

379

},

380

],

381

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

382

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

383

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

384

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

385

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

386

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

387

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

388

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

389

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

390

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

391

{ # A message containing the custom metric.

392

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

393

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

394

},

395

],

396

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

397

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

398

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

399

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

400

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

401

"channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store

402

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

403

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

404

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

405

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

406

},

407

],

408

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

409

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

413

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

John Asmuth

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

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

[diff] [blame]

418

The object takes the form of:

419

420

{ # The request to update availability.

Bu Sun Kim

6502091

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

[diff] [blame]

421

"availabilities": [ # The availabilities being requested.

John Asmuth

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

[diff] [blame]

422

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

423

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

424

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

425

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

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

426

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

427

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

428

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

},

],

}

Bu Sun Kim

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

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.

Bu Sun Kim

6502091

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

[diff] [blame]

442

"availabilities": [ # The availabilities being returned.

John Asmuth

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

[diff] [blame]

443

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

444

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

445

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

446

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

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

447

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

448

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

449

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

John Asmuth