Google Workspace Events V1BETA API - Class Google::Apps::Events::Subscriptions::V1beta::PayloadOptions (v0.1.0)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Google Workspace Events V1BETA API class Google::Apps::Events::Subscriptions::V1beta::PayloadOptions.
Options about what data to include in the event payload. Only supported for
Google Chat events.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#field_mask
deffield_mask()->::Google::Protobuf::FieldMask
Returns
(::Google::Protobuf::FieldMask) — Optional. If include_resource is set to true, the list of fields to
include in the event payload. Separate fields with a comma. For example, to
include a Google Chat message's sender and create time, enter
message.sender,message.createTime. If omitted, the payload includes all
fields for the resource.
If you specify a field that doesn't exist for the resource, the system
ignores the field.
value (::Google::Protobuf::FieldMask) — Optional. If include_resource is set to true, the list of fields to
include in the event payload. Separate fields with a comma. For example, to
include a Google Chat message's sender and create time, enter
message.sender,message.createTime. If omitted, the payload includes all
fields for the resource.
If you specify a field that doesn't exist for the resource, the system
ignores the field.
Returns
(::Google::Protobuf::FieldMask) — Optional. If include_resource is set to true, the list of fields to
include in the event payload. Separate fields with a comma. For example, to
include a Google Chat message's sender and create time, enter
message.sender,message.createTime. If omitted, the payload includes all
fields for the resource.
If you specify a field that doesn't exist for the resource, the system
ignores the field.
#include_resource
definclude_resource()->::Boolean
Returns
(::Boolean) — Optional. Whether the event payload includes data about the resource that
changed. For example, for an event where a Google Chat message was created,
whether the payload contains data about the
Message
resource. If false, the event payload only includes the name of the changed
resource.
#include_resource=
definclude_resource=(value)->::Boolean
Parameter
value (::Boolean) — Optional. Whether the event payload includes data about the resource that
changed. For example, for an event where a Google Chat message was created,
whether the payload contains data about the
Message
resource. If false, the event payload only includes the name of the changed
resource.
Returns
(::Boolean) — Optional. Whether the event payload includes data about the resource that
changed. For example, for an event where a Google Chat message was created,
whether the payload contains data about the
Message
resource. If false, the event payload only includes the name of the changed
resource.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Workspace Events V1BETA API - Class Google::Apps::Events::Subscriptions::V1beta::PayloadOptions (v0.1.0)\n\nReference documentation and code samples for the Google Workspace Events V1BETA API class Google::Apps::Events::Subscriptions::V1beta::PayloadOptions.\n\nOptions about what data to include in the event payload. Only supported for\nGoogle Chat events. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #field_mask\n\n def field_mask() -\u003e ::Google::Protobuf::FieldMask\n\n**Returns**\n\n- ([::Google::Protobuf::FieldMask](./Google-Protobuf-FieldMask)) --- Optional. If `include_resource` is set to `true`, the list of fields to include in the event payload. Separate fields with a comma. For example, to include a Google Chat message's sender and create time, enter `message.sender,message.createTime`. If omitted, the payload includes all fields for the resource.\n\n\n If you specify a field that doesn't exist for the resource, the system\n ignores the field.\n\n### #field_mask=\n\n def field_mask=(value) -\u003e ::Google::Protobuf::FieldMask\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::FieldMask](./Google-Protobuf-FieldMask)) --- Optional. If `include_resource` is set to `true`, the list of fields to include in the event payload. Separate fields with a comma. For example, to include a Google Chat message's sender and create time, enter `message.sender,message.createTime`. If omitted, the payload includes all fields for the resource.\n\n\n If you specify a field that doesn't exist for the resource, the system\nignores the field. \n**Returns**\n\n- ([::Google::Protobuf::FieldMask](./Google-Protobuf-FieldMask)) --- Optional. If `include_resource` is set to `true`, the list of fields to include in the event payload. Separate fields with a comma. For example, to include a Google Chat message's sender and create time, enter `message.sender,message.createTime`. If omitted, the payload includes all fields for the resource.\n\n\n If you specify a field that doesn't exist for the resource, the system\n ignores the field.\n\n### #include_resource\n\n def include_resource() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. Whether the event payload includes data about the resource that changed. For example, for an event where a Google Chat message was created, whether the payload contains data about the [`Message`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages) resource. If false, the event payload only includes the name of the changed resource.\n\n### #include_resource=\n\n def include_resource=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. Whether the event payload includes data about the resource that changed. For example, for an event where a Google Chat message was created, whether the payload contains data about the [`Message`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages) resource. If false, the event payload only includes the name of the changed resource. \n**Returns**\n\n- (::Boolean) --- Optional. Whether the event payload includes data about the resource that changed. For example, for an event where a Google Chat message was created, whether the payload contains data about the [`Message`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages) resource. If false, the event payload only includes the name of the changed resource."]]
