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

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

[diff] [blame]

94

<code class="details" id="close">close()</code>

95

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

110

campaignId: string, Numeric ID of the campaign.

Dmitry Frenkel

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

[diff] [blame]

111

criterionId: string, Numeric ID of the criterion.

Bu Sun Kim

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

[diff] [blame]

112

adGroupId: string, Numeric ID of the ad group.

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.

Bu Sun Kim

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

[diff] [blame]

123

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

Bu Sun Kim

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

[diff] [blame]

124

"conversion": [ # The conversions being requested.

125

{ # A conversion containing data relevant to DoubleClick Search.

Bu Sun Kim

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

[diff] [blame]

126

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

127

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

128

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

129

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

130

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

Bu Sun Kim

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

[diff] [blame]

131

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

132

{ # A message containing the custom metric.

Bu Sun Kim

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

[diff] [blame]

133

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

Dmitry Frenkel

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

[diff] [blame]

134

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

Bu Sun Kim

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

[diff] [blame]

135

},

136

],

Bu Sun Kim

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

[diff] [blame]

137

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

138

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

139

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

Bu Sun Kim

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

[diff] [blame]

140

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

Bu Sun Kim

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

[diff] [blame]

141

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

142

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

143

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

144

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

145

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

Dmitry Frenkel

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

[diff] [blame]

146

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

Bu Sun Kim

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

[diff] [blame]

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

Bu Sun Kim

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

[diff] [blame]

156

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

157

{ # A message containing the custom dimension.

158

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

159

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

160

},

161

],

Bu Sun Kim

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

[diff] [blame]

162

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

163

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

Dmitry Frenkel

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

[diff] [blame]

164

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

Bu Sun Kim

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

[diff] [blame]

165

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

166

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

167

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

168

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

Bu Sun Kim

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

[diff] [blame]

169

},

170

],

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.

Bu Sun Kim

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

[diff] [blame]

183

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

Bu Sun Kim

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

[diff] [blame]

184

"conversion": [ # The conversions being requested.

185

{ # A conversion containing data relevant to DoubleClick Search.

Bu Sun Kim

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

[diff] [blame]

186

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

187

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

188

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

189

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

190

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

Bu Sun Kim

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

[diff] [blame]

191

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

192

{ # A message containing the custom metric.

Bu Sun Kim

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

[diff] [blame]

193

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

Dmitry Frenkel

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

[diff] [blame]

194

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

Bu Sun Kim

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

[diff] [blame]

195

},

196

],

Bu Sun Kim

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

[diff] [blame]

197

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

198

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

199

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

Bu Sun Kim

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

[diff] [blame]

200

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

Bu Sun Kim

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

[diff] [blame]

201

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

202

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

203

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

204

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

205

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

Dmitry Frenkel

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

[diff] [blame]

206

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

Bu Sun Kim

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

[diff] [blame]

207

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

208

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

209

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

210

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

211

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

212

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

213

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

214

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

215

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

Bu Sun Kim

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

[diff] [blame]

216

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

217

{ # A message containing the custom dimension.

218

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

219

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

220

},

221

],

Bu Sun Kim

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

[diff] [blame]

222

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

223

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

Dmitry Frenkel

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

[diff] [blame]

224

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

Bu Sun Kim

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

[diff] [blame]

225

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

226

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

227

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

228

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

Bu Sun Kim

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

[diff] [blame]

229

},

230

],

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.

Bu Sun Kim

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

[diff] [blame]

242

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

Bu Sun Kim

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

[diff] [blame]

243

"conversion": [ # The conversions being requested.

244

{ # A conversion containing data relevant to DoubleClick Search.

Bu Sun Kim

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

[diff] [blame]

245

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

246

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

247

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

248

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

249

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

Bu Sun Kim

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

[diff] [blame]

250

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

251

{ # A message containing the custom metric.

Bu Sun Kim

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

[diff] [blame]

252

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

Dmitry Frenkel

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

[diff] [blame]

253

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

Bu Sun Kim

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

[diff] [blame]

254

},

255

],

Bu Sun Kim

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

[diff] [blame]

256

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

257

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

258

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

Bu Sun Kim

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

[diff] [blame]

259

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

Bu Sun Kim

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

[diff] [blame]

260

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

261

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

262

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

263

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

264

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

Dmitry Frenkel

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

[diff] [blame]

265

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

Bu Sun Kim

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

[diff] [blame]

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

Bu Sun Kim

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

[diff] [blame]

275

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

276

{ # A message containing the custom dimension.

277

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

278

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

279

},

280

],

Bu Sun Kim

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

[diff] [blame]

281

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

282

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

Dmitry Frenkel

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

[diff] [blame]

283

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

Bu Sun Kim

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

[diff] [blame]

284

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

285

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

286

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

287

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

Bu Sun Kim

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

[diff] [blame]

288

},

289

],

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.

Bu Sun Kim

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

[diff] [blame]

302

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

Bu Sun Kim

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

[diff] [blame]

303

"conversion": [ # The conversions being requested.

304

{ # A conversion containing data relevant to DoubleClick Search.

Bu Sun Kim

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

[diff] [blame]

305

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

306

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

307

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

308

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

309

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

Bu Sun Kim

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

[diff] [blame]

310

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

311

{ # A message containing the custom metric.

Bu Sun Kim

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

[diff] [blame]

312

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

Dmitry Frenkel

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

[diff] [blame]

313

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

Bu Sun Kim

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

[diff] [blame]

314

},

315

],

Bu Sun Kim

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

[diff] [blame]

316

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

317

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

318

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

Bu Sun Kim

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

[diff] [blame]

319

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

Bu Sun Kim

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

[diff] [blame]

320

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

321

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

322

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

323

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

324

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

Dmitry Frenkel

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

[diff] [blame]

325

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

Bu Sun Kim

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

[diff] [blame]

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

Bu Sun Kim

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

[diff] [blame]

335

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

336

{ # A message containing the custom dimension.

337

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

338

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

339

},

340

],

Bu Sun Kim

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

[diff] [blame]

341

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

342

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

Dmitry Frenkel

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

[diff] [blame]

343

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

Bu Sun Kim

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

[diff] [blame]

344

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

345

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

346

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

347

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

Bu Sun Kim

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

[diff] [blame]

348

},

349

],

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.

Bu Sun Kim

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

[diff] [blame]

361

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

Bu Sun Kim

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

[diff] [blame]

362

"conversion": [ # The conversions being requested.

363

{ # A conversion containing data relevant to DoubleClick Search.

Bu Sun Kim

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

[diff] [blame]

364

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

365

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

366

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

367

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

368

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

Bu Sun Kim

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

[diff] [blame]

369

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

370

{ # A message containing the custom metric.

Bu Sun Kim

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

[diff] [blame]

371

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

Dmitry Frenkel

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

[diff] [blame]

372

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

Bu Sun Kim

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

[diff] [blame]

373

},

374

],

Bu Sun Kim

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

[diff] [blame]

375

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

376

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

377

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

Bu Sun Kim

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

[diff] [blame]

378

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

Bu Sun Kim

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

[diff] [blame]

379

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

380

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

381

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

382

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

383

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

Dmitry Frenkel

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

[diff] [blame]

384

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

Bu Sun Kim

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

[diff] [blame]

385

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

386

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

387

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

388

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

389

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

390

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

391

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

392

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

393

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

Bu Sun Kim

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

[diff] [blame]

394

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

395

{ # A message containing the custom dimension.

396

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

397

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

398

},

399

],

Bu Sun Kim

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

[diff] [blame]

400

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

401

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

Dmitry Frenkel

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

[diff] [blame]

402

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

Bu Sun Kim

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

[diff] [blame]

403

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

404

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

405

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

406

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

Bu Sun Kim

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

[diff] [blame]

407

},

408

],

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.

424

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

Bu Sun Kim

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

[diff] [blame]

425

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

Dmitry Frenkel

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

[diff] [blame]

426

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

Bu Sun Kim

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

[diff] [blame]

427

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

428

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

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.

445

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

Bu Sun Kim

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

[diff] [blame]

446

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

Dmitry Frenkel

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

[diff] [blame]

447

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

Bu Sun Kim

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

[diff] [blame]

448

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

449

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

John Asmuth