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-11-25 07:50:41 -0800

[diff] [blame]

99

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

Dmitry Frenkel

3e17f89

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

[diff] [blame]

110

criterionId: string, Numeric ID of the criterion.

Yoshi Automation Bot

c2228be

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

[diff] [blame]

111

campaignId: string, Numeric ID of the campaign.

Yoshi Automation Bot

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

[diff] [blame]

112

adGroupId: string, Numeric ID of the ad group.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

113

adId: string, Numeric ID of the ad.

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-11-25 07:50:41 -0800

[diff] [blame]

123

"conversion": [ # The conversions being requested.

124

{ # A conversion containing data relevant to DoubleClick Search.

125

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

126

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

127

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

128

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

129

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

130

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

131

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

132

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

133

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

134

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

135

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

136

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

137

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

138

{ # A message containing the custom metric.

139

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

140

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

141

},

142

],

143

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

144

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

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

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

148

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

149

},

150

],

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

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

167

"type": "A String", # The type of the conversion, that is, either `ACTION` or `TRANSACTION`. An `ACTION` conversion is an action by the user that has no monetarily quantifiable value, while a `TRANSACTION` conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (`ACTION`) versus ecommerce purchases (`TRANSACTION`).

168

},

169

],

170

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

171

}</pre>

John Asmuth

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-11-25 07:50:41 -0800

[diff] [blame]

183

"conversion": [ # The conversions being requested.

184

{ # A conversion containing data relevant to DoubleClick Search.

185

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

186

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

187

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

188

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

189

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

190

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

191

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

192

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

193

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

194

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

195

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

196

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

197

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

198

{ # A message containing the custom metric.

199

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

200

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

201

},

202

],

203

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

204

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

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

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

208

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

209

},

210

],

211

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

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

"type": "A String", # The type of the conversion, that is, either `ACTION` or `TRANSACTION`. An `ACTION` conversion is an action by the user that has no monetarily quantifiable value, while a `TRANSACTION` conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (`ACTION`) versus ecommerce purchases (`TRANSACTION`).

228

},

229

],

230

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

231

}

John Asmuth

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-11-25 07:50:41 -0800

[diff] [blame]

242

"conversion": [ # The conversions being requested.

243

{ # A conversion containing data relevant to DoubleClick Search.

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

{ # A message containing the custom metric.

258

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

259

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

260

},

261

],

262

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

263

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

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

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

267

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

268

},

269

],

270

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

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

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

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

284

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

285

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

286

"type": "A String", # The type of the conversion, that is, either `ACTION` or `TRANSACTION`. An `ACTION` conversion is an action by the user that has no monetarily quantifiable value, while a `TRANSACTION` conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (`ACTION`) versus ecommerce purchases (`TRANSACTION`).

287

},

288

],

289

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

290

}</pre>

John Asmuth

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-11-25 07:50:41 -0800

[diff] [blame]

302

"conversion": [ # The conversions being requested.

303

{ # A conversion containing data relevant to DoubleClick Search.

304

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

305

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

306

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

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. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser's Floodlight instructions.

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

{ # A message containing the custom metric.

318

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

319

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

320

},

321

],

322

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

323

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

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

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

327

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

328

},

329

],

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

"type": "A String", # The type of the conversion, that is, either `ACTION` or `TRANSACTION`. An `ACTION` conversion is an action by the user that has no monetarily quantifiable value, while a `TRANSACTION` conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (`ACTION`) versus ecommerce purchases (`TRANSACTION`).

347

},

348

],

349

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

350

}

John Asmuth

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-11-25 07:50:41 -0800

[diff] [blame]

361

"conversion": [ # The conversions being requested.

362

{ # A conversion containing data relevant to DoubleClick Search.

363

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

364

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

365

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

366

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

367

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

368

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

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

{ # A message containing the custom metric.

377

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

378

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

379

},

380

],

381

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

382

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

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

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

386

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

387

},

388

],

389

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

390

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

391

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

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

"type": "A String", # The type of the conversion, that is, either `ACTION` or `TRANSACTION`. An `ACTION` conversion is an action by the user that has no monetarily quantifiable value, while a `TRANSACTION` conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (`ACTION`) versus ecommerce purchases (`TRANSACTION`).

406

},

407

],

408

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

409

}</pre>

John Asmuth

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.

Yoshi Automation Bot

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

[diff] [blame]

423

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

424

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

Yoshi Automation Bot

c2228be

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

[diff] [blame]

425

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

Yoshi Automation Bot

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

[diff] [blame]

426

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

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

427

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

Yoshi Automation Bot

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

[diff] [blame]

428

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

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.

Yoshi Automation Bot

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

[diff] [blame]

444

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

445

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

Yoshi Automation Bot

c2228be

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

[diff] [blame]

446

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

Yoshi Automation Bot

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

[diff] [blame]

447

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

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

448

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

Yoshi Automation Bot

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

[diff] [blame]

449

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

John Asmuth