chat
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package chat provides access to the Google Chat API.
For product documentation, see:https://developers.google.com/workspace/chat
Library status¶
These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.
When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.
Creating a client¶
Usage example:
import "google.golang.org/api/chat/v1"...ctx := context.Background()chatService, err := chat.NewService(ctx)
In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options¶
By default, all available scopes (see "Constants") are used to authenticate.To restrict scopes, usegoogle.golang.org/api/option.WithScopes:
chatService, err := chat.NewService(ctx, option.WithScopes(chat.ChatUsersSpacesettingsScope))
To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:
chatService, err := chat.NewService(ctx, option.WithAPIKey("AIza..."))To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)chatService, err := chat.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seegoogle.golang.org/api/option.ClientOption for details on options.
Index¶
- Constants
- type AccessSettings
- type AccessoryWidget
- type ActionParameter
- type ActionResponse
- type ActionStatus
- type Annotation
- type AppCommandMetadata
- type AttachedGif
- type Attachment
- type AttachmentDataRef
- type Button
- type CalendarEventLinkData
- type Card
- type CardAction
- type CardHeader
- type CardWithId
- type ChatAppLogEntry
- type ChatClientDataSourceMarkup
- type ChatSpaceLinkData
- type Color
- type CommonEventObject
- type CompleteImportSpaceRequest
- type CompleteImportSpaceResponse
- type CustomEmoji
- type CustomEmojiMetadata
- type CustomEmojiPayload
- type CustomEmojisCreateCall
- func (c *CustomEmojisCreateCall) Context(ctx context.Context) *CustomEmojisCreateCall
- func (c *CustomEmojisCreateCall) Do(opts ...googleapi.CallOption) (*CustomEmoji, error)
- func (c *CustomEmojisCreateCall) Fields(s ...googleapi.Field) *CustomEmojisCreateCall
- func (c *CustomEmojisCreateCall) Header() http.Header
- type CustomEmojisDeleteCall
- func (c *CustomEmojisDeleteCall) Context(ctx context.Context) *CustomEmojisDeleteCall
- func (c *CustomEmojisDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *CustomEmojisDeleteCall) Fields(s ...googleapi.Field) *CustomEmojisDeleteCall
- func (c *CustomEmojisDeleteCall) Header() http.Header
- type CustomEmojisGetCall
- func (c *CustomEmojisGetCall) Context(ctx context.Context) *CustomEmojisGetCall
- func (c *CustomEmojisGetCall) Do(opts ...googleapi.CallOption) (*CustomEmoji, error)
- func (c *CustomEmojisGetCall) Fields(s ...googleapi.Field) *CustomEmojisGetCall
- func (c *CustomEmojisGetCall) Header() http.Header
- func (c *CustomEmojisGetCall) IfNoneMatch(entityTag string) *CustomEmojisGetCall
- type CustomEmojisListCall
- func (c *CustomEmojisListCall) Context(ctx context.Context) *CustomEmojisListCall
- func (c *CustomEmojisListCall) Do(opts ...googleapi.CallOption) (*ListCustomEmojisResponse, error)
- func (c *CustomEmojisListCall) Fields(s ...googleapi.Field) *CustomEmojisListCall
- func (c *CustomEmojisListCall) Filter(filter string) *CustomEmojisListCall
- func (c *CustomEmojisListCall) Header() http.Header
- func (c *CustomEmojisListCall) IfNoneMatch(entityTag string) *CustomEmojisListCall
- func (c *CustomEmojisListCall) PageSize(pageSize int64) *CustomEmojisListCall
- func (c *CustomEmojisListCall) PageToken(pageToken string) *CustomEmojisListCall
- func (c *CustomEmojisListCall) Pages(ctx context.Context, f func(*ListCustomEmojisResponse) error) error
- type CustomEmojisService
- type DateInput
- type DateTimeInput
- type DeletionMetadata
- type DeprecatedEvent
- type Dialog
- type DialogAction
- type DriveDataRef
- type DriveLinkData
- type Emoji
- type EmojiReactionSummary
- type Empty
- type FormAction
- type GoogleAppsCardV1Action
- type GoogleAppsCardV1ActionParameter
- type GoogleAppsCardV1BorderStyle
- type GoogleAppsCardV1Button
- type GoogleAppsCardV1ButtonList
- type GoogleAppsCardV1Card
- type GoogleAppsCardV1CardAction
- type GoogleAppsCardV1CardFixedFooter
- type GoogleAppsCardV1CardHeader
- type GoogleAppsCardV1Carousel
- type GoogleAppsCardV1CarouselCard
- type GoogleAppsCardV1Chip
- type GoogleAppsCardV1ChipList
- type GoogleAppsCardV1CollapseControl
- type GoogleAppsCardV1Column
- type GoogleAppsCardV1Columns
- type GoogleAppsCardV1CommonWidgetAction
- type GoogleAppsCardV1Condition
- type GoogleAppsCardV1DataSourceConfig
- type GoogleAppsCardV1DateTimePicker
- type GoogleAppsCardV1DecoratedText
- type GoogleAppsCardV1Divider
- type GoogleAppsCardV1EventAction
- type GoogleAppsCardV1ExpressionData
- type GoogleAppsCardV1ExpressionDataCondition
- type GoogleAppsCardV1Grid
- type GoogleAppsCardV1GridItem
- type GoogleAppsCardV1Icon
- type GoogleAppsCardV1Image
- type GoogleAppsCardV1ImageComponent
- type GoogleAppsCardV1ImageCropStyle
- type GoogleAppsCardV1MaterialIcon
- type GoogleAppsCardV1NestedWidget
- type GoogleAppsCardV1OnClick
- type GoogleAppsCardV1OpenLink
- type GoogleAppsCardV1OverflowMenu
- type GoogleAppsCardV1OverflowMenuItem
- type GoogleAppsCardV1PlatformDataSource
- type GoogleAppsCardV1Section
- type GoogleAppsCardV1SelectionInput
- type GoogleAppsCardV1SelectionItem
- type GoogleAppsCardV1SuggestionItem
- type GoogleAppsCardV1Suggestions
- type GoogleAppsCardV1SwitchControl
- type GoogleAppsCardV1TextInput
- type GoogleAppsCardV1TextParagraph
- type GoogleAppsCardV1Trigger
- type GoogleAppsCardV1UpdateVisibilityAction
- type GoogleAppsCardV1Validation
- type GoogleAppsCardV1Widget
- type GoogleAppsCardV1Widgets
- type Group
- type HostAppDataSourceMarkup
- type Image
- type ImageButton
- type Inputs
- type KeyValue
- type ListCustomEmojisResponse
- type ListMembershipsResponse
- type ListMessagesResponse
- type ListReactionsResponse
- type ListSpaceEventsResponse
- type ListSpacesResponse
- type MatchedUrl
- type Media
- type MediaDownloadCall
- func (c *MediaDownloadCall) Context(ctx context.Context) *MediaDownloadCall
- func (c *MediaDownloadCall) Do(opts ...googleapi.CallOption) (*Media, error)
- func (c *MediaDownloadCall) Download(opts ...googleapi.CallOption) (*http.Response, error)
- func (c *MediaDownloadCall) Fields(s ...googleapi.Field) *MediaDownloadCall
- func (c *MediaDownloadCall) Header() http.Header
- func (c *MediaDownloadCall) IfNoneMatch(entityTag string) *MediaDownloadCall
- type MediaService
- type MediaUploadCall
- func (c *MediaUploadCall) Context(ctx context.Context) *MediaUploadCall
- func (c *MediaUploadCall) Do(opts ...googleapi.CallOption) (*UploadAttachmentResponse, error)
- func (c *MediaUploadCall) Fields(s ...googleapi.Field) *MediaUploadCall
- func (c *MediaUploadCall) Header() http.Header
- func (c *MediaUploadCall) Media(r io.Reader, options ...googleapi.MediaOption) *MediaUploadCall
- func (c *MediaUploadCall) ProgressUpdater(pu googleapi.ProgressUpdater) *MediaUploadCall
- func (c *MediaUploadCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *MediaUploadCalldeprecated
- type MeetSpaceLinkData
- type Membership
- type MembershipBatchCreatedEventData
- type MembershipBatchDeletedEventData
- type MembershipBatchUpdatedEventData
- type MembershipCount
- type MembershipCreatedEventData
- type MembershipDeletedEventData
- type MembershipUpdatedEventData
- type Message
- type MessageBatchCreatedEventData
- type MessageBatchDeletedEventData
- type MessageBatchUpdatedEventData
- type MessageCreatedEventData
- type MessageDeletedEventData
- type MessageUpdatedEventData
- type OnClick
- type OpenLink
- type PermissionSetting
- type PermissionSettings
- type QuotedMessageMetadata
- type Reaction
- type ReactionBatchCreatedEventData
- type ReactionBatchDeletedEventData
- type ReactionCreatedEventData
- type ReactionDeletedEventData
- type RichLinkMetadata
- type SearchSpacesResponse
- type Section
- type SelectionItems
- type Service
- type SetUpSpaceRequest
- type SlashCommand
- type SlashCommandMetadata
- type Space
- type SpaceBatchUpdatedEventData
- type SpaceDataSource
- type SpaceDetails
- type SpaceEvent
- type SpaceNotificationSetting
- type SpaceReadState
- type SpaceUpdatedEventData
- type SpacesCompleteImportCall
- func (c *SpacesCompleteImportCall) Context(ctx context.Context) *SpacesCompleteImportCall
- func (c *SpacesCompleteImportCall) Do(opts ...googleapi.CallOption) (*CompleteImportSpaceResponse, error)
- func (c *SpacesCompleteImportCall) Fields(s ...googleapi.Field) *SpacesCompleteImportCall
- func (c *SpacesCompleteImportCall) Header() http.Header
- type SpacesCreateCall
- func (c *SpacesCreateCall) Context(ctx context.Context) *SpacesCreateCall
- func (c *SpacesCreateCall) Do(opts ...googleapi.CallOption) (*Space, error)
- func (c *SpacesCreateCall) Fields(s ...googleapi.Field) *SpacesCreateCall
- func (c *SpacesCreateCall) Header() http.Header
- func (c *SpacesCreateCall) RequestId(requestId string) *SpacesCreateCall
- type SpacesDeleteCall
- func (c *SpacesDeleteCall) Context(ctx context.Context) *SpacesDeleteCall
- func (c *SpacesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *SpacesDeleteCall) Fields(s ...googleapi.Field) *SpacesDeleteCall
- func (c *SpacesDeleteCall) Header() http.Header
- func (c *SpacesDeleteCall) UseAdminAccess(useAdminAccess bool) *SpacesDeleteCall
- type SpacesFindDirectMessageCall
- func (c *SpacesFindDirectMessageCall) Context(ctx context.Context) *SpacesFindDirectMessageCall
- func (c *SpacesFindDirectMessageCall) Do(opts ...googleapi.CallOption) (*Space, error)
- func (c *SpacesFindDirectMessageCall) Fields(s ...googleapi.Field) *SpacesFindDirectMessageCall
- func (c *SpacesFindDirectMessageCall) Header() http.Header
- func (c *SpacesFindDirectMessageCall) IfNoneMatch(entityTag string) *SpacesFindDirectMessageCall
- func (c *SpacesFindDirectMessageCall) Name(name string) *SpacesFindDirectMessageCall
- type SpacesGetCall
- func (c *SpacesGetCall) Context(ctx context.Context) *SpacesGetCall
- func (c *SpacesGetCall) Do(opts ...googleapi.CallOption) (*Space, error)
- func (c *SpacesGetCall) Fields(s ...googleapi.Field) *SpacesGetCall
- func (c *SpacesGetCall) Header() http.Header
- func (c *SpacesGetCall) IfNoneMatch(entityTag string) *SpacesGetCall
- func (c *SpacesGetCall) UseAdminAccess(useAdminAccess bool) *SpacesGetCall
- type SpacesListCall
- func (c *SpacesListCall) Context(ctx context.Context) *SpacesListCall
- func (c *SpacesListCall) Do(opts ...googleapi.CallOption) (*ListSpacesResponse, error)
- func (c *SpacesListCall) Fields(s ...googleapi.Field) *SpacesListCall
- func (c *SpacesListCall) Filter(filter string) *SpacesListCall
- func (c *SpacesListCall) Header() http.Header
- func (c *SpacesListCall) IfNoneMatch(entityTag string) *SpacesListCall
- func (c *SpacesListCall) PageSize(pageSize int64) *SpacesListCall
- func (c *SpacesListCall) PageToken(pageToken string) *SpacesListCall
- func (c *SpacesListCall) Pages(ctx context.Context, f func(*ListSpacesResponse) error) error
- type SpacesMembersCreateCall
- func (c *SpacesMembersCreateCall) Context(ctx context.Context) *SpacesMembersCreateCall
- func (c *SpacesMembersCreateCall) Do(opts ...googleapi.CallOption) (*Membership, error)
- func (c *SpacesMembersCreateCall) Fields(s ...googleapi.Field) *SpacesMembersCreateCall
- func (c *SpacesMembersCreateCall) Header() http.Header
- func (c *SpacesMembersCreateCall) UseAdminAccess(useAdminAccess bool) *SpacesMembersCreateCall
- type SpacesMembersDeleteCall
- func (c *SpacesMembersDeleteCall) Context(ctx context.Context) *SpacesMembersDeleteCall
- func (c *SpacesMembersDeleteCall) Do(opts ...googleapi.CallOption) (*Membership, error)
- func (c *SpacesMembersDeleteCall) Fields(s ...googleapi.Field) *SpacesMembersDeleteCall
- func (c *SpacesMembersDeleteCall) Header() http.Header
- func (c *SpacesMembersDeleteCall) UseAdminAccess(useAdminAccess bool) *SpacesMembersDeleteCall
- type SpacesMembersGetCall
- func (c *SpacesMembersGetCall) Context(ctx context.Context) *SpacesMembersGetCall
- func (c *SpacesMembersGetCall) Do(opts ...googleapi.CallOption) (*Membership, error)
- func (c *SpacesMembersGetCall) Fields(s ...googleapi.Field) *SpacesMembersGetCall
- func (c *SpacesMembersGetCall) Header() http.Header
- func (c *SpacesMembersGetCall) IfNoneMatch(entityTag string) *SpacesMembersGetCall
- func (c *SpacesMembersGetCall) UseAdminAccess(useAdminAccess bool) *SpacesMembersGetCall
- type SpacesMembersListCall
- func (c *SpacesMembersListCall) Context(ctx context.Context) *SpacesMembersListCall
- func (c *SpacesMembersListCall) Do(opts ...googleapi.CallOption) (*ListMembershipsResponse, error)
- func (c *SpacesMembersListCall) Fields(s ...googleapi.Field) *SpacesMembersListCall
- func (c *SpacesMembersListCall) Filter(filter string) *SpacesMembersListCall
- func (c *SpacesMembersListCall) Header() http.Header
- func (c *SpacesMembersListCall) IfNoneMatch(entityTag string) *SpacesMembersListCall
- func (c *SpacesMembersListCall) PageSize(pageSize int64) *SpacesMembersListCall
- func (c *SpacesMembersListCall) PageToken(pageToken string) *SpacesMembersListCall
- func (c *SpacesMembersListCall) Pages(ctx context.Context, f func(*ListMembershipsResponse) error) error
- func (c *SpacesMembersListCall) ShowGroups(showGroups bool) *SpacesMembersListCall
- func (c *SpacesMembersListCall) ShowInvited(showInvited bool) *SpacesMembersListCall
- func (c *SpacesMembersListCall) UseAdminAccess(useAdminAccess bool) *SpacesMembersListCall
- type SpacesMembersPatchCall
- func (c *SpacesMembersPatchCall) Context(ctx context.Context) *SpacesMembersPatchCall
- func (c *SpacesMembersPatchCall) Do(opts ...googleapi.CallOption) (*Membership, error)
- func (c *SpacesMembersPatchCall) Fields(s ...googleapi.Field) *SpacesMembersPatchCall
- func (c *SpacesMembersPatchCall) Header() http.Header
- func (c *SpacesMembersPatchCall) UpdateMask(updateMask string) *SpacesMembersPatchCall
- func (c *SpacesMembersPatchCall) UseAdminAccess(useAdminAccess bool) *SpacesMembersPatchCall
- type SpacesMembersService
- func (r *SpacesMembersService) Create(parent string, membership *Membership) *SpacesMembersCreateCall
- func (r *SpacesMembersService) Delete(name string) *SpacesMembersDeleteCall
- func (r *SpacesMembersService) Get(name string) *SpacesMembersGetCall
- func (r *SpacesMembersService) List(parent string) *SpacesMembersListCall
- func (r *SpacesMembersService) Patch(name string, membership *Membership) *SpacesMembersPatchCall
- type SpacesMessagesAttachmentsGetCall
- func (c *SpacesMessagesAttachmentsGetCall) Context(ctx context.Context) *SpacesMessagesAttachmentsGetCall
- func (c *SpacesMessagesAttachmentsGetCall) Do(opts ...googleapi.CallOption) (*Attachment, error)
- func (c *SpacesMessagesAttachmentsGetCall) Fields(s ...googleapi.Field) *SpacesMessagesAttachmentsGetCall
- func (c *SpacesMessagesAttachmentsGetCall) Header() http.Header
- func (c *SpacesMessagesAttachmentsGetCall) IfNoneMatch(entityTag string) *SpacesMessagesAttachmentsGetCall
- type SpacesMessagesAttachmentsService
- type SpacesMessagesCreateCall
- func (c *SpacesMessagesCreateCall) Context(ctx context.Context) *SpacesMessagesCreateCall
- func (c *SpacesMessagesCreateCall) Do(opts ...googleapi.CallOption) (*Message, error)
- func (c *SpacesMessagesCreateCall) Fields(s ...googleapi.Field) *SpacesMessagesCreateCall
- func (c *SpacesMessagesCreateCall) Header() http.Header
- func (c *SpacesMessagesCreateCall) MessageId(messageId string) *SpacesMessagesCreateCall
- func (c *SpacesMessagesCreateCall) MessageReplyOption(messageReplyOption string) *SpacesMessagesCreateCall
- func (c *SpacesMessagesCreateCall) RequestId(requestId string) *SpacesMessagesCreateCall
- func (c *SpacesMessagesCreateCall) ThreadKey(threadKey string) *SpacesMessagesCreateCall
- type SpacesMessagesDeleteCall
- func (c *SpacesMessagesDeleteCall) Context(ctx context.Context) *SpacesMessagesDeleteCall
- func (c *SpacesMessagesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *SpacesMessagesDeleteCall) Fields(s ...googleapi.Field) *SpacesMessagesDeleteCall
- func (c *SpacesMessagesDeleteCall) Force(force bool) *SpacesMessagesDeleteCall
- func (c *SpacesMessagesDeleteCall) Header() http.Header
- type SpacesMessagesGetCall
- func (c *SpacesMessagesGetCall) Context(ctx context.Context) *SpacesMessagesGetCall
- func (c *SpacesMessagesGetCall) Do(opts ...googleapi.CallOption) (*Message, error)
- func (c *SpacesMessagesGetCall) Fields(s ...googleapi.Field) *SpacesMessagesGetCall
- func (c *SpacesMessagesGetCall) Header() http.Header
- func (c *SpacesMessagesGetCall) IfNoneMatch(entityTag string) *SpacesMessagesGetCall
- type SpacesMessagesListCall
- func (c *SpacesMessagesListCall) Context(ctx context.Context) *SpacesMessagesListCall
- func (c *SpacesMessagesListCall) Do(opts ...googleapi.CallOption) (*ListMessagesResponse, error)
- func (c *SpacesMessagesListCall) Fields(s ...googleapi.Field) *SpacesMessagesListCall
- func (c *SpacesMessagesListCall) Filter(filter string) *SpacesMessagesListCall
- func (c *SpacesMessagesListCall) Header() http.Header
- func (c *SpacesMessagesListCall) IfNoneMatch(entityTag string) *SpacesMessagesListCall
- func (c *SpacesMessagesListCall) OrderBy(orderBy string) *SpacesMessagesListCall
- func (c *SpacesMessagesListCall) PageSize(pageSize int64) *SpacesMessagesListCall
- func (c *SpacesMessagesListCall) PageToken(pageToken string) *SpacesMessagesListCall
- func (c *SpacesMessagesListCall) Pages(ctx context.Context, f func(*ListMessagesResponse) error) error
- func (c *SpacesMessagesListCall) ShowDeleted(showDeleted bool) *SpacesMessagesListCall
- type SpacesMessagesPatchCall
- func (c *SpacesMessagesPatchCall) AllowMissing(allowMissing bool) *SpacesMessagesPatchCall
- func (c *SpacesMessagesPatchCall) Context(ctx context.Context) *SpacesMessagesPatchCall
- func (c *SpacesMessagesPatchCall) Do(opts ...googleapi.CallOption) (*Message, error)
- func (c *SpacesMessagesPatchCall) Fields(s ...googleapi.Field) *SpacesMessagesPatchCall
- func (c *SpacesMessagesPatchCall) Header() http.Header
- func (c *SpacesMessagesPatchCall) UpdateMask(updateMask string) *SpacesMessagesPatchCall
- type SpacesMessagesReactionsCreateCall
- func (c *SpacesMessagesReactionsCreateCall) Context(ctx context.Context) *SpacesMessagesReactionsCreateCall
- func (c *SpacesMessagesReactionsCreateCall) Do(opts ...googleapi.CallOption) (*Reaction, error)
- func (c *SpacesMessagesReactionsCreateCall) Fields(s ...googleapi.Field) *SpacesMessagesReactionsCreateCall
- func (c *SpacesMessagesReactionsCreateCall) Header() http.Header
- type SpacesMessagesReactionsDeleteCall
- func (c *SpacesMessagesReactionsDeleteCall) Context(ctx context.Context) *SpacesMessagesReactionsDeleteCall
- func (c *SpacesMessagesReactionsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *SpacesMessagesReactionsDeleteCall) Fields(s ...googleapi.Field) *SpacesMessagesReactionsDeleteCall
- func (c *SpacesMessagesReactionsDeleteCall) Header() http.Header
- type SpacesMessagesReactionsListCall
- func (c *SpacesMessagesReactionsListCall) Context(ctx context.Context) *SpacesMessagesReactionsListCall
- func (c *SpacesMessagesReactionsListCall) Do(opts ...googleapi.CallOption) (*ListReactionsResponse, error)
- func (c *SpacesMessagesReactionsListCall) Fields(s ...googleapi.Field) *SpacesMessagesReactionsListCall
- func (c *SpacesMessagesReactionsListCall) Filter(filter string) *SpacesMessagesReactionsListCall
- func (c *SpacesMessagesReactionsListCall) Header() http.Header
- func (c *SpacesMessagesReactionsListCall) IfNoneMatch(entityTag string) *SpacesMessagesReactionsListCall
- func (c *SpacesMessagesReactionsListCall) PageSize(pageSize int64) *SpacesMessagesReactionsListCall
- func (c *SpacesMessagesReactionsListCall) PageToken(pageToken string) *SpacesMessagesReactionsListCall
- func (c *SpacesMessagesReactionsListCall) Pages(ctx context.Context, f func(*ListReactionsResponse) error) error
- type SpacesMessagesReactionsService
- func (r *SpacesMessagesReactionsService) Create(parent string, reaction *Reaction) *SpacesMessagesReactionsCreateCall
- func (r *SpacesMessagesReactionsService) Delete(name string) *SpacesMessagesReactionsDeleteCall
- func (r *SpacesMessagesReactionsService) List(parent string) *SpacesMessagesReactionsListCall
- type SpacesMessagesService
- func (r *SpacesMessagesService) Create(parent string, message *Message) *SpacesMessagesCreateCall
- func (r *SpacesMessagesService) Delete(name string) *SpacesMessagesDeleteCall
- func (r *SpacesMessagesService) Get(name string) *SpacesMessagesGetCall
- func (r *SpacesMessagesService) List(parent string) *SpacesMessagesListCall
- func (r *SpacesMessagesService) Patch(name string, message *Message) *SpacesMessagesPatchCall
- func (r *SpacesMessagesService) Update(name string, message *Message) *SpacesMessagesUpdateCall
- type SpacesMessagesUpdateCall
- func (c *SpacesMessagesUpdateCall) AllowMissing(allowMissing bool) *SpacesMessagesUpdateCall
- func (c *SpacesMessagesUpdateCall) Context(ctx context.Context) *SpacesMessagesUpdateCall
- func (c *SpacesMessagesUpdateCall) Do(opts ...googleapi.CallOption) (*Message, error)
- func (c *SpacesMessagesUpdateCall) Fields(s ...googleapi.Field) *SpacesMessagesUpdateCall
- func (c *SpacesMessagesUpdateCall) Header() http.Header
- func (c *SpacesMessagesUpdateCall) UpdateMask(updateMask string) *SpacesMessagesUpdateCall
- type SpacesPatchCall
- func (c *SpacesPatchCall) Context(ctx context.Context) *SpacesPatchCall
- func (c *SpacesPatchCall) Do(opts ...googleapi.CallOption) (*Space, error)
- func (c *SpacesPatchCall) Fields(s ...googleapi.Field) *SpacesPatchCall
- func (c *SpacesPatchCall) Header() http.Header
- func (c *SpacesPatchCall) UpdateMask(updateMask string) *SpacesPatchCall
- func (c *SpacesPatchCall) UseAdminAccess(useAdminAccess bool) *SpacesPatchCall
- type SpacesSearchCall
- func (c *SpacesSearchCall) Context(ctx context.Context) *SpacesSearchCall
- func (c *SpacesSearchCall) Do(opts ...googleapi.CallOption) (*SearchSpacesResponse, error)
- func (c *SpacesSearchCall) Fields(s ...googleapi.Field) *SpacesSearchCall
- func (c *SpacesSearchCall) Header() http.Header
- func (c *SpacesSearchCall) IfNoneMatch(entityTag string) *SpacesSearchCall
- func (c *SpacesSearchCall) OrderBy(orderBy string) *SpacesSearchCall
- func (c *SpacesSearchCall) PageSize(pageSize int64) *SpacesSearchCall
- func (c *SpacesSearchCall) PageToken(pageToken string) *SpacesSearchCall
- func (c *SpacesSearchCall) Pages(ctx context.Context, f func(*SearchSpacesResponse) error) error
- func (c *SpacesSearchCall) Query(query string) *SpacesSearchCall
- func (c *SpacesSearchCall) UseAdminAccess(useAdminAccess bool) *SpacesSearchCall
- type SpacesService
- func (r *SpacesService) CompleteImport(name string, completeimportspacerequest *CompleteImportSpaceRequest) *SpacesCompleteImportCall
- func (r *SpacesService) Create(space *Space) *SpacesCreateCall
- func (r *SpacesService) Delete(name string) *SpacesDeleteCall
- func (r *SpacesService) FindDirectMessage() *SpacesFindDirectMessageCall
- func (r *SpacesService) Get(name string) *SpacesGetCall
- func (r *SpacesService) List() *SpacesListCall
- func (r *SpacesService) Patch(name string, space *Space) *SpacesPatchCall
- func (r *SpacesService) Search() *SpacesSearchCall
- func (r *SpacesService) Setup(setupspacerequest *SetUpSpaceRequest) *SpacesSetupCall
- type SpacesSetupCall
- type SpacesSpaceEventsGetCall
- func (c *SpacesSpaceEventsGetCall) Context(ctx context.Context) *SpacesSpaceEventsGetCall
- func (c *SpacesSpaceEventsGetCall) Do(opts ...googleapi.CallOption) (*SpaceEvent, error)
- func (c *SpacesSpaceEventsGetCall) Fields(s ...googleapi.Field) *SpacesSpaceEventsGetCall
- func (c *SpacesSpaceEventsGetCall) Header() http.Header
- func (c *SpacesSpaceEventsGetCall) IfNoneMatch(entityTag string) *SpacesSpaceEventsGetCall
- type SpacesSpaceEventsListCall
- func (c *SpacesSpaceEventsListCall) Context(ctx context.Context) *SpacesSpaceEventsListCall
- func (c *SpacesSpaceEventsListCall) Do(opts ...googleapi.CallOption) (*ListSpaceEventsResponse, error)
- func (c *SpacesSpaceEventsListCall) Fields(s ...googleapi.Field) *SpacesSpaceEventsListCall
- func (c *SpacesSpaceEventsListCall) Filter(filter string) *SpacesSpaceEventsListCall
- func (c *SpacesSpaceEventsListCall) Header() http.Header
- func (c *SpacesSpaceEventsListCall) IfNoneMatch(entityTag string) *SpacesSpaceEventsListCall
- func (c *SpacesSpaceEventsListCall) PageSize(pageSize int64) *SpacesSpaceEventsListCall
- func (c *SpacesSpaceEventsListCall) PageToken(pageToken string) *SpacesSpaceEventsListCall
- func (c *SpacesSpaceEventsListCall) Pages(ctx context.Context, f func(*ListSpaceEventsResponse) error) error
- type SpacesSpaceEventsService
- type Status
- type StringInputs
- type TextButton
- type TextParagraph
- type Thread
- type ThreadReadState
- type TimeInput
- type TimeZone
- type UpdatedWidget
- type UploadAttachmentRequest
- type UploadAttachmentResponse
- type User
- type UserMentionMetadata
- type UsersService
- type UsersSpacesGetSpaceReadStateCall
- func (c *UsersSpacesGetSpaceReadStateCall) Context(ctx context.Context) *UsersSpacesGetSpaceReadStateCall
- func (c *UsersSpacesGetSpaceReadStateCall) Do(opts ...googleapi.CallOption) (*SpaceReadState, error)
- func (c *UsersSpacesGetSpaceReadStateCall) Fields(s ...googleapi.Field) *UsersSpacesGetSpaceReadStateCall
- func (c *UsersSpacesGetSpaceReadStateCall) Header() http.Header
- func (c *UsersSpacesGetSpaceReadStateCall) IfNoneMatch(entityTag string) *UsersSpacesGetSpaceReadStateCall
- type UsersSpacesService
- type UsersSpacesSpaceNotificationSettingGetCall
- func (c *UsersSpacesSpaceNotificationSettingGetCall) Context(ctx context.Context) *UsersSpacesSpaceNotificationSettingGetCall
- func (c *UsersSpacesSpaceNotificationSettingGetCall) Do(opts ...googleapi.CallOption) (*SpaceNotificationSetting, error)
- func (c *UsersSpacesSpaceNotificationSettingGetCall) Fields(s ...googleapi.Field) *UsersSpacesSpaceNotificationSettingGetCall
- func (c *UsersSpacesSpaceNotificationSettingGetCall) Header() http.Header
- func (c *UsersSpacesSpaceNotificationSettingGetCall) IfNoneMatch(entityTag string) *UsersSpacesSpaceNotificationSettingGetCall
- type UsersSpacesSpaceNotificationSettingPatchCall
- func (c *UsersSpacesSpaceNotificationSettingPatchCall) Context(ctx context.Context) *UsersSpacesSpaceNotificationSettingPatchCall
- func (c *UsersSpacesSpaceNotificationSettingPatchCall) Do(opts ...googleapi.CallOption) (*SpaceNotificationSetting, error)
- func (c *UsersSpacesSpaceNotificationSettingPatchCall) Fields(s ...googleapi.Field) *UsersSpacesSpaceNotificationSettingPatchCall
- func (c *UsersSpacesSpaceNotificationSettingPatchCall) Header() http.Header
- func (c *UsersSpacesSpaceNotificationSettingPatchCall) UpdateMask(updateMask string) *UsersSpacesSpaceNotificationSettingPatchCall
- type UsersSpacesSpaceNotificationSettingService
- type UsersSpacesThreadsGetThreadReadStateCall
- func (c *UsersSpacesThreadsGetThreadReadStateCall) Context(ctx context.Context) *UsersSpacesThreadsGetThreadReadStateCall
- func (c *UsersSpacesThreadsGetThreadReadStateCall) Do(opts ...googleapi.CallOption) (*ThreadReadState, error)
- func (c *UsersSpacesThreadsGetThreadReadStateCall) Fields(s ...googleapi.Field) *UsersSpacesThreadsGetThreadReadStateCall
- func (c *UsersSpacesThreadsGetThreadReadStateCall) Header() http.Header
- func (c *UsersSpacesThreadsGetThreadReadStateCall) IfNoneMatch(entityTag string) *UsersSpacesThreadsGetThreadReadStateCall
- type UsersSpacesThreadsService
- type UsersSpacesUpdateSpaceReadStateCall
- func (c *UsersSpacesUpdateSpaceReadStateCall) Context(ctx context.Context) *UsersSpacesUpdateSpaceReadStateCall
- func (c *UsersSpacesUpdateSpaceReadStateCall) Do(opts ...googleapi.CallOption) (*SpaceReadState, error)
- func (c *UsersSpacesUpdateSpaceReadStateCall) Fields(s ...googleapi.Field) *UsersSpacesUpdateSpaceReadStateCall
- func (c *UsersSpacesUpdateSpaceReadStateCall) Header() http.Header
- func (c *UsersSpacesUpdateSpaceReadStateCall) UpdateMask(updateMask string) *UsersSpacesUpdateSpaceReadStateCall
- type WidgetMarkup
- type WorkflowDataSourceMarkup
Constants¶
const (// Delete conversations and spaces owned by your organization and remove access// to associated files in Google ChatChatAdminDeleteScope = "https://www.googleapis.com/auth/chat.admin.delete"// View, add, update and remove members and managers in conversations owned by// your organizationChatAdminMembershipsScope = "https://www.googleapis.com/auth/chat.admin.memberships"// View members and managers in conversations owned by your organizationChatAdminMembershipsReadonlyScope = "https://www.googleapis.com/auth/chat.admin.memberships.readonly"// View or edit display name, description, and other metadata for all Google// Chat conversations owned by your organizationChatAdminSpacesScope = "https://www.googleapis.com/auth/chat.admin.spaces"// View display name, description, and other metadata for all Google Chat// conversations owned by your organizationChatAdminSpacesReadonlyScope = "https://www.googleapis.com/auth/chat.admin.spaces.readonly"// On their own behalf, apps in Google Chat can delete conversations and spaces// and remove access to associated filesChatAppDeleteScope = "https://www.googleapis.com/auth/chat.app.delete"// On their own behalf, apps in Google Chat can see, add, update, and remove// members from conversations and spacesChatAppMembershipsScope = "https://www.googleapis.com/auth/chat.app.memberships"// On their own behalf, apps in Google Chat can see all messages and their// associated reactions and message contentChatAppMessagesReadonlyScope = "https://www.googleapis.com/auth/chat.app.messages.readonly"// On their own behalf, apps in Google Chat can create conversations and spaces// and see or update their metadata (including history settings and access// settings)ChatAppSpacesScope = "https://www.googleapis.com/auth/chat.app.spaces"// On their own behalf, apps in Google Chat can create conversations and spacesChatAppSpacesCreateScope = "https://www.googleapis.com/auth/chat.app.spaces.create"// Private Service:https://www.googleapis.com/auth/chat.botChatBotScope = "https://www.googleapis.com/auth/chat.bot"// View, create, and delete custom emoji in Google ChatChatCustomemojisScope = "https://www.googleapis.com/auth/chat.customemojis"// View custom emoji in Google ChatChatCustomemojisReadonlyScope = "https://www.googleapis.com/auth/chat.customemojis.readonly"// Delete conversations and spaces and remove access to associated files in// Google ChatChatDeleteScope = "https://www.googleapis.com/auth/chat.delete"// Import spaces, messages, and memberships into Google Chat.ChatImportScope = "https://www.googleapis.com/auth/chat.import"// See, add, update, and remove members from conversations and spaces in Google// ChatChatMembershipsScope = "https://www.googleapis.com/auth/chat.memberships"// Add and remove itself from conversations and spaces in Google ChatChatMembershipsAppScope = "https://www.googleapis.com/auth/chat.memberships.app"// View members in Google Chat conversations.ChatMembershipsReadonlyScope = "https://www.googleapis.com/auth/chat.memberships.readonly"// See, compose, send, update, and delete messages as well as their message// content; add, see, and delete reactions to messages.ChatMessagesScope = "https://www.googleapis.com/auth/chat.messages"// Compose and send messages in Google ChatChatMessagesCreateScope = "https://www.googleapis.com/auth/chat.messages.create"// See, add, and delete reactions as well as their reaction content to messages// in Google ChatChatMessagesReactionsScope = "https://www.googleapis.com/auth/chat.messages.reactions"// Add reactions to messages in Google ChatChatMessagesReactionsCreateScope = "https://www.googleapis.com/auth/chat.messages.reactions.create"// View reactions as well as their reaction content to messages in Google ChatChatMessagesReactionsReadonlyScope = "https://www.googleapis.com/auth/chat.messages.reactions.readonly"// See messages as well as their reactions and message content in Google ChatChatMessagesReadonlyScope = "https://www.googleapis.com/auth/chat.messages.readonly"// Create conversations and spaces and see or update metadata (including// history settings and access settings) in Google ChatChatSpacesScope = "https://www.googleapis.com/auth/chat.spaces"// Create new conversations and spaces in Google ChatChatSpacesCreateScope = "https://www.googleapis.com/auth/chat.spaces.create"// View chat and spaces in Google ChatChatSpacesReadonlyScope = "https://www.googleapis.com/auth/chat.spaces.readonly"// View and modify last read time for Google Chat conversationsChatUsersReadstateScope = "https://www.googleapis.com/auth/chat.users.readstate"// View last read time for Google Chat conversationsChatUsersReadstateReadonlyScope = "https://www.googleapis.com/auth/chat.users.readstate.readonly"// Read and update your space settingsChatUsersSpacesettingsScope = "https://www.googleapis.com/auth/chat.users.spacesettings")
OAuth2 scopes used by this API.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeAccessSettings¶added inv0.187.0
type AccessSettings struct {// AccessState: Output only. Indicates the access state of the space.//// Possible values:// "ACCESS_STATE_UNSPECIFIED" - Access state is unknown or not supported in// this API.// "PRIVATE" - Only users or Google Groups that have been individually added// or invited by other users or Google Workspace administrators can discover// and access the space.// "DISCOVERABLE" - A space manager has granted a target audience access to// the space. Users or Google Groups that have been individually added or// invited to the space can also discover and access the space. To learn more,// see [Make a space discoverable to specific// users](https://developers.google.com/workspace/chat/space-target-audience).// Creating discoverable spaces requires [user// authentication](https://developers.google.com/workspace/chat/authenticate-aut// horize-chat-user).AccessStatestring `json:"accessState,omitempty"`// Audience: Optional. The resource name of the target audience// (https://support.google.com/a/answer/9934697) who can discover the space,// join the space, and preview the messages in the space. If unset, only users// or Google Groups who have been individually invited or added to the space// can access it. For details, see Make a space discoverable to a target// audience// (https://developers.google.com/workspace/chat/space-target-audience).// Format: `audiences/{audience}` To use the default target audience for the// Google Workspace organization, set to `audiences/default`. Reading the// target audience supports: - User authentication// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)// - App authentication// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)// with administrator approval (https://support.google.com/a?p=chat-app-auth)// with the `chat.app.spaces` scope. This field is not populated when using the// `chat.bot` scope with app authentication// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).// Setting the target audience requires user authentication// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).Audiencestring `json:"audience,omitempty"`// ForceSendFields is a list of field names (e.g. "AccessState") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AccessState") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}AccessSettings: Represents the access setting(https://support.google.com/chat/answer/11971020) of the space.
func (AccessSettings)MarshalJSON¶added inv0.187.0
func (sAccessSettings) MarshalJSON() ([]byte,error)
typeAccessoryWidget¶added inv0.173.0
type AccessoryWidget struct {// ButtonList: A list of buttons.ButtonList *GoogleAppsCardV1ButtonList `json:"buttonList,omitempty"`// ForceSendFields is a list of field names (e.g. "ButtonList") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ButtonList") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}AccessoryWidget: One or more interactive widgets that appear at the bottomof a message. For details, see Add interactive widgets at the bottom of amessage(https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets).
func (AccessoryWidget)MarshalJSON¶added inv0.173.0
func (sAccessoryWidget) MarshalJSON() ([]byte,error)
typeActionParameter¶
type ActionParameter struct {// Key: The name of the parameter for the action script.Keystring `json:"key,omitempty"`// Value: The value of the parameter.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Key") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Key") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ActionParameter: List of string parameters to supply when the action methodis invoked. For example, consider three snooze buttons: snooze now, snoozeone day, snooze next week. You might use `action method = snooze()`, passingthe snooze type and snooze time in the list of string parameters.
func (ActionParameter)MarshalJSON¶
func (sActionParameter) MarshalJSON() ([]byte,error)
typeActionResponse¶
type ActionResponse struct {// DialogAction: Input only. A response to an interaction event related to a// dialog (https://developers.google.com/workspace/chat/dialogs). Must be// accompanied by `ResponseType.Dialog`.DialogAction *DialogAction `json:"dialogAction,omitempty"`// Type: Input only. The type of Chat app response.//// Possible values:// "TYPE_UNSPECIFIED" - Default type that's handled as `NEW_MESSAGE`.// "NEW_MESSAGE" - Post as a new message in the topic.// "UPDATE_MESSAGE" - Update the Chat app's message. This is only permitted// on a `CARD_CLICKED` event where the message sender type is `BOT`.// "UPDATE_USER_MESSAGE_CARDS" - Update the cards on a user's message. This// is only permitted as a response to a `MESSAGE` event with a matched url, or// a `CARD_CLICKED` event where the message sender type is `HUMAN`. Text is// ignored.// "REQUEST_CONFIG" - Privately ask the user for additional authentication or// configuration.// "DIALOG" - Presents a// [dialog](https://developers.google.com/workspace/chat/dialogs).// "UPDATE_WIDGET" - Widget text autocomplete options query.Typestring `json:"type,omitempty"`// UpdatedWidget: Input only. The response of the updated widget.UpdatedWidget *UpdatedWidget `json:"updatedWidget,omitempty"`// Url: Input only. URL for users to authenticate or configure. (Only for// `REQUEST_CONFIG` response types.)Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "DialogAction") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DialogAction") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ActionResponse: Parameters that a Chat app can use to configure how itsresponse is posted.
func (ActionResponse)MarshalJSON¶
func (sActionResponse) MarshalJSON() ([]byte,error)
typeActionStatus¶added inv0.51.0
type ActionStatus struct {// StatusCode: The status code.//// Possible values:// "OK" - Not an error; returned on success. HTTP Mapping: 200 OK// "CANCELLED" - The operation was cancelled, typically by the caller. HTTP// Mapping: 499 Client Closed Request// "UNKNOWN" - Unknown error. For example, this error may be returned when a// `Status` value received from another address space belongs to an error space// that is not known in this address space. Also errors raised by APIs that do// not return enough error information may be converted to this error. HTTP// Mapping: 500 Internal Server Error// "INVALID_ARGUMENT" - The client specified an invalid argument. Note that// this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates// arguments that are problematic regardless of the state of the system (e.g.,// a malformed file name). HTTP Mapping: 400 Bad Request// "DEADLINE_EXCEEDED" - The deadline expired before the operation could// complete. For operations that change the state of the system, this error may// be returned even if the operation has completed successfully. For example, a// successful response from a server could have been delayed long enough for// the deadline to expire. HTTP Mapping: 504 Gateway Timeout// "NOT_FOUND" - Some requested entity (e.g., file or directory) was not// found. Note to server developers: if a request is denied for an entire class// of users, such as gradual feature rollout or undocumented allowlist,// `NOT_FOUND` may be used. If a request is denied for some users within a// class of users, such as user-based access control, `PERMISSION_DENIED` must// be used. HTTP Mapping: 404 Not Found// "ALREADY_EXISTS" - The entity that a client attempted to create (e.g.,// file or directory) already exists. HTTP Mapping: 409 Conflict// "PERMISSION_DENIED" - The caller does not have permission to execute the// specified operation. `PERMISSION_DENIED` must not be used for rejections// caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for// those errors). `PERMISSION_DENIED` must not be used if the caller can not be// identified (use `UNAUTHENTICATED` instead for those errors). This error code// does not imply the request is valid or the requested entity exists or// satisfies other pre-conditions. HTTP Mapping: 403 Forbidden// "UNAUTHENTICATED" - The request does not have valid authentication// credentials for the operation. HTTP Mapping: 401 Unauthorized// "RESOURCE_EXHAUSTED" - Some resource has been exhausted, perhaps a// per-user quota, or perhaps the entire file system is out of space. HTTP// Mapping: 429 Too Many Requests// "FAILED_PRECONDITION" - The operation was rejected because the system is// not in a state required for the operation's execution. For example, the// directory to be deleted is non-empty, an rmdir operation is applied to a// non-directory, etc. Service implementors can use the following guidelines to// decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use// `UNAVAILABLE` if the client can retry just the failing call. (b) Use// `ABORTED` if the client should retry at a higher level. For example, when a// client-specified test-and-set fails, indicating the client should restart a// read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client// should not retry until the system state has been explicitly fixed. For// example, if an "rmdir" fails because the directory is non-empty,// `FAILED_PRECONDITION` should be returned since the client should not retry// unless the files are deleted from the directory. HTTP Mapping: 400 Bad// Request// "ABORTED" - The operation was aborted, typically due to a concurrency// issue such as a sequencer check failure or transaction abort. See the// guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and// `UNAVAILABLE`. HTTP Mapping: 409 Conflict// "OUT_OF_RANGE" - The operation was attempted past the valid range. E.g.,// seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error// indicates a problem that may be fixed if the system state changes. For// example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to// read at an offset that is not in the range [0,2^32-1], but it will generate// `OUT_OF_RANGE` if asked to read from an offset past the current file size.// There is a fair bit of overlap between `FAILED_PRECONDITION` and// `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error)// when it applies so that callers who are iterating through a space can easily// look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping:// 400 Bad Request// "UNIMPLEMENTED" - The operation is not implemented or is not// supported/enabled in this service. HTTP Mapping: 501 Not Implemented// "INTERNAL" - Internal errors. This means that some invariants expected by// the underlying system have been broken. This error code is reserved for// serious errors. HTTP Mapping: 500 Internal Server Error// "UNAVAILABLE" - The service is currently unavailable. This is most likely// a transient condition, which can be corrected by retrying with a backoff.// Note that it is not always safe to retry non-idempotent operations. See the// guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and// `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable// "DATA_LOSS" - Unrecoverable data loss or corruption. HTTP Mapping: 500// Internal Server ErrorStatusCodestring `json:"statusCode,omitempty"`// UserFacingMessage: The message to send users about the status of their// request. If unset, a generic message based on the `status_code` is sent.UserFacingMessagestring `json:"userFacingMessage,omitempty"`// ForceSendFields is a list of field names (e.g. "StatusCode") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "StatusCode") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ActionStatus: Represents the status for a request to either invoke or submita dialog (https://developers.google.com/workspace/chat/dialogs).
func (ActionStatus)MarshalJSON¶added inv0.51.0
func (sActionStatus) MarshalJSON() ([]byte,error)
typeAnnotation¶
type Annotation struct {// CustomEmojiMetadata: The metadata for a custom emoji.CustomEmojiMetadata *CustomEmojiMetadata `json:"customEmojiMetadata,omitempty"`// Length: Length of the substring in the plain-text message body this// annotation corresponds to. If not present, indicates a length of 0.Lengthint64 `json:"length,omitempty"`// RichLinkMetadata: The metadata for a rich link.RichLinkMetadata *RichLinkMetadata `json:"richLinkMetadata,omitempty"`// SlashCommand: The metadata for a slash command.SlashCommand *SlashCommandMetadata `json:"slashCommand,omitempty"`// StartIndex: Start index (0-based, inclusive) in the plain-text message body// this annotation corresponds to.StartIndexint64 `json:"startIndex,omitempty"`// Type: The type of this annotation.//// Possible values:// "ANNOTATION_TYPE_UNSPECIFIED" - Default value for the enum. Don't use.// "USER_MENTION" - A user is mentioned.// "SLASH_COMMAND" - A slash command is invoked.// "RICH_LINK" - A rich link annotation.// "CUSTOM_EMOJI" - A custom emoji annotation.Typestring `json:"type,omitempty"`// UserMention: The metadata of user mention.UserMention *UserMentionMetadata `json:"userMention,omitempty"`// ForceSendFields is a list of field names (e.g. "CustomEmojiMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CustomEmojiMetadata") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Annotation: Output only. Annotations can be associated with the plain-textbody of the message or with chips that link to Google Workspace resourceslike Google Docs or Sheets with `start_index` and `length` of 0. To addbasic formatting to a text message, see Format text messages(https://developers.google.com/workspace/chat/format-messages). Exampleplain-text message body: ``` Hello @FooBot how are you!" ``` Thecorresponding annotations metadata: ``` "annotations":[{"type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user":{ "name":"users/{user}", "displayName":"FooBot","avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }]```
func (Annotation)MarshalJSON¶
func (sAnnotation) MarshalJSON() ([]byte,error)
typeAppCommandMetadata¶added inv0.221.0
type AppCommandMetadata struct {// AppCommandId: The ID for the command specified in the Chat API// configuration.AppCommandIdint64 `json:"appCommandId,omitempty"`// AppCommandType: The type of Chat app command.//// Possible values:// "APP_COMMAND_TYPE_UNSPECIFIED" - Default value. Unspecified.// "SLASH_COMMAND" - A slash command. The user sends the command in a Chat// message.// "QUICK_COMMAND" - A quick command. The user selects the command from the// Chat menu in the message reply area.AppCommandTypestring `json:"appCommandType,omitempty"`// ForceSendFields is a list of field names (e.g. "AppCommandId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AppCommandId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}AppCommandMetadata: Metadata about a Chat app command(https://developers.google.com/workspace/chat/commands).
func (AppCommandMetadata)MarshalJSON¶added inv0.221.0
func (sAppCommandMetadata) MarshalJSON() ([]byte,error)
typeAttachedGif¶added inv0.129.0
type AttachedGif struct {// Uri: Output only. The URL that hosts the GIF image.Uristring `json:"uri,omitempty"`// ForceSendFields is a list of field names (e.g. "Uri") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Uri") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}AttachedGif: A GIF image that's specified by a URL.
func (AttachedGif)MarshalJSON¶added inv0.129.0
func (sAttachedGif) MarshalJSON() ([]byte,error)
typeAttachment¶added inv0.30.0
type Attachment struct {// AttachmentDataRef: Optional. A reference to the attachment data. This field// is used to create or update messages with attachments, or with the media API// to download the attachment data.AttachmentDataRef *AttachmentDataRef `json:"attachmentDataRef,omitempty"`// ContentName: Output only. The original file name for the content, not the// full path.ContentNamestring `json:"contentName,omitempty"`// ContentType: Output only. The content type (MIME type) of the file.ContentTypestring `json:"contentType,omitempty"`// DownloadUri: Output only. The download URL which should be used to allow a// human user to download the attachment. Chat apps shouldn't use this URL to// download attachment content.DownloadUristring `json:"downloadUri,omitempty"`// DriveDataRef: Output only. A reference to the Google Drive attachment. This// field is used with the Google Drive API.DriveDataRef *DriveDataRef `json:"driveDataRef,omitempty"`// Name: Identifier. Resource name of the attachment. Format:// `spaces/{space}/messages/{message}/attachments/{attachment}`.Namestring `json:"name,omitempty"`// Source: Output only. The source of the attachment.//// Possible values:// "SOURCE_UNSPECIFIED" - Reserved.// "DRIVE_FILE" - The file is a Google Drive file.// "UPLOADED_CONTENT" - The file is uploaded to Chat.Sourcestring `json:"source,omitempty"`// ThumbnailUri: Output only. The thumbnail URL which should be used to preview// the attachment to a human user. Chat apps shouldn't use this URL to download// attachment content.ThumbnailUristring `json:"thumbnailUri,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AttachmentDataRef") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AttachmentDataRef") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Attachment: An attachment in Google Chat.
func (Attachment)MarshalJSON¶added inv0.30.0
func (sAttachment) MarshalJSON() ([]byte,error)
typeAttachmentDataRef¶added inv0.30.0
type AttachmentDataRef struct {// AttachmentUploadToken: Optional. Opaque token containing a reference to an// uploaded attachment. Treated by clients as an opaque string and used to// create or update Chat messages with attachments.AttachmentUploadTokenstring `json:"attachmentUploadToken,omitempty"`// ResourceName: Optional. The resource name of the attachment data. This field// is used with the media API to download the attachment data.ResourceNamestring `json:"resourceName,omitempty"`// ForceSendFields is a list of field names (e.g. "AttachmentUploadToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AttachmentUploadToken") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}AttachmentDataRef: A reference to the attachment data.
func (AttachmentDataRef)MarshalJSON¶added inv0.30.0
func (sAttachmentDataRef) MarshalJSON() ([]byte,error)
typeButton¶
type Button struct {// ImageButton: A button with image and `onclick` action.ImageButton *ImageButton `json:"imageButton,omitempty"`// TextButton: A button with text and `onclick` action.TextButton *TextButton `json:"textButton,omitempty"`// ForceSendFields is a list of field names (e.g. "ImageButton") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ImageButton") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Button: A button. Can be a text button or an image button.
func (Button)MarshalJSON¶
typeCalendarEventLinkData¶added inv0.244.0
type CalendarEventLinkData struct {// CalendarId: The Calendar identifier// (https://developers.google.com/workspace/calendar/api/v3/reference/calendars)// of the linked Calendar.CalendarIdstring `json:"calendarId,omitempty"`// EventId: The Event identifier// (https://developers.google.com/workspace/calendar/api/v3/reference/events)// of the linked Calendar event.EventIdstring `json:"eventId,omitempty"`// ForceSendFields is a list of field names (e.g. "CalendarId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CalendarId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}CalendarEventLinkData: Data for Calendar event links.
func (CalendarEventLinkData)MarshalJSON¶added inv0.244.0
func (sCalendarEventLinkData) MarshalJSON() ([]byte,error)
typeCard¶
type Card struct {// CardActions: The actions of this card.CardActions []*CardAction `json:"cardActions,omitempty"`// Header: The header of the card. A header usually contains a title and an// image.Header *CardHeader `json:"header,omitempty"`// Name: Name of the card.Namestring `json:"name,omitempty"`// Sections: Sections are separated by a line divider.Sections []*Section `json:"sections,omitempty"`// ForceSendFields is a list of field names (e.g. "CardActions") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CardActions") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Card: A card is a UI element that can contain UI widgets such as text andimages.
func (Card)MarshalJSON¶
typeCardAction¶
type CardAction struct {// ActionLabel: The label used to be displayed in the action menu item.ActionLabelstring `json:"actionLabel,omitempty"`// OnClick: The onclick action for this action item.OnClick *OnClick `json:"onClick,omitempty"`// ForceSendFields is a list of field names (e.g. "ActionLabel") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ActionLabel") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}CardAction: A card action is the action associated with the card. For aninvoice card, a typical action would be: delete invoice, email invoice oropen the invoice in browser. Not supported by Google Chat apps.
func (CardAction)MarshalJSON¶
func (sCardAction) MarshalJSON() ([]byte,error)
typeCardHeader¶
type CardHeader struct {// ImageStyle: The image's type (for example, square border or circular// border).//// Possible values:// "IMAGE_STYLE_UNSPECIFIED"// "IMAGE" - Square border.// "AVATAR" - Circular border.ImageStylestring `json:"imageStyle,omitempty"`// ImageUrl: The URL of the image in the card header.ImageUrlstring `json:"imageUrl,omitempty"`// Subtitle: The subtitle of the card header.Subtitlestring `json:"subtitle,omitempty"`// Title: The title must be specified. The header has a fixed height: if both a// title and subtitle is specified, each takes up one line. If only the title// is specified, it takes up both lines.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "ImageStyle") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ImageStyle") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}func (CardHeader)MarshalJSON¶
func (sCardHeader) MarshalJSON() ([]byte,error)
typeCardWithId¶added inv0.49.0
type CardWithId struct {// Card: A card. Maximum size is 32 KB.Card *GoogleAppsCardV1Card `json:"card,omitempty"`// CardId: Required if the message contains multiple cards. A unique identifier// for a card in a message.CardIdstring `json:"cardId,omitempty"`// ForceSendFields is a list of field names (e.g. "Card") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Card") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}CardWithId: A card(https://developers.google.com/workspace/chat/api/reference/rest/v1/cards)in a Google Chat message. Only Chat apps can create cards. If your Chat appauthenticates as a user(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),the message can't contain cards. Card builder(https://addons.gsuite.google.com/uikit/builder)
func (CardWithId)MarshalJSON¶added inv0.49.0
func (sCardWithId) MarshalJSON() ([]byte,error)
typeChatAppLogEntry¶added inv0.76.0
type ChatAppLogEntry struct {// Deployment: The deployment that caused the error. For Chat apps built in// Apps Script, this is the deployment ID defined by Apps Script.Deploymentstring `json:"deployment,omitempty"`// DeploymentFunction: The unencrypted `callback_method` name that was running// when the error was encountered.DeploymentFunctionstring `json:"deploymentFunction,omitempty"`// Error: The error code and message.Error *Status `json:"error,omitempty"`// ForceSendFields is a list of field names (e.g. "Deployment") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Deployment") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ChatAppLogEntry: JSON payload of error messages. If the Cloud Logging API isenabled, these error messages are logged to Google Cloud Logging(https://cloud.google.com/logging/docs).
func (ChatAppLogEntry)MarshalJSON¶added inv0.76.0
func (sChatAppLogEntry) MarshalJSON() ([]byte,error)
typeChatClientDataSourceMarkup¶added inv0.132.0
type ChatClientDataSourceMarkup struct {// SpaceDataSource: Google Chat spaces that the user is a member of.SpaceDataSource *SpaceDataSource `json:"spaceDataSource,omitempty"`// ForceSendFields is a list of field names (e.g. "SpaceDataSource") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SpaceDataSource") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ChatClientDataSourceMarkup: For a `SelectionInput` widget that uses amultiselect menu, a data source from Google Chat. The data source populatesselection items for the multiselect menu. For example, a user can selectGoogle Chat spaces that they're a member of. Google Chat apps(https://developers.google.com/workspace/chat):
func (ChatClientDataSourceMarkup)MarshalJSON¶added inv0.132.0
func (sChatClientDataSourceMarkup) MarshalJSON() ([]byte,error)
typeChatSpaceLinkData¶added inv0.197.0
type ChatSpaceLinkData struct {// Message: The message of the linked Chat space resource. Format:// `spaces/{space}/messages/{message}`Messagestring `json:"message,omitempty"`// Space: The space of the linked Chat space resource. Format: `spaces/{space}`Spacestring `json:"space,omitempty"`// Thread: The thread of the linked Chat space resource. Format:// `spaces/{space}/threads/{thread}`Threadstring `json:"thread,omitempty"`// ForceSendFields is a list of field names (e.g. "Message") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Message") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ChatSpaceLinkData: Data for Chat space links.
func (ChatSpaceLinkData)MarshalJSON¶added inv0.197.0
func (sChatSpaceLinkData) MarshalJSON() ([]byte,error)
typeColor¶added inv0.49.0
type Color struct {// Alpha: The fraction of this color that should be applied to the pixel. That// is, the final pixel color is defined by the equation: `pixel color = alpha *// (this color) + (1.0 - alpha) * (background color)` This means that a value// of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a// completely transparent color. This uses a wrapper message rather than a// simple float scalar so that it is possible to distinguish between a default// value and the value being unset. If omitted, this color object is rendered// as a solid color (as if the alpha value had been explicitly given a value of// 1.0).Alphafloat64 `json:"alpha,omitempty"`// Blue: The amount of blue in the color as a value in the interval [0, 1].Bluefloat64 `json:"blue,omitempty"`// Green: The amount of green in the color as a value in the interval [0, 1].Greenfloat64 `json:"green,omitempty"`// Red: The amount of red in the color as a value in the interval [0, 1].Redfloat64 `json:"red,omitempty"`// ForceSendFields is a list of field names (e.g. "Alpha") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Alpha") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Color: Represents a color in the RGBA color space. This representation isdesigned for simplicity of conversion to and from color representations invarious languages over compactness. For example, the fields of thisrepresentation can be trivially provided to the constructor of`java.awt.Color` in Java; it can also be trivially provided to UIColor's`+colorWithRed:green:blue:alpha` method in iOS; and, with just a littlework, it can be easily formatted into a CSS `rgba()` string in JavaScript.This reference page doesn't have information about the absolute color spacethat should be used to interpret the RGB value—for example, sRGB, AdobeRGB, DCI-P3, and BT.2020. By default, applications should assume the sRGBcolor space. When color equality needs to be decided, implementations,unless documented otherwise, treat two colors as equal if all their red,green, blue, and alpha values each differ by at most `1e-5`. Example (Java):import com.google.type.Color; // ... public static java.awt.ColorfromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ?protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color(protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); }public static Color toProto(java.awt.Color color) { float red = (float)color.getRed(); float green = (float) color.getGreen(); float blue = (float)color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder =Color .newBuilder() .setRed(red / denominator) .setGreen(green /denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if(alpha != 255) { result.setAlpha( FloatValue .newBuilder().setValue(((float) alpha) / denominator) .build()); } returnresultBuilder.build(); } // ... Example (iOS / Obj-C): // ... staticUIColor* fromProto(Color* protocolor) { float red = [protocolor red]; floatgreen = [protocolor green]; float blue = [protocolor blue]; FloatValue*alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper !=nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:redgreen:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color){ CGFloat red, green, blue, alpha; if (![color getRed:&red green:&greenblue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc]init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue];if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; }[result autorelease]; return result; } // ... Example (JavaScript): // ...var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red ||0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue|| 0.0; var red = Math.floor(redFrac * 255); var green =Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if(!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } varalphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green,blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(”);}; var rgbToCssColor = function(red, green, blue) { var rgbNumber = newNumber((red << 16) | (green << 8) | blue); var hexString =rgbNumber.toString(16); var missingZeros = 6 - hexString.length; varresultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) {resultBuilder.push('0'); } resultBuilder.push(hexString); returnresultBuilder.join(”); }; // ...
func (Color)MarshalJSON¶added inv0.49.0
func (*Color)UnmarshalJSON¶added inv0.49.0
typeCommonEventObject¶added inv0.55.0
type CommonEventObject struct {// FormInputs: A map containing the current values of the widgets in the// displayed card. The map keys are the string IDs assigned with each widget.// The structure of the map value object is dependent on the widget type:// **Note**: The following examples are formatted for Apps Script's V8 runtime.// If you're using Rhino runtime, you must add `[""]` after the value. For// example, instead of// `e.commonEventObject.formInputs.employeeName.stringInputs.value[0]`, format// the event object as// `e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0]`. To// learn more about runtimes in Apps Script, see the V8 Runtime Overview// (https://developers.google.com/apps-script/guides/v8-runtime). *// Single-valued widgets (for example, a text box): a list of strings (only one// element). **Example**: for a text input widget with `employeeName` as its// ID, access the text input value with:// `e.commonEventObject.formInputs.employeeName.stringInputs.value[0]`. *// Multi-valued widgets (for example, checkbox groups): a list of strings.// **Example**: for a multi-value widget with `participants` as its ID, access// the value array with:// `e.commonEventObject.formInputs.participants.stringInputs.value`. * **A// date-time picker**: a `DateTimeInput object`// (https://developers.google.com/workspace/add-ons/concepts/event-objects#date-time-input).// **Example**: For a picker with an ID of `myDTPicker`, access the// `DateTimeInput`// (https://developers.google.com/workspace/add-ons/concepts/event-objects#date-time-input)// object using `e.commonEventObject.formInputs.myDTPicker.dateTimeInput`. *// **A date-only picker**: a `DateInput object`// (https://developers.google.com/workspace/add-ons/concepts/event-objects#date-input).// **Example**: For a picker with an ID of `myDatePicker`, access the// `DateInput`// (https://developers.google.com/workspace/add-ons/concepts/event-objects#date-input)// object using `e.commonEventObject.formInputs.myDatePicker.dateInput`. * **A// time-only picker**: a `TimeInput object`// (https://developers.google.com/workspace/add-ons/concepts/event-objects#time-input).// **Example**: For a picker with an ID of `myTimePicker`, access the// `TimeInput`// (https://developers.google.com/workspace/add-ons/concepts/event-objects#time-input)// object using `e.commonEventObject.formInputs.myTimePicker.timeInput`.FormInputs map[string]Inputs `json:"formInputs,omitempty"`// HostApp: Indicates the host app the add-on is active in when the event// object is generated. Possible values include the following: * `GMAIL` *// `CALENDAR` * `DRIVE` * `DOCS` * `SHEETS` * `SLIDES` * `CHAT`//// Possible values:// "UNSPECIFIED_HOST_APP" - Google can't identify a host app.// "GMAIL" - The add-on launches from Gmail.// "CALENDAR" - The add-on launches from Google Calendar.// "DRIVE" - The add-on launches from Google Drive.// "DEMO" - Not used.// "DOCS" - The add-on launches from Google Docs.// "MEET" - The add-on launches from Google Meet.// "SHEETS" - The add-on launches from Google Sheets.// "SLIDES" - The add-on launches from Google Slides.// "DRAWINGS" - The add-on launches from Google Drawings.// "CHAT" - A Google Chat app.HostAppstring `json:"hostApp,omitempty"`// InvokedFunction: Name of the function to invoke. This field doesn't populate// for Google Workspace Add-ons that extend Google Chat. Instead, to receive// function data like identifiers, add-ons that extend Chat should use the// `parameters` field. See Build interactive interfaces for Chat apps// (https://developers.google.com/workspace/add-ons/chat/build).InvokedFunctionstring `json:"invokedFunction,omitempty"`// Parameters: Any additional parameters you supply to an action using// `actionParameters`// (https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#google.apps.card.v1.Action.ActionParameter)// or `Action.setParameters()`// (https://developers.google.com/apps-script/reference/card-service/action#setparametersparameters).// **Developer Preview:** For add-ons that extend Google Chat// (https://developers.google.com/workspace/add-ons/chat), to suggest items// based on what the users type in multiselect menus, use the value of the// "autocomplete_widget_query" key// (`event.commonEventObject.parameters["autocomplete_widget_query"]`). You can// use this value to query a database and suggest selectable items to users as// they type. For details, see Collect and process information from Google Chat// users// (https://developers.google.com/workspace/add-ons/chat/collect-information).Parameters map[string]string `json:"parameters,omitempty"`// Platform: The platform enum which indicates the platform where the event// originates (`WEB`, `IOS`, or `ANDROID`). Not supported by Chat apps.//// Possible values:// "UNKNOWN_PLATFORM"// "WEB"// "IOS"// "ANDROID"Platformstring `json:"platform,omitempty"`// TimeZone: **Disabled by default.** The timezone ID and offset from// Coordinated Universal Time (UTC). To turn on this field, you must set// `addOns.common.useLocaleFromApp` to `true` in your add-on's manifest. Your// add-on's scope list must also include// `https://www.googleapis.com/auth/script.locale`. See Accessing user locale// and timezone// (https://developers.google.com/workspace/add-ons/how-tos/access-user-locale)// for more details. Only supported for the event types `CARD_CLICKED`// (https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_VALUES.CARD_CLICKED)// and `SUBMIT_DIALOG`// (https://developers.google.com/chat/api/reference/rest/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG).TimeZone *TimeZone `json:"timeZone,omitempty"`// UserLocale: **Disabled by default.** The user's language and country/region// identifier in the format of ISO 639// (https://wikipedia.org/wiki/ISO_639_macrolanguage) language code-ISO 3166// (https://wikipedia.org/wiki/ISO_3166) country/region code. For example,// `en-US`. To turn on this field, you must set// `addOns.common.useLocaleFromApp` to `true` in your add-on's manifest. Your// add-on's scope list must also include// `https://www.googleapis.com/auth/script.locale`. See Accessing user locale// and timezone// (https://developers.google.com/workspace/add-ons/how-tos/access-user-locale)// for more details.UserLocalestring `json:"userLocale,omitempty"`// ForceSendFields is a list of field names (e.g. "FormInputs") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FormInputs") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}CommonEventObject: The common event object is the portion of the overallevent object that carries general, host-independent information to theadd-on from the user's client. This information includes details such as theuser's locale, host app, and platform. In addition to homepage andcontextual triggers, add-ons construct and pass event objects to actioncallback functions(https://developers.google.com/workspace/add-ons/concepts/actions#callback_functions)when the user interacts with widgets. Your add-on's callback function canquery the common event object to determine the contents of open widgets inthe user's client. For example, your add-on can locate the text a user hasentered into a TextInput(https://developers.google.com/apps-script/reference/card-service/text-input)widget in the `eventObject.commentEventObject.formInputs` object. For Chatapps, the name of the function that the user invoked when interacting with awidget.
func (CommonEventObject)MarshalJSON¶added inv0.55.0
func (sCommonEventObject) MarshalJSON() ([]byte,error)
typeCompleteImportSpaceRequest¶added inv0.156.0
type CompleteImportSpaceRequest struct {}CompleteImportSpaceRequest: Request message for completing the importprocess for a space.
typeCompleteImportSpaceResponse¶added inv0.156.0
type CompleteImportSpaceResponse struct {// Space: The import mode space.Space *Space `json:"space,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Space") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Space") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}CompleteImportSpaceResponse: Response message for completing the importprocess for a space.
func (CompleteImportSpaceResponse)MarshalJSON¶added inv0.156.0
func (sCompleteImportSpaceResponse) MarshalJSON() ([]byte,error)
typeCustomEmoji¶added inv0.123.0
type CustomEmoji struct {// EmojiName: Optional. Immutable. User-provided name for the custom emoji,// which is unique within the organization. Required when the custom emoji is// created, output only otherwise. Emoji names must start and end with colons,// must be lowercase and can only contain alphanumeric characters, hyphens, and// underscores. Hyphens and underscores should be used to separate words and// cannot be used consecutively. Example: `:valid-emoji-name:`EmojiNamestring `json:"emojiName,omitempty"`// Name: Identifier. The resource name of the custom emoji, assigned by the// server. Format: `customEmojis/{customEmoji}`Namestring `json:"name,omitempty"`// Payload: Optional. Input only. Payload data. Required when the custom emoji// is created.Payload *CustomEmojiPayload `json:"payload,omitempty"`// TemporaryImageUri: Output only. A temporary image URL for the custom emoji,// valid for at least 10 minutes. Note that this is not populated in the// response when the custom emoji is created.TemporaryImageUristring `json:"temporaryImageUri,omitempty"`// Uid: Output only. Unique key for the custom emoji resource.Uidstring `json:"uid,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "EmojiName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EmojiName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}CustomEmoji: Represents a custom emoji(https://support.google.com/chat/answer/12800149).
func (CustomEmoji)MarshalJSON¶added inv0.123.0
func (sCustomEmoji) MarshalJSON() ([]byte,error)
typeCustomEmojiMetadata¶added inv0.220.0
type CustomEmojiMetadata struct {// CustomEmoji: The custom emoji.CustomEmoji *CustomEmoji `json:"customEmoji,omitempty"`// ForceSendFields is a list of field names (e.g. "CustomEmoji") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CustomEmoji") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}CustomEmojiMetadata: Annotation metadata for custom emoji.
func (CustomEmojiMetadata)MarshalJSON¶added inv0.220.0
func (sCustomEmojiMetadata) MarshalJSON() ([]byte,error)
typeCustomEmojiPayload¶added inv0.229.0
type CustomEmojiPayload struct {// FileContent: Required. Input only. The image used for the custom emoji. The// payload must be under 256 KB and the dimension of the image must be square// and between 64 and 500 pixels. The restrictions are subject to change.FileContentstring `json:"fileContent,omitempty"`// Filename: Required. Input only. The image file name. Supported file// extensions: `.png`, `.jpg`, `.gif`.Filenamestring `json:"filename,omitempty"`// ForceSendFields is a list of field names (e.g. "FileContent") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FileContent") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}CustomEmojiPayload: Payload data for the custom emoji.
func (CustomEmojiPayload)MarshalJSON¶added inv0.229.0
func (sCustomEmojiPayload) MarshalJSON() ([]byte,error)
typeCustomEmojisCreateCall¶added inv0.229.0
type CustomEmojisCreateCall struct {// contains filtered or unexported fields}func (*CustomEmojisCreateCall)Context¶added inv0.229.0
func (c *CustomEmojisCreateCall) Context(ctxcontext.Context) *CustomEmojisCreateCall
Context sets the context to be used in this call's Do method.
func (*CustomEmojisCreateCall)Do¶added inv0.229.0
func (c *CustomEmojisCreateCall) Do(opts ...googleapi.CallOption) (*CustomEmoji,error)
Do executes the "chat.customEmojis.create" call.Any non-2xx status code is an error. Response headers are in either*CustomEmoji.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*CustomEmojisCreateCall)Fields¶added inv0.229.0
func (c *CustomEmojisCreateCall) Fields(s ...googleapi.Field) *CustomEmojisCreateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CustomEmojisCreateCall)Header¶added inv0.229.0
func (c *CustomEmojisCreateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeCustomEmojisDeleteCall¶added inv0.229.0
type CustomEmojisDeleteCall struct {// contains filtered or unexported fields}func (*CustomEmojisDeleteCall)Context¶added inv0.229.0
func (c *CustomEmojisDeleteCall) Context(ctxcontext.Context) *CustomEmojisDeleteCall
Context sets the context to be used in this call's Do method.
func (*CustomEmojisDeleteCall)Do¶added inv0.229.0
func (c *CustomEmojisDeleteCall) Do(opts ...googleapi.CallOption) (*Empty,error)
Do executes the "chat.customEmojis.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*CustomEmojisDeleteCall)Fields¶added inv0.229.0
func (c *CustomEmojisDeleteCall) Fields(s ...googleapi.Field) *CustomEmojisDeleteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CustomEmojisDeleteCall)Header¶added inv0.229.0
func (c *CustomEmojisDeleteCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeCustomEmojisGetCall¶added inv0.229.0
type CustomEmojisGetCall struct {// contains filtered or unexported fields}func (*CustomEmojisGetCall)Context¶added inv0.229.0
func (c *CustomEmojisGetCall) Context(ctxcontext.Context) *CustomEmojisGetCall
Context sets the context to be used in this call's Do method.
func (*CustomEmojisGetCall)Do¶added inv0.229.0
func (c *CustomEmojisGetCall) Do(opts ...googleapi.CallOption) (*CustomEmoji,error)
Do executes the "chat.customEmojis.get" call.Any non-2xx status code is an error. Response headers are in either*CustomEmoji.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*CustomEmojisGetCall)Fields¶added inv0.229.0
func (c *CustomEmojisGetCall) Fields(s ...googleapi.Field) *CustomEmojisGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CustomEmojisGetCall)Header¶added inv0.229.0
func (c *CustomEmojisGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*CustomEmojisGetCall)IfNoneMatch¶added inv0.229.0
func (c *CustomEmojisGetCall) IfNoneMatch(entityTagstring) *CustomEmojisGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeCustomEmojisListCall¶added inv0.229.0
type CustomEmojisListCall struct {// contains filtered or unexported fields}func (*CustomEmojisListCall)Context¶added inv0.229.0
func (c *CustomEmojisListCall) Context(ctxcontext.Context) *CustomEmojisListCall
Context sets the context to be used in this call's Do method.
func (*CustomEmojisListCall)Do¶added inv0.229.0
func (c *CustomEmojisListCall) Do(opts ...googleapi.CallOption) (*ListCustomEmojisResponse,error)
Do executes the "chat.customEmojis.list" call.Any non-2xx status code is an error. Response headers are in either*ListCustomEmojisResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*CustomEmojisListCall)Fields¶added inv0.229.0
func (c *CustomEmojisListCall) Fields(s ...googleapi.Field) *CustomEmojisListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CustomEmojisListCall)Filter¶added inv0.229.0
func (c *CustomEmojisListCall) Filter(filterstring) *CustomEmojisListCall
Filter sets the optional parameter "filter": A query filter. Supportsfiltering by creator. To filter by creator, you must specify a valid value.Currently only `creator("users/me")` and `NOT creator("users/me")` areaccepted to filter custom emojis by whether they were created by the callinguser or not. For example, the following query returns custom emojis createdby the caller: ``` creator("users/me") ``` Invalid queries are rejected withan `INVALID_ARGUMENT` error.
func (*CustomEmojisListCall)Header¶added inv0.229.0
func (c *CustomEmojisListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*CustomEmojisListCall)IfNoneMatch¶added inv0.229.0
func (c *CustomEmojisListCall) IfNoneMatch(entityTagstring) *CustomEmojisListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*CustomEmojisListCall)PageSize¶added inv0.229.0
func (c *CustomEmojisListCall) PageSize(pageSizeint64) *CustomEmojisListCall
PageSize sets the optional parameter "pageSize": The maximum number ofcustom emojis returned. The service can return fewer custom emojis than thisvalue. If unspecified, the default value is 25. The maximum value is 200;values above 200 are changed to 200.
func (*CustomEmojisListCall)PageToken¶added inv0.229.0
func (c *CustomEmojisListCall) PageToken(pageTokenstring) *CustomEmojisListCall
PageToken sets the optional parameter "pageToken": (If resuming from aprevious query.) A page token received from a previous list custom emojicall. Provide this to retrieve the subsequent page. When paginating, thefilter value should match the call that provided the page token. Passing adifferent value might lead to unexpected results.
func (*CustomEmojisListCall)Pages¶added inv0.229.0
func (c *CustomEmojisListCall) Pages(ctxcontext.Context, f func(*ListCustomEmojisResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
typeCustomEmojisService¶added inv0.229.0
type CustomEmojisService struct {// contains filtered or unexported fields}funcNewCustomEmojisService¶added inv0.229.0
func NewCustomEmojisService(s *Service) *CustomEmojisService
func (*CustomEmojisService)Create¶added inv0.229.0
func (r *CustomEmojisService) Create(customemoji *CustomEmoji) *CustomEmojisCreateCall
Create: Creates a custom emoji. Custom emojis are only available for GoogleWorkspace accounts, and the administrator must turn custom emojis on for theorganization. For more information, see Learn about custom emojis in GoogleChat (https://support.google.com/chat/answer/12800149) and Manage customemoji permissions (https://support.google.com/a/answer/12850085). Requiresuser authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with the authorization scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.customemojis`
func (*CustomEmojisService)Delete¶added inv0.229.0
func (r *CustomEmojisService) Delete(namestring) *CustomEmojisDeleteCall
Delete: Deletes a custom emoji. By default, users can only delete customemoji they created. Emoji managers(https://support.google.com/a/answer/12850085) assigned by the administratorcan delete any custom emoji in the organization. See Learn about customemojis in Google Chat (https://support.google.com/chat/answer/12800149).Custom emojis are only available for Google Workspace accounts, and theadministrator must turn custom emojis on for the organization. For moreinformation, see Learn about custom emojis in Google Chat(https://support.google.com/chat/answer/12800149) and Manage custom emojipermissions (https://support.google.com/a/answer/12850085). Requires userauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with the authorization scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.customemojis`
- name: Resource name of the custom emoji to delete. Format:`customEmojis/{customEmoji}` You can use the emoji name as an alias for`{customEmoji}`. For example, `customEmojis/:example-emoji:` where`:example-emoji:` is the emoji name for a custom emoji.
func (*CustomEmojisService)Get¶added inv0.229.0
func (r *CustomEmojisService) Get(namestring) *CustomEmojisGetCall
Get: Returns details about a custom emoji. Custom emojis are only availablefor Google Workspace accounts, and the administrator must turn custom emojison for the organization. For more information, see Learn about custom emojisin Google Chat (https://support.google.com/chat/answer/12800149) and Managecustom emoji permissions (https://support.google.com/a/answer/12850085).Requires user authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.customemojis.readonly` -`https://www.googleapis.com/auth/chat.customemojis`
- name: Resource name of the custom emoji. Format:`customEmojis/{customEmoji}` You can use the emoji name as an alias for`{customEmoji}`. For example, `customEmojis/:example-emoji:` where`:example-emoji:` is the emoji name for a custom emoji.
func (*CustomEmojisService)List¶added inv0.229.0
func (r *CustomEmojisService) List() *CustomEmojisListCall
List: Lists custom emojis visible to the authenticated user. Custom emojisare only available for Google Workspace accounts, and the administrator mustturn custom emojis on for the organization. For more information, see Learnabout custom emojis in Google Chat(https://support.google.com/chat/answer/12800149) and Manage custom emojipermissions (https://support.google.com/a/answer/12850085). Requires userauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.customemojis.readonly` -`https://www.googleapis.com/auth/chat.customemojis`
typeDateInput¶added inv0.55.0
type DateInput struct {// MsSinceEpoch: Time since epoch time, in milliseconds.MsSinceEpochint64 `json:"msSinceEpoch,omitempty,string"`// ForceSendFields is a list of field names (e.g. "MsSinceEpoch") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MsSinceEpoch") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DateInput: Date input values.
func (DateInput)MarshalJSON¶added inv0.55.0
typeDateTimeInput¶added inv0.55.0
type DateTimeInput struct {// HasDate: Whether the `datetime` input includes a calendar date.HasDatebool `json:"hasDate,omitempty"`// HasTime: Whether the `datetime` input includes a timestamp.HasTimebool `json:"hasTime,omitempty"`// MsSinceEpoch: Time since epoch time, in milliseconds.MsSinceEpochint64 `json:"msSinceEpoch,omitempty,string"`// ForceSendFields is a list of field names (e.g. "HasDate") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "HasDate") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DateTimeInput: Date and time input values.
func (DateTimeInput)MarshalJSON¶added inv0.55.0
func (sDateTimeInput) MarshalJSON() ([]byte,error)
typeDeletionMetadata¶added inv0.123.0
type DeletionMetadata struct {// DeletionType: Indicates who deleted the message.//// Possible values:// "DELETION_TYPE_UNSPECIFIED" - This value is unused.// "CREATOR" - User deleted their own message.// "SPACE_OWNER" - An owner or manager deleted the message.// "ADMIN" - A Google Workspace administrator deleted the message.// Administrators can delete any message in the space, including messages sent// by any space member or Chat app.// "APP_MESSAGE_EXPIRY" - A Chat app deleted its own message when it expired.// "CREATOR_VIA_APP" - A Chat app deleted the message on behalf of the// creator (using user authentication).// "SPACE_OWNER_VIA_APP" - A Chat app deleted the message on behalf of a// space manager (using user authentication).// "SPACE_MEMBER" - A member of the space deleted the message. Users can// delete messages sent by apps.DeletionTypestring `json:"deletionType,omitempty"`// ForceSendFields is a list of field names (e.g. "DeletionType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DeletionType") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DeletionMetadata: Information about a deleted message. A message is deletedwhen `delete_time` is set.
func (DeletionMetadata)MarshalJSON¶added inv0.123.0
func (sDeletionMetadata) MarshalJSON() ([]byte,error)
typeDeprecatedEvent¶
type DeprecatedEvent struct {// Action: For `CARD_CLICKED` interaction events, the form action data// associated when a user clicks a card or dialog. To learn more, see Read form// data input by users on cards// (https://developers.google.com/workspace/chat/read-form-data).Action *FormAction `json:"action,omitempty"`// AppCommandMetadata: Metadata about a Chat app command.AppCommandMetadata *AppCommandMetadata `json:"appCommandMetadata,omitempty"`// Common: Represents information about the user's client, such as locale, host// app, and platform. For Chat apps, `CommonEventObject` includes information// submitted by users interacting with dialogs// (https://developers.google.com/workspace/chat/dialogs), like data entered on// a card.Common *CommonEventObject `json:"common,omitempty"`// ConfigCompleteRedirectUrl: This URL is populated for `MESSAGE`,// `ADDED_TO_SPACE`, and `APP_COMMAND` interaction events. After completing an// authorization or configuration flow outside of Google Chat, users must be// redirected to this URL to signal to Google Chat that the authorization or// configuration flow was successful. For more information, see Connect a Chat// app with other services and tools// (https://developers.google.com/workspace/chat/connect-web-services-tools).ConfigCompleteRedirectUrlstring `json:"configCompleteRedirectUrl,omitempty"`// DialogEventType: The type of dialog// (https://developers.google.com/workspace/chat/dialogs) interaction event// received.//// Possible values:// "TYPE_UNSPECIFIED" - Default value. Unspecified.// "REQUEST_DIALOG" - A user opens a dialog.// "SUBMIT_DIALOG" - A user clicks an interactive element of a dialog. For// example, a user fills out information in a dialog and clicks a button to// submit the information.// "CANCEL_DIALOG" - A user closes a dialog without submitting information.// The Chat app only receives this interaction event when users click the close// icon in the top right corner of the dialog. When the user closes the dialog// by other means (such as refreshing the browser, clicking outside the dialog// box, or pressing the escape key), no event is sent.DialogEventTypestring `json:"dialogEventType,omitempty"`// EventTime: The timestamp indicating when the interaction event occurred.EventTimestring `json:"eventTime,omitempty"`// IsDialogEvent: For `CARD_CLICKED` and `MESSAGE` interaction events, whether// the user is interacting with or about to interact with a dialog// (https://developers.google.com/workspace/chat/dialogs).IsDialogEventbool `json:"isDialogEvent,omitempty"`// Message: For `ADDED_TO_SPACE`, `CARD_CLICKED`, and `MESSAGE` interaction// events, the message that triggered the interaction event, if applicable.Message *Message `json:"message,omitempty"`// Space: The space in which the user interacted with the Chat app.Space *Space `json:"space,omitempty"`// Thread: The thread in which the user interacted with the Chat app. This// could be in a new thread created by a newly sent message. This field is// populated if the interaction event is associated with a specific message or// thread.Thread *Thread `json:"thread,omitempty"`// ThreadKey: The Chat app-defined key for the thread related to the// interaction event. See `spaces.messages.thread.threadKey`// (/chat/api/reference/rest/v1/spaces.messages#Thread.FIELDS.thread_key) for// more information.ThreadKeystring `json:"threadKey,omitempty"`// Token: A secret value that legacy Chat apps can use to verify if a request// is from Google. Google randomly generates the token, and its value remains// static. You can obtain, revoke, or regenerate the token from the Chat API// configuration page// (https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat)// in the Google Cloud Console. Modern Chat apps don't use this field. It is// absent from API responses and the Chat API configuration page// (https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat).Tokenstring `json:"token,omitempty"`// Type: The type (/workspace/chat/api/reference/rest/v1/EventType) of user// interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`.//// Possible values:// "UNSPECIFIED" - Default value for the enum. DO NOT USE.// "MESSAGE" - A user sends the Chat app a message, or invokes the Chat app// in a space. Examples of message events include: * Any message in a direct// message (DM) space with the Chat app. * A message in a multi-person space// where a person @mentions the Chat app, or uses one of its [slash// commands](https://developers.google.com/workspace/chat/commands#types). * If// you've configured link previews for your Chat app, a user posts a message// that contains a link that matches the configured URL pattern.// "ADDED_TO_SPACE" - A user adds the Chat app to a space, or a Google// Workspace administrator installs the Chat app in direct message spaces for// users in their organization. Chat apps typically respond to this interaction// event by posting a welcome message in the space. When administrators install// Chat apps, the `space.adminInstalled` field is set to `true` and users can't// uninstall them. To learn about Chat apps installed by administrators, see// Google Workspace Admin Help's documentation, [Install Marketplace apps in// your domain](https://support.google.com/a/answer/172482).// "REMOVED_FROM_SPACE" - A user removes the Chat app from a space, or a// Google Workspace administrator uninstalls the Chat app for a user in their// organization. Chat apps can't respond with messages to this event, because// they have already been removed. When administrators uninstall Chat apps, the// `space.adminInstalled` field is set to `false`. If a user installed the Chat// app before the administrator, the Chat app remains installed for the user// and the Chat app doesn't receive a `REMOVED_FROM_SPACE` interaction event.// "CARD_CLICKED" - A user clicks an interactive element of a card or dialog// from a Chat app, such as a button. To receive an interaction event, the// button must trigger another interaction with the Chat app. For example, a// Chat app doesn't receive a `CARD_CLICKED` interaction event if a user clicks// a button that opens a link to a website, but receives interaction events in// the following examples: * The user clicks a `Send feedback` button on a// card, which opens a dialog for the user to input information. * The user// clicks a `Submit` button after inputting information into a card or dialog.// If a user clicks a button to open, submit, or cancel a dialog, the// `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true`// and includes a// [`DialogEventType`](https://developers.google.com/workspace/chat/api/referenc// e/rest/v1/DialogEventType).// "WIDGET_UPDATED" - A user updates a widget in a card message or dialog.// This event is triggered when a user interacts with a widget that has an// associated action.// "APP_COMMAND" - A user uses a Chat app// [command](https://developers.google.com/workspace/chat/commands#types),// including slash commands and quick commands.Typestring `json:"type,omitempty"`// User: The user that interacted with the Chat app.User *User `json:"user,omitempty"`// ForceSendFields is a list of field names (e.g. "Action") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Action") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DeprecatedEvent: A Google Chat app interaction event that represents andcontains data about a user's interaction with a Chat app. To configure yourChat app to receive interaction events, see Receive and respond to userinteractions(https://developers.google.com/workspace/chat/receive-respond-interactions).In addition to receiving events from user interactions, Chat apps canreceive events about changes to spaces, such as when a new member is addedto a space. To learn about space events, see Work with events from GoogleChat (https://developers.google.com/workspace/chat/events-overview). Note:This event is only used for Chat interaction events(https://developers.google.com/workspace/chat/receive-respond-interactions).If your Chat app is built as a Google Workspace add-on(https://developers.google.com/workspace/add-ons/chat/build), see Chat eventobjects(https://developers.google.com/workspace/add-ons/concepts/event-objects#chat-event-object)in the add-ons documentation.
func (DeprecatedEvent)MarshalJSON¶
func (sDeprecatedEvent) MarshalJSON() ([]byte,error)
typeDialog¶added inv0.51.0
type Dialog struct {// Body: Input only. Body of the dialog, which is rendered in a modal. Google// Chat apps don't support the following card entities: `DateTimePicker`,// `OnChangeAction`.Body *GoogleAppsCardV1Card `json:"body,omitempty"`// ForceSendFields is a list of field names (e.g. "Body") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Body") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Dialog: Wrapper around the card body of the dialog.
func (Dialog)MarshalJSON¶added inv0.51.0
typeDialogAction¶added inv0.51.0
type DialogAction struct {// ActionStatus: Input only. Status for a request to either invoke or submit a// dialog (https://developers.google.com/workspace/chat/dialogs). Displays a// status and message to users, if necessary. For example, in case of an error// or success.ActionStatus *ActionStatus `json:"actionStatus,omitempty"`// Dialog: Input only. Dialog// (https://developers.google.com/workspace/chat/dialogs) for the request.Dialog *Dialog `json:"dialog,omitempty"`// ForceSendFields is a list of field names (e.g. "ActionStatus") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ActionStatus") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DialogAction: Contains a dialog(https://developers.google.com/workspace/chat/dialogs) and request statuscode.
func (DialogAction)MarshalJSON¶added inv0.51.0
func (sDialogAction) MarshalJSON() ([]byte,error)
typeDriveDataRef¶added inv0.30.0
type DriveDataRef struct {// DriveFileId: The ID for the drive file. Use with the Drive API.DriveFileIdstring `json:"driveFileId,omitempty"`// ForceSendFields is a list of field names (e.g. "DriveFileId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DriveFileId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DriveDataRef: A reference to the data of a drive attachment.
func (DriveDataRef)MarshalJSON¶added inv0.30.0
func (sDriveDataRef) MarshalJSON() ([]byte,error)
typeDriveLinkData¶added inv0.170.0
type DriveLinkData struct {// DriveDataRef: A DriveDataRef// (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref)// which references a Google Drive file.DriveDataRef *DriveDataRef `json:"driveDataRef,omitempty"`// MimeType: The mime type of the linked Google Drive resource.MimeTypestring `json:"mimeType,omitempty"`// ForceSendFields is a list of field names (e.g. "DriveDataRef") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DriveDataRef") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DriveLinkData: Data for Google Drive links.
func (DriveLinkData)MarshalJSON¶added inv0.170.0
func (sDriveLinkData) MarshalJSON() ([]byte,error)
typeEmoji¶added inv0.123.0
type Emoji struct {// CustomEmoji: A custom emoji.CustomEmoji *CustomEmoji `json:"customEmoji,omitempty"`// Unicode: Optional. A basic emoji represented by a unicode string.Unicodestring `json:"unicode,omitempty"`// ForceSendFields is a list of field names (e.g. "CustomEmoji") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CustomEmoji") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Emoji: An emoji that is used as a reaction to a message.
func (Emoji)MarshalJSON¶added inv0.123.0
typeEmojiReactionSummary¶added inv0.123.0
type EmojiReactionSummary struct {// Emoji: Output only. Emoji associated with the reactions.Emoji *Emoji `json:"emoji,omitempty"`// ReactionCount: Output only. The total number of reactions using the// associated emoji.ReactionCountint64 `json:"reactionCount,omitempty"`// ForceSendFields is a list of field names (e.g. "Emoji") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Emoji") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}EmojiReactionSummary: The number of people who reacted to a message with aspecific emoji.
func (EmojiReactionSummary)MarshalJSON¶added inv0.123.0
func (sEmojiReactionSummary) MarshalJSON() ([]byte,error)
typeEmpty¶
type Empty struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}Empty: A generic empty message that you can re-use to avoid definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
typeFormAction¶
type FormAction struct {// ActionMethodName: The method name is used to identify which part of the form// triggered the form submission. This information is echoed back to the Chat// app as part of the card click event. You can use the same method name for// several elements that trigger a common behavior.ActionMethodNamestring `json:"actionMethodName,omitempty"`// Parameters: List of action parameters.Parameters []*ActionParameter `json:"parameters,omitempty"`// ForceSendFields is a list of field names (e.g. "ActionMethodName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ActionMethodName") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}FormAction: A form action describes the behavior when the form is submitted.For example, you can invoke Apps Script to handle the form.
func (FormAction)MarshalJSON¶
func (sFormAction) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Action¶added inv0.49.0
type GoogleAppsCardV1Action struct {// AllWidgetsAreRequired: Optional. If this is true, then all widgets are// considered required by this action. Google Workspace add-ons and Chat apps// (https://developers.google.com/workspace/extend):AllWidgetsAreRequiredbool `json:"allWidgetsAreRequired,omitempty"`// Function: A custom function to invoke when the containing element is clicked// or otherwise activated. For example usage, see Read form data// (https://developers.google.com/workspace/chat/read-form-data).Functionstring `json:"function,omitempty"`// Interaction: Optional. Required when opening a dialog// (https://developers.google.com/workspace/chat/dialogs). What to do in// response to an interaction with a user, such as a user clicking a button in// a card message. If unspecified, the app responds by executing an// `action`—like opening a link or running a function—as normal. By// specifying an `interaction`, the app can respond in special interactive// ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can// open a dialog (https://developers.google.com/workspace/chat/dialogs). When// specified, a loading indicator isn't shown. If specified for an add-on, the// entire card is stripped and nothing is shown in the client. Google Chat apps// (https://developers.google.com/workspace/chat)://// Possible values:// "INTERACTION_UNSPECIFIED" - Default value. The `action` executes as// normal.// "OPEN_DIALOG" - Opens a// [dialog](https://developers.google.com/workspace/chat/dialogs), a windowed,// card-based interface that Chat apps use to interact with users. Only// supported by Chat apps in response to button-clicks on card messages. If// specified for an add-on, the entire card is stripped and nothing is shown in// the client. [Google Chat// apps](https://developers.google.com/workspace/chat):Interactionstring `json:"interaction,omitempty"`// LoadIndicator: Specifies the loading indicator that the action displays// while making the call to the action.//// Possible values:// "SPINNER" - Displays a spinner to indicate that content is loading.// "NONE" - Nothing is displayed.LoadIndicatorstring `json:"loadIndicator,omitempty"`// Parameters: List of action parameters.Parameters []*GoogleAppsCardV1ActionParameter `json:"parameters,omitempty"`// PersistValues: Indicates whether form values persist after the action. The// default value is `false`. If `true`, form values remain after the action is// triggered. To let the user make changes while the action is being processed,// set `LoadIndicator`// (https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator)// to `NONE`. For card messages// (https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create)// in Chat apps, you must also set the action's `ResponseType`// (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype)// to `UPDATE_MESSAGE` and use the same `card_id`// (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId)// from the card that contained the action. If `false`, the form values are// cleared when the action is triggered. To prevent the user from making// changes while the action is being processed, set `LoadIndicator`// (https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator)// to `SPINNER`.PersistValuesbool `json:"persistValues,omitempty"`// RequiredWidgets: Optional. Fill this list with the names of widgets that// this Action needs for a valid submission. If the widgets listed here don't// have a value when this Action is invoked, the form submission is aborted.// Google Workspace add-ons and Chat apps// (https://developers.google.com/workspace/extend):RequiredWidgets []string `json:"requiredWidgets,omitempty"`// ForceSendFields is a list of field names (e.g. "AllWidgetsAreRequired") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllWidgetsAreRequired") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Action: An action that describes the behavior when the formis submitted. For example, you can invoke an Apps Script script to handlethe form. If the action is triggered, the form values are sent to theserver. Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1Action)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1Action) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1ActionParameter¶added inv0.49.0
type GoogleAppsCardV1ActionParameter struct {// Key: The name of the parameter for the action script.Keystring `json:"key,omitempty"`// Value: The value of the parameter.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Key") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Key") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1ActionParameter: List of string parameters to supply whenthe action method is invoked. For example, consider three snooze buttons:snooze now, snooze one day, or snooze next week. You might use `actionmethod = snooze()`, passing the snooze type and snooze time in the list ofstring parameters. To learn more, see `CommonEventObject`(https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject).Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1ActionParameter)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1ActionParameter) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1BorderStyle¶added inv0.49.0
type GoogleAppsCardV1BorderStyle struct {// CornerRadius: The corner radius for the border.CornerRadiusint64 `json:"cornerRadius,omitempty"`// StrokeColor: The colors to use when the type is `BORDER_TYPE_STROKE`. To set// the stroke color, specify a value for the `red`, `green`, and `blue` fields.// The value must be a float number between 0 and 1 based on the RGB color// value, where `0` (0/255) represents the absence of color and `1` (255/255)// represents the maximum intensity of the color. For example, the following// sets the color to red at its maximum intensity: “` "color": { "red": 1,// "green": 0, "blue": 0, } “` The `alpha` field is unavailable for stroke// color. If specified, this field is ignored.StrokeColor *Color `json:"strokeColor,omitempty"`// Type: The border type.//// Possible values:// "BORDER_TYPE_UNSPECIFIED" - Don't use. Unspecified.// "NO_BORDER" - No border.// "STROKE" - Default value. Outline.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "CornerRadius") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CornerRadius") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1BorderStyle: The style options for the border of a card orwidget, including the border type and color. Google Workspace add-ons andChat apps (https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1BorderStyle)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1BorderStyle) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Button¶added inv0.49.0
type GoogleAppsCardV1Button struct {// AltText: The alternative text that's used for accessibility. Set descriptive// text that lets users know what the button does. For example, if a button// opens a hyperlink, you might write: "Opens a new browser tab and navigates// to the Google Chat developer documentation at//https://developers.google.com/workspace/chat".AltTextstring `json:"altText,omitempty"`// Color: Optional. The color of the button. If set, the button `type` is set// to `FILLED` and the color of `text` and `icon` fields are set to a// contrasting color for readability. For example, if the button color is set// to blue, any text or icons in the button are set to white. To set the button// color, specify a value for the `red`, `green`, and `blue` fields. The value// must be a float number between 0 and 1 based on the RGB color value, where// `0` (0/255) represents the absence of color and `1` (255/255) represents the// maximum intensity of the color. For example, the following sets the color to// red at its maximum intensity: “` "color": { "red": 1, "green": 0, "blue":// 0, } “` The `alpha` field is unavailable for button color. If specified,// this field is ignored.Color *Color `json:"color,omitempty"`// Disabled: If `true`, the button is displayed in an inactive state and// doesn't respond to user actions.Disabledbool `json:"disabled,omitempty"`// Icon: An icon displayed inside the button. If both `icon` and `text` are// set, then the icon appears before the text.Icon *GoogleAppsCardV1Icon `json:"icon,omitempty"`// OnClick: Required. The action to perform when a user clicks the button, such// as opening a hyperlink or running a custom function.OnClick *GoogleAppsCardV1OnClick `json:"onClick,omitempty"`// Text: The text displayed inside the button.Textstring `json:"text,omitempty"`// Type: Optional. The type of a button. If unset, button type defaults to// `OUTLINED`. If the `color` field is set, the button type is forced to// `FILLED` and any value set for this field is ignored.//// Possible values:// "TYPE_UNSPECIFIED" - Don't use. Unspecified.// "OUTLINED" - Outlined buttons are medium-emphasis buttons. They usually// contain actions that are important, but aren’t the primary action in a// Chat app or an add-on.// "FILLED" - A filled button has a container with a solid color. It has the// most visual impact and is recommended for the important and primary action// in a Chat app or an add-on.// "FILLED_TONAL" - A filled tonal button is an alternative middle ground// between filled and outlined buttons. They’re useful in contexts where a// lower-priority button requires slightly more emphasis than an outline button// would give.// "BORDERLESS" - A button does not have an invisible container in its// default state. It is often used for the lowest priority actions, especially// when presenting multiple options.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "AltText") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AltText") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Button: A text, icon, or text and icon button that users canclick. For an example in Google Chat apps, see Add a button(https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button).To make an image a clickable button, specify an `Image` (not an`ImageComponent`) and set an `onClick` action. Google Workspace add-ons andChat apps (https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1Button)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1Button) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1ButtonList¶added inv0.49.0
type GoogleAppsCardV1ButtonList struct {// Buttons: An array of buttons.Buttons []*GoogleAppsCardV1Button `json:"buttons,omitempty"`// ForceSendFields is a list of field names (e.g. "Buttons") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Buttons") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1ButtonList: A list of buttons layed out horizontally. For anexample in Google Chat apps, see Add a button(https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button).Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1ButtonList)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1ButtonList) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Card¶added inv0.49.0
type GoogleAppsCardV1Card struct {// CardActions: The card's actions. Actions are added to the card's toolbar// menu. Google Workspace add-ons// (https://developers.google.com/workspace/add-ons): For example, the// following JSON constructs a card action menu with `Settings` and `Send// Feedback` options: “` "card_actions": [ { "actionLabel": "Settings",// "onClick": { "action": { "functionName": "goToView", "parameters": [ {// "key": "viewType", "value": "SETTING" } ], "loadIndicator":// "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick":// { "openLink": { "url": "https://example.com/feedback" } } } ] “`CardActions []*GoogleAppsCardV1CardAction `json:"cardActions,omitempty"`// DisplayStyle: In Google Workspace add-ons, sets the display properties of// the `peekCardHeader`. Google Workspace add-ons// (https://developers.google.com/workspace/add-ons)://// Possible values:// "DISPLAY_STYLE_UNSPECIFIED" - Don't use. Unspecified.// "PEEK" - The header of the card appears at the bottom of the sidebar,// partially covering the current top card of the stack. Clicking the header// pops the card into the card stack. If the card has no header, a generated// header is used instead.// "REPLACE" - Default value. The card is shown by replacing the view of the// top card in the card stack.DisplayStylestring `json:"displayStyle,omitempty"`// ExpressionData: The expression data for the card. Available for Google// Workspace add-ons that extend Google Workspace flows, which is available as// part of the Gemini Alpha program// (https://support.google.com/a/answer/14170809). Unavailable for Google Chat// apps.ExpressionData []*GoogleAppsCardV1ExpressionData `json:"expressionData,omitempty"`// FixedFooter: The fixed footer shown at the bottom of this card. Setting// `fixedFooter` without specifying a `primaryButton` or a `secondaryButton`// causes an error. For Chat apps, you can use fixed footers in dialogs// (https://developers.google.com/workspace/chat/dialogs), but not card// messages// (https://developers.google.com/workspace/chat/create-messages#create).// Google Workspace add-ons and Chat apps// (https://developers.google.com/workspace/extend):FixedFooter *GoogleAppsCardV1CardFixedFooter `json:"fixedFooter,omitempty"`// Header: The header of the card. A header usually contains a leading image// and a title. Headers always appear at the top of a card.Header *GoogleAppsCardV1CardHeader `json:"header,omitempty"`// Name: Name of the card. Used as a card identifier in card navigation. Google// Workspace add-ons (https://developers.google.com/workspace/add-ons):Namestring `json:"name,omitempty"`// PeekCardHeader: When displaying contextual content, the peek card header// acts as a placeholder so that the user can navigate forward between the// homepage cards and the contextual cards. Google Workspace add-ons// (https://developers.google.com/workspace/add-ons):PeekCardHeader *GoogleAppsCardV1CardHeader `json:"peekCardHeader,omitempty"`// SectionDividerStyle: The divider style between the header, sections and// footer.//// Possible values:// "DIVIDER_STYLE_UNSPECIFIED" - Don't use. Unspecified.// "SOLID_DIVIDER" - Default option. Render a solid divider.// "NO_DIVIDER" - If set, no divider is rendered. This style completely// removes the divider from the layout. The result is equivalent to not adding// a divider at all.SectionDividerStylestring `json:"sectionDividerStyle,omitempty"`// Sections: Contains a collection of widgets. Each section has its own,// optional header. Sections are visually separated by a line divider. For an// example in Google Chat apps, see Define a section of a card// (https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).Sections []*GoogleAppsCardV1Section `json:"sections,omitempty"`// ForceSendFields is a list of field names (e.g. "CardActions") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CardActions") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Card: A card interface displayed in a Google Chat message orGoogle Workspace add-on. Cards support a defined layout, interactive UIelements like buttons, and rich media like images. Use cards to presentdetailed information, gather information from users, and guide users to takea next step. Card builder (https://addons.gsuite.google.com/uikit/builder)To learn how to build cards, see the following documentation: * For GoogleChat apps, see Design the components of a card or dialog(https://developers.google.com/workspace/chat/design-components-card-dialog).* For Google Workspace add-ons, see Card-based interfaces(https://developers.google.com/apps-script/add-ons/concepts/cards). Note:You can add up to 100 widgets per card. Any widgets beyond this limit areignored. This limit applies to both card messages and dialogs in Google Chatapps, and to cards in Google Workspace add-ons. **Example: Card message fora Google Chat app** !Example contact card(https://developers.google.com/workspace/chat/images/card_api_reference.png)To create the sample card message in Google Chat, use the following JSON:``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": {"title": "Sasha", "subtitle": "Software Engineer", "imageUrl":"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections":[ { "header": "Contact Info", "collapsible": true,"uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": {"startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, {"decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online"} }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1(555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share","onClick": { "openLink": { "url": "https://example.com/share" } } }, {"text": "Edit", "onClick": { "action": { "function": "goToView","parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] }} ] } ```
func (GoogleAppsCardV1Card)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1Card) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1CardAction¶added inv0.49.0
type GoogleAppsCardV1CardAction struct {// ActionLabel: The label that displays as the action menu item.ActionLabelstring `json:"actionLabel,omitempty"`// OnClick: The `onClick` action for this action item.OnClick *GoogleAppsCardV1OnClick `json:"onClick,omitempty"`// ForceSendFields is a list of field names (e.g. "ActionLabel") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ActionLabel") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1CardAction: A card action is the action associated with thecard. For example, an invoice card might include actions such as deleteinvoice, email invoice, or open the invoice in a browser. Google Workspaceadd-ons (https://developers.google.com/workspace/add-ons):
func (GoogleAppsCardV1CardAction)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1CardAction) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1CardFixedFooter¶added inv0.49.0
type GoogleAppsCardV1CardFixedFooter struct {// PrimaryButton: The primary button of the fixed footer. The button must be a// text button with text and color set.PrimaryButton *GoogleAppsCardV1Button `json:"primaryButton,omitempty"`// SecondaryButton: The secondary button of the fixed footer. The button must// be a text button with text and color set. If `secondaryButton` is set, you// must also set `primaryButton`.SecondaryButton *GoogleAppsCardV1Button `json:"secondaryButton,omitempty"`// ForceSendFields is a list of field names (e.g. "PrimaryButton") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PrimaryButton") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1CardFixedFooter: A persistent (sticky) footer that thatappears at the bottom of the card. Setting `fixedFooter` without specifyinga `primaryButton` or a `secondaryButton` causes an error. For Chat apps, youcan use fixed footers in dialogs(https://developers.google.com/workspace/chat/dialogs), but not cardmessages(https://developers.google.com/workspace/chat/create-messages#create). Foran example in Google Chat apps, see Add a persistent footer(https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_persistent_footer).Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1CardFixedFooter)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1CardFixedFooter) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1CardHeader¶added inv0.49.0
type GoogleAppsCardV1CardHeader struct {// ImageAltText: The alternative text of this image that's used for// accessibility.ImageAltTextstring `json:"imageAltText,omitempty"`// ImageType: The shape used to crop the image. Google Workspace add-ons and// Chat apps (https://developers.google.com/workspace/extend)://// Possible values:// "SQUARE" - Default value. Applies a square mask to the image. For example,// a 4x3 image becomes 3x3.// "CIRCLE" - Applies a circular mask to the image. For example, a 4x3 image// becomes a circle with a diameter of 3.ImageTypestring `json:"imageType,omitempty"`// ImageUrl: The HTTPS URL of the image in the card header.ImageUrlstring `json:"imageUrl,omitempty"`// Subtitle: The subtitle of the card header. If specified, appears on its own// line below the `title`.Subtitlestring `json:"subtitle,omitempty"`// Title: Required. The title of the card header. The header has a fixed// height: if both a title and subtitle are specified, each takes up one line.// If only the title is specified, it takes up both lines.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "ImageAltText") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ImageAltText") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1CardHeader: Represents a card header. For an example inGoogle Chat apps, see Add a header(https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header).Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1CardHeader)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1CardHeader) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Carousel¶added inv0.212.0
type GoogleAppsCardV1Carousel struct {// CarouselCards: A list of cards included in the carousel.CarouselCards []*GoogleAppsCardV1CarouselCard `json:"carouselCards,omitempty"`// ForceSendFields is a list of field names (e.g. "CarouselCards") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CarouselCards") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Carousel: A carousel, also known as a slider, rotates anddisplays a list of widgets in a slideshow format, with buttons navigating tothe previous or next widget. For example, this is a JSON representation of acarousel that contains three text paragraph widgets. ``` { "carouselCards":[ { "widgets": [ { "textParagraph": { "text": "First text paragraph incarousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second textparagraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text":"Third text paragraph in carousel", } } ] } ] } ``` Google Chat apps(https://developers.google.com/workspace/chat):
func (GoogleAppsCardV1Carousel)MarshalJSON¶added inv0.212.0
func (sGoogleAppsCardV1Carousel) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1CarouselCard¶added inv0.212.0
type GoogleAppsCardV1CarouselCard struct {// FooterWidgets: A list of widgets displayed at the bottom of the carousel// card. The widgets are displayed in the order that they are specified.FooterWidgets []*GoogleAppsCardV1NestedWidget `json:"footerWidgets,omitempty"`// Widgets: A list of widgets displayed in the carousel card. The widgets are// displayed in the order that they are specified.Widgets []*GoogleAppsCardV1NestedWidget `json:"widgets,omitempty"`// ForceSendFields is a list of field names (e.g. "FooterWidgets") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FooterWidgets") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1CarouselCard: A card that can be displayed as a carouselitem. Google Chat apps (https://developers.google.com/workspace/chat):
func (GoogleAppsCardV1CarouselCard)MarshalJSON¶added inv0.212.0
func (sGoogleAppsCardV1CarouselCard) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Chip¶added inv0.204.0
type GoogleAppsCardV1Chip struct {// AltText: The alternative text that's used for accessibility. Set descriptive// text that lets users know what the chip does. For example, if a chip opens a// hyperlink, write: "Opens a new browser tab and navigates to the Google Chat// developer documentation athttps://developers.google.com/workspace/chat".AltTextstring `json:"altText,omitempty"`// Disabled: Whether the chip is in an inactive state and ignores user actions.// Defaults to `false`.Disabledbool `json:"disabled,omitempty"`// Enabled: Whether the chip is in an active state and responds to user// actions. Defaults to `true`. Deprecated. Use `disabled` instead.Enabledbool `json:"enabled,omitempty"`// Icon: The icon image. If both `icon` and `text` are set, then the icon// appears before the text.Icon *GoogleAppsCardV1Icon `json:"icon,omitempty"`// Label: The text displayed inside the chip.Labelstring `json:"label,omitempty"`// OnClick: Optional. The action to perform when a user clicks the chip, such// as opening a hyperlink or running a custom function.OnClick *GoogleAppsCardV1OnClick `json:"onClick,omitempty"`// ForceSendFields is a list of field names (e.g. "AltText") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AltText") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Chip: A text, icon, or text and icon chip that users canclick. Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1Chip)MarshalJSON¶added inv0.204.0
func (sGoogleAppsCardV1Chip) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1ChipList¶added inv0.204.0
type GoogleAppsCardV1ChipList struct {// Chips: An array of chips.Chips []*GoogleAppsCardV1Chip `json:"chips,omitempty"`// Layout: Specified chip list layout.//// Possible values:// "LAYOUT_UNSPECIFIED" - Don't use. Unspecified.// "WRAPPED" - Default value. The chip list wraps to the next line if there// isn't enough horizontal space.// "HORIZONTAL_SCROLLABLE" - The chips scroll horizontally if they don't fit// in the available space.Layoutstring `json:"layout,omitempty"`// ForceSendFields is a list of field names (e.g. "Chips") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Chips") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1ChipList: A list of chips layed out horizontally, which caneither scroll horizontally or wrap to the next line. Google Workspaceadd-ons and Chat apps (https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1ChipList)MarshalJSON¶added inv0.204.0
func (sGoogleAppsCardV1ChipList) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1CollapseControl¶added inv0.204.0
type GoogleAppsCardV1CollapseControl struct {// CollapseButton: Optional. Define a customizable button to collapse the// section. Both expand_button and collapse_button field must be set. Only one// field set will not take into effect. If this field isn't set, the default// button is used.CollapseButton *GoogleAppsCardV1Button `json:"collapseButton,omitempty"`// ExpandButton: Optional. Define a customizable button to expand the section.// Both expand_button and collapse_button field must be set. Only one field set// will not take into effect. If this field isn't set, the default button is// used.ExpandButton *GoogleAppsCardV1Button `json:"expandButton,omitempty"`// HorizontalAlignment: The horizontal alignment of the expand and collapse// button.//// Possible values:// "HORIZONTAL_ALIGNMENT_UNSPECIFIED" - Don't use. Unspecified.// "START" - Default value. Aligns widgets to the start position of the// column. For left-to-right layouts, aligns to the left. For right-to-left// layouts, aligns to the right.// "CENTER" - Aligns widgets to the center of the column.// "END" - Aligns widgets to the end position of the column. For// left-to-right layouts, aligns widgets to the right. For right-to-left// layouts, aligns widgets to the left.HorizontalAlignmentstring `json:"horizontalAlignment,omitempty"`// ForceSendFields is a list of field names (e.g. "CollapseButton") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CollapseButton") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1CollapseControl: Represent an expand and collapse control.Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1CollapseControl)MarshalJSON¶added inv0.204.0
func (sGoogleAppsCardV1CollapseControl) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Column¶added inv0.123.0
type GoogleAppsCardV1Column struct {// HorizontalAlignment: Specifies whether widgets align to the left, right, or// center of a column.//// Possible values:// "HORIZONTAL_ALIGNMENT_UNSPECIFIED" - Don't use. Unspecified.// "START" - Default value. Aligns widgets to the start position of the// column. For left-to-right layouts, aligns to the left. For right-to-left// layouts, aligns to the right.// "CENTER" - Aligns widgets to the center of the column.// "END" - Aligns widgets to the end position of the column. For// left-to-right layouts, aligns widgets to the right. For right-to-left// layouts, aligns widgets to the left.HorizontalAlignmentstring `json:"horizontalAlignment,omitempty"`// HorizontalSizeStyle: Specifies how a column fills the width of the card.//// Possible values:// "HORIZONTAL_SIZE_STYLE_UNSPECIFIED" - Don't use. Unspecified.// "FILL_AVAILABLE_SPACE" - Default value. Column fills the available space,// up to 70% of the card's width. If both columns are set to// `FILL_AVAILABLE_SPACE`, each column fills 50% of the space.// "FILL_MINIMUM_SPACE" - Column fills the least amount of space possible and// no more than 30% of the card's width.HorizontalSizeStylestring `json:"horizontalSizeStyle,omitempty"`// VerticalAlignment: Specifies whether widgets align to the top, bottom, or// center of a column.//// Possible values:// "VERTICAL_ALIGNMENT_UNSPECIFIED" - Don't use. Unspecified.// "CENTER" - Default value. Aligns widgets to the center of a column.// "TOP" - Aligns widgets to the top of a column.// "BOTTOM" - Aligns widgets to the bottom of a column.VerticalAlignmentstring `json:"verticalAlignment,omitempty"`// Widgets: An array of widgets included in a column. Widgets appear in the// order that they are specified.Widgets []*GoogleAppsCardV1Widgets `json:"widgets,omitempty"`// ForceSendFields is a list of field names (e.g. "HorizontalAlignment") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "HorizontalAlignment") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Column: A column. Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend)
func (GoogleAppsCardV1Column)MarshalJSON¶added inv0.123.0
func (sGoogleAppsCardV1Column) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Columns¶added inv0.123.0
type GoogleAppsCardV1Columns struct {// ColumnItems: An array of columns. You can include up to 2 columns in a card// or dialog.ColumnItems []*GoogleAppsCardV1Column `json:"columnItems,omitempty"`// ForceSendFields is a list of field names (e.g. "ColumnItems") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ColumnItems") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Columns: The `Columns` widget displays up to 2 columns in acard or dialog. You can add widgets to each column; the widgets appear inthe order that they are specified. For an example in Google Chat apps, seeDisplay cards and dialogs in columns(https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns).The height of each column is determined by the taller column. For example,if the first column is taller than the second column, both columns have theheight of the first column. Because each column can contain a differentnumber of widgets, you can't define rows or align widgets between thecolumns. Columns are displayed side-by-side. You can customize the width ofeach column using the `HorizontalSizeStyle` field. If the user's screenwidth is too narrow, the second column wraps below the first: * On web, thesecond column wraps if the screen width is less than or equal to 480 pixels.* On iOS devices, the second column wraps if the screen width is less thanor equal to 300 pt. * On Android devices, the second column wraps if thescreen width is less than or equal to 320 dp. To include more than twocolumns, or to use rows, use the `Grid` widget. Google Workspace add-ons andChat apps (https://developers.google.com/workspace/extend): The add-on UIsthat support columns include: * The dialog displayed when users open theadd-on from an email draft. * The dialog displayed when users open theadd-on from the **Add attachment** menu in a Google Calendar event.
func (GoogleAppsCardV1Columns)MarshalJSON¶added inv0.123.0
func (sGoogleAppsCardV1Columns) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1CommonWidgetAction¶added inv0.248.0
type GoogleAppsCardV1CommonWidgetAction struct {// UpdateVisibilityAction: The action to update the visibility of a widget.UpdateVisibilityAction *GoogleAppsCardV1UpdateVisibilityAction `json:"updateVisibilityAction,omitempty"`// ForceSendFields is a list of field names (e.g. "UpdateVisibilityAction") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "UpdateVisibilityAction") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1CommonWidgetAction: Represents an action that is notspecific to a widget. Available for Google Workspace add-ons that extendGoogle Workspace flows, which is available as part of the Gemini Alphaprogram (https://support.google.com/a/answer/14170809). Unavailable forGoogle Chat apps.
func (GoogleAppsCardV1CommonWidgetAction)MarshalJSON¶added inv0.248.0
func (sGoogleAppsCardV1CommonWidgetAction) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Condition¶added inv0.248.0
type GoogleAppsCardV1Condition struct {// ActionRuleId: The unique identifier of the ActionRule.ActionRuleIdstring `json:"actionRuleId,omitempty"`// ExpressionDataCondition: The condition that is determined by the expression// data.ExpressionDataCondition *GoogleAppsCardV1ExpressionDataCondition `json:"expressionDataCondition,omitempty"`// ForceSendFields is a list of field names (e.g. "ActionRuleId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ActionRuleId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Condition: Represents a condition that can be used totrigger an action. Available for Google Workspace add-ons that extend GoogleWorkspace flows, which is available as part of the Gemini Alpha program(https://support.google.com/a/answer/14170809). Unavailable for Google Chatapps.
func (GoogleAppsCardV1Condition)MarshalJSON¶added inv0.248.0
func (sGoogleAppsCardV1Condition) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1DataSourceConfig¶added inv0.248.0
type GoogleAppsCardV1DataSourceConfig struct {// PlatformDataSource: The data is from a Google Workspace application.PlatformDataSource *GoogleAppsCardV1PlatformDataSource `json:"platformDataSource,omitempty"`// RemoteDataSource: The data is from a remote data provider.RemoteDataSource *GoogleAppsCardV1Action `json:"remoteDataSource,omitempty"`// ForceSendFields is a list of field names (e.g. "PlatformDataSource") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PlatformDataSource") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1DataSourceConfig: A configuration object that helpsconfigure the data sources for a widget. Available for Google Workspaceadd-ons that extend Google Workspace flows, which is available as part ofthe Gemini Alpha program (https://support.google.com/a/answer/14170809).Unavailable for Google Chat apps.
func (GoogleAppsCardV1DataSourceConfig)MarshalJSON¶added inv0.248.0
func (sGoogleAppsCardV1DataSourceConfig) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1DateTimePicker¶added inv0.49.0
type GoogleAppsCardV1DateTimePicker struct {// HostAppDataSource: A data source that's unique to a Google Workspace host// application, such as Gmail emails, Google Calendar events, or Google Chat// messages. Available for Google Workspace add-ons that extend Google// Workspace flows, which is available as part of the Gemini Alpha program// (https://support.google.com/a/answer/14170809). Unavailable for Google Chat// apps.HostAppDataSource *HostAppDataSourceMarkup `json:"hostAppDataSource,omitempty"`// Label: The text that prompts users to input a date, a time, or a date and// time. For example, if users are scheduling an appointment, use a label such// as `Appointment date` or `Appointment date and time`.Labelstring `json:"label,omitempty"`// Name: The name by which the `DateTimePicker` is identified in a form input// event. For details about working with form inputs, see Receive form data// (https://developers.google.com/workspace/chat/read-form-data).Namestring `json:"name,omitempty"`// OnChangeAction: Triggered when the user clicks **Save** or **Clear** from// the `DateTimePicker` interface.OnChangeAction *GoogleAppsCardV1Action `json:"onChangeAction,omitempty"`// TimezoneOffsetDate: The number representing the time zone offset from UTC,// in minutes. If set, the `value_ms_epoch` is displayed in the specified time// zone. If unset, the value defaults to the user's time zone setting.TimezoneOffsetDateint64 `json:"timezoneOffsetDate,omitempty"`// Type: Whether the widget supports inputting a date, a time, or the date and// time.//// Possible values:// "DATE_AND_TIME" - Users input a date and time.// "DATE_ONLY" - Users input a date.// "TIME_ONLY" - Users input a time.Typestring `json:"type,omitempty"`// ValueMsEpoch: The default value displayed in the widget, in milliseconds// since Unix epoch time (https://en.wikipedia.org/wiki/Unix_time). Specify the// value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`:// a calendar date and time in UTC. For example, to represent January 1, 2023// at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at// 00:00:00 UTC. For example, to represent January 1, 2023, use// `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent// 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).ValueMsEpochint64 `json:"valueMsEpoch,omitempty,string"`// ForceSendFields is a list of field names (e.g. "HostAppDataSource") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "HostAppDataSource") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1DateTimePicker: Lets users input a date, a time, or both adate and a time. Supports form submission validation. When`Action.all_widgets_are_required` is set to `true` or this widget isspecified in `Action.required_widgets`, the submission action is blockedunless a value is selected. For an example in Google Chat apps, see Let auser pick a date and time(https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time).Users can input text or use the picker to select dates and times. If usersinput an invalid date or time, the picker shows an error that prompts usersto input the information correctly. Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1DateTimePicker)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1DateTimePicker) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1DecoratedText¶added inv0.49.0
type GoogleAppsCardV1DecoratedText struct {// BottomLabel: The text that appears below `text`. Always wraps.BottomLabelstring `json:"bottomLabel,omitempty"`// BottomLabelText: `TextParagraph` equivalent of `bottom_label`. Always wraps.// Allows for more complex formatting than `bottom_label`. Google Chat apps// (https://developers.google.com/workspace/chat):BottomLabelText *GoogleAppsCardV1TextParagraph `json:"bottomLabelText,omitempty"`// Button: A button that a user can click to trigger an action.Button *GoogleAppsCardV1Button `json:"button,omitempty"`// ContentText: `TextParagraph` equivalent of `text`. Allows for more complex// formatting than `text`. Google Chat apps// (https://developers.google.com/workspace/chat):ContentText *GoogleAppsCardV1TextParagraph `json:"contentText,omitempty"`// EndIcon: An icon displayed after the text. Supports built-in// (https://developers.google.com/workspace/chat/format-messages#builtinicons)// and custom// (https://developers.google.com/workspace/chat/format-messages#customicons)// icons.EndIcon *GoogleAppsCardV1Icon `json:"endIcon,omitempty"`// Icon: Deprecated in favor of `startIcon`.Icon *GoogleAppsCardV1Icon `json:"icon,omitempty"`// OnClick: This action is triggered when users click `topLabel` or// `bottomLabel`.OnClick *GoogleAppsCardV1OnClick `json:"onClick,omitempty"`// StartIcon: The icon displayed in front of the text.StartIcon *GoogleAppsCardV1Icon `json:"startIcon,omitempty"`// StartIconVerticalAlignment: Optional. Vertical alignment of the start icon.// If not set, the icon will be vertically centered. Google Chat apps// (https://developers.google.com/workspace/chat)://// Possible values:// "VERTICAL_ALIGNMENT_UNSPECIFIED" - Unspecified type. Do not use.// "TOP" - Alignment to the top position.// "MIDDLE" - Alignment to the middle position.// "BOTTOM" - Alignment to the bottom position.StartIconVerticalAlignmentstring `json:"startIconVerticalAlignment,omitempty"`// SwitchControl: A switch widget that a user can click to change its state and// trigger an action.SwitchControl *GoogleAppsCardV1SwitchControl `json:"switchControl,omitempty"`// Text: Required. The primary text. Supports simple formatting. For more// information about formatting text, see Formatting text in Google Chat apps// (https://developers.google.com/workspace/chat/format-messages#card-formatting)// and Formatting text in Google Workspace add-ons// (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).Textstring `json:"text,omitempty"`// TopLabel: The text that appears above `text`. Always truncates.TopLabelstring `json:"topLabel,omitempty"`// TopLabelText: `TextParagraph` equivalent of `top_label`. Always truncates.// Allows for more complex formatting than `top_label`. Google Chat apps// (https://developers.google.com/workspace/chat):TopLabelText *GoogleAppsCardV1TextParagraph `json:"topLabelText,omitempty"`// WrapText: The wrap text setting. If `true`, the text wraps and displays on// multiple lines. Otherwise, the text is truncated. Only applies to `text`,// not `topLabel` and `bottomLabel`.WrapTextbool `json:"wrapText,omitempty"`// ForceSendFields is a list of field names (e.g. "BottomLabel") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BottomLabel") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1DecoratedText: A widget that displays text with optionaldecorations such as a label above or below the text, an icon in front of thetext, a selection widget, or a button after the text. For an example inGoogle Chat apps, see Display text with decorative text(https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements).Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1DecoratedText)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1DecoratedText) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Divider¶added inv0.49.0
type GoogleAppsCardV1Divider struct {}GoogleAppsCardV1Divider: Displays a divider between widgets as a horizontalline. For an example in Google Chat apps, see Add a horizontal dividerbetween widgets(https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets).Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend): For example, the followingJSON creates a divider: ``` "divider": {} ```
typeGoogleAppsCardV1EventAction¶added inv0.248.0
type GoogleAppsCardV1EventAction struct {// ActionRuleId: The unique identifier of the ActionRule.ActionRuleIdstring `json:"actionRuleId,omitempty"`// CommonWidgetAction: Common widget action.CommonWidgetAction *GoogleAppsCardV1CommonWidgetAction `json:"commonWidgetAction,omitempty"`// PostEventTriggers: The list of triggers that will be triggered after the// EventAction is executed.PostEventTriggers []*GoogleAppsCardV1Trigger `json:"postEventTriggers,omitempty"`// ForceSendFields is a list of field names (e.g. "ActionRuleId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ActionRuleId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1EventAction: Represents an actionthat can be performed on anui element. Available for Google Workspace add-ons that extend GoogleWorkspace flows, which is available as part of the Gemini Alpha program(https://support.google.com/a/answer/14170809). Unavailable for Google Chatapps.
func (GoogleAppsCardV1EventAction)MarshalJSON¶added inv0.248.0
func (sGoogleAppsCardV1EventAction) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1ExpressionData¶added inv0.248.0
type GoogleAppsCardV1ExpressionData struct {// Conditions: The list of conditions that are determined by the expression// evaluation result.Conditions []*GoogleAppsCardV1Condition `json:"conditions,omitempty"`// EventActions: The list of actions that the ExpressionData can be used.EventActions []*GoogleAppsCardV1EventAction `json:"eventActions,omitempty"`// Expression: The uncompiled expression.Expressionstring `json:"expression,omitempty"`// Id: The unique identifier of the ExpressionData.Idstring `json:"id,omitempty"`// ForceSendFields is a list of field names (e.g. "Conditions") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Conditions") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1ExpressionData: Represents the data that is used to evaluatean expression. Available for Google Workspace add-ons that extend GoogleWorkspace flows, which is available as part of the Gemini Alpha program(https://support.google.com/a/answer/14170809). Unavailable for Google Chatapps.
func (GoogleAppsCardV1ExpressionData)MarshalJSON¶added inv0.248.0
func (sGoogleAppsCardV1ExpressionData) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1ExpressionDataCondition¶added inv0.248.0
type GoogleAppsCardV1ExpressionDataCondition struct {// ConditionType: The type of the condition.//// Possible values:// "CONDITION_TYPE_UNSPECIFIED" - Unspecified condition type.// "EXPRESSION_EVALUATION_SUCCESS" - The expression evaluation was// successful.// "EXPRESSION_EVALUATION_FAILURE" - The expression evaluation was// unsuccessful.ConditionTypestring `json:"conditionType,omitempty"`// ForceSendFields is a list of field names (e.g. "ConditionType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ConditionType") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1ExpressionDataCondition: Represents a condition that isevaluated using CEL. Available for Google Workspace add-ons that extendGoogle Workspace flows, which is available as part of the Gemini Alphaprogram (https://support.google.com/a/answer/14170809). Unavailable forGoogle Chat apps.
func (GoogleAppsCardV1ExpressionDataCondition)MarshalJSON¶added inv0.248.0
func (sGoogleAppsCardV1ExpressionDataCondition) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Grid¶added inv0.49.0
type GoogleAppsCardV1Grid struct {// BorderStyle: The border style to apply to each grid item.BorderStyle *GoogleAppsCardV1BorderStyle `json:"borderStyle,omitempty"`// ColumnCount: The number of columns to display in the grid. A default value// is used if this field isn't specified, and that default value is different// depending on where the grid is shown (dialog versus companion).ColumnCountint64 `json:"columnCount,omitempty"`// Items: The items to display in the grid.Items []*GoogleAppsCardV1GridItem `json:"items,omitempty"`// OnClick: This callback is reused by each individual grid item, but with the// item's identifier and index in the items list added to the callback's// parameters.OnClick *GoogleAppsCardV1OnClick `json:"onClick,omitempty"`// Title: The text that displays in the grid header.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "BorderStyle") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BorderStyle") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Grid: Displays a grid with a collection of items. Items canonly include text or images. For responsive columns, or to include more thantext or images, use `Columns`. For an example in Google Chat apps, seeDisplay a Grid with a collection of items(https://developers.google.com/workspace/chat/format-structure-card-dialog#display_a_grid_with_a_collection_of_items).A grid supports any number of columns and items. The number of rows isdetermined by items divided by columns. A grid with 10 items and 2 columnshas 5 rows. A grid with 11 items and 2 columns has 6 rows. Google Workspaceadd-ons and Chat apps (https://developers.google.com/workspace/extend): Forexample, the following JSON creates a 2 column grid with a single item: ```"grid": { "title": "A fine collection of items", "columnCount": 2,"borderStyle": { "type": "STROKE", "cornerRadius": 4 }, "items": [ {"image": { "imageUri": "https://www.example.com/image.png", "cropStyle": {"type": "SQUARE" }, "borderStyle": { "type": "STROKE" } }, "title": "Anitem", "textAlignment": "CENTER" } ], "onClick": { "openLink": { "url":"https://www.example.com" } } } ```
func (GoogleAppsCardV1Grid)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1Grid) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1GridItem¶added inv0.49.0
type GoogleAppsCardV1GridItem struct {// Id: A user-specified identifier for this grid item. This identifier is// returned in the parent grid's `onClick` callback parameters.Idstring `json:"id,omitempty"`// Image: The image that displays in the grid item.Image *GoogleAppsCardV1ImageComponent `json:"image,omitempty"`// Layout: The layout to use for the grid item.//// Possible values:// "GRID_ITEM_LAYOUT_UNSPECIFIED" - Don't use. Unspecified.// "TEXT_BELOW" - The title and subtitle are shown below the grid item's// image.// "TEXT_ABOVE" - The title and subtitle are shown above the grid item's// image.Layoutstring `json:"layout,omitempty"`// Subtitle: The grid item's subtitle.Subtitlestring `json:"subtitle,omitempty"`// Title: The grid item's title.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "Id") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Id") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1GridItem: Represents an item in a grid layout. Items cancontain text, an image, or both text and an image. Google Workspace add-onsand Chat apps (https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1GridItem)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1GridItem) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Icon¶added inv0.49.0
type GoogleAppsCardV1Icon struct {// AltText: Optional. A description of the icon used for accessibility. If// unspecified, the default value `Button` is provided. As a best practice, you// should set a helpful description for what the icon displays, and if// applicable, what it does. For example, `A user's account portrait`, or// `Opens a new browser tab and navigates to the Google Chat developer// documentation athttps://developers.google.com/workspace/chat`. If the icon// is set in a `Button`, the `altText` appears as helper text when the user// hovers over the button. However, if the button also sets `text`, the icon's// `altText` is ignored.AltTextstring `json:"altText,omitempty"`// IconUrl: Display a custom icon hosted at an HTTPS URL. For example: “`// "iconUrl":// "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.pn// g" “` Supported file types include `.png` and `.jpg`.IconUrlstring `json:"iconUrl,omitempty"`// ImageType: The crop style applied to the image. In some cases, applying a// `CIRCLE` crop causes the image to be drawn larger than a built-in icon.//// Possible values:// "SQUARE" - Default value. Applies a square mask to the image. For example,// a 4x3 image becomes 3x3.// "CIRCLE" - Applies a circular mask to the image. For example, a 4x3 image// becomes a circle with a diameter of 3.ImageTypestring `json:"imageType,omitempty"`// KnownIcon: Display one of the built-in icons provided by Google Workspace.// For example, to display an airplane icon, specify `AIRPLANE`. For a bus,// specify `BUS`. For a full list of supported icons, see built-in icons// (https://developers.google.com/workspace/chat/format-messages#builtinicons).KnownIconstring `json:"knownIcon,omitempty"`// MaterialIcon: Display one of the Google Material Icons// (https://fonts.google.com/icons). For example, to display a checkbox icon// (https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048),// use “` "material_icon": { "name": "check_box" } “` Google Chat apps// (https://developers.google.com/workspace/chat):MaterialIcon *GoogleAppsCardV1MaterialIcon `json:"materialIcon,omitempty"`// ForceSendFields is a list of field names (e.g. "AltText") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AltText") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Icon: An icon displayed in a widget on a card. For anexample in Google Chat apps, see Add an icon(https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon).Supports built-in(https://developers.google.com/workspace/chat/format-messages#builtinicons)and custom(https://developers.google.com/workspace/chat/format-messages#customicons)icons. Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1Icon)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1Icon) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Image¶added inv0.49.0
type GoogleAppsCardV1Image struct {// AltText: The alternative text of this image that's used for accessibility.AltTextstring `json:"altText,omitempty"`// ImageUrl: The HTTPS URL that hosts the image. For example: “`//https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png// “`ImageUrlstring `json:"imageUrl,omitempty"`// OnClick: When a user clicks the image, the click triggers this action.OnClick *GoogleAppsCardV1OnClick `json:"onClick,omitempty"`// ForceSendFields is a list of field names (e.g. "AltText") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AltText") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Image: An image that is specified by a URL and can have an`onClick` action. For an example, see Add an image(https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image).Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1Image)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1Image) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1ImageComponent¶added inv0.49.0
type GoogleAppsCardV1ImageComponent struct {// AltText: The accessibility label for the image.AltTextstring `json:"altText,omitempty"`// BorderStyle: The border style to apply to the image.BorderStyle *GoogleAppsCardV1BorderStyle `json:"borderStyle,omitempty"`// CropStyle: The crop style to apply to the image.CropStyle *GoogleAppsCardV1ImageCropStyle `json:"cropStyle,omitempty"`// ImageUri: The image URL.ImageUristring `json:"imageUri,omitempty"`// ForceSendFields is a list of field names (e.g. "AltText") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AltText") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1ImageComponent: Represents an image. Google Workspaceadd-ons and Chat apps (https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1ImageComponent)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1ImageComponent) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1ImageCropStyle¶added inv0.49.0
type GoogleAppsCardV1ImageCropStyle struct {// AspectRatio: The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`.// For example, here's how to apply a 16:9 aspect ratio: “` cropStyle {// "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9 } “`AspectRatiofloat64 `json:"aspectRatio,omitempty"`// Type: The crop type.//// Possible values:// "IMAGE_CROP_TYPE_UNSPECIFIED" - Don't use. Unspecified.// "SQUARE" - Default value. Applies a square crop.// "CIRCLE" - Applies a circular crop.// "RECTANGLE_CUSTOM" - Applies a rectangular crop with a custom aspect// ratio. Set the custom aspect ratio with `aspectRatio`.// "RECTANGLE_4_3" - Applies a rectangular crop with a 4:3 aspect ratio.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "AspectRatio") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AspectRatio") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1ImageCropStyle: Represents the crop style applied to animage. Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend): For example, here's how toapply a 16:9 aspect ratio: ``` cropStyle { "type": "RECTANGLE_CUSTOM","aspectRatio": 16/9 } ```
func (GoogleAppsCardV1ImageCropStyle)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1ImageCropStyle) MarshalJSON() ([]byte,error)
func (*GoogleAppsCardV1ImageCropStyle)UnmarshalJSON¶added inv0.49.0
func (s *GoogleAppsCardV1ImageCropStyle) UnmarshalJSON(data []byte)error
typeGoogleAppsCardV1MaterialIcon¶added inv0.171.0
type GoogleAppsCardV1MaterialIcon struct {// Fill: Whether the icon renders as filled. Default value is false. To preview// different icon settings, go to Google Font Icons// (https://fonts.google.com/icons) and adjust the settings under// **Customize**.Fillbool `json:"fill,omitempty"`// Grade: Weight and grade affect a symbol’s thickness. Adjustments to grade// are more granular than adjustments to weight and have a small impact on the// size of the symbol. Choose from {-25, 0, 200}. If absent, default value is// 0. If any other value is specified, the default value is used. To preview// different icon settings, go to Google Font Icons// (https://fonts.google.com/icons) and adjust the settings under// **Customize**.Gradeint64 `json:"grade,omitempty"`// Name: The icon name defined in the Google Material Icon// (https://fonts.google.com/icons), for example, `check_box`. Any invalid// names are abandoned and replaced with empty string and results in the icon// failing to render.Namestring `json:"name,omitempty"`// Weight: The stroke weight of the icon. Choose from {100, 200, 300, 400, 500,// 600, 700}. If absent, default value is 400. If any other value is specified,// the default value is used. To preview different icon settings, go to Google// Font Icons (https://fonts.google.com/icons) and adjust the settings under// **Customize**.Weightint64 `json:"weight,omitempty"`// ForceSendFields is a list of field names (e.g. "Fill") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Fill") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1MaterialIcon: A Google Material Icon(https://fonts.google.com/icons), which includes over 2500+ options. Forexample, to display a checkbox icon(https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048)with customized weight and grade, write the following: ``` { "name":"check_box", "fill": true, "weight": 300, "grade": -25 } ``` Google Chatapps (https://developers.google.com/workspace/chat):
func (GoogleAppsCardV1MaterialIcon)MarshalJSON¶added inv0.171.0
func (sGoogleAppsCardV1MaterialIcon) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1NestedWidget¶added inv0.212.0
type GoogleAppsCardV1NestedWidget struct {// ButtonList: A button list widget.ButtonList *GoogleAppsCardV1ButtonList `json:"buttonList,omitempty"`// Image: An image widget.Image *GoogleAppsCardV1Image `json:"image,omitempty"`// TextParagraph: A text paragraph widget.TextParagraph *GoogleAppsCardV1TextParagraph `json:"textParagraph,omitempty"`// ForceSendFields is a list of field names (e.g. "ButtonList") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ButtonList") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1NestedWidget: A list of widgets that can be displayed in acontaining layout, such as a `CarouselCard`. Google Chat apps(https://developers.google.com/workspace/chat):
func (GoogleAppsCardV1NestedWidget)MarshalJSON¶added inv0.212.0
func (sGoogleAppsCardV1NestedWidget) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1OnClick¶added inv0.49.0
type GoogleAppsCardV1OnClick struct {// Action: If specified, an action is triggered by this `onClick`.Action *GoogleAppsCardV1Action `json:"action,omitempty"`// Card: A new card is pushed to the card stack after clicking if specified.// Google Workspace add-ons (https://developers.google.com/workspace/add-ons):Card *GoogleAppsCardV1Card `json:"card,omitempty"`// OpenDynamicLinkAction: An add-on triggers this action when the action needs// to open a link. This differs from the `open_link` above in that this needs// to talk to server to get the link. Thus some preparation work is required// for web client to do before the open link action response comes back. Google// Workspace add-ons (https://developers.google.com/workspace/add-ons):OpenDynamicLinkAction *GoogleAppsCardV1Action `json:"openDynamicLinkAction,omitempty"`// OpenLink: If specified, this `onClick` triggers an open link action.OpenLink *GoogleAppsCardV1OpenLink `json:"openLink,omitempty"`// OverflowMenu: If specified, this `onClick` opens an overflow menu.OverflowMenu *GoogleAppsCardV1OverflowMenu `json:"overflowMenu,omitempty"`// ForceSendFields is a list of field names (e.g. "Action") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Action") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1OnClick: Represents how to respond when users click aninteractive element on a card, such as a button. Google Workspace add-onsand Chat apps (https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1OnClick)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1OnClick) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1OpenLink¶added inv0.49.0
type GoogleAppsCardV1OpenLink struct {// OnClose: Whether the client forgets about a link after opening it, or// observes it until the window closes. Google Workspace add-ons// (https://developers.google.com/workspace/add-ons)://// Possible values:// "NOTHING" - Default value. The card doesn't reload; nothing happens.// "RELOAD" - Reloads the card after the child window closes. If used in// conjunction with// [`OpenAs.OVERLAY`](https://developers.google.com/workspace/add-ons/reference/// rpc/google.apps.card.v1#openas), the child window acts as a modal dialog and// the parent card is blocked until the child window closes.OnClosestring `json:"onClose,omitempty"`// OpenAs: How to open a link. Google Workspace add-ons// (https://developers.google.com/workspace/add-ons)://// Possible values:// "FULL_SIZE" - The link opens as a full-size window (if that's the frame// used by the client).// "OVERLAY" - The link opens as an overlay, such as a pop-up.OpenAsstring `json:"openAs,omitempty"`// Url: The URL to open.Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "OnClose") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "OnClose") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1OpenLink: Represents an `onClick` event that opens ahyperlink. Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1OpenLink)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1OpenLink) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1OverflowMenu¶added inv0.204.0
type GoogleAppsCardV1OverflowMenu struct {// Items: Required. The list of menu options.Items []*GoogleAppsCardV1OverflowMenuItem `json:"items,omitempty"`// ForceSendFields is a list of field names (e.g. "Items") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Items") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1OverflowMenu: A widget that presents a pop-up menu with oneor more actions that users can invoke. For example, showing non-primaryactions in a card. You can use this widget when actions don't fit in theavailable space. To use, specify this widget in the `OnClick` action ofwidgets that support it. For example, in a `Button`. Google Workspaceadd-ons and Chat apps (https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1OverflowMenu)MarshalJSON¶added inv0.204.0
func (sGoogleAppsCardV1OverflowMenu) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1OverflowMenuItem¶added inv0.204.0
type GoogleAppsCardV1OverflowMenuItem struct {// Disabled: Whether the menu option is disabled. Defaults to false.Disabledbool `json:"disabled,omitempty"`// OnClick: Required. The action invoked when a menu option is selected. This// `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is// dropped and the menu item disabled.OnClick *GoogleAppsCardV1OnClick `json:"onClick,omitempty"`// StartIcon: The icon displayed in front of the text.StartIcon *GoogleAppsCardV1Icon `json:"startIcon,omitempty"`// Text: Required. The text that identifies or describes the item to users.Textstring `json:"text,omitempty"`// ForceSendFields is a list of field names (e.g. "Disabled") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Disabled") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1OverflowMenuItem: An option that users can invoke in anoverflow menu. Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1OverflowMenuItem)MarshalJSON¶added inv0.204.0
func (sGoogleAppsCardV1OverflowMenuItem) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1PlatformDataSource¶added inv0.132.0
type GoogleAppsCardV1PlatformDataSource struct {// CommonDataSource: A data source shared by all Google Workspace applications,// such as users in a Google Workspace organization.//// Possible values:// "UNKNOWN" - Default value. Don't use.// "USER" - Google Workspace users. The user can only view and select users// from their Google Workspace organization.CommonDataSourcestring `json:"commonDataSource,omitempty"`// HostAppDataSource: A data source that's unique to a Google Workspace host// application, such spaces in Google Chat. This field supports the Google API// Client Libraries but isn't available in the Cloud Client Libraries. To learn// more, see Install the client libraries// (https://developers.google.com/workspace/chat/libraries).HostAppDataSource *HostAppDataSourceMarkup `json:"hostAppDataSource,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonDataSource") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonDataSource") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1PlatformDataSource: For a `SelectionInput` widget that usesa multiselect menu, a data source from Google Workspace. Used to populateitems in a multiselect menu. Google Chat apps(https://developers.google.com/workspace/chat):
func (GoogleAppsCardV1PlatformDataSource)MarshalJSON¶added inv0.132.0
func (sGoogleAppsCardV1PlatformDataSource) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Section¶added inv0.49.0
type GoogleAppsCardV1Section struct {// CollapseControl: Optional. Define the expand and collapse button of the// section. This button will be shown only if the section is collapsible. If// this field isn't set, the default button is used.CollapseControl *GoogleAppsCardV1CollapseControl `json:"collapseControl,omitempty"`// Collapsible: Indicates whether this section is collapsible. Collapsible// sections hide some or all widgets, but users can expand the section to// reveal the hidden widgets by clicking **Show more**. Users can hide the// widgets again by clicking **Show less**. To determine which widgets are// hidden, specify `uncollapsibleWidgetsCount`.Collapsiblebool `json:"collapsible,omitempty"`// Header: Text that appears at the top of a section. Supports simple HTML// formatted text. For more information about formatting text, see Formatting// text in Google Chat apps// (https://developers.google.com/workspace/chat/format-messages#card-formatting)// and Formatting text in Google Workspace add-ons// (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).Headerstring `json:"header,omitempty"`// Id: A unique ID assigned to the section that's used to identify the section// to be mutated. The ID has a character limit of 64 characters and should be// in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons// that extend Google Workspace flows, which is available as part of the Gemini// Alpha program (https://support.google.com/a/answer/14170809). Unavailable// for Google Chat apps.Idstring `json:"id,omitempty"`// UncollapsibleWidgetsCount: The number of uncollapsible widgets which remain// visible even when a section is collapsed. For example, when a section// contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the// first two widgets are always shown and the last three are collapsed by// default. The `uncollapsibleWidgetsCount` is taken into account only when// `collapsible` is `true`.UncollapsibleWidgetsCountint64 `json:"uncollapsibleWidgetsCount,omitempty"`// Widgets: All the widgets in the section. Must contain at least one widget.Widgets []*GoogleAppsCardV1Widget `json:"widgets,omitempty"`// ForceSendFields is a list of field names (e.g. "CollapseControl") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CollapseControl") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Section: A section contains a collection of widgets that arerendered vertically in the order that they're specified. Google Workspaceadd-ons and Chat apps (https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1Section)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1Section) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1SelectionInput¶added inv0.49.0
type GoogleAppsCardV1SelectionInput struct {// DataSourceConfigs: Optional. The data source configs for the selection// control. This field provides more fine-grained control over the data source.// If specified, the `multi_select_max_selected_items` field,// `multi_select_min_query_length` field, `external_data_source` field and// `platform_data_source` field are ignored. Available for Google Workspace// add-ons that extend Google Workspace flows, which is available as part of// the Gemini Alpha program (https://support.google.com/a/answer/14170809).// Unavailable for Google Chat apps.DataSourceConfigs []*GoogleAppsCardV1DataSourceConfig `json:"dataSourceConfigs,omitempty"`// ExternalDataSource: An external data source, such as a relational database.ExternalDataSource *GoogleAppsCardV1Action `json:"externalDataSource,omitempty"`// HintText: Optional. Text that appears below the selection input field meant// to assist users by prompting them to enter a certain value. This text is// always visible. Available for Google Workspace add-ons that extend Google// Workspace flows, which is available as part of the Gemini Alpha program// (https://support.google.com/a/answer/14170809). Unavailable for Google Chat// apps.HintTextstring `json:"hintText,omitempty"`// Items: An array of selectable items. For example, an array of radio buttons// or checkboxes. Supports up to 100 items.Items []*GoogleAppsCardV1SelectionItem `json:"items,omitempty"`// Label: The text that appears above the selection input field in the user// interface. Specify text that helps the user enter the information your app// needs. For example, if users are selecting the urgency of a work ticket from// a drop-down menu, the label might be "Urgency" or "Select urgency".Labelstring `json:"label,omitempty"`// MultiSelectMaxSelectedItems: For multiselect menus, the maximum number of// items that a user can select. Minimum value is 1 item. If unspecified,// defaults to 3 items.MultiSelectMaxSelectedItemsint64 `json:"multiSelectMaxSelectedItems,omitempty"`// MultiSelectMinQueryLength: For multiselect menus, the number of text// characters that a user inputs before the menu returns suggested selection// items. If unset, the multiselect menu uses the following default values: *// If the menu uses a static array of `SelectionInput` items, defaults to 0// characters and immediately populates items from the array. * If the menu// uses a dynamic data source (`multi_select_data_source`), defaults to 3// characters before querying the data source to return suggested items.MultiSelectMinQueryLengthint64 `json:"multiSelectMinQueryLength,omitempty"`// Name: Required. The name that identifies the selection input in a form input// event. For details about working with form inputs, see Receive form data// (https://developers.google.com/workspace/chat/read-form-data).Namestring `json:"name,omitempty"`// OnChangeAction: If specified, the form is submitted when the selection// changes. If not specified, you must specify a separate button that submits// the form. For details about working with form inputs, see Receive form data// (https://developers.google.com/workspace/chat/read-form-data).OnChangeAction *GoogleAppsCardV1Action `json:"onChangeAction,omitempty"`// PlatformDataSource: A data source from Google Workspace.PlatformDataSource *GoogleAppsCardV1PlatformDataSource `json:"platformDataSource,omitempty"`// Type: The type of items that are displayed to users in a `SelectionInput`// widget. Selection types support different types of interactions. For// example, users can select one or more checkboxes, but they can only select// one value from a dropdown menu.//// Possible values:// "CHECK_BOX" - A set of checkboxes. Users can select one or more// checkboxes.// "RADIO_BUTTON" - A set of radio buttons. Users can select one radio// button.// "SWITCH" - A set of switches. Users can turn on one or more switches.// "DROPDOWN" - A dropdown menu. Users can select one item from the menu.// "MULTI_SELECT" - A menu with a text box. Users can type and select one or// more items. For Google Workspace add-ons, you must populate items using a// static array of `SelectionItem` objects. For Google Chat apps, you can also// populate items using a dynamic data source and autosuggest items as users// type in the menu. For example, users can start typing the name of a Google// Chat space and the widget autosuggests the space. To dynamically populate// items for a multiselect menu, use one of the following types of data// sources: * Google Workspace data: Items are populated using data from Google// Workspace, such as Google Workspace users or Google Chat spaces. * External// data: Items are populated from an external data source outside of Google// Workspace. For examples of how to implement multiselect menus for Chat apps,// see [Add a multiselect// menu](https://developers.google.com/workspace/chat/design-interactive-card-di// alog#multiselect-menu). [Google Workspace add-ons and Chat// apps](https://developers.google.com/workspace/extend):Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "DataSourceConfigs") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DataSourceConfigs") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1SelectionInput: A widget that creates one or more UI itemsthat users can select. Supports form submission validation for `dropdown`and `multiselect` menus only. When `Action.all_widgets_are_required` is setto `true` or this widget is specified in `Action.required_widgets`, thesubmission action is blocked unless a value is selected. For example, adropdown menu or checkboxes. You can use this widget to collect data thatcan be predicted or enumerated. For an example in Google Chat apps, see Addselectable UI elements(/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements).Chat apps can process the value of items that users select or input. Fordetails about working with form inputs, see Receive form data(https://developers.google.com/workspace/chat/read-form-data). To collectundefined or abstract data from users, use the TextInput widget. GoogleWorkspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1SelectionInput)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1SelectionInput) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1SelectionItem¶added inv0.49.0
type GoogleAppsCardV1SelectionItem struct {// BottomText: For multiselect menus, a text description or label that's// displayed below the item's `text` field.BottomTextstring `json:"bottomText,omitempty"`// Selected: Whether the item is selected by default. If the selection input// only accepts one value (such as for radio buttons or a dropdown menu), only// set this field for one item.Selectedbool `json:"selected,omitempty"`StartIconUristring `json:"startIconUri,omitempty"`// Text: The text that identifies or describes the item to users.Textstring `json:"text,omitempty"`// Value: The value associated with this item. The client should use this as a// form input value. For details about working with form inputs, see Receive// form data (https://developers.google.com/workspace/chat/read-form-data).Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "BottomText") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BottomText") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1SelectionItem: An item that users can select in a selectioninput, such as a checkbox or switch. Supports up to 100 items. GoogleWorkspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1SelectionItem)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1SelectionItem) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1SuggestionItem¶added inv0.49.0
type GoogleAppsCardV1SuggestionItem struct {// Text: The value of a suggested input to a text input field. This is// equivalent to what users enter themselves.Textstring `json:"text,omitempty"`// ForceSendFields is a list of field names (e.g. "Text") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Text") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1SuggestionItem: One suggested value that users can enter ina text input field. Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1SuggestionItem)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1SuggestionItem) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Suggestions¶added inv0.49.0
type GoogleAppsCardV1Suggestions struct {// Items: A list of suggestions used for autocomplete recommendations in text// input fields.Items []*GoogleAppsCardV1SuggestionItem `json:"items,omitempty"`// ForceSendFields is a list of field names (e.g. "Items") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Items") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Suggestions: Suggested values that users can enter. Thesevalues appear when users click inside the text input field. As users type,the suggested values dynamically filter to match what the users have typed.For example, a text input field for programming language might suggest Java,JavaScript, Python, and C++. When users start typing `Jav`, the list ofsuggestions filters to show `Java` and `JavaScript`. Suggested values helpguide users to enter values that your app can make sense of. When referringto JavaScript, some users might enter `javascript` and others `java script`.Suggesting `JavaScript` can standardize how users interact with your app.When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's setto `MULTIPLE_LINE`. Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1Suggestions)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1Suggestions) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1SwitchControl¶added inv0.49.0
type GoogleAppsCardV1SwitchControl struct {// ControlType: How the switch appears in the user interface. Google Workspace// add-ons and Chat apps (https://developers.google.com/workspace/extend)://// Possible values:// "SWITCH" - A toggle-style switch.// "CHECKBOX" - Deprecated in favor of `CHECK_BOX`.// "CHECK_BOX" - A checkbox.ControlTypestring `json:"controlType,omitempty"`// Name: The name by which the switch widget is identified in a form input// event. For details about working with form inputs, see Receive form data// (https://developers.google.com/workspace/chat/read-form-data).Namestring `json:"name,omitempty"`// OnChangeAction: The action to perform when the switch state is changed, such// as what function to run.OnChangeAction *GoogleAppsCardV1Action `json:"onChangeAction,omitempty"`// Selected: When `true`, the switch is selected.Selectedbool `json:"selected,omitempty"`// Value: The value entered by a user, returned as part of a form input event.// For details about working with form inputs, see Receive form data// (https://developers.google.com/workspace/chat/read-form-data).Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "ControlType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ControlType") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1SwitchControl: Either a toggle-style switch or a checkboxinside a `decoratedText` widget. Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend): Only supported in the`decoratedText` widget.
func (GoogleAppsCardV1SwitchControl)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1SwitchControl) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1TextInput¶added inv0.49.0
type GoogleAppsCardV1TextInput struct {// AutoCompleteAction: Optional. Specify what action to take when the text// input field provides suggestions to users who interact with it. If// unspecified, the suggestions are set by `initialSuggestions` and are// processed by the client. If specified, the app takes the action specified// here, such as running a custom function. Google Workspace add-ons// (https://developers.google.com/workspace/add-ons):AutoCompleteAction *GoogleAppsCardV1Action `json:"autoCompleteAction,omitempty"`// HintText: Text that appears below the text input field meant to assist users// by prompting them to enter a certain value. This text is always visible.// Required if `label` is unspecified. Otherwise, optional.HintTextstring `json:"hintText,omitempty"`// HostAppDataSource: A data source that's unique to a Google Workspace host// application, such as Gmail emails, Google Calendar events, or Google Chat// messages. Available for Google Workspace add-ons that extend Google// Workspace flows, which is available as part of the Gemini Alpha program// (https://support.google.com/a/answer/14170809). Unavailable for Google Chat// apps.HostAppDataSource *HostAppDataSourceMarkup `json:"hostAppDataSource,omitempty"`// InitialSuggestions: Suggested values that users can enter. These values// appear when users click inside the text input field. As users type, the// suggested values dynamically filter to match what the users have typed. For// example, a text input field for programming language might suggest Java,// JavaScript, Python, and C++. When users start typing `Jav`, the list of// suggestions filters to show just `Java` and `JavaScript`. Suggested values// help guide users to enter values that your app can make sense of. When// referring to JavaScript, some users might enter `javascript` and others// `java script`. Suggesting `JavaScript` can standardize how users interact// with your app. When specified, `TextInput.type` is always `SINGLE_LINE`,// even if it's set to `MULTIPLE_LINE`. Google Workspace add-ons and Chat apps// (https://developers.google.com/workspace/extend):InitialSuggestions *GoogleAppsCardV1Suggestions `json:"initialSuggestions,omitempty"`// Label: The text that appears above the text input field in the user// interface. Specify text that helps the user enter the information your app// needs. For example, if you are asking someone's name, but specifically need// their surname, write `surname` instead of `name`. Required if `hintText` is// unspecified. Otherwise, optional.Labelstring `json:"label,omitempty"`// Name: The name by which the text input is identified in a form input event.// For details about working with form inputs, see Receive form data// (https://developers.google.com/workspace/chat/read-form-data).Namestring `json:"name,omitempty"`// OnChangeAction: What to do when a change occurs in the text input field. For// example, a user adding to the field or deleting text. Examples of actions to// take include running a custom function or opening a dialog// (https://developers.google.com/workspace/chat/dialogs) in Google Chat.OnChangeAction *GoogleAppsCardV1Action `json:"onChangeAction,omitempty"`// PlaceholderText: Text that appears in the text input field when the field is// empty. Use this text to prompt users to enter a value. For example, `Enter a// number from 0 to 100`. Google Chat apps// (https://developers.google.com/workspace/chat):PlaceholderTextstring `json:"placeholderText,omitempty"`// Type: How a text input field appears in the user interface. For example,// whether the field is single or multi-line.//// Possible values:// "SINGLE_LINE" - The text input field has a fixed height of one line.// "MULTIPLE_LINE" - The text input field has a fixed height of multiple// lines.Typestring `json:"type,omitempty"`// Validation: Specify the input format validation necessary for this text// field. Google Workspace add-ons and Chat apps// (https://developers.google.com/workspace/extend):Validation *GoogleAppsCardV1Validation `json:"validation,omitempty"`// Value: The value entered by a user, returned as part of a form input event.// For details about working with form inputs, see Receive form data// (https://developers.google.com/workspace/chat/read-form-data).Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "AutoCompleteAction") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AutoCompleteAction") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1TextInput: A field in which users can enter text. Supportssuggestions and on-change actions. Supports form submission validation. When`Action.all_widgets_are_required` is set to `true` or this widget isspecified in `Action.required_widgets`, the submission action is blockedunless a value is entered. For an example in Google Chat apps, see Add afield in which a user can enter text(https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text).Chat apps receive and can process the value of entered text during forminput events. For details about working with form inputs, see Receive formdata (https://developers.google.com/workspace/chat/read-form-data). When youneed to collect undefined or abstract data from users, use a text input. Tocollect defined or enumerated data from users, use the SelectionInputwidget. Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1TextInput)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1TextInput) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1TextParagraph¶added inv0.49.0
type GoogleAppsCardV1TextParagraph struct {// MaxLines: The maximum number of lines of text that are displayed in the// widget. If the text exceeds the specified maximum number of lines, the// excess content is concealed behind a **show more** button. If the text is// equal or shorter than the specified maximum number of lines, a **show more**// button isn't displayed. The default value is 0, in which case all context is// displayed. Negative values are ignored.MaxLinesint64 `json:"maxLines,omitempty"`// Text: The text that's shown in the widget.Textstring `json:"text,omitempty"`// TextSyntax: The syntax of the text. If not set, the text is rendered as// HTML. Google Chat apps (https://developers.google.com/workspace/chat)://// Possible values:// "TEXT_SYNTAX_UNSPECIFIED" - The text is rendered as HTML if unspecified.// "HTML" - The text is rendered as HTML. This is the default value.// "MARKDOWN" - The text is rendered as Markdown.TextSyntaxstring `json:"textSyntax,omitempty"`// ForceSendFields is a list of field names (e.g. "MaxLines") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MaxLines") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1TextParagraph: A paragraph of text that supports formatting.For an example in Google Chat apps, see Add a paragraph of formatted text(https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text).For more information about formatting text, see Formatting text in GoogleChat apps(https://developers.google.com/workspace/chat/format-messages#card-formatting)and Formatting text in Google Workspace add-ons(https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1TextParagraph)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1TextParagraph) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Trigger¶added inv0.248.0
type GoogleAppsCardV1Trigger struct {// ActionRuleId: The unique identifier of the ActionRule.ActionRuleIdstring `json:"actionRuleId,omitempty"`// ForceSendFields is a list of field names (e.g. "ActionRuleId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ActionRuleId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Trigger: Represents a trigger. Available for GoogleWorkspace add-ons that extend Google Workspace flows, which is available aspart of the Gemini Alpha program(https://support.google.com/a/answer/14170809). Unavailable for Google Chatapps.
func (GoogleAppsCardV1Trigger)MarshalJSON¶added inv0.248.0
func (sGoogleAppsCardV1Trigger) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1UpdateVisibilityAction¶added inv0.248.0
type GoogleAppsCardV1UpdateVisibilityAction struct {// Visibility: The new visibility.//// Possible values:// "VISIBILITY_UNSPECIFIED" - Unspecified visibility. Do not use.// "VISIBLE" - The UI element is visible.// "HIDDEN" - The UI element is hidden.Visibilitystring `json:"visibility,omitempty"`// ForceSendFields is a list of field names (e.g. "Visibility") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Visibility") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1UpdateVisibilityAction: Represents an action that updatesthe visibility of a widget. Available for Google Workspace add-ons thatextend Google Workspace flows, which is available as part of the GeminiAlpha program (https://support.google.com/a/answer/14170809). Unavailablefor Google Chat apps.
func (GoogleAppsCardV1UpdateVisibilityAction)MarshalJSON¶added inv0.248.0
func (sGoogleAppsCardV1UpdateVisibilityAction) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Validation¶added inv0.216.0
type GoogleAppsCardV1Validation struct {// CharacterLimit: Specify the character limit for text input widgets. Note// that this is only used for text input and is ignored for other widgets.// Google Workspace add-ons and Chat apps// (https://developers.google.com/workspace/extend):CharacterLimitint64 `json:"characterLimit,omitempty"`// InputType: Specify the type of the input widgets. Google Workspace add-ons// and Chat apps (https://developers.google.com/workspace/extend)://// Possible values:// "INPUT_TYPE_UNSPECIFIED" - Unspecified type. Do not use.// "TEXT" - Regular text that accepts all characters.// "INTEGER" - An integer value.// "FLOAT" - A float value.// "EMAIL" - An email address.// "EMOJI_PICKER" - A emoji selected from system-provided emoji picker.InputTypestring `json:"inputType,omitempty"`// ForceSendFields is a list of field names (e.g. "CharacterLimit") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CharacterLimit") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Validation: Represents the necessary data for validating thewidget it's attached to. Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend):
func (GoogleAppsCardV1Validation)MarshalJSON¶added inv0.216.0
func (sGoogleAppsCardV1Validation) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Widget¶added inv0.49.0
type GoogleAppsCardV1Widget struct {// ButtonList: A list of buttons. For example, the following JSON creates two// buttons. The first is a blue text button and the second is an image button// that opens a link: “` "buttonList": { "buttons": [ { "text": "Edit",// "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, {// "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": {// "openLink": { "url": "https://example.com/calendar" } } } ] } “`ButtonList *GoogleAppsCardV1ButtonList `json:"buttonList,omitempty"`// Carousel: A carousel contains a collection of nested widgets. For example,// this is a JSON representation of a carousel that contains two text// paragraphs. “` { "widgets": [ { "textParagraph": { "text": "First text// paragraph in the carousel." } }, { "textParagraph": { "text": "Second text// paragraph in the carousel." } } ] } “`Carousel *GoogleAppsCardV1Carousel `json:"carousel,omitempty"`// ChipList: A list of chips. For example, the following JSON creates two// chips. The first is a text chip and the second is an icon chip that opens a// link: “` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, {// "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": {// "openLink": { "url": "https://example.com/calendar" } } } ] } “`ChipList *GoogleAppsCardV1ChipList `json:"chipList,omitempty"`// Columns: Displays up to 2 columns. To include more than 2 columns, or to use// rows, use the `Grid` widget. For example, the following JSON creates 2// columns that each contain text paragraphs: “` "columns": { "columnItems": [// { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment":// "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": {// "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle":// "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER",// "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text":// "Second column text paragraph" } } ] } ] } “`Columns *GoogleAppsCardV1Columns `json:"columns,omitempty"`// DateTimePicker: Displays a widget that lets users input a date, time, or// date and time. For example, the following JSON creates a date time picker to// schedule an appointment: “` "dateTimePicker": { "name": "appointment_time",// "label": "Book your appointment at:", "type": "DATE_AND_TIME",// "valueMsEpoch": 796435200000 } “`DateTimePicker *GoogleAppsCardV1DateTimePicker `json:"dateTimePicker,omitempty"`// DecoratedText: Displays a decorated text item. For example, the following// JSON creates a decorated text widget showing email address: “`// "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email// Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email// address!", "switchControl": { "name": "has_send_welcome_email_to_sasha",// "selected": false, "controlType": "CHECKBOX" } } “`DecoratedText *GoogleAppsCardV1DecoratedText `json:"decoratedText,omitempty"`// Divider: Displays a horizontal line divider between widgets. For example,// the following JSON creates a divider: “` "divider": { } “`Divider *GoogleAppsCardV1Divider `json:"divider,omitempty"`// EventActions: Specifies the event actions that can be performed on the// widget. Available for Google Workspace add-ons that extend Google Workspace// flows, which is available as part of the Gemini Alpha program// (https://support.google.com/a/answer/14170809). Unavailable for Google Chat// apps.EventActions []*GoogleAppsCardV1EventAction `json:"eventActions,omitempty"`// Grid: Displays a grid with a collection of items. A grid supports any number// of columns and items. The number of rows is determined by the upper bounds// of the number items divided by the number of columns. A grid with 10 items// and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows.// Google Workspace add-ons and Chat apps// (https://developers.google.com/workspace/extend): For example, the following// JSON creates a 2 column grid with a single item: “` "grid": { "title": "A// fine collection of items", "columnCount": 2, "borderStyle": { "type":// "STROKE", "cornerRadius": 4 }, "items": [ { "image": { "imageUri":// "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" },// "borderStyle": { "type": "STROKE" } }, "title": "An item", "textAlignment":// "CENTER" } ], "onClick": { "openLink": { "url": "https://www.example.com" }// } } “`Grid *GoogleAppsCardV1Grid `json:"grid,omitempty"`// HorizontalAlignment: Specifies whether widgets align to the left, right, or// center of a column.//// Possible values:// "HORIZONTAL_ALIGNMENT_UNSPECIFIED" - Don't use. Unspecified.// "START" - Default value. Aligns widgets to the start position of the// column. For left-to-right layouts, aligns to the left. For right-to-left// layouts, aligns to the right.// "CENTER" - Aligns widgets to the center of the column.// "END" - Aligns widgets to the end position of the column. For// left-to-right layouts, aligns widgets to the right. For right-to-left// layouts, aligns widgets to the left.HorizontalAlignmentstring `json:"horizontalAlignment,omitempty"`// Id: A unique ID assigned to the widget that's used to identify the widget to// be mutated. The ID has a character limit of 64 characters and should be in// the format of `[a-zA-Z0-9-]+` and. Available for Google Workspace add-ons// that extend Google Workspace flows, which is available as part of the Gemini// Alpha program (https://support.google.com/a/answer/14170809). Unavailable// for Google Chat apps.Idstring `json:"id,omitempty"`// Image: Displays an image. For example, the following JSON creates an image// with alternative text: “` "image": { "imageUrl":// "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.pn// g", "altText": "Chat app avatar" } “`Image *GoogleAppsCardV1Image `json:"image,omitempty"`// SelectionInput: Displays a selection control that lets users select items.// Selection controls can be checkboxes, radio buttons, switches, or dropdown// menus. For example, the following JSON creates a dropdown menu that lets// users choose a size: “` "selectionInput": { "name": "size", "label": "Size"// "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected":// false }, { "text": "M", "value": "medium", "selected": true }, { "text":// "L", "value": "large", "selected": false }, { "text": "XL", "value":// "extra_large", "selected": false } ] } “`SelectionInput *GoogleAppsCardV1SelectionInput `json:"selectionInput,omitempty"`// TextInput: Displays a text box that users can type into. For example, the// following JSON creates a text input for an email address: “` "textInput": {// "name": "mailing_address", "label": "Mailing Address" } “` As another// example, the following JSON creates a text input for a programming language// with static suggestions: “` "textInput": { "name":// "preferred_programing_language", "label": "Preferred Language",// "initialSuggestions": { "items": [ { "text": "C++" }, { "text": "Java" }, {// "text": "JavaScript" }, { "text": "Python" } ] } } “`TextInput *GoogleAppsCardV1TextInput `json:"textInput,omitempty"`// TextParagraph: Displays a text paragraph. Supports simple HTML formatted// text. For more information about formatting text, see Formatting text in// Google Chat apps// (https://developers.google.com/workspace/chat/format-messages#card-formatting)// and Formatting text in Google Workspace add-ons// (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).// For example, the following JSON creates a bolded text: “` "textParagraph":// { "text": " *bold text*" } “`TextParagraph *GoogleAppsCardV1TextParagraph `json:"textParagraph,omitempty"`// Visibility: Specifies whether the widget is visible or hidden. The default// value is `VISIBLE`. Available for Google Workspace add-ons that extend// Google Workspace flows, which is available as part of the Gemini Alpha// program (https://support.google.com/a/answer/14170809). Unavailable for// Google Chat apps.//// Possible values:// "VISIBILITY_UNSPECIFIED" - Unspecified visibility. Do not use.// "VISIBLE" - The UI element is visible.// "HIDDEN" - The UI element is hidden.Visibilitystring `json:"visibility,omitempty"`// ForceSendFields is a list of field names (e.g. "ButtonList") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ButtonList") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Widget: Each card is made up of widgets. A widget is acomposite object that can represent one of text, images, buttons, and otherobject types.
func (GoogleAppsCardV1Widget)MarshalJSON¶added inv0.49.0
func (sGoogleAppsCardV1Widget) MarshalJSON() ([]byte,error)
typeGoogleAppsCardV1Widgets¶added inv0.123.0
type GoogleAppsCardV1Widgets struct {// ButtonList: ButtonList widget.ButtonList *GoogleAppsCardV1ButtonList `json:"buttonList,omitempty"`// ChipList: ChipList widget.ChipList *GoogleAppsCardV1ChipList `json:"chipList,omitempty"`// DateTimePicker: DateTimePicker widget.DateTimePicker *GoogleAppsCardV1DateTimePicker `json:"dateTimePicker,omitempty"`// DecoratedText: DecoratedText widget.DecoratedText *GoogleAppsCardV1DecoratedText `json:"decoratedText,omitempty"`// Image: Image widget.Image *GoogleAppsCardV1Image `json:"image,omitempty"`// SelectionInput: SelectionInput widget.SelectionInput *GoogleAppsCardV1SelectionInput `json:"selectionInput,omitempty"`// TextInput: TextInput widget.TextInput *GoogleAppsCardV1TextInput `json:"textInput,omitempty"`// TextParagraph: TextParagraph widget.TextParagraph *GoogleAppsCardV1TextParagraph `json:"textParagraph,omitempty"`// ForceSendFields is a list of field names (e.g. "ButtonList") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ButtonList") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleAppsCardV1Widgets: The supported widgets that you can include in acolumn. Google Workspace add-ons and Chat apps(https://developers.google.com/workspace/extend)
func (GoogleAppsCardV1Widgets)MarshalJSON¶added inv0.123.0
func (sGoogleAppsCardV1Widgets) MarshalJSON() ([]byte,error)
typeGroup¶added inv0.153.0
type Group struct {// Name: Resource name for a Google Group. Represents a group// (https://cloud.google.com/identity/docs/reference/rest/v1/groups) in Cloud// Identity Groups API. Format: groups/{group}Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Group: A Google Group in Google Chat.
func (Group)MarshalJSON¶added inv0.153.0
typeHostAppDataSourceMarkup¶added inv0.132.0
type HostAppDataSourceMarkup struct {// ChatDataSource: A data source from Google Chat.ChatDataSource *ChatClientDataSourceMarkup `json:"chatDataSource,omitempty"`// WorkflowDataSource: A data source from Google Workflow.WorkflowDataSource *WorkflowDataSourceMarkup `json:"workflowDataSource,omitempty"`// ForceSendFields is a list of field names (e.g. "ChatDataSource") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ChatDataSource") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}HostAppDataSourceMarkup: A data source from a Google Workspace application.The data source populates available items for a widget.
func (HostAppDataSourceMarkup)MarshalJSON¶added inv0.132.0
func (sHostAppDataSourceMarkup) MarshalJSON() ([]byte,error)
typeImage¶
type Image struct {// AspectRatio: The aspect ratio of this image (width and height). This field// lets you reserve the right height for the image while waiting for it to// load. It's not meant to override the built-in aspect ratio of the image. If// unset, the server fills it by prefetching the image.AspectRatiofloat64 `json:"aspectRatio,omitempty"`// ImageUrl: The URL of the image.ImageUrlstring `json:"imageUrl,omitempty"`// OnClick: The `onclick` action.OnClick *OnClick `json:"onClick,omitempty"`// ForceSendFields is a list of field names (e.g. "AspectRatio") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AspectRatio") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Image: An image that's specified by a URL and can have an `onclick` action.
func (Image)MarshalJSON¶
func (*Image)UnmarshalJSON¶
typeImageButton¶
type ImageButton struct {// Icon: The icon specified by an `enum` that indices to an icon provided by// Chat API.//// Possible values:// "ICON_UNSPECIFIED"// "AIRPLANE"// "BOOKMARK"// "BUS"// "CAR"// "CLOCK"// "CONFIRMATION_NUMBER_ICON"// "DOLLAR"// "DESCRIPTION"// "EMAIL"// "EVENT_PERFORMER"// "EVENT_SEAT"// "FLIGHT_ARRIVAL"// "FLIGHT_DEPARTURE"// "HOTEL"// "HOTEL_ROOM_TYPE"// "INVITE"// "MAP_PIN"// "MEMBERSHIP"// "MULTIPLE_PEOPLE"// "OFFER"// "PERSON"// "PHONE"// "RESTAURANT_ICON"// "SHOPPING_CART"// "STAR"// "STORE"// "TICKET"// "TRAIN"// "VIDEO_CAMERA"// "VIDEO_PLAY"Iconstring `json:"icon,omitempty"`// IconUrl: The icon specified by a URL.IconUrlstring `json:"iconUrl,omitempty"`// Name: The name of this `image_button` that's used for accessibility. Default// value is provided if this name isn't specified.Namestring `json:"name,omitempty"`// OnClick: The `onclick` action.OnClick *OnClick `json:"onClick,omitempty"`// ForceSendFields is a list of field names (e.g. "Icon") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Icon") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ImageButton: An image button with an `onclick` action.
func (ImageButton)MarshalJSON¶
func (sImageButton) MarshalJSON() ([]byte,error)
typeInputs¶added inv0.55.0
type Inputs struct {// DateInput: Date input values from a `DateTimePicker`// (https://developers.google.com/chat/api/reference/rest/v1/cards#DateTimePicker)// widget that only accepts date values.DateInput *DateInput `json:"dateInput,omitempty"`// DateTimeInput: Date and time input values from a `DateTimePicker`// (https://developers.google.com/chat/api/reference/rest/v1/cards#DateTimePicker)// widget that accepts both a date and time.DateTimeInput *DateTimeInput `json:"dateTimeInput,omitempty"`// StringInputs: A list of strings that represent the values that the user// inputs in a widget. If the widget only accepts one value, such as a// `TextInput`// (https://developers.google.com/chat/api/reference/rest/v1/cards#TextInput)// widget, the list contains one string object. If the widget accepts multiple// values, such as a `SelectionInput`// (https://developers.google.com/chat/api/reference/rest/v1/cards#selectioninput)// widget of checkboxes, the list contains a string object for each value that// the user inputs or selects.StringInputs *StringInputs `json:"stringInputs,omitempty"`// TimeInput: Time input values from a `DateTimePicker`// (https://developers.google.com/chat/api/reference/rest/v1/cards#DateTimePicker)// widget that only accepts time values.TimeInput *TimeInput `json:"timeInput,omitempty"`// ForceSendFields is a list of field names (e.g. "DateInput") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DateInput") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Inputs: Types of data that users can input on cards or dialogs(https://developers.google.com/chat/ui/read-form-data). The input typedepends on the type of values that the widget accepts.
func (Inputs)MarshalJSON¶added inv0.55.0
typeKeyValue¶
type KeyValue struct {// BottomLabel: The text of the bottom label. Formatted text supported. For// more information about formatting text, see Formatting text in Google Chat// apps// (https://developers.google.com/workspace/chat/format-messages#card-formatting)// and Formatting text in Google Workspace Add-ons// (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).BottomLabelstring `json:"bottomLabel,omitempty"`// Button: A button that can be clicked to trigger an action.Button *Button `json:"button,omitempty"`// Content: The text of the content. Formatted text supported and always// required. For more information about formatting text, see Formatting text in// Google Chat apps// (https://developers.google.com/workspace/chat/format-messages#card-formatting)// and Formatting text in Google Workspace Add-ons// (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).Contentstring `json:"content,omitempty"`// ContentMultiline: If the content should be multiline.ContentMultilinebool `json:"contentMultiline,omitempty"`// Icon: An enum value that's replaced by the Chat API with the corresponding// icon image.//// Possible values:// "ICON_UNSPECIFIED"// "AIRPLANE"// "BOOKMARK"// "BUS"// "CAR"// "CLOCK"// "CONFIRMATION_NUMBER_ICON"// "DOLLAR"// "DESCRIPTION"// "EMAIL"// "EVENT_PERFORMER"// "EVENT_SEAT"// "FLIGHT_ARRIVAL"// "FLIGHT_DEPARTURE"// "HOTEL"// "HOTEL_ROOM_TYPE"// "INVITE"// "MAP_PIN"// "MEMBERSHIP"// "MULTIPLE_PEOPLE"// "OFFER"// "PERSON"// "PHONE"// "RESTAURANT_ICON"// "SHOPPING_CART"// "STAR"// "STORE"// "TICKET"// "TRAIN"// "VIDEO_CAMERA"// "VIDEO_PLAY"Iconstring `json:"icon,omitempty"`// IconUrl: The icon specified by a URL.IconUrlstring `json:"iconUrl,omitempty"`// OnClick: The `onclick` action. Only the top label, bottom label, and content// region are clickable.OnClick *OnClick `json:"onClick,omitempty"`// TopLabel: The text of the top label. Formatted text supported. For more// information about formatting text, see Formatting text in Google Chat apps// (https://developers.google.com/workspace/chat/format-messages#card-formatting)// and Formatting text in Google Workspace Add-ons// (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).TopLabelstring `json:"topLabel,omitempty"`// ForceSendFields is a list of field names (e.g. "BottomLabel") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BottomLabel") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}KeyValue: A UI element contains a key (label) and a value (content). Thiselement can also contain some actions such as `onclick` button.
func (KeyValue)MarshalJSON¶
typeListCustomEmojisResponse¶added inv0.229.0
type ListCustomEmojisResponse struct {// CustomEmojis: Unordered list. List of custom emojis.CustomEmojis []*CustomEmoji `json:"customEmojis,omitempty"`// NextPageToken: A token that you can send as `pageToken` to retrieve the next// page of results. If empty, there are no subsequent pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CustomEmojis") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CustomEmojis") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListCustomEmojisResponse: A response to list custom emojis.
func (ListCustomEmojisResponse)MarshalJSON¶added inv0.229.0
func (sListCustomEmojisResponse) MarshalJSON() ([]byte,error)
typeListMembershipsResponse¶
type ListMembershipsResponse struct {// Memberships: Unordered list. List of memberships in the requested (or first)// page.Memberships []*Membership `json:"memberships,omitempty"`// NextPageToken: A token that you can send as `pageToken` to retrieve the next// page of results. If empty, there are no subsequent pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Memberships") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Memberships") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListMembershipsResponse: Response to list memberships of the space.
func (ListMembershipsResponse)MarshalJSON¶
func (sListMembershipsResponse) MarshalJSON() ([]byte,error)
typeListMessagesResponse¶added inv0.123.0
type ListMessagesResponse struct {// Messages: List of messages.Messages []*Message `json:"messages,omitempty"`// NextPageToken: You can send a token as `pageToken` to retrieve the next page// of results. If empty, there are no subsequent pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Messages") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Messages") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListMessagesResponse: Response message for listing messages.
func (ListMessagesResponse)MarshalJSON¶added inv0.123.0
func (sListMessagesResponse) MarshalJSON() ([]byte,error)
typeListReactionsResponse¶added inv0.123.0
type ListReactionsResponse struct {// NextPageToken: Continuation token to retrieve the next page of results. It's// empty for the last page of results.NextPageTokenstring `json:"nextPageToken,omitempty"`// Reactions: List of reactions in the requested (or first) page.Reactions []*Reaction `json:"reactions,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListReactionsResponse: Response to a list reactions request.
func (ListReactionsResponse)MarshalJSON¶added inv0.123.0
func (sListReactionsResponse) MarshalJSON() ([]byte,error)
typeListSpaceEventsResponse¶added inv0.173.0
type ListSpaceEventsResponse struct {// NextPageToken: Continuation token used to fetch more events. If this field// is omitted, there are no subsequent pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// SpaceEvents: Results are returned in chronological order (oldest event// first). Note: The `permissionSettings` field is not returned in the Space// object for list requests.SpaceEvents []*SpaceEvent `json:"spaceEvents,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListSpaceEventsResponse: Response message for listing space events.
func (ListSpaceEventsResponse)MarshalJSON¶added inv0.173.0
func (sListSpaceEventsResponse) MarshalJSON() ([]byte,error)
typeListSpacesResponse¶
type ListSpacesResponse struct {// NextPageToken: You can send a token as `pageToken` to retrieve the next page// of results. If empty, there are no subsequent pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// Spaces: List of spaces in the requested (or first) page. Note: The// `permissionSettings` field is not returned in the Space object for list// requests.Spaces []*Space `json:"spaces,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListSpacesResponse: The response for a list spaces request.
func (ListSpacesResponse)MarshalJSON¶
func (sListSpacesResponse) MarshalJSON() ([]byte,error)
typeMatchedUrl¶added inv0.63.0
type MatchedUrl struct {// Url: Output only. The URL that was matched.Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "Url") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Url") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MatchedUrl: A matched URL in a Chat message. Chat apps can preview matchedURLs. For more information, see Preview links(https://developers.google.com/chat/how-tos/preview-links).
func (MatchedUrl)MarshalJSON¶added inv0.63.0
func (sMatchedUrl) MarshalJSON() ([]byte,error)
typeMedia¶added inv0.30.0
type Media struct {// ResourceName: Name of the media resource.ResourceNamestring `json:"resourceName,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ResourceName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ResourceName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Media: Media resource.
func (Media)MarshalJSON¶added inv0.30.0
typeMediaDownloadCall¶added inv0.30.0
type MediaDownloadCall struct {// contains filtered or unexported fields}func (*MediaDownloadCall)Context¶added inv0.30.0
func (c *MediaDownloadCall) Context(ctxcontext.Context) *MediaDownloadCall
Context sets the context to be used in this call's Do and Download methods.
func (*MediaDownloadCall)Do¶added inv0.30.0
func (c *MediaDownloadCall) Do(opts ...googleapi.CallOption) (*Media,error)
Do executes the "chat.media.download" call.Any non-2xx status code is an error. Response headers are in either*Media.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*MediaDownloadCall)Download¶added inv0.30.0
func (c *MediaDownloadCall) Download(opts ...googleapi.CallOption) (*http.Response,error)
Download fetches the API endpoint's "media" value, instead of the normalAPI response value. If the returned error is nil, the Response is guaranteed tohave a 2xx status code. Callers must close the Response.Body as usual.
func (*MediaDownloadCall)Fields¶added inv0.30.0
func (c *MediaDownloadCall) Fields(s ...googleapi.Field) *MediaDownloadCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*MediaDownloadCall)Header¶added inv0.30.0
func (c *MediaDownloadCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*MediaDownloadCall)IfNoneMatch¶added inv0.30.0
func (c *MediaDownloadCall) IfNoneMatch(entityTagstring) *MediaDownloadCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeMediaService¶added inv0.30.0
type MediaService struct {// contains filtered or unexported fields}funcNewMediaService¶added inv0.30.0
func NewMediaService(s *Service) *MediaService
func (*MediaService)Download¶added inv0.30.0
func (r *MediaService) Download(resourceNamestring) *MediaDownloadCall
Download: Downloads media. Download is supported on the URI`/v1/media/{+name}?alt=media`.
- resourceName: Name of the media that is being downloaded. SeeReadRequest.resource_name.
func (*MediaService)Upload¶added inv0.123.0
func (r *MediaService) Upload(parentstring, uploadattachmentrequest *UploadAttachmentRequest) *MediaUploadCall
Upload: Uploads an attachment. For an example, see Upload media as a fileattachment(https://developers.google.com/workspace/chat/upload-media-attachments).Requires user authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.messages.create` -`https://www.googleapis.com/auth/chat.messages` -`https://www.googleapis.com/auth/chat.import` (import mode spaces only) Youcan upload attachments up to 200 MB. Certain file types aren't supported.For details, see File types blocked by Google Chat(https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).
- parent: Resource name of the Chat space in which the attachment isuploaded. Format "spaces/{space}".
typeMediaUploadCall¶added inv0.123.0
type MediaUploadCall struct {// contains filtered or unexported fields}func (*MediaUploadCall)Context¶added inv0.123.0
func (c *MediaUploadCall) Context(ctxcontext.Context) *MediaUploadCall
Context sets the context to be used in this call's Do method.This context will supersede any context previously provided to theResumableMedia method.
func (*MediaUploadCall)Do¶added inv0.123.0
func (c *MediaUploadCall) Do(opts ...googleapi.CallOption) (*UploadAttachmentResponse,error)
Do executes the "chat.media.upload" call.Any non-2xx status code is an error. Response headers are in either*UploadAttachmentResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*MediaUploadCall)Fields¶added inv0.123.0
func (c *MediaUploadCall) Fields(s ...googleapi.Field) *MediaUploadCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*MediaUploadCall)Header¶added inv0.123.0
func (c *MediaUploadCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*MediaUploadCall)Media¶added inv0.123.0
func (c *MediaUploadCall) Media(rio.Reader, options ...googleapi.MediaOption) *MediaUploadCall
Media specifies the media to upload in one or more chunks. The chunk sizemay be controlled by supplying a MediaOption generated bygoogleapi.ChunkSize. The chunk size defaults togoogleapi.DefaultUploadChunkSize.The Content-Type header used in the uploadrequest will be determined by sniffing the contents of r, unless aMediaOption generated by googleapi.ContentType is supplied.At most one of Media and ResumableMedia may be set.
func (*MediaUploadCall)ProgressUpdater¶added inv0.123.0
func (c *MediaUploadCall) ProgressUpdater(pugoogleapi.ProgressUpdater) *MediaUploadCall
ProgressUpdater provides a callback function that will be called after everychunk. It should be a low-latency function in order to not slow down theupload operation. This should only be called when using ResumableMedia (asopposed to Media).
func (*MediaUploadCall)ResumableMediadeprecatedadded inv0.123.0
func (c *MediaUploadCall) ResumableMedia(ctxcontext.Context, rio.ReaderAt, sizeint64, mediaTypestring) *MediaUploadCall
ResumableMedia specifies the media to upload in chunks and can be canceledwith ctx.
Deprecated: use Media instead.
At most one of Media and ResumableMedia may be set. mediaType identifies theMIME media type of the upload, such as "image/png". If mediaType is "", itwill be auto-detected. The provided ctx will supersede any contextpreviously provided to the Context method.
typeMeetSpaceLinkData¶added inv0.244.0
type MeetSpaceLinkData struct {// HuddleStatus: Optional. Output only. If the Meet is a Huddle, indicates the// status of the huddle. Otherwise, this is unset.//// Possible values:// "HUDDLE_STATUS_UNSPECIFIED" - Default value for the enum. Don't use.// "STARTED" - The huddle has started.// "ENDED" - The huddle has ended. In this case the Meet space URI and// identifiers will no longer be valid.// "MISSED" - The huddle has been missed. In this case the Meet space URI and// identifiers will no longer be valid.HuddleStatusstring `json:"huddleStatus,omitempty"`// MeetingCode: Meeting code of the linked Meet space.MeetingCodestring `json:"meetingCode,omitempty"`// Type: Indicates the type of the Meet space.//// Possible values:// "TYPE_UNSPECIFIED" - Default value for the enum. Don't use.// "MEETING" - The Meet space is a meeting.// "HUDDLE" - The Meet space is a huddle.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "HuddleStatus") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "HuddleStatus") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MeetSpaceLinkData: Data for Meet space links.
func (MeetSpaceLinkData)MarshalJSON¶added inv0.244.0
func (sMeetSpaceLinkData) MarshalJSON() ([]byte,error)
typeMembership¶
type Membership struct {// CreateTime: Optional. Immutable. The creation time of the membership, such// as when a member joined or was invited to join a space. This field is output// only, except when used to import historical memberships in import mode// spaces.CreateTimestring `json:"createTime,omitempty"`// DeleteTime: Optional. Immutable. The deletion time of the membership, such// as when a member left or was removed from a space. This field is output// only, except when used to import historical memberships in import mode// spaces.DeleteTimestring `json:"deleteTime,omitempty"`// GroupMember: Optional. The Google Group the membership corresponds to.// Reading or mutating memberships for Google Groups requires user// authentication// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).GroupMember *Group `json:"groupMember,omitempty"`// Member: Optional. The Google Chat user or app the membership corresponds to.// If your Chat app authenticates as a user// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),// the output populates the user// (https://developers.google.com/workspace/chat/api/reference/rest/v1/User)// `name` and `type`.Member *User `json:"member,omitempty"`// Name: Identifier. Resource name of the membership, assigned by the server.// Format: `spaces/{space}/members/{member}`Namestring `json:"name,omitempty"`// Role: Optional. User's role within a Chat space, which determines their// permitted actions in the space. This field can only be used as input in// `UpdateMembership`.//// Possible values:// "MEMBERSHIP_ROLE_UNSPECIFIED" - Default value. For users: they aren't a// member of the space, but can be invited. For Google Groups: they're always// assigned this role (other enum values might be used in the future).// "ROLE_MEMBER" - A member of the space. In the Chat UI, this role is called// Member. The user has basic permissions, like sending messages to the space.// Managers and owners can grant members additional permissions in a space,// including: - Add or remove members. - Modify space details. - Turn history// on or off. - Mention everyone in the space with `@all`. - Manage Chat apps// and webhooks installed in the space. In direct messages and unnamed group// conversations, everyone has this role.// "ROLE_MANAGER" - A space owner. In the Chat UI, this role is called Owner.// The user has the complete set of space permissions to manage the space,// including: - Change the role of other members in the space to member,// manager, or owner. - Delete the space. Only supported in SpaceType.SPACE// (named spaces). To learn more, see [Learn more about your role as a space// owner or manager](https://support.google.com/chat/answer/11833441).// "ROLE_ASSISTANT_MANAGER" - A space manager. In the Chat UI, this role is// called Manager. The user has all basic permissions of `ROLE_MEMBER`, and can// be granted a subset of administrative permissions by an owner. By default,// managers have all the permissions of an owner except for the ability to: -// Delete the space. - Make another space member an owner. - Change an owner's// role. By default, managers permissions include but aren't limited to: - Make// another member a manager. - Delete messages in the space. - Manage space// permissions. - Receive notifications for requests to join the space if the// manager has the "manage members" permission in the space settings. - Make a// space discoverable. Only supported in SpaceType.SPACE (named spaces). To// learn more, see [Manage space// settings](https://support.google.com/chat/answer/13340792).Rolestring `json:"role,omitempty"`// State: Output only. State of the membership.//// Possible values:// "MEMBERSHIP_STATE_UNSPECIFIED" - Default value. Don't use.// "JOINED" - The user is added to the space, and can participate in the// space.// "INVITED" - The user is invited to join the space, but hasn't joined it.// "NOT_A_MEMBER" - The user doesn't belong to the space and doesn't have a// pending invitation to join the space.Statestring `json:"state,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Membership: Represents a membership relation in Google Chat, such as whethera user or Chat app is invited to, part of, or absent from a space.
func (Membership)MarshalJSON¶
func (sMembership) MarshalJSON() ([]byte,error)
typeMembershipBatchCreatedEventData¶added inv0.173.0
type MembershipBatchCreatedEventData struct {// Memberships: A list of new memberships.Memberships []*MembershipCreatedEventData `json:"memberships,omitempty"`// ForceSendFields is a list of field names (e.g. "Memberships") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Memberships") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MembershipBatchCreatedEventData: Event payload for multiple new memberships.Event type: `google.workspace.chat.membership.v1.batchCreated`
func (MembershipBatchCreatedEventData)MarshalJSON¶added inv0.173.0
func (sMembershipBatchCreatedEventData) MarshalJSON() ([]byte,error)
typeMembershipBatchDeletedEventData¶added inv0.173.0
type MembershipBatchDeletedEventData struct {// Memberships: A list of deleted memberships.Memberships []*MembershipDeletedEventData `json:"memberships,omitempty"`// ForceSendFields is a list of field names (e.g. "Memberships") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Memberships") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MembershipBatchDeletedEventData: Event payload for multiple deletedmemberships. Event type: `google.workspace.chat.membership.v1.batchDeleted`
func (MembershipBatchDeletedEventData)MarshalJSON¶added inv0.173.0
func (sMembershipBatchDeletedEventData) MarshalJSON() ([]byte,error)
typeMembershipBatchUpdatedEventData¶added inv0.173.0
type MembershipBatchUpdatedEventData struct {// Memberships: A list of updated memberships.Memberships []*MembershipUpdatedEventData `json:"memberships,omitempty"`// ForceSendFields is a list of field names (e.g. "Memberships") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Memberships") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MembershipBatchUpdatedEventData: Event payload for multiple updatedmemberships. Event type: `google.workspace.chat.membership.v1.batchUpdated`
func (MembershipBatchUpdatedEventData)MarshalJSON¶added inv0.173.0
func (sMembershipBatchUpdatedEventData) MarshalJSON() ([]byte,error)
typeMembershipCount¶added inv0.194.0
type MembershipCount struct {// JoinedDirectHumanUserCount: Output only. Count of human users that have// directly joined the space, not counting users joined by having membership in// a joined group.JoinedDirectHumanUserCountint64 `json:"joinedDirectHumanUserCount,omitempty"`// JoinedGroupCount: Output only. Count of all groups that have directly joined// the space.JoinedGroupCountint64 `json:"joinedGroupCount,omitempty"`// ForceSendFields is a list of field names (e.g. "JoinedDirectHumanUserCount")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "JoinedDirectHumanUserCount") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MembershipCount: Represents the count of memberships of a space, groupedinto categories.
func (MembershipCount)MarshalJSON¶added inv0.194.0
func (sMembershipCount) MarshalJSON() ([]byte,error)
typeMembershipCreatedEventData¶added inv0.173.0
type MembershipCreatedEventData struct {// Membership: The new membership.Membership *Membership `json:"membership,omitempty"`// ForceSendFields is a list of field names (e.g. "Membership") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Membership") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MembershipCreatedEventData: Event payload for a new membership. Event type:`google.workspace.chat.membership.v1.created`.
func (MembershipCreatedEventData)MarshalJSON¶added inv0.173.0
func (sMembershipCreatedEventData) MarshalJSON() ([]byte,error)
typeMembershipDeletedEventData¶added inv0.173.0
type MembershipDeletedEventData struct {// Membership: The deleted membership. Only the `name` and `state` fields are// populated.Membership *Membership `json:"membership,omitempty"`// ForceSendFields is a list of field names (e.g. "Membership") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Membership") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MembershipDeletedEventData: Event payload for a deleted membership. Eventtype: `google.workspace.chat.membership.v1.deleted`
func (MembershipDeletedEventData)MarshalJSON¶added inv0.173.0
func (sMembershipDeletedEventData) MarshalJSON() ([]byte,error)
typeMembershipUpdatedEventData¶added inv0.173.0
type MembershipUpdatedEventData struct {// Membership: The updated membership.Membership *Membership `json:"membership,omitempty"`// ForceSendFields is a list of field names (e.g. "Membership") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Membership") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MembershipUpdatedEventData: Event payload for an updated membership. Eventtype: `google.workspace.chat.membership.v1.updated`
func (MembershipUpdatedEventData)MarshalJSON¶added inv0.173.0
func (sMembershipUpdatedEventData) MarshalJSON() ([]byte,error)
typeMessage¶
type Message struct {// AccessoryWidgets: Optional. One or more interactive widgets that appear at// the bottom of a message. You can add accessory widgets to messages that// contain text, cards, or both text and cards. Not supported for messages that// contain dialogs. For details, see Add interactive widgets at the bottom of a// message// (https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets).// Creating a message with accessory widgets requires [app authentication]// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).AccessoryWidgets []*AccessoryWidget `json:"accessoryWidgets,omitempty"`// ActionResponse: Input only. Parameters that a Chat app can use to configure// how its response is posted.ActionResponse *ActionResponse `json:"actionResponse,omitempty"`// Annotations: Output only. Annotations can be associated with the plain-text// body of the message or with chips that link to Google Workspace resources// like Google Docs or Sheets with `start_index` and `length` of 0.Annotations []*Annotation `json:"annotations,omitempty"`// ArgumentText: Output only. Plain-text body of the message with all Chat app// mentions stripped out.ArgumentTextstring `json:"argumentText,omitempty"`// AttachedGifs: Output only. GIF images that are attached to the message.AttachedGifs []*AttachedGif `json:"attachedGifs,omitempty"`// Attachment: Optional. User-uploaded attachment.Attachment []*Attachment `json:"attachment,omitempty"`// Cards: Deprecated: Use `cards_v2` instead. Rich, formatted, and interactive// cards that you can use to display UI elements such as: formatted texts,// buttons, and clickable images. Cards are normally displayed below the// plain-text body of the message. `cards` and `cards_v2` can have a maximum// size of 32 KB.Cards []*Card `json:"cards,omitempty"`// CardsV2: Optional. An array of cards// (https://developers.google.com/workspace/chat/api/reference/rest/v1/cards).// Only Chat apps can create cards. If your Chat app authenticates as a user// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),// the messages can't contain cards. To learn how to create a message that// contains cards, see Send a message// (https://developers.google.com/workspace/chat/create-messages). Card builder// (https://addons.gsuite.google.com/uikit/builder)CardsV2 []*CardWithId `json:"cardsV2,omitempty"`// ClientAssignedMessageId: Optional. A custom ID for the message. You can use// field to identify a message, or to get, delete, or update a message. To set// a custom ID, specify the `messageId`// (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#body.QUERY_PARAMETERS.message_id)// field when you create the message. For details, see Name a message// (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).ClientAssignedMessageIdstring `json:"clientAssignedMessageId,omitempty"`// CreateTime: Optional. Immutable. For spaces created in Chat, the time at// which the message was created. This field is output only, except when used// in import mode spaces. For import mode spaces, set this field to the// historical timestamp at which the message was created in the source in order// to preserve the original creation time.CreateTimestring `json:"createTime,omitempty"`// DeleteTime: Output only. The time at which the message was deleted in Google// Chat. If the message is never deleted, this field is empty.DeleteTimestring `json:"deleteTime,omitempty"`// DeletionMetadata: Output only. Information about a deleted message. A// message is deleted when `delete_time` is set.DeletionMetadata *DeletionMetadata `json:"deletionMetadata,omitempty"`// EmojiReactionSummaries: Output only. The list of emoji reaction summaries on// the message.EmojiReactionSummaries []*EmojiReactionSummary `json:"emojiReactionSummaries,omitempty"`// FallbackText: Optional. A plain-text description of the message's cards,// used when the actual cards can't be displayed—for example, mobile// notifications.FallbackTextstring `json:"fallbackText,omitempty"`// FormattedText: Output only. Contains the message `text` with markups added// to communicate formatting. This field might not capture all formatting// visible in the UI, but includes the following: * Markup syntax// (https://developers.google.com/workspace/chat/format-messages) for bold,// italic, strikethrough, monospace, monospace block, and bulleted list. * User// mentions// (https://developers.google.com/workspace/chat/format-messages#messages-@mention)// using the format “. * Custom hyperlinks using the format// `<{url}|{rendered_text}>` where the first string is the URL and the second// is the rendered text—for example, “. * Custom emoji using the format// `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode// emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items// using asterisks (`*`)—for example, `* item`. For more information, see// View text formatting sent in a message// (https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message)FormattedTextstring `json:"formattedText,omitempty"`// LastUpdateTime: Output only. The time at which the message was last edited// by a user. If the message has never been edited, this field is empty.LastUpdateTimestring `json:"lastUpdateTime,omitempty"`// MatchedUrl: Output only. A URL in `spaces.messages.text` that matches a link// preview pattern. For more information, see Preview links// (https://developers.google.com/workspace/chat/preview-links).MatchedUrl *MatchedUrl `json:"matchedUrl,omitempty"`// Name: Identifier. Resource name of the message. Format:// `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space// where the message is posted and `{message}` is a system-assigned ID for the// message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`.// If you set a custom ID when you create a message, you can use this ID to// specify the message in a request by replacing `{message}` with the value// from the `clientAssignedMessageId` field. For example,// `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see Name a// message// (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).Namestring `json:"name,omitempty"`// PrivateMessageViewer: Optional. Immutable. Input for creating a message,// otherwise output only. The user that can view the message. When set, the// message is private and only visible to the specified user and the Chat app.// To include this field in your request, you must call the Chat API using app// authentication// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)// and omit the following: * Attachments// (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments)// * Accessory widgets// (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#Message.AccessoryWidget)// For details, see Send a message privately// (https://developers.google.com/workspace/chat/create-messages#private).PrivateMessageViewer *User `json:"privateMessageViewer,omitempty"`// QuotedMessageMetadata: Optional. Information about a message that another// message quotes. When you create a message, you can quote messages within the// same thread, or quote a root message to create a new root message. However,// you can't quote a message reply from a different thread. When you update a// message, you can't add or replace the `quotedMessageMetadata` field, but you// can remove it. For example usage, see Quote another message// (https://developers.google.com/workspace/chat/create-messages#quote-a-message).QuotedMessageMetadata *QuotedMessageMetadata `json:"quotedMessageMetadata,omitempty"`// Sender: Output only. The user who created the message. If your Chat app// authenticates as a user// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),// the output populates the user// (https://developers.google.com/workspace/chat/api/reference/rest/v1/User)// `name` and `type`.Sender *User `json:"sender,omitempty"`// SlashCommand: Output only. Slash command information, if applicable.SlashCommand *SlashCommand `json:"slashCommand,omitempty"`// Space: Output only. If your Chat app authenticates as a user// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),// the output only populates the space// (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces)// `name`.Space *Space `json:"space,omitempty"`// Text: Optional. Plain-text body of the message. The first link to an image,// video, or web page generates a preview chip// (https://developers.google.com/workspace/chat/preview-links). You can also// @mention a Google Chat user// (https://developers.google.com/workspace/chat/format-messages#messages-@mention),// or everyone in the space. To learn about creating text messages, see Send a// message (https://developers.google.com/workspace/chat/create-messages).Textstring `json:"text,omitempty"`// Thread: The thread the message belongs to. For example usage, see Start or// reply to a message thread// (https://developers.google.com/workspace/chat/create-messages#create-message-thread).Thread *Thread `json:"thread,omitempty"`// ThreadReply: Output only. When `true`, the message is a response in a reply// thread. When `false`, the message is visible in the space's top-level// conversation as either the first message of a thread or a message with no// threaded replies. If the space doesn't support reply in threads, this field// is always `false`.ThreadReplybool `json:"threadReply,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AccessoryWidgets") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AccessoryWidgets") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Message: A message in a Google Chat space.
func (Message)MarshalJSON¶
typeMessageBatchCreatedEventData¶added inv0.173.0
type MessageBatchCreatedEventData struct {// Messages: A list of new messages.Messages []*MessageCreatedEventData `json:"messages,omitempty"`// ForceSendFields is a list of field names (e.g. "Messages") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Messages") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MessageBatchCreatedEventData: Event payload for multiple new messages. Eventtype: `google.workspace.chat.message.v1.batchCreated`
func (MessageBatchCreatedEventData)MarshalJSON¶added inv0.173.0
func (sMessageBatchCreatedEventData) MarshalJSON() ([]byte,error)
typeMessageBatchDeletedEventData¶added inv0.173.0
type MessageBatchDeletedEventData struct {// Messages: A list of deleted messages.Messages []*MessageDeletedEventData `json:"messages,omitempty"`// ForceSendFields is a list of field names (e.g. "Messages") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Messages") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MessageBatchDeletedEventData: Event payload for multiple deleted messages.Event type: `google.workspace.chat.message.v1.batchDeleted`
func (MessageBatchDeletedEventData)MarshalJSON¶added inv0.173.0
func (sMessageBatchDeletedEventData) MarshalJSON() ([]byte,error)
typeMessageBatchUpdatedEventData¶added inv0.173.0
type MessageBatchUpdatedEventData struct {// Messages: A list of updated messages.Messages []*MessageUpdatedEventData `json:"messages,omitempty"`// ForceSendFields is a list of field names (e.g. "Messages") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Messages") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MessageBatchUpdatedEventData: Event payload for multiple updated messages.Event type: `google.workspace.chat.message.v1.batchUpdated`
func (MessageBatchUpdatedEventData)MarshalJSON¶added inv0.173.0
func (sMessageBatchUpdatedEventData) MarshalJSON() ([]byte,error)
typeMessageCreatedEventData¶added inv0.173.0
type MessageCreatedEventData struct {// Message: The new message.Message *Message `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Message") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Message") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MessageCreatedEventData: Event payload for a new message. Event type:`google.workspace.chat.message.v1.created`
func (MessageCreatedEventData)MarshalJSON¶added inv0.173.0
func (sMessageCreatedEventData) MarshalJSON() ([]byte,error)
typeMessageDeletedEventData¶added inv0.173.0
type MessageDeletedEventData struct {// Message: The deleted message. Only the `name`, `createTime`, and// `deletionMetadata` fields are populated.Message *Message `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Message") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Message") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MessageDeletedEventData: Event payload for a deleted message. Event type:`google.workspace.chat.message.v1.deleted`
func (MessageDeletedEventData)MarshalJSON¶added inv0.173.0
func (sMessageDeletedEventData) MarshalJSON() ([]byte,error)
typeMessageUpdatedEventData¶added inv0.173.0
type MessageUpdatedEventData struct {// Message: The updated message.Message *Message `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Message") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Message") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MessageUpdatedEventData: Event payload for an updated message. Event type:`google.workspace.chat.message.v1.updated`
func (MessageUpdatedEventData)MarshalJSON¶added inv0.173.0
func (sMessageUpdatedEventData) MarshalJSON() ([]byte,error)
typeOnClick¶
type OnClick struct {// Action: A form action is triggered by this `onclick` action if specified.Action *FormAction `json:"action,omitempty"`// OpenLink: This `onclick` action triggers an open link action if specified.OpenLink *OpenLink `json:"openLink,omitempty"`// ForceSendFields is a list of field names (e.g. "Action") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Action") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}OnClick: An `onclick` action (for example, open a link).
func (OnClick)MarshalJSON¶
typeOpenLink¶
type OpenLink struct {// Url: The URL to open.Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "Url") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Url") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}OpenLink: A link that opens a new window.
func (OpenLink)MarshalJSON¶
typePermissionSetting¶added inv0.200.0
type PermissionSetting struct {// AssistantManagersAllowed: Optional. Whether space managers// `ROLE_ASSISTANT_MANAGER`) have this permission.AssistantManagersAllowedbool `json:"assistantManagersAllowed,omitempty"`// ManagersAllowed: Optional. Whether space owners (`ROLE_MANAGER`) have this// permission.ManagersAllowedbool `json:"managersAllowed,omitempty"`// MembersAllowed: Optional. Whether basic space members (`ROLE_MEMBER`) have// this permission.MembersAllowedbool `json:"membersAllowed,omitempty"`// ForceSendFields is a list of field names (e.g. "AssistantManagersAllowed")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AssistantManagersAllowed") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}PermissionSetting: Represents a space permission setting.
func (PermissionSetting)MarshalJSON¶added inv0.200.0
func (sPermissionSetting) MarshalJSON() ([]byte,error)
typePermissionSettings¶added inv0.200.0
type PermissionSettings struct {// ManageApps: Optional. Setting for managing apps in a space.ManageApps *PermissionSetting `json:"manageApps,omitempty"`// ManageMembersAndGroups: Optional. Setting for managing members and groups in// a space.ManageMembersAndGroups *PermissionSetting `json:"manageMembersAndGroups,omitempty"`// ManageWebhooks: Optional. Setting for managing webhooks in a space.ManageWebhooks *PermissionSetting `json:"manageWebhooks,omitempty"`// ModifySpaceDetails: Optional. Setting for updating space name, avatar,// description and guidelines.ModifySpaceDetails *PermissionSetting `json:"modifySpaceDetails,omitempty"`// PostMessages: Output only. Setting for posting messages in a space.PostMessages *PermissionSetting `json:"postMessages,omitempty"`// ReplyMessages: Optional. Setting for replying to messages in a space.ReplyMessages *PermissionSetting `json:"replyMessages,omitempty"`// ToggleHistory: Optional. Setting for toggling space history on and off.ToggleHistory *PermissionSetting `json:"toggleHistory,omitempty"`// UseAtMentionAll: Optional. Setting for using @all in a space.UseAtMentionAll *PermissionSetting `json:"useAtMentionAll,omitempty"`// ForceSendFields is a list of field names (e.g. "ManageApps") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ManageApps") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}PermissionSettings: Permission settings(https://support.google.com/chat/answer/13340792) that you can specify whenupdating an existing named space. To set permission settings when creating aspace, specify the `PredefinedPermissionSettings` field in your request.
func (PermissionSettings)MarshalJSON¶added inv0.200.0
func (sPermissionSettings) MarshalJSON() ([]byte,error)
typeQuotedMessageMetadata¶added inv0.131.0
type QuotedMessageMetadata struct {// LastUpdateTime: Required. The timestamp when the quoted message was created// or when the quoted message was last updated. If the message was edited, use// this field, `last_update_time`. If the message was never edited, use// `create_time`. If `last_update_time` doesn't match the latest version of the// quoted message, the request fails.LastUpdateTimestring `json:"lastUpdateTime,omitempty"`// Name: Required. Resource name of the message that is quoted. Format:// `spaces/{space}/messages/{message}`Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "LastUpdateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LastUpdateTime") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}QuotedMessageMetadata: Information about a message that another messagequotes. When you create a message, you can quote messages within the samethread, or quote a root message to create a new root message. However, youcan't quote a message reply from a different thread. When you update amessage, you can't add or replace the `quotedMessageMetadata` field, but youcan remove it. For example usage, see Quote another message(https://developers.google.com/workspace/chat/create-messages#quote-a-message).
func (QuotedMessageMetadata)MarshalJSON¶added inv0.131.0
func (sQuotedMessageMetadata) MarshalJSON() ([]byte,error)
typeReaction¶added inv0.123.0
type Reaction struct {// Emoji: Required. The emoji used in the reaction.Emoji *Emoji `json:"emoji,omitempty"`// Name: Identifier. The resource name of the reaction. Format:// `spaces/{space}/messages/{message}/reactions/{reaction}`Namestring `json:"name,omitempty"`// User: Output only. The user who created the reaction.User *User `json:"user,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Emoji") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Emoji") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Reaction: A reaction to a message.
func (Reaction)MarshalJSON¶added inv0.123.0
typeReactionBatchCreatedEventData¶added inv0.173.0
type ReactionBatchCreatedEventData struct {// Reactions: A list of new reactions.Reactions []*ReactionCreatedEventData `json:"reactions,omitempty"`// ForceSendFields is a list of field names (e.g. "Reactions") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Reactions") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ReactionBatchCreatedEventData: Event payload for multiple new reactions.Event type: `google.workspace.chat.reaction.v1.batchCreated`
func (ReactionBatchCreatedEventData)MarshalJSON¶added inv0.173.0
func (sReactionBatchCreatedEventData) MarshalJSON() ([]byte,error)
typeReactionBatchDeletedEventData¶added inv0.173.0
type ReactionBatchDeletedEventData struct {// Reactions: A list of deleted reactions.Reactions []*ReactionDeletedEventData `json:"reactions,omitempty"`// ForceSendFields is a list of field names (e.g. "Reactions") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Reactions") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ReactionBatchDeletedEventData: Event payload for multiple deleted reactions.Event type: `google.workspace.chat.reaction.v1.batchDeleted`
func (ReactionBatchDeletedEventData)MarshalJSON¶added inv0.173.0
func (sReactionBatchDeletedEventData) MarshalJSON() ([]byte,error)
typeReactionCreatedEventData¶added inv0.173.0
type ReactionCreatedEventData struct {// Reaction: The new reaction.Reaction *Reaction `json:"reaction,omitempty"`// ForceSendFields is a list of field names (e.g. "Reaction") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Reaction") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ReactionCreatedEventData: Event payload for a new reaction. Event type:`google.workspace.chat.reaction.v1.created`
func (ReactionCreatedEventData)MarshalJSON¶added inv0.173.0
func (sReactionCreatedEventData) MarshalJSON() ([]byte,error)
typeReactionDeletedEventData¶added inv0.173.0
type ReactionDeletedEventData struct {// Reaction: The deleted reaction.Reaction *Reaction `json:"reaction,omitempty"`// ForceSendFields is a list of field names (e.g. "Reaction") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Reaction") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ReactionDeletedEventData: Event payload for a deleted reaction. Type:`google.workspace.chat.reaction.v1.deleted`
func (ReactionDeletedEventData)MarshalJSON¶added inv0.173.0
func (sReactionDeletedEventData) MarshalJSON() ([]byte,error)
typeRichLinkMetadata¶added inv0.170.0
type RichLinkMetadata struct {// CalendarEventLinkData: Data for a Calendar event link.CalendarEventLinkData *CalendarEventLinkData `json:"calendarEventLinkData,omitempty"`// ChatSpaceLinkData: Data for a chat space link.ChatSpaceLinkData *ChatSpaceLinkData `json:"chatSpaceLinkData,omitempty"`// DriveLinkData: Data for a drive link.DriveLinkData *DriveLinkData `json:"driveLinkData,omitempty"`// MeetSpaceLinkData: Data for a Meet space link.MeetSpaceLinkData *MeetSpaceLinkData `json:"meetSpaceLinkData,omitempty"`// RichLinkType: The rich link type.//// Possible values:// "RICH_LINK_TYPE_UNSPECIFIED" - Default value for the enum. Don't use.// "DRIVE_FILE" - A Google Drive rich link type.// "CHAT_SPACE" - A Chat space rich link type. For example, a space smart// chip.// "MEET_SPACE" - A Meet message rich link type. For example, a Meet chip.// "CALENDAR_EVENT" - A Calendar message rich link type. For example, a// Calendar chip.RichLinkTypestring `json:"richLinkType,omitempty"`// Uri: The URI of this link.Uristring `json:"uri,omitempty"`// ForceSendFields is a list of field names (e.g. "CalendarEventLinkData") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CalendarEventLinkData") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}RichLinkMetadata: A rich link to a resource. Rich links can be associatedwith the plain-text body of the message or represent chips that link toGoogle Workspace resources like Google Docs or Sheets with `start_index` and`length` of 0.
func (RichLinkMetadata)MarshalJSON¶added inv0.170.0
func (sRichLinkMetadata) MarshalJSON() ([]byte,error)
typeSearchSpacesResponse¶added inv0.194.0
type SearchSpacesResponse struct {// NextPageToken: A token that can be used to retrieve the next page. If this// field is empty, there are no subsequent pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// Spaces: A page of the requested spaces.Spaces []*Space `json:"spaces,omitempty"`// TotalSize: The total number of spaces that match the query, across all// pages. If the result is over 10,000 spaces, this value is an estimate.TotalSizeint64 `json:"totalSize,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SearchSpacesResponse: Response with a list of spaces corresponding to thesearch spaces request.
func (SearchSpacesResponse)MarshalJSON¶added inv0.194.0
func (sSearchSpacesResponse) MarshalJSON() ([]byte,error)
typeSection¶
type Section struct {// Header: The header of the section. Formatted text is supported. For more// information about formatting text, see Formatting text in Google Chat apps// (https://developers.google.com/workspace/chat/format-messages#card-formatting)// and Formatting text in Google Workspace Add-ons// (https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).Headerstring `json:"header,omitempty"`// Widgets: A section must contain at least one widget.Widgets []*WidgetMarkup `json:"widgets,omitempty"`// ForceSendFields is a list of field names (e.g. "Header") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Header") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Section: A section contains a collection of widgets that are rendered(vertically) in the order that they are specified. Across all platforms,cards have a narrow fixed width, so there's currently no need for layoutproperties (for example, float).
func (Section)MarshalJSON¶
typeSelectionItems¶added inv0.153.0
type SelectionItems struct {// Items: An array of the SelectionItem objects.Items []*GoogleAppsCardV1SelectionItem `json:"items,omitempty"`// ForceSendFields is a list of field names (e.g. "Items") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Items") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SelectionItems: List of widget autocomplete results.
func (SelectionItems)MarshalJSON¶added inv0.153.0
func (sSelectionItems) MarshalJSON() ([]byte,error)
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentCustomEmojis *CustomEmojisServiceMedia *MediaServiceSpaces *SpacesServiceUsers *UsersService// contains filtered or unexported fields} funcNewdeprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
funcNewService¶added inv0.3.0
NewService creates a new Service.
typeSetUpSpaceRequest¶added inv0.123.0
type SetUpSpaceRequest struct {// Memberships: Optional. The Google Chat users or groups to invite to join the// space. Omit the calling user, as they are added automatically. The set// currently allows up to 49 memberships (in addition to the caller). For human// membership, the `Membership.member` field must contain a `user` with `name`// populated (format: `users/{user}`) and `type` set to `User.Type.HUMAN`. You// can only add human users when setting up a space (adding Chat apps is only// supported for direct message setup with the calling app). You can also add// members using the user's email as an alias for {user}. For example, the// `user.name` can be `users/example@gmail.com`. To invite Gmail users or users// from external Google Workspace domains, user's email must be used for// `{user}`. For Google group membership, the `Membership.group_member` field// must contain a `group` with `name` populated (format `groups/{group}`). You// can only add Google groups when setting `Space.spaceType` to `SPACE`.// Optional when setting `Space.spaceType` to `SPACE`. Required when setting// `Space.spaceType` to `GROUP_CHAT`, along with at least two memberships.// Required when setting `Space.spaceType` to `DIRECT_MESSAGE` with a human// user, along with exactly one membership. Must be empty when creating a 1:1// conversation between a human and the calling Chat app (when setting// `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to// `true`).Memberships []*Membership `json:"memberships,omitempty"`// RequestId: Optional. A unique identifier for this request. A random UUID is// recommended. Specifying an existing request ID returns the space created// with that ID instead of creating a new space. Specifying an existing request// ID from the same Chat app with a different authenticated user returns an// error.RequestIdstring `json:"requestId,omitempty"`// Space: Required. The `Space.spaceType` field is required. To create a space,// set `Space.spaceType` to `SPACE` and set `Space.displayName`. If you receive// the error message `ALREADY_EXISTS` when setting up a space, try a different// `displayName`. An existing space within the Google Workspace organization// might already use this display name. To create a group chat, set// `Space.spaceType` to `GROUP_CHAT`. Don't set `Space.displayName`. To create// a 1:1 conversation between humans, set `Space.spaceType` to `DIRECT_MESSAGE`// and set `Space.singleUserBotDm` to `false`. Don't set `Space.displayName` or// `Space.spaceDetails`. To create an 1:1 conversation between a human and the// calling Chat app, set `Space.spaceType` to `DIRECT_MESSAGE` and// `Space.singleUserBotDm` to `true`. Don't set `Space.displayName` or// `Space.spaceDetails`. If a `DIRECT_MESSAGE` space already exists, that space// is returned instead of creating a new space.Space *Space `json:"space,omitempty"`// ForceSendFields is a list of field names (e.g. "Memberships") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Memberships") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SetUpSpaceRequest: Request to create a space and add specified users to it.
func (SetUpSpaceRequest)MarshalJSON¶added inv0.123.0
func (sSetUpSpaceRequest) MarshalJSON() ([]byte,error)
typeSlashCommand¶added inv0.33.0
type SlashCommand struct {// CommandId: The ID of the slash command.CommandIdint64 `json:"commandId,omitempty,string"`// ForceSendFields is a list of field names (e.g. "CommandId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommandId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SlashCommand: Metadata about a slash command(https://developers.google.com/workspace/chat/commands) in Google Chat.
func (SlashCommand)MarshalJSON¶added inv0.33.0
func (sSlashCommand) MarshalJSON() ([]byte,error)
typeSlashCommandMetadata¶added inv0.33.0
type SlashCommandMetadata struct {// Bot: The Chat app whose command was invoked.Bot *User `json:"bot,omitempty"`// CommandId: The command ID of the invoked slash command.CommandIdint64 `json:"commandId,omitempty,string"`// CommandName: The name of the invoked slash command.CommandNamestring `json:"commandName,omitempty"`// TriggersDialog: Indicates whether the slash command is for a dialog.TriggersDialogbool `json:"triggersDialog,omitempty"`// Type: The type of slash command.//// Possible values:// "TYPE_UNSPECIFIED" - Default value for the enum. Don't use.// "ADD" - Add Chat app to space.// "INVOKE" - Invoke slash command in space.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Bot") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Bot") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SlashCommandMetadata: Annotation metadata for slash commands (/).
func (SlashCommandMetadata)MarshalJSON¶added inv0.33.0
func (sSlashCommandMetadata) MarshalJSON() ([]byte,error)
typeSpace¶
type Space struct {// AccessSettings: Optional. Specifies the access setting// (https://support.google.com/chat/answer/11971020) of the space. Only// populated when the `space_type` is `SPACE`.AccessSettings *AccessSettings `json:"accessSettings,omitempty"`// AdminInstalled: Output only. For direct message (DM) spaces with a Chat app,// whether the space was created by a Google Workspace administrator.// Administrators can install and set up a direct message with a Chat app on// behalf of users in their organization. To support admin install, your Chat// app must feature direct messaging.AdminInstalledbool `json:"adminInstalled,omitempty"`// CreateTime: Optional. Immutable. For spaces created in Chat, the time the// space was created. This field is output only, except when used in import// mode spaces. For import mode spaces, set this field to the historical// timestamp at which the space was created in the source in order to preserve// the original creation time. Only populated in the output when `spaceType` is// `GROUP_CHAT` or `SPACE`.CreateTimestring `json:"createTime,omitempty"`// Customer: Optional. Immutable. The customer id of the domain of the space.// Required only when creating a space with app authentication// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)// and `SpaceType` is `SPACE`, otherwise should not be set. In the format// `customers/{customer}`, where `customer` is the `id` from the Admin SDK// customer resource// (https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers).// Private apps can also use the `customers/my_customer` alias to create the// space in the same Google Workspace organization as the app. This field isn't// populated for direct messages (DMs) or when the space is created by// non-Google Workspace users.Customerstring `json:"customer,omitempty"`// DisplayName: Optional. The space's display name. Required when creating a// space// (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create)// with a `spaceType` of `SPACE`. If you receive the error message// `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a// different `displayName`. An existing space within the Google Workspace// organization might already use this display name. For direct messages, this// field might be empty. Supports up to 128 characters.DisplayNamestring `json:"displayName,omitempty"`// ExternalUserAllowed: Optional. Immutable. Whether this space permits any// Google Chat user as a member. Input when creating a space in a Google// Workspace organization. Omit this field when creating spaces in the// following conditions: * The authenticated user uses a consumer account// (unmanaged user account). By default, a space created by a consumer account// permits any Google Chat user. For existing spaces, this field is output// only.ExternalUserAllowedbool `json:"externalUserAllowed,omitempty"`// ImportMode: Optional. Whether this space is created in `Import Mode` as part// of a data migration into Google Workspace. While spaces are being imported,// they aren't visible to users until the import is complete. Creating a space// in `Import Mode`requires user authentication// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).ImportModebool `json:"importMode,omitempty"`// ImportModeExpireTime: Output only. The time when the space will be// automatically deleted by the system if it remains in import mode. Each space// created in import mode must exit this mode before this expire time using// `spaces.completeImport`. This field is only populated for spaces that were// created with import mode.ImportModeExpireTimestring `json:"importModeExpireTime,omitempty"`// LastActiveTime: Output only. Timestamp of the last message in the space.LastActiveTimestring `json:"lastActiveTime,omitempty"`// MembershipCount: Output only. The count of joined memberships grouped by// member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or// `GROUP_CHAT`.MembershipCount *MembershipCount `json:"membershipCount,omitempty"`// Name: Identifier. Resource name of the space. Format: `spaces/{space}` Where// `{space}` represents the system-assigned ID for the space. You can obtain// the space ID by calling the `spaces.list()`// (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list)// method or from the space URL. For example, if the space URL is// `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is// `AAAAAAAAA`.Namestring `json:"name,omitempty"`// PermissionSettings: Optional. Space permission settings for existing spaces.// Input for updating exact space permission settings, where existing// permission settings are replaced. Output lists current permission settings.// Reading and updating permission settings supports: - App authentication// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)// with administrator approval (https://support.google.com/a?p=chat-app-auth)// with the `chat.app.spaces` scope. Only populated and settable when the Chat// app created the space. - User authentication// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)PermissionSettings *PermissionSettings `json:"permissionSettings,omitempty"`// PredefinedPermissionSettings: Optional. Input only. Predefined space// permission settings, input only when creating a space. If the field is not// set, a collaboration space is created. After you create the space, settings// are populated in the `PermissionSettings` field. Setting predefined// permission settings supports: - App authentication// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)// with administrator approval (https://support.google.com/a?p=chat-app-auth)// with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - User// authentication// (https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)//// Possible values:// "PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED" - Unspecified. Don't use.// "COLLABORATION_SPACE" - Setting to make the space a collaboration space// where all members can post messages.// "ANNOUNCEMENT_SPACE" - Setting to make the space an announcement space// where only space managers can post messages.PredefinedPermissionSettingsstring `json:"predefinedPermissionSettings,omitempty"`// SingleUserBotDm: Optional. Whether the space is a DM between a Chat app and// a single human.SingleUserBotDmbool `json:"singleUserBotDm,omitempty"`// SpaceDetails: Optional. Details about the space including description and// rules.SpaceDetails *SpaceDetails `json:"spaceDetails,omitempty"`// SpaceHistoryState: Optional. The message history state for messages and// threads in this space.//// Possible values:// "HISTORY_STATE_UNSPECIFIED" - Default value. Do not use.// "HISTORY_OFF" - History off. [Messages and threads are kept for 24// hours](https://support.google.com/chat/answer/7664687).// "HISTORY_ON" - History on. The organization's [Vault retention// rules](https://support.google.com/vault/answer/7657597) specify for how long// messages and threads are kept.SpaceHistoryStatestring `json:"spaceHistoryState,omitempty"`// SpaceThreadingState: Output only. The threading state in the Chat space.//// Possible values:// "SPACE_THREADING_STATE_UNSPECIFIED" - Reserved.// "THREADED_MESSAGES" - Named spaces that support message threads. When// users respond to a message, they can reply in-thread, which keeps their// response in the context of the original message.// "GROUPED_MESSAGES" - Named spaces where the conversation is organized by// topic. Topics and their replies are grouped together.// "UNTHREADED_MESSAGES" - Direct messages (DMs) between two people and group// conversations between 3 or more people.SpaceThreadingStatestring `json:"spaceThreadingState,omitempty"`// SpaceType: Optional. The type of space. Required when creating a space or// updating the space type of a space. Output only for other usage.//// Possible values:// "SPACE_TYPE_UNSPECIFIED" - Reserved.// "SPACE" - A place where people send messages, share files, and// collaborate. A `SPACE` can include Chat apps.// "GROUP_CHAT" - Group conversations between 3 or more people. A// `GROUP_CHAT` can include Chat apps.// "DIRECT_MESSAGE" - 1:1 messages between two humans or a human and a Chat// app.SpaceTypestring `json:"spaceType,omitempty"`// SpaceUri: Output only. The URI for a user to access the space.SpaceUristring `json:"spaceUri,omitempty"`// Threaded: Output only. Deprecated: Use `spaceThreadingState` instead.// Whether messages are threaded in this space.Threadedbool `json:"threaded,omitempty"`// Type: Output only. Deprecated: Use `space_type` instead. The type of a// space.//// Possible values:// "TYPE_UNSPECIFIED" - Reserved.// "ROOM" - Conversations between two or more humans.// "DM" - 1:1 Direct Message between a human and a Chat app, where all// messages are flat. Note that this doesn't include direct messages between// two humans.Typestring `json:"type,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AccessSettings") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AccessSettings") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Space: A space in Google Chat. Spaces are conversations between two or moreusers or 1:1 messages between a user and a Chat app.
func (Space)MarshalJSON¶
typeSpaceBatchUpdatedEventData¶added inv0.173.0
type SpaceBatchUpdatedEventData struct {// Spaces: A list of updated spaces.Spaces []*SpaceUpdatedEventData `json:"spaces,omitempty"`// ForceSendFields is a list of field names (e.g. "Spaces") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Spaces") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SpaceBatchUpdatedEventData: Event payload for multiple updates to a space.Event type: `google.workspace.chat.space.v1.batchUpdated`
func (SpaceBatchUpdatedEventData)MarshalJSON¶added inv0.173.0
func (sSpaceBatchUpdatedEventData) MarshalJSON() ([]byte,error)
typeSpaceDataSource¶added inv0.132.0
type SpaceDataSource struct {// DefaultToCurrentSpace: If set to `true`, the multiselect menu selects the// current Google Chat space as an item by default.DefaultToCurrentSpacebool `json:"defaultToCurrentSpace,omitempty"`// ForceSendFields is a list of field names (e.g. "DefaultToCurrentSpace") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DefaultToCurrentSpace") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SpaceDataSource: A data source that populates Google Chat spaces asselection items for a multiselect menu. Only populates spaces that the useris a member of. Google Chat apps(https://developers.google.com/workspace/chat):
func (SpaceDataSource)MarshalJSON¶added inv0.132.0
func (sSpaceDataSource) MarshalJSON() ([]byte,error)
typeSpaceDetails¶added inv0.90.0
type SpaceDetails struct {// Description: Optional. A description of the space. For example, describe the// space's discussion topic, functional purpose, or participants. Supports up// to 150 characters.Descriptionstring `json:"description,omitempty"`// Guidelines: Optional. The space's rules, expectations, and etiquette.// Supports up to 5,000 characters.Guidelinesstring `json:"guidelines,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SpaceDetails: Details about the space including description and rules.
func (SpaceDetails)MarshalJSON¶added inv0.90.0
func (sSpaceDetails) MarshalJSON() ([]byte,error)
typeSpaceEvent¶added inv0.173.0
type SpaceEvent struct {// EventTime: Time when the event occurred.EventTimestring `json:"eventTime,omitempty"`// EventType: Type of space event. Each event type has a batch version, which// represents multiple instances of the event type that occur in a short period// of time. For `spaceEvents.list()` requests, omit batch event types in your// query filter. By default, the server returns both event type and its batch// version. Supported event types for messages// (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages):// * New message: `google.workspace.chat.message.v1.created` * Updated message:// `google.workspace.chat.message.v1.updated` * Deleted message:// `google.workspace.chat.message.v1.deleted` * Multiple new messages:// `google.workspace.chat.message.v1.batchCreated` * Multiple updated messages:// `google.workspace.chat.message.v1.batchUpdated` * Multiple deleted messages:// `google.workspace.chat.message.v1.batchDeleted` Supported event types for// memberships// (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members):// * New membership: `google.workspace.chat.membership.v1.created` * Updated// membership: `google.workspace.chat.membership.v1.updated` * Deleted// membership: `google.workspace.chat.membership.v1.deleted` * Multiple new// memberships: `google.workspace.chat.membership.v1.batchCreated` * Multiple// updated memberships: `google.workspace.chat.membership.v1.batchUpdated` *// Multiple deleted memberships:// `google.workspace.chat.membership.v1.batchDeleted` Supported event types for// reactions// (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.reactions):// * New reaction: `google.workspace.chat.reaction.v1.created` * Deleted// reaction: `google.workspace.chat.reaction.v1.deleted` * Multiple new// reactions: `google.workspace.chat.reaction.v1.batchCreated` * Multiple// deleted reactions: `google.workspace.chat.reaction.v1.batchDeleted`// Supported event types about the space// (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces):// * Updated space: `google.workspace.chat.space.v1.updated` * Multiple space// updates: `google.workspace.chat.space.v1.batchUpdated`EventTypestring `json:"eventType,omitempty"`// MembershipBatchCreatedEventData: Event payload for multiple new memberships.// Event type: `google.workspace.chat.membership.v1.batchCreated`MembershipBatchCreatedEventData *MembershipBatchCreatedEventData `json:"membershipBatchCreatedEventData,omitempty"`// MembershipBatchDeletedEventData: Event payload for multiple deleted// memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted`MembershipBatchDeletedEventData *MembershipBatchDeletedEventData `json:"membershipBatchDeletedEventData,omitempty"`// MembershipBatchUpdatedEventData: Event payload for multiple updated// memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated`MembershipBatchUpdatedEventData *MembershipBatchUpdatedEventData `json:"membershipBatchUpdatedEventData,omitempty"`// MembershipCreatedEventData: Event payload for a new membership. Event type:// `google.workspace.chat.membership.v1.created`MembershipCreatedEventData *MembershipCreatedEventData `json:"membershipCreatedEventData,omitempty"`// MembershipDeletedEventData: Event payload for a deleted membership. Event// type: `google.workspace.chat.membership.v1.deleted`MembershipDeletedEventData *MembershipDeletedEventData `json:"membershipDeletedEventData,omitempty"`// MembershipUpdatedEventData: Event payload for an updated membership. Event// type: `google.workspace.chat.membership.v1.updated`MembershipUpdatedEventData *MembershipUpdatedEventData `json:"membershipUpdatedEventData,omitempty"`// MessageBatchCreatedEventData: Event payload for multiple new messages. Event// type: `google.workspace.chat.message.v1.batchCreated`MessageBatchCreatedEventData *MessageBatchCreatedEventData `json:"messageBatchCreatedEventData,omitempty"`// MessageBatchDeletedEventData: Event payload for multiple deleted messages.// Event type: `google.workspace.chat.message.v1.batchDeleted`MessageBatchDeletedEventData *MessageBatchDeletedEventData `json:"messageBatchDeletedEventData,omitempty"`// MessageBatchUpdatedEventData: Event payload for multiple updated messages.// Event type: `google.workspace.chat.message.v1.batchUpdated`MessageBatchUpdatedEventData *MessageBatchUpdatedEventData `json:"messageBatchUpdatedEventData,omitempty"`// MessageCreatedEventData: Event payload for a new message. Event type:// `google.workspace.chat.message.v1.created`MessageCreatedEventData *MessageCreatedEventData `json:"messageCreatedEventData,omitempty"`// MessageDeletedEventData: Event payload for a deleted message. Event type:// `google.workspace.chat.message.v1.deleted`MessageDeletedEventData *MessageDeletedEventData `json:"messageDeletedEventData,omitempty"`// MessageUpdatedEventData: Event payload for an updated message. Event type:// `google.workspace.chat.message.v1.updated`MessageUpdatedEventData *MessageUpdatedEventData `json:"messageUpdatedEventData,omitempty"`// Name: Resource name of the space event. Format:// `spaces/{space}/spaceEvents/{spaceEvent}`Namestring `json:"name,omitempty"`// ReactionBatchCreatedEventData: Event payload for multiple new reactions.// Event type: `google.workspace.chat.reaction.v1.batchCreated`ReactionBatchCreatedEventData *ReactionBatchCreatedEventData `json:"reactionBatchCreatedEventData,omitempty"`// ReactionBatchDeletedEventData: Event payload for multiple deleted reactions.// Event type: `google.workspace.chat.reaction.v1.batchDeleted`ReactionBatchDeletedEventData *ReactionBatchDeletedEventData `json:"reactionBatchDeletedEventData,omitempty"`// ReactionCreatedEventData: Event payload for a new reaction. Event type:// `google.workspace.chat.reaction.v1.created`ReactionCreatedEventData *ReactionCreatedEventData `json:"reactionCreatedEventData,omitempty"`// ReactionDeletedEventData: Event payload for a deleted reaction. Event type:// `google.workspace.chat.reaction.v1.deleted`ReactionDeletedEventData *ReactionDeletedEventData `json:"reactionDeletedEventData,omitempty"`// SpaceBatchUpdatedEventData: Event payload for multiple updates to a space.// Event type: `google.workspace.chat.space.v1.batchUpdated`SpaceBatchUpdatedEventData *SpaceBatchUpdatedEventData `json:"spaceBatchUpdatedEventData,omitempty"`// SpaceUpdatedEventData: Event payload for a space update. Event type:// `google.workspace.chat.space.v1.updated`SpaceUpdatedEventData *SpaceUpdatedEventData `json:"spaceUpdatedEventData,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "EventTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EventTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SpaceEvent: An event that represents a change or activity in a Google Chatspace. To learn more, see Work with events from Google Chat(https://developers.google.com/workspace/chat/events-overview).
func (SpaceEvent)MarshalJSON¶added inv0.173.0
func (sSpaceEvent) MarshalJSON() ([]byte,error)
typeSpaceNotificationSetting¶added inv0.224.0
type SpaceNotificationSetting struct {// MuteSetting: The space notification mute setting.//// Possible values:// "MUTE_SETTING_UNSPECIFIED" - Reserved.// "UNMUTED" - The user will receive notifications for the space based on the// notification setting.// "MUTED" - The user will not receive any notifications for the space,// regardless of the notification setting.MuteSettingstring `json:"muteSetting,omitempty"`// Name: Identifier. The resource name of the space notification setting.// Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.Namestring `json:"name,omitempty"`// NotificationSetting: The notification setting.//// Possible values:// "NOTIFICATION_SETTING_UNSPECIFIED" - Reserved.// "ALL" - Notifications are triggered by @mentions, followed threads, first// message of new threads. All new threads are automatically followed, unless// manually unfollowed by the user.// "MAIN_CONVERSATIONS" - The notification is triggered by @mentions,// followed threads, first message of new threads. Not available for 1:1 direct// messages.// "FOR_YOU" - The notification is triggered by @mentions, followed threads.// Not available for 1:1 direct messages.// "OFF" - Notification is off.NotificationSettingstring `json:"notificationSetting,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "MuteSetting") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MuteSetting") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SpaceNotificationSetting: The notification setting of a user in a space.
func (SpaceNotificationSetting)MarshalJSON¶added inv0.224.0
func (sSpaceNotificationSetting) MarshalJSON() ([]byte,error)
typeSpaceReadState¶added inv0.177.0
type SpaceReadState struct {// LastReadTime: Optional. The time when the user's space read state was// updated. Usually this corresponds with either the timestamp of the last read// message, or a timestamp specified by the user to mark the last read position// in a space.LastReadTimestring `json:"lastReadTime,omitempty"`// Name: Resource name of the space read state. Format:// `users/{user}/spaces/{space}/spaceReadState`Namestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "LastReadTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LastReadTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SpaceReadState: A user's read state within a space, used to identify readand unread messages.
func (SpaceReadState)MarshalJSON¶added inv0.177.0
func (sSpaceReadState) MarshalJSON() ([]byte,error)
typeSpaceUpdatedEventData¶added inv0.173.0
type SpaceUpdatedEventData struct {// Space: The updated space.Space *Space `json:"space,omitempty"`// ForceSendFields is a list of field names (e.g. "Space") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Space") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SpaceUpdatedEventData: Event payload for an updated space. Event type:`google.workspace.chat.space.v1.updated`
func (SpaceUpdatedEventData)MarshalJSON¶added inv0.173.0
func (sSpaceUpdatedEventData) MarshalJSON() ([]byte,error)
typeSpacesCompleteImportCall¶added inv0.156.0
type SpacesCompleteImportCall struct {// contains filtered or unexported fields}func (*SpacesCompleteImportCall)Context¶added inv0.156.0
func (c *SpacesCompleteImportCall) Context(ctxcontext.Context) *SpacesCompleteImportCall
Context sets the context to be used in this call's Do method.
func (*SpacesCompleteImportCall)Do¶added inv0.156.0
func (c *SpacesCompleteImportCall) Do(opts ...googleapi.CallOption) (*CompleteImportSpaceResponse,error)
Do executes the "chat.spaces.completeImport" call.Any non-2xx status code is an error. Response headers are in either*CompleteImportSpaceResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*SpacesCompleteImportCall)Fields¶added inv0.156.0
func (c *SpacesCompleteImportCall) Fields(s ...googleapi.Field) *SpacesCompleteImportCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesCompleteImportCall)Header¶added inv0.156.0
func (c *SpacesCompleteImportCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeSpacesCreateCall¶added inv0.123.0
type SpacesCreateCall struct {// contains filtered or unexported fields}func (*SpacesCreateCall)Context¶added inv0.123.0
func (c *SpacesCreateCall) Context(ctxcontext.Context) *SpacesCreateCall
Context sets the context to be used in this call's Do method.
func (*SpacesCreateCall)Do¶added inv0.123.0
func (c *SpacesCreateCall) Do(opts ...googleapi.CallOption) (*Space,error)
Do executes the "chat.spaces.create" call.Any non-2xx status code is an error. Response headers are in either*Space.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesCreateCall)Fields¶added inv0.123.0
func (c *SpacesCreateCall) Fields(s ...googleapi.Field) *SpacesCreateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesCreateCall)Header¶added inv0.123.0
func (c *SpacesCreateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesCreateCall)RequestId¶added inv0.123.0
func (c *SpacesCreateCall) RequestId(requestIdstring) *SpacesCreateCall
RequestId sets the optional parameter "requestId": A unique identifier forthis request. A random UUID is recommended. Specifying an existing requestID returns the space created with that ID instead of creating a new space.Specifying an existing request ID from the same Chat app with a differentauthenticated user returns an error.
typeSpacesDeleteCall¶added inv0.123.0
type SpacesDeleteCall struct {// contains filtered or unexported fields}func (*SpacesDeleteCall)Context¶added inv0.123.0
func (c *SpacesDeleteCall) Context(ctxcontext.Context) *SpacesDeleteCall
Context sets the context to be used in this call's Do method.
func (*SpacesDeleteCall)Do¶added inv0.123.0
func (c *SpacesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty,error)
Do executes the "chat.spaces.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesDeleteCall)Fields¶added inv0.123.0
func (c *SpacesDeleteCall) Fields(s ...googleapi.Field) *SpacesDeleteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesDeleteCall)Header¶added inv0.123.0
func (c *SpacesDeleteCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesDeleteCall)UseAdminAccess¶added inv0.194.0
func (c *SpacesDeleteCall) UseAdminAccess(useAdminAccessbool) *SpacesDeleteCall
UseAdminAccess sets the optional parameter "useAdminAccess": When `true`,the method runs using the user's Google Workspace administrator privileges.The calling user must be a Google Workspace administrator with the managechat and spaces conversations privilege(https://support.google.com/a/answer/13369245). Requires the`chat.admin.delete` OAuth 2.0 scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
typeSpacesFindDirectMessageCall¶added inv0.123.0
type SpacesFindDirectMessageCall struct {// contains filtered or unexported fields}func (*SpacesFindDirectMessageCall)Context¶added inv0.123.0
func (c *SpacesFindDirectMessageCall) Context(ctxcontext.Context) *SpacesFindDirectMessageCall
Context sets the context to be used in this call's Do method.
func (*SpacesFindDirectMessageCall)Do¶added inv0.123.0
func (c *SpacesFindDirectMessageCall) Do(opts ...googleapi.CallOption) (*Space,error)
Do executes the "chat.spaces.findDirectMessage" call.Any non-2xx status code is an error. Response headers are in either*Space.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesFindDirectMessageCall)Fields¶added inv0.123.0
func (c *SpacesFindDirectMessageCall) Fields(s ...googleapi.Field) *SpacesFindDirectMessageCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesFindDirectMessageCall)Header¶added inv0.123.0
func (c *SpacesFindDirectMessageCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesFindDirectMessageCall)IfNoneMatch¶added inv0.123.0
func (c *SpacesFindDirectMessageCall) IfNoneMatch(entityTagstring) *SpacesFindDirectMessageCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*SpacesFindDirectMessageCall)Name¶added inv0.123.0
func (c *SpacesFindDirectMessageCall) Name(namestring) *SpacesFindDirectMessageCall
Name sets the optional parameter "name": Required. Resource name of the userto find direct message with. Format: `users/{user}`, where `{user}` iseither the `id` for the person(https://developers.google.com/people/api/rest/v1/people) from the PeopleAPI, or the `id` for the user(https://developers.google.com/admin-sdk/directory/reference/rest/v1/users)in the Directory API. For example, if the People API profile ID is`123456789`, you can find a direct message with that person by using`users/123456789` as the `name`. When authenticated as a user(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),you can use the email as an alias for `{user}`. For example,`users/example@gmail.com` where `example@gmail.com` is the email of theGoogle Chat user.
typeSpacesGetCall¶
type SpacesGetCall struct {// contains filtered or unexported fields}func (*SpacesGetCall)Context¶
func (c *SpacesGetCall) Context(ctxcontext.Context) *SpacesGetCall
Context sets the context to be used in this call's Do method.
func (*SpacesGetCall)Do¶
func (c *SpacesGetCall) Do(opts ...googleapi.CallOption) (*Space,error)
Do executes the "chat.spaces.get" call.Any non-2xx status code is an error. Response headers are in either*Space.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesGetCall)Fields¶
func (c *SpacesGetCall) Fields(s ...googleapi.Field) *SpacesGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesGetCall)Header¶
func (c *SpacesGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesGetCall)IfNoneMatch¶
func (c *SpacesGetCall) IfNoneMatch(entityTagstring) *SpacesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*SpacesGetCall)UseAdminAccess¶added inv0.194.0
func (c *SpacesGetCall) UseAdminAccess(useAdminAccessbool) *SpacesGetCall
UseAdminAccess sets the optional parameter "useAdminAccess": When `true`,the method runs using the user's Google Workspace administrator privileges.The calling user must be a Google Workspace administrator with the managechat and spaces conversations privilege(https://support.google.com/a/answer/13369245). Requires the`chat.admin.spaces` or `chat.admin.spaces.readonly` OAuth 2.0 scopes(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
typeSpacesListCall¶
type SpacesListCall struct {// contains filtered or unexported fields}func (*SpacesListCall)Context¶
func (c *SpacesListCall) Context(ctxcontext.Context) *SpacesListCall
Context sets the context to be used in this call's Do method.
func (*SpacesListCall)Do¶
func (c *SpacesListCall) Do(opts ...googleapi.CallOption) (*ListSpacesResponse,error)
Do executes the "chat.spaces.list" call.Any non-2xx status code is an error. Response headers are in either*ListSpacesResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*SpacesListCall)Fields¶
func (c *SpacesListCall) Fields(s ...googleapi.Field) *SpacesListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesListCall)Filter¶added inv0.123.0
func (c *SpacesListCall) Filter(filterstring) *SpacesListCall
Filter sets the optional parameter "filter": A query filter. You can filterspaces by the space type (`space_type`(https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)).To filter by space type, you must specify valid enum value, such as `SPACE`or `GROUP_CHAT` (the `space_type` can't be `SPACE_TYPE_UNSPECIFIED`). Toquery for multiple space types, use the `OR` operator. For example, thefollowing queries are valid: ``` space_type = "SPACE" spaceType ="GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE" ``` Invalid queries arerejected by the server with an `INVALID_ARGUMENT` error.
func (*SpacesListCall)Header¶
func (c *SpacesListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesListCall)IfNoneMatch¶
func (c *SpacesListCall) IfNoneMatch(entityTagstring) *SpacesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*SpacesListCall)PageSize¶
func (c *SpacesListCall) PageSize(pageSizeint64) *SpacesListCall
PageSize sets the optional parameter "pageSize": The maximum number ofspaces to return. The service might return fewer than this value. Ifunspecified, at most 100 spaces are returned. The maximum value is 1000. Ifyou use a value more than 1000, it's automatically changed to 1000. Negativevalues return an `INVALID_ARGUMENT` error.
func (*SpacesListCall)PageToken¶
func (c *SpacesListCall) PageToken(pageTokenstring) *SpacesListCall
PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous list spaces call. Provide this parameter to retrieve thesubsequent page. When paginating, the filter value should match the callthat provided the page token. Passing a different value may lead tounexpected results.
func (*SpacesListCall)Pages¶
func (c *SpacesListCall) Pages(ctxcontext.Context, f func(*ListSpacesResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
typeSpacesMembersCreateCall¶added inv0.123.0
type SpacesMembersCreateCall struct {// contains filtered or unexported fields}func (*SpacesMembersCreateCall)Context¶added inv0.123.0
func (c *SpacesMembersCreateCall) Context(ctxcontext.Context) *SpacesMembersCreateCall
Context sets the context to be used in this call's Do method.
func (*SpacesMembersCreateCall)Do¶added inv0.123.0
func (c *SpacesMembersCreateCall) Do(opts ...googleapi.CallOption) (*Membership,error)
Do executes the "chat.spaces.members.create" call.Any non-2xx status code is an error. Response headers are in either*Membership.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesMembersCreateCall)Fields¶added inv0.123.0
func (c *SpacesMembersCreateCall) Fields(s ...googleapi.Field) *SpacesMembersCreateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesMembersCreateCall)Header¶added inv0.123.0
func (c *SpacesMembersCreateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesMembersCreateCall)UseAdminAccess¶added inv0.194.0
func (c *SpacesMembersCreateCall) UseAdminAccess(useAdminAccessbool) *SpacesMembersCreateCall
UseAdminAccess sets the optional parameter "useAdminAccess": When `true`,the method runs using the user's Google Workspace administrator privileges.The calling user must be a Google Workspace administrator with the managechat and spaces conversations privilege(https://support.google.com/a/answer/13369245). Requires the`chat.admin.memberships` OAuth 2.0 scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).Creating app memberships or creating memberships for users outside theadministrator's Google Workspace organization isn't supported using adminaccess.
typeSpacesMembersDeleteCall¶added inv0.123.0
type SpacesMembersDeleteCall struct {// contains filtered or unexported fields}func (*SpacesMembersDeleteCall)Context¶added inv0.123.0
func (c *SpacesMembersDeleteCall) Context(ctxcontext.Context) *SpacesMembersDeleteCall
Context sets the context to be used in this call's Do method.
func (*SpacesMembersDeleteCall)Do¶added inv0.123.0
func (c *SpacesMembersDeleteCall) Do(opts ...googleapi.CallOption) (*Membership,error)
Do executes the "chat.spaces.members.delete" call.Any non-2xx status code is an error. Response headers are in either*Membership.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesMembersDeleteCall)Fields¶added inv0.123.0
func (c *SpacesMembersDeleteCall) Fields(s ...googleapi.Field) *SpacesMembersDeleteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesMembersDeleteCall)Header¶added inv0.123.0
func (c *SpacesMembersDeleteCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesMembersDeleteCall)UseAdminAccess¶added inv0.194.0
func (c *SpacesMembersDeleteCall) UseAdminAccess(useAdminAccessbool) *SpacesMembersDeleteCall
UseAdminAccess sets the optional parameter "useAdminAccess": When `true`,the method runs using the user's Google Workspace administrator privileges.The calling user must be a Google Workspace administrator with the managechat and spaces conversations privilege(https://support.google.com/a/answer/13369245). Requires the`chat.admin.memberships` OAuth 2.0 scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).Deleting app memberships in a space isn't supported using admin access.
typeSpacesMembersGetCall¶
type SpacesMembersGetCall struct {// contains filtered or unexported fields}func (*SpacesMembersGetCall)Context¶
func (c *SpacesMembersGetCall) Context(ctxcontext.Context) *SpacesMembersGetCall
Context sets the context to be used in this call's Do method.
func (*SpacesMembersGetCall)Do¶
func (c *SpacesMembersGetCall) Do(opts ...googleapi.CallOption) (*Membership,error)
Do executes the "chat.spaces.members.get" call.Any non-2xx status code is an error. Response headers are in either*Membership.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesMembersGetCall)Fields¶
func (c *SpacesMembersGetCall) Fields(s ...googleapi.Field) *SpacesMembersGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesMembersGetCall)Header¶
func (c *SpacesMembersGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesMembersGetCall)IfNoneMatch¶
func (c *SpacesMembersGetCall) IfNoneMatch(entityTagstring) *SpacesMembersGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*SpacesMembersGetCall)UseAdminAccess¶added inv0.194.0
func (c *SpacesMembersGetCall) UseAdminAccess(useAdminAccessbool) *SpacesMembersGetCall
UseAdminAccess sets the optional parameter "useAdminAccess": When `true`,the method runs using the user's Google Workspace administrator privileges.The calling user must be a Google Workspace administrator with the managechat and spaces conversations privilege(https://support.google.com/a/answer/13369245). Requires the`chat.admin.memberships` or `chat.admin.memberships.readonly` OAuth 2.0scopes(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).Getting app memberships in a space isn't supported when using admin access.
typeSpacesMembersListCall¶
type SpacesMembersListCall struct {// contains filtered or unexported fields}func (*SpacesMembersListCall)Context¶
func (c *SpacesMembersListCall) Context(ctxcontext.Context) *SpacesMembersListCall
Context sets the context to be used in this call's Do method.
func (*SpacesMembersListCall)Do¶
func (c *SpacesMembersListCall) Do(opts ...googleapi.CallOption) (*ListMembershipsResponse,error)
Do executes the "chat.spaces.members.list" call.Any non-2xx status code is an error. Response headers are in either*ListMembershipsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*SpacesMembersListCall)Fields¶
func (c *SpacesMembersListCall) Fields(s ...googleapi.Field) *SpacesMembersListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesMembersListCall)Filter¶added inv0.123.0
func (c *SpacesMembersListCall) Filter(filterstring) *SpacesMembersListCall
Filter sets the optional parameter "filter": A query filter. You can filtermemberships by a member's role (`role`(https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole))and type (`member.type`(https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)).To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filterby type, set `member.type` to `HUMAN` or `BOT`. You can also filter for`member.type` using the `!=` operator. To filter by both role and type, usethe `AND` operator. To filter by either role or type, use the `OR` operator.Either `member.type = "HUMAN" or `member.type != "BOT" is required when`use_admin_access` is set to true. Other member type filters will berejected. For example, the following queries are valid: ``` role ="ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role ="ROLE_MANAGER" member.type != "BOT" ``` The following queries are invalid:``` member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" ANDrole = "ROLE_MEMBER" ``` Invalid queries are rejected by the server with an`INVALID_ARGUMENT` error.
func (*SpacesMembersListCall)Header¶
func (c *SpacesMembersListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesMembersListCall)IfNoneMatch¶
func (c *SpacesMembersListCall) IfNoneMatch(entityTagstring) *SpacesMembersListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*SpacesMembersListCall)PageSize¶
func (c *SpacesMembersListCall) PageSize(pageSizeint64) *SpacesMembersListCall
PageSize sets the optional parameter "pageSize": The maximum number ofmemberships to return. The service might return fewer than this value. Ifunspecified, at most 100 memberships are returned. The maximum value is1000. If you use a value more than 1000, it's automatically changed to 1000.Negative values return an `INVALID_ARGUMENT` error.
func (*SpacesMembersListCall)PageToken¶
func (c *SpacesMembersListCall) PageToken(pageTokenstring) *SpacesMembersListCall
PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous call to list memberships. Provide this parameter to retrievethe subsequent page. When paginating, all other parameters provided shouldmatch the call that provided the page token. Passing different values to theother parameters might lead to unexpected results.
func (*SpacesMembersListCall)Pages¶
func (c *SpacesMembersListCall) Pages(ctxcontext.Context, f func(*ListMembershipsResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
func (*SpacesMembersListCall)ShowGroups¶added inv0.153.0
func (c *SpacesMembersListCall) ShowGroups(showGroupsbool) *SpacesMembersListCall
ShowGroups sets the optional parameter "showGroups": When `true`, alsoreturns memberships associated with a Google Group, in addition to othertypes of memberships. If a filter is set, Google Group memberships thatdon't match the filter criteria aren't returned.
func (*SpacesMembersListCall)ShowInvited¶added inv0.123.0
func (c *SpacesMembersListCall) ShowInvited(showInvitedbool) *SpacesMembersListCall
ShowInvited sets the optional parameter "showInvited": When `true`, alsoreturns memberships associated with invited members, in addition to othertypes of memberships. If a filter is set, invited memberships that don'tmatch the filter criteria aren't returned. Currently requires userauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
func (*SpacesMembersListCall)UseAdminAccess¶added inv0.194.0
func (c *SpacesMembersListCall) UseAdminAccess(useAdminAccessbool) *SpacesMembersListCall
UseAdminAccess sets the optional parameter "useAdminAccess": When `true`,the method runs using the user's Google Workspace administrator privileges.The calling user must be a Google Workspace administrator with the managechat and spaces conversations privilege(https://support.google.com/a/answer/13369245). Requires either the`chat.admin.memberships.readonly` or `chat.admin.memberships` OAuth 2.0scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).Listing app memberships in a space isn't supported when using admin access.
typeSpacesMembersPatchCall¶added inv0.175.0
type SpacesMembersPatchCall struct {// contains filtered or unexported fields}func (*SpacesMembersPatchCall)Context¶added inv0.175.0
func (c *SpacesMembersPatchCall) Context(ctxcontext.Context) *SpacesMembersPatchCall
Context sets the context to be used in this call's Do method.
func (*SpacesMembersPatchCall)Do¶added inv0.175.0
func (c *SpacesMembersPatchCall) Do(opts ...googleapi.CallOption) (*Membership,error)
Do executes the "chat.spaces.members.patch" call.Any non-2xx status code is an error. Response headers are in either*Membership.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesMembersPatchCall)Fields¶added inv0.175.0
func (c *SpacesMembersPatchCall) Fields(s ...googleapi.Field) *SpacesMembersPatchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesMembersPatchCall)Header¶added inv0.175.0
func (c *SpacesMembersPatchCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesMembersPatchCall)UpdateMask¶added inv0.175.0
func (c *SpacesMembersPatchCall) UpdateMask(updateMaskstring) *SpacesMembersPatchCall
UpdateMask sets the optional parameter "updateMask": Required. The fieldpaths to update. Separate multiple values with commas or use `*` to updateall field paths. Currently supported field paths: - `role`
func (*SpacesMembersPatchCall)UseAdminAccess¶added inv0.194.0
func (c *SpacesMembersPatchCall) UseAdminAccess(useAdminAccessbool) *SpacesMembersPatchCall
UseAdminAccess sets the optional parameter "useAdminAccess": When `true`,the method runs using the user's Google Workspace administrator privileges.The calling user must be a Google Workspace administrator with the managechat and spaces conversations privilege(https://support.google.com/a/answer/13369245). Requires the`chat.admin.memberships` OAuth 2.0 scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
typeSpacesMembersService¶
type SpacesMembersService struct {// contains filtered or unexported fields}funcNewSpacesMembersService¶
func NewSpacesMembersService(s *Service) *SpacesMembersService
func (*SpacesMembersService)Create¶added inv0.123.0
func (r *SpacesMembersService) Create(parentstring, membership *Membership) *SpacesMembersCreateCall
Create: Creates a membership for the calling Chat app, a user, or a GoogleGroup. Creating memberships for other Chat apps isn't supported. Whencreating a membership, if the specified member has their auto-accept policyturned off, then they're invited, and must accept the space invitationbefore joining. Otherwise, creating a membership adds the member directly tothe specified space. Supports the following types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with administrator approval (https://support.google.com/a?p=chat-app-auth)and the authorization scope: -`https://www.googleapis.com/auth/chat.app.memberships` - User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.memberships` -`https://www.googleapis.com/auth/chat.memberships.app` (to add the callingapp to the space) - `https://www.googleapis.com/auth/chat.import` (importmode spaces only) - User authentication grants administrator privileges whenan administrator account authenticates, `use_admin_access` is `true`, andthe following authorization scope is used: -`https://www.googleapis.com/auth/chat.admin.memberships` App authenticationis not supported for the following use cases: - Inviting users external tothe Workspace organization that owns the space. - Adding a Google Group to aspace. - Adding a Chat app to a space. For example usage, see: - Invite oradd a user to a space(https://developers.google.com/workspace/chat/create-members#create-user-membership).- Invite or add a Google Group to a space(https://developers.google.com/workspace/chat/create-members#create-group-membership).- Add the Chat app to a space(https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).
- parent: The resource name of the space for which to create the membership.Format: spaces/{space}.
func (*SpacesMembersService)Delete¶added inv0.123.0
func (r *SpacesMembersService) Delete(namestring) *SpacesMembersDeleteCall
Delete: Deletes a membership. For an example, see Remove a user or a GoogleChat app from a space(https://developers.google.com/workspace/chat/delete-members). Supports thefollowing types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with administrator approval (https://support.google.com/a?p=chat-app-auth)and the authorization scope: -`https://www.googleapis.com/auth/chat.app.memberships` - User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.memberships` -`https://www.googleapis.com/auth/chat.memberships.app` (to remove thecalling app from the space) - `https://www.googleapis.com/auth/chat.import`(import mode spaces only) - User authentication grants administratorprivileges when an administrator account authenticates, `use_admin_access`is `true`, and the following authorization scope is used: -`https://www.googleapis.com/auth/chat.admin.memberships` App authenticationis not supported for the following use cases: - Removing a Google Group froma space. - Removing a Chat app from a space. To delete memberships for spacemanagers, the requester must be a space manager. If you're using appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)the Chat app must be the space creator.
- name: Resource name of the membership to delete. Chat apps can deletehuman users' or their own memberships. Chat apps can't delete other apps'memberships. When deleting a human membership, requires the`chat.memberships` scope with user authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)or the `chat.memberships.app` scope with app authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)and the `spaces/{space}/members/{member}` format. You can use the email asan alias for `{member}`. For example,`spaces/{space}/members/example@gmail.com` where `example@gmail.com` isthe email of the Google Chat user. When deleting an app membership,requires the `chat.memberships.app` scope and `spaces/{space}/members/app`format. Format: `spaces/{space}/members/{member}` or`spaces/{space}/members/app`.
func (*SpacesMembersService)Get¶
func (r *SpacesMembersService) Get(namestring) *SpacesMembersGetCall
Get: Returns details about a membership. For an example, see Get detailsabout a user's or Google Chat app's membership(https://developers.google.com/workspace/chat/get-members). Supports thefollowing types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.bot` -`https://www.googleapis.com/auth/chat.app.memberships` (requiresadministrator approval (https://support.google.com/a?p=chat-app-auth)) -User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.memberships.readonly` -`https://www.googleapis.com/auth/chat.memberships` - User authenticationgrants administrator privileges when an administrator account authenticates,`use_admin_access` is `true`, and one of the following authorization scopesis used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly`- `https://www.googleapis.com/auth/chat.admin.memberships`
- name: Resource name of the membership to retrieve. To get the app's ownmembership by using user authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),you can optionally use `spaces/{space}/members/app`. Format:`spaces/{space}/members/{member}` or `spaces/{space}/members/app` You canuse the user's email as an alias for `{member}`. For example,`spaces/{space}/members/example@gmail.com` where `example@gmail.com` isthe email of the Google Chat user.
func (*SpacesMembersService)List¶
func (r *SpacesMembersService) List(parentstring) *SpacesMembersListCall
List: Lists memberships in a space. For an example, see List users andGoogle Chat apps in a space(https://developers.google.com/workspace/chat/list-members). Listingmemberships with app authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)lists memberships in spaces that the Chat app has access to, but excludesChat app memberships, including its own. Listing memberships with Userauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)lists memberships in spaces that the authenticated user has access to.Supports the following types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.bot` -`https://www.googleapis.com/auth/chat.app.memberships` (requiresadministrator approval (https://support.google.com/a?p=chat-app-auth)) -User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.memberships.readonly` -`https://www.googleapis.com/auth/chat.memberships` -`https://www.googleapis.com/auth/chat.import` (import mode spaces only) -User authentication grants administrator privileges when an administratoraccount authenticates, `use_admin_access` is `true`, and one of thefollowing authorization scopes is used: -`https://www.googleapis.com/auth/chat.admin.memberships.readonly` -`https://www.googleapis.com/auth/chat.admin.memberships`
- parent: The resource name of the space for which to fetch a membershiplist. Format: spaces/{space}.
func (*SpacesMembersService)Patch¶added inv0.175.0
func (r *SpacesMembersService) Patch(namestring, membership *Membership) *SpacesMembersPatchCall
Patch: Updates a membership. For an example, see Update a user's membershipin a space (https://developers.google.com/workspace/chat/update-members).Supports the following types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with administrator approval (https://support.google.com/a?p=chat-app-auth)and the authorization scope: -`https://www.googleapis.com/auth/chat.app.memberships` (only in spaces theapp created) - User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.memberships` -`https://www.googleapis.com/auth/chat.import` (import mode spaces only) -User authentication grants administrator privileges when an administratoraccount authenticates, `use_admin_access` is `true`, and the followingauthorization scope is used: -`https://www.googleapis.com/auth/chat.admin.memberships`
- name: Identifier. Resource name of the membership, assigned by the server.Format: `spaces/{space}/members/{member}`.
typeSpacesMessagesAttachmentsGetCall¶added inv0.30.0
type SpacesMessagesAttachmentsGetCall struct {// contains filtered or unexported fields}func (*SpacesMessagesAttachmentsGetCall)Context¶added inv0.30.0
func (c *SpacesMessagesAttachmentsGetCall) Context(ctxcontext.Context) *SpacesMessagesAttachmentsGetCall
Context sets the context to be used in this call's Do method.
func (*SpacesMessagesAttachmentsGetCall)Do¶added inv0.30.0
func (c *SpacesMessagesAttachmentsGetCall) Do(opts ...googleapi.CallOption) (*Attachment,error)
Do executes the "chat.spaces.messages.attachments.get" call.Any non-2xx status code is an error. Response headers are in either*Attachment.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesMessagesAttachmentsGetCall)Fields¶added inv0.30.0
func (c *SpacesMessagesAttachmentsGetCall) Fields(s ...googleapi.Field) *SpacesMessagesAttachmentsGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesMessagesAttachmentsGetCall)Header¶added inv0.30.0
func (c *SpacesMessagesAttachmentsGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesMessagesAttachmentsGetCall)IfNoneMatch¶added inv0.30.0
func (c *SpacesMessagesAttachmentsGetCall) IfNoneMatch(entityTagstring) *SpacesMessagesAttachmentsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeSpacesMessagesAttachmentsService¶added inv0.30.0
type SpacesMessagesAttachmentsService struct {// contains filtered or unexported fields}funcNewSpacesMessagesAttachmentsService¶added inv0.30.0
func NewSpacesMessagesAttachmentsService(s *Service) *SpacesMessagesAttachmentsService
func (*SpacesMessagesAttachmentsService)Get¶added inv0.30.0
func (r *SpacesMessagesAttachmentsService) Get(namestring) *SpacesMessagesAttachmentsGetCall
Get: Gets the metadata of a message attachment. The attachment data isfetched using the media API(https://developers.google.com/workspace/chat/api/reference/rest/v1/media/download).For an example, see Get metadata about a message attachment(https://developers.google.com/workspace/chat/get-media-attachments).Requires app authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with the authorization scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.bot`
- name: Resource name of the attachment, in the form`spaces/{space}/messages/{message}/attachments/{attachment}`.
typeSpacesMessagesCreateCall¶
type SpacesMessagesCreateCall struct {// contains filtered or unexported fields}func (*SpacesMessagesCreateCall)Context¶
func (c *SpacesMessagesCreateCall) Context(ctxcontext.Context) *SpacesMessagesCreateCall
Context sets the context to be used in this call's Do method.
func (*SpacesMessagesCreateCall)Do¶
func (c *SpacesMessagesCreateCall) Do(opts ...googleapi.CallOption) (*Message,error)
Do executes the "chat.spaces.messages.create" call.Any non-2xx status code is an error. Response headers are in either*Message.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesMessagesCreateCall)Fields¶
func (c *SpacesMessagesCreateCall) Fields(s ...googleapi.Field) *SpacesMessagesCreateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesMessagesCreateCall)Header¶
func (c *SpacesMessagesCreateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesMessagesCreateCall)MessageId¶added inv0.100.0
func (c *SpacesMessagesCreateCall) MessageId(messageIdstring) *SpacesMessagesCreateCall
MessageId sets the optional parameter "messageId": A custom ID for amessage. Lets Chat apps get, update, or delete a message without needing tostore the system-assigned ID in the message's resource name (represented inthe message `name` field). The value for this field must meet the followingrequirements: * Begins with `client-`. For example, `client-custom-name` isa valid custom ID, but `custom-name` is not. * Contains up to 63 charactersand only lowercase letters, numbers, and hyphens. * Is unique within aspace. A Chat app can't use the same custom ID for different messages. Fordetails, see Name a message(https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
func (*SpacesMessagesCreateCall)MessageReplyOption¶added inv0.101.0
func (c *SpacesMessagesCreateCall) MessageReplyOption(messageReplyOptionstring) *SpacesMessagesCreateCall
MessageReplyOption sets the optional parameter "messageReplyOption":Specifies whether a message starts a thread or replies to one. Onlysupported in named spaces. When responding to user interactions(https://developers.google.com/workspace/chat/receive-respond-interactions),this field is ignored. For interactions within a thread, the reply iscreated in the same thread. Otherwise, the reply is created as a new thread.
Possible values:
"MESSAGE_REPLY_OPTION_UNSPECIFIED" - Default. Starts a new thread. Using
this option ignores any thread ID or `thread_key` that's included.
"REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD" - Creates the message as a reply to
the thread specified by thread ID or `thread_key`. If it fails, the messagestarts a new thread instead.
"REPLY_MESSAGE_OR_FAIL" - Creates the message as a reply to the thread
specified by thread ID or `thread_key`. If a new `thread_key` is used, a newthread is created. If the message creation fails, a `NOT_FOUND` error isreturned instead.
func (*SpacesMessagesCreateCall)RequestId¶added inv0.60.0
func (c *SpacesMessagesCreateCall) RequestId(requestIdstring) *SpacesMessagesCreateCall
RequestId sets the optional parameter "requestId": A unique request ID forthis message. Specifying an existing request ID returns the message createdwith that ID instead of creating a new message.
func (*SpacesMessagesCreateCall)ThreadKey¶
func (c *SpacesMessagesCreateCall) ThreadKey(threadKeystring) *SpacesMessagesCreateCall
ThreadKey sets the optional parameter "threadKey": Deprecated: Usethread.thread_key instead. ID for the thread. Supports up to 4000characters. To start or add to a thread, create a message and specify a`threadKey` or the thread.name. For example usage, see Start or reply to amessage thread(https://developers.google.com/workspace/chat/create-messages#create-message-thread).
typeSpacesMessagesDeleteCall¶
type SpacesMessagesDeleteCall struct {// contains filtered or unexported fields}func (*SpacesMessagesDeleteCall)Context¶
func (c *SpacesMessagesDeleteCall) Context(ctxcontext.Context) *SpacesMessagesDeleteCall
Context sets the context to be used in this call's Do method.
func (*SpacesMessagesDeleteCall)Do¶
func (c *SpacesMessagesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty,error)
Do executes the "chat.spaces.messages.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesMessagesDeleteCall)Fields¶
func (c *SpacesMessagesDeleteCall) Fields(s ...googleapi.Field) *SpacesMessagesDeleteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesMessagesDeleteCall)Force¶added inv0.123.0
func (c *SpacesMessagesDeleteCall) Force(forcebool) *SpacesMessagesDeleteCall
Force sets the optional parameter "force": When `true`, deleting a messagealso deletes its threaded replies. When `false`, if a message has threadedreplies, deletion fails. Only applies when authenticating as a user(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).Has no effect when [authenticating as a Chat app](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
func (*SpacesMessagesDeleteCall)Header¶
func (c *SpacesMessagesDeleteCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeSpacesMessagesGetCall¶
type SpacesMessagesGetCall struct {// contains filtered or unexported fields}func (*SpacesMessagesGetCall)Context¶
func (c *SpacesMessagesGetCall) Context(ctxcontext.Context) *SpacesMessagesGetCall
Context sets the context to be used in this call's Do method.
func (*SpacesMessagesGetCall)Do¶
func (c *SpacesMessagesGetCall) Do(opts ...googleapi.CallOption) (*Message,error)
Do executes the "chat.spaces.messages.get" call.Any non-2xx status code is an error. Response headers are in either*Message.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesMessagesGetCall)Fields¶
func (c *SpacesMessagesGetCall) Fields(s ...googleapi.Field) *SpacesMessagesGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesMessagesGetCall)Header¶
func (c *SpacesMessagesGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesMessagesGetCall)IfNoneMatch¶
func (c *SpacesMessagesGetCall) IfNoneMatch(entityTagstring) *SpacesMessagesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeSpacesMessagesListCall¶added inv0.123.0
type SpacesMessagesListCall struct {// contains filtered or unexported fields}func (*SpacesMessagesListCall)Context¶added inv0.123.0
func (c *SpacesMessagesListCall) Context(ctxcontext.Context) *SpacesMessagesListCall
Context sets the context to be used in this call's Do method.
func (*SpacesMessagesListCall)Do¶added inv0.123.0
func (c *SpacesMessagesListCall) Do(opts ...googleapi.CallOption) (*ListMessagesResponse,error)
Do executes the "chat.spaces.messages.list" call.Any non-2xx status code is an error. Response headers are in either*ListMessagesResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*SpacesMessagesListCall)Fields¶added inv0.123.0
func (c *SpacesMessagesListCall) Fields(s ...googleapi.Field) *SpacesMessagesListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesMessagesListCall)Filter¶added inv0.123.0
func (c *SpacesMessagesListCall) Filter(filterstring) *SpacesMessagesListCall
Filter sets the optional parameter "filter": A query filter. You can filtermessages by date (`create_time`) and thread (`thread.name`). To filtermessages by the date they were created, specify the `create_time` with atimestamp in RFC-3339 (https://www.rfc-editor.org/rfc/rfc3339) format anddouble quotation marks. For example, "2023-04-21T11:30:00-04:00". You canuse the greater than operator `>` to list messages that were created after atimestamp, or the less than operator `<` to list messages that were createdbefore a timestamp. To filter messages within a time interval, use the `AND`operator between two timestamps. To filter by thread, specify the`thread.name`, formatted as `spaces/{space}/threads/{thread}`. You can onlyspecify one `thread.name` per query. To filter by both thread and date, usethe `AND` operator in your query. For example, the following queries arevalid: ``` create_time > "2012-04-21T11:30:00-04:00" create_time >"2012-04-21T11:30:00-04:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123create_time > "2012-04-21T11:30:00+00:00" AND create_time <"2013-01-01T00:00:00+00:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123thread.name = spaces/AAAAAAAAAAA/threads/123 ``` Invalid queries arerejected by the server with an `INVALID_ARGUMENT` error.
func (*SpacesMessagesListCall)Header¶added inv0.123.0
func (c *SpacesMessagesListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesMessagesListCall)IfNoneMatch¶added inv0.123.0
func (c *SpacesMessagesListCall) IfNoneMatch(entityTagstring) *SpacesMessagesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*SpacesMessagesListCall)OrderBy¶added inv0.123.0
func (c *SpacesMessagesListCall) OrderBy(orderBystring) *SpacesMessagesListCall
OrderBy sets the optional parameter "orderBy": How the list of messages isordered. Specify a value to order by an ordering operation. Valid orderingoperation values are as follows: - `ASC` for ascending. - `DESC` fordescending. The default ordering is `create_time ASC`.
func (*SpacesMessagesListCall)PageSize¶added inv0.123.0
func (c *SpacesMessagesListCall) PageSize(pageSizeint64) *SpacesMessagesListCall
PageSize sets the optional parameter "pageSize": The maximum number ofmessages returned. The service might return fewer messages than this value.If unspecified, at most 25 are returned. The maximum value is 1000. If youuse a value more than 1000, it's automatically changed to 1000. Negativevalues return an `INVALID_ARGUMENT` error.
func (*SpacesMessagesListCall)PageToken¶added inv0.123.0
func (c *SpacesMessagesListCall) PageToken(pageTokenstring) *SpacesMessagesListCall
PageToken sets the optional parameter "pageToken": A page token receivedfrom a previous list messages call. Provide this parameter to retrieve thesubsequent page. When paginating, all other parameters provided should matchthe call that provided the page token. Passing different values to the otherparameters might lead to unexpected results.
func (*SpacesMessagesListCall)Pages¶added inv0.123.0
func (c *SpacesMessagesListCall) Pages(ctxcontext.Context, f func(*ListMessagesResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
func (*SpacesMessagesListCall)ShowDeleted¶added inv0.123.0
func (c *SpacesMessagesListCall) ShowDeleted(showDeletedbool) *SpacesMessagesListCall
ShowDeleted sets the optional parameter "showDeleted": Whether to includedeleted messages. Deleted messages include deleted time and metadata abouttheir deletion, but message content is unavailable.
typeSpacesMessagesPatchCall¶added inv0.104.0
type SpacesMessagesPatchCall struct {// contains filtered or unexported fields}func (*SpacesMessagesPatchCall)AllowMissing¶added inv0.104.0
func (c *SpacesMessagesPatchCall) AllowMissing(allowMissingbool) *SpacesMessagesPatchCall
AllowMissing sets the optional parameter "allowMissing": If `true` and themessage isn't found, a new message is created and `updateMask` is ignored.The specified message ID must be client-assigned(https://developers.google.com/workspace/chat/create-messages#name_a_created_message)or the request fails.
func (*SpacesMessagesPatchCall)Context¶added inv0.104.0
func (c *SpacesMessagesPatchCall) Context(ctxcontext.Context) *SpacesMessagesPatchCall
Context sets the context to be used in this call's Do method.
func (*SpacesMessagesPatchCall)Do¶added inv0.104.0
func (c *SpacesMessagesPatchCall) Do(opts ...googleapi.CallOption) (*Message,error)
Do executes the "chat.spaces.messages.patch" call.Any non-2xx status code is an error. Response headers are in either*Message.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesMessagesPatchCall)Fields¶added inv0.104.0
func (c *SpacesMessagesPatchCall) Fields(s ...googleapi.Field) *SpacesMessagesPatchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesMessagesPatchCall)Header¶added inv0.104.0
func (c *SpacesMessagesPatchCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesMessagesPatchCall)UpdateMask¶added inv0.104.0
func (c *SpacesMessagesPatchCall) UpdateMask(updateMaskstring) *SpacesMessagesPatchCall
UpdateMask sets the optional parameter "updateMask": Required. The fieldpaths to update. Separate multiple values with commas or use `*` to updateall field paths. Currently supported field paths: - `text` - `attachment` -`cards` (Requires app authentication(/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires appauthentication (/chat/api/guides/auth/service-accounts).) -`accessory_widgets` (Requires app authentication(/chat/api/guides/auth/service-accounts).) - `quoted_message_metadata` (Onlyallows removal of the quoted message.)
typeSpacesMessagesReactionsCreateCall¶added inv0.123.0
type SpacesMessagesReactionsCreateCall struct {// contains filtered or unexported fields}func (*SpacesMessagesReactionsCreateCall)Context¶added inv0.123.0
func (c *SpacesMessagesReactionsCreateCall) Context(ctxcontext.Context) *SpacesMessagesReactionsCreateCall
Context sets the context to be used in this call's Do method.
func (*SpacesMessagesReactionsCreateCall)Do¶added inv0.123.0
func (c *SpacesMessagesReactionsCreateCall) Do(opts ...googleapi.CallOption) (*Reaction,error)
Do executes the "chat.spaces.messages.reactions.create" call.Any non-2xx status code is an error. Response headers are in either*Reaction.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesMessagesReactionsCreateCall)Fields¶added inv0.123.0
func (c *SpacesMessagesReactionsCreateCall) Fields(s ...googleapi.Field) *SpacesMessagesReactionsCreateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesMessagesReactionsCreateCall)Header¶added inv0.123.0
func (c *SpacesMessagesReactionsCreateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeSpacesMessagesReactionsDeleteCall¶added inv0.123.0
type SpacesMessagesReactionsDeleteCall struct {// contains filtered or unexported fields}func (*SpacesMessagesReactionsDeleteCall)Context¶added inv0.123.0
func (c *SpacesMessagesReactionsDeleteCall) Context(ctxcontext.Context) *SpacesMessagesReactionsDeleteCall
Context sets the context to be used in this call's Do method.
func (*SpacesMessagesReactionsDeleteCall)Do¶added inv0.123.0
func (c *SpacesMessagesReactionsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty,error)
Do executes the "chat.spaces.messages.reactions.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesMessagesReactionsDeleteCall)Fields¶added inv0.123.0
func (c *SpacesMessagesReactionsDeleteCall) Fields(s ...googleapi.Field) *SpacesMessagesReactionsDeleteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesMessagesReactionsDeleteCall)Header¶added inv0.123.0
func (c *SpacesMessagesReactionsDeleteCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeSpacesMessagesReactionsListCall¶added inv0.123.0
type SpacesMessagesReactionsListCall struct {// contains filtered or unexported fields}func (*SpacesMessagesReactionsListCall)Context¶added inv0.123.0
func (c *SpacesMessagesReactionsListCall) Context(ctxcontext.Context) *SpacesMessagesReactionsListCall
Context sets the context to be used in this call's Do method.
func (*SpacesMessagesReactionsListCall)Do¶added inv0.123.0
func (c *SpacesMessagesReactionsListCall) Do(opts ...googleapi.CallOption) (*ListReactionsResponse,error)
Do executes the "chat.spaces.messages.reactions.list" call.Any non-2xx status code is an error. Response headers are in either*ListReactionsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*SpacesMessagesReactionsListCall)Fields¶added inv0.123.0
func (c *SpacesMessagesReactionsListCall) Fields(s ...googleapi.Field) *SpacesMessagesReactionsListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesMessagesReactionsListCall)Filter¶added inv0.123.0
func (c *SpacesMessagesReactionsListCall) Filter(filterstring) *SpacesMessagesReactionsListCall
Filter sets the optional parameter "filter": A query filter. You can filterreactions by emoji(https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji)(either `emoji.unicode` or `emoji.custom_emoji.uid`) and user(https://developers.google.com/workspace/chat/api/reference/rest/v1/User)(`user.name`). To filter reactions for multiple emojis or users, joinsimilar fields with the `OR` operator, such as `emoji.unicode = "🙂" ORemoji.unicode = "👍" and `user.name = "users/AAAAAA" OR user.name ="users/BBBBBB". To filter reactions by emoji and user, use the `AND`operator, such as `emoji.unicode = "🙂" AND user.name = "users/AAAAAA".If your query uses both `AND` and `OR`, group them with parentheses. Forexample, the following queries are valid: ``` user.name = "users/{user}"emoji.unicode = "🙂" emoji.custom_emoji.uid = "{uid}" emoji.unicode ="🙂" OR emoji.unicode = "👍" emoji.unicode = "🙂" ORemoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" AND user.name ="users/{user}" (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")AND user.name = "users/{user}" ``` The following queries are invalid: ```emoji.unicode = "🙂" AND emoji.unicode = "👍" emoji.unicode = "🙂" ANDemoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR user.name ="users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" ORuser.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid= "{uid}" AND user.name = "users/{user}" ``` Invalid queries are rejectedwith an `INVALID_ARGUMENT` error.
func (*SpacesMessagesReactionsListCall)Header¶added inv0.123.0
func (c *SpacesMessagesReactionsListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesMessagesReactionsListCall)IfNoneMatch¶added inv0.123.0
func (c *SpacesMessagesReactionsListCall) IfNoneMatch(entityTagstring) *SpacesMessagesReactionsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*SpacesMessagesReactionsListCall)PageSize¶added inv0.123.0
func (c *SpacesMessagesReactionsListCall) PageSize(pageSizeint64) *SpacesMessagesReactionsListCall
PageSize sets the optional parameter "pageSize": The maximum number ofreactions returned. The service can return fewer reactions than this value.If unspecified, the default value is 25. The maximum value is 200; valuesabove 200 are changed to 200.
func (*SpacesMessagesReactionsListCall)PageToken¶added inv0.123.0
func (c *SpacesMessagesReactionsListCall) PageToken(pageTokenstring) *SpacesMessagesReactionsListCall
PageToken sets the optional parameter "pageToken": (If resuming from aprevious query.) A page token received from a previous list reactions call.Provide this to retrieve the subsequent page. When paginating, the filtervalue should match the call that provided the page token. Passing adifferent value might lead to unexpected results.
func (*SpacesMessagesReactionsListCall)Pages¶added inv0.123.0
func (c *SpacesMessagesReactionsListCall) Pages(ctxcontext.Context, f func(*ListReactionsResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
typeSpacesMessagesReactionsService¶added inv0.123.0
type SpacesMessagesReactionsService struct {// contains filtered or unexported fields}funcNewSpacesMessagesReactionsService¶added inv0.123.0
func NewSpacesMessagesReactionsService(s *Service) *SpacesMessagesReactionsService
func (*SpacesMessagesReactionsService)Create¶added inv0.123.0
func (r *SpacesMessagesReactionsService) Create(parentstring, reaction *Reaction) *SpacesMessagesReactionsCreateCall
Create: Creates a reaction and adds it to a message. For an example, see Adda reaction to a message(https://developers.google.com/workspace/chat/create-reactions). Requiresuser authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.messages.reactions.create` -`https://www.googleapis.com/auth/chat.messages.reactions` -`https://www.googleapis.com/auth/chat.messages` -`https://www.googleapis.com/auth/chat.import` (import mode spaces only)
- parent: The message where the reaction is created. Format:`spaces/{space}/messages/{message}`.
func (*SpacesMessagesReactionsService)Delete¶added inv0.123.0
func (r *SpacesMessagesReactionsService) Delete(namestring) *SpacesMessagesReactionsDeleteCall
Delete: Deletes a reaction to a message. For an example, see Delete areaction (https://developers.google.com/workspace/chat/delete-reactions).Requires user authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.messages.reactions` -`https://www.googleapis.com/auth/chat.messages` -`https://www.googleapis.com/auth/chat.import` (import mode spaces only)
- name: Name of the reaction to delete. Format:`spaces/{space}/messages/{message}/reactions/{reaction}`.
func (*SpacesMessagesReactionsService)List¶added inv0.123.0
func (r *SpacesMessagesReactionsService) List(parentstring) *SpacesMessagesReactionsListCall
List: Lists reactions to a message. For an example, see List reactions for amessage (https://developers.google.com/workspace/chat/list-reactions).Requires user authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.messages.reactions.readonly` -`https://www.googleapis.com/auth/chat.messages.reactions` -`https://www.googleapis.com/auth/chat.messages.readonly` -`https://www.googleapis.com/auth/chat.messages`
- parent: The message users reacted to. Format:`spaces/{space}/messages/{message}`.
typeSpacesMessagesService¶
type SpacesMessagesService struct {Attachments *SpacesMessagesAttachmentsServiceReactions *SpacesMessagesReactionsService// contains filtered or unexported fields}funcNewSpacesMessagesService¶
func NewSpacesMessagesService(s *Service) *SpacesMessagesService
func (*SpacesMessagesService)Create¶
func (r *SpacesMessagesService) Create(parentstring, message *Message) *SpacesMessagesCreateCall
Create: Creates a message in a Google Chat space. For an example, see Send amessage (https://developers.google.com/workspace/chat/create-messages).Supports the following types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` -User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.messages.create` -`https://www.googleapis.com/auth/chat.messages` -`https://www.googleapis.com/auth/chat.import` (import mode spaces only) Chatattributes the message sender differently depending on the type ofauthentication that you use in your request. The following image shows howChat attributes a message when you use app authentication. Chat displays theChat app as the message sender. The content of the message can contain text(`text`), cards (`cardsV2`), and accessory widgets (`accessoryWidgets`).!Message sent with app authentication(https://developers.google.com/workspace/chat/images/message-app-auth.svg)The following image shows how Chat attributes a message when you use userauthentication. Chat displays the user as the message sender and attributesthe Chat app to the message by displaying its name. The content of messagecan only contain text (`text`). !Message sent with user authentication(https://developers.google.com/workspace/chat/images/message-user-auth.svg)The maximum message size, including the message contents, is 32,000 bytes.For webhook(https://developers.google.com/workspace/chat/quickstart/webhooks) requests,the response doesn't contain the full message. The response only populatesthe `name` and `thread.name` fields in addition to the information that wasin the request.
- parent: The resource name of the space in which to create a message.Format: `spaces/{space}`.
func (*SpacesMessagesService)Delete¶
func (r *SpacesMessagesService) Delete(namestring) *SpacesMessagesDeleteCall
Delete: Deletes a message. For an example, see Delete a message(https://developers.google.com/workspace/chat/delete-messages). Supports thefollowing types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` -User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.messages` -`https://www.googleapis.com/auth/chat.import` (import mode spaces only) Whenusing app authentication, requests can only delete messages created by thecalling Chat app.
- name: Resource name of the message. Format:`spaces/{space}/messages/{message}` If you've set a custom ID for yourmessage, you can use the value from the `clientAssignedMessageId` fieldfor `{message}`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
func (*SpacesMessagesService)Get¶
func (r *SpacesMessagesService) Get(namestring) *SpacesMessagesGetCall
Get: Returns details about a message. For an example, see Get details abouta message (https://developers.google.com/workspace/chat/get-messages).Supports the following types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.bot`: When using this authorizationscope, this method returns details about a message the Chat app has accessto, like direct messages and slash commands(https://developers.google.com/workspace/chat/slash-commands) that invokethe Chat app. - `https://www.googleapis.com/auth/chat.app.messages.readonly`with administrator approval (https://support.google.com/a?p=chat-app-auth)(available in Developer Preview(https://developers.google.com/workspace/preview)). When using thisauthentication scope, this method returns details about a public message ina space. - User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.messages.readonly` -`https://www.googleapis.com/auth/chat.messages` Note: Might return a messagefrom a blocked member or space.
- name: Resource name of the message. Format:`spaces/{space}/messages/{message}` If you've set a custom ID for yourmessage, you can use the value from the `clientAssignedMessageId` fieldfor `{message}`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
func (*SpacesMessagesService)List¶added inv0.123.0
func (r *SpacesMessagesService) List(parentstring) *SpacesMessagesListCall
List: Lists messages in a space that the caller is a member of, includingmessages from blocked members and spaces. System messages, like thoseannouncing new space members, aren't included. If you list messages from aspace with no messages, the response is an empty object. When using aREST/HTTP interface, the response contains an empty JSON object, `{}`. Foran example, see List messages(https://developers.google.com/workspace/chat/api/guides/v1/messages/list).Supports the following types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with administrator approval (https://support.google.com/a?p=chat-app-auth)in Developer Preview (https://developers.google.com/workspace/preview) withthe authorization scope: -`https://www.googleapis.com/auth/chat.app.messages.readonly`. When usingthis authentication scope, this method only returns public messages in aspace. It doesn't include private messages. - User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.messages.readonly` -`https://www.googleapis.com/auth/chat.messages` -`https://www.googleapis.com/auth/chat.import` (import mode spaces only)
- parent: The resource name of the space to list messages from. Format:`spaces/{space}`.
func (*SpacesMessagesService)Patch¶added inv0.104.0
func (r *SpacesMessagesService) Patch(namestring, message *Message) *SpacesMessagesPatchCall
Patch: Updates a message. There's a difference between the `patch` and`update` methods. The `patch` method uses a `patch` request while the`update` method uses a `put` request. We recommend using the `patch` method.For an example, see Update a message(https://developers.google.com/workspace/chat/update-messages). Supports thefollowing types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` -User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.messages` -`https://www.googleapis.com/auth/chat.import` (import mode spaces only) Whenusing app authentication, requests can only update messages created by thecalling Chat app.
- name: Identifier. Resource name of the message. Format:`spaces/{space}/messages/{message}` Where `{space}` is the ID of the spacewhere the message is posted and `{message}` is a system-assigned ID forthe message. For example,`spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a customID when you create a message, you can use this ID to specify the messagein a request by replacing `{message}` with the value from the`clientAssignedMessageId` field. For example,`spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see Name amessage(https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
func (*SpacesMessagesService)Update¶
func (r *SpacesMessagesService) Update(namestring, message *Message) *SpacesMessagesUpdateCall
Update: Updates a message. There's a difference between the `patch` and`update` methods. The `patch` method uses a `patch` request while the`update` method uses a `put` request. We recommend using the `patch` method.For an example, see Update a message(https://developers.google.com/workspace/chat/update-messages). Supports thefollowing types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` -User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.messages` -`https://www.googleapis.com/auth/chat.import` (import mode spaces only) Whenusing app authentication, requests can only update messages created by thecalling Chat app.
- name: Identifier. Resource name of the message. Format:`spaces/{space}/messages/{message}` Where `{space}` is the ID of the spacewhere the message is posted and `{message}` is a system-assigned ID forthe message. For example,`spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a customID when you create a message, you can use this ID to specify the messagein a request by replacing `{message}` with the value from the`clientAssignedMessageId` field. For example,`spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see Name amessage(https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
typeSpacesMessagesUpdateCall¶
type SpacesMessagesUpdateCall struct {// contains filtered or unexported fields}func (*SpacesMessagesUpdateCall)AllowMissing¶added inv0.100.0
func (c *SpacesMessagesUpdateCall) AllowMissing(allowMissingbool) *SpacesMessagesUpdateCall
AllowMissing sets the optional parameter "allowMissing": If `true` and themessage isn't found, a new message is created and `updateMask` is ignored.The specified message ID must be client-assigned(https://developers.google.com/workspace/chat/create-messages#name_a_created_message)or the request fails.
func (*SpacesMessagesUpdateCall)Context¶
func (c *SpacesMessagesUpdateCall) Context(ctxcontext.Context) *SpacesMessagesUpdateCall
Context sets the context to be used in this call's Do method.
func (*SpacesMessagesUpdateCall)Do¶
func (c *SpacesMessagesUpdateCall) Do(opts ...googleapi.CallOption) (*Message,error)
Do executes the "chat.spaces.messages.update" call.Any non-2xx status code is an error. Response headers are in either*Message.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesMessagesUpdateCall)Fields¶
func (c *SpacesMessagesUpdateCall) Fields(s ...googleapi.Field) *SpacesMessagesUpdateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesMessagesUpdateCall)Header¶
func (c *SpacesMessagesUpdateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesMessagesUpdateCall)UpdateMask¶
func (c *SpacesMessagesUpdateCall) UpdateMask(updateMaskstring) *SpacesMessagesUpdateCall
UpdateMask sets the optional parameter "updateMask": Required. The fieldpaths to update. Separate multiple values with commas or use `*` to updateall field paths. Currently supported field paths: - `text` - `attachment` -`cards` (Requires app authentication(/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires appauthentication (/chat/api/guides/auth/service-accounts).) -`accessory_widgets` (Requires app authentication(/chat/api/guides/auth/service-accounts).) - `quoted_message_metadata` (Onlyallows removal of the quoted message.)
typeSpacesPatchCall¶added inv0.123.0
type SpacesPatchCall struct {// contains filtered or unexported fields}func (*SpacesPatchCall)Context¶added inv0.123.0
func (c *SpacesPatchCall) Context(ctxcontext.Context) *SpacesPatchCall
Context sets the context to be used in this call's Do method.
func (*SpacesPatchCall)Do¶added inv0.123.0
func (c *SpacesPatchCall) Do(opts ...googleapi.CallOption) (*Space,error)
Do executes the "chat.spaces.patch" call.Any non-2xx status code is an error. Response headers are in either*Space.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesPatchCall)Fields¶added inv0.123.0
func (c *SpacesPatchCall) Fields(s ...googleapi.Field) *SpacesPatchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesPatchCall)Header¶added inv0.123.0
func (c *SpacesPatchCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesPatchCall)UpdateMask¶added inv0.123.0
func (c *SpacesPatchCall) UpdateMask(updateMaskstring) *SpacesPatchCall
UpdateMask sets the optional parameter "updateMask": Required. The updatedfield paths, comma separated if there are multiple. You can update thefollowing fields for a space: `space_details`: Updates the space'sdescription and guidelines. You must pass both description and guidelines inthe update request as `SpaceDetails`. If you only want to update one of thefields, pass the existing value for the other field. `display_name`: Onlysupports updating the display name for spaces where `spaceType` field is`SPACE`. If you receive the error message `ALREADY_EXISTS`, try a differentvalue. An existing space within the Google Workspace organization mightalready use this display name. `space_type`: Only supports changing a`GROUP_CHAT` space type to `SPACE`. Include `display_name` together with`space_type` in the update mask and ensure that the specified space has anon-empty display name and the `SPACE` space type. Including the`space_type` mask and the `SPACE` type in the specified space when updatingthe display name is optional if the existing space already has the `SPACE`type. Trying to update the space type in other ways results in an invalidargument error. `space_type` is not supported with `useAdminAccess`.`space_history_state`: Updates space history settings(https://support.google.com/chat/answer/7664687) by turning history on oroff for the space. Only supported if history settings are enabled for theGoogle Workspace organization. To update the space history state, you mustomit all other field masks in your request. `space_history_state` is notsupported with `useAdminAccess`. `access_settings.audience`: Updates theaccess setting (https://support.google.com/chat/answer/11971020) of who candiscover the space, join the space, and preview the messages in named spacewhere `spaceType` field is `SPACE`. If the existing space has a targetaudience, you can remove the audience and restrict space access by omittinga value for this field mask. To update access settings for a space, theauthenticating user must be a space manager and omit all other field masksin your request. You can't update this field if the space is in import mode(https://developers.google.com/workspace/chat/import-data-overview). Tolearn more, see Make a space discoverable to specific users(https://developers.google.com/workspace/chat/space-target-audience).`access_settings.audience` is not supported with `useAdminAccess`.`permission_settings`: Supports changing the permission settings(https://support.google.com/chat/answer/13340792) of a space. When updatingpermission settings, you can only specify `permissionSettings` field masks;you cannot update other field masks at the same time. `permissionSettings`is not supported with `useAdminAccess`. The supported field masks include: -`permission_settings.manageMembersAndGroups` -`permission_settings.modifySpaceDetails` -`permission_settings.toggleHistory` - `permission_settings.useAtMentionAll`- `permission_settings.manageApps` - `permission_settings.manageWebhooks` -`permission_settings.replyMessages`
func (*SpacesPatchCall)UseAdminAccess¶added inv0.194.0
func (c *SpacesPatchCall) UseAdminAccess(useAdminAccessbool) *SpacesPatchCall
UseAdminAccess sets the optional parameter "useAdminAccess": When `true`,the method runs using the user's Google Workspace administrator privileges.The calling user must be a Google Workspace administrator with the managechat and spaces conversations privilege(https://support.google.com/a/answer/13369245). Requires the`chat.admin.spaces` OAuth 2.0 scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).Some `FieldMask` values are not supported using admin access. For details,see the description of `update_mask`.
typeSpacesSearchCall¶added inv0.194.0
type SpacesSearchCall struct {// contains filtered or unexported fields}func (*SpacesSearchCall)Context¶added inv0.194.0
func (c *SpacesSearchCall) Context(ctxcontext.Context) *SpacesSearchCall
Context sets the context to be used in this call's Do method.
func (*SpacesSearchCall)Do¶added inv0.194.0
func (c *SpacesSearchCall) Do(opts ...googleapi.CallOption) (*SearchSpacesResponse,error)
Do executes the "chat.spaces.search" call.Any non-2xx status code is an error. Response headers are in either*SearchSpacesResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*SpacesSearchCall)Fields¶added inv0.194.0
func (c *SpacesSearchCall) Fields(s ...googleapi.Field) *SpacesSearchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesSearchCall)Header¶added inv0.194.0
func (c *SpacesSearchCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesSearchCall)IfNoneMatch¶added inv0.194.0
func (c *SpacesSearchCall) IfNoneMatch(entityTagstring) *SpacesSearchCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*SpacesSearchCall)OrderBy¶added inv0.194.0
func (c *SpacesSearchCall) OrderBy(orderBystring) *SpacesSearchCall
OrderBy sets the optional parameter "orderBy": How the list of spaces isordered. Supported attributes to order by are: -`membership_count.joined_direct_human_user_count` — Denotes the count ofhuman users that have directly joined a space. - `last_active_time` —Denotes the time when last eligible item is added to any topic of thisspace. - `create_time` — Denotes the time of the space creation. Validordering operation values are: - `ASC` for ascending. Default value. -`DESC` for descending. The supported syntax are: -`membership_count.joined_direct_human_user_count DESC` -`membership_count.joined_direct_human_user_count ASC` - `last_active_timeDESC` - `last_active_time ASC` - `create_time DESC` - `create_time ASC`
func (*SpacesSearchCall)PageSize¶added inv0.194.0
func (c *SpacesSearchCall) PageSize(pageSizeint64) *SpacesSearchCall
PageSize sets the optional parameter "pageSize": The maximum number ofspaces to return. The service may return fewer than this value. Ifunspecified, at most 100 spaces are returned. The maximum value is 1000. Ifyou use a value more than 1000, it's automatically changed to 1000.
func (*SpacesSearchCall)PageToken¶added inv0.194.0
func (c *SpacesSearchCall) PageToken(pageTokenstring) *SpacesSearchCall
PageToken sets the optional parameter "pageToken": A token, received fromthe previous search spaces call. Provide this parameter to retrieve thesubsequent page. When paginating, all other parameters provided should matchthe call that provided the page token. Passing different values to the otherparameters might lead to unexpected results.
func (*SpacesSearchCall)Pages¶added inv0.194.0
func (c *SpacesSearchCall) Pages(ctxcontext.Context, f func(*SearchSpacesResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
func (*SpacesSearchCall)Query¶added inv0.194.0
func (c *SpacesSearchCall) Query(querystring) *SpacesSearchCall
Query sets the optional parameter "query": Required. A search query. You cansearch by using the following parameters: - `create_time` - `customer` -`display_name` - `external_user_allowed` - `last_active_time` -`space_history_state` - `space_type` `create_time` and `last_active_time`accept a timestamp in RFC-3339 (https://www.rfc-editor.org/rfc/rfc3339)format and the supported comparison operators are: `=`, `<`, `>`, `<=`,`>=`. `customer` is required and is used to indicate which customer to fetchspaces from. `customers/my_customer` is the only supported value.`display_name` only accepts the `HAS` (`:`) operator. The text to match isfirst tokenized into tokens and each token is prefix-matchedcase-insensitively and independently as a substring anywhere in the space's`display_name`. For example, `Fun Eve` matches `Fun event` or `The eveningwas fun`, but not `notFun event` or `even`. `external_user_allowed` acceptseither `true` or `false`. `space_history_state` only accepts values from the[`historyState`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState)field of a `space` resource. `space_type` is required and the only validvalue is `SPACE`. Across different fields, only `AND` operators aresupported. A valid example is `space_type = "SPACE" ANDdisplay_name:"Hello" and an invalid example is `space_type = "SPACE" ORdisplay_name:"Hello". Among the same field, `space_type` doesn't support`AND` or `OR` operators. `display_name`, 'space_history_state', and'external_user_allowed' only support `OR` operators. `last_active_time` and`create_time` support both `AND` and `OR` operators. `AND` can only be usedto represent an interval, such as `last_active_time <"2022-01-01T00:00:00+00:00" AND last_active_time >"2023-01-01T00:00:00+00:00". The following example queries are valid: ```customer = "customers/my_customer" AND space_type = "SPACE" customer ="customers/my_customer" AND space_type = "SPACE" AND display_name:"HelloWorld" customer = "customers/my_customer" AND space_type = "SPACE" AND(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >"2022-01-01T00:00:00+00:00") customer = "customers/my_customer" ANDspace_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Funevent") AND (last_active_time > "2020-01-01T00:00:00+00:00" ANDlast_active_time < "2022-01-01T00:00:00+00:00") customer ="customers/my_customer" AND space_type = "SPACE" AND (create_time >"2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00")AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON"OR space_history_state = "HISTORY_OFF") ```
func (*SpacesSearchCall)UseAdminAccess¶added inv0.194.0
func (c *SpacesSearchCall) UseAdminAccess(useAdminAccessbool) *SpacesSearchCall
UseAdminAccess sets the optional parameter "useAdminAccess": When `true`,the method runs using the user's Google Workspace administrator privileges.The calling user must be a Google Workspace administrator with the managechat and spaces conversations privilege(https://support.google.com/a/answer/13369245). Requires either the`chat.admin.spaces.readonly` or `chat.admin.spaces` OAuth 2.0 scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).This method currently only supports admin access, thus only `true` isaccepted for this field.
typeSpacesService¶
type SpacesService struct {Members *SpacesMembersServiceMessages *SpacesMessagesServiceSpaceEvents *SpacesSpaceEventsService// contains filtered or unexported fields}funcNewSpacesService¶
func NewSpacesService(s *Service) *SpacesService
func (*SpacesService)CompleteImport¶added inv0.156.0
func (r *SpacesService) CompleteImport(namestring, completeimportspacerequest *CompleteImportSpaceRequest) *SpacesCompleteImportCall
CompleteImport: Completes the import process(https://developers.google.com/workspace/chat/import-data) for the specifiedspace and makes it visible to users. Requires user authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)and domain-wide delegation with the authorization scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.import` For more information, seeAuthorize Google Chat apps to import data(https://developers.google.com/workspace/chat/authorize-import).
- name: Resource name of the import mode space. Format: `spaces/{space}`.
func (*SpacesService)Create¶added inv0.123.0
func (r *SpacesService) Create(space *Space) *SpacesCreateCall
Create: Creates a space. Can be used to create a named space, or a groupchat in `Import mode`. For an example, see Create a space(https://developers.google.com/workspace/chat/create-spaces). Supports thefollowing types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with administrator approval (https://support.google.com/a?p=chat-app-auth)and one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.app.spaces.create` -`https://www.googleapis.com/auth/chat.app.spaces` - User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.spaces.create` -`https://www.googleapis.com/auth/chat.spaces` -`https://www.googleapis.com/auth/chat.import` (import mode spaces only) Whenauthenticating as an app, the `space.customer` field must be set in therequest. When authenticating as an app, the Chat app is added as a member ofthe space. However, unlike human authentication, the Chat app is not addedas a space manager. By default, the Chat app can be removed from the spaceby all space members. To allow only space managers to remove the app from aspace, set `space.permission_settings.manage_apps` to `managers_allowed`.Space membership upon creation depends on whether the space is created in`Import mode`: * **Import mode:** No members are created. * **All othermodes:** The calling user is added as a member. This is: * The app itselfwhen using app authentication. * The human user when using userauthentication. If you receive the error message `ALREADY_EXISTS` whencreating a space, try a different `displayName`. An existing space withinthe Google Workspace organization might already use this display name.
func (*SpacesService)Delete¶added inv0.123.0
func (r *SpacesService) Delete(namestring) *SpacesDeleteCall
Delete: Deletes a named space. Always performs a cascading delete, whichmeans that the space's child resources—like messages posted in the spaceand memberships in the space—are also deleted. For an example, see Deletea space (https://developers.google.com/workspace/chat/delete-spaces).Supports the following types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with administrator approval (https://support.google.com/a?p=chat-app-auth)and the authorization scope: -`https://www.googleapis.com/auth/chat.app.delete` (only in spaces the appcreated) - User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.delete` -`https://www.googleapis.com/auth/chat.import` (import mode spaces only) -User authentication grants administrator privileges when an administratoraccount authenticates, `use_admin_access` is `true`, and the followingauthorization scope is used: -`https://www.googleapis.com/auth/chat.admin.delete`
- name: Resource name of the space to delete. Format: `spaces/{space}`.
func (*SpacesService)FindDirectMessage¶added inv0.123.0
func (r *SpacesService) FindDirectMessage() *SpacesFindDirectMessageCall
FindDirectMessage: Returns the existing direct message with the specifieduser. If no direct message space is found, returns a `404 NOT_FOUND` error.For an example, see Find a direct message(/chat/api/guides/v1/spaces/find-direct-message). With app authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app),returns the direct message space between the specified user and the callingChat app. With user authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),returns the direct message space between the specified user and theauthenticated user. Supports the following types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` -User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.spaces.readonly` -`https://www.googleapis.com/auth/chat.spaces`
func (*SpacesService)Get¶
func (r *SpacesService) Get(namestring) *SpacesGetCall
Get: Returns details about a space. For an example, see Get details about aspace (https://developers.google.com/workspace/chat/get-spaces). Supportsthe following types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.bot` -`https://www.googleapis.com/auth/chat.app.spaces` with administratorapproval (https://support.google.com/a?p=chat-app-auth) - Userauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.spaces.readonly` -`https://www.googleapis.com/auth/chat.spaces` - User authentication grantsadministrator privileges when an administrator account authenticates,`use_admin_access` is `true`, and one of the following authorization scopesis used: - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` -`https://www.googleapis.com/auth/chat.admin.spaces` App authentication hasthe following limitations: - `space.access_settings` is only populated whenusing the `chat.app.spaces` scope. - `space.predefind_permission_settings`and `space.permission_settings` are only populated when using the`chat.app.spaces` scope, and only for spaces the app created.
- name: Resource name of the space, in the form `spaces/{space}`. Format:`spaces/{space}`.
func (*SpacesService)List¶
func (r *SpacesService) List() *SpacesListCall
List: Lists spaces the caller is a member of. Group chats and DMs aren'tlisted until the first message is sent. For an example, see List spaces(https://developers.google.com/workspace/chat/list-spaces). Supports thefollowing types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` -User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.spaces.readonly` -`https://www.googleapis.com/auth/chat.spaces` To list all named spaces byGoogle Workspace organization, use the `spaces.search()`(https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search)method using Workspace administrator privileges instead.
func (*SpacesService)Patch¶added inv0.123.0
func (r *SpacesService) Patch(namestring, space *Space) *SpacesPatchCall
Patch: Updates a space. For an example, see Update a space(https://developers.google.com/workspace/chat/update-spaces). If you'reupdating the `displayName` field and receive the error message`ALREADY_EXISTS`, try a different display name.. An existing space withinthe Google Workspace organization might already use this display name.Supports the following types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize): - Appauthentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with administrator approval (https://support.google.com/a?p=chat-app-auth)and one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.app.spaces` - User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.spaces` -`https://www.googleapis.com/auth/chat.import` (import mode spaces only) -User authentication grants administrator privileges when an administratoraccount authenticates, `use_admin_access` is `true`, and the followingauthorization scopes is used: -`https://www.googleapis.com/auth/chat.admin.spaces` App authentication hasthe following limitations: - To update either`space.predefined_permission_settings` or `space.permission_settings`, theapp must be the space creator. - Updating the`space.access_settings.audience` is not supported for app authentication.
- name: Identifier. Resource name of the space. Format: `spaces/{space}`Where `{space}` represents the system-assigned ID for the space. You canobtain the space ID by calling the `spaces.list()`(https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list)method or from the space URL. For example, if the space URL is`https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is`AAAAAAAAA`.
func (*SpacesService)Search¶added inv0.194.0
func (r *SpacesService) Search() *SpacesSearchCall
Search: Returns a list of spaces in a Google Workspace organization based onan administrator's search. In the request, set `use_admin_access` to `true`.For an example, see Search for and manage spaces(https://developers.google.com/workspace/chat/search-manage-admin). Requiresuser authentication with administrator privileges(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges)and one of the following authorization scopes(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.admin.spaces.readonly` -`https://www.googleapis.com/auth/chat.admin.spaces`
func (*SpacesService)Setup¶added inv0.123.0
func (r *SpacesService) Setup(setupspacerequest *SetUpSpaceRequest) *SpacesSetupCall
Setup: Creates a space and adds specified users to it. The calling user isautomatically added to the space, and shouldn't be specified as a membershipin the request. For an example, see Set up a space with initial members(https://developers.google.com/workspace/chat/set-up-spaces). To specify thehuman members to add, add memberships with the appropriate`membership.member.name`. To add a human user, use `users/{user}`, where`{user}` can be the email address for the user. For users in the sameWorkspace organization `{user}` can also be the `id` for the person from thePeople API, or the `id` for the user in the Directory API. For example, ifthe People API Person profile ID for `user@example.com` is `123456789`, youcan add the user to the space by setting the `membership.member.name` to`users/user@example.com` or `users/123456789`. To specify the Google groupsto add, add memberships with the appropriate `membership.group_member.name`.To add or invite a Google group, use `groups/{group}`, where `{group}` isthe `id` for the group from the Cloud Identity Groups API. For example, youcan use Cloud Identity Groups lookup API(https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) toretrieve the ID `123456789` for group email `group@example.com`, then youcan add the group to the space by setting the `membership.group_member.name`to `groups/123456789`. Group email is not supported, and Google groups canonly be added as members in named spaces. For a named space or group chat,if the caller blocks, or is blocked by some members, or doesn't havepermission to add some members, then those members aren't added to thecreated space. To create a direct message (DM) between the calling user andanother human user, specify exactly one membership to represent the humanuser. If one user blocks the other, the request fails and the DM isn'tcreated. To create a DM between the calling user and the calling app, set`Space.singleUserBotDm` to `true` and don't specify any memberships. You canonly use this method to set up a DM with the calling app. To add the callingapp as a member of a space or an existing DM between two human users, seeInvite or add a user or app to a space(https://developers.google.com/workspace/chat/create-members). If a DMalready exists between two users, even when one user blocks the other at thetime a request is made, then the existing DM is returned. Spaces withthreaded replies aren't supported. If you receive the error message`ALREADY_EXISTS` when setting up a space, try a different `displayName`. Anexisting space within the Google Workspace organization might already usethis display name. Requires user authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.spaces.create` -`https://www.googleapis.com/auth/chat.spaces`
typeSpacesSetupCall¶added inv0.123.0
type SpacesSetupCall struct {// contains filtered or unexported fields}func (*SpacesSetupCall)Context¶added inv0.123.0
func (c *SpacesSetupCall) Context(ctxcontext.Context) *SpacesSetupCall
Context sets the context to be used in this call's Do method.
func (*SpacesSetupCall)Do¶added inv0.123.0
func (c *SpacesSetupCall) Do(opts ...googleapi.CallOption) (*Space,error)
Do executes the "chat.spaces.setup" call.Any non-2xx status code is an error. Response headers are in either*Space.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesSetupCall)Fields¶added inv0.123.0
func (c *SpacesSetupCall) Fields(s ...googleapi.Field) *SpacesSetupCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesSetupCall)Header¶added inv0.123.0
func (c *SpacesSetupCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeSpacesSpaceEventsGetCall¶added inv0.173.0
type SpacesSpaceEventsGetCall struct {// contains filtered or unexported fields}func (*SpacesSpaceEventsGetCall)Context¶added inv0.173.0
func (c *SpacesSpaceEventsGetCall) Context(ctxcontext.Context) *SpacesSpaceEventsGetCall
Context sets the context to be used in this call's Do method.
func (*SpacesSpaceEventsGetCall)Do¶added inv0.173.0
func (c *SpacesSpaceEventsGetCall) Do(opts ...googleapi.CallOption) (*SpaceEvent,error)
Do executes the "chat.spaces.spaceEvents.get" call.Any non-2xx status code is an error. Response headers are in either*SpaceEvent.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SpacesSpaceEventsGetCall)Fields¶added inv0.173.0
func (c *SpacesSpaceEventsGetCall) Fields(s ...googleapi.Field) *SpacesSpaceEventsGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesSpaceEventsGetCall)Header¶added inv0.173.0
func (c *SpacesSpaceEventsGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesSpaceEventsGetCall)IfNoneMatch¶added inv0.173.0
func (c *SpacesSpaceEventsGetCall) IfNoneMatch(entityTagstring) *SpacesSpaceEventsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeSpacesSpaceEventsListCall¶added inv0.173.0
type SpacesSpaceEventsListCall struct {// contains filtered or unexported fields}func (*SpacesSpaceEventsListCall)Context¶added inv0.173.0
func (c *SpacesSpaceEventsListCall) Context(ctxcontext.Context) *SpacesSpaceEventsListCall
Context sets the context to be used in this call's Do method.
func (*SpacesSpaceEventsListCall)Do¶added inv0.173.0
func (c *SpacesSpaceEventsListCall) Do(opts ...googleapi.CallOption) (*ListSpaceEventsResponse,error)
Do executes the "chat.spaces.spaceEvents.list" call.Any non-2xx status code is an error. Response headers are in either*ListSpaceEventsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*SpacesSpaceEventsListCall)Fields¶added inv0.173.0
func (c *SpacesSpaceEventsListCall) Fields(s ...googleapi.Field) *SpacesSpaceEventsListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SpacesSpaceEventsListCall)Filter¶added inv0.173.0
func (c *SpacesSpaceEventsListCall) Filter(filterstring) *SpacesSpaceEventsListCall
Filter sets the optional parameter "filter": Required. A query filter. Youmust specify at least one event type (`event_type`) using the has `:`operator. To filter by multiple event types, use the `OR` operator. Omitbatch event types in your filter. The request automatically returns anyrelated batch events. For example, if you filter by new reactions(`google.workspace.chat.reaction.v1.created`), the server also returns batchnew reactions events (`google.workspace.chat.reaction.v1.batchCreated`). Fora list of supported event types, see the `SpaceEvents` referencedocumentation(https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type).Optionally, you can also filter by start time (`start_time`) and end time(`end_time`): * `start_time`: Exclusive timestamp from which to startlisting space events. You can list events that occurred up to 28 days ago.If unspecified, lists space events from the past 28 days. * `end_time`:Inclusive timestamp until which space events are listed. If unspecified,lists events up to the time of the request. To specify a start or end time,use the equals `=` operator and format in RFC-3339(https://www.rfc-editor.org/rfc/rfc3339). To filter by both `start_time` and`end_time`, use the `AND` operator. For example, the following queries arevalid: ``` start_time="2023-08-23T19:20:33+00:00" ANDend_time="2023-08-23T19:21:54+00:00" ``` ```start_time="2023-08-23T19:20:33+00:00" AND(event_types:"google.workspace.chat.space.v1.updated" ORevent_types:"google.workspace.chat.message.v1.created") ``` The followingqueries are invalid: ``` start_time="2023-08-23T19:20:33+00:00" ORend_time="2023-08-23T19:21:54+00:00" ``` ```event_types:"google.workspace.chat.space.v1.updated" ANDevent_types:"google.workspace.chat.message.v1.created" ``` Invalid queriesare rejected by the server with an `INVALID_ARGUMENT` error.
func (*SpacesSpaceEventsListCall)Header¶added inv0.173.0
func (c *SpacesSpaceEventsListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SpacesSpaceEventsListCall)IfNoneMatch¶added inv0.173.0
func (c *SpacesSpaceEventsListCall) IfNoneMatch(entityTagstring) *SpacesSpaceEventsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*SpacesSpaceEventsListCall)PageSize¶added inv0.173.0
func (c *SpacesSpaceEventsListCall) PageSize(pageSizeint64) *SpacesSpaceEventsListCall
PageSize sets the optional parameter "pageSize": The maximum number of spaceevents returned. The service might return fewer than this value. Negativevalues return an `INVALID_ARGUMENT` error.
func (*SpacesSpaceEventsListCall)PageToken¶added inv0.173.0
func (c *SpacesSpaceEventsListCall) PageToken(pageTokenstring) *SpacesSpaceEventsListCall
PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous list space events call. Provide this to retrieve thesubsequent page. When paginating, all other parameters provided to listspace events must match the call that provided the page token. Passingdifferent values to the other parameters might lead to unexpected results.
func (*SpacesSpaceEventsListCall)Pages¶added inv0.173.0
func (c *SpacesSpaceEventsListCall) Pages(ctxcontext.Context, f func(*ListSpaceEventsResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
typeSpacesSpaceEventsService¶added inv0.173.0
type SpacesSpaceEventsService struct {// contains filtered or unexported fields}funcNewSpacesSpaceEventsService¶added inv0.173.0
func NewSpacesSpaceEventsService(s *Service) *SpacesSpaceEventsService
func (*SpacesSpaceEventsService)Get¶added inv0.173.0
func (r *SpacesSpaceEventsService) Get(namestring) *SpacesSpaceEventsGetCall
Get: Returns an event from a Google Chat space. The event payload(https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload)contains the most recent version of the resource that changed. For example,if you request an event about a new message but the message was laterupdated, the server returns the updated `Message` resource in the eventpayload. Note: The `permissionSettings` field is not returned in the Spaceobject of the Space event data for this request. Supports the followingtypes of authentication(https://developers.google.com/workspace/chat/authenticate-authorize) withan authorization scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes)appropriate for reading the requested data: - App authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with administrator approval (https://support.google.com/a?p=chat-app-auth)in Developer Preview (https://developers.google.com/workspace/preview) withone of the following authorization scopes: -`https://www.googleapis.com/auth/chat.app.spaces` -`https://www.googleapis.com/auth/chat.app.messages.readonly` -`https://www.googleapis.com/auth/chat.app.memberships` - User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.spaces.readonly` -`https://www.googleapis.com/auth/chat.spaces` -`https://www.googleapis.com/auth/chat.messages.readonly` -`https://www.googleapis.com/auth/chat.messages` -`https://www.googleapis.com/auth/chat.messages.reactions.readonly` -`https://www.googleapis.com/auth/chat.messages.reactions` -`https://www.googleapis.com/auth/chat.memberships.readonly` -`https://www.googleapis.com/auth/chat.memberships` To get an event, theauthenticated caller must be a member of the space. For an example, see Getdetails about an event from a Google Chat space(https://developers.google.com/workspace/chat/get-space-event).
- name: The resource name of the space event. Format:`spaces/{space}/spaceEvents/{spaceEvent}`.
func (*SpacesSpaceEventsService)List¶added inv0.173.0
func (r *SpacesSpaceEventsService) List(parentstring) *SpacesSpaceEventsListCall
List: Lists events from a Google Chat space. For each event, the payload(https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload)contains the most recent version of the Chat resource. For example, if youlist events about new space members, the server returns `Membership`resources that contain the latest membership details. If new members wereremoved during the requested period, the event payload contains an empty`Membership` resource. Supports the following types of authentication(https://developers.google.com/workspace/chat/authenticate-authorize) withan authorization scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes)appropriate for reading the requested data: - App authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)with administrator approval (https://support.google.com/a?p=chat-app-auth)in Developer Preview (https://developers.google.com/workspace/preview) withone of the following authorization scopes: -`https://www.googleapis.com/auth/chat.app.spaces` -`https://www.googleapis.com/auth/chat.app.messages.readonly` -`https://www.googleapis.com/auth/chat.app.memberships` - User authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes: -`https://www.googleapis.com/auth/chat.spaces.readonly` -`https://www.googleapis.com/auth/chat.spaces` -`https://www.googleapis.com/auth/chat.messages.readonly` -`https://www.googleapis.com/auth/chat.messages` -`https://www.googleapis.com/auth/chat.messages.reactions.readonly` -`https://www.googleapis.com/auth/chat.messages.reactions` -`https://www.googleapis.com/auth/chat.memberships.readonly` -`https://www.googleapis.com/auth/chat.memberships` To list events, theauthenticated caller must be a member of the space. For an example, see Listevents from a Google Chat space(https://developers.google.com/workspace/chat/list-space-events).
- parent: Resource name of the Google Chat space(https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces)where the events occurred. Format: `spaces/{space}`.
typeStatus¶added inv0.61.0
type Status struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `json:"code,omitempty"`// Details: A list of messages that carry the error details. There is a common// set of message types for APIs to use.Details []googleapi.RawMessage `json:"details,omitempty"`// Message: A developer-facing error message, which should be in English. Any// user-facing error message should be localized and sent in the// google.rpc.Status.details field, or localized by the client.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Status: The `Status` type defines a logical error model that is suitable fordifferent programming environments, including REST APIs and RPC APIs. It isused by gRPC (https://github.com/grpc). Each `Status` message contains threepieces of data: error code, error message, and error details. You can findout more about this error model and how to work with it in the API DesignGuide (https://cloud.google.com/apis/design/errors).
func (Status)MarshalJSON¶added inv0.61.0
typeStringInputs¶added inv0.55.0
type StringInputs struct {// Value: An list of strings entered by the user.Value []string `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Value") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Value") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}StringInputs: Input parameter for regular widgets. For single-valuedwidgets, it is a single value list. For multi-valued widgets, such ascheckbox, all the values are presented.
func (StringInputs)MarshalJSON¶added inv0.55.0
func (sStringInputs) MarshalJSON() ([]byte,error)
typeTextButton¶
type TextButton struct {// OnClick: The `onclick` action of the button.OnClick *OnClick `json:"onClick,omitempty"`// Text: The text of the button.Textstring `json:"text,omitempty"`// ForceSendFields is a list of field names (e.g. "OnClick") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "OnClick") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}TextButton: A button with text and `onclick` action.
func (TextButton)MarshalJSON¶
func (sTextButton) MarshalJSON() ([]byte,error)
typeTextParagraph¶
type TextParagraph struct {Textstring `json:"text,omitempty"`// ForceSendFields is a list of field names (e.g. "Text") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Text") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}TextParagraph: A paragraph of text. Formatted text supported. For moreinformation about formatting text, see Formatting text in Google Chat apps(https://developers.google.com/workspace/chat/format-messages#card-formatting)and Formatting text in Google Workspace Add-ons(https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
func (TextParagraph)MarshalJSON¶
func (sTextParagraph) MarshalJSON() ([]byte,error)
typeThread¶
type Thread struct {// Name: Identifier. Resource name of the thread. Example:// `spaces/{space}/threads/{thread}`Namestring `json:"name,omitempty"`// ThreadKey: Optional. Input for creating or updating a thread. Otherwise,// output only. ID for the thread. Supports up to 4000 characters. This ID is// unique to the Chat app that sets it. For example, if multiple Chat apps// create a message using the same thread key, the messages are posted in// different threads. To reply in a thread created by a person or another Chat// app, specify the thread `name` field instead.ThreadKeystring `json:"threadKey,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Thread: A thread in a Google Chat space. For example usage, see Start orreply to a message thread(https://developers.google.com/workspace/chat/create-messages#create-message-thread).If you specify a thread when creating a message, you can set the`messageReplyOption`(https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption)field to determine what happens if no matching thread is found.
func (Thread)MarshalJSON¶
typeThreadReadState¶added inv0.177.0
type ThreadReadState struct {// LastReadTime: The time when the user's thread read state was updated.// Usually this corresponds with the timestamp of the last read message in a// thread.LastReadTimestring `json:"lastReadTime,omitempty"`// Name: Resource name of the thread read state. Format:// `users/{user}/spaces/{space}/threads/{thread}/threadReadState`Namestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "LastReadTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LastReadTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ThreadReadState: A user's read state within a thread, used to identify readand unread messages.
func (ThreadReadState)MarshalJSON¶added inv0.177.0
func (sThreadReadState) MarshalJSON() ([]byte,error)
typeTimeInput¶added inv0.55.0
type TimeInput struct {// Hours: The hour on a 24-hour clock.Hoursint64 `json:"hours,omitempty"`// Minutes: The number of minutes past the hour. Valid values are 0 to 59.Minutesint64 `json:"minutes,omitempty"`// ForceSendFields is a list of field names (e.g. "Hours") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Hours") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}TimeInput: Time input values.
func (TimeInput)MarshalJSON¶added inv0.55.0
typeTimeZone¶added inv0.55.0
type TimeZone struct {// Id: The IANA TZ (https://www.iana.org/time-zones) time zone database code,// such as "America/Toronto".Idstring `json:"id,omitempty"`// Offset: The user timezone offset, in milliseconds, from Coordinated// Universal Time (UTC).Offsetint64 `json:"offset,omitempty"`// ForceSendFields is a list of field names (e.g. "Id") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Id") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}TimeZone: The timezone ID and offset from Coordinated Universal Time (UTC).Only supported for the event types `CARD_CLICKED`(https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_VALUES.CARD_CLICKED)and `SUBMIT_DIALOG`(https://developers.google.com/chat/api/reference/rest/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG).
func (TimeZone)MarshalJSON¶added inv0.55.0
typeUpdatedWidget¶added inv0.153.0
type UpdatedWidget struct {// Suggestions: List of widget autocomplete resultsSuggestions *SelectionItems `json:"suggestions,omitempty"`// Widget: The ID of the updated widget. The ID must match the one for the// widget that triggered the update request.Widgetstring `json:"widget,omitempty"`// ForceSendFields is a list of field names (e.g. "Suggestions") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Suggestions") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}UpdatedWidget: For `selectionInput` widgets, returns autocompletesuggestions for a multiselect menu.
func (UpdatedWidget)MarshalJSON¶added inv0.153.0
func (sUpdatedWidget) MarshalJSON() ([]byte,error)
typeUploadAttachmentRequest¶added inv0.123.0
type UploadAttachmentRequest struct {// Filename: Required. The filename of the attachment, including the file// extension.Filenamestring `json:"filename,omitempty"`// ForceSendFields is a list of field names (e.g. "Filename") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Filename") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}UploadAttachmentRequest: Request to upload an attachment.
func (UploadAttachmentRequest)MarshalJSON¶added inv0.123.0
func (sUploadAttachmentRequest) MarshalJSON() ([]byte,error)
typeUploadAttachmentResponse¶added inv0.123.0
type UploadAttachmentResponse struct {// AttachmentDataRef: Reference to the uploaded attachment.AttachmentDataRef *AttachmentDataRef `json:"attachmentDataRef,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AttachmentDataRef") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AttachmentDataRef") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}UploadAttachmentResponse: Response of uploading an attachment.
func (UploadAttachmentResponse)MarshalJSON¶added inv0.123.0
func (sUploadAttachmentResponse) MarshalJSON() ([]byte,error)
typeUser¶
type User struct {// DisplayName: Output only. The user's display name.DisplayNamestring `json:"displayName,omitempty"`// DomainId: Unique identifier of the user's Google Workspace domain.DomainIdstring `json:"domainId,omitempty"`// IsAnonymous: Output only. When `true`, the user is deleted or their profile// is not visible.IsAnonymousbool `json:"isAnonymous,omitempty"`// Name: Resource name for a Google Chat user. Format: `users/{user}`.// `users/app` can be used as an alias for the calling app bot user. For human// users, `{user}` is the same user identifier as: - the `id` for the Person// (https://developers.google.com/people/api/rest/v1/people) in the People API.// For example, `users/123456789` in Chat API represents the same person as the// `123456789` Person profile ID in People API. - the `id` for a user// (https://developers.google.com/admin-sdk/directory/reference/rest/v1/users)// in the Admin SDK Directory API. - the user's email address can be used as an// alias for `{user}` in API requests. For example, if the People API Person// profile ID for `user@example.com` is `123456789`, you can use// `users/user@example.com` as an alias to reference `users/123456789`. Only// the canonical resource name (for example `users/123456789`) will be returned// from the API.Namestring `json:"name,omitempty"`// Type: User type.//// Possible values:// "TYPE_UNSPECIFIED" - Default value for the enum. DO NOT USE.// "HUMAN" - Human user.// "BOT" - Chat app user.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}User: A user in Google Chat. When returned as an output from a request, ifyour Chat app authenticates as a user(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),the output for a `User` resource only populates the user's `name` and`type`.
func (User)MarshalJSON¶
typeUserMentionMetadata¶
type UserMentionMetadata struct {// Type: The type of user mention.//// Possible values:// "TYPE_UNSPECIFIED" - Default value for the enum. Don't use.// "ADD" - Add user to space.// "MENTION" - Mention user in space.Typestring `json:"type,omitempty"`// User: The user mentioned.User *User `json:"user,omitempty"`// ForceSendFields is a list of field names (e.g. "Type") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Type") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}UserMentionMetadata: Annotation metadata for user mentions (@).
func (UserMentionMetadata)MarshalJSON¶
func (sUserMentionMetadata) MarshalJSON() ([]byte,error)
typeUsersService¶added inv0.177.0
type UsersService struct {Spaces *UsersSpacesService// contains filtered or unexported fields}funcNewUsersService¶added inv0.177.0
func NewUsersService(s *Service) *UsersService
typeUsersSpacesGetSpaceReadStateCall¶added inv0.177.0
type UsersSpacesGetSpaceReadStateCall struct {// contains filtered or unexported fields}func (*UsersSpacesGetSpaceReadStateCall)Context¶added inv0.177.0
func (c *UsersSpacesGetSpaceReadStateCall) Context(ctxcontext.Context) *UsersSpacesGetSpaceReadStateCall
Context sets the context to be used in this call's Do method.
func (*UsersSpacesGetSpaceReadStateCall)Do¶added inv0.177.0
func (c *UsersSpacesGetSpaceReadStateCall) Do(opts ...googleapi.CallOption) (*SpaceReadState,error)
Do executes the "chat.users.spaces.getSpaceReadState" call.Any non-2xx status code is an error. Response headers are in either*SpaceReadState.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*UsersSpacesGetSpaceReadStateCall)Fields¶added inv0.177.0
func (c *UsersSpacesGetSpaceReadStateCall) Fields(s ...googleapi.Field) *UsersSpacesGetSpaceReadStateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*UsersSpacesGetSpaceReadStateCall)Header¶added inv0.177.0
func (c *UsersSpacesGetSpaceReadStateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*UsersSpacesGetSpaceReadStateCall)IfNoneMatch¶added inv0.177.0
func (c *UsersSpacesGetSpaceReadStateCall) IfNoneMatch(entityTagstring) *UsersSpacesGetSpaceReadStateCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeUsersSpacesService¶added inv0.177.0
type UsersSpacesService struct {SpaceNotificationSetting *UsersSpacesSpaceNotificationSettingServiceThreads *UsersSpacesThreadsService// contains filtered or unexported fields}funcNewUsersSpacesService¶added inv0.177.0
func NewUsersSpacesService(s *Service) *UsersSpacesService
func (*UsersSpacesService)GetSpaceReadState¶added inv0.177.0
func (r *UsersSpacesService) GetSpaceReadState(namestring) *UsersSpacesGetSpaceReadStateCall
GetSpaceReadState: Returns details about a user's read state within a space,used to identify read and unread messages. For an example, see Get detailsabout a user's space read state(https://developers.google.com/workspace/chat/get-space-read-state).Requires user authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.users.readstate.readonly` -`https://www.googleapis.com/auth/chat.users.readstate`
- name: Resource name of the space read state to retrieve. Only supportsgetting read state for the calling user. To refer to the calling user, setone of the following: - The `me` alias. For example,`users/me/spaces/{space}/spaceReadState`. - Their Workspace email address.For example, `users/user@example.com/spaces/{space}/spaceReadState`. -Their user id. For example,`users/123456789/spaces/{space}/spaceReadState`. Format:users/{user}/spaces/{space}/spaceReadState.
func (*UsersSpacesService)UpdateSpaceReadState¶added inv0.177.0
func (r *UsersSpacesService) UpdateSpaceReadState(namestring, spacereadstate *SpaceReadState) *UsersSpacesUpdateSpaceReadStateCall
UpdateSpaceReadState: Updates a user's read state within a space, used toidentify read and unread messages. For an example, see Update a user's spaceread state(https://developers.google.com/workspace/chat/update-space-read-state).Requires user authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with the authorization scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.users.readstate`
- name: Resource name of the space read state. Format:`users/{user}/spaces/{space}/spaceReadState`.
typeUsersSpacesSpaceNotificationSettingGetCall¶added inv0.224.0
type UsersSpacesSpaceNotificationSettingGetCall struct {// contains filtered or unexported fields}func (*UsersSpacesSpaceNotificationSettingGetCall)Context¶added inv0.224.0
func (c *UsersSpacesSpaceNotificationSettingGetCall) Context(ctxcontext.Context) *UsersSpacesSpaceNotificationSettingGetCall
Context sets the context to be used in this call's Do method.
func (*UsersSpacesSpaceNotificationSettingGetCall)Do¶added inv0.224.0
func (c *UsersSpacesSpaceNotificationSettingGetCall) Do(opts ...googleapi.CallOption) (*SpaceNotificationSetting,error)
Do executes the "chat.users.spaces.spaceNotificationSetting.get" call.Any non-2xx status code is an error. Response headers are in either*SpaceNotificationSetting.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*UsersSpacesSpaceNotificationSettingGetCall)Fields¶added inv0.224.0
func (c *UsersSpacesSpaceNotificationSettingGetCall) Fields(s ...googleapi.Field) *UsersSpacesSpaceNotificationSettingGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*UsersSpacesSpaceNotificationSettingGetCall)Header¶added inv0.224.0
func (c *UsersSpacesSpaceNotificationSettingGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*UsersSpacesSpaceNotificationSettingGetCall)IfNoneMatch¶added inv0.224.0
func (c *UsersSpacesSpaceNotificationSettingGetCall) IfNoneMatch(entityTagstring) *UsersSpacesSpaceNotificationSettingGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeUsersSpacesSpaceNotificationSettingPatchCall¶added inv0.224.0
type UsersSpacesSpaceNotificationSettingPatchCall struct {// contains filtered or unexported fields}func (*UsersSpacesSpaceNotificationSettingPatchCall)Context¶added inv0.224.0
func (c *UsersSpacesSpaceNotificationSettingPatchCall) Context(ctxcontext.Context) *UsersSpacesSpaceNotificationSettingPatchCall
Context sets the context to be used in this call's Do method.
func (*UsersSpacesSpaceNotificationSettingPatchCall)Do¶added inv0.224.0
func (c *UsersSpacesSpaceNotificationSettingPatchCall) Do(opts ...googleapi.CallOption) (*SpaceNotificationSetting,error)
Do executes the "chat.users.spaces.spaceNotificationSetting.patch" call.Any non-2xx status code is an error. Response headers are in either*SpaceNotificationSetting.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*UsersSpacesSpaceNotificationSettingPatchCall)Fields¶added inv0.224.0
func (c *UsersSpacesSpaceNotificationSettingPatchCall) Fields(s ...googleapi.Field) *UsersSpacesSpaceNotificationSettingPatchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*UsersSpacesSpaceNotificationSettingPatchCall)Header¶added inv0.224.0
func (c *UsersSpacesSpaceNotificationSettingPatchCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*UsersSpacesSpaceNotificationSettingPatchCall)UpdateMask¶added inv0.224.0
func (c *UsersSpacesSpaceNotificationSettingPatchCall) UpdateMask(updateMaskstring) *UsersSpacesSpaceNotificationSettingPatchCall
UpdateMask sets the optional parameter "updateMask": Required. Supportedfield paths: - `notification_setting` - `mute_setting`
typeUsersSpacesSpaceNotificationSettingService¶added inv0.224.0
type UsersSpacesSpaceNotificationSettingService struct {// contains filtered or unexported fields}funcNewUsersSpacesSpaceNotificationSettingService¶added inv0.224.0
func NewUsersSpacesSpaceNotificationSettingService(s *Service) *UsersSpacesSpaceNotificationSettingService
func (*UsersSpacesSpaceNotificationSettingService)Get¶added inv0.224.0
func (r *UsersSpacesSpaceNotificationSettingService) Get(namestring) *UsersSpacesSpaceNotificationSettingGetCall
Get: Gets the space notification setting. For an example, see Get thecaller's space notification setting(https://developers.google.com/workspace/chat/get-space-notification-setting).Requires user authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with the authorization scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.users.spacesettings`
- name: Format: users/{user}/spaces/{space}/spaceNotificationSetting -`users/me/spaces/{space}/spaceNotificationSetting`, OR -`users/user@example.com/spaces/{space}/spaceNotificationSetting`, OR -`users/123456789/spaces/{space}/spaceNotificationSetting`. Note: Only thecaller's user id or email is allowed in the path.
func (*UsersSpacesSpaceNotificationSettingService)Patch¶added inv0.224.0
func (r *UsersSpacesSpaceNotificationSettingService) Patch(namestring, spacenotificationsetting *SpaceNotificationSetting) *UsersSpacesSpaceNotificationSettingPatchCall
Patch: Updates the space notification setting. For an example, see Updatethe caller's space notification setting(https://developers.google.com/workspace/chat/update-space-notification-setting).Requires user authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with the authorization scope(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.users.spacesettings`
- name: Identifier. The resource name of the space notification setting.Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.
typeUsersSpacesThreadsGetThreadReadStateCall¶added inv0.177.0
type UsersSpacesThreadsGetThreadReadStateCall struct {// contains filtered or unexported fields}func (*UsersSpacesThreadsGetThreadReadStateCall)Context¶added inv0.177.0
func (c *UsersSpacesThreadsGetThreadReadStateCall) Context(ctxcontext.Context) *UsersSpacesThreadsGetThreadReadStateCall
Context sets the context to be used in this call's Do method.
func (*UsersSpacesThreadsGetThreadReadStateCall)Do¶added inv0.177.0
func (c *UsersSpacesThreadsGetThreadReadStateCall) Do(opts ...googleapi.CallOption) (*ThreadReadState,error)
Do executes the "chat.users.spaces.threads.getThreadReadState" call.Any non-2xx status code is an error. Response headers are in either*ThreadReadState.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*UsersSpacesThreadsGetThreadReadStateCall)Fields¶added inv0.177.0
func (c *UsersSpacesThreadsGetThreadReadStateCall) Fields(s ...googleapi.Field) *UsersSpacesThreadsGetThreadReadStateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*UsersSpacesThreadsGetThreadReadStateCall)Header¶added inv0.177.0
func (c *UsersSpacesThreadsGetThreadReadStateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*UsersSpacesThreadsGetThreadReadStateCall)IfNoneMatch¶added inv0.177.0
func (c *UsersSpacesThreadsGetThreadReadStateCall) IfNoneMatch(entityTagstring) *UsersSpacesThreadsGetThreadReadStateCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeUsersSpacesThreadsService¶added inv0.177.0
type UsersSpacesThreadsService struct {// contains filtered or unexported fields}funcNewUsersSpacesThreadsService¶added inv0.177.0
func NewUsersSpacesThreadsService(s *Service) *UsersSpacesThreadsService
func (*UsersSpacesThreadsService)GetThreadReadState¶added inv0.177.0
func (r *UsersSpacesThreadsService) GetThreadReadState(namestring) *UsersSpacesThreadsGetThreadReadStateCall
GetThreadReadState: Returns details about a user's read state within athread, used to identify read and unread messages. For an example, see Getdetails about a user's thread read state(https://developers.google.com/workspace/chat/get-thread-read-state).Requires user authentication(https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)with one of the following authorization scopes(https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):- `https://www.googleapis.com/auth/chat.users.readstate.readonly` -`https://www.googleapis.com/auth/chat.users.readstate`
- name: Resource name of the thread read state to retrieve. Only supportsgetting read state for the calling user. To refer to the calling user, setone of the following: - The `me` alias. For example,`users/me/spaces/{space}/threads/{thread}/threadReadState`. - TheirWorkspace email address. For example,`users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`.
- Their user id. For example,`users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format:users/{user}/spaces/{space}/threads/{thread}/threadReadState.
typeUsersSpacesUpdateSpaceReadStateCall¶added inv0.177.0
type UsersSpacesUpdateSpaceReadStateCall struct {// contains filtered or unexported fields}func (*UsersSpacesUpdateSpaceReadStateCall)Context¶added inv0.177.0
func (c *UsersSpacesUpdateSpaceReadStateCall) Context(ctxcontext.Context) *UsersSpacesUpdateSpaceReadStateCall
Context sets the context to be used in this call's Do method.
func (*UsersSpacesUpdateSpaceReadStateCall)Do¶added inv0.177.0
func (c *UsersSpacesUpdateSpaceReadStateCall) Do(opts ...googleapi.CallOption) (*SpaceReadState,error)
Do executes the "chat.users.spaces.updateSpaceReadState" call.Any non-2xx status code is an error. Response headers are in either*SpaceReadState.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*UsersSpacesUpdateSpaceReadStateCall)Fields¶added inv0.177.0
func (c *UsersSpacesUpdateSpaceReadStateCall) Fields(s ...googleapi.Field) *UsersSpacesUpdateSpaceReadStateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*UsersSpacesUpdateSpaceReadStateCall)Header¶added inv0.177.0
func (c *UsersSpacesUpdateSpaceReadStateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*UsersSpacesUpdateSpaceReadStateCall)UpdateMask¶added inv0.177.0
func (c *UsersSpacesUpdateSpaceReadStateCall) UpdateMask(updateMaskstring) *UsersSpacesUpdateSpaceReadStateCall
UpdateMask sets the optional parameter "updateMask": Required. The fieldpaths to update. Currently supported field paths: - `last_read_time` Whenthe `last_read_time` is before the latest message create time, the spaceappears as unread in the UI. To mark the space as read, set `last_read_time`to any value later (larger) than the latest message create time. The`last_read_time` is coerced to match the latest message create time. Notethat the space read state only affects the read state of messages that arevisible in the space's top-level conversation. Replies in threads areunaffected by this timestamp, and instead rely on the thread read state.
typeWidgetMarkup¶
type WidgetMarkup struct {// Buttons: A list of buttons. Buttons is also `oneof data` and only one of// these fields should be set.Buttons []*Button `json:"buttons,omitempty"`// Image: Display an image in this widget.Image *Image `json:"image,omitempty"`// KeyValue: Display a key value item in this widget.KeyValue *KeyValue `json:"keyValue,omitempty"`// TextParagraph: Display a text paragraph in this widget.TextParagraph *TextParagraph `json:"textParagraph,omitempty"`// ForceSendFields is a list of field names (e.g. "Buttons") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Buttons") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}WidgetMarkup: A widget is a UI element that presents text and images.
func (WidgetMarkup)MarshalJSON¶
func (sWidgetMarkup) MarshalJSON() ([]byte,error)
typeWorkflowDataSourceMarkup¶added inv0.248.0
type WorkflowDataSourceMarkup struct {// IncludeVariables: Whether to include variables from the previous step in the// data source.IncludeVariablesbool `json:"includeVariables,omitempty"`// Type: The type of data source.//// Possible values:// "UNKNOWN" - Default value. Don't use.// "USER" - Google Workspace users. The user can only view and select users// from their Google Workspace organization.// "SPACE" - Google Chat spaces that the user is a member of.// "USER_WITH_FREE_FORM" - Users can choose to view and select existing// members from their Google Workspace organization or manually enter an email// address or a valid domain.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "IncludeVariables") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IncludeVariables") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}WorkflowDataSourceMarkup: * Only supported by Google Workspace Workflow, butnot Google Chat apps or Google Workspace add-ons. In a `TextInput` or`SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`,provide data source from Google.
func (WorkflowDataSourceMarkup)MarshalJSON¶added inv0.248.0
func (sWorkflowDataSourceMarkup) MarshalJSON() ([]byte,error)