Blame - docs/dyn/chat_v1.spaces.messages.html - platform/external/python/google-api-python-client

<h1><a href="chat_v1.html">Hangouts Chat API</a> . <a href="chat_v1.spaces.html">spaces</a> . <a href="chat_v1.spaces.messages.html">messages</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#create">create(parent, body, threadKey=None, x__xgafv=None)</a></code></p>

79

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

80

81

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

82

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

83

84

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Returns a message.</p>

86

87

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

88

<p class="firstline">Updates a message.</p>

89

<h3>Method Details</h3>

90

91

<code class="details" id="create">create(parent, body, threadKey=None, x__xgafv=None)</code>

92

<pre>Creates a message.

93

94

Args:

95

parent: string, Required. Space resource name, in the form "spaces/*".

96

Example: spaces/AAAAMpdlehY (required)

97

body: object, The request body. (required)

98

The object takes the form of:

99

100

{ # A message in Hangouts Chat.

101

"actionResponse": { # Parameters that a bot can use to configure how it's response is posted. # Input only. Parameters that a bot can use to configure how its response is

102

# posted.

103

"url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)

104

"type": "A String", # The type of bot response.

105

},

106

"name": "A String", # Resource name, in the form "spaces/*/messages/*".

107

#

108

# Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4

109

"thread": { # A thread in Hangouts Chat. # The thread the message belongs to.

110

"name": "A String", # Resource name, in the form "spaces/*/threads/*".

111

#

112

# Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4

113

},

114

"space": { # A room or DM in Hangouts Chat. # The space the message belongs to.

115

"displayName": "A String", # Output only. The display name (only if the space is a room).

116

"type": "A String", # Output only. The type of a space.

117

"name": "A String", # Resource name of the space, in the form "spaces/*".

118

#

119

# Example: spaces/AAAAMpdlehYs

120

},

121

"text": "A String", # Plain-text body of the message.

122

"fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards

123

# cannot be displayed (e.g. mobile notifications).

124

"annotations": [ # Output only. Annotations associated with the text in this message.

125

{ # Annotations associated with the plain-text body of the message.

126

#

127

# Example plain-text message body:

128

# ```

129

# Hello @FooBot how are you!"

130

# ```

131

#

132

# The corresponding annotations metadata:

133

# ```

134

# "annotations":[{

135

# "type":"USER_MENTION",

# "startIndex":6,

# "length":7,

# "userMention": {

# "user": {

# "name":"users/107946847022116401880",

141

# "displayName":"FooBot",

142

# "avatarUrl":"https://goo.gl/aeDtrS",

# "type":"BOT"

# },

# "type":"MENTION"

# }

# }]

# ```

"userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.

150

"type": "A String", # The type of user mention.

151

"user": { # A user in Hangouts Chat. # The user mentioned.

152

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

153

"type": "A String", # User type.

154

"name": "A String", # Resource name, in the format "users/*".

155

},

156

},

157

"length": 42, # Length of the substring in the plain-text message body this annotation

158

# corresponds to.

159

"type": "A String", # The type of this annotation.

160

"startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this

161

# annotation corresponds to.

162

},

163

],

164

"argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out.

165

"cards": [ # Rich, formatted and interactive cards that can be used to display UI

166

# elements such as: formatted texts, buttons, clickable images. Cards are

167

# normally displayed below the plain-text body of the message.

168

{ # A card is a UI element that can contain UI widgets such as texts, images.

169

"cardActions": [ # The actions of this card.

170

{ # A card action is

171

# the action associated with the card. For an invoice card, a

172

# typical action would be: delete invoice, email invoice or open the

173

# invoice in browser.

174

"actionLabel": "A String", # The label used to be displayed in the action menu item.

175

"onClick": { # An onclick action (e.g. open a link). # The onclick action for this action item.

176

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

177

"url": "A String", # The URL to open.

178

},

179

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

180

# For example, an Apps Script can be invoked to handle the form.

181

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

182

# clicked/activated.

183

"parameters": [ # List of action parameters.

184

{ # List of string parameters to supply when the action method is invoked.

185

# For example, consider three snooze buttons: snooze now, snooze 1 day,

186

# snooze next week. You might use action method = snooze(), passing the

187

# snooze type and snooze time in the list of string parameters.

188

"value": "A String", # The value of the parameter.

189

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

],

"sections": [ # Sections are separated by a line divider.

197

{ # A section contains a collection of widgets that are rendered

198

# (vertically) in the order that they are specified. Across all platforms,

199

# cards have a narrow fixed width, so

200

# there is currently no need for layout properties (e.g. float).

201

"widgets": [ # A section must contain at least 1 widget.

202

{ # A widget is a UI element that presents texts, images, etc.

203

"buttons": [ # A list of buttons. Buttons is also oneof data and only one of these

204

# fields should be set.

205

{ # A button. Can be a text button or an image button.

206

"imageButton": { # An image button with an onclick action. # A button with image and onclick action.

207

"iconUrl": "A String", # The icon specified by a URL.

208

"name": "A String", # The name of this image_button which will be used for accessibility.

209

# Default value will be provided if developers don't specify.

210

"onClick": { # An onclick action (e.g. open a link). # The onclick action.

211

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

212

"url": "A String", # The URL to open.

213

},

214

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

215

# For example, an Apps Script can be invoked to handle the form.

216

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

217

# clicked/activated.

218

"parameters": [ # List of action parameters.

219

{ # List of string parameters to supply when the action method is invoked.

220

# For example, consider three snooze buttons: snooze now, snooze 1 day,

221

# snooze next week. You might use action method = snooze(), passing the

222

# snooze type and snooze time in the list of string parameters.

223

"value": "A String", # The value of the parameter.

224

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

"icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat

230

# API.

231

},

232

"textButton": { # A button with text and onclick action. # A button with text and onclick action.

233

"text": "A String", # The text of the button.

234

"onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.

235

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

236

"url": "A String", # The URL to open.

237

},

238

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

239

# For example, an Apps Script can be invoked to handle the form.

240

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

241

# clicked/activated.

242

"parameters": [ # List of action parameters.

243

{ # List of string parameters to supply when the action method is invoked.

244

# For example, consider three snooze buttons: snooze now, snooze 1 day,

245

# snooze next week. You might use action method = snooze(), passing the

246

# snooze type and snooze time in the list of string parameters.

247

"value": "A String", # The value of the parameter.

248

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

},

],

"keyValue": { # A UI element contains a key (label) and a value (content). And this # Display a key value item in this widget.

257

# element may also contain some actions such as onclick button.

258

"contentMultiline": True or False, # If the content should be multiline.

259

"bottomLabel": "A String", # The text of the bottom label. Formatted text supported.

260

"topLabel": "A String", # The text of the top label. Formatted text supported.

261

"button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.

262

"imageButton": { # An image button with an onclick action. # A button with image and onclick action.

263

"iconUrl": "A String", # The icon specified by a URL.

264

"name": "A String", # The name of this image_button which will be used for accessibility.

265

# Default value will be provided if developers don't specify.

266

"onClick": { # An onclick action (e.g. open a link). # The onclick action.

267

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

268

"url": "A String", # The URL to open.

269

},

270

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

271

# For example, an Apps Script can be invoked to handle the form.

272

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

273

# clicked/activated.

274

"parameters": [ # List of action parameters.

275

{ # List of string parameters to supply when the action method is invoked.

276

# For example, consider three snooze buttons: snooze now, snooze 1 day,

277

# snooze next week. You might use action method = snooze(), passing the

278

# snooze type and snooze time in the list of string parameters.

279

"value": "A String", # The value of the parameter.

280

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

"icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat

286

# API.

287

},

288

"textButton": { # A button with text and onclick action. # A button with text and onclick action.

289

"text": "A String", # The text of the button.

290

"onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.

291

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

292

"url": "A String", # The URL to open.

293

},

294

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

295

# For example, an Apps Script can be invoked to handle the form.

296

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

297

# clicked/activated.

298

"parameters": [ # List of action parameters.

299

{ # List of string parameters to supply when the action method is invoked.

300

# For example, consider three snooze buttons: snooze now, snooze 1 day,

301

# snooze next week. You might use action method = snooze(), passing the

302

# snooze type and snooze time in the list of string parameters.

303

"value": "A String", # The value of the parameter.

304

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

},

"content": "A String", # The text of the content. Formatted text supported and always required.

312

"iconUrl": "A String", # The icon specified by a URL.

313

"onClick": { # An onclick action (e.g. open a link). # The onclick action. Only the top label, bottom label and content region

314

# are clickable.

315

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

316

"url": "A String", # The URL to open.

317

},

318

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

319

# For example, an Apps Script can be invoked to handle the form.

320

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

321

# clicked/activated.

322

"parameters": [ # List of action parameters.

323

{ # List of string parameters to supply when the action method is invoked.

324

# For example, consider three snooze buttons: snooze now, snooze 1 day,

325

# snooze next week. You might use action method = snooze(), passing the

326

# snooze type and snooze time in the list of string parameters.

327

"value": "A String", # The value of the parameter.

328

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

"icon": "A String", # An enum value that will be replaced by the Chat API with the

334

# corresponding icon image.

335

},

336

"image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget.

337

"aspectRatio": 3.14, # The aspect ratio of this image (width/height).

338

"imageUrl": "A String", # The URL of the image.

339

"onClick": { # An onclick action (e.g. open a link). # The onclick action.

340

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

341

"url": "A String", # The URL to open.

342

},

343

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

344

# For example, an Apps Script can be invoked to handle the form.

345

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

346

# clicked/activated.

347

"parameters": [ # List of action parameters.

348

{ # List of string parameters to supply when the action method is invoked.

349

# For example, consider three snooze buttons: snooze now, snooze 1 day,

350

# snooze next week. You might use action method = snooze(), passing the

351

# snooze type and snooze time in the list of string parameters.

352

"value": "A String", # The value of the parameter.

353

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

"textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget.

"text": "A String",

},

},

],

"header": "A String", # The header of the section, text formatted supported.

365

},

366

],

367

"name": "A String", # Name of the card.

368

"header": { # The header of the card. A header usually contains a title and an image.

369

"imageStyle": "A String", # The image's type (e.g. square border or circular border).

370

"imageUrl": "A String", # The URL of the image in the card header.

371

"subtitle": "A String", # The subtitle of the card header.

372

"title": "A String", # The title must be specified. The header has a fixed height: if both a

373

# title and subtitle is specified, each will take up 1 line. If only the

374

# title is specified, it will take up both lines.

},

},

],

"previewText": "A String", # Text for generating preview chips. This text will not be displayed to the

379

# user, but any links to images, web pages, videos, etc. included here will

380

# generate preview chips.

381

"createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat

382

# server.

383

"sender": { # A user in Hangouts Chat. # The user who created the message.

384

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

385

"type": "A String", # User type.

386

"name": "A String", # Resource name, in the format "users/*".

},

}

threadKey: string, Opaque thread identifier string that can be specified to group messages

391

into a single thread. If this is the first message with a given thread

392

identifier, a new thread is created. Subsequent messages with the same

393

thread identifier will be posted into the same thread. This relieves bots

394

and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post

395

further updates to it.

396

397

Has no effect if thread field,

398

corresponding to an existing thread, is set in message.

399

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

406

407

{ # A message in Hangouts Chat.

408

"actionResponse": { # Parameters that a bot can use to configure how it's response is posted. # Input only. Parameters that a bot can use to configure how its response is

409

# posted.

410

"url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)

411

"type": "A String", # The type of bot response.

412

},

413

"name": "A String", # Resource name, in the form "spaces/*/messages/*".

414

#

415

# Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4

416

"thread": { # A thread in Hangouts Chat. # The thread the message belongs to.

417

"name": "A String", # Resource name, in the form "spaces/*/threads/*".

418

#

419

# Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4

420

},

421

"space": { # A room or DM in Hangouts Chat. # The space the message belongs to.

422

"displayName": "A String", # Output only. The display name (only if the space is a room).

423

"type": "A String", # Output only. The type of a space.

424

"name": "A String", # Resource name of the space, in the form "spaces/*".

425

#

426

# Example: spaces/AAAAMpdlehYs

427

},

428

"text": "A String", # Plain-text body of the message.

429

"fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards

430

# cannot be displayed (e.g. mobile notifications).

431

"annotations": [ # Output only. Annotations associated with the text in this message.

432

{ # Annotations associated with the plain-text body of the message.

433

#

434

# Example plain-text message body:

435

# ```

436

# Hello @FooBot how are you!"

437

# ```

438

#

439

# The corresponding annotations metadata:

440

# ```

441

# "annotations":[{

442

# "type":"USER_MENTION",

# "startIndex":6,

# "length":7,

# "userMention": {

# "user": {

# "name":"users/107946847022116401880",

448

# "displayName":"FooBot",

449

# "avatarUrl":"https://goo.gl/aeDtrS",

# "type":"BOT"

# },

# "type":"MENTION"

# }

# }]

# ```

"userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.

457

"type": "A String", # The type of user mention.

458

"user": { # A user in Hangouts Chat. # The user mentioned.

459

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

460

"type": "A String", # User type.

461

"name": "A String", # Resource name, in the format "users/*".

462

},

463

},

464

"length": 42, # Length of the substring in the plain-text message body this annotation

465

# corresponds to.

466

"type": "A String", # The type of this annotation.

467

"startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this

468

# annotation corresponds to.

469

},

470

],

471

"argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out.

472

"cards": [ # Rich, formatted and interactive cards that can be used to display UI

473

# elements such as: formatted texts, buttons, clickable images. Cards are

474

# normally displayed below the plain-text body of the message.

475

{ # A card is a UI element that can contain UI widgets such as texts, images.

476

"cardActions": [ # The actions of this card.

477

{ # A card action is

478

# the action associated with the card. For an invoice card, a

479

# typical action would be: delete invoice, email invoice or open the

480

# invoice in browser.

481

"actionLabel": "A String", # The label used to be displayed in the action menu item.

482

"onClick": { # An onclick action (e.g. open a link). # The onclick action for this action item.

483

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

484

"url": "A String", # The URL to open.

485

},

486

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

487

# For example, an Apps Script can be invoked to handle the form.

488

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

489

# clicked/activated.

490

"parameters": [ # List of action parameters.

491

{ # List of string parameters to supply when the action method is invoked.

492

# For example, consider three snooze buttons: snooze now, snooze 1 day,

493

# snooze next week. You might use action method = snooze(), passing the

494

# snooze type and snooze time in the list of string parameters.

495

"value": "A String", # The value of the parameter.

496

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

],

"sections": [ # Sections are separated by a line divider.

504

{ # A section contains a collection of widgets that are rendered

505

# (vertically) in the order that they are specified. Across all platforms,

506

# cards have a narrow fixed width, so

507

# there is currently no need for layout properties (e.g. float).

508

"widgets": [ # A section must contain at least 1 widget.

509

{ # A widget is a UI element that presents texts, images, etc.

510

"buttons": [ # A list of buttons. Buttons is also oneof data and only one of these

511

# fields should be set.

512

{ # A button. Can be a text button or an image button.

513

"imageButton": { # An image button with an onclick action. # A button with image and onclick action.

514

"iconUrl": "A String", # The icon specified by a URL.

515

"name": "A String", # The name of this image_button which will be used for accessibility.

516

# Default value will be provided if developers don't specify.

517

"onClick": { # An onclick action (e.g. open a link). # The onclick action.

518

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

519

"url": "A String", # The URL to open.

520

},

521

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

522

# For example, an Apps Script can be invoked to handle the form.

523

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

524

# clicked/activated.

525

"parameters": [ # List of action parameters.

526

{ # List of string parameters to supply when the action method is invoked.

527

# For example, consider three snooze buttons: snooze now, snooze 1 day,

528

# snooze next week. You might use action method = snooze(), passing the

529

# snooze type and snooze time in the list of string parameters.

530

"value": "A String", # The value of the parameter.

531

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

"icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat

537

# API.

538

},

539

"textButton": { # A button with text and onclick action. # A button with text and onclick action.

540

"text": "A String", # The text of the button.

541

"onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.

542

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

543

"url": "A String", # The URL to open.

544

},

545

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

546

# For example, an Apps Script can be invoked to handle the form.

547

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

548

# clicked/activated.

549

"parameters": [ # List of action parameters.

550

{ # List of string parameters to supply when the action method is invoked.

551

# For example, consider three snooze buttons: snooze now, snooze 1 day,

552

# snooze next week. You might use action method = snooze(), passing the

553

# snooze type and snooze time in the list of string parameters.

554

"value": "A String", # The value of the parameter.

555

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

},

],

"keyValue": { # A UI element contains a key (label) and a value (content). And this # Display a key value item in this widget.

564

# element may also contain some actions such as onclick button.

565

"contentMultiline": True or False, # If the content should be multiline.

566

"bottomLabel": "A String", # The text of the bottom label. Formatted text supported.

567

"topLabel": "A String", # The text of the top label. Formatted text supported.

568

"button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.

569

"imageButton": { # An image button with an onclick action. # A button with image and onclick action.

570

"iconUrl": "A String", # The icon specified by a URL.

571

"name": "A String", # The name of this image_button which will be used for accessibility.

572

# Default value will be provided if developers don't specify.

573

"onClick": { # An onclick action (e.g. open a link). # The onclick action.

574

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

575

"url": "A String", # The URL to open.

576

},

577

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

578

# For example, an Apps Script can be invoked to handle the form.

579

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

580

# clicked/activated.

581

"parameters": [ # List of action parameters.

582

{ # List of string parameters to supply when the action method is invoked.

583

# For example, consider three snooze buttons: snooze now, snooze 1 day,

584

# snooze next week. You might use action method = snooze(), passing the

585

# snooze type and snooze time in the list of string parameters.

586

"value": "A String", # The value of the parameter.

587

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

"icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat

593

# API.

594

},

595

"textButton": { # A button with text and onclick action. # A button with text and onclick action.

596

"text": "A String", # The text of the button.

597

"onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.

598

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

599

"url": "A String", # The URL to open.

600

},

601

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

602

# For example, an Apps Script can be invoked to handle the form.

603

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

604

# clicked/activated.

605

"parameters": [ # List of action parameters.

606

{ # List of string parameters to supply when the action method is invoked.

607

# For example, consider three snooze buttons: snooze now, snooze 1 day,

608

# snooze next week. You might use action method = snooze(), passing the

609

# snooze type and snooze time in the list of string parameters.

610

"value": "A String", # The value of the parameter.

611

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

},

"content": "A String", # The text of the content. Formatted text supported and always required.

619

"iconUrl": "A String", # The icon specified by a URL.

620

"onClick": { # An onclick action (e.g. open a link). # The onclick action. Only the top label, bottom label and content region

621

# are clickable.

622

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

623

"url": "A String", # The URL to open.

624

},

625

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

626

# For example, an Apps Script can be invoked to handle the form.

627

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

628

# clicked/activated.

629

"parameters": [ # List of action parameters.

630

{ # List of string parameters to supply when the action method is invoked.

631

# For example, consider three snooze buttons: snooze now, snooze 1 day,

632

# snooze next week. You might use action method = snooze(), passing the

633

# snooze type and snooze time in the list of string parameters.

634

"value": "A String", # The value of the parameter.

635

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

"icon": "A String", # An enum value that will be replaced by the Chat API with the

641

# corresponding icon image.

642

},

643

"image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget.

644

"aspectRatio": 3.14, # The aspect ratio of this image (width/height).

645

"imageUrl": "A String", # The URL of the image.

646

"onClick": { # An onclick action (e.g. open a link). # The onclick action.

647

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

648

"url": "A String", # The URL to open.

649

},

650

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

651

# For example, an Apps Script can be invoked to handle the form.

652

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

653

# clicked/activated.

654

"parameters": [ # List of action parameters.

655

{ # List of string parameters to supply when the action method is invoked.

656

# For example, consider three snooze buttons: snooze now, snooze 1 day,

657

# snooze next week. You might use action method = snooze(), passing the

658

# snooze type and snooze time in the list of string parameters.

659

"value": "A String", # The value of the parameter.

660

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

"textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget.

"text": "A String",

},

},

],

"header": "A String", # The header of the section, text formatted supported.

672

},

673

],

674

"name": "A String", # Name of the card.

675

"header": { # The header of the card. A header usually contains a title and an image.

676

"imageStyle": "A String", # The image's type (e.g. square border or circular border).

677

"imageUrl": "A String", # The URL of the image in the card header.

678

"subtitle": "A String", # The subtitle of the card header.

679

"title": "A String", # The title must be specified. The header has a fixed height: if both a

680

# title and subtitle is specified, each will take up 1 line. If only the

681

# title is specified, it will take up both lines.

},

},

],

"previewText": "A String", # Text for generating preview chips. This text will not be displayed to the

686

# user, but any links to images, web pages, videos, etc. included here will

687

# generate preview chips.

688

"createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat

689

# server.

690

"sender": { # A user in Hangouts Chat. # The user who created the message.

691

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

692

"type": "A String", # User type.

693

"name": "A String", # Resource name, in the format "users/*".

},

}</pre>

</div>

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

700

<pre>Deletes a message.

701

702

Args:

703

name: string, Required. Resource name of the message to be deleted, in the form

704

"spaces/*/messages/*"

705

706

Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 (required)

707

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

714

715

{ # A generic empty message that you can re-use to avoid defining duplicated

716

# empty messages in your APIs. A typical example is to use it as the request

717

# or the response type of an API method. For instance:

718

#

719

# service Foo {

720

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

721

# }

722

#

723

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

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

729

<pre>Returns a message.

730

731

Args:

732

name: string, Required. Resource name of the message to be retrieved, in the form

733

"spaces/*/messages/*".

734

735

Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 (required)

736

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

743

744

{ # A message in Hangouts Chat.

745

"actionResponse": { # Parameters that a bot can use to configure how it's response is posted. # Input only. Parameters that a bot can use to configure how its response is

746

# posted.

747

"url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)

748

"type": "A String", # The type of bot response.

749

},

750

"name": "A String", # Resource name, in the form "spaces/*/messages/*".

751

#

752

# Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4

753

"thread": { # A thread in Hangouts Chat. # The thread the message belongs to.

754

"name": "A String", # Resource name, in the form "spaces/*/threads/*".

755

#

756

# Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4

757

},

758

"space": { # A room or DM in Hangouts Chat. # The space the message belongs to.

759

"displayName": "A String", # Output only. The display name (only if the space is a room).

760

"type": "A String", # Output only. The type of a space.

761

"name": "A String", # Resource name of the space, in the form "spaces/*".

762

#

763

# Example: spaces/AAAAMpdlehYs

764

},

765

"text": "A String", # Plain-text body of the message.

766

"fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards

767

# cannot be displayed (e.g. mobile notifications).

768

"annotations": [ # Output only. Annotations associated with the text in this message.

769

{ # Annotations associated with the plain-text body of the message.

770

#

771

# Example plain-text message body:

772

# ```

773

# Hello @FooBot how are you!"

774

# ```

775

#

776

# The corresponding annotations metadata:

777

# ```

778

# "annotations":[{

779

# "type":"USER_MENTION",

# "startIndex":6,

# "length":7,

# "userMention": {

# "user": {

# "name":"users/107946847022116401880",

785

# "displayName":"FooBot",

786

# "avatarUrl":"https://goo.gl/aeDtrS",

# "type":"BOT"

# },

# "type":"MENTION"

# }

# }]

# ```

"userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.

794

"type": "A String", # The type of user mention.

795

"user": { # A user in Hangouts Chat. # The user mentioned.

796

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

797

"type": "A String", # User type.

798

"name": "A String", # Resource name, in the format "users/*".

799

},

800

},

801

"length": 42, # Length of the substring in the plain-text message body this annotation

802

# corresponds to.

803

"type": "A String", # The type of this annotation.

804

"startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this

805

# annotation corresponds to.

806

},

807

],

808

"argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out.

809

"cards": [ # Rich, formatted and interactive cards that can be used to display UI

810

# elements such as: formatted texts, buttons, clickable images. Cards are

811

# normally displayed below the plain-text body of the message.

812

{ # A card is a UI element that can contain UI widgets such as texts, images.

813

"cardActions": [ # The actions of this card.

814

{ # A card action is

815

# the action associated with the card. For an invoice card, a

816

# typical action would be: delete invoice, email invoice or open the

817

# invoice in browser.

818

"actionLabel": "A String", # The label used to be displayed in the action menu item.

819

"onClick": { # An onclick action (e.g. open a link). # The onclick action for this action item.

820

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

821

"url": "A String", # The URL to open.

822

},

823

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

824

# For example, an Apps Script can be invoked to handle the form.

825

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

826

# clicked/activated.

827

"parameters": [ # List of action parameters.

828

{ # List of string parameters to supply when the action method is invoked.

829

# For example, consider three snooze buttons: snooze now, snooze 1 day,

830

# snooze next week. You might use action method = snooze(), passing the

831

# snooze type and snooze time in the list of string parameters.

832

"value": "A String", # The value of the parameter.

833

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

],

"sections": [ # Sections are separated by a line divider.

841

{ # A section contains a collection of widgets that are rendered

842

# (vertically) in the order that they are specified. Across all platforms,

843

# cards have a narrow fixed width, so

844

# there is currently no need for layout properties (e.g. float).

845

"widgets": [ # A section must contain at least 1 widget.

846

{ # A widget is a UI element that presents texts, images, etc.

847

"buttons": [ # A list of buttons. Buttons is also oneof data and only one of these

848

# fields should be set.

849

{ # A button. Can be a text button or an image button.

850

"imageButton": { # An image button with an onclick action. # A button with image and onclick action.

851

"iconUrl": "A String", # The icon specified by a URL.

852

"name": "A String", # The name of this image_button which will be used for accessibility.

853

# Default value will be provided if developers don't specify.

854

"onClick": { # An onclick action (e.g. open a link). # The onclick action.

855

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

856

"url": "A String", # The URL to open.

857

},

858

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

859

# For example, an Apps Script can be invoked to handle the form.

860

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

861

# clicked/activated.

862

"parameters": [ # List of action parameters.

863

{ # List of string parameters to supply when the action method is invoked.

864

# For example, consider three snooze buttons: snooze now, snooze 1 day,

865

# snooze next week. You might use action method = snooze(), passing the

866

# snooze type and snooze time in the list of string parameters.

867

"value": "A String", # The value of the parameter.

868

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

"icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat

874

# API.

875

},

876

"textButton": { # A button with text and onclick action. # A button with text and onclick action.

877

"text": "A String", # The text of the button.

878

"onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.

879

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

880

"url": "A String", # The URL to open.

881

},

882

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

883

# For example, an Apps Script can be invoked to handle the form.

884

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

885

# clicked/activated.

886

"parameters": [ # List of action parameters.

887

{ # List of string parameters to supply when the action method is invoked.

888

# For example, consider three snooze buttons: snooze now, snooze 1 day,

889

# snooze next week. You might use action method = snooze(), passing the

890

# snooze type and snooze time in the list of string parameters.

891

"value": "A String", # The value of the parameter.

892

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

},

],

"keyValue": { # A UI element contains a key (label) and a value (content). And this # Display a key value item in this widget.

901

# element may also contain some actions such as onclick button.

902

"contentMultiline": True or False, # If the content should be multiline.

903

"bottomLabel": "A String", # The text of the bottom label. Formatted text supported.

904

"topLabel": "A String", # The text of the top label. Formatted text supported.

905

"button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.

906

"imageButton": { # An image button with an onclick action. # A button with image and onclick action.

907

"iconUrl": "A String", # The icon specified by a URL.

908

"name": "A String", # The name of this image_button which will be used for accessibility.

909

# Default value will be provided if developers don't specify.

910

"onClick": { # An onclick action (e.g. open a link). # The onclick action.

911

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

912

"url": "A String", # The URL to open.

913

},

914

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

915

# For example, an Apps Script can be invoked to handle the form.

916

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

917

# clicked/activated.

918

"parameters": [ # List of action parameters.

919

{ # List of string parameters to supply when the action method is invoked.

920

# For example, consider three snooze buttons: snooze now, snooze 1 day,

921

# snooze next week. You might use action method = snooze(), passing the

922

# snooze type and snooze time in the list of string parameters.

923

"value": "A String", # The value of the parameter.

924

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

"icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat

930

# API.

931

},

932

"textButton": { # A button with text and onclick action. # A button with text and onclick action.

933

"text": "A String", # The text of the button.

934

"onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.

935

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

936

"url": "A String", # The URL to open.

937

},

938

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

939

# For example, an Apps Script can be invoked to handle the form.

940

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

941

# clicked/activated.

942

"parameters": [ # List of action parameters.

943

{ # List of string parameters to supply when the action method is invoked.

944

# For example, consider three snooze buttons: snooze now, snooze 1 day,

945

# snooze next week. You might use action method = snooze(), passing the

946

# snooze type and snooze time in the list of string parameters.

947

"value": "A String", # The value of the parameter.

948

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

},

"content": "A String", # The text of the content. Formatted text supported and always required.

956

"iconUrl": "A String", # The icon specified by a URL.

957

"onClick": { # An onclick action (e.g. open a link). # The onclick action. Only the top label, bottom label and content region

958

# are clickable.

959

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

960

"url": "A String", # The URL to open.

961

},

962

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

963

# For example, an Apps Script can be invoked to handle the form.

964

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

965

# clicked/activated.

966

"parameters": [ # List of action parameters.

967

{ # List of string parameters to supply when the action method is invoked.

968

# For example, consider three snooze buttons: snooze now, snooze 1 day,

969

# snooze next week. You might use action method = snooze(), passing the

970

# snooze type and snooze time in the list of string parameters.

971

"value": "A String", # The value of the parameter.

972

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

"icon": "A String", # An enum value that will be replaced by the Chat API with the

978

# corresponding icon image.

979

},

980

"image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget.

981

"aspectRatio": 3.14, # The aspect ratio of this image (width/height).

982

"imageUrl": "A String", # The URL of the image.

983

"onClick": { # An onclick action (e.g. open a link). # The onclick action.

984

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

985

"url": "A String", # The URL to open.

986

},

987

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

988

# For example, an Apps Script can be invoked to handle the form.

989

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

990

# clicked/activated.

991

"parameters": [ # List of action parameters.

992

{ # List of string parameters to supply when the action method is invoked.

993

# For example, consider three snooze buttons: snooze now, snooze 1 day,

994

# snooze next week. You might use action method = snooze(), passing the

995

# snooze type and snooze time in the list of string parameters.

996

"value": "A String", # The value of the parameter.

997

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

"textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget.

"text": "A String",

},

},

],

"header": "A String", # The header of the section, text formatted supported.

1009

},

1010

],

1011

"name": "A String", # Name of the card.

1012

"header": { # The header of the card. A header usually contains a title and an image.

1013

"imageStyle": "A String", # The image's type (e.g. square border or circular border).

1014

"imageUrl": "A String", # The URL of the image in the card header.

1015

"subtitle": "A String", # The subtitle of the card header.

1016

"title": "A String", # The title must be specified. The header has a fixed height: if both a

1017

# title and subtitle is specified, each will take up 1 line. If only the

1018

# title is specified, it will take up both lines.

},

},

],

"previewText": "A String", # Text for generating preview chips. This text will not be displayed to the

1023

# user, but any links to images, web pages, videos, etc. included here will

1024

# generate preview chips.

1025

"createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat

1026

# server.

1027

"sender": { # A user in Hangouts Chat. # The user who created the message.

1028

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

1029

"type": "A String", # User type.

1030

"name": "A String", # Resource name, in the format "users/*".

},

}</pre>

</div>

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

1037

<pre>Updates a message.

1038

1039

Args:

1040

name: string, Resource name, in the form "spaces/*/messages/*".

1041

1042

Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 (required)

1043

body: object, The request body. (required)

1044

The object takes the form of:

1045

1046

{ # A message in Hangouts Chat.

1047

"actionResponse": { # Parameters that a bot can use to configure how it's response is posted. # Input only. Parameters that a bot can use to configure how its response is

1048

# posted.

1049

"url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)

1050

"type": "A String", # The type of bot response.

1051

},

1052

"name": "A String", # Resource name, in the form "spaces/*/messages/*".

1053

#

1054

# Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4

1055

"thread": { # A thread in Hangouts Chat. # The thread the message belongs to.

1056

"name": "A String", # Resource name, in the form "spaces/*/threads/*".

1057

#

1058

# Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4

1059

},

1060

"space": { # A room or DM in Hangouts Chat. # The space the message belongs to.

1061

"displayName": "A String", # Output only. The display name (only if the space is a room).

1062

"type": "A String", # Output only. The type of a space.

1063

"name": "A String", # Resource name of the space, in the form "spaces/*".

1064

#

1065

# Example: spaces/AAAAMpdlehYs

1066

},

1067

"text": "A String", # Plain-text body of the message.

1068

"fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards

1069

# cannot be displayed (e.g. mobile notifications).

1070

"annotations": [ # Output only. Annotations associated with the text in this message.

1071

{ # Annotations associated with the plain-text body of the message.

1072

#

1073

# Example plain-text message body:

1074

# ```

1075

# Hello @FooBot how are you!"

1076

# ```

1077

#

1078

# The corresponding annotations metadata:

1079

# ```

1080

# "annotations":[{

1081

# "type":"USER_MENTION",

# "startIndex":6,

# "length":7,

# "userMention": {

# "user": {

# "name":"users/107946847022116401880",

1087

# "displayName":"FooBot",

1088

# "avatarUrl":"https://goo.gl/aeDtrS",

# "type":"BOT"

# },

# "type":"MENTION"

# }

# }]

# ```

"userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.

1096

"type": "A String", # The type of user mention.

1097

"user": { # A user in Hangouts Chat. # The user mentioned.

1098

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

1099

"type": "A String", # User type.

1100

"name": "A String", # Resource name, in the format "users/*".

1101

},

1102

},

1103

"length": 42, # Length of the substring in the plain-text message body this annotation

1104

# corresponds to.

1105

"type": "A String", # The type of this annotation.

1106

"startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this

1107

# annotation corresponds to.

1108

},

1109

],

1110

"argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out.

1111

"cards": [ # Rich, formatted and interactive cards that can be used to display UI

1112

# elements such as: formatted texts, buttons, clickable images. Cards are

1113

# normally displayed below the plain-text body of the message.

1114

{ # A card is a UI element that can contain UI widgets such as texts, images.

1115

"cardActions": [ # The actions of this card.

1116

{ # A card action is

1117

# the action associated with the card. For an invoice card, a

1118

# typical action would be: delete invoice, email invoice or open the

1119

# invoice in browser.

1120

"actionLabel": "A String", # The label used to be displayed in the action menu item.

1121

"onClick": { # An onclick action (e.g. open a link). # The onclick action for this action item.

1122

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

1123

"url": "A String", # The URL to open.

1124

},

1125

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

1126

# For example, an Apps Script can be invoked to handle the form.

1127

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

1128

# clicked/activated.

1129

"parameters": [ # List of action parameters.

1130

{ # List of string parameters to supply when the action method is invoked.

1131

# For example, consider three snooze buttons: snooze now, snooze 1 day,

1132

# snooze next week. You might use action method = snooze(), passing the

1133

# snooze type and snooze time in the list of string parameters.

1134

"value": "A String", # The value of the parameter.

1135

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

],

"sections": [ # Sections are separated by a line divider.

1143

{ # A section contains a collection of widgets that are rendered

1144

# (vertically) in the order that they are specified. Across all platforms,

1145

# cards have a narrow fixed width, so

1146

# there is currently no need for layout properties (e.g. float).

1147

"widgets": [ # A section must contain at least 1 widget.

1148

{ # A widget is a UI element that presents texts, images, etc.

1149

"buttons": [ # A list of buttons. Buttons is also oneof data and only one of these

1150

# fields should be set.

1151

{ # A button. Can be a text button or an image button.

1152

"imageButton": { # An image button with an onclick action. # A button with image and onclick action.

1153

"iconUrl": "A String", # The icon specified by a URL.

1154

"name": "A String", # The name of this image_button which will be used for accessibility.

1155

# Default value will be provided if developers don't specify.

1156

"onClick": { # An onclick action (e.g. open a link). # The onclick action.

1157

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

1158

"url": "A String", # The URL to open.

1159

},

1160

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

1161

# For example, an Apps Script can be invoked to handle the form.

1162

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

1163

# clicked/activated.

1164

"parameters": [ # List of action parameters.

1165

{ # List of string parameters to supply when the action method is invoked.

1166

# For example, consider three snooze buttons: snooze now, snooze 1 day,

1167

# snooze next week. You might use action method = snooze(), passing the

1168

# snooze type and snooze time in the list of string parameters.

1169

"value": "A String", # The value of the parameter.

1170

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

"icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat

1176

# API.

1177

},

1178

"textButton": { # A button with text and onclick action. # A button with text and onclick action.

1179

"text": "A String", # The text of the button.

1180

"onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.

1181

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

1182

"url": "A String", # The URL to open.

1183

},

1184

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

1185

# For example, an Apps Script can be invoked to handle the form.

1186

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

1187

# clicked/activated.

1188

"parameters": [ # List of action parameters.

1189

{ # List of string parameters to supply when the action method is invoked.

1190

# For example, consider three snooze buttons: snooze now, snooze 1 day,

1191

# snooze next week. You might use action method = snooze(), passing the

1192

# snooze type and snooze time in the list of string parameters.

1193

"value": "A String", # The value of the parameter.

1194

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

},

],

"keyValue": { # A UI element contains a key (label) and a value (content). And this # Display a key value item in this widget.

1203

# element may also contain some actions such as onclick button.

1204

"contentMultiline": True or False, # If the content should be multiline.

1205

"bottomLabel": "A String", # The text of the bottom label. Formatted text supported.

1206

"topLabel": "A String", # The text of the top label. Formatted text supported.

1207

"button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.

1208

"imageButton": { # An image button with an onclick action. # A button with image and onclick action.

1209

"iconUrl": "A String", # The icon specified by a URL.

1210

"name": "A String", # The name of this image_button which will be used for accessibility.

1211

# Default value will be provided if developers don't specify.

1212

"onClick": { # An onclick action (e.g. open a link). # The onclick action.

1213

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

1214

"url": "A String", # The URL to open.

1215

},

1216

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

1217

# For example, an Apps Script can be invoked to handle the form.

1218

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

1219

# clicked/activated.

1220

"parameters": [ # List of action parameters.

1221

{ # List of string parameters to supply when the action method is invoked.

1222

# For example, consider three snooze buttons: snooze now, snooze 1 day,

1223

# snooze next week. You might use action method = snooze(), passing the

1224

# snooze type and snooze time in the list of string parameters.

1225

"value": "A String", # The value of the parameter.

1226

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

"icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat

1232

# API.

1233

},

1234

"textButton": { # A button with text and onclick action. # A button with text and onclick action.

1235

"text": "A String", # The text of the button.

1236

"onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.

1237

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

1238

"url": "A String", # The URL to open.

1239

},

1240

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

1241

# For example, an Apps Script can be invoked to handle the form.

1242

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

1243

# clicked/activated.

1244

"parameters": [ # List of action parameters.

1245

{ # List of string parameters to supply when the action method is invoked.

1246

# For example, consider three snooze buttons: snooze now, snooze 1 day,

1247

# snooze next week. You might use action method = snooze(), passing the

1248

# snooze type and snooze time in the list of string parameters.

1249

"value": "A String", # The value of the parameter.

1250

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

},

"content": "A String", # The text of the content. Formatted text supported and always required.

1258

"iconUrl": "A String", # The icon specified by a URL.

1259

"onClick": { # An onclick action (e.g. open a link). # The onclick action. Only the top label, bottom label and content region

1260

# are clickable.

1261

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

1262

"url": "A String", # The URL to open.

1263

},

1264

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

1265

# For example, an Apps Script can be invoked to handle the form.

1266

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

1267

# clicked/activated.

1268

"parameters": [ # List of action parameters.

1269

{ # List of string parameters to supply when the action method is invoked.

1270

# For example, consider three snooze buttons: snooze now, snooze 1 day,

1271

# snooze next week. You might use action method = snooze(), passing the

1272

# snooze type and snooze time in the list of string parameters.

1273

"value": "A String", # The value of the parameter.

1274

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

"icon": "A String", # An enum value that will be replaced by the Chat API with the

1280

# corresponding icon image.

1281

},

1282

"image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget.

1283

"aspectRatio": 3.14, # The aspect ratio of this image (width/height).

1284

"imageUrl": "A String", # The URL of the image.

1285

"onClick": { # An onclick action (e.g. open a link). # The onclick action.

1286

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

1287

"url": "A String", # The URL to open.

1288

},

1289

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

1290

# For example, an Apps Script can be invoked to handle the form.

1291

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

1292

# clicked/activated.

1293

"parameters": [ # List of action parameters.

1294

{ # List of string parameters to supply when the action method is invoked.

1295

# For example, consider three snooze buttons: snooze now, snooze 1 day,

1296

# snooze next week. You might use action method = snooze(), passing the

1297

# snooze type and snooze time in the list of string parameters.

1298

"value": "A String", # The value of the parameter.

1299

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

"textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget.

"text": "A String",

},

},

],

"header": "A String", # The header of the section, text formatted supported.

1311

},

1312

],

1313

"name": "A String", # Name of the card.

1314

"header": { # The header of the card. A header usually contains a title and an image.

1315

"imageStyle": "A String", # The image's type (e.g. square border or circular border).

1316

"imageUrl": "A String", # The URL of the image in the card header.

1317

"subtitle": "A String", # The subtitle of the card header.

1318

"title": "A String", # The title must be specified. The header has a fixed height: if both a

1319

# title and subtitle is specified, each will take up 1 line. If only the

1320

# title is specified, it will take up both lines.

},

},

],

"previewText": "A String", # Text for generating preview chips. This text will not be displayed to the

1325

# user, but any links to images, web pages, videos, etc. included here will

1326

# generate preview chips.

1327

"createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat

1328

# server.

1329

"sender": { # A user in Hangouts Chat. # The user who created the message.

1330

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

1331

"type": "A String", # User type.

1332

"name": "A String", # Resource name, in the format "users/*".

},

}

updateMask: string, Required. The field paths to be updated.

1337

1338

Currently supported field paths: "text", "cards".

1339

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1346

1347

{ # A message in Hangouts Chat.

1348

"actionResponse": { # Parameters that a bot can use to configure how it's response is posted. # Input only. Parameters that a bot can use to configure how its response is

1349

# posted.

1350

"url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)

1351

"type": "A String", # The type of bot response.

1352

},

1353

"name": "A String", # Resource name, in the form "spaces/*/messages/*".

1354

#

1355

# Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4

1356

"thread": { # A thread in Hangouts Chat. # The thread the message belongs to.

1357

"name": "A String", # Resource name, in the form "spaces/*/threads/*".

1358

#

1359

# Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4

1360

},

1361

"space": { # A room or DM in Hangouts Chat. # The space the message belongs to.

1362

"displayName": "A String", # Output only. The display name (only if the space is a room).

1363

"type": "A String", # Output only. The type of a space.

1364

"name": "A String", # Resource name of the space, in the form "spaces/*".

1365

#

1366

# Example: spaces/AAAAMpdlehYs

1367

},

1368

"text": "A String", # Plain-text body of the message.

1369

"fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards

1370

# cannot be displayed (e.g. mobile notifications).

1371

"annotations": [ # Output only. Annotations associated with the text in this message.

1372

{ # Annotations associated with the plain-text body of the message.

1373

#

1374

# Example plain-text message body:

1375

# ```

1376

# Hello @FooBot how are you!"

1377

# ```

1378

#

1379

# The corresponding annotations metadata:

1380

# ```

1381

# "annotations":[{

1382

# "type":"USER_MENTION",

# "startIndex":6,

# "length":7,

# "userMention": {

# "user": {

# "name":"users/107946847022116401880",

1388

# "displayName":"FooBot",

1389

# "avatarUrl":"https://goo.gl/aeDtrS",

# "type":"BOT"

# },

# "type":"MENTION"

# }

# }]

# ```

"userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.

1397

"type": "A String", # The type of user mention.

1398

"user": { # A user in Hangouts Chat. # The user mentioned.

1399

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

1400

"type": "A String", # User type.

1401

"name": "A String", # Resource name, in the format "users/*".

1402

},

1403

},

1404

"length": 42, # Length of the substring in the plain-text message body this annotation

1405

# corresponds to.

1406

"type": "A String", # The type of this annotation.

1407

"startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this

1408

# annotation corresponds to.

1409

},

1410

],

1411

"argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out.

1412

"cards": [ # Rich, formatted and interactive cards that can be used to display UI

1413

# elements such as: formatted texts, buttons, clickable images. Cards are

1414

# normally displayed below the plain-text body of the message.

1415

{ # A card is a UI element that can contain UI widgets such as texts, images.

1416

"cardActions": [ # The actions of this card.

1417

{ # A card action is

1418

# the action associated with the card. For an invoice card, a

1419

# typical action would be: delete invoice, email invoice or open the

1420

# invoice in browser.

1421

"actionLabel": "A String", # The label used to be displayed in the action menu item.

1422

"onClick": { # An onclick action (e.g. open a link). # The onclick action for this action item.

1423

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

1424

"url": "A String", # The URL to open.

1425

},

1426

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

1427

# For example, an Apps Script can be invoked to handle the form.

1428

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

1429

# clicked/activated.

1430

"parameters": [ # List of action parameters.

1431

{ # List of string parameters to supply when the action method is invoked.

1432

# For example, consider three snooze buttons: snooze now, snooze 1 day,

1433

# snooze next week. You might use action method = snooze(), passing the

1434

# snooze type and snooze time in the list of string parameters.

1435

"value": "A String", # The value of the parameter.

1436

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

],

"sections": [ # Sections are separated by a line divider.

1444

{ # A section contains a collection of widgets that are rendered

1445

# (vertically) in the order that they are specified. Across all platforms,

1446

# cards have a narrow fixed width, so

1447

# there is currently no need for layout properties (e.g. float).

1448

"widgets": [ # A section must contain at least 1 widget.

1449

{ # A widget is a UI element that presents texts, images, etc.

1450

"buttons": [ # A list of buttons. Buttons is also oneof data and only one of these

1451

# fields should be set.

1452

{ # A button. Can be a text button or an image button.

1453

"imageButton": { # An image button with an onclick action. # A button with image and onclick action.

1454

"iconUrl": "A String", # The icon specified by a URL.

1455

"name": "A String", # The name of this image_button which will be used for accessibility.

1456

# Default value will be provided if developers don't specify.

1457

"onClick": { # An onclick action (e.g. open a link). # The onclick action.

1458

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

1459

"url": "A String", # The URL to open.

1460

},

1461

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

1462

# For example, an Apps Script can be invoked to handle the form.

1463

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

1464

# clicked/activated.

1465

"parameters": [ # List of action parameters.

1466

{ # List of string parameters to supply when the action method is invoked.

1467

# For example, consider three snooze buttons: snooze now, snooze 1 day,

1468

# snooze next week. You might use action method = snooze(), passing the

1469

# snooze type and snooze time in the list of string parameters.

1470

"value": "A String", # The value of the parameter.

1471

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

"icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat

1477

# API.

1478

},

1479

"textButton": { # A button with text and onclick action. # A button with text and onclick action.

1480

"text": "A String", # The text of the button.

1481

"onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.

1482

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

1483

"url": "A String", # The URL to open.

1484

},

1485

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

1486

# For example, an Apps Script can be invoked to handle the form.

1487

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

1488

# clicked/activated.

1489

"parameters": [ # List of action parameters.

1490

{ # List of string parameters to supply when the action method is invoked.

1491

# For example, consider three snooze buttons: snooze now, snooze 1 day,

1492

# snooze next week. You might use action method = snooze(), passing the

1493

# snooze type and snooze time in the list of string parameters.

1494

"value": "A String", # The value of the parameter.

1495

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

},

],

"keyValue": { # A UI element contains a key (label) and a value (content). And this # Display a key value item in this widget.

1504

# element may also contain some actions such as onclick button.

1505

"contentMultiline": True or False, # If the content should be multiline.

1506

"bottomLabel": "A String", # The text of the bottom label. Formatted text supported.

1507

"topLabel": "A String", # The text of the top label. Formatted text supported.

1508

"button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.

1509

"imageButton": { # An image button with an onclick action. # A button with image and onclick action.

1510

"iconUrl": "A String", # The icon specified by a URL.

1511

"name": "A String", # The name of this image_button which will be used for accessibility.

1512

# Default value will be provided if developers don't specify.

1513

"onClick": { # An onclick action (e.g. open a link). # The onclick action.

1514

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

1515

"url": "A String", # The URL to open.

1516

},

1517

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

1518

# For example, an Apps Script can be invoked to handle the form.

1519

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

1520

# clicked/activated.

1521

"parameters": [ # List of action parameters.

1522

{ # List of string parameters to supply when the action method is invoked.

1523

# For example, consider three snooze buttons: snooze now, snooze 1 day,

1524

# snooze next week. You might use action method = snooze(), passing the

1525

# snooze type and snooze time in the list of string parameters.

1526

"value": "A String", # The value of the parameter.

1527

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

"icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat

1533

# API.

1534

},

1535

"textButton": { # A button with text and onclick action. # A button with text and onclick action.

1536

"text": "A String", # The text of the button.

1537

"onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.

1538

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

1539

"url": "A String", # The URL to open.

1540

},

1541

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

1542

# For example, an Apps Script can be invoked to handle the form.

1543

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

1544

# clicked/activated.

1545

"parameters": [ # List of action parameters.

1546

{ # List of string parameters to supply when the action method is invoked.

1547

# For example, consider three snooze buttons: snooze now, snooze 1 day,

1548

# snooze next week. You might use action method = snooze(), passing the

1549

# snooze type and snooze time in the list of string parameters.

1550

"value": "A String", # The value of the parameter.

1551

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

},

"content": "A String", # The text of the content. Formatted text supported and always required.

1559

"iconUrl": "A String", # The icon specified by a URL.

1560

"onClick": { # An onclick action (e.g. open a link). # The onclick action. Only the top label, bottom label and content region

1561

# are clickable.

1562

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

1563

"url": "A String", # The URL to open.

1564

},

1565

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

1566

# For example, an Apps Script can be invoked to handle the form.

1567

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

1568

# clicked/activated.

1569

"parameters": [ # List of action parameters.

1570

{ # List of string parameters to supply when the action method is invoked.

1571

# For example, consider three snooze buttons: snooze now, snooze 1 day,

1572

# snooze next week. You might use action method = snooze(), passing the

1573

# snooze type and snooze time in the list of string parameters.

1574

"value": "A String", # The value of the parameter.

1575

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

"icon": "A String", # An enum value that will be replaced by the Chat API with the

1581

# corresponding icon image.

1582

},

1583

"image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget.

1584

"aspectRatio": 3.14, # The aspect ratio of this image (width/height).

1585

"imageUrl": "A String", # The URL of the image.

1586

"onClick": { # An onclick action (e.g. open a link). # The onclick action.

1587

"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.

1588

"url": "A String", # The URL to open.

1589

},

1590

"action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.

1591

# For example, an Apps Script can be invoked to handle the form.

1592

"actionMethodName": "A String", # Apps Script function to invoke when the containing element is

1593

# clicked/activated.

1594

"parameters": [ # List of action parameters.

1595

{ # List of string parameters to supply when the action method is invoked.

1596

# For example, consider three snooze buttons: snooze now, snooze 1 day,

1597

# snooze next week. You might use action method = snooze(), passing the

1598

# snooze type and snooze time in the list of string parameters.

1599

"value": "A String", # The value of the parameter.

1600

"key": "A String", # The name of the parameter for the action script.

},

],

},

},

},

"textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget.

"text": "A String",

},

},

],

"header": "A String", # The header of the section, text formatted supported.

1612

},

1613

],

1614

"name": "A String", # Name of the card.

1615

"header": { # The header of the card. A header usually contains a title and an image.

1616

"imageStyle": "A String", # The image's type (e.g. square border or circular border).

1617

"imageUrl": "A String", # The URL of the image in the card header.

1618

"subtitle": "A String", # The subtitle of the card header.

1619

"title": "A String", # The title must be specified. The header has a fixed height: if both a

1620

# title and subtitle is specified, each will take up 1 line. If only the

1621

# title is specified, it will take up both lines.

},

},

],

"previewText": "A String", # Text for generating preview chips. This text will not be displayed to the

1626

# user, but any links to images, web pages, videos, etc. included here will

1627

# generate preview chips.

1628

"createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat

1629

# server.

1630

"sender": { # A user in Hangouts Chat. # The user who created the message.

1631

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

1632

"type": "A String", # User type.

1633

"name": "A String", # Resource name, in the format "users/*".

},

}</pre>

</div>

</body></html>