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

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

[diff] [blame]

104

<h3>Method Details</h3>

105

Dmitry Frenkel

3e17f89

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

[diff] [blame]

106

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

107

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

111

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

Bu Sun Kim

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

[diff] [blame]

112

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

Craig Citro

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

[diff] [blame]

113

114

Args:

Dan O'Meara

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

[diff] [blame]

115

body: object, The request body.

Craig Citro

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

[diff] [blame]

116

The object takes the form of:

117

118

{

Bu Sun Kim

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

[diff] [blame]

119

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

Craig Citro

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

[diff] [blame]

120

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

Bu Sun Kim

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

[diff] [blame]

121

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

122

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

123

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

124

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

125

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

126

#

127

# Acceptable values are:

128

# - "`local products`"

129

# - "`product inventory`"

130

# - "`products`"

131

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

132

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

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

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

141

#

142

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

150

},

Bu Sun Kim

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

[diff] [blame]

151

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

152

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

153

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

154

#

155

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

160

#

161

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

168

#

169

# Acceptable values are:

170

# - "`normal character`"

171

# - "`value quoting`"

172

},

173

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

174

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

175

"A String",

176

],

177

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

178

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

179

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

180

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

181

{

182

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

183

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

184

"A String",

185

],

186

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

187

#

188

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

# - DisplayAds

# - Shopping

# - ShoppingActions

# - SurfacesAcrossGoogle

193

"A String",

194

],

195

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

200

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

201

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

Dan O'Meara

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

[diff] [blame]

202

#

203

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

213

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]

214

215

Returns:

216

An object of the form:

217

218

{

Bu Sun Kim

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

[diff] [blame]

219

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

Craig Citro

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

[diff] [blame]

220

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

Bu Sun Kim

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

[diff] [blame]

221

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

222

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

223

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

224

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

225

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

226

#

227

# Acceptable values are:

228

# - "`local products`"

229

# - "`product inventory`"

230

# - "`products`"

231

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

232

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

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

#

242

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

252

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

253

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

254

#

255

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

260

#

261

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

268

#

269

# Acceptable values are:

270

# - "`normal character`"

271

# - "`value quoting`"

272

},

273

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

274

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

275

"A String",

276

],

277

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

278

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

279

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

280

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

281

{

282

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

283

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

284

"A String",

285

],

286

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

287

#

288

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

# - DisplayAds

# - Shopping

# - ShoppingActions

# - SurfacesAcrossGoogle

293

"A String",

294

],

295

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

296

},

297

],

298

},

Bu Sun Kim

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

[diff] [blame]

299

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

300

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

301

"errors": [ # A list of errors.

302

{ # An error returned by the API.

303

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

304

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

305

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

Craig Citro

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

[diff] [blame]

306

},

Bu Sun Kim

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

[diff] [blame]

307

],

308

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

309

},

Craig Citro

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

[diff] [blame]

310

},

311

],

Bu Sun Kim

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

[diff] [blame]

312

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

317

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

Bu Sun Kim

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

[diff] [blame]

318

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

Craig Citro

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

[diff] [blame]

319

320

Args:

Bu Sun Kim

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

[diff] [blame]

321

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

322

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

323

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]

328

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

329

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

Craig Citro

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

[diff] [blame]

330

331

Args:

Bu Sun Kim

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

[diff] [blame]

332

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

333

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

334

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]

335

336

Returns:

337

An object of the form:

338

Bu Sun Kim

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

[diff] [blame]

339

{

Bu Sun Kim

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

[diff] [blame]

340

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

346

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

347

348

Args:

349

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

350

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

351

352

Returns:

353

An object of the form:

354

355

{ # Datafeed configuration data.

Bu Sun Kim

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

[diff] [blame]

356

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

357

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

358

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

359

#

360

# Acceptable values are:

361

# - "`local products`"

362

# - "`product inventory`"

363

# - "`products`"

364

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

365

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

366

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

367

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

368

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

369

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

370

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

371

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

372

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

373

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

374

#

375

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

385

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

386

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

387

#

388

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

393

#

394

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

401

#

402

# Acceptable values are:

403

# - "`normal character`"

404

# - "`value quoting`"

405

},

406

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

407

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

408

"A String",

409

],

410

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

411

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

412

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

413

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

414

{

415

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

416

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

417

"A String",

418

],

419

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

420

#

Bu Sun Kim

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

[diff] [blame]

421

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

# - DisplayAds

# - Shopping

# - ShoppingActions

# - SurfacesAcrossGoogle

426

"A String",

427

],

428

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

429

},

Bu Sun Kim

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

[diff] [blame]

430

],

431

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

435

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

Bu Sun Kim

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

[diff] [blame]

436

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

Craig Citro

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

[diff] [blame]

437

438

Args:

Bu Sun Kim

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

[diff] [blame]

439

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]

440

body: object, The request body.

Craig Citro

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

[diff] [blame]

441

The object takes the form of:

442

Bu Sun Kim

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

[diff] [blame]

443

{ # Datafeed configuration data.

Bu Sun Kim

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

[diff] [blame]

444

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

445

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

446

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

447

#

448

# Acceptable values are:

449

# - "`local products`"

450

# - "`product inventory`"

451

# - "`products`"

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

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

461

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

462

#

Dan O'Meara

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

[diff] [blame]

463

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

473

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

474

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

475

#

476

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

481

#

482

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

489

#

490

# Acceptable values are:

491

# - "`normal character`"

492

# - "`value quoting`"

493

},

494

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

495

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

496

"A String",

497

],

498

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

499

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

500

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

501

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

502

{

503

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

504

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

505

"A String",

506

],

507

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

508

#

Bu Sun Kim

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

[diff] [blame]

509

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

# - DisplayAds

# - Shopping

# - ShoppingActions

# - SurfacesAcrossGoogle

514

"A String",

515

],

516

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

517

},

Bu Sun Kim

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

[diff] [blame]

518

],

519

}

Craig Citro

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

[diff] [blame]

520

Bu Sun Kim

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

[diff] [blame]

521

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]

522

523

Returns:

524

An object of the form:

525

Bu Sun Kim

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

[diff] [blame]

526

{ # Datafeed configuration data.

Bu Sun Kim

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

[diff] [blame]

527

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

528

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

529

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

530

#

531

# Acceptable values are:

532

# - "`local products`"

533

# - "`product inventory`"

534

# - "`products`"

535

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

536

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

537

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

538

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

539

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

540

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

541

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

542

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

543

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

544

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

545

#

546

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

556

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

557

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

558

#

559

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

564

#

565

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

572

#

573

# Acceptable values are:

574

# - "`normal character`"

575

# - "`value quoting`"

576

},

577

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

578

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

579

"A String",

580

],

581

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

582

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

583

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

584

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

585

{

586

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

587

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

588

"A String",

589

],

590

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

591

#

Bu Sun Kim

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

[diff] [blame]

592

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

# - DisplayAds

# - Shopping

# - ShoppingActions

# - SurfacesAcrossGoogle

597

"A String",

598

],

599

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

600

},

Bu Sun Kim

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

[diff] [blame]

601

],

602

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

606

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

Bu Sun Kim

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

[diff] [blame]

607

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

Craig Citro

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

[diff] [blame]

608

609

Args:

Bu Sun Kim

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

[diff] [blame]

610

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]

611

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]

612

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

Craig Citro

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

[diff] [blame]

613

614

Returns:

615

An object of the form:

616

617

{

Bu Sun Kim

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

[diff] [blame]

618

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

619

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

620

"resources": [

Bu Sun Kim

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

[diff] [blame]

621

{ # Datafeed configuration data.

Bu Sun Kim

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

[diff] [blame]

622

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

623

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

624

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

625

#

626

# Acceptable values are:

627

# - "`local products`"

628

# - "`product inventory`"

629

# - "`products`"

630

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

631

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

632

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

633

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

634

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

635

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

636

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

637

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

638

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

639

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

640

#

641

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

649

},

Bu Sun Kim

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

[diff] [blame]

650

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

651

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

652

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

653

#

654

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

659

#

660

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

667

#

668

# Acceptable values are:

669

# - "`normal character`"

670

# - "`value quoting`"

671

},

672

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

673

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

674

"A String",

675

],

676

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

677

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

678

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

679

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

680

{

681

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

682

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

683

"A String",

684

],

685

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

686

#

687

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

# - DisplayAds

# - Shopping

# - ShoppingActions

# - SurfacesAcrossGoogle

692

"A String",

693

],

694

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

695

},

696

],

697

},

Craig Citro

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

[diff] [blame]

],

}</pre>

</div>

Craig Citro

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

[diff] [blame]

703

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

704

<pre>Retrieves the next page of results.

705

706

Args:

707

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

708

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

709

710

Returns:

Bu Sun Kim

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

[diff] [blame]

711

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

Craig Citro

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

[diff] [blame]

712

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]

717

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

718

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

719

720

Args:

Bu Sun Kim

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

[diff] [blame]

721

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

722

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

Dan O'Meara

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

[diff] [blame]

723

body: object, The request body.

Craig Citro

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

[diff] [blame]

724

The object takes the form of:

725

Bu Sun Kim

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

[diff] [blame]

726

{ # Datafeed configuration data.

Bu Sun Kim

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

[diff] [blame]

727

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

728

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

729

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

730

#

731

# Acceptable values are:

732

# - "`local products`"

733

# - "`product inventory`"

734

# - "`products`"

735

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

736

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

737

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

738

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

739

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

740

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

741

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

742

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

743

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

744

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

745

#

Dan O'Meara

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

[diff] [blame]

746

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

756

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

757

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

758

#

759

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

764

#

765

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

772

#

773

# Acceptable values are:

774

# - "`normal character`"

775

# - "`value quoting`"

776

},

777

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

778

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

779

"A String",

780

],

781

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

782

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

783

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

784

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

785

{

786

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

787

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

788

"A String",

789

],

790

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

791

#

Bu Sun Kim

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

[diff] [blame]

792

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

# - DisplayAds

# - Shopping

# - ShoppingActions

# - SurfacesAcrossGoogle

797

"A String",

798

],

799

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

800

},

Bu Sun Kim

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

[diff] [blame]

801

],

802

}

Craig Citro

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

[diff] [blame]

803

Bu Sun Kim

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

[diff] [blame]

804

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]

805

806

Returns:

807

An object of the form:

808

Bu Sun Kim

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

[diff] [blame]

809

{ # Datafeed configuration data.

Bu Sun Kim

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

[diff] [blame]

810

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

811

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

812

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

813

#

814

# Acceptable values are:

815

# - "`local products`"

816

# - "`product inventory`"

817

# - "`products`"

818

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

819

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

820

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

821

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

822

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

823

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

824

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

825

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

826

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

827

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

828

#

829

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

839

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

840

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

841

#

842

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

847

#

848

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

855

#

856

# Acceptable values are:

857

# - "`normal character`"

858

# - "`value quoting`"

859

},

860

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

861

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

862

"A String",

863

],

864

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

865

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

866

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

867

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

868

{

869

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

870

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

871

"A String",

872

],

873

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

874

#

Bu Sun Kim