Package com.google.apps.card.v1
Class Card.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
com.google.apps.card.v1.Card.Builder
- All Implemented Interfaces:
CardOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- Card
public static final class Card.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
implements CardOrBuilder
A card interface displayed in a Google Chat message or Google Workspace
add-on.
Cards support a defined layout, interactive UI elements like buttons, and
rich media like images. Use cards to present detailed information,
gather information from users, and guide users to take a next step.
[Card builder](https://addons.gsuite.google.com/uikit/builder)
To learn how
to build cards, see the following documentation:
* For Google Chat 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 are ignored. This limit applies to both card messages and dialogs
in Google Chat apps, and to cards in Google Workspace add-ons.
**Example: Card message for a Google Chat app**

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": "<font color=\"#80e27e\">Online</font>"
}
},
{
"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"
}
]
}
}
}
]
}
}
]
}
]
}
}
]
}
```
Protobuf type google.apps.card.v1.Card-
Method Summary
Modifier and TypeMethodDescriptionaddAllCardActions(Iterable<? extends Card.CardAction> values) The card's actions.addAllSections(Iterable<? extends Card.Section> values) Contains a collection of widgets.addCardActions(int index, Card.CardAction value) The card's actions.addCardActions(int index, Card.CardAction.Builder builderForValue) The card's actions.addCardActions(Card.CardAction value) The card's actions.addCardActions(Card.CardAction.Builder builderForValue) The card's actions.The card's actions.addCardActionsBuilder(int index) The card's actions.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) addSections(int index, Card.Section value) Contains a collection of widgets.addSections(int index, Card.Section.Builder builderForValue) Contains a collection of widgets.addSections(Card.Section value) Contains a collection of widgets.addSections(Card.Section.Builder builderForValue) Contains a collection of widgets.Contains a collection of widgets.addSectionsBuilder(int index) Contains a collection of widgets.build()clear()The card's actions.In Google Workspace add-ons, sets the display properties of the `peekCardHeader`.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) The fixed footer shown at the bottom of this card.The header of the card.Name of the card.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) 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.The divider style between the header, sections and footer.Contains a collection of widgets.clone()getCardActions(int index) The card's actions.getCardActionsBuilder(int index) The card's actions.The card's actions.intThe card's actions.The card's actions.getCardActionsOrBuilder(int index) The card's actions.List<? extends Card.CardActionOrBuilder>The card's actions.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorIn Google Workspace add-ons, sets the display properties of the `peekCardHeader`.intIn Google Workspace add-ons, sets the display properties of the `peekCardHeader`.The fixed footer shown at the bottom of this card.The fixed footer shown at the bottom of this card.The fixed footer shown at the bottom of this card.The header of the card.The header of the card.The header of the card.getName()Name of the card.com.google.protobuf.ByteStringName of the card.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.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.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.The divider style between the header, sections and footer.intThe divider style between the header, sections and footer.getSections(int index) Contains a collection of widgets.getSectionsBuilder(int index) Contains a collection of widgets.Contains a collection of widgets.intContains a collection of widgets.Contains a collection of widgets.getSectionsOrBuilder(int index) Contains a collection of widgets.List<? extends Card.SectionOrBuilder>Contains a collection of widgets.booleanThe fixed footer shown at the bottom of this card.booleanThe header of the card.booleanWhen 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.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanThe fixed footer shown at the bottom of this card.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeHeader(Card.CardHeader value) The header of the card.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.final Card.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) removeCardActions(int index) The card's actions.removeSections(int index) Contains a collection of widgets.setCardActions(int index, Card.CardAction value) The card's actions.setCardActions(int index, Card.CardAction.Builder builderForValue) The card's actions.setDisplayStyle(Card.DisplayStyle value) In Google Workspace add-ons, sets the display properties of the `peekCardHeader`.setDisplayStyleValue(int value) In Google Workspace add-ons, sets the display properties of the `peekCardHeader`.The fixed footer shown at the bottom of this card.setFixedFooter(Card.CardFixedFooter.Builder builderForValue) The fixed footer shown at the bottom of this card.setHeader(Card.CardHeader value) The header of the card.setHeader(Card.CardHeader.Builder builderForValue) The header of the card.Name of the card.setNameBytes(com.google.protobuf.ByteString value) Name of the card.setPeekCardHeader(Card.CardHeader value) 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.setPeekCardHeader(Card.CardHeader.Builder builderForValue) 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.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) The divider style between the header, sections and footer.setSectionDividerStyleValue(int value) The divider style between the header, sections and footer.setSections(int index, Card.Section value) Contains a collection of widgets.setSections(int index, Card.Section.Builder builderForValue) Contains a collection of widgets.final Card.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
setField
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
setRepeatedField
public Card.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
addRepeatedField
public Card.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Card.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
mergeFrom
public Card.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Card.Builder>- Throws:
IOException
-
hasHeader
public boolean hasHeader()The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.
.google.apps.card.v1.Card.CardHeader header = 1;- Specified by:
hasHeaderin interfaceCardOrBuilder- Returns:
- Whether the header field is set.
-
getHeader
The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.
.google.apps.card.v1.Card.CardHeader header = 1;- Specified by:
getHeaderin interfaceCardOrBuilder- Returns:
- The header.
-
setHeader
The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.
.google.apps.card.v1.Card.CardHeader header = 1; -
setHeader
The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.
.google.apps.card.v1.Card.CardHeader header = 1; -
mergeHeader
The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.
.google.apps.card.v1.Card.CardHeader header = 1; -
clearHeader
The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.
.google.apps.card.v1.Card.CardHeader header = 1; -
getHeaderBuilder
The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.
.google.apps.card.v1.Card.CardHeader header = 1; -
getHeaderOrBuilder
The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.
.google.apps.card.v1.Card.CardHeader header = 1;- Specified by:
getHeaderOrBuilderin interfaceCardOrBuilder
-
getSectionsList
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).
repeated .google.apps.card.v1.Card.Section sections = 2;- Specified by:
getSectionsListin interfaceCardOrBuilder
-
getSectionsCount
public int getSectionsCount()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).
repeated .google.apps.card.v1.Card.Section sections = 2;- Specified by:
getSectionsCountin interfaceCardOrBuilder
-
getSections
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).
repeated .google.apps.card.v1.Card.Section sections = 2;- Specified by:
getSectionsin interfaceCardOrBuilder
-
setSections
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).
repeated .google.apps.card.v1.Card.Section sections = 2; -
setSections
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).
repeated .google.apps.card.v1.Card.Section sections = 2; -
addSections
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).
repeated .google.apps.card.v1.Card.Section sections = 2; -
addSections
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).
repeated .google.apps.card.v1.Card.Section sections = 2; -
addSections
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).
repeated .google.apps.card.v1.Card.Section sections = 2; -
addSections
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).
repeated .google.apps.card.v1.Card.Section sections = 2; -
addAllSections
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).
repeated .google.apps.card.v1.Card.Section sections = 2; -
clearSections
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).
repeated .google.apps.card.v1.Card.Section sections = 2; -
removeSections
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).
repeated .google.apps.card.v1.Card.Section sections = 2; -
getSectionsBuilder
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).
repeated .google.apps.card.v1.Card.Section sections = 2; -
getSectionsOrBuilder
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).
repeated .google.apps.card.v1.Card.Section sections = 2;- Specified by:
getSectionsOrBuilderin interfaceCardOrBuilder
-
getSectionsOrBuilderList
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).
repeated .google.apps.card.v1.Card.Section sections = 2;- Specified by:
getSectionsOrBuilderListin interfaceCardOrBuilder
-
addSectionsBuilder
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).
repeated .google.apps.card.v1.Card.Section sections = 2; -
addSectionsBuilder
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).
repeated .google.apps.card.v1.Card.Section sections = 2; -
getSectionsBuilderList
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).
repeated .google.apps.card.v1.Card.Section sections = 2; -
getSectionDividerStyleValue
public int getSectionDividerStyleValue()The divider style between the header, sections and footer.
.google.apps.card.v1.Card.DividerStyle section_divider_style = 9;- Specified by:
getSectionDividerStyleValuein interfaceCardOrBuilder- Returns:
- The enum numeric value on the wire for sectionDividerStyle.
-
setSectionDividerStyleValue
The divider style between the header, sections and footer.
.google.apps.card.v1.Card.DividerStyle section_divider_style = 9;- Parameters:
value- The enum numeric value on the wire for sectionDividerStyle to set.- Returns:
- This builder for chaining.
-
getSectionDividerStyle
The divider style between the header, sections and footer.
.google.apps.card.v1.Card.DividerStyle section_divider_style = 9;- Specified by:
getSectionDividerStylein interfaceCardOrBuilder- Returns:
- The sectionDividerStyle.
-
setSectionDividerStyle
The divider style between the header, sections and footer.
.google.apps.card.v1.Card.DividerStyle section_divider_style = 9;- Parameters:
value- The sectionDividerStyle to set.- Returns:
- This builder for chaining.
-
clearSectionDividerStyle
The divider style between the header, sections and footer.
.google.apps.card.v1.Card.DividerStyle section_divider_style = 9;- Returns:
- This builder for chaining.
-
getCardActionsList
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3;- Specified by:
getCardActionsListin interfaceCardOrBuilder
-
getCardActionsCount
public int getCardActionsCount()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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3;- Specified by:
getCardActionsCountin interfaceCardOrBuilder
-
getCardActions
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3;- Specified by:
getCardActionsin interfaceCardOrBuilder
-
setCardActions
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3; -
setCardActions
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3; -
addCardActions
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3; -
addCardActions
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3; -
addCardActions
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3; -
addCardActions
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3; -
addAllCardActions
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3; -
clearCardActions
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3; -
removeCardActions
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3; -
getCardActionsBuilder
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3; -
getCardActionsOrBuilder
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3;- Specified by:
getCardActionsOrBuilderin interfaceCardOrBuilder
-
getCardActionsOrBuilderList
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3;- Specified by:
getCardActionsOrBuilderListin interfaceCardOrBuilder
-
addCardActionsBuilder
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3; -
addCardActionsBuilder
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3; -
getCardActionsBuilderList
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" } } } ] ```repeated .google.apps.card.v1.Card.CardAction card_actions = 3; -
getName
Name of the card. Used as a card identifier in card navigation. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
string name = 4;- Specified by:
getNamein interfaceCardOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Name of the card. Used as a card identifier in card navigation. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
string name = 4;- Specified by:
getNameBytesin interfaceCardOrBuilder- Returns:
- The bytes for name.
-
setName
Name of the card. Used as a card identifier in card navigation. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
string name = 4;- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
clearName
Name of the card. Used as a card identifier in card navigation. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
string name = 4;- Returns:
- This builder for chaining.
-
setNameBytes
Name of the card. Used as a card identifier in card navigation. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
string name = 4;- Parameters:
value- The bytes for name to set.- Returns:
- This builder for chaining.
-
getDisplayStyleValue
public int getDisplayStyleValue()In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
.google.apps.card.v1.Card.DisplayStyle display_style = 6;- Specified by:
getDisplayStyleValuein interfaceCardOrBuilder- Returns:
- The enum numeric value on the wire for displayStyle.
-
setDisplayStyleValue
In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
.google.apps.card.v1.Card.DisplayStyle display_style = 6;- Parameters:
value- The enum numeric value on the wire for displayStyle to set.- Returns:
- This builder for chaining.
-
getDisplayStyle
In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
.google.apps.card.v1.Card.DisplayStyle display_style = 6;- Specified by:
getDisplayStylein interfaceCardOrBuilder- Returns:
- The displayStyle.
-
setDisplayStyle
In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
.google.apps.card.v1.Card.DisplayStyle display_style = 6;- Parameters:
value- The displayStyle to set.- Returns:
- This builder for chaining.
-
clearDisplayStyle
In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
.google.apps.card.v1.Card.DisplayStyle display_style = 6;- Returns:
- This builder for chaining.
-
hasPeekCardHeader
public boolean hasPeekCardHeader()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):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7;- Specified by:
hasPeekCardHeaderin interfaceCardOrBuilder- Returns:
- Whether the peekCardHeader field is set.
-
getPeekCardHeader
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):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7;- Specified by:
getPeekCardHeaderin interfaceCardOrBuilder- Returns:
- The peekCardHeader.
-
setPeekCardHeader
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):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7; -
setPeekCardHeader
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):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7; -
mergePeekCardHeader
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):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7; -
clearPeekCardHeader
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):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7; -
getPeekCardHeaderBuilder
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):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7; -
getPeekCardHeaderOrBuilder
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):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7;- Specified by:
getPeekCardHeaderOrBuilderin interfaceCardOrBuilder
-
setUnknownFields
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
mergeUnknownFields
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-