Blame - docs/dyn/youtube_v3.liveChatMessages.html - platform/external/python/google-api-python-client

2016-02-19 16:02:29 -0800

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

Bu Sun Kim

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

[diff] [blame^]

75

<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.liveChatMessages.html">liveChatMessages</a></h1>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

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

[diff] [blame^]

78

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

79

<p class="firstline">Deletes a chat message.</p>

80

Bu Sun Kim

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

[diff] [blame^]

81

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

82

<p class="firstline">Inserts a new resource into this collection.</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

83

Bu Sun Kim

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

[diff] [blame^]

84

<code><a href="#list">list(liveChatId, part, pageToken=None, hl=None, maxResults=None, profileImageSize=None, x__xgafv=None)</a></code></p>

85

<p class="firstline">Retrieves a list of resources, possibly filtered.</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

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

<h3>Method Details</h3>

90

Bu Sun Kim

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

[diff] [blame^]

91

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

92

<pre>Deletes a chat message.

93

94

Args:

Bu Sun Kim

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

[diff] [blame^]

95

id: string, A parameter (required)

96

x__xgafv: string, V1 error format.

97

Allowed values

98

1 - v1 error format

99

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

104

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

105

<pre>Inserts a new resource into this collection.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

106

107

Args:

Bu Sun Kim

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

[diff] [blame^]

108

part: string, The <code><strong>part</strong></code> parameter serves two purposes. It

109

identifies the properties that the write operation will set as well as the

110

properties that the API response will include. Set the parameter value to

111

<code>snippet</code>. (required) (repeated)

Dan O'Meara

dd49464

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

[diff] [blame]

112

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

113

The object takes the form of:

114

Bu Sun Kim

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

[diff] [blame^]

115

{ # A <code><strong>liveChatMessage</strong></code> resource represents a chat

116

# message in a YouTube Live Chat.

117

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

118

# <code>"youtube#liveChatMessage"</code>.

Bu Sun Kim

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

[diff] [blame]

119

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

Bu Sun Kim

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

[diff] [blame^]

120

"snippet": { # The <code>snippet</code> object contains basic details about the message.

Bu Sun Kim

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

[diff] [blame]

121

"liveChatId": "A String",

Bu Sun Kim

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

[diff] [blame^]

122

"authorChannelId": "A String", # The ID of the user that authored this message, this field is not always

123

# filled.

124

# textMessageEvent - the user that wrote the message

125

# fanFundingEvent - the user that funded the broadcast

126

# newSponsorEvent - the user that just became a sponsor

127

# messageDeletedEvent - the moderator that took the action

128

# messageRetractedEvent - the author that retracted their message

129

# userBannedEvent - the moderator that took the action

130

# superChatEvent - the user that made the purchase

131

"publishedAt": "A String", # The date and time when the message was orignally published. The value is

132

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

133

# format.

134

"userBannedDetails": {

135

"banDurationSeconds": "A String", # The duration of the ban. This property is only present if the

136

# <code>banType</code> is <code>temporary</code>.

137

"bannedUserDetails": { # The details of the user that was banned.

138

"profileImageUrl": "A String", # The channels's avatar URL.

139

"channelUrl": "A String", # The channel's URL.

140

"displayName": "A String", # The channel's display name.

141

"channelId": "A String", # The YouTube channel ID.

142

},

143

"banType": "A String", # The type of ban.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

144

},

Bu Sun Kim

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

[diff] [blame]

145

"messageRetractedDetails": {

146

"retractedMessageId": "A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

147

},

Bu Sun Kim

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

[diff] [blame^]

148

"superChatDetails": { # Details about the Super Chat event, this is only set if the type is

149

# 'superChatEvent'.

Bu Sun Kim

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

[diff] [blame]

150

"amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).

Bu Sun Kim

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

[diff] [blame]

151

"userComment": "A String", # The comment added by the user to this Super Chat event.

Bu Sun Kim

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

[diff] [blame]

152

"currency": "A String", # The currency in which the purchase was made.

Bu Sun Kim

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

[diff] [blame^]

153

"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.

154

"tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower

155

# tiers. The lowest tier is <code>1</code>.

Bu Sun Kim

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

[diff] [blame]

156

},

Bu Sun Kim

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

[diff] [blame^]

157

"superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is

158

# 'superStickerEvent'.

159

"tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower

160

# tiers. The lowest tier is <code>1</code>.

161

"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.

162

"superStickerMetadata": { # Information about the Super Sticker.

163

"altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.

164

"altText": "A String", # Internationalized alt text that describes the sticker image and any

165

# animation associated with it.

166

"stickerId": "A String", # Unique identifier of the Super Sticker. This is a shorter form of the

167

# alt_text that includes pack name and a recognizable characteristic of the

168

# sticker.

169

},

170

"currency": "A String", # The currency in which the purchase was made.

171

"amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).

172

},

173

"fanFundingEventDetails": { # Details about the funding event, this is only set if the type is

174

# 'fanFundingEvent'.

175

"userComment": "A String", # The comment added by the user to this fan funding event.

176

"amountMicros": "A String", # The amount of the fund.

177

"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.

178

"currency": "A String", # The currency in which the fund was made.

179

},

180

"textMessageDetails": { # Details about the text message, this is only set if the type is

181

# 'textMessageEvent'.

Bu Sun Kim

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

[diff] [blame]

182

"messageText": "A String", # The user's message.

183

},

Bu Sun Kim

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

[diff] [blame^]

184

"displayMessage": "A String", # Contains a string that can be displayed to the user.

185

# If this field is not present the message is silent, at the moment only

186

# messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.

187

"messageDeletedDetails": {

188

"deletedMessageId": "A String",

Jon Wayne Parrott

7d5badb

2016-08-16 12:44:29 -0700

[diff] [blame]

189

},

Bu Sun Kim

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

[diff] [blame^]

190

"type": "A String", # The type of message, this will always be present, it determines the

191

# contents of the message as well as which fields will be present.

192

"hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.

193

},

194

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

195

"authorDetails": { # The <code>authorDetails</code> object contains basic details about the

196

# user that posted this message.

197

"isChatModerator": True or False, # Whether the author is a moderator of the live chat.

198

"channelUrl": "A String", # The channel's URL.

199

"isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.

200

"isVerified": True or False, # Whether the author's identity has been verified by YouTube.

201

"isChatOwner": True or False, # Whether the author is the owner of the live chat.

202

"profileImageUrl": "A String", # The channels's avatar URL.

203

"channelId": "A String", # The YouTube channel ID.

204

"displayName": "A String", # The channel's display name.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

205

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

206

}

207

Bu Sun Kim

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

[diff] [blame^]

208

x__xgafv: string, V1 error format.

209

Allowed values

210

1 - v1 error format

211

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

212

213

Returns:

214

An object of the form:

215

Bu Sun Kim

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

[diff] [blame^]

216

{ # A <code><strong>liveChatMessage</strong></code> resource represents a chat

217

# message in a YouTube Live Chat.

218

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

219

# <code>"youtube#liveChatMessage"</code>.

Bu Sun Kim

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

[diff] [blame]

220

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

Bu Sun Kim

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

[diff] [blame^]

221

"snippet": { # The <code>snippet</code> object contains basic details about the message.

Bu Sun Kim

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

[diff] [blame]

222

"liveChatId": "A String",

Bu Sun Kim

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

[diff] [blame^]

223

"authorChannelId": "A String", # The ID of the user that authored this message, this field is not always

224

# filled.

225

# textMessageEvent - the user that wrote the message

226

# fanFundingEvent - the user that funded the broadcast

227

# newSponsorEvent - the user that just became a sponsor

228

# messageDeletedEvent - the moderator that took the action

229

# messageRetractedEvent - the author that retracted their message

230

# userBannedEvent - the moderator that took the action

231

# superChatEvent - the user that made the purchase

232

"publishedAt": "A String", # The date and time when the message was orignally published. The value is

233

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

234

# format.

235

"userBannedDetails": {

236

"banDurationSeconds": "A String", # The duration of the ban. This property is only present if the

237

# <code>banType</code> is <code>temporary</code>.

238

"bannedUserDetails": { # The details of the user that was banned.

239

"profileImageUrl": "A String", # The channels's avatar URL.

240

"channelUrl": "A String", # The channel's URL.

241

"displayName": "A String", # The channel's display name.

242

"channelId": "A String", # The YouTube channel ID.

243

},

244

"banType": "A String", # The type of ban.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

245

},

Bu Sun Kim

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

[diff] [blame]

246

"messageRetractedDetails": {

247

"retractedMessageId": "A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

248

},

Bu Sun Kim

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

[diff] [blame^]

249

"superChatDetails": { # Details about the Super Chat event, this is only set if the type is

250

# 'superChatEvent'.

Bu Sun Kim

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

[diff] [blame]

251

"amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).

Bu Sun Kim

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

[diff] [blame]

252

"userComment": "A String", # The comment added by the user to this Super Chat event.

Bu Sun Kim

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

[diff] [blame]

253

"currency": "A String", # The currency in which the purchase was made.

Bu Sun Kim

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

[diff] [blame^]

254

"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.

255

"tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower

256

# tiers. The lowest tier is <code>1</code>.

Bu Sun Kim

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

[diff] [blame]

257

},

Bu Sun Kim

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

[diff] [blame^]

258

"superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is

259

# 'superStickerEvent'.

260

"tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower

261

# tiers. The lowest tier is <code>1</code>.

262

"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.

263

"superStickerMetadata": { # Information about the Super Sticker.

264

"altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.

265

"altText": "A String", # Internationalized alt text that describes the sticker image and any

266

# animation associated with it.

267

"stickerId": "A String", # Unique identifier of the Super Sticker. This is a shorter form of the

268

# alt_text that includes pack name and a recognizable characteristic of the

269

# sticker.

270

},

271

"currency": "A String", # The currency in which the purchase was made.

272

"amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).

273

},

274

"fanFundingEventDetails": { # Details about the funding event, this is only set if the type is

275

# 'fanFundingEvent'.

276

"userComment": "A String", # The comment added by the user to this fan funding event.

277

"amountMicros": "A String", # The amount of the fund.

278

"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.

279

"currency": "A String", # The currency in which the fund was made.

280

},

281

"textMessageDetails": { # Details about the text message, this is only set if the type is

282

# 'textMessageEvent'.

Bu Sun Kim

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

[diff] [blame]

283

"messageText": "A String", # The user's message.

284

},

Bu Sun Kim

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

[diff] [blame^]

285

"displayMessage": "A String", # Contains a string that can be displayed to the user.

286

# If this field is not present the message is silent, at the moment only

287

# messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.

288

"messageDeletedDetails": {

289

"deletedMessageId": "A String",

Jon Wayne Parrott

7d5badb

2016-08-16 12:44:29 -0700

[diff] [blame]

290

},

Bu Sun Kim

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

[diff] [blame^]

291

"type": "A String", # The type of message, this will always be present, it determines the

292

# contents of the message as well as which fields will be present.

293

"hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.

294

},

295

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

296

"authorDetails": { # The <code>authorDetails</code> object contains basic details about the

297

# user that posted this message.

298

"isChatModerator": True or False, # Whether the author is a moderator of the live chat.

299

"channelUrl": "A String", # The channel's URL.

300

"isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.

301

"isVerified": True or False, # Whether the author's identity has been verified by YouTube.

302

"isChatOwner": True or False, # Whether the author is the owner of the live chat.

303

"profileImageUrl": "A String", # The channels's avatar URL.

304

"channelId": "A String", # The YouTube channel ID.

305

"displayName": "A String", # The channel's display name.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

306

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

311

<code class="details" id="list">list(liveChatId, part, pageToken=None, hl=None, maxResults=None, profileImageSize=None, x__xgafv=None)</code>

312

<pre>Retrieves a list of resources, possibly filtered.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

313

314

Args:

Bu Sun Kim

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

[diff] [blame^]

315

liveChatId: string, The id of the live chat for which comments should be returned. (required)

316

part: string, The <code><strong>part</strong></code> parameter specifies the

317

<code>liveChatComment</code> resource parts that the API response will

318

include. Supported values are <code>id</code> and <code>snippet</code>. (required) (repeated)

319

pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific

320

page in the result set that should be returned. In an API response, the

321

<code>nextPageToken</code> property identify other pages that could be

322

retrieved.

323

hl: string, Specifies the localization language in which the system messages

324

should be returned.

325

maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the

326

maximum number of items that should be returned in the result set.

327

profileImageSize: integer, Specifies the size of the profile image that should be

328

returned for each user.

329

x__xgafv: string, V1 error format.

330

Allowed values

331

1 - v1 error format

332

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

333

334

Returns:

335

An object of the form:

336

337

{

Bu Sun Kim

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

[diff] [blame^]

338

"pollingIntervalMillis": 42, # The amount of time the client should wait before polling again.

339

"items": [

340

{ # A <code><strong>liveChatMessage</strong></code> resource represents a chat

341

# message in a YouTube Live Chat.

342

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

343

# <code>"youtube#liveChatMessage"</code>.

Bu Sun Kim

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

[diff] [blame]

344

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

Bu Sun Kim

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

[diff] [blame^]

345

"snippet": { # The <code>snippet</code> object contains basic details about the message.

Bu Sun Kim

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

[diff] [blame]

346

"liveChatId": "A String",

Bu Sun Kim

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

[diff] [blame^]

347

"authorChannelId": "A String", # The ID of the user that authored this message, this field is not always

348

# filled.

349

# textMessageEvent - the user that wrote the message

350

# fanFundingEvent - the user that funded the broadcast

351

# newSponsorEvent - the user that just became a sponsor

352

# messageDeletedEvent - the moderator that took the action

353

# messageRetractedEvent - the author that retracted their message

354

# userBannedEvent - the moderator that took the action

355

# superChatEvent - the user that made the purchase

356

"publishedAt": "A String", # The date and time when the message was orignally published. The value is

357

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

358

# format.

359

"userBannedDetails": {

360

"banDurationSeconds": "A String", # The duration of the ban. This property is only present if the

361

# <code>banType</code> is <code>temporary</code>.

362

"bannedUserDetails": { # The details of the user that was banned.

363

"profileImageUrl": "A String", # The channels's avatar URL.

364

"channelUrl": "A String", # The channel's URL.

365

"displayName": "A String", # The channel's display name.

366

"channelId": "A String", # The YouTube channel ID.

367

},

368

"banType": "A String", # The type of ban.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

369

},

Bu Sun Kim

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

[diff] [blame]

370

"messageRetractedDetails": {

371

"retractedMessageId": "A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

372

},

Bu Sun Kim

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

[diff] [blame^]

373

"superChatDetails": { # Details about the Super Chat event, this is only set if the type is

374

# 'superChatEvent'.

Bu Sun Kim

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

[diff] [blame]

375

"amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).

Bu Sun Kim

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

[diff] [blame]

376

"userComment": "A String", # The comment added by the user to this Super Chat event.

Bu Sun Kim

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

[diff] [blame]

377

"currency": "A String", # The currency in which the purchase was made.

Bu Sun Kim

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

[diff] [blame^]

378

"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.

379

"tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower

380

# tiers. The lowest tier is <code>1</code>.

Bu Sun Kim

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

[diff] [blame]

381

},

Bu Sun Kim

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

[diff] [blame^]

382

"superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is

383

# 'superStickerEvent'.

384

"tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower

385

# tiers. The lowest tier is <code>1</code>.

386

"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.

387

"superStickerMetadata": { # Information about the Super Sticker.

388

"altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.

389

"altText": "A String", # Internationalized alt text that describes the sticker image and any

390

# animation associated with it.

391

"stickerId": "A String", # Unique identifier of the Super Sticker. This is a shorter form of the

392

# alt_text that includes pack name and a recognizable characteristic of the

393

# sticker.

394

},

395

"currency": "A String", # The currency in which the purchase was made.

396

"amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).

397

},

398

"fanFundingEventDetails": { # Details about the funding event, this is only set if the type is

399

# 'fanFundingEvent'.

400

"userComment": "A String", # The comment added by the user to this fan funding event.

401

"amountMicros": "A String", # The amount of the fund.

402

"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.

403

"currency": "A String", # The currency in which the fund was made.

404

},

405

"textMessageDetails": { # Details about the text message, this is only set if the type is

406

# 'textMessageEvent'.

Bu Sun Kim

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

[diff] [blame]

407

"messageText": "A String", # The user's message.

408

},

Bu Sun Kim

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

[diff] [blame^]

409

"displayMessage": "A String", # Contains a string that can be displayed to the user.

410

# If this field is not present the message is silent, at the moment only

411

# messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.

412

"messageDeletedDetails": {

413

"deletedMessageId": "A String",

Jon Wayne Parrott

7d5badb

2016-08-16 12:44:29 -0700

[diff] [blame]

414

},

Bu Sun Kim

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

[diff] [blame^]

415

"type": "A String", # The type of message, this will always be present, it determines the

416

# contents of the message as well as which fields will be present.

417

"hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.

418

},

419

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

420

"authorDetails": { # The <code>authorDetails</code> object contains basic details about the

421

# user that posted this message.

422

"isChatModerator": True or False, # Whether the author is a moderator of the live chat.

423

"channelUrl": "A String", # The channel's URL.

424

"isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.

425

"isVerified": True or False, # Whether the author's identity has been verified by YouTube.

426

"isChatOwner": True or False, # Whether the author is the owner of the live chat.

427

"profileImageUrl": "A String", # The channels's avatar URL.

428

"channelId": "A String", # The YouTube channel ID.

429

"displayName": "A String", # The channel's display name.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

430

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

431

},

432

],

Bu Sun Kim

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

[diff] [blame^]

433

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

434

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

435

# <code>"youtube#liveChatMessageListResponse"</code>.

436

"pageInfo": { # Paging details for lists of resources, including total number of items # General pagination information.

437

# available and number of resources returned in a single page.

Bu Sun Kim

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

[diff] [blame]

438

"resultsPerPage": 42, # The number of results included in the API response.

439

"totalResults": 42, # The total number of results in the result set.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

440

},

Bu Sun Kim

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

[diff] [blame^]

441

"visitorId": "A String", # The <code>visitorId</code> identifies the visitor.

442

"eventId": "A String", # Serialized EventId of the request which produced this response.

Bu Sun Kim

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

[diff] [blame]

443

"tokenPagination": { # Stub token pagination template to suppress results.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

444

},

Bu Sun Kim

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

[diff] [blame^]

445

"offlineAt": "A String", # The date and time when the underlying stream went offline. The value is

446

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

447

# format.

448

"nextPageToken": "A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

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

454

<pre>Retrieves the next page of results.

455

456

Args:

457

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

458

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

459

460

Returns:

Bu Sun Kim

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

[diff] [blame]

461

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

Jon Wayne Parrott