Reference documentation and code samples for the Google Apps Events Subscriptions V1beta Client class PayloadOptions.
Options about what data to include in the event payload. Only supported for
Google Chat events.
Generated from protobuf messagegoogle.apps.events.subscriptions.v1beta.PayloadOptions
Namespace
Google \ Apps \ Events \ Subscriptions \ V1beta
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ include_resource
bool
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 theMessageresource. If false, the event payload only includes the name of the changed resource.
Optional. Ifinclude_resourceis set totrue, 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, entermessage.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.
getIncludeResource
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 theMessageresource. If false, the event payload only includes the name of the changed
resource.
Returns
Type
Description
bool
setIncludeResource
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 theMessageresource. If false, the event payload only includes the name of the changed
resource.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getFieldMask
Optional. Ifinclude_resourceis set totrue, 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, entermessage.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.
Optional. Ifinclude_resourceis set totrue, 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, entermessage.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.
[[["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 Apps Events Subscriptions V1beta Client - Class PayloadOptions (0.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.3.1 (latest)](/php/docs/reference/apps-events-subscriptions/latest/V1beta.PayloadOptions)\n- [0.3.0](/php/docs/reference/apps-events-subscriptions/0.3.0/V1beta.PayloadOptions)\n- [0.2.1](/php/docs/reference/apps-events-subscriptions/0.2.1/V1beta.PayloadOptions)\n- [0.1.6](/php/docs/reference/apps-events-subscriptions/0.1.6/V1beta.PayloadOptions) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Apps Events Subscriptions V1beta Client class PayloadOptions.\n\nOptions about what data to include in the event payload. Only supported for\nGoogle Chat events.\n\nGenerated from protobuf message `google.apps.events.subscriptions.v1beta.PayloadOptions`\n\nNamespace\n---------\n\nGoogle \\\\ Apps \\\\ Events \\\\ Subscriptions \\\\ V1beta\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getIncludeResource\n\nOptional. Whether the event payload includes data about the resource that\nchanged. For example, for an event where a Google Chat message was created,\nwhether the payload contains data about the\n[`Message`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages)\nresource. If false, the event payload only includes the name of the changed\nresource.\n\n### setIncludeResource\n\nOptional. Whether the event payload includes data about the resource that\nchanged. For example, for an event where a Google Chat message was created,\nwhether the payload contains data about the\n[`Message`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages)\nresource. If false, the event payload only includes the name of the changed\nresource.\n\n### getFieldMask\n\nOptional. If `include_resource` is set to `true`, the list of fields to\ninclude in the event payload. Separate fields with a comma. For example, to\ninclude a Google Chat message's sender and create time, enter\n`message.sender,message.createTime`. If omitted, the payload includes all\nfields for the resource.\n\nIf you specify a field that doesn't exist for the resource, the system\nignores the field.\n\n### hasFieldMask\n\n### clearFieldMask\n\n### setFieldMask\n\nOptional. If `include_resource` is set to `true`, the list of fields to\ninclude in the event payload. Separate fields with a comma. For example, to\ninclude a Google Chat message's sender and create time, enter\n`message.sender,message.createTime`. If omitted, the payload includes all\nfields for the resource.\n\nIf you specify a field that doesn't exist for the resource, the system\nignores the field."]]
