Namespace Google.Apis.CloudSearch.v1.Data

Classes

AbuseReportingConfig

Abuse reporting configuration outlining what is supported in this conference.

AckInfo

Information about how devices in a meeting have acked for a session/operation.

AclFixRequest

The request set by clients to instruct Backend how the user intend to fix the ACL. Technically it's not a request to ACL Fixer, because Backend uses /DriveService.Share to modify Drive ACLs.

The message reconstructed based on information in the response of /PermissionFixOptionsService.Query (or the Apiary API that wraps it). Indicates the ability of the requester to change the access to the Drive file for the room roster or the DM members. Used in GetMessagePreviewMetadataResponse only.

AclInfo

Next tag: 4

ActionParameter

List of string parameters that developers can specify when the above action method (in apps script) is invoked. An example use case is for 3 snooze buttons: snooze now, snooze 1 day, snooze next week. Developers can have action method = snooze() and pass the snooze type and snooze time in list of string parameters.

AddonComposeUiActionMarkup

AffectedMembership

Earlier we used to populate just the affected_members list and inferred the new membership state (roles didn't exist back then) from the Type. go/dynamite-finra required backend to know the previous membership state to reconstruct membership history. The proper solution involved cleaning up up Type enum, but it was used in many, many places. This was added as a stop-gap solution to unblock FINRA without breaking everything. Later role update and target audience update started relying on this to communicate information to clients about what transition happened. So this is now required to be populated and should be in sync with affected_members for new messages.

AllAuthenticatedUsersProto

Represents a principal who has authenticated as any kind of user which the application understands. This is typically used for "wiki-like" security, where anyone is allowed access so long as they can be held accountable for that access. Since the purpose is knowing whom to blame, it is up to the application to decide what kinds of users it knows how to blame. For example, an application might choose to include GAIA users in "all authenticated users", but not include MDB users. Nothing here.

Annotation

NOTE WHEN ADDING NEW PROTO FIELDS: Be sure to add datapol annotations to new fields with potential PII, so they get scrubbed when logging protos for errors. NEXT TAG: 31

AppId

Identifier of an App.

AppsDynamiteSharedActivityFeedAnnotationData

Next Id: 7

AppsDynamiteSharedActivityFeedAnnotationDataUserInfo

UserId of the AF item updater to show and the updater count to show.

AppsDynamiteSharedAppProfile

Optional field for apps overriding display info

AppsDynamiteSharedAssistantAnnotationData

This is the internal version of the API proto at google3/google/chat/v1/gsuite_message_integration.proto Data used to render Assistant suggestions. See go/bullseye-rendering.

AppsDynamiteSharedAssistantDebugContext

Represents info regarding suggestion debug information.

AppsDynamiteSharedAssistantFeedbackContext

Data needed to render feedback on the Assistant card

AppsDynamiteSharedAssistantFeedbackContextFeedbackChip

Suggestion chips for users to indicate positive or negative feedback

AppsDynamiteSharedAssistantSessionContext

Session context specific for Assistant suggestions.

AppsDynamiteSharedAssistantSuggestion

Data for an Assistant suggestion.

AppsDynamiteSharedAssistantUnfulfillableRequest

Data for a response to an unfulfillable request.

AppsDynamiteSharedAvatarInfo

AppsDynamiteSharedBackendUploadMetadata

Metadata used only in Dynamite backend for uploaded attachments.

AppsDynamiteSharedCalendarEventAnnotationData

AppsDynamiteSharedCalendarEventAnnotationDataCalendarEvent

AppsDynamiteSharedCalendarEventAnnotationDataCalendarEventTime

AppsDynamiteSharedCalendarEventAnnotationDataEventCreation

Creation of an event (no extra data for now).

AppsDynamiteSharedCallAnnotationData

Data used to render Meet or Google Voice chips in Chat. See go/dynamite-calling-artifacts-in-chat.

AppsDynamiteSharedCallMetadata

Metadata required to generate call artifacts. This can either be the metadata for a Meet or, in the future, Google Voice call.

AppsDynamiteSharedCardClickSuggestion

Card click which identifies one suggestion provided by the app/bot.

AppsDynamiteSharedChatItem

Next Id: 5

AppsDynamiteSharedChatItemActivityInfo

AppsDynamiteSharedChatItemActivityInfoFeedItemNudge

Existence of this attribute indicates that the AF item is for a message nudge item.

AppsDynamiteSharedChatItemActivityInfoFeedItemReactions

Existence of this attribute indicates that the AF item is for message reactions, but it is intentionally left empty since the list of reactions can be found in the top-level Message.Reactions.

AppsDynamiteSharedChatItemActivityInfoFeedItemThreadReply

Existence of this attribute indicates that the AF item is for thread reply.

AppsDynamiteSharedChatItemActivityInfoFeedItemUserMention

Existence of this attribute indicates that the AF item is for a user mention item.

AppsDynamiteSharedChatItemGroupInfo

Information about the space that the item originated from. This will be used to display Activity Feed items from rooms, and only contain the necessary information, such as the space name and group attributes. NEXT TAG: 6

AppsDynamiteSharedContentReportType

Denotes a type of content report a user can send.

AppsDynamiteSharedCustomEmoji

Proto representation of a custom emoji. May be used in both APIs and in Spanner, but certain fields should be restricted to one or the other. See the per-field documentation for details. NEXT_TAG: 14

AppsDynamiteSharedDimension

Dimension for the uploaded attachments.

AppsDynamiteSharedDlpMetricsMetadata

LINT.IfChange

AppsDynamiteSharedDocument

Data for rendering a document.

AppsDynamiteSharedEmoji

AppsDynamiteSharedFindDocumentSuggestion

Data for a FindDocument suggestion type.

AppsDynamiteSharedGroupDetails

NEXT TAG: 3 A GroupDetails proto will store the information pertaining to single Group.

AppsDynamiteSharedGroupVisibility

AppsDynamiteSharedJustification

Data for rendering a justification for a document.

AppsDynamiteSharedJustificationPerson

Data for rendering a person associated with a document.

AppsDynamiteSharedMeetMetadata

Metadata specific for a Meet call that are required to generate call artifacts.

AppsDynamiteSharedMessageInfo

Information that references a Dynamite chat message. This is only used for Activity Feed messages.

AppsDynamiteSharedMessageIntegrationPayload

The payload(restricted to 1P applications) to be stored with a specific message.

AppsDynamiteSharedOrganizationInfo

Contains info about the entity that something is, or is owned by.

AppsDynamiteSharedOrganizationInfoConsumerInfo

Intentionally empty. Used to disambiguate consumer and customer use cases in oneof below.

AppsDynamiteSharedOrganizationInfoCustomerInfo

AppsDynamiteSharedOriginAppSuggestion

Stores the suggestion provided by apps/bots.

AppsDynamiteSharedPhoneNumber

AppsDynamiteSharedReaction

AppsDynamiteSharedRetentionSettings

The settings of retention period of a message or topic.

AppsDynamiteSharedSegmentedMembershipCount

Contains info on membership count for member types: HUMAN_USER, APP_USER & ROSTER_MEMBER different states: INVITED, JOINED

AppsDynamiteSharedSegmentedMembershipCounts

AppsDynamiteSharedSpaceInfo

Defines the representation of a single matching space.

AppsDynamiteSharedTasksAnnotationData

This is the internal version of the API proto at google3/google/chat/v1/gsuite_message_integration.proto

AppsDynamiteSharedTasksAnnotationDataAssigneeChange

AppsDynamiteSharedTasksAnnotationDataCompletionChange

AppsDynamiteSharedTasksAnnotationDataCreation

AppsDynamiteSharedTasksAnnotationDataDeletionChange

AppsDynamiteSharedTasksAnnotationDataTaskProperties

All relevant task properties for a Chat message.

AppsDynamiteSharedTasksAnnotationDataUserDefinedMessage

Used for task card attachments on custom user messages that should be kept as is without generating an i18n event message, e.g. the user starts a conversation from an existing task. IMPORTANT: please don't populate this field yet as it could break existing flows until it's implemented. See code at http://shortn/_CM74CdENMx used by http://shortn/_5o85POJY8Q.

AppsDynamiteSharedTasksMessageIntegrationPayload

A payload containing Tasks metadata for rendering a live card. Currently not used by the Tasks integration.

AppsDynamiteSharedUserBlockRelationship

User-block relationship

AppsDynamiteSharedVideoReference

Reference to a transcoded video attachment.

AppsDynamiteStorageAction

An action that describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form.

AppsDynamiteStorageActionActionParameter

List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze 1 day, snooze next week. You might use action method = snooze(), passing the snooze type and snooze time in the list of string parameters.

AppsDynamiteStorageBorderStyle

Represents the complete border style applied to widgets.

AppsDynamiteStorageButton

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

AppsDynamiteStorageButtonList

A list of buttons layed out horizontally.

AppsDynamiteStorageCard

A card is a UI element that can contain UI widgets such as text and images. For more information, see Cards . For example, the following JSON creates a card that has a header with the name, position, icons, and link for a contact, followed by a section with contact information like email and phone number. { "header": { "title": "Heba Salam", "subtitle": "Software Engineer", "imageStyle": "ImageStyle.AVATAR", "imageUrl": "https://example.com/heba_salam.png", "imageAltText": "Avatar for Heba Salam" }, "sections" : [ { "header": "Contact Info", "widgets": [ { "decorated_text": { "icon": { "knownIcon": "EMAIL" }, "content": "heba.salam@example.com" } }, { "decoratedText": { "icon": { "knownIcon": "PERSON" }, "content": "Online" } }, { "decoratedText": { "icon": { "knownIcon": "PHONE" }, "content": "+1 (555) 555-1234" } }, { "buttons": [ { "textButton": { "text": "Share", }, "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "textButton": { "text": "Edit", }, "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ], "loadIndicator": "LoadIndicator.SPINNER" } } } ] } ], "collapsible": true, "uncollapsibleWidgetsCount": 3 } ], "cardActions": [ { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ], "name": "contact-card-K3wB6arF2H9L" }

AppsDynamiteStorageCardCardAction

A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser.

AppsDynamiteStorageCardCardHeader

AppsDynamiteStorageCardSection

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 is currently no need for layout properties, for example, float.

AppsDynamiteStorageColumns

Represents a Columns widget that displays a single row of columns.

AppsDynamiteStorageColumnsColumn

Represents a Column that consists of widgets stacked vertically.

AppsDynamiteStorageColumnsColumnWidgets

LINT.IfChange The column widget can contain these widgets.

AppsDynamiteStorageDateTimePicker

The widget that lets users to specify a date and time.

AppsDynamiteStorageDecoratedText

A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget or a button after the text.

AppsDynamiteStorageDecoratedTextSwitchControl

AppsDynamiteStorageDivider

A divider that appears in between widgets.

AppsDynamiteStorageGrid

Represents a Grid widget that displays items in a configurable grid layout.

AppsDynamiteStorageGridGridItem

Represents a single item in the grid layout.

AppsDynamiteStorageIcon

AppsDynamiteStorageImage

An image that is specified by a URL and can have an onClick action.

AppsDynamiteStorageImageComponent

AppsDynamiteStorageImageCropStyle

Represents the crop style applied to an image.

AppsDynamiteStorageOnClick

AppsDynamiteStorageOpenLink

AppsDynamiteStorageOpenLinkAppUri

Represents the platform specific uri/intent to open for each client.

AppsDynamiteStorageOpenLinkAppUriIntent

Android intent.

AppsDynamiteStorageOpenLinkAppUriIntentExtraData

Extra data for an android intent. Valid keys are defined in the hosting app contract.

AppsDynamiteStorageSelectionInput

A widget that creates a UI item (for example, a drop-down list) with options for users to select.

AppsDynamiteStorageSelectionInputSelectionItem

The item in the switch control. A radio button, at most one of the items is selected.

AppsDynamiteStorageSuggestions

A container wrapping elements necessary for showing suggestion items used in text input autocomplete.

AppsDynamiteStorageSuggestionsSuggestionItem

A suggestion item. Only supports text for now.

AppsDynamiteStorageTextInput

A text input is a UI item where users can input text. A text input can also have an onChange action and suggestions.

AppsDynamiteStorageTextParagraph

A paragraph of text that supports formatting. See Text formatting for details.

AppsDynamiteStorageWidget

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

AppsDynamiteV1ApiCompatV1Action

Interactive objects inside a message. Documentation: - https://api.slack.com/docs/message-buttons

AppsDynamiteV1ApiCompatV1ActionConfirm

Confirmation dialog config.

AppsDynamiteV1ApiCompatV1Attachment

Richly formatted attachments. Documentation: - https://api.slack.com/docs/message-attachments

AppsDynamiteV1ApiCompatV1Field

A column of text in an attachment. Documentation: - https://api.slack.com/docs/message-attachments

AppsExtensionsMarkupCalendarClientActionMarkupAddAttachmentsActionMarkup

AppsExtensionsMarkupCalendarClientActionMarkupAddAttachmentsActionMarkupAddonAttachment

AppsExtensionsMarkupCalendarClientActionMarkupConferenceDataMarkup

Markup that defines conference data associated to a Google Calendar event.

AppsExtensionsMarkupCalendarClientActionMarkupConferenceDataMarkupEntryPointMarkup

A way to join the conference.

AppsExtensionsMarkupCalendarClientActionMarkupConferenceDataMarkupError

Represents an error that occurred during conference creation.

AppsExtensionsMarkupCalendarClientActionMarkupConferenceDataMarkupParameter

Solution-specific parameters that are persisted with the event data and, if an update or delete is needed, are passed to the add-on. For example: [{key: 'sessionKey', value: '123'}, {key: 'meetingId', value: '456'}]

AppsExtensionsMarkupCalendarClientActionMarkupEditAttendeesActionMarkup

AppsExtensionsMarkupCalendarClientActionMarkupEditConferenceDataActionMarkup

Attachment

Attachments that follow the message text.

Attribute

An Attribute is a piece of data attached an Item. Attributes are opaque to the Starbox and have no effect on, nor are they effected by, message storage, indexing, or search.

AttributeRemoved

An attribute was deleted from some (subset of the) messages in this thread.

Attributes

AttributeSet

An attribute was added to some (subset of the) messages in this thread.

AuditLoggingSettings

Represents the settings for Cloud audit logging

AuthorizedItemId

A combination of an identifier for a Drive resource (e.g. file, folder, or drive) and any secrets needed to access it. The secrets should never be logged, and this proto annotates those secret fields to ensure that they are not. Clients are encouraged to use this proto rather than defining their own, to ensure that secrets are correctly annotated.

AutoComplete

AutoCompleteItem

BabelMessageProps

Container for Babel (Hangouts Classic) only message properties. The properties here will not be consumed by Dynamite clients. They are relevant only for Hangouts Classic.

BabelPlaceholderMetadata

Annotation metadata for Babel-only items that signals which type of placeholder message should be displayed in Babel clients.

BooleanOperatorOptions

Used to provide a search operator for boolean properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.

BooleanPropertyOptions

The options for boolean properties.

BorderStyle

Represents a complete border style that can be applied to widgets.

BotInfo

Bot-specific profile information.

BotResponse

Information about a bot response, branched from shared/bot_response.proto without frontend User proto as we never store it.

BroadcastAccess

Broadcast access information of a meeting space.

BroadcastSessionInfo

Information about a broadcast session.

BroadcastStats

Statistics of the broadcast session.

Button

CalendarClientActionMarkup

CallInfo

Contains information regarding an ongoing conference (aka call) for a meeting space.

CallSettings

Effective settings of the ongoing conference.

CapTokenHolderProto

Represents a principal which possesses a particular secret string whose cryptographic hash is specified here. CapTokens ("Capability Tokens") are used in ACLProto. It's expected that ACLs with CapTokenHolders will strongly enforce them by Keystore-wrapping crypto keys for the corresponding CapTokens.

Card

CardAction

When an AddOn Card is shown in detailed view, a card action is the action associated with the card. For an invoice card, a typical action would be: delete invoice, email invoice or open the invoice in browser.

CardCapabilityMetadata

CardHeader

CaribouAttributeValue

ChatClientActionMarkup

Actions handled by Chat Clients.

ChatConserverDynamitePlaceholderMetadata

Metadata used as inputs to the localization that is performed on Dynamite-originated messages that are incompatible with Hangouts clients. See go/localization-of-system-messages for more details.

ChatConserverDynamitePlaceholderMetadataAttachmentMetadata

An attachment uploaded in Dynamite and its filename.

ChatConserverDynamitePlaceholderMetadataBotMessageMetadata

A bot sent a message in Dynamite.

ChatConserverDynamitePlaceholderMetadataCalendarEventMetadata

A Calendar event message in Dynamite.

ChatConserverDynamitePlaceholderMetadataDeleteMetadata

A message was deleted in Dynamite.

ChatConserverDynamitePlaceholderMetadataEditMetadata

An edit was made in Dynamite.

ChatConserverDynamitePlaceholderMetadataTasksMetadata

A Tasks message in Dynamite.

ChatConserverDynamitePlaceholderMetadataVideoCallMetadata

A Meet initiated in Dynamite and its URL.

ChatConserverMessageContent

The content of a chat message, which includes 0 or more segments along with 0 or more embeds, which represent various attachment types (like photos).

ChatContentExtension

NEXT ID: 12

ChatProto

Represents the invitees or other users associated with a Babel Chat (see http://goto/babel). Corresponds to GroupType CHAT in //social/graph/storage/proto/data.proto.

CheckAccessResponse

CircleProto

Represents a Google+ Circle. Currently (12/2011), a Circle is identical to the ContactGroup with matching parameters, but Circle must only be used for true Circles and not other Focus groups, and should be preferred over ContactGroup where applicable. Soon it may become more efficient to check membership in a Circle than in a ContactGroup (see http://go/superglue). Support for this principal type is currently (12/2011) incomplete -- e.g., Keystore does not support it yet (see b/5703421).

ClientContext

Represents the context of the client on behalf of which a HistoryRecord is produced. The ClientContext message can be used to hold context about the service client (e.g. the internal server making fusebox requests) or the user client (e.g. the IP address of the end user).

CloudPrincipalProto

Principal associated with a Cloud Principal representing third party user.

ClusterInfo

ClusterInfo contains clustering related information for a particular thread that would be sent as part of the conversation view. Today, this information would be used by iOS notification server to identify whether the thread belongs to a cluster. If the thread belongs to a grouped cluster, it would identify whether the cluster is throttled.

CoActivity

Metadata about a co-activity session.

Collaboration

Information about a collaboration session.

Color

Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness. For example, the fields of this representation 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 little work, it can be easily formatted into a CSS rgba() string in JavaScript. This reference page doesn't carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications should assume the sRGB color 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.Color fromProto(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()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [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:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&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); } var alphaFrac = 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 = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...

CommunalLabelTag

An individual instance (or "tag") of a label configured as a communal type that's associated with a message.

CompositeFilter

ConsentedAppUnfurlMetadata

Annotation metadata app unfurl consent.

ContactGroupProto

A group of contacts for a given user, as described in http://cs/p#google3/focus/backend/proto/backend.proto Historically (and in still-existing ACLs), this was used to represent Google+ circles as well as contact groups, but this use is now deprecated. New code should use the CIRCLE principal type to represent Google+ circles.

ContentReport

ContentReportJustification

ContentReportSummary

Summarized info of content reports. Usually less expensive to fetch than to fetch all detailed reports. Set only when the request asks for it.

ContextAttribute

A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.

ContextualAddOnMarkup

The markup for developers to specify the contents of a contextual AddOn. A contextual AddOn is triggered in context of an email. For that email, there can be N items that are associated with the email (e.g. contacts, sales lead, meeting information). Each item is represented as a "card". A card has two views, collapsed and detailed. If there are more than 1 card, the cards are show as a list of collapsed views. The end user can expand into the detailed view for each of those cards. In the detailed view, developers have the freedom to use a variety of "widgets" to construct it. The model here is to restrict (make consistent for end users) the navigation of the N cards but providing developers the freedom to build the detailed view that can best represent their use case/content. Go http://go/aoig-widgets1 to see the mocks. Post v1, we plan to support new AddOn use cases that will require different and separate 'templates'. For example, a compose triggered AddOn which will support a new set of use cases with different user interaction patterns. As a result, we will likely need a very different template than this one.

CseInfo

Information needed for Client-side Encryption.

CustomEmojiMetadata

CustomerId

Represents a GSuite customer ID. Obfuscated with CustomerIdObfuscator.

CustomerIndexStats

Aggregation of items by status code as of the specified date.

CustomerQueryStats

CustomerSearchApplicationStats

Search application stats for a customer for the given date.

CustomerSessionStats

CustomerSettings

Represents settings at a customer level.

CustomerUserStats

CustomFunctionReturnValueMarkup

The result of a user running a custom function.

DataLossPreventionMetadata

Annotation metadata for Data Loss Prevention that pertains to DLP violation on message send or edit events. It is used for client -> BE communication and other downstream process in BE (e.g. storage and audit logging), and it should never be returned to the client.

DataSource

Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.

DataSourceIndexStats

Aggregation of items by status code as of the specified date.

DataSourceRestriction

Restriction on Datasource.

Date

Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The date must be a valid calendar date between the year 1 and 9999.

DateOperatorOptions

Optional. Provides a search operator for date properties. Search operators let users restrict the query to specific fields relevant to the type of item being searched.

DatePropertyOptions

The options for date properties.

DateTimePicker

DateValues

List of date values.

DebugOptions

Shared request debug options for all cloudsearch RPC methods.

DeepLinkData

Deep-linking data is used to construct a deep-link URI for an activity or frame's embed, such that on click, the user is taken to the right place in a mobile app. If the app is not installed, the user is taken to the app store. If not on mobile, an analogous web uri is used.

DeleteMetadata

A message delete in Dynamite inserts a Babel-only item containing this field. This is only inserted for messages before the source-of-truth flip. See go/hsc-message-deletions for more details.

DeleteQueueItemsRequest

DeliveryMedium

DisplayedProperty

A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties is displayed in the search results along with the display label for that property if one is specified. If a display label is not specified, only the values is shown.

Divider

DlpScanSummary

A summary of a DLP scan event. This is a summary and should contain the minimum amount of data required to identify and process DLP scans. It is written to Starcast and encoded & returned to the client on attachment upload.

DmId

DocumentInfo

Information on a document attached to an active conference.

DoubleOperatorOptions

Used to provide a search operator for double properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.

DoublePropertyOptions

The options for double properties.

DoubleValues

List of double values.

DriveClientActionMarkup

DriveFollowUpRestrict

Drive follow-up search restricts (e.g. "followup:suggestions").

DriveLocationRestrict

Drive location search restricts (e.g. "is:starred").

DriveMetadata

Annotation metadata for Drive artifacts.

DriveMimeTypeRestrict

Drive mime-type search restricts (e.g. "type:pdf").

DriveTimeSpanRestrict

The time span search restrict (e.g. "after:2017-09-11 before:2017-09-12").

DynamiteMessagesScoringInfo

This is the proto for holding message level scoring information. This data is used for logging in query-api server and for testing purposes.

DynamiteSpacesScoringInfo

This is the proto for holding space level scoring information. This data is used for logging in query-api server and for testing purposes.

EditMetadata

A message edit in Dynamite inserts a Babel-only item containing this field.

EditorClientActionMarkup

EmailAddress

A person's email address.

EmailOwnerProto

Represents a verified owner of the given email address. Note that a single address may have many owners, and a single user may own many addresses. (All lower-case, in display form -- see com.google.gaia.client.GaiaEmail)

EmbedClientItem

Represents an embedded object in an update. This is a wrapper class that can contain a single specific item proto in an extension field. Think of it as a base class like Message in Java. Each item proto must declare that it extends this proto: message ExampleObject { option (item_type) = EXAMPLE_OBJECT; extend EmbedClientItem { optional ExampleObject example_object = ; } } See go/es-embeds for details.

EnumOperatorOptions

Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a priority enum property with possible values p0 and p1, a query that contains the term p0 returns items that have p0 as the value of the priority property, as well as any items that contain the string p0 in other fields. If you provide an operator name for the enum, such as priority, then search users can use that operator to refine results to only items that have p0 as this property's value, with the query priority:p0.

EnumPropertyOptions

The options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value. For example, for items in a request tracking system with priority information, you could define p0 as an allowable enum value and tie this enum to the operator name priority so that search users could add priority:p0 to their query to restrict the set of results to only those items indexed with the value p0.

EnumValuePair

The enumeration value pair defines two things: a required string value and an optional integer value. The string value defines the necessary query term required to retrieve that item, such as p0 for a priority item. The integer value determines the ranking of that string value relative to other enumerated values for the same property. For example, you might associate p0 with 0 and define another enum pair such as p1 and 1. You must use the integer value in combination with ordered ranking to set the ranking of a given value relative to other enumerated values for the same property name. Here, a ranking order of DESCENDING for priority properties results in a ranking boost for items indexed with a value of p0 compared to items indexed with a value of p1. Without a specified ranking order, the integer value has no effect on item ranking.

EnumValues

List of enum values.

ErrorInfo

Error information about the response.

ErrorMessage

Error message per source response.

EventAnnotation

EventProto

Represents the invitees or other users associated with a Google+ Event (see http://goto/events-backend-design).

FacetBucket

A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object.

FacetOptions

Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.

FacetResult

Source specific facet response

FieldViolation

Filter

A generic way of expressing filters in a query, which supports two approaches: 1. Setting a ValueFilter. The name must match an operator_name defined in the schema for your data source. 2. Setting a CompositeFilter. The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND.

FilterCreated

A filter was created.

FilterDeleted

A filter was deleted.

FilterOptions

Filter options to be applied on query.

FilterUpdate

HistoryRecord for changes associated with a filter, namely: FILTER_CREATED FILTER_DELETED

FixedFooter

A persistent (sticky) footer that is added to the bottom of the card.

Folder

FolderAttribute

This is the content of //imapsync/folder attribute.

FormAction

FormatMetadata

Annotation metadata for markup formatting

Formatting

Formatting information for a segment.

FreshnessOptions

Indicates which freshness property to use when adjusting search ranking for an item. Fresher, more recent dates indicate higher quality. Use the freshness option property that best works with your data. For fileshare documents, last modified time is most relevant. For calendar event data, the time when the event occurs is a more relevant freshness indicator. In this way, calendar events that occur closer to the time of the search query are considered higher quality and ranked accordingly.

FuseboxItem

The Item message is the read interface for user data (traditionally referred to as a "message", such as a mail message or a chat message, but generalized to encompass other types such as tasks) and stored in Tingle. Each Item is associated with a single Thread. An Item contains three classes of data. (1): Item "fields" are common to items of all message types (e.g. mail, chat, task, etc.) and are identified by the ItemFieldSpec.FetchType enum when fetching Items. (2): Item "attributes" represent data associated with an Item that is stored on behalf of the client but to which the fusebox and storage layers are otherwise agnostic. (3): Item "parts" are application-defined protocol buffers that affect how the Item is indexed. Item parts are referenced as extensions to the ItemParts message. By default the application specifies the index terms associated with an Item part. For performance sensitive applications, the storage layer can be modified to understand and index data types natively.

FuseboxItemThreadMatchInfo

In the context of a search, the MatchInfo contains information about which Items matched the query.

FuseboxPrefUpdatePreState

If the Value field is not set this means the pref did not exist.

GaiaGroupProto

GaiaUserProto

A Gaia account, which may represent a user, device, service account, etc. For prod (@prod.google.com) accounts, use MdbUserProto instead.

GatewayAccess

Details on the third-party interoperability settings for the meeting space.

GatewaySipAccess

Details how to join the conference via a SIP gateway.

GetCustomerIndexStatsResponse

GetCustomerQueryStatsResponse

GetCustomerSearchApplicationStatsResponse

Response format for search application stats for a customer.

GetCustomerSessionStatsResponse

GetCustomerUserStatsResponse

GetDataSourceIndexStatsResponse

GetSearchApplicationQueryStatsResponse

Response format for getting query stats for a search application between given dates.

GetSearchApplicationSessionStatsResponse

GetSearchApplicationUserStatsResponse

GmailClientActionMarkup

GoogleChatV1ContextualAddOnMarkup

The markup for developers to specify the contents of a contextual AddOn.

GoogleChatV1ContextualAddOnMarkupCard

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

GoogleChatV1ContextualAddOnMarkupCardCardAction

A card action is the action associated with the card. For an invoice card, a typical action would be: delete invoice, email invoice or open the invoice in browser. Not supported by Google Chat apps.

GoogleChatV1ContextualAddOnMarkupCardCardHeader

GoogleChatV1ContextualAddOnMarkupCardSection

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 is currently no need for layout properties (e.g. float).

GoogleChatV1WidgetMarkup

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

GoogleChatV1WidgetMarkupButton

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

GoogleChatV1WidgetMarkupFormAction

A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form.

GoogleChatV1WidgetMarkupFormActionActionParameter

GoogleChatV1WidgetMarkupImage

An image that is specified by a URL and can have an onclick action.

GoogleChatV1WidgetMarkupImageButton

An image button with an onclick action.

GoogleChatV1WidgetMarkupKeyValue

A UI element contains a key (label) and a value (content). And this element may also contain some actions such as onclick button.

GoogleChatV1WidgetMarkupOnClick

An onclick action (e.g. open a link).

GoogleChatV1WidgetMarkupOpenLink

A link that opens a new window.

GoogleChatV1WidgetMarkupTextButton

A button with text and onclick action.

GoogleChatV1WidgetMarkupTextParagraph

A paragraph of text. Formatted text supported.

GoogleDocsMetadata

The corpus specific metadata for office-type documents, from Google Docs and other sources. This message is passed to the scorer and beyond. Next tag: 9

GoogleDocsResultInfo

A message containing information about a specific result. This information is passed to the scorer and beyond; in particular, GWS relies on it to format the result in the UI. Split from GoogleDocsMetadata in case we later want to reuse the message.

Grid

GridItem

GroupDetailsUpdatedMetadata

GroupId

Id representing a group that could be a space, a chat, or a direct message space. Which ID is set here will determine which group

GroupLinkSharingModificationEvent

GroupRetentionSettingsUpdatedMetaData

GsuiteIntegrationMetadata

Annotation metadata for an GsuiteIntegration artifact.

GSuitePrincipal

HangoutEvent

HangoutVideoEventMetadata

A message representing the Hangout video start/end events in Babel

HashtagData

Hashtag metadata, for HASHTAG segments. For a hashtag, the "text" field should contain the display text, and the search_text field should represent the topic being referenced, without the hash symbol; for example, we might have: text = "#Google" hashtag_data.search_text = "Google" Another example: text = "#pikachu" hashtag_data.search_text = "Pokemon" Both strings should be considered part of the searchable text. In go/sbe, both are indexed and searchable.

History

The most recent history records associated with the item.

HistoryRecord

HostAppActionMarkup

Actions handled by individual host apps.

HostProto

Represents a single host. Optionally, the MDB owner of the host can be specified.

HtmlOperatorOptions

Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.

HtmlPropertyOptions

The options for html properties.

HtmlValues

List of html values.

IconImage

Id

Identifies a particular object, including both Users and DirEntries. This Id is unique across the entire server instance, such as the production or qa instance.

Image

ImageButton

ImageComponent

NOTE: Through future refactoring work, this image component will eventually be used in the Image widget, and will likely replace the Icon proto as well.

ImageCropStyle

Represents a crop style that can be applied to an image.

ImageKeyValue

This is deprecated and please use KeyValue.

ImapSessionContext

ImapSyncDelete

Message delete history record extension that exports //imapsync/folder attribute of deleted messages which have ^is label.

ImapsyncFolderAttributeFolderMessage

ImapsyncFolderAttributeFolderMessageFlags

ImapUidsReassign

ImapUpdate

HistoryRecord for changes associated with IMAP, namely: IMAP_UIDS_REASSIGN

IncomingWebhookChangedMetadata

Annotation metadata to display system messages for incoming webhook events. Next Tag: 7

IndexItemOptions

IndexItemRequest

InitializeCustomerRequest

Request message for InitializeCustomer method.

InsertContent

IntegerFacetingOptions

Used to specify integer faceting options.

IntegerOperatorOptions

Used to provide a search operator for integer properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.

IntegerPropertyOptions

The options for integer properties.

IntegerValues

List of integer values.

IntegrationConfigMutation

IntegrationConfigUpdatedMetadata

Annotation metadata to display system message for integration config updated event. This metadata is stored in spanner, and can be dispatched to clients without any field modification or transformation.

Interaction

Represents an interaction between a user and an item.

InteractionData

Interaction data for an annotation, which may be supplemental to the metadata oneof. For example, this will contain the fully built navigation target for smart chips. NEXT TAG: 2

InviteAcceptedEvent

InviteeInfo

Invitee information from a Dynamite invitation. See go/dynamite-invitee-mgmt.

Item

Represents a single object that is an item in the search index, such as a file, folder, or a database record.

ItemAcl

Access control list information for the item. For more information see Map ACLs.

ItemContent

Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded.

ItemCountByStatus

ItemMetadata

Available metadata fields for the item.

ItemParts

Container for type-specific extensions of an Item. This protobuf is defined in a separate file to allow types to reference/extend the message without depending on other fusebox protobufs. See items.proto.

ItemStatus

This contains item's status and any errors.

ItemStructuredData

Available structured data fields for the item.

ItemThread

An ItemThread is an ordered list of Items. An ItemThread corresponds to a "conversation" in the context of mail. An Item belongs to exactly one ItemThread.

JobsettedServerSpec

Identifies a jobsetted server as a target for Trigger dispatch.

KeyValue

LabelAdded

A label was added to some (subset of the) messages in this thread.

LabelCreated

A label was created.

LabelDeleted

A label was deleted.

LabelRemoved

A label was removed from some (subset of the) messages in this thread.

LabelRenamed

A label was renamed.

Labels

LabelUpdate

HistoryRecord for changes associated with a label, namely: LABEL_CREATED LABEL_DELETED LABEL_RENAMED LABEL_UPDATED

LabelUpdated

A label pref was updated outside of a rename, create, or delete.

LanguageConfig

The language configuration for the session.

LdapGroupProto

LdapUserProto

LegacyUploadMetadata

The original UploadMetadata that this DriveMetadata was converted from.

LinkData

Link metadata, for LINK segments. Anchor text should be stored in the "text" field of the Segment, which can also serve as a fallback.

ListDataSourceResponse

ListItemNamesForUnmappedIdentityResponse

ListItemsResponse

ListOperationsResponse

The response message for Operations.ListOperations.

ListQuerySourcesResponse

List sources response.

ListSearchApplicationsResponse

ListUnmappedIdentitiesResponse

MatchInfo

MatchRange

Matched range of a snippet [start, end).

MdbGroupProto

An entity from the MDB namespace that is to be interpreted as a group. If using this for authorization, you should do an exact match of the peer role against group_name or any of the names in the Chubby expansion of the MDB group named group_name.

MdbUserProto

An entity from the MDB namespace that is to be interpreted as a user. If using this for authorization, you should only do an exact match on the peer role against user_name.

Media

Media resource.

MeetingSpace

A meeting space is a persistent object that is the context for one or more calls. The meeting space is what makes users find each other when they want to meet and to find shared resources. With two exceptions, all the fields in the meeting space resource are visible publicly to any client, even anonymous users. The exceptions are that * The call_info field is only visible to clients that have a device (as indicated by the meeting token) in the JOINED or HIDDEN state. * The meeting_alias field will only be set for users who are in the same domain as the meeting space. The meeting space resource (outside call_info) should only contain information necessary to join a call in the meeting space, and not any other metadata about the meeting space, such as what organization it belongs to or things related to ongoing calls.

Member

MemberId

Eventually this can be updated to a oneOf User, Space (for nested spaces), Bots or Service, as and when these use cases come up.

MembershipChangedMetadata

Annotation metadata to display system messages for membership changes. Next Tag: 8

MembershipChangeEvent

MenuItem

Message

Message posted to a Space.

MessageAdded

A message was added. Specifying id and initial labels.

MessageAttributes

Stores tombstone message attributes: go/tombstone-message-attributes-overview

MessageDeleted

Some (subset of the) messages in this thread were deleted.

MessageId

Primary key for Message resource.

MessageInfo

MessageParentId

Primary key identifying Message resource's immediate parent. For top-level Messages, either topic_id or chat_id is populated. For replies, message_id is populated with the topic Message's ID.

MessageProps

Container for storing properties applicable to messages. For now (until storage consolidation is complete), it will only be used for babel props. In the future it could be used to house Dynamite properties for experimenting/rapid prototyping.

MessageSet

This is proto2's version of MessageSet.

Metadata

Metadata of a matched search result.

Metaline

A metaline is a list of properties that are displayed along with the search result to provide context.

MultiKey

A union-like type for identifiying an object in storage. MultiKeys contain multiple key fields, each in a separate key space. At least one key field must be set. More than one key field may be set as long as all key values refer to the same object. All objects in storage have unique server_id keys. All MultiKeys returned from storage to storage clients will always have the server_id field set. When creating an object, if a MultiKey without a server_id is supplied to storage, the storage system will auto-assign a server ID to the new object. For all other storage requests (i.e. those not creating new objects), clients may omit server_id (as long as they supply another key). Instead of server ids, clients can specify string based client_assigned_perm_id keys. Mail message drafts are a prime example of these kinds of objects. Each time a user saves a new version of a draft, the storage system needs to create a new object with the updated draft content and needs to delete the object containing the old content. The new object gets a new SERVER_ID but should get the same CLIENT_ASSIGNED_PERM_ID as the now-deleted object containing the old content. Carrying forward the perm ID allows it to be used to consistently refer to the same logical object across revisions. These perm IDs save sync clients from having to deal with changing object IDs. For example, assume there's a mail message in storage with SERVER_ID = 123 and CLIENT_ASSIGNED_PERM_ID = "foo". The following are all valid ways of addressing the object using MultiKeys: 1) MultiKey { server_id = 123 } 2) MultiKey { server_id = 123, client_assigned_perm_id = "foo" } 3) MultiKey { client_assigned_perm_id = "foo" } Multikeys are never serialized in the storage. The individual keys are extracted and processed separately. Both the integer ids as well as string ids are indexed for efficient retrieval using the same fields in the backend. See go/tingle-multikeys for more information on background and motivation.

Name

A person's name.

NamedProperty

A typed name-value pair for structured data. The type of the value should be the same as the registered type for the name property in the object definition of objectType.

OAuthConsumerProto

Represents an OAuth consumer, a/k/a AuthSub target. These principals are identified by domain name (e.g., example.com). Historically, Dasher domain GAIA group IDs have been used instead, but that doesn't work: http://go/tricky-gaia-ids

ObjectDefinition

The definition for an object within a data source.

ObjectDisplayOptions

The display options for an object.

ObjectOptions

The options for an object.

ObjectPropertyOptions

The options for object properties.

ObjectValues

List of object values.

OnClick

OpenCreatedDraftActionMarkup

OpenLink

Operation

This resource represents a long-running operation that is the result of a network API call.

OsVersion

OtrChatMessageEvent

OtrModificationEvent

PackagingServiceClient

Developers register a client in Google API Console to get the deep-linking feature on Google+ posts or frames about their apps. The client data is stored in this proto.

PaygateInfo

Information provided to clients so that they can show upgrade promos and warnings on call ending early (for non-paying users).

PeopleSuggestion

This field contains information about the person being suggested.

Person

Object to represent a person.

PersonalLabelTag

An individual instance (or "tag") of a label configured as a personal type that's associated with a message.

PhoneAccess

Phone access contains information required to dial into a conference using a regional phone number and a PIN that is specific to that phone number.

PhoneNumber

A person's Phone Number

Photo

A person's photo.

PinnedItemId

PollItemsRequest

PollItemsResponse

PossiblyTrimmedModel

This message contains either the device model, or a prefix of the device model (AKA a trimmed device model). The "is_trimmed" field indicates which one it is.

PostiniUserProto

See http://s/?fileprint=//depot/google3/security/authentication/postini/auth_token.proto

PrefDeleted

PREF_DELETED

PrefUpdate

HistoryRecord for changes associated with prefs, namely: PREF_WRITTEN PREF_DELETED

PrefWritten

PREF_WRITTEN

Presenter

Presenter contains information about which device is currently presenting as well as which device requested the presenter to be set.

PreState

State of the thread previous to the update. This really just describes the label state of all messages before the update.

Principal

Reference to a user, group, or domain.

PrincipalProto

A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange

PrivateMessageInfo

Private message information specific to a given user. DEPRECATED: Use the privateMessageViewer field in CreateMessageInfo instead.

ProcessingError

PropertyDefinition

The definition of a property within an object.

PropertyDisplayOptions

The display options for a property.

Provenance

This field records where the ItemScope was retrieved, if it was created via a web fetch.

PushItem

Represents an item to be pushed to the indexing queue.

PushItemRequest

QueryCountByStatus

QueryInterpretation

QueryInterpretationConfig

Default options to interpret user query.

QueryInterpretationOptions

Options to interpret user query.

QueryItem

Information relevant only to a query entry.

QueryOperator

The definition of a operator that can be used in a Search/Suggest request.

QuerySource

List of sources that the user can search using the query API.

QuerySuggestion

This field does not contain anything as of now and is just used as an indicator that the suggest result was a phrase completion.

QuotedMessageMetadata

Quote metadata: go/message-quoting-be-dd-v2. This proto is only used on the read path. For the request proto, refer to QuotedMessagePayload. Fields are either derived from storage directly from the Item this metadata belongs to, or is hydrated at read time from another Item read. Note: QuotedMessageMetadata proto is similar to Message proto with less field. Reasons to differtiate QuotedMessageMetadata from Message are: 1. Not all fields for original message is applicable for quoted message. (E.g. reactions, is_inline_reply, etc.), thus separting out for confusion. 2. We don't support nested message quoting. For more detailed discussion, please see http://shortn/_VsSXQb2C7P. For future reference: if your new feature/field will be supported in message quoting feature (go/chat-quoting-prd), you will need to add that field within QuotedMessageMetadata

Rank

The rank contains a tuple of numbers which may be used as a general sort order. The rank should be treated as an ordered set of numbers, where the ordering is done in descending order of the most significant rank member. For example, given the following ranks described as (primary, secondary): (1,1), (1,2), (2,2) (2,1) The descending rank-order is: (2,2) > (2,1) > (1,2) > (1,1)

RbacRoleProto

Principal associated with a given RBAC role. This principal is used by Sphinx Provisioning Service for RBAC provisionable (go/sphinx-rbacz).

RbacSubjectProto

Principal associated with a given RBAC subject. This principal is used by Sphinx Provisioning Service for RBAC provisionable (go/sphinx-rbacz).

ReactionInfo

Contains information about an emoji reaction.

ReadReceiptsSettingsUpdatedMetadata

Recipient

RecordingEvent

A recording event is something that happens to the recording in a conference.

RecordingInfo

This message is deprecated, please use RecordingSessionInfo instead. Information about recording in the current conference.

RecordingSessionInfo

Information about a recording session.

Reference

All fields in this proto are now columns in spanner see google3/storage/slice/production/gmail/user_data_tables.pi for documentation.

References

RenameEvent

RepositoryError

Errors when the connector is communicating to the source repository.

RequestFileScope

RequestFileScopeForActiveDocument

RequestOptions

Shared request options for all RPC methods.

RequiredMessageFeaturesMetadata

A list of capabilities that are used in this message.

ResetSearchApplicationRequest

ResourceRoleProto

A type of sharing target that points to some resource's ACL. Used to refer to the set of Principals that have the given privilege ('role_id') for the given resource ('application_id', 'object_id', 'object_part'). The meaning of 'role_id' is interpreted only by implementations of AclRpcService and is usually dependent on 'application_id' All fields except object_part are required. If present, object_part must be non-empty.

ResponseDebugInfo

Debugging information about the response.

RestrictItem

Information relevant only to a restrict entry. NextId: 12

ResultCounts

Result count information

ResultDebugInfo

Debugging information about the result.

ResultDisplayField

Display Fields for Search Results

ResultDisplayLine

The collection of fields that make up a displayed line

ResultDisplayMetadata

RetrievalImportance

RoomRenameMetadata

RoomUpdatedMetadata

Roster

Roster profile information.

RosterId

Primary key for Roster resource.

RpcOptions

Options for Triggers dispatched via RPC.

SafeUrlProto

Message containing a string that is safe to use in URL contexts in DOM APIs and HTML documents, where the URL context does not refer to a resource that loads code.

Schema

The schema definition for a data source.

ScoringConfig

Scoring configurations for a source while processing a Search or Suggest request.

SearchApplication

SearchApplicationQueryStats

Search application level query stats per date

SearchApplicationSessionStats

SearchApplicationUserStats

SearchItemsByViewUrlRequest

SearchItemsByViewUrlResponse

SearchQualityMetadata

Additional search quality metadata of the item.

SearchRequest

The search API request.

SearchResponse

The search API response.

SearchResult

Results containing indexed information for a document.

Section

Sections are separated by a line divider. They contain a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, AddOns have a narrow fixed width, so there is currently no need for layout properties (e.g. float).

Segment

SelectionControl

SelectionItem

SessionContext

SessionEvent

A session event is something that happens to the streaming session in a conference.

SessionStateInfo

Information about the state of a (recording, broadcast, transcription...) session in a conference.

Settings

Settings of a meeting space that can be edited by users with corresponding manage privilege. These settings are always populated in responses.

ShareScope

SheetsClientActionMarkup

SigningKeyPossessorProto

Represents a principal who possesses a signing key corresponding to the verification key or keyset described here.

SimpleSecretHolderProto

Represents a principal which possesses a particular, presumably secret, string. Useful for things like "auth keys," used for anonymous sharing. Since representing this principal with the actual secret included reveals the secret, it's best if the requisite condition is enforced in some other way, for example via Keystore wrapping attributes (Keystore will unwrap only if the specified secret, aka "attribute", is presented). All that's stored here is an identifying label.

SimpleSecretLabelProto

SimpleSecretProto (in authenticator.proto) and SimpleSecretHolderProto (below) share the notion of a "label", which identifies a particular secret without (hopefully) revealing the secret. Note that a SimpleSecretLabel only disambiguates between secrets used to get access to some particular object. Two different secrets that apply to two different objects could have the same label. For example, in the common sharing model, each object has no more than one "auth key". Therefore, the label for an auth key simply has type = AUTH_KEY with no additional information. In theory, we could add some sort of resource ID to SimpleSecretLabel to make it more explicit. However, in practice, this is never really needed. A SimpleSecret for one object is never used to authorize a request on some other object, so there is no ambiguity. Also, since SimpleSecrets must obviously be unguessable, there is no risk that a SimpleSecret intended for one object will accidentally grant access to another.

SlashCommandMetadata

Annotation metadata for slash commands (/).

Snippet

Snippet of the search result, which summarizes the content of the resulting page.

SocialCommonAttachmentAttachment

An Attachment represents a linked entity associated with a piece of social content. This may be a 1st-party or 3rd-party entity. In the Papyrus context, an Attachment is part of a Cent, and sits alongside the main content of the cent, which is represented as a sequence of Segments. Right now an Attachment is just a wrapper around an Embed, but we provide the extra layer of abstraction since, as Embeds move to separate storage in Briefcase, we may want to add additional fields that are not part of the Embed proper, but that (for example) relate to the usage of the linked content within the particular post/cent.

SocialGraphNodeProto

Represents a user pseudonym. Pseudonyms are linked accounts on Google and third-party services (e.g. YouTube or Twitter) and are described by a Social Graph Node.

SortOptions

Source

Defines sources for the suggest/search APIs.

SourceConfig

Configurations for a source while processing a Search or Suggest request.

SourceCrowdingConfig

Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host "crowd out" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source.

SourceResultCount

Per source result count information.

SourceScoringConfig

Set the scoring configuration. This allows modifying the ranking of results for a source.

SpaceId

Primary key for Space resource.

SpellResult

SquareProto

Represents the set of members (of a given type) in a Google+ Square (see http://go/squares). A Square with default member_type is currently (1/2012) identical to the GaiaGroup with the same ID, but that is expected to change soon (see http://go/superglue). Support for this principal type is currently (1/2012) incomplete -- e.g., Keystore does not support it yet (see b/5703421).

StartUploadItemRequest

Start upload file request.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

StoredParticipantId

StreamingSessionInfo

Information about a streaming session in conference.

StreamViewerStats

Information about viewers of the stream.

StructuredDataObject

A structured data object consisting of named properties.

StructuredResult

Structured results that are returned as part of search request.

SuggestRequest

Request of suggest API.

SuggestResponse

Response of the suggest API.

SuggestResult

One suggestion result.

SupportUrls

Urls with additional bot related information.

SwitchWidget

TaskActionMarkup

TextButton

TextField

TextKeyValue

This is deprecated and please use KeyValue.

TextOperatorOptions

Used to provide a search operator for text properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.

TextParagraph

TextPropertyOptions

The options for text properties.

TextValues

List of text values.

ThreadKeySet

The ThreadKey was set on some (subset of the) messages in this thread.

ThreadUpdate

HistoryRecord for changes associated with a thread, namely: MESSAGE_ADDED MESSAGE_DELETED LABEL_ADDED LABEL_REMOVED ATTRIBUTE_SET ATTRIBUTE_REMOVED THREAD_KEY_SET All label_ids refer to the (unchanging) value as defined by the Label.id field in labels.proto. In particular, it is not the canonical_name.

TimestampOperatorOptions

Used to provide a search operator for timestamp properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.

TimestampPropertyOptions

The options for timestamp properties.

TimestampValues

List of timestamp values.

TombstoneMetadata

Tombstoning is the act of leaving a contextual trace when deleting a message. See more: go/tombstone-prd, go/hub-dynamite-tombstones-server-design-v2.

Toolbar

The Toolbar markup has been deprecated. The information is now specified in the manifest.

TopicId

TopicState

State of an topic thread as maintained within Tingle.

TopicStateUpdate

TransactionContext

Storage information pertaining to the transaction with which a HistoryRecord is associated.

TransactionDebugInfo

HistoryRecord for debug info associated with the transaction, namely: TXN_DEBUG_INFO TODO(b/143845917) This is a short-term workaround for unblocking fusebox writes migration. Clean up the code or land a long-term solution after the rollout. go/diff-to-historyrecord

TranscriptionSessionInfo

Information about a transcription session.

TransientData

Transient generic data that will not be saved on the server.

Trigger

TriggerAction

TriggerKey

A TriggerKey (type + instance_id) uniquely identifies a trigger within a message for a message-trigger and within an account for an account-trigger.

Triggers

TrustedResourceUrlProto

Message containing a string that is safe to use in all URL contexts in DOM APIs and HTML documents; even where the referred-to resource is interpreted as code, e.g., as the src of a script element.

TypeInfo

Next tag: 2

UniversalPhoneAccess

Universal phone access contains information required to dial into a conference using one of a static list of phone numbers and a universal PIN. The phone number list is distributed separately.

UnmappedIdentity

UnreserveItemsRequest

UpdateBccRecipients

UpdateBody

UpdateCcRecipients

UpdateDataSourceRequest

UpdateDraftActionMarkup

UpdateSchemaRequest

UpdateSubject

UpdateToRecipients

UploadItemRef

Represents an upload session reference. This reference is created via upload method. This reference is valid for 30 days after its creation. Updating of item content may refer to this uploaded content via contentDataRef.

UploadMetadata

Annotation metadata for user Upload artifacts.

UrlMetadata

Annotation metadata for a Weblink. In case of pasted link it can qualify to be other types in addition to being a URL - like DRIVE_DOC/DRIVE_SHEET and so on. The URL metadata will also be present and it's up to the client to decide which metadata to render it with. These fields are filled in using page render service.

User

User profile information. This user is not necessarily member of a space.

UserDisplayInfo

Resource for displaying user info

UserId

Primary key for User resource.

UserInfo

Contains info regarding the updater of an Activity Feed item. Next Id: 8

UserMentionData

Person metadata, for USER_MENTION segments. Should always contain at least one of user_gaia_id, user_id, email or user. The exact set of populated fields may differ depending on the context and the level in the serving stack; for example, emails will be elided on the viewing path. But as a general rule, a proto having any one of the four is valid, subject to the standard constraints of the applied annotations -- that is, communication between servers and clients will ignore jspb.ignore fields, and communication between servers and other servers (or between servers and storage) will ignore client_only fields. For more on the annotations, see the comments in social/common/segment_annotations.proto

UserMentionMetadata

Annotation metadata for user mentions (+/@/-).

Value

Definition of a single value with generic type.

ValueFilter

VideoCallMetadata

VideoInfo

Next tag: 2

VoicePhoneNumber

Represents both long and short phone number that can be called or texted. Short telephone numbers are used to reach local services. Short numbers and their purpose differ from country to country. These numbers in US are in the form of N11 which is a three-digit abbreviated dialing telephone number.

VoicePhoneNumberI18nData

VPCSettings

WhiteboardInfo

Information on a whiteboard attached to an active conference. A whiteboard is a Jam document.

WidgetMarkup

WonderCardDelete

Message delete history record extension that exports /wonder/message_mapping/{vertical} attribute of deleted messages which have any smartmail label (eg. ^cob_sm_invoice). go/how-dd-card-deletion

WonderMessageMapping

Card mapping attached to original message as an attribute stored at /wonder/message_mapping/{vertical} Next ID: 2

WrappedResourceKey

A wrapper around a raw resource key. The secret should never be logged, and this proto annotates those secret fields to ensure that they are not. Clients are encouraged to use this proto rather than defining their own, to ensure that secrets are correctly annotated.