Blame - docs/dyn/youtubeAnalytics_v2.groups.html - platform/external/python/google-api-python-client

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

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

<h1><a href="youtubeAnalytics_v2.html">YouTube Analytics API</a> . <a href="youtubeAnalytics_v2.groups.html">groups</a></h1>

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

78

<code><a href="#delete">delete(onBehalfOfContentOwner=None, id=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

79

<p class="firstline">Deletes a group.</p>

80

Dan O'Meara

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

[diff] [blame]

81

<code><a href="#insert">insert(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

82

<p class="firstline">Creates a group.</p>

83

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

84

<code><a href="#list">list(onBehalfOfContentOwner=None, pageToken=None, id=None, mine=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

85

<p class="firstline">Returns a collection of groups that match the API request parameters. For</p>

86

87

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

88

<p class="firstline">Retrieves the next page of results.</p>

89

Dan O'Meara

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

[diff] [blame]

90

<code><a href="#update">update(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

91

<p class="firstline">Modifies a group. For example, you could change a group's title.</p>

92

<h3>Method Details</h3>

93

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

94

<code class="details" id="delete">delete(onBehalfOfContentOwner=None, id=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

95

<pre>Deletes a group.

96

97

Args:

98

onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:**

99

This parameter is intended exclusively for YouTube content partners that

100

own and manage many different YouTube channels.

101

Bu Sun Kim

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

[diff] [blame]

102

The `onBehalfOfContentOwner` parameter indicates that the request's

Bu Sun Kim

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

[diff] [blame]

103

authorization credentials identify a YouTube user who is acting on behalf

104

of the content owner specified in the parameter value. It allows content

105

owners to authenticate once and get access to all their video and channel

106

data, without having to provide authentication credentials for each

107

individual channel. The account that the user authenticates with must be

108

linked to the specified YouTube content owner.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

109

id: string, The `id` parameter specifies the YouTube group ID of the group that is

110

being deleted.

Bu Sun Kim

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

[diff] [blame]

111

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

118

119

{ # Empty response.

Bu Sun Kim

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

[diff] [blame]

120

"errors": { # Request Error information. # Apiary error details

Bu Sun Kim

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

[diff] [blame]

121

#

122

# The presence of an error field signals that the operation

123

# has failed.

Bu Sun Kim

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

[diff] [blame]

124

"requestId": "A String", # Request identifier generated by the service, which can be

Bu Sun Kim

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

[diff] [blame]

125

# used to identify the error in the logs

Bu Sun Kim

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

[diff] [blame]

126

"error": [ # Specific error description and codes

Bu Sun Kim

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

[diff] [blame]

127

{ # Describes one specific error.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

128

"debugInfo": "A String", # Debugging information, which should not be

129

# shared externally.

130

"argument": [ # Error arguments, to be used when building user-friendly error messages

131

# given the error domain and code. Different error codes require different

132

# arguments.

133

"A String",

134

],

Bu Sun Kim

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

[diff] [blame]

135

"code": "A String", # Error code in the error domain. This should correspond to

Bu Sun Kim

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

[diff] [blame]

136

# a value of the enum type whose name is in domain. See

137

# the core error domain in error_domain.proto.

Bu Sun Kim

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

[diff] [blame]

138

"domain": "A String", # Error domain. RoSy services can define their own

139

# domain and error codes. This should normally be

140

# the name of an enum type, such as: gdata.CoreErrorDomain

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

141

"locationType": "A String",

Bu Sun Kim

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

[diff] [blame]

142

"location": "A String", # Location of the error, as specified by the location type.

143

#

144

# If location_type is PATH, this should be a path to a field that's

145

# relative to the request, using FieldPath notation

146

# (net/proto2/util/public/field_path.h).

147

#

148

# Examples:

149

# authenticated_user.gaia_id

150

# resource.address[2].country

Bu Sun Kim

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

[diff] [blame]

151

"externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google.

Bu Sun Kim

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

[diff] [blame]

152

#

153

# Please set domain, code and arguments whenever possible instead of this

154

# error message so that external APIs can build safe error messages

155

# themselves.

156

#

157

# External messages built in a RoSy interface will most likely refer to

158

# information and concepts that are not available externally and should not

159

# be exposed. It is safer if external APIs can understand the errors and

160

# decide what the error message should look like.

Bu Sun Kim

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

[diff] [blame]

161

},

162

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

163

"code": "A String", # Global error code. Deprecated and ignored.

164

# Set custom error codes in ErrorProto.domain and ErrorProto.code

165

# instead.

Bu Sun Kim

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

[diff] [blame]

},

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

171

<code class="details" id="insert">insert(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

172

<pre>Creates a group.

173

174

Args:

Dan O'Meara

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

[diff] [blame]

175

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

176

The object takes the form of:

177

178

{ # A group.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

179

"id": "A String", # The ID that YouTube uses to uniquely identify the group.

180

"errors": { # Request Error information. # Apiary error details

Bu Sun Kim

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

[diff] [blame]

181

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

182

# The presence of an error field signals that the operation

183

# has failed.

184

"requestId": "A String", # Request identifier generated by the service, which can be

185

# used to identify the error in the logs

186

"error": [ # Specific error description and codes

187

{ # Describes one specific error.

188

"debugInfo": "A String", # Debugging information, which should not be

189

# shared externally.

190

"argument": [ # Error arguments, to be used when building user-friendly error messages

191

# given the error domain and code. Different error codes require different

# arguments.

"A String",

],

"code": "A String", # Error code in the error domain. This should correspond to

196

# a value of the enum type whose name is in domain. See

197

# the core error domain in error_domain.proto.

198

"domain": "A String", # Error domain. RoSy services can define their own

199

# domain and error codes. This should normally be

200

# the name of an enum type, such as: gdata.CoreErrorDomain

201

"locationType": "A String",

202

"location": "A String", # Location of the error, as specified by the location type.

203

#

204

# If location_type is PATH, this should be a path to a field that's

205

# relative to the request, using FieldPath notation

206

# (net/proto2/util/public/field_path.h).

207

#

208

# Examples:

209

# authenticated_user.gaia_id

210

# resource.address[2].country

211

"externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google.

212

#

213

# Please set domain, code and arguments whenever possible instead of this

214

# error message so that external APIs can build safe error messages

215

# themselves.

216

#

217

# External messages built in a RoSy interface will most likely refer to

218

# information and concepts that are not available externally and should not

219

# be exposed. It is safer if external APIs can understand the errors and

220

# decide what the error message should look like.

221

},

222

],

223

"code": "A String", # Global error code. Deprecated and ignored.

224

# Set custom error codes in ErrorProto.domain and ErrorProto.code

225

# instead.

226

},

227

"kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`.

228

"contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the

229

# group, such as the number and type of items that it contains.

230

"itemType": "A String", # The type of resources that the group contains.

231

#

232

# Valid values for this property are:

233

# * `youtube#channel`

234

# * `youtube#playlist`

235

# * `youtube#video`

236

# * `youtubePartner#asset`

237

"itemCount": "A String", # The number of items in the group.

238

},

239

"snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including

240

# its creation date and name.

241

"publishedAt": "A String", # The date and time that the group was created. The value is specified in

242

# ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

243

"title": "A String", # The group name. The value must be a non-empty string.

244

},

245

"etag": "A String", # The Etag of this resource.

246

}

Bu Sun Kim

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

[diff] [blame]

247

248

onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:**

249

This parameter is intended exclusively for YouTube content partners that

250

own and manage many different YouTube channels.

251

Bu Sun Kim

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

[diff] [blame]

252

The `onBehalfOfContentOwner` parameter indicates that the request's

Bu Sun Kim

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

[diff] [blame]

253

authorization credentials identify a YouTube user who is acting on behalf

254

of the content owner specified in the parameter value. It allows content

255

owners to authenticate once and get access to all their video and channel

256

data, without having to provide authentication credentials for each

257

individual channel. The account that the user authenticates with must be

258

linked to the specified YouTube content owner.

259

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

266

267

{ # A group.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

268

"id": "A String", # The ID that YouTube uses to uniquely identify the group.

269

"errors": { # Request Error information. # Apiary error details

Bu Sun Kim

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

[diff] [blame]

270

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

271

# The presence of an error field signals that the operation

272

# has failed.

273

"requestId": "A String", # Request identifier generated by the service, which can be

274

# used to identify the error in the logs

275

"error": [ # Specific error description and codes

276

{ # Describes one specific error.

277

"debugInfo": "A String", # Debugging information, which should not be

278

# shared externally.

279

"argument": [ # Error arguments, to be used when building user-friendly error messages

280

# given the error domain and code. Different error codes require different

# arguments.

"A String",

],

"code": "A String", # Error code in the error domain. This should correspond to

285

# a value of the enum type whose name is in domain. See

286

# the core error domain in error_domain.proto.

287

"domain": "A String", # Error domain. RoSy services can define their own

288

# domain and error codes. This should normally be

289

# the name of an enum type, such as: gdata.CoreErrorDomain

290

"locationType": "A String",

291

"location": "A String", # Location of the error, as specified by the location type.

292

#

293

# If location_type is PATH, this should be a path to a field that's

294

# relative to the request, using FieldPath notation

295

# (net/proto2/util/public/field_path.h).

296

#

297

# Examples:

298

# authenticated_user.gaia_id

299

# resource.address[2].country

300

"externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google.

301

#

302

# Please set domain, code and arguments whenever possible instead of this

303

# error message so that external APIs can build safe error messages

304

# themselves.

305

#

306

# External messages built in a RoSy interface will most likely refer to

307

# information and concepts that are not available externally and should not

308

# be exposed. It is safer if external APIs can understand the errors and

309

# decide what the error message should look like.

310

},

311

],

312

"code": "A String", # Global error code. Deprecated and ignored.

313

# Set custom error codes in ErrorProto.domain and ErrorProto.code

314

# instead.

315

},

316

"kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`.

317

"contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the

318

# group, such as the number and type of items that it contains.

319

"itemType": "A String", # The type of resources that the group contains.

320

#

321

# Valid values for this property are:

322

# * `youtube#channel`

323

# * `youtube#playlist`

324

# * `youtube#video`

325

# * `youtubePartner#asset`

326

"itemCount": "A String", # The number of items in the group.

327

},

328

"snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including

329

# its creation date and name.

330

"publishedAt": "A String", # The date and time that the group was created. The value is specified in

331

# ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

332

"title": "A String", # The group name. The value must be a non-empty string.

333

},

334

"etag": "A String", # The Etag of this resource.

335

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

339

<code class="details" id="list">list(onBehalfOfContentOwner=None, pageToken=None, id=None, mine=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

340

<pre>Returns a collection of groups that match the API request parameters. For

341

example, you can retrieve all groups that the authenticated user owns,

342

or you can retrieve one or more groups by their unique IDs.

343

344

Args:

Bu Sun Kim

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

[diff] [blame]

345

onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:**

346

This parameter is intended exclusively for YouTube content partners that

347

own and manage many different YouTube channels.

348

349

The `onBehalfOfContentOwner` parameter indicates that the request's

350

authorization credentials identify a YouTube user who is acting on behalf

351

of the content owner specified in the parameter value. It allows content

352

owners to authenticate once and get access to all their video and channel

353

data, without having to provide authentication credentials for each

354

individual channel. The account that the user authenticates with must be

355

linked to the specified YouTube content owner.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

356

pageToken: string, The `pageToken` parameter identifies a specific page in the result set that

357

should be returned. In an API response, the `nextPageToken` property

358

identifies the next page that can be retrieved.

Bu Sun Kim

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

[diff] [blame]

359

id: string, The `id` parameter specifies a comma-separated list of the YouTube group

360

ID(s) for the resource(s) that are being retrieved. Each group must be

361

owned by the authenticated user. In a `group` resource, the `id` property

362

specifies the group's YouTube group ID.

363

364

Note that if you do not specify a value for the `id` parameter, then you

365

must set the `mine` parameter to `true`.

366

mine: boolean, This parameter can only be used in a properly authorized request. Set this

367

parameter's value to true to retrieve all groups owned by the authenticated

368

user.

369

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

376

377

{ # Response message for GroupsService.ListGroups.

378

"etag": "A String", # The Etag of this resource.

379

"items": [ # A list of groups that match the API request parameters. Each item in the

380

# list represents a `group` resource.

381

{ # A group.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

382

"id": "A String", # The ID that YouTube uses to uniquely identify the group.

383

"errors": { # Request Error information. # Apiary error details

Bu Sun Kim

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

[diff] [blame]

384

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

385

# The presence of an error field signals that the operation

386

# has failed.

387

"requestId": "A String", # Request identifier generated by the service, which can be

388

# used to identify the error in the logs

389

"error": [ # Specific error description and codes

390

{ # Describes one specific error.

391

"debugInfo": "A String", # Debugging information, which should not be

392

# shared externally.

393

"argument": [ # Error arguments, to be used when building user-friendly error messages

394

# given the error domain and code. Different error codes require different

# arguments.

"A String",

],

"code": "A String", # Error code in the error domain. This should correspond to

399

# a value of the enum type whose name is in domain. See

400

# the core error domain in error_domain.proto.

401

"domain": "A String", # Error domain. RoSy services can define their own

402

# domain and error codes. This should normally be

403

# the name of an enum type, such as: gdata.CoreErrorDomain

404

"locationType": "A String",

405

"location": "A String", # Location of the error, as specified by the location type.

406

#

407

# If location_type is PATH, this should be a path to a field that's

408

# relative to the request, using FieldPath notation

409

# (net/proto2/util/public/field_path.h).

410

#

411

# Examples:

412

# authenticated_user.gaia_id

413

# resource.address[2].country

414

"externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google.

415

#

416

# Please set domain, code and arguments whenever possible instead of this

417

# error message so that external APIs can build safe error messages

418

# themselves.

419

#

420

# External messages built in a RoSy interface will most likely refer to

421

# information and concepts that are not available externally and should not

422

# be exposed. It is safer if external APIs can understand the errors and

423

# decide what the error message should look like.

424

},

425

],

426

"code": "A String", # Global error code. Deprecated and ignored.

427

# Set custom error codes in ErrorProto.domain and ErrorProto.code

428

# instead.

429

},

430

"kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`.

431

"contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the

432

# group, such as the number and type of items that it contains.

433

"itemType": "A String", # The type of resources that the group contains.

434

#

435

# Valid values for this property are:

436

# * `youtube#channel`

437

# * `youtube#playlist`

438

# * `youtube#video`

439

# * `youtubePartner#asset`

440

"itemCount": "A String", # The number of items in the group.

441

},

442

"snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including

443

# its creation date and name.

444

"publishedAt": "A String", # The date and time that the group was created. The value is specified in

445

# ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

446

"title": "A String", # The group name. The value must be a non-empty string.

447

},

448

"etag": "A String", # The Etag of this resource.

Bu Sun Kim

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

[diff] [blame]

449

},

Bu Sun Kim

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

[diff] [blame]

450

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

451

"kind": "A String", # Identifies the API resource's type. The value will be

452

# `youtube#groupListResponse`.

Bu Sun Kim

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

[diff] [blame]

453

"errors": { # Request Error information. # Apiary error details

454

#

455

# The presence of an error field signals that the operation

456

# has failed.

Bu Sun Kim

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

[diff] [blame]

457

"requestId": "A String", # Request identifier generated by the service, which can be

458

# used to identify the error in the logs

459

"error": [ # Specific error description and codes

460

{ # Describes one specific error.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

461

"debugInfo": "A String", # Debugging information, which should not be

462

# shared externally.

463

"argument": [ # Error arguments, to be used when building user-friendly error messages

464

# given the error domain and code. Different error codes require different

465

# arguments.

466

"A String",

467

],

Bu Sun Kim

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

[diff] [blame]

468

"code": "A String", # Error code in the error domain. This should correspond to

469

# a value of the enum type whose name is in domain. See

470

# the core error domain in error_domain.proto.

471

"domain": "A String", # Error domain. RoSy services can define their own

472

# domain and error codes. This should normally be

473

# the name of an enum type, such as: gdata.CoreErrorDomain

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

474

"locationType": "A String",

Bu Sun Kim

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

[diff] [blame]

475

"location": "A String", # Location of the error, as specified by the location type.

476

#

477

# If location_type is PATH, this should be a path to a field that's

Bu Sun Kim

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

[diff] [blame]

478

# relative to the request, using FieldPath notation

479

# (net/proto2/util/public/field_path.h).

480

#

481

# Examples:

482

# authenticated_user.gaia_id

483

# resource.address[2].country

Bu Sun Kim

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

[diff] [blame]

484

"externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google.

485

#

486

# Please set domain, code and arguments whenever possible instead of this

487

# error message so that external APIs can build safe error messages

488

# themselves.

489

#

490

# External messages built in a RoSy interface will most likely refer to

491

# information and concepts that are not available externally and should not

492

# be exposed. It is safer if external APIs can understand the errors and

493

# decide what the error message should look like.

Bu Sun Kim

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

[diff] [blame]

494

},

495

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

496

"code": "A String", # Global error code. Deprecated and ignored.

497

# Set custom error codes in ErrorProto.domain and ErrorProto.code

498

# instead.

Bu Sun Kim

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

[diff] [blame]

499

},

Bu Sun Kim

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

[diff] [blame]

500

"nextPageToken": "A String", # The token that can be used as the value of the `pageToken` parameter to

501

# retrieve the next page in the result set.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

507

<pre>Retrieves the next page of results.

508

509

Args:

510

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

511

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

512

513

Returns:

Bu Sun Kim

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

[diff] [blame]

514

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

Bu Sun Kim

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

[diff] [blame]

515

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]

520

<code class="details" id="update">update(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

521

<pre>Modifies a group. For example, you could change a group's title.

Bu Sun Kim

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

[diff] [blame]

522

523

Args:

Dan O'Meara

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

[diff] [blame]

524

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

525

The object takes the form of:

526

527

{ # A group.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

528

"id": "A String", # The ID that YouTube uses to uniquely identify the group.

529

"errors": { # Request Error information. # Apiary error details

Bu Sun Kim

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

[diff] [blame]

530

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

531

# The presence of an error field signals that the operation

532

# has failed.

533

"requestId": "A String", # Request identifier generated by the service, which can be

534

# used to identify the error in the logs

535

"error": [ # Specific error description and codes

536

{ # Describes one specific error.

537

"debugInfo": "A String", # Debugging information, which should not be

538

# shared externally.

539

"argument": [ # Error arguments, to be used when building user-friendly error messages

540

# given the error domain and code. Different error codes require different

# arguments.

"A String",

],

"code": "A String", # Error code in the error domain. This should correspond to

545

# a value of the enum type whose name is in domain. See

546

# the core error domain in error_domain.proto.

547

"domain": "A String", # Error domain. RoSy services can define their own

548

# domain and error codes. This should normally be

549

# the name of an enum type, such as: gdata.CoreErrorDomain

550

"locationType": "A String",

551

"location": "A String", # Location of the error, as specified by the location type.

552

#

553

# If location_type is PATH, this should be a path to a field that's

554

# relative to the request, using FieldPath notation

555

# (net/proto2/util/public/field_path.h).

556

#

557

# Examples:

558

# authenticated_user.gaia_id

559

# resource.address[2].country

560

"externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google.

561

#

562

# Please set domain, code and arguments whenever possible instead of this

563

# error message so that external APIs can build safe error messages

564

# themselves.

565

#

566

# External messages built in a RoSy interface will most likely refer to

567

# information and concepts that are not available externally and should not

568

# be exposed. It is safer if external APIs can understand the errors and

569

# decide what the error message should look like.

570

},

571

],

572

"code": "A String", # Global error code. Deprecated and ignored.

573

# Set custom error codes in ErrorProto.domain and ErrorProto.code

574

# instead.

575

},

576

"kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`.

577

"contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the

578

# group, such as the number and type of items that it contains.

579

"itemType": "A String", # The type of resources that the group contains.

580

#

581

# Valid values for this property are:

582

# * `youtube#channel`

583

# * `youtube#playlist`

584

# * `youtube#video`

585

# * `youtubePartner#asset`

586

"itemCount": "A String", # The number of items in the group.

587

},

588

"snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including

589

# its creation date and name.

590

"publishedAt": "A String", # The date and time that the group was created. The value is specified in

591

# ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

592

"title": "A String", # The group name. The value must be a non-empty string.

593

},

594

"etag": "A String", # The Etag of this resource.

595

}

Bu Sun Kim

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

[diff] [blame]

596

597

onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:**

598

This parameter is intended exclusively for YouTube content partners that

599

own and manage many different YouTube channels.

600

Bu Sun Kim

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

[diff] [blame]

601

The `onBehalfOfContentOwner` parameter indicates that the request's

Bu Sun Kim

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

[diff] [blame]

602

authorization credentials identify a YouTube user who is acting on behalf

603

of the content owner specified in the parameter value. It allows content

604

owners to authenticate once and get access to all their video and channel

605

data, without having to provide authentication credentials for each

606

individual channel. The account that the user authenticates with must be

607

linked to the specified YouTube content owner.

608

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

615

616

{ # A group.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

617

"id": "A String", # The ID that YouTube uses to uniquely identify the group.

618

"errors": { # Request Error information. # Apiary error details

Bu Sun Kim

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

[diff] [blame]

619

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

620

# The presence of an error field signals that the operation

621

# has failed.

622

"requestId": "A String", # Request identifier generated by the service, which can be

623

# used to identify the error in the logs

624

"error": [ # Specific error description and codes

625

{ # Describes one specific error.

626

"debugInfo": "A String", # Debugging information, which should not be

627

# shared externally.

628

"argument": [ # Error arguments, to be used when building user-friendly error messages

629

# given the error domain and code. Different error codes require different

# arguments.

"A String",

],

"code": "A String", # Error code in the error domain. This should correspond to

634

# a value of the enum type whose name is in domain. See

635

# the core error domain in error_domain.proto.

636

"domain": "A String", # Error domain. RoSy services can define their own

637

# domain and error codes. This should normally be

638

# the name of an enum type, such as: gdata.CoreErrorDomain

639

"locationType": "A String",

640

"location": "A String", # Location of the error, as specified by the location type.

641

#

642

# If location_type is PATH, this should be a path to a field that's

643

# relative to the request, using FieldPath notation

644

# (net/proto2/util/public/field_path.h).

645

#

646

# Examples:

647

# authenticated_user.gaia_id

648

# resource.address[2].country

649

"externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google.

650

#

651

# Please set domain, code and arguments whenever possible instead of this

652

# error message so that external APIs can build safe error messages

653

# themselves.

654

#

655

# External messages built in a RoSy interface will most likely refer to

656

# information and concepts that are not available externally and should not

657

# be exposed. It is safer if external APIs can understand the errors and

658

# decide what the error message should look like.

659

},

660

],

661

"code": "A String", # Global error code. Deprecated and ignored.

662

# Set custom error codes in ErrorProto.domain and ErrorProto.code

663

# instead.

664

},

665

"kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`.

666

"contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the

667

# group, such as the number and type of items that it contains.

668

"itemType": "A String", # The type of resources that the group contains.

669

#

670

# Valid values for this property are:

671

# * `youtube#channel`

672

# * `youtube#playlist`

673

# * `youtube#video`

674

# * `youtubePartner#asset`

675

"itemCount": "A String", # The number of items in the group.

676

},

677

"snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including

678

# its creation date and name.

679

"publishedAt": "A String", # The date and time that the group was created. The value is specified in

680

# ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

681

"title": "A String", # The group name. The value must be a non-empty string.

682

},

683

"etag": "A String", # The Etag of this resource.

684

}</pre>

Bu Sun Kim