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

Bu Sun Kim

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

[diff] [blame]

81

<code><a href="#insert">insert(body=None, x__xgafv=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

Bu Sun Kim

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

[diff] [blame]

84

<code><a href="#update">update(body=None, x__xgafv=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

Bu Sun Kim

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

[diff] [blame]

87

<code><a href="#updateAvailability">updateAvailability(body=None, x__xgafv=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-07-22 17:02:09 -0700

[diff] [blame]

91

<code class="details" id="get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adId=None, criterionId=None, adGroupId=None, campaignId=None, x__xgafv=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)

John Asmuth

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

[diff] [blame]

102

adId: string, Numeric ID of the ad.

103

criterionId: string, Numeric ID of the criterion.

Bu Sun Kim

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

[diff] [blame]

104

adGroupId: string, Numeric ID of the ad group.

105

campaignId: string, Numeric ID of the campaign.

106

x__xgafv: string, V1 error format.

107

Allowed values

108

1 - v1 error format

109

2 - v2 error format

John Asmuth

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

[diff] [blame]

110

111

Returns:

112

An object of the form:

113

114

{ # A list of conversions.

Bu Sun Kim

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

[diff] [blame]

115

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

116

"conversion": [ # The conversions being requested.

117

{ # A conversion containing data relevant to DoubleClick Search.

118

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

119

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

120

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

121

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

122

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

123

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

124

{ # A message containing the custom metric.

125

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

126

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

127

},

128

],

129

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

130

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

131

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

132

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

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

{ # A message containing the custom dimension.

147

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

148

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

149

},

150

],

151

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

152

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

153

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

154

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

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

156

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

157

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

158

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

159

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

160

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

161

},

162

],

163

}</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]

167

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

John Asmuth

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

[diff] [blame]

168

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

169

170

Args:

Dan O'Meara

dd49464

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

[diff] [blame]

171

body: object, The request body.

John Asmuth

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

[diff] [blame]

172

The object takes the form of:

173

174

{ # A list of conversions.

Bu Sun Kim

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

[diff] [blame]

175

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

176

"conversion": [ # The conversions being requested.

177

{ # A conversion containing data relevant to DoubleClick Search.

178

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

179

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

180

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

181

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

182

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

183

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

184

{ # A message containing the custom metric.

185

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

186

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

187

},

188

],

189

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

190

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

191

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

192

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

193

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

194

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

195

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

196

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

197

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

198

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

199

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

200

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

201

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

202

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

203

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

204

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

205

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

206

{ # A message containing the custom dimension.

207

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

208

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

209

},

210

],

211

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

212

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

213

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

214

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

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

216

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

217

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

218

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

219

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

220

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

221

},

222

],

223

}

John Asmuth

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

[diff] [blame]

224

Bu Sun Kim

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

[diff] [blame]

225

x__xgafv: string, V1 error format.

226

Allowed values

227

1 - v1 error format

228

2 - v2 error format

John Asmuth

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

[diff] [blame]

229

230

Returns:

231

An object of the form:

232

233

{ # A list of conversions.

Bu Sun Kim

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

[diff] [blame]

234

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

235

"conversion": [ # The conversions being requested.

236

{ # A conversion containing data relevant to DoubleClick Search.

237

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

238

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

239

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

240

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

241

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

242

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

243

{ # A message containing the custom metric.

244

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

245

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

246

},

247

],

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

{ # A message containing the custom dimension.

266

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

267

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

268

},

269

],

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

},

281

],

282

}</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]

286

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

John Asmuth

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

[diff] [blame]

287

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

288

289

Args:

Dan O'Meara

dd49464

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

[diff] [blame]

290

body: object, The request body.

John Asmuth

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

[diff] [blame]

291

The object takes the form of:

292

293

{ # A list of conversions.

Bu Sun Kim

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

[diff] [blame]

294

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

295

"conversion": [ # The conversions being requested.

296

{ # A conversion containing data relevant to DoubleClick Search.

297

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

298

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

299

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

300

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

301

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

302

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

303

{ # A message containing the custom metric.

304

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

305

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

306

},

307

],

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

"revenueMicros": "A String", # The revenue amount of this `TRANSACTION` conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.

318

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

319

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

320

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

321

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

322

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

323

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

324

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

325

{ # A message containing the custom dimension.

326

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

327

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

328

},

329

],

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

},

341

],

342

}

John Asmuth

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

[diff] [blame]

343

Bu Sun Kim

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

[diff] [blame]

344

x__xgafv: string, V1 error format.

345

Allowed values

346

1 - v1 error format

347

2 - v2 error format

John Asmuth

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

[diff] [blame]

348

349

Returns:

350

An object of the form:

351

352

{ # A list of conversions.

Bu Sun Kim

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

[diff] [blame]

353

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

354

"conversion": [ # The conversions being requested.

355

{ # A conversion containing data relevant to DoubleClick Search.

356

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

357

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

358

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

359

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

360

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

361

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

362

{ # A message containing the custom metric.

363

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

364

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

365

},

366

],

367

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

368

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

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

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

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

{ # A message containing the custom dimension.

385

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

386

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

387

},

388

],

389

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

390

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

391

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

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

},

400

],

401

}</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]

405

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

John Asmuth

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

[diff] [blame]

406

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

407

408

Args:

Dan O'Meara

dd49464

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

[diff] [blame]

409

body: object, The request body.

John Asmuth

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

[diff] [blame]

410

The object takes the form of:

411

412

{ # The request to update availability.

Bu Sun Kim

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

[diff] [blame]

413

"availabilities": [ # The availabilities being requested.

John Asmuth

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

[diff] [blame]

414

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

Bu Sun Kim

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

[diff] [blame]

415

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

Bu Sun Kim

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

[diff] [blame]

416

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

Bu Sun Kim

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

[diff] [blame]

417

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

Bu Sun Kim

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

[diff] [blame]

418

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

Bu Sun Kim

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

[diff] [blame]

419

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

420

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

John Asmuth

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

[diff] [blame]

},

],

}

Bu Sun Kim

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

[diff] [blame]

425

x__xgafv: string, V1 error format.

426

Allowed values

427

1 - v1 error format

428

2 - v2 error format

John Asmuth

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

[diff] [blame]

429

430

Returns:

431

An object of the form:

432

433

{ # The response to a update availability request.

Bu Sun Kim

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

[diff] [blame]

434

"availabilities": [ # The availabilities being returned.

John Asmuth

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

[diff] [blame]

435

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

Bu Sun Kim

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

[diff] [blame]

436

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

Bu Sun Kim

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

[diff] [blame]

437

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

Bu Sun Kim

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

[diff] [blame]

438

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

Bu Sun Kim

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

[diff] [blame]

439

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

Bu Sun Kim

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

[diff] [blame]

440

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

441

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

John Asmuth