Blame - docs/dyn/content_v2.datafeeds.html - platform/external/python/google-api-python-client

2014-08-14 00:47:23 -0700

[diff] [blame]

101

<h3>Method Details</h3>

102

Dan O'Meara

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

[diff] [blame]

103

<code class="details" id="custombatch">custombatch(body=None, dryRun=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

104

<pre>Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

105

106

Args:

Dan O'Meara

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

[diff] [blame]

107

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

108

The object takes the form of:

109

110

{

Bu Sun Kim

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

[diff] [blame]

111

"entries": [ # The request entries to be processed in the batch.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

112

{ # A batch entry encoding a single non-batch datafeeds request.

Bu Sun Kim

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

[diff] [blame]

113

"batchId": 42, # An entry ID, unique within the batch request.

114

"datafeed": { # Datafeed configuration data. # The data feed to insert.

115

"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.

116

"contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.

117

"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.

118

#

119

# Acceptable values are:

120

# - "`local products`"

121

# - "`product inventory`"

122

# - "`products`"

123

"fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.

124

"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).

125

"fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.

126

"hour": 42, # The hour of the day the feed file should be fetched (0-23).

127

"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.

128

"password": "A String", # An optional password for fetch_url.

129

"paused": True or False, # Whether the scheduled fetch is paused or not.

130

"timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".

131

"username": "A String", # An optional user name for fetch_url.

132

"weekday": "A String", # The day of the week the feed file should be fetched.

Dan O'Meara

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

[diff] [blame]

133

#

134

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

# - "`monday`"

# - "`tuesday`"

# - "`wednesday`"

# - "`thursday`"

# - "`friday`"

# - "`saturday`"

# - "`sunday`"

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

142

},

Bu Sun Kim

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

[diff] [blame]

143

"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.

144

"format": { # Format of the feed file.

145

"columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.

146

#

147

# Acceptable values are:

# - "`pipe`"

# - "`tab`"

# - "`tilde`"

"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.

152

#

153

# Acceptable values are:

# - "`latin-1`"

# - "`utf-16be`"

# - "`utf-16le`"

# - "`utf-8`"

# - "`windows-1252`"

"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.

160

#

161

# Acceptable values are:

162

# - "`normal character`"

163

# - "`value quoting`"

164

},

165

"id": "A String", # Required for update. The ID of the data feed.

166

"intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).

167

"A String",

168

],

169

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"

170

"name": "A String", # Required for insert. A descriptive name of the data feed.

171

"targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

172

"targets": [ # The targets this feed should apply to (country, language, destinations).

173

{

174

"country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

175

"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).

176

"A String",

177

],

178

"includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.

179

#

180

# List of supported destinations (if available to the account):

# - DisplayAds

# - Shopping

# - ShoppingActions

# - SurfacesAcrossGoogle

185

"A String",

186

],

187

"language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.

},

],

},

"datafeedId": "A String", # The ID of the data feed to get, delete or fetch.

192

"merchantId": "A String", # The ID of the managing account.

193

"method": "A String", # The method of the batch entry.

Dan O'Meara

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

[diff] [blame]

194

#

195

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

# - "`delete`"

# - "`fetchNow`"

# - "`get`"

# - "`insert`"

# - "`update`"

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

},

],

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

205

dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

206

207

Returns:

208

An object of the form:

209

210

{

Bu Sun Kim

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

[diff] [blame]

211

"entries": [ # The result of the execution of the batch requests.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

212

{ # A batch entry encoding a single non-batch datafeeds response.

Bu Sun Kim

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

[diff] [blame]

213

"batchId": 42, # The ID of the request entry this entry responds to.

214

"datafeed": { # Datafeed configuration data. # The requested data feed. Defined if and only if the request was successful.

215

"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.

216

"contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.

217

"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.

218

#

219

# Acceptable values are:

220

# - "`local products`"

221

# - "`product inventory`"

222

# - "`products`"

223

"fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.

224

"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).

225

"fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.

226

"hour": 42, # The hour of the day the feed file should be fetched (0-23).

227

"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.

228

"password": "A String", # An optional password for fetch_url.

229

"paused": True or False, # Whether the scheduled fetch is paused or not.

230

"timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".

231

"username": "A String", # An optional user name for fetch_url.

232

"weekday": "A String", # The day of the week the feed file should be fetched.

233

#

234

# Acceptable values are:

# - "`monday`"

# - "`tuesday`"

# - "`wednesday`"

# - "`thursday`"

# - "`friday`"

# - "`saturday`"

# - "`sunday`"

},

"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.

244

"format": { # Format of the feed file.

245

"columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.

246

#

247

# Acceptable values are:

# - "`pipe`"

# - "`tab`"

# - "`tilde`"

"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.

252

#

253

# Acceptable values are:

# - "`latin-1`"

# - "`utf-16be`"

# - "`utf-16le`"

# - "`utf-8`"

# - "`windows-1252`"

"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.

260

#

261

# Acceptable values are:

262

# - "`normal character`"

263

# - "`value quoting`"

264

},

265

"id": "A String", # Required for update. The ID of the data feed.

266

"intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).

267

"A String",

268

],

269

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"

270

"name": "A String", # Required for insert. A descriptive name of the data feed.

271

"targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

272

"targets": [ # The targets this feed should apply to (country, language, destinations).

273

{

274

"country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

275

"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).

276

"A String",

277

],

278

"includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.

279

#

280

# List of supported destinations (if available to the account):

# - DisplayAds

# - Shopping

# - ShoppingActions

# - SurfacesAcrossGoogle

285

"A String",

286

],

287

"language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

288

},

289

],

290

},

Bu Sun Kim

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

[diff] [blame]

291

"errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.

292

"code": 42, # The HTTP status of the first error in `errors`.

293

"errors": [ # A list of errors.

294

{ # An error returned by the API.

295

"domain": "A String", # The domain of the error.

296

"message": "A String", # A description of the error.

297

"reason": "A String", # The error code.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

298

},

Bu Sun Kim

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

[diff] [blame]

299

],

300

"message": "A String", # The message of the first error in `errors`.

301

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

302

},

303

],

Bu Sun Kim

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

[diff] [blame]

304

"kind": "content#datafeedsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse".

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

309

<code class="details" id="delete">delete(merchantId, datafeedId, dryRun=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

310

<pre>Deletes a datafeed configuration from your Merchant Center account.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

311

312

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

313

merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)

314

datafeedId: string, The ID of the datafeed. (required)

315

dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

320

<code class="details" id="fetchnow">fetchnow(merchantId, datafeedId, dryRun=None)</code>

321

<pre>Invokes a fetch for the datafeed in your Merchant Center account.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

322

323

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

324

merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)

325

datafeedId: string, The ID of the datafeed to be fetched. (required)

326

dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

327

328

Returns:

329

An object of the form:

330

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

331

{

Bu Sun Kim

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

[diff] [blame]

332

"kind": "content#datafeedsFetchNowResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsFetchNowResponse".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(merchantId, datafeedId)</code>

338

<pre>Retrieves a datafeed configuration from your Merchant Center account.

339

340

Args:

341

merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)

342

datafeedId: string, The ID of the datafeed. (required)

343

344

Returns:

345

An object of the form:

346

347

{ # Datafeed configuration data.

Bu Sun Kim

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

[diff] [blame]

348

"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.

349

"contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.

350

"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.

351

#

352

# Acceptable values are:

353

# - "`local products`"

354

# - "`product inventory`"

355

# - "`products`"

356

"fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.

357

"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).

358

"fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.

359

"hour": 42, # The hour of the day the feed file should be fetched (0-23).

360

"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.

361

"password": "A String", # An optional password for fetch_url.

362

"paused": True or False, # Whether the scheduled fetch is paused or not.

363

"timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".

364

"username": "A String", # An optional user name for fetch_url.

365

"weekday": "A String", # The day of the week the feed file should be fetched.

Dan O'Meara

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

[diff] [blame]

366

#

367

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

# - "`monday`"

# - "`tuesday`"

# - "`wednesday`"

# - "`thursday`"

# - "`friday`"

# - "`saturday`"

# - "`sunday`"

},

"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.

377

"format": { # Format of the feed file.

378

"columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.

379

#

380

# Acceptable values are:

# - "`pipe`"

# - "`tab`"

# - "`tilde`"

"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.

385

#

386

# Acceptable values are:

# - "`latin-1`"

# - "`utf-16be`"

# - "`utf-16le`"

# - "`utf-8`"

# - "`windows-1252`"

"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.

393

#

394

# Acceptable values are:

395

# - "`normal character`"

396

# - "`value quoting`"

397

},

398

"id": "A String", # Required for update. The ID of the data feed.

399

"intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).

400

"A String",

401

],

402

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"

403

"name": "A String", # Required for insert. A descriptive name of the data feed.

404

"targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

405

"targets": [ # The targets this feed should apply to (country, language, destinations).

406

{

407

"country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

408

"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).

409

"A String",

410

],

411

"includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.

Dan O'Meara

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

[diff] [blame]

412

#

Bu Sun Kim

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

[diff] [blame]

413

# List of supported destinations (if available to the account):

# - DisplayAds

# - Shopping

# - ShoppingActions

# - SurfacesAcrossGoogle

418

"A String",

419

],

420

"language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

421

},

Bu Sun Kim

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

[diff] [blame]

422

],

423

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

427

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

428

<pre>Registers a datafeed configuration with your Merchant Center account.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

429

430

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

431

merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)

Dan O'Meara

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

[diff] [blame]

432

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

433

The object takes the form of:

434

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

435

{ # Datafeed configuration data.

Bu Sun Kim

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

[diff] [blame]

436

"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.

437

"contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.

438

"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.

439

#

440

# Acceptable values are:

441

# - "`local products`"

442

# - "`product inventory`"

443

# - "`products`"

444

"fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.

445

"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).

446

"fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.

447

"hour": 42, # The hour of the day the feed file should be fetched (0-23).

448

"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.

449

"password": "A String", # An optional password for fetch_url.

450

"paused": True or False, # Whether the scheduled fetch is paused or not.

451

"timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".

452

"username": "A String", # An optional user name for fetch_url.

453

"weekday": "A String", # The day of the week the feed file should be fetched.

454

#

Dan O'Meara

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

[diff] [blame]

455

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

# - "`monday`"

# - "`tuesday`"

# - "`wednesday`"

# - "`thursday`"

# - "`friday`"

# - "`saturday`"

# - "`sunday`"

},

"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.

465

"format": { # Format of the feed file.

466

"columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.

467

#

468

# Acceptable values are:

# - "`pipe`"

# - "`tab`"

# - "`tilde`"

"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.

473

#

474

# Acceptable values are:

# - "`latin-1`"

# - "`utf-16be`"

# - "`utf-16le`"

# - "`utf-8`"

# - "`windows-1252`"

"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.

481

#

482

# Acceptable values are:

483

# - "`normal character`"

484

# - "`value quoting`"

485

},

486

"id": "A String", # Required for update. The ID of the data feed.

487

"intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).

488

"A String",

489

],

490

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"

491

"name": "A String", # Required for insert. A descriptive name of the data feed.

492

"targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

493

"targets": [ # The targets this feed should apply to (country, language, destinations).

494

{

495

"country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

496

"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).

497

"A String",

498

],

499

"includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.

Dan O'Meara

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

[diff] [blame]

500

#

Bu Sun Kim

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

[diff] [blame]

501

# List of supported destinations (if available to the account):

# - DisplayAds

# - Shopping

# - ShoppingActions

# - SurfacesAcrossGoogle

506

"A String",

507

],

508

"language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

509

},

Bu Sun Kim

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

[diff] [blame]

510

],

511

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

512

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

513

dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

514

515

Returns:

516

An object of the form:

517

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

518

{ # Datafeed configuration data.

Bu Sun Kim

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

[diff] [blame]

519

"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.

520

"contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.

521

"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.

522

#

523

# Acceptable values are:

524

# - "`local products`"

525

# - "`product inventory`"

526

# - "`products`"

527

"fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.

528

"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).

529

"fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.

530

"hour": 42, # The hour of the day the feed file should be fetched (0-23).

531

"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.

532

"password": "A String", # An optional password for fetch_url.

533

"paused": True or False, # Whether the scheduled fetch is paused or not.

534

"timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".

535

"username": "A String", # An optional user name for fetch_url.

536

"weekday": "A String", # The day of the week the feed file should be fetched.

Dan O'Meara

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

[diff] [blame]

537

#

538

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

# - "`monday`"

# - "`tuesday`"

# - "`wednesday`"

# - "`thursday`"

# - "`friday`"

# - "`saturday`"

# - "`sunday`"

},

"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.

548

"format": { # Format of the feed file.

549

"columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.

550

#

551

# Acceptable values are:

# - "`pipe`"

# - "`tab`"

# - "`tilde`"

"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.

556

#

557

# Acceptable values are:

# - "`latin-1`"

# - "`utf-16be`"

# - "`utf-16le`"

# - "`utf-8`"

# - "`windows-1252`"

"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.

564

#

565

# Acceptable values are:

566

# - "`normal character`"

567

# - "`value quoting`"

568

},

569

"id": "A String", # Required for update. The ID of the data feed.

570

"intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).

571

"A String",

572

],

573

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"

574

"name": "A String", # Required for insert. A descriptive name of the data feed.

575

"targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

576

"targets": [ # The targets this feed should apply to (country, language, destinations).

577

{

578

"country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

579

"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).

580

"A String",

581

],

582

"includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.

Dan O'Meara

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

[diff] [blame]

583

#

Bu Sun Kim

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

[diff] [blame]

584

# List of supported destinations (if available to the account):

# - DisplayAds

# - Shopping

# - ShoppingActions

# - SurfacesAcrossGoogle

589

"A String",

590

],

591

"language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

592

},

Bu Sun Kim

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

[diff] [blame]

593

],

594

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

598

<code class="details" id="list">list(merchantId, maxResults=None, pageToken=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

599

<pre>Lists the configurations for datafeeds in your Merchant Center account.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

600

601

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

602

merchantId: string, The ID of the account that manages the datafeeds. This account cannot be a multi-client account. (required)

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

603

maxResults: integer, The maximum number of products to return in the response, used for paging.

Bu Sun Kim

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

[diff] [blame]

604

pageToken: string, The token returned by the previous request.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

605

606

Returns:

607

An object of the form:

608

609

{

Bu Sun Kim

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

[diff] [blame]

610

"kind": "content#datafeedsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse".

611

"nextPageToken": "A String", # The token for the retrieval of the next page of datafeeds.

612

"resources": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

613

{ # Datafeed configuration data.

Bu Sun Kim

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

[diff] [blame]

614

"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.

615

"contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.

616

"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.

617

#

618

# Acceptable values are:

619

# - "`local products`"

620

# - "`product inventory`"

621

# - "`products`"

622

"fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.

623

"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).

624

"fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.

625

"hour": 42, # The hour of the day the feed file should be fetched (0-23).

626

"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.

627

"password": "A String", # An optional password for fetch_url.

628

"paused": True or False, # Whether the scheduled fetch is paused or not.

629

"timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".

630

"username": "A String", # An optional user name for fetch_url.

631

"weekday": "A String", # The day of the week the feed file should be fetched.

Dan O'Meara

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

[diff] [blame]

632

#

633

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

# - "`monday`"

# - "`tuesday`"

# - "`wednesday`"

# - "`thursday`"

# - "`friday`"

# - "`saturday`"

# - "`sunday`"

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

641

},

Bu Sun Kim

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

[diff] [blame]

642

"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.

643

"format": { # Format of the feed file.

644

"columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.

645

#

646

# Acceptable values are:

# - "`pipe`"

# - "`tab`"

# - "`tilde`"

"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.

651

#

652

# Acceptable values are:

# - "`latin-1`"

# - "`utf-16be`"

# - "`utf-16le`"

# - "`utf-8`"

# - "`windows-1252`"

"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.

659

#

660

# Acceptable values are:

661

# - "`normal character`"

662

# - "`value quoting`"

663

},

664

"id": "A String", # Required for update. The ID of the data feed.

665

"intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).

666

"A String",

667

],

668

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"

669

"name": "A String", # Required for insert. A descriptive name of the data feed.

670

"targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

671

"targets": [ # The targets this feed should apply to (country, language, destinations).

672

{

673

"country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

674

"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).

675

"A String",

676

],

677

"includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.

678

#

679

# List of supported destinations (if available to the account):

# - DisplayAds

# - Shopping

# - ShoppingActions

# - SurfacesAcrossGoogle

684

"A String",

685

],

686

"language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.

687

},

688

],

689

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

],

}</pre>

</div>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

695

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

696

<pre>Retrieves the next page of results.

697

698

Args:

699

previous_request: The request for the previous page. (required)

700

previous_response: The response from the request for the previous page. (required)

701

702

Returns:

Bu Sun Kim

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

[diff] [blame]

703

A request object that you can call 'execute()' on to request the next

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

704

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

709

<code class="details" id="update">update(merchantId, datafeedId, body=None, dryRun=None)</code>

Bu Sun Kim

d059ad8

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

[diff] [blame]

710

<pre>Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

711

712

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

713

merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)

714

datafeedId: string, The ID of the datafeed. (required)

Dan O'Meara

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

[diff] [blame]

715

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

716

The object takes the form of:

717

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

718

{ # Datafeed configuration data.

Bu Sun Kim

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

[diff] [blame]

719

"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.

720

"contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.

721

"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.

722

#

723

# Acceptable values are:

724

# - "`local products`"

725

# - "`product inventory`"

726

# - "`products`"

727

"fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.

728

"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).

729

"fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.

730

"hour": 42, # The hour of the day the feed file should be fetched (0-23).

731

"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.

732

"password": "A String", # An optional password for fetch_url.

733

"paused": True or False, # Whether the scheduled fetch is paused or not.

734

"timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".

735

"username": "A String", # An optional user name for fetch_url.

736

"weekday": "A String", # The day of the week the feed file should be fetched.

737

#

Dan O'Meara

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

[diff] [blame]

738

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

# - "`monday`"

# - "`tuesday`"

# - "`wednesday`"

# - "`thursday`"

# - "`friday`"

# - "`saturday`"

# - "`sunday`"

},

"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.

748

"format": { # Format of the feed file.

749

"columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.

750

#

751

# Acceptable values are:

# - "`pipe`"

# - "`tab`"

# - "`tilde`"

"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.

756

#

757

# Acceptable values are:

# - "`latin-1`"

# - "`utf-16be`"

# - "`utf-16le`"

# - "`utf-8`"

# - "`windows-1252`"

"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.

764

#

765

# Acceptable values are:

766

# - "`normal character`"

767

# - "`value quoting`"

768

},

769

"id": "A String", # Required for update. The ID of the data feed.

770

"intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).

771

"A String",

772

],

773

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"

774

"name": "A String", # Required for insert. A descriptive name of the data feed.

775

"targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

776

"targets": [ # The targets this feed should apply to (country, language, destinations).

777

{

778

"country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

779

"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).

780

"A String",

781

],

782

"includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.

Dan O'Meara

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

[diff] [blame]

783

#

Bu Sun Kim

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

[diff] [blame]

784

# List of supported destinations (if available to the account):

# - DisplayAds

# - Shopping

# - ShoppingActions

# - SurfacesAcrossGoogle

789

"A String",

790

],

791

"language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

792

},

Bu Sun Kim

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

[diff] [blame]

793

],

794

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

795

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

796

dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

797

798

Returns:

799

An object of the form:

800

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

801

{ # Datafeed configuration data.

Bu Sun Kim

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

[diff] [blame]

802

"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.

803

"contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.

804

"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.

805

#

806

# Acceptable values are:

807

# - "`local products`"

808

# - "`product inventory`"

809

# - "`products`"

810

"fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.

811

"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).

812

"fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.

813

"hour": 42, # The hour of the day the feed file should be fetched (0-23).

814

"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.

815

"password": "A String", # An optional password for fetch_url.

816

"paused": True or False, # Whether the scheduled fetch is paused or not.

817

"timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".

818

"username": "A String", # An optional user name for fetch_url.

819

"weekday": "A String", # The day of the week the feed file should be fetched.

Dan O'Meara

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

[diff] [blame]

820

#

821

# Acceptable values are:

Bu Sun Kim

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

[diff] [blame]

# - "`monday`"

# - "`tuesday`"

# - "`wednesday`"

# - "`thursday`"

# - "`friday`"

# - "`saturday`"

# - "`sunday`"

},

"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.

831

"format": { # Format of the feed file.

832

"columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.

833

#

834

# Acceptable values are:

# - "`pipe`"

# - "`tab`"

# - "`tilde`"

"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.

839

#

840

# Acceptable values are:

# - "`latin-1`"

# - "`utf-16be`"

# - "`utf-16le`"

# - "`utf-8`"

# - "`windows-1252`"

"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.

847

#

848

# Acceptable values are:

849

# - "`normal character`"

850

# - "`value quoting`"

851

},

852

"id": "A String", # Required for update. The ID of the data feed.

853

"intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).

854

"A String",

855

],

856

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"

857

"name": "A String", # Required for insert. A descriptive name of the data feed.

858

"targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

859

"targets": [ # The targets this feed should apply to (country, language, destinations).

860

{

861

"country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

862

"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).

863

"A String",

864

],

865

"includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.

Dan O'Meara

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

[diff] [blame]

866

#

Bu Sun Kim