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>

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

John Asmuth

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

[diff] [blame]

110

adId: string, Numeric ID of the ad.

Bu Sun Kim

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

[diff] [blame]

111

adGroupId: string, Numeric ID of the ad group.

112

campaignId: string, Numeric ID of the campaign.

Dmitry Frenkel

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

[diff] [blame^]

113

criterionId: string, Numeric ID of the criterion.

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-07-22 17:02:09 -0700

[diff] [blame]

123

"conversion": [ # The conversions being requested.

124

{ # A conversion containing data relevant to DoubleClick Search.

Dmitry Frenkel

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

[diff] [blame^]

125

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

126

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

Bu Sun Kim

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

[diff] [blame]

127

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

Dmitry Frenkel

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

[diff] [blame^]

128

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

Bu Sun Kim

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

[diff] [blame]

129

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

Dmitry Frenkel

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

[diff] [blame^]

130

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

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

],

Dmitry Frenkel

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

[diff] [blame^]

137

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

138

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

139

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

140

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

Bu Sun Kim

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

[diff] [blame]

141

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

Dmitry Frenkel

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

[diff] [blame^]

142

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

143

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

Bu Sun Kim

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

[diff] [blame]

144

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

145

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

Dmitry Frenkel

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

[diff] [blame^]

146

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

147

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

148

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

Bu Sun Kim

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

[diff] [blame]

149

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

150

{ # A message containing the custom dimension.

151

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

152

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

153

},

154

],

Dmitry Frenkel

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

[diff] [blame^]

155

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

156

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

Bu Sun Kim

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

[diff] [blame]

157

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

Dmitry Frenkel

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

[diff] [blame^]

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

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

167

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

Bu Sun Kim

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

[diff] [blame]

168

},

169

],

Dmitry Frenkel

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

[diff] [blame^]

170

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

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-07-22 17:02:09 -0700

[diff] [blame]

183

"conversion": [ # The conversions being requested.

184

{ # A conversion containing data relevant to DoubleClick Search.

Dmitry Frenkel

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

[diff] [blame^]

185

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

186

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

Bu Sun Kim

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

[diff] [blame]

187

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

Dmitry Frenkel

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

[diff] [blame^]

188

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

Bu Sun Kim

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

[diff] [blame]

189

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

Dmitry Frenkel

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

[diff] [blame^]

190

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

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

],

Dmitry Frenkel

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

[diff] [blame^]

197

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

198

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

199

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

200

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

Bu Sun Kim

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

[diff] [blame]

201

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

Dmitry Frenkel

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

[diff] [blame^]

202

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

203

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

Bu Sun Kim

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

[diff] [blame]

204

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

205

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

Dmitry Frenkel

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

[diff] [blame^]

206

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

207

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

208

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

Bu Sun Kim

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

[diff] [blame]

209

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

210

{ # A message containing the custom dimension.

211

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

212

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

213

},

214

],

Dmitry Frenkel

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

[diff] [blame^]

215

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

216

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

Bu Sun Kim

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

[diff] [blame]

217

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

Dmitry Frenkel

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

[diff] [blame^]

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

Bu Sun Kim

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

[diff] [blame]

228

},

229

],

Dmitry Frenkel

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

[diff] [blame^]

230

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

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-07-22 17:02:09 -0700

[diff] [blame]

242

"conversion": [ # The conversions being requested.

243

{ # A conversion containing data relevant to DoubleClick Search.

Dmitry Frenkel

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

[diff] [blame^]

244

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

245

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

Bu Sun Kim

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

[diff] [blame]

246

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

Dmitry Frenkel

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

[diff] [blame^]

247

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

Bu Sun Kim

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

[diff] [blame]

248

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

Dmitry Frenkel

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

[diff] [blame^]

249

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

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

],

Dmitry Frenkel

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

[diff] [blame^]

256

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

257

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

258

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

259

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

Bu Sun Kim

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

[diff] [blame]

260

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

Dmitry Frenkel

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

[diff] [blame^]

261

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

262

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

Bu Sun Kim

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

[diff] [blame]

263

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

264

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

Dmitry Frenkel

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

[diff] [blame^]

265

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

266

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

267

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

Bu Sun Kim

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

[diff] [blame]

268

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

269

{ # A message containing the custom dimension.

270

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

271

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

272

},

273

],

Dmitry Frenkel

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

[diff] [blame^]

274

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

275

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

Bu Sun Kim

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

[diff] [blame]

276

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

Dmitry Frenkel

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

[diff] [blame^]

277

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

278

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

279

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

280

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

281

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

282

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

283

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

284

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

285

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

286

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

Bu Sun Kim

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

[diff] [blame]

287

},

288

],

Dmitry Frenkel

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

[diff] [blame^]

289

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

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-07-22 17:02:09 -0700

[diff] [blame]

302

"conversion": [ # The conversions being requested.

303

{ # A conversion containing data relevant to DoubleClick Search.

Dmitry Frenkel

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

[diff] [blame^]

304

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

305

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

Bu Sun Kim

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

[diff] [blame]

306

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

Dmitry Frenkel

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

[diff] [blame^]

307

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

Bu Sun Kim

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

[diff] [blame]

308

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

Dmitry Frenkel

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

[diff] [blame^]

309

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

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

],

Dmitry Frenkel

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

[diff] [blame^]

316

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

317

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

318

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

319

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

Bu Sun Kim

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

[diff] [blame]

320

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

Dmitry Frenkel

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

[diff] [blame^]

321

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

322

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

Bu Sun Kim

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

[diff] [blame]

323

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

324

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

Dmitry Frenkel

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

[diff] [blame^]

325

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

326

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

327

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

Bu Sun Kim

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

[diff] [blame]

328

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

329

{ # A message containing the custom dimension.

330

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

331

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

332

},

333

],

Dmitry Frenkel

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

[diff] [blame^]

334

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

335

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

Bu Sun Kim

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

[diff] [blame]

336

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

Dmitry Frenkel

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

[diff] [blame^]

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

Bu Sun Kim

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

[diff] [blame]

347

},

348

],

Dmitry Frenkel

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

[diff] [blame^]

349

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

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-07-22 17:02:09 -0700

[diff] [blame]

361

"conversion": [ # The conversions being requested.

362

{ # A conversion containing data relevant to DoubleClick Search.

Dmitry Frenkel

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

[diff] [blame^]

363

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

364

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

Bu Sun Kim

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

[diff] [blame]

365

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

Dmitry Frenkel

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

[diff] [blame^]

366

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

Bu Sun Kim

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

[diff] [blame]

367

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

Dmitry Frenkel

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

[diff] [blame^]

368

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

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

],

Dmitry Frenkel

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

[diff] [blame^]

375

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

376

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

377

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

378

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

Bu Sun Kim

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

[diff] [blame]

379

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

Dmitry Frenkel

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

[diff] [blame^]

380

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

381

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

Bu Sun Kim

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

[diff] [blame]

382

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

383

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

Dmitry Frenkel

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

[diff] [blame^]

384

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

385

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

386

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

Bu Sun Kim

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

[diff] [blame]

387

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

388

{ # A message containing the custom dimension.

389

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

390

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

391

},

392

],

Dmitry Frenkel

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

[diff] [blame^]

393

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

394

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

Bu Sun Kim

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

[diff] [blame]

395

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

Dmitry Frenkel

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

[diff] [blame^]

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

Bu Sun Kim

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

[diff] [blame]

406

},

407

],

Dmitry Frenkel

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

[diff] [blame^]

408

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

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

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-05-20 12:08:20 -0700

[diff] [blame]

423

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

Bu Sun Kim

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

[diff] [blame]

424

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

425

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

Dmitry Frenkel

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

[diff] [blame^]

426

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

427

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

428

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

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

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-05-20 12:08:20 -0700

[diff] [blame]

444

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

Bu Sun Kim

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

[diff] [blame]

445

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

446

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

Dmitry Frenkel

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

[diff] [blame^]

447

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

448

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

449

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

John Asmuth