| ATTSignalConfig | | description | Configures Octarine webview on iOS to append ATT (Apple Tracking Transparency) consent state to URLs it navigates to. URLs are not modified if the parameter is already present. |
|---|
| id | ATTSignalConfig |
|---|
| properties | | paramName | | description | The name of the query parameter being appended to the URL. |
|---|
| type | string |
|---|
|
|---|
| urlPatterns | | description | List of regular expressions for mathing URLs. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountMenuInformation | | description | Information that can be provided to the OGL account menu Next Id: 2 |
|---|
| id | AccountMenuInformation |
|---|
| properties | | accountAlertLevel | | description | The alert level of the account, based on security advisor suggestions. |
|---|
| enum | - ACCOUNT_ALERT_LEVEL_UNSPECIFIED
- ACCOUNT_ALERT_LEVEL_INFORMATION
- ACCOUNT_ALERT_LEVEL_SUGGESTION
- ACCOUNT_ALERT_LEVEL_RECOMMENDATION
- ACCOUNT_ALERT_LEVEL_CRITICAL
|
|---|
| enumDescriptions | - The status was not fetched or is otherwise unknown.
- Safe / Green account state without any recommendations.
- Yellow account state with low-priority recommendations (i.e., suggestions).
- Yellow account state with high-priority recommendations.
- Critical / Red account state with acute warnings.
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ActionChip | | description | An action chip. |
|---|
| id | ActionChip |
|---|
| properties | | icon | | $ref | Image |
|---|
| description | Icon displayed on the left of the chip. |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| stackItemImage | | $ref | Image |
|---|
| description | When ActionChip is converted to StackItem, this is the image displayed on the left of the new StackItem. screen/3zk9fDfWnP93UKN This is a temporary solution in use to convert SummaryCard to CollectionCard. This field should not be used by new cards. New cards should directly use CollectionCard. |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of tap destination resource. DEPRECATED: Use link instead. |
|---|
|
|---|
| text | | description | Text of the chip. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ActionChipBlock | | description | A block containing a scrollable horizontal list of action chips. |
|---|
| id | ActionChipBlock |
|---|
| properties | | chips | | description | List of action chips. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| listPreviewUnitTotal | | description | Total number of chips there would have been if not limited/truncated. This will be mapped to ListPreviewUnit.total. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| wrapChips | | description | Whether to wrap chips when there isn't enough space. Currently available for web only. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ActionChipsUnit | | description | screen/82c8fpyatXbybbe |
|---|
| id | ActionChipsUnit |
|---|
| properties | | actionChips | | description | ActionChips |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| wrapChips | | description | Whether the chips should wrap when there's not enough horizontal space. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ActionItem | | description | The action item that may be used to build all kind of menus. |
|---|
| id | ActionItem |
|---|
| properties | | delegateLinkType | | description | Specifies that a Link from elsewhere in the current screen's resource graph should be used, instead of the target or link fields. |
|---|
| enum | - DELEGATE_UNSPECIFIED
- DELEGATE_TO_SUPPORT_LINK
|
|---|
| enumDescriptions | - Unspecified delegate link type
- Use the value in support_link from the current screen resource
|
|---|
| type | string |
|---|
|
|---|
| icon | | $ref | Image |
|---|
| description | The icon of the action item. |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | The id of the target resource. DEPRECATED: Use link instead. |
|---|
|
|---|
| title | | description | The title of the action item. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ActionLineBlock | | description | A block containing a navigation link and an icon. |
|---|
| id | ActionLineBlock |
|---|
| properties | | expansionUnitLabel | | description | When ActionLineBlock is converted to StackItem, this will be the label of the ExpansionUnit. This is a temporary solution in use to convert SummaryCard to CollectionCard. This field should not be used by new cards. New cards should directly use CollectionCard. |
|---|
| type | string |
|---|
|
|---|
| forcedConversionToStackItem | | description | Forces the conversion of ActionLineBlock to StackItem. This is a temporary solution in use to convert SummaryCard to CollectionCard. This field should not be used by new cards. New cards should directly use CollectionCard. |
|---|
| type | boolean |
|---|
|
|---|
| icon | | $ref | Image |
|---|
| description | icon shown on the right of the block, e.g. chevron icon. |
|---|
|
|---|
| stackItemImage | | $ref | Image |
|---|
| description | When ActionLineBlock is converted to StackItem, this is the image displayed on the left of the new StackItem. This is a temporary solution in use to convert SummaryCard to CollectionCard. This field should not be used by new cards. New cards should directly use CollectionCard. |
|---|
|
|---|
| text | | description | Visible text of the link. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ActivityListItemBlock | | description | A block representing a List item to display activities. Next Id: 7 |
|---|
| id | ActivityListItemBlock |
|---|
| properties | | description | | description | A description of the item, shown underneath the special description. |
|---|
| type | string |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | An illustration, if set, shown on the left side of the title&description. |
|---|
|
|---|
| imageLink | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click on the image. Eventually should completely replace the `target` field. |
|---|
|
|---|
| imageTarget | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | An optional link target for the image. |
|---|
|
|---|
| specialDescription | | $ref | SpecialDescription |
|---|
| description | Special description shown underneath the title. |
|---|
|
|---|
| title | | $ref | Text |
|---|
| description | The title of the item, as the most prominent text of the item. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AdditionalDescription | | description | The additional description that might be displayed for some account types. Next id: 8 |
|---|
| id | AdditionalDescription |
|---|
| properties | | image | | $ref | Image |
|---|
| description | An account type logo icon. |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click on the link. Eventually should completely replace the `target` field. |
|---|
|
|---|
| linkAccessibilityLabel | | deprecated | True |
|---|
| description | Accessibility label for the link, used by screen readers instead of link_text. DEPRECATED: Use link.aria_label instead. |
|---|
| type | string |
|---|
|
|---|
| linkIcon | | $ref | Image |
|---|
| description | Icon to append after the link text. |
|---|
|
|---|
| linkTarget | | $ref | ResourceKey |
|---|
| description | The target resource of the link. |
|---|
|
|---|
| linkText | | description | The text in the link that shows up on managed account types (e.g. 'Learn More'). |
|---|
| type | string |
|---|
|
|---|
| mainText | | description | The secondary description message that shows up on managed account types. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AdditionalParagraph | | description | Encapsulates one of additional sections of information displayed to the user below the sign in button. Next id: 7 |
|---|
| id | AdditionalParagraph |
|---|
| properties | | link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| linkAccessibilityLabel | | deprecated | True |
|---|
| description | Accessibility label for the link, used by screen readers instead of link_text. DEPRECATED: Use link.aria_label instead. |
|---|
| type | string |
|---|
|
|---|
| linkIcon | | $ref | Image |
|---|
| description | Icon to append after the link text. |
|---|
|
|---|
| linkTarget | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Optional link destination. DEPRECATED: Use link instead. |
|---|
|
|---|
| linkText | | description | The text of the link. The link will be displayed inline with the main text. Can be omited leaving just the text. |
|---|
| type | string |
|---|
|
|---|
| text | | description | Main text in this paragraph. Can be omited leaving just the link. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Alternative | | description | Alternatives represent different ways in which a screen can be displayed, e.g. as a native menu or a native setting. Exactly one of the fields should be set. Next id: 14 |
|---|
| id | Alternative |
|---|
| properties | | androidIntentAlternative | | $ref | AndroidIntentAlternative |
|---|
| description | Opens a native app by launching an Android intent. |
|---|
|
|---|
| browserAlternative | | $ref | BrowserAlternative |
|---|
| description | Displays a screen by opening a page in the browser. |
|---|
|
|---|
| cardsAlternative | | $ref | CardsAlternative |
|---|
| description | Opens a native app screen with tabs and card deck. |
|---|
|
|---|
| fauxbakeAlternative | | $ref | FauxbakeAlternative |
|---|
| description | Opens a native fauxbake screen, allowing to change the profile picture. |
|---|
|
|---|
| menuAlternative | | $ref | MenuAlternative |
|---|
| description | Displays a screen as a native menu. |
|---|
|
|---|
| messageAlternative | | $ref | MessageAlternative |
|---|
| description | Displays a screen by showing a message to the user. |
|---|
|
|---|
| nativeAlternative | | $ref | NativeAlternative |
|---|
| description | Displays a screen as a native setting. |
|---|
|
|---|
| nativeNavigationAlternative | | $ref | NativeNavigationAlternative |
|---|
| description | Navigates to a native screen from a web or webview page. |
|---|
|
|---|
| onboardingAlternative | | $ref | OnboardingAlternative |
|---|
| deprecated | True |
|---|
| description | Opens an onboarding screen. |
|---|
|
|---|
| placeholderAlternative | | $ref | PlaceholderAlternative |
|---|
| description | Reserved for internal use by clients. |
|---|
|
|---|
| searchAlternative | | $ref | SearchAlternative |
|---|
| description | Opens a native app screen with a search box and results. |
|---|
|
|---|
| supportAlternative | | $ref | SupportAlternative |
|---|
| description | Opens a support panel if possible, otherwise opens the support screen. |
|---|
|
|---|
| webviewAlternative | | $ref | WebviewAlternative |
|---|
| description | Displays a screen by opening a page in a WebView. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AnchorNavigationParams | | description | Configuration items used when scrolling to an item on the screen Next Id: 2 |
|---|
| id | AnchorNavigationParams |
|---|
| properties | | anchor | | description | The identifier is used to find an item to which scrolling should happen. The corresponding item should have the same anchor. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AndroidIntent | | description | Android intent |
|---|
| id | AndroidIntent |
|---|
| properties | | action | | description | The intent action, such as ACTION_VIEW. |
|---|
| type | string |
|---|
|
|---|
| categories | | description | A list of intent categories. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| className | | description | The intent class. This should be the complete class with package name. Required. |
|---|
| type | string |
|---|
|
|---|
| extras | | additionalProperties | |
|---|
| description | A map of intent extras keyed by the names of the extras. |
|---|
| type | object |
|---|
|
|---|
| flagActivityNewTask | | description | Whether to set the Intent flag FLAG_ACTIVITY_NEW_TASK. |
|---|
| type | boolean |
|---|
|
|---|
| packageName | | description | The intent package name. Required. |
|---|
| type | string |
|---|
|
|---|
| thirdParty | | deprecated | True |
|---|
| description | The intent is for a third-party app. If false, the client will verify that the called app has a Google signature. |
|---|
| type | boolean |
|---|
|
|---|
| type | | description | The intent MIME data type. |
|---|
| type | string |
|---|
|
|---|
| uri | | description | Data uri. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AndroidIntentAlternative | | description | An alternative with an intent and conditions to launch an Android activity |
|---|
| id | AndroidIntentAlternative |
|---|
| properties | | check | | description | Defines what type of intent security check is performed on the client. |
|---|
| enum | - CHECK_UNSPECIFIED
- FIRST_PARTY_CHECK
- SYSTEM_CHECK
- THIRD_PARTY_CHECK
|
|---|
| enumDescriptions | - This is treated same as the first party check.
- * Performs following checks: - class name or action is present - package name is present - package is Google signed
- * Performs following checks: - intent resolves - package name of resolved intent is in the system partition
- * Performs following checks: - class name is present TODO(b/119490916) Verify that we can allow intent actions as well.
|
|---|
| type | string |
|---|
|
|---|
| intent | | $ref | AndroidIntent |
|---|
| description | Android intent to launch |
|---|
|
|---|
| rules | | description | If present, only use the intent if one of these requirements is met (i.e. rules are ORed) |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AndroidIntentCapabilities | | description | The intent capabilities of the client Field names should be without a "supports" prefix. It is implicit in the message, since it's about which features the client supports. |
|---|
| id | AndroidIntentCapabilities |
|---|
| properties | | accountNameBackPropagation | | description | Whether the client supports propagating the account name back to the opening first- or zero party activity. |
|---|
| type | boolean |
|---|
|
|---|
| flagActivityNewTask | | description | Whether the client supports setting the Intent flag FLAG_ACTIVITY_NEW_TASK. |
|---|
| type | boolean |
|---|
|
|---|
| supportedAndroidIntentCheck | | description | Whether the client supports a specific intent check type. |
|---|
| items | | $ref | SupportedAndroidIntentCheck |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AndroidIntentRule | | description | All conditions that are present must be met for this "rule" to be met (i.e. conditions are ANDed). |
|---|
| id | AndroidIntentRule |
|---|
| properties | | maxVersionCode | | description | Only use the intent alternative if the package has at most this version code, exclusive. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| maxVersionInfo | | description | The number of ints sent here should match the format of the version name of the provided package e.g. if the version name is xx.yy.zz, three ints should be sent to decide whether the right package version is installed. Missing values will be treated as zeros. The comparison is done by comparing each of these ints against a piece of the version name (xx.yy.zz) from most major piece (xx) to least (zz), exclusive. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| minVersionCode | | description | Only use the intent alternative if the package has at least this version code, inclusive |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| minVersionInfo | | description | The number of ints sent here should match the format of the version name of the provided package e.g. if the version name is xx.yy.zz, three ints should be sent to decide whether the right package version is installed. Missing values will be treated as zeros. The comparison is done by comparing each of these ints against a piece of the version name (xx.yy.zz) from most major piece (xx) to least (zz), inclusive. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| packageName | | description | Only use the intent alternative if the package is installed. Required. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AnimationSegment | | deprecated | True |
|---|
| description | Describes the features of the animation segment, which should be applied to the animation specified in OnboardingFlow. Next Id: 3 |
|---|
| id | AnimationSegment |
|---|
| properties | | animationEndFrame | | description | The end frame number of the animation segment. Required. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| animationStartFrame | | description | The start frame number of the animation segment. Required. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AppBar | | description | Renders the app bar. See go/mg-redesign-header-proto for more info. |
|---|
| id | AppBar |
|---|
| properties | | actionItems | | description | Action items to show in the toolbar. Only used on Android and iOS. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| backButtonTarget | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | The destination of the back button only used on Web, ignored by other platforms. DEPRECATED: Use link instead. |
|---|
|
|---|
| backLink | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the back button click only used on Web, ignored by other platforms. Eventually should completely replace the `target` field. |
|---|
|
|---|
| closeButton | | description | Whether to show a close button instead of a back button. Only used on Android. On iOS, the state of the navigation stack determines whether a close button is shown. On Web, a close button is never shown. |
|---|
| type | boolean |
|---|
|
|---|
| title | | description | The title text to be displayed. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Attribute | | description | Attribute |
|---|
| id | Attribute |
|---|
| properties | | attribute | | description | Text of the attribute |
|---|
| type | string |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | An optional image - screen/ivNErM2XjsmVbU7. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AttributesUnit | | description | screen/8vM3aFoKwwLD7FN |
|---|
| id | AttributesUnit |
|---|
| properties | | attributes | | description | List of attributes. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Block | | description | Building block of a card Next id: 35 |
|---|
| id | Block |
|---|
| properties | | actionChipBlock | | $ref | ActionChipBlock |
|---|
| description | Action Chip Block |
|---|
|
|---|
| actionLineBlock | | $ref | ActionLineBlock |
|---|
| description | Navigation Link Block |
|---|
|
|---|
| carouselBlock | | $ref | CarouselBlock |
|---|
| description | Carousel Block |
|---|
|
|---|
| descriptionBlock | | $ref | DescriptionBlock |
|---|
| description | Description block |
|---|
|
|---|
| dividerBlock | | $ref | DividerBlock |
|---|
| description | Divider Block |
|---|
|
|---|
| imageBlock | | $ref | ImageBlock |
|---|
| description | Image block |
|---|
|
|---|
| legendBlock | | $ref | LegendBlock |
|---|
| description | Legend Block |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| listItemBlock | | $ref | ListItemBlock |
|---|
| description | List Item Block |
|---|
|
|---|
| profilePictureBlock | | $ref | ProfilePictureBlock |
|---|
| description | Profile Picture Block |
|---|
|
|---|
| progressBarBlock | | $ref | ProgressBarBlock |
|---|
| description | Progress Bar Block |
|---|
|
|---|
| progressBarListItemBlock | | $ref | ProgressBarListItemBlock |
|---|
| description | List item-like block with progress bar |
|---|
|
|---|
| searchBlock | | $ref | SearchBlock |
|---|
| description | A block that has a search bar. |
|---|
|
|---|
| signInBlock | | $ref | SignInBlock |
|---|
| description | Sign In Block |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of tap destination resource. DEPRECATED: Use link instead. |
|---|
|
|---|
| twoColumnTableBlock | | $ref | TwoColumnTableBlock |
|---|
| description | Two Column Table Block |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| BoolArray | | description | A boolean array |
|---|
| id | BoolArray |
|---|
| properties | | values | | description | values of boolean array |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| BottomButton | | description | One of the BottomNav buttons. |
|---|
| id | BottomButton |
|---|
| properties | | icon | | $ref | Image |
|---|
| description | Button icon (default version) to be displayed above the title. Instead, only the image_id can be used |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link referencing the screen that should be opened when the item is activated. Not supported on iOS and Android. |
|---|
|
|---|
| menu | | $ref | BottomDrawerMenu |
|---|
| description | The bottom menu. |
|---|
|
|---|
| selectedIcon | | $ref | Image |
|---|
| description | Button icon (selected version) to be displayed above the title. Instead, only the image_id can be used |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | The target screen. DEPRECATED: Bottom Navigation is deprecated. |
|---|
|
|---|
| title | | description | Button caption. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| BottomDrawerMenu | | description | The bottom navigation drawer menu. |
|---|
| id | BottomDrawerMenu |
|---|
| properties | | blocks | | description | The list of blocks in the bottom menu. The order of the blocks in the list matches the order they will appear in the UI, top to bottom. |
|---|
| items | | $ref | BottomDrawerMenuBlock |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| BottomDrawerMenuBlock | | description | A building block of the bottom navigation menu drawer. |
|---|
| id | BottomDrawerMenuBlock |
|---|
| properties | | divider | | $ref | BottomDrawerMenuDivider |
|---|
| description | A horizontal divider. |
|---|
|
|---|
| menuItem | | $ref | BottomDrawerMenuItem |
|---|
| description | A menu item. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| BottomDrawerMenuDivider | | description | A horizontal divider for the bottom navigation menu drawer. |
|---|
| id | BottomDrawerMenuDivider |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| BottomDrawerMenuItem | | description | A bottom navigation menu drawer item, pointing to targets across the app. |
|---|
| id | BottomDrawerMenuItem |
|---|
| properties | | icon | | $ref | Image |
|---|
| description | A small icon to be displayed next to the item title. Truly optional. |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link referencing the screen that should be opened when the item is activated. Not supported on iOS and Android. |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | The target of the menu item. DEPRECATED: Bottom Navigation is deprecated. |
|---|
|
|---|
| title | | description | The displayed title of the menu item. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| BottomNav | | description | Bottom navigation bar with buttons. |
|---|
| id | BottomNav |
|---|
| properties | | buttons | | description | List of buttons. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| BrowserAlternative | | description | Displays a screen by opening an URL in the default browser. Next Id: 7 |
|---|
| id | BrowserAlternative |
|---|
| properties | | auth | | description | If true, the user should be signed in first using AccountChooser. |
|---|
| type | boolean |
|---|
|
|---|
| browserType | | description | What kind of API should be used to open the URL. May influence user experience (e.g., whether automatic sign in is supported). Only for mobile platforms. Currently only used on Platform.IOS. |
|---|
| enum | - BROWSER_TYPE_UNSPECIFIED
- IN_APP
- PLATFORM_DEFAULT
|
|---|
| enumDescriptions | - By default, an in-app browser should be used (e.g., SafariViewController or Chrome Custom Tab).
- In-App browser (e.g., SafariViewController or Chrome Custom Tab).
- Use the browser app currently set as default on the device (e.g., Safari or Chrome).
|
|---|
| type | string |
|---|
|
|---|
| setContinueUrlParam | | description | Whether the "continue" URL param should be set, if available, when linking to this page. Used only for Platform.WEB. |
|---|
| type | boolean |
|---|
|
|---|
| target | | description | Where to display the linked URL. Used only for Platform.WEB. See Target enum. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| themedUrl | | $ref | ThemedUrl |
|---|
| description | The set of theme-dependent URLs to open. One of url or themed_url required. |
|---|
|
|---|
| url | | description | The URL to open. One of url or themed_url required. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| BrowserCapabilities | | description | The capabilities related to opening a URL in a browser. Field names should be without a "supports" prefix. It is implicit in the message, since it's about which features the client supports. Next Id: 2 |
|---|
| id | BrowserCapabilities |
|---|
| properties | | typeSelection | | description | Whether the client supports selecting the browser API type that is used. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ByteArray | | description | A byte array |
|---|
| id | ByteArray |
|---|
| properties | | values | | description | values of byte array int8 scale |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Card | | description | Cards that can be stacked on a screen. |
|---|
| id | Card |
|---|
| properties | | anchor | | description | An identifier for scrolling into the view. |
|---|
| type | string |
|---|
|
|---|
| collectionCard | | $ref | CollectionCard |
|---|
| description | Collection Card |
|---|
|
|---|
| loading | | $ref | LoadingCard |
|---|
| description | Card with a loading spinner on it. |
|---|
|
|---|
| oneGoogle | | $ref | OneGoogleCard |
|---|
| description | Card representing an entry in the OneGoogle Account Menu. |
|---|
|
|---|
| promptCarousel | | $ref | PromptCarouselCard |
|---|
| description | Prompt Carousel |
|---|
|
|---|
| searchResultCard | | $ref | SearchResultCard |
|---|
| description | Card presenting a result on Google Search. |
|---|
|
|---|
| securityHubPromptCarousel | | $ref | SecurityHubPromptCarouselCard |
|---|
| description | SecurityHub Prompt Carousel (for Angel) |
|---|
|
|---|
| segmentHeaderCard | | $ref | SegmentHeaderCard |
|---|
| description | Segment header card |
|---|
|
|---|
| summary | | $ref | SummaryCard |
|---|
| description | Summary Card |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| CardCapabilities | | description | The capabilities of the cards framework Field names should be without a "supports" prefix. It is implicit in the message, since it's about which features the client supports. |
|---|
| id | CardCapabilities |
|---|
| properties | | adviceFramework | | description | Support for the Advice Framework. |
|---|
| type | boolean |
|---|
|
|---|
| borderlessCards | | description | Support for borderless summary cards. |
|---|
| type | boolean |
|---|
|
|---|
| carouselViewAll | | description | Supports for "view all" button in carousels |
|---|
| type | boolean |
|---|
|
|---|
| genericStyledTexts | | description | Support for generic styled texts. |
|---|
| type | boolean |
|---|
|
|---|
| headerActionItems | | description | Whether the client supports action menu on WelcomeHeader. |
|---|
| type | boolean |
|---|
|
|---|
| helpItem | | description | Support for help item in CardsAlternative. |
|---|
| type | boolean |
|---|
|
|---|
| iconOnlyChip | | deprecated | True |
|---|
| description | Support for chips that have only icons (no text) |
|---|
| type | boolean |
|---|
|
|---|
| legendBlock | | description | Support for LegendBlock |
|---|
| type | boolean |
|---|
|
|---|
| linkNavigation | | description | Support for link navigation. |
|---|
| type | boolean |
|---|
|
|---|
| listItemSecondaryIcon | | description | Support for secondary icon in ListItemBlock |
|---|
| type | boolean |
|---|
|
|---|
| navigateToAnchor | | description | Support for navigation to anchors |
|---|
| type | boolean |
|---|
|
|---|
| progressBarSummaryCardBlock | | deprecated | True |
|---|
| description | Support for progress bar block in summary cards. |
|---|
| type | boolean |
|---|
|
|---|
| promptResource | | description | Whether the client supports prompt as a separate resource outside of the prompt carousel. |
|---|
| type | boolean |
|---|
|
|---|
| screenIntroLink | | description | Support for link in ScreenIntro. |
|---|
| type | boolean |
|---|
|
|---|
| segmentHeaderCard | | description | Support for segment header cards |
|---|
| type | boolean |
|---|
|
|---|
| signInSummaryCardBlock | | description | Support for sign in block in summary cards. |
|---|
| type | boolean |
|---|
|
|---|
| summaryCardPaddingDividerReplacement | | description | Support for additional padding replacing dividers in summary cards. |
|---|
| type | boolean |
|---|
|
|---|
| summaryCardProgressBar | | description | Whether the client supports progress bar in the summary card |
|---|
| type | boolean |
|---|
|
|---|
| untintedUrlChipIcons | | description | Support for untinted URL chip icons. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| CardDeck | | description | A set of cards. |
|---|
| id | CardDeck |
|---|
| properties | | cardKeys | | description | List of cards. The order is equal to the order they should appear in the UI. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| visualElementConfig | | $ref | GoogleAccountVisualElementConfig |
|---|
| description | Visual element configuration for the card deck. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| CardsAlternative | | description | A screen with tabs and cards. Used for Home, Personal info, etc. Next Id: 22 |
|---|
| id | CardsAlternative |
|---|
| properties | | appBar | | $ref | AppBar |
|---|
| description | Renders the app bar. If omitted, mobile will render the default app bar but web won't render one. See go/mg-redesign-header-proto for more info. |
|---|
|
|---|
| bottomNavKey | | $ref | ResourceKey |
|---|
| description | Id of the bottom buttons bar. |
|---|
|
|---|
| bottomNavSelection | | $ref | ResourceKey |
|---|
| description | Identifies which bottom button should appear selected. If omitted or if there is no button with this key, the first button with a target is selected. |
|---|
|
|---|
| deckKey | | $ref | ResourceKey |
|---|
| description | Id of the deck of cards displayed on the page. |
|---|
|
|---|
| footerKey | | $ref | ResourceKey |
|---|
| description | Footer displayed on this page. |
|---|
|
|---|
| hatsSurvey | | $ref | HaTSSurvey |
|---|
| description | HaTS survey to be shown. |
|---|
|
|---|
| helpItemTarget | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of the target of the help center item in the header. DEPRECATED: use support link instead. |
|---|
|
|---|
| leftNavKey | | $ref | ResourceKey |
|---|
| description | Id of the left navigation. |
|---|
|
|---|
| leftNavSelection | | $ref | ResourceKey |
|---|
| description | Identifies which left menu item should appear selected. If omitted or if there is no button with this key, nothing is selected. |
|---|
|
|---|
| onboardingFlowKey | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of an OnboardingFlow resource. |
|---|
|
|---|
| screenIntro | | $ref | ScreenIntro |
|---|
| description | Screen intro displayed just before the cards. |
|---|
|
|---|
| simpleHeaderKey | | $ref | ResourceKey |
|---|
| description | Id of the header bar where action items and a title are displayed. Currently only used on Android and iOS. |
|---|
|
|---|
| supportLink | | $ref | Link |
|---|
| description | Id of the link of the help center item in the header, successor of help_item_target. |
|---|
|
|---|
| supportPanelKey | | $ref | ResourceKey |
|---|
| description | Support panel displayed on the page. |
|---|
|
|---|
| topNavKey | | $ref | ResourceKey |
|---|
| description | Id of the top tabs bar. |
|---|
|
|---|
| visualElementConfig | | $ref | GoogleAccountVisualElementConfig |
|---|
| description | Visual element configuration for the summary page. |
|---|
|
|---|
| welcomeHeaderKey | | $ref | ResourceKey |
|---|
| description | Id of the header bar where user name and avatar are displayed. |
|---|
|
|---|
| welcomeScreenIntroKey | | $ref | ResourceKey |
|---|
| description | Personalized welcome screen intro displayed on the home page instead of the usual screen intro. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| CarouselBlock | | description | A horizontal list (carousel) block. |
|---|
| id | CarouselBlock |
|---|
| properties | | accessibilityLabel | | description | Accessibility label for the legend item, used by screen readers. |
|---|
| type | string |
|---|
|
|---|
| itemWidth | | description | The width of the carousel item, only applies to vertical carousels. If not provided, client defaults to 128dp. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| items | | description | List of carousel items. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| itemsType | | description | The carousel items type. See CarouselItemsType for possible values. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| textHorizontalAlignment | | description | Horizontal alignment of text. See HorizontalAlignment enum. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| viewAllLink | | $ref | Link |
|---|
| description | If present, a "view all" button will be shown at the end of the carousel. When tapped it will open this link. |
|---|
|
|---|
| viewAllTarget | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | If present, a "view all" button will be shown at the end of the carousel. When tapped it will open this target. DEPRECATED: Use view_all_link instead. |
|---|
|
|---|
| viewAllText | | description | Text, which is shown beneath the "view all" button. If empty the button is shown without text. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| CarouselItem | | description | Item of a carousel, can be an elevated or flat card. |
|---|
| id | CarouselItem |
|---|
| properties | | descriptionColor | | $ref | Color |
|---|
| description | Color of the description text. |
|---|
|
|---|
| descriptions | | description | List of carousel descriptions. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| elevate | | description | Whether or not to elevate the carousel card. |
|---|
| type | boolean |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | Image displayed on the top or left of the carousel item. |
|---|
|
|---|
| label | | description | Label of the carousel item. |
|---|
| type | string |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| specialDescription | | $ref | SpecialDescription |
|---|
| description | Special description. |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of tap destination resource. DEPRECATED: Use link instead. |
|---|
|
|---|
| textEntries | | deprecated | True |
|---|
| description | Text entries of the carousel item. Use label, titles, etc. instead. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| titles | | description | List of carousel titles. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| CharArray | | description | A char array |
|---|
| id | CharArray |
|---|
| properties | | values | | description | values of char array char |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ClientCapabilities | | description | Describes the client's capabilities to the server. Field names should be without a "supports" prefix. It is implicit in the message, since it's about which features the client supports. Next Id: 23 |
|---|
| id | ClientCapabilities |
|---|
| properties | | androidIntentCapabilities | | $ref | AndroidIntentCapabilities |
|---|
| description | The supported intent capabilites of the client |
|---|
|
|---|
| bottomNavigation | | description | Whether the client supports bottom navigation or not. |
|---|
| type | boolean |
|---|
|
|---|
| browserAuthentication | | description | Whether the client supports signing users in before opening a browser alternative. |
|---|
| type | boolean |
|---|
|
|---|
| browserCapabilities | | $ref | BrowserCapabilities |
|---|
| description | The capabilities related to opening a URL in a browser. |
|---|
|
|---|
| cardCapabilities | | $ref | CardCapabilities |
|---|
| description | The capabilities of the cards framework |
|---|
|
|---|
| expressiveDesign | | description | Whether the client implements the expressive design language. |
|---|
| type | boolean |
|---|
|
|---|
| footer | | description | Whether the client supports footer or not. |
|---|
| type | boolean |
|---|
|
|---|
| hats | | description | Whether the client supports HaTS. See go/hats for details. |
|---|
| type | boolean |
|---|
|
|---|
| leftNavigation | | description | Whether the left navigation is supported or not. |
|---|
| type | boolean |
|---|
|
|---|
| nativeCapabilities | | $ref | NativeCapabilities |
|---|
| description | The capabilities of the native actions. |
|---|
|
|---|
| seamlessDarkMode | | description | Whether the client supports theme-agnostic resources. |
|---|
| type | boolean |
|---|
|
|---|
| simpleHeader | | description | Whether the client supports simple header or not. |
|---|
| type | boolean |
|---|
|
|---|
| supportLinkDelegation | | description | Whether the client supports support_link and DelegateLinkType.DELEGATE_SUPPORT. |
|---|
| type | boolean |
|---|
|
|---|
| supportedAlternativeTypes | | description | Lists all supported alternative types. Only supported since gmscore_module_version=3 v2 and below supports MenuAlternative, MessageAlternative, NativeAlternative, BrowserAlternative. |
|---|
| items | | $ref | SupportedAlternativeType |
|---|
|
|---|
| type | array |
|---|
|
|---|
| supportedIcons | | description | Lists all supported icons. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| supportedItemTypes | | description | Lists all supported item types. Only supported since gmscore_module_version=3 v2 and below supports SimpleItem and PromoItem. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| supportedNativeActions | | description | Lists all supported native actions. |
|---|
| items | | $ref | SupportedNativeAction |
|---|
|
|---|
| type | array |
|---|
|
|---|
| supportedOfflineScreens | | description | Lists all supported offline screens. |
|---|
| items | | $ref | SupportedOfflineScreen |
|---|
|
|---|
| type | array |
|---|
|
|---|
| topTabIcons | | description | Whether the client supports top tab icons or not. |
|---|
| type | boolean |
|---|
|
|---|
| usesStandardChevron | | description | Whether the client uses the default chevrons or a custom version with less padding |
|---|
| type | boolean |
|---|
|
|---|
| webviewCapabilities | | $ref | WebviewCapabilities |
|---|
| description | The capabilities of the webview client. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ClientVersions | | description | The version of a specific piece of client software. This message type has an equivalent type in asm_client_info.proto that should generally be changed in sync. Next Id: 14 LINT.IfChange |
|---|
| id | ClientVersions |
|---|
| properties | | androidLibraryVersion | | description | The version of the Android AccountSettings library that is used outside of GMSCore, to present ASMS content within other apps. e.g. "1.0" |
|---|
| type | string |
|---|
|
|---|
| androidOsVersion | | description | The Android OS version, e.g. "5.1.1". |
|---|
| type | string |
|---|
|
|---|
| androidSdkVersion | | description | The Android SDK version. e.g. "22" |
|---|
| type | string |
|---|
|
|---|
| androidSystemWebviewVersion | | description | The version of the Android system webview component e.g. "37.0.0.0" |
|---|
| type | string |
|---|
|
|---|
| gmscoreModuleApkVersionName | | description | The version of the AccountSettings GMSCore module. ., eg. "1237.113896342.113954321" https://docs.google.com/document/d/1bmA9cRjlIpM_PBAS3I9m-4x6U3M4vs_MN-FA3epaA78/edit#heading=h.27m0cgqiiq77 |
|---|
| type | string |
|---|
|
|---|
| gmscoreModuleVersion | | description | The version of the AccountSettings GMSCore module. e.g. "1" In the past it was manually incremented. Going forward it is pinned to the container version: go/pin-module-version-to-container |
|---|
| type | string |
|---|
|
|---|
| gmscoreVersion | | description | The GMSCore version code. e.g. "9033000" |
|---|
| type | string |
|---|
|
|---|
| gmscoreWebviewModuleVersion | | description | The version of the Account Settings Webview GMSCore module. e.g. "1" In the past it was manually incremented. Going forward it is pinned to the container version: go/pin-module-version-to-container |
|---|
| type | string |
|---|
|
|---|
| iosAppBundleId | | description | The bundle ID (CFBundleIdentifier) of the hosting iOS app. e.g. "com.google.ios.youtube" |
|---|
| type | string |
|---|
|
|---|
| iosAppVersion | | description | The version (CFBundleVersion) of the hosting iOS app. e.g. "10.30.11661" |
|---|
| type | string |
|---|
|
|---|
| iosLibrary | | description | The type of the iOS AccountSettings library, e.g. "main" or "policies" |
|---|
| type | string |
|---|
|
|---|
| iosLibraryVersion | | description | The version of the iOS AccountSettings library. e.g. "1.0" |
|---|
| type | string |
|---|
|
|---|
| iosVersion | | description | The iOS version. e.g. "9.2.1" |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| CollapsableBlock | | description | Block that can be collapsed, containing a set of other blocks. |
|---|
| id | CollapsableBlock |
|---|
| properties | | collapsedActionLabel | | description | The label of the action block in its collapsed form. |
|---|
| type | string |
|---|
|
|---|
| content | | description | The content of the block in its extended form. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| expandedContentDescription | | description | Description below the title of the expanded section. |
|---|
| type | string |
|---|
|
|---|
| expandedContentTitle | | description | Title on top of the expanded section. |
|---|
| type | string |
|---|
|
|---|
| initiallyExpanded | | description | Indicator whether the block should initially be collapsed or extended. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| CollectionCard | | description | A collection card - screen/3R3xDXaRngvfQMS. |
|---|
| id | CollectionCard |
|---|
| properties | | description | | description | Description of the card. |
|---|
| type | string |
|---|
|
|---|
| hyperlink | | $ref | Link |
|---|
| description | Link of the hyperlink_text. |
|---|
|
|---|
| hyperlinkText | | description | Hyperlink text/label of the card displayed after the description. |
|---|
| type | string |
|---|
|
|---|
| stacks | | description | Stacks of the card. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| title | | description | Title of the card. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Color | | description | Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and 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 have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. 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(''); }; // ... |
|---|
| id | Color |
|---|
| properties | | alpha | | description | The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). |
|---|
| format | float |
|---|
| type | number |
|---|
|
|---|
| blue | | description | The amount of blue in the color as a value in the interval [0, 1]. |
|---|
| format | float |
|---|
| type | number |
|---|
|
|---|
| green | | description | The amount of green in the color as a value in the interval [0, 1]. |
|---|
| format | float |
|---|
| type | number |
|---|
|
|---|
| red | | description | The amount of red in the color as a value in the interval [0, 1]. |
|---|
| format | float |
|---|
| type | number |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| DashboardNavigationMetadata | | description | Additional information about navigations from Google Dashboard. |
|---|
| id | DashboardNavigationMetadata |
|---|
| properties | | globalCta | | description | Type of global CTA the user interacted with, e.g. Takeout (Download your data) or "Delete a service". |
|---|
| enum | - GLOBAL_CTA_UNSPECIFIED
- GLOBAL_CTA_UNKNOWN
- GLOBAL_CTA_TAKEOUT
- GLOBAL_CTA_DELETE_A_SERVICE
|
|---|
| enumDescriptions | - Default value of enum (go/protodosdonts#do-include-an-unspecified-value-in-an-enum)
- An uncategorized Global CTA.
- Global CTA that takes the user to Google Takeout (https://takeout.google.com). https://screenshot.googleplex.com/8ELE8GduazvxVQZ.png
- Global CTA that takes the user to 'Delete a service' page (https://myaccount.google.com/delete-services-or-account). https://screenshot.googleplex.com/EiKosTWAdfCGToH.png
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| DashboardServiceCardOutboundNavigationMetadata | | description | Additional information about outbound navigations from service cards on Google Dashboard. |
|---|
| id | DashboardServiceCardOutboundNavigationMetadata |
|---|
| properties | | navigationType | | description | Type of Navigation - whether the user went to service specific Takeout page, service's privacy page etc. |
|---|
| enum | - NAVIGATION_TYPE_UNSPECIFIED
- CONTENT_LINKS
- HELP_CENTER
- OTHER_ACTION_CHIPS
- PRIVACY_PAGE
- SERVICE_PAGE
- SETTINGS_PAGE
- TAKEOUT
- TAKEOUT_TRANSFER
- MY_ACTIVITY
- ACTIVITY_ITEMS_LINKS
- MY_ACTIVITY_MANAGE_HISTORY
- CONTINUE_TO_SERVICE
|
|---|
| enumDescriptions | - Default value of enum (go/protodosdonts#do-include-an-unspecified-value-in-an-enum)
- Navigation to one of the links in service card's body (https://screenshot.googleplex.com/3hRNyKfoqKvUFxr.png)
- Navigation to the service's help center by clicking on "Help center" action chip (https://screenshot.googleplex.com/Q9XUxdcyquUymh8.png)
- Navigation to action chips other than the ones listed in this enum e.g. "Manage history" chip on Youtube card (https://screenshot.googleplex.com/5nzGJzy2MRdmomB.png)
- Navigation to service's privacy page by clicking on "Your data in X" action chip (https://screenshot.googleplex.com/6X7tTR6wDukrPYB.png)
- Navigation to service's page by clicking on card header (https://screenshot.googleplex.com/63vVsaegFVcDC4A.png)
- Navigation to service's settings page by clicking on "Settings" action chip (https://screenshot.googleplex.com/7NAiqJCENGQp5Bm.png)
- Navigation to Takeout by clicking on "Download" action chip (https://screenshot.googleplex.com/6u75minrW2K3brW.png)
- Navigation to Takeout's transfer page by clicking on "Transfer your data" action chip (https://screenshot.googleplex.com/X2QJPrFfnqLig4g.png)
- Navigation to My Activity page by clicking on setting state action chip (http://screen/7WUvsJvT2kgZYuZ)
- Navigation to one of the links in service card's activity items (http://screen/AM4vYpvYoRn2Y7A)
- Navigation to My Activity History page by clicking on manage history (http://screen/Yu6sQXyatMp2o7p)
- Navigation to service's page by clicking on "Continue to [service]" action chip (http://screen/54GgDCNNnDaffmT.png)
|
|---|
| type | string |
|---|
|
|---|
| pageSection | | description | The section of the dashboard page to which the service card belongs. |
|---|
| enum | - PAGE_SECTION_UNSPECIFIED
- PAGE_SECTION_RECENTLY_USED_SERVICES
- PAGE_SECTION_OTHER_GOOGLE_SERVICES
|
|---|
| enumDescriptions | - Default value of enum (go/protodosdonts#do-include-an-unspecified-value-in-an-enum)
- Section of dashboard page containing user's recently used services. http://screen/9QWGzrWj8F9dTgE.png
- Section of dashboard page containing services other services. http://screen/6cUx7rWCS7Vai6B.png
|
|---|
| type | string |
|---|
|
|---|
| serviceId | |
|---|
|
|---|
| type | object |
|---|
|
|---|
| DescriptionBlock | | description | A description block, can contain a title with a link, a description and an image (position to the right of the block). Next id: 11 |
|---|
| id | DescriptionBlock |
|---|
| properties | | descriptionText | | description | description block description text. |
|---|
| type | string |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | image displayed to the right of the text. |
|---|
|
|---|
| largeImage | | $ref | Image |
|---|
| description | the large version of image to be displayed on larger screens. |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the link click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| linkAccessibilityLabel | | deprecated | True |
|---|
| description | Accessibility label for the link, used by screen readers instead of link_text. DEPRECATED: Use link.aria_label instead. |
|---|
| type | string |
|---|
|
|---|
| linkIcon | | $ref | Image |
|---|
| description | Icon to append after the description block link. |
|---|
|
|---|
| linkTarget | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of link destination resource. DEPRECATED: Use link instead. |
|---|
|
|---|
| linkText | | description | description block link text. |
|---|
| type | string |
|---|
|
|---|
| stackItemImage | | $ref | Image |
|---|
| description | When DescriptionBlock is converted to StackItem, this is the image displayed on the left of the new StackItem. This is a temporary solution in use to convert SummaryCard to CollectionCard. This field should not be used by new cards. New cards should directly use CollectionCard. |
|---|
|
|---|
| title | | description | description block title. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| DividerBlock | | description | A block that acts as a divider between different kinds of blocks. |
|---|
| id | DividerBlock |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| DoubleArray | | description | A double array |
|---|
| id | DoubleArray |
|---|
| properties | | values | | description | values of double array |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ExpansionUnit | | description | screen/9fYD3c8gNSJH6Aj & screen/AfX5FY6knEvFoEj |
|---|
| id | ExpansionUnit |
|---|
| properties | | backgroundColor | | $ref | ThemedColor |
|---|
| description | Color to tint the background and serve as container for Icon and Label |
|---|
|
|---|
| foregroundColor | | $ref | ThemedColor |
|---|
| description | Color to tint label and icon |
|---|
|
|---|
| icon | | $ref | Image |
|---|
| description | Icon of the expansion button |
|---|
|
|---|
| label | | description | Label of the expansion button |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Extra | | description | An Android intent extra LINT.IfChange |
|---|
| id | Extra |
|---|
| properties | | booleanArrayValue | | $ref | BoolArray |
|---|
| description | A boolean array extra value. |
|---|
|
|---|
| booleanValue | | description | A boolean extra value. |
|---|
| type | boolean |
|---|
|
|---|
| byteArrayValue | | $ref | ByteArray |
|---|
| description | A byte array extra value. |
|---|
|
|---|
| byteValue | | description | A byte extra value. int8 scale |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| charArrayValue | | $ref | CharArray |
|---|
| description | A char array extra value. |
|---|
|
|---|
| charValue | | description | A char extra value. char |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| doubleArrayValue | | $ref | DoubleArray |
|---|
| description | A double array extra value. |
|---|
|
|---|
| doubleValue | | description | A double extra value. |
|---|
| format | double |
|---|
| type | number |
|---|
|
|---|
| floatArrayValue | | $ref | FloatArray |
|---|
| description | A float array extra value. |
|---|
|
|---|
| floatValue | | description | A float extra value. |
|---|
| format | float |
|---|
| type | number |
|---|
|
|---|
| intArrayValue | | $ref | IntArray |
|---|
| description | An int array extra value. |
|---|
|
|---|
| intValue | | description | An int extra value. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| longArrayValue | | $ref | LongArray |
|---|
| description | A long array extra value. |
|---|
|
|---|
| longValue | | description | A long extra value. |
|---|
| format | int64 |
|---|
| type | string |
|---|
|
|---|
| shortArrayValue | | $ref | ShortArray |
|---|
| description | A short array extra value. |
|---|
|
|---|
| shortValue | | description | A short extra value. int16 scale |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| stringArrayValue | | $ref | StringArray |
|---|
| description | A string array extra value. |
|---|
|
|---|
| stringValue | | description | A string extra value. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| FauxbakeAlternative | | description | A screen with a profile picture and buttons to allow changing or removing it. Next Id: 11 |
|---|
| id | FauxbakeAlternative |
|---|
| properties | | addPictureButton | | $ref | FauxbakeButton |
|---|
| description | The button that allows users to add a profile picture. |
|---|
|
|---|
| avatarInformation | | $ref | FauxbakePictureInfo |
|---|
| description | The accessibility information for the picture if the user has a profile picture set. |
|---|
|
|---|
| changePictureButton | | $ref | FauxbakeButton |
|---|
| description | The button that allows users to change their profile picture. |
|---|
|
|---|
| croppingOverlay | | $ref | FauxbakeCroppingOverlay |
|---|
| description | Fauxbake cropping and rotate screen. |
|---|
|
|---|
| description | | description | The description text that should be displayed below the title. |
|---|
| type | string |
|---|
|
|---|
| footer | | $ref | FauxbakeFooter |
|---|
| description | The footer that should be displayed at the bottom of the screen. |
|---|
|
|---|
| monogramInformation | | $ref | FauxbakePictureInfo |
|---|
| description | The accessibility information for the picture if the user has no profile picture set and a monogram is visible instead. |
|---|
|
|---|
| removePictureButton | | $ref | FauxbakeButton |
|---|
| description | The button that allows users to remove their profile picture. |
|---|
|
|---|
| title | | description | The title text that should be displayed at the top of the screen. |
|---|
| type | string |
|---|
|
|---|
| welcomeHeaderKey | | $ref | ResourceKey |
|---|
| description | An optional welcome header to configure a menu in the navigation bar. Should not include an actual expanding header, as there already is a big profile picture on the screen. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| FauxbakeButton | | description | A button with a title and icon. Does not support generic resource-based navigation and instead relies on native action already present on the device. Next Id: 4 |
|---|
| id | FauxbakeButton |
|---|
| properties | | accessibilityLabel | | description | An accessibility label for the button. If not present, the button title should be used. |
|---|
| type | string |
|---|
|
|---|
| icon | | $ref | Image |
|---|
| description | The icon of the button |
|---|
|
|---|
| title | | description | The title of the button. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| FauxbakeCroppingExtraInformationAlert | | description | Alert showing extra information. Next Id: 4 |
|---|
| id | FauxbakeCroppingExtraInformationAlert |
|---|
| properties | | closeButtonTitle | | description | Title for the button that closes the information alert. |
|---|
| type | string |
|---|
|
|---|
| informationText | | description | Text for the extra information alert. |
|---|
| type | string |
|---|
|
|---|
| triggerButton | | $ref | FauxbakeButton |
|---|
| description | Button for triggering the extra information alert. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| FauxbakeCroppingOverlay | | description | Overlay screen for cropping and rotating the user profile picture. Next Id: 5 |
|---|
| id | FauxbakeCroppingOverlay |
|---|
| properties | | navigationBar | | $ref | FauxbakeCroppingOverlayNavigationBar |
|---|
| description | Navigation bar containing the back and extra information alert buttons. |
|---|
|
|---|
| rotateButton | | $ref | FauxbakeButton |
|---|
| description | Button to rotate the image, placed on the footer. |
|---|
|
|---|
| saveButton | | $ref | FauxbakeButton |
|---|
| description | Button that concludes the action of cropping & rotating the image. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| FauxbakeCroppingOverlayNavigationBar | | description | Navigation bar for the cropping overlay containing the back button and extra information alert trigger with its data. Next Id: 4 |
|---|
| id | FauxbakeCroppingOverlayNavigationBar |
|---|
| properties | | backButton | | $ref | FauxbakeButton |
|---|
| description | Navigation bar back button. |
|---|
|
|---|
| extraInformationAlert | | $ref | FauxbakeCroppingExtraInformationAlert |
|---|
| description | Alert showing extra information. |
|---|
|
|---|
| title | | description | The title shown in the navigation bar. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| FauxbakeFooter | | description | The footer text that should be displayed at the bottom of the screen. Next Id: 6 |
|---|
| id | FauxbakeFooter |
|---|
| properties | | icon | | $ref | Image |
|---|
| description | The icon that is displayed next to the footer text. |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| linkTarget | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | The target of the link at the end of the footer. DEPRECATED: Use link instead. |
|---|
|
|---|
| linkText | | description | The text of the link at the end of the footer. |
|---|
| type | string |
|---|
|
|---|
| text | | description | The text that should be in the footer. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| FauxbakePictureInfo | | description | Additional information for the big profile picture on the Fauxbake screen. Next Id: 3 |
|---|
| id | FauxbakePictureInfo |
|---|
| properties | | accessibilityHint | | description | The hint that is going to be read when a screen reader focuses on the profile picture. Should indicate the action to take to activate the normal tap action (e.g., change the profile picture). |
|---|
| type | string |
|---|
|
|---|
| accessibilityLabel | | description | The text that is going to be read when a screen reader focuses on the profile picture. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| FeedbackParams | | description | Configuration items used when launching the Feedback Client. Next Id: 3 |
|---|
| id | FeedbackParams |
|---|
| properties | | captureScreenshot | | description | If true, include a screenshot in the feedback report. |
|---|
| type | boolean |
|---|
|
|---|
| category | | description | The Feedback entry point within My Google, used to sort into buckets. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| FloatArray | | description | A float array |
|---|
| id | FloatArray |
|---|
| properties | | values | | description | values of float array |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Footer | | description | Footer consists of link items. |
|---|
| id | Footer |
|---|
| properties | | items | | description | List of items. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| FooterItem | | description | One of the Footer link text items. Next id: 5 |
|---|
| id | FooterItem |
|---|
| properties | | label | | description | The a11y text label for this link. |
|---|
| type | string |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | The target screen. DEPRECATED: Use link instead. |
|---|
|
|---|
| text | | description | The text content of this link. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GetClientConfigRequest | | description | Request message for GetClientConfig. |
|---|
| id | GetClientConfigRequest |
|---|
| properties | | context | | $ref | RequestContext |
|---|
| description | Information sent with every request. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GetClientConfigResponse | | description | Response message for GetClientConfig. The fields here should be kept in sync with id.boq.proto.protoconf.accountsettings.mobile.service.ClientConfig. LINT.IfChange Next Id: 20 |
|---|
| id | GetClientConfigResponse |
|---|
| properties | | attSignalConfigs | | description | Configuration for appending ATT (Apple Tracking Transparency) consent state to URLs in Octarine webviews, for every app/URL combination. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| canUsePeopleApiForProfilePictureUploading | | description | Whether it's safe to use People API for profile picture uploading. Used only by iOS client. |
|---|
| type | boolean |
|---|
|
|---|
| clearcutDenylistedScreenIds | | description | List of screen IDs that should have clearcut logging disabled. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| heartbeatTimesS | | description | The client will send heartbeat logs after a user has been on a screen for the given number of seconds. Also included in logs as int32. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| prefetchingEnabled | | description | Whether the client app should issue PrefetchRelatedScreens requests. |
|---|
| type | boolean |
|---|
|
|---|
| screenMaxLifetime | | description | After this time limit, screens should be deleted from the cache. The client may use a periodic task for this, so the actual deletion may happen a little later than the deadline given here. |
|---|
| format | google-duration |
|---|
| type | string |
|---|
|
|---|
| stableScreenStaleTime | | description | After this time limit, cached stable screens should be considered stale (potentially out of date). This value should be based on how quickly we need to be able to roll out product changes. |
|---|
| format | google-duration |
|---|
| type | string |
|---|
|
|---|
| unstableScreenStaleTime | | description | After this time limit, cached unstable screens should be considered stale (potentially out of date). This value should be based on how quickly we want changes by the user to be visible when made from another app or device. |
|---|
| format | google-duration |
|---|
| type | string |
|---|
|
|---|
| useSystemDefaultBrowserToOpenUrls | | description | Indicates whether the client should use the default system browser to open links in Octarine. |
|---|
| type | boolean |
|---|
|
|---|
| webviewBlacklistedUrlPatterns | | description | See webview_whitelisted_url_patterns. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| webviewBrowserAuthBlacklistedUrlPatterns | | description | See webview_browser_auth_whitelisted_url_patterns. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| webviewBrowserAuthWhitelistedUrlPatterns | | description | List of regexes used to determine whether a user should be authenticated for a given URL. The user should be authenticated if the URL matches any regex in webview_browser_auth_whitelisted_url_patterns and doesn't match any regex in webview_browser_auth_blacklisted_url_patterns. The regexes are executed on iOS using NSRegularExpression, but server validation limits them to features supported by RE2. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| webviewDefaultJsBridgeBlacklistedUrlPatterns | | description | See webview_default_js_bridge_whitelisted_url_patterns. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| webviewDefaultJsBridgeWhitelistedUrlPatterns | | description | List of regexes used to determine whether any JS bridge should be enabled for a given URL. An arbitrary JS bridge can be enabled if the URL matches any regex in webview_default_js_bridge_whitelisted_url_patterns and doesn't match any regex in webview_default_js_bridge_blacklisted_url_patterns in addition to passing any other checks specific to that JS bridge. The regexes are executed on iOS using NSRegularExpression, but server validation limits them to features supported by RE2. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| webviewUdcJsBridgeBlacklistedUrlPatterns | | description | See webview_udc_js_bridge_whitelisted_url_patterns. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| webviewUdcJsBridgeWhitelistedUrlPatterns | | description | List of regexes used to determine whether the UDC JS bridge should be enabled for a given URL. The UDC JS bridge should be enabled if the URL matches any regex in webview_udc_js_bridge_whitelisted_url_patterns and doesn't match any regex in webview_udc_js_bridge_blacklisted_url_patterns. The regexes are executed on iOS using NSRegularExpression, but server validation limits them to features supported by RE2. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| webviewWhitelistedUrlPatterns | | description | List of regexes used to determine whether a URL should be opened in a webview. A URL may be opened in the webview if it matches any regex in webview_whitelisted_url_patterns and doesn't match any regex in webview_blacklisted_url_patterns. The regexes are executed on iOS using NSRegularExpression, but server validation limits them to features supported by RE2. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GetResourceRequest | | description | Request message for GetResource. |
|---|
| id | GetResourceRequest |
|---|
| properties | | context | | $ref | RequestContext |
|---|
| description | Information sent with every request. |
|---|
|
|---|
| resourceKey | | $ref | ResourceKey |
|---|
| description | Identifies the Resource being requested. |
|---|
|
|---|
| resourcesToOmit | | description | Specify the resources to omit from the response. The server is allowed to ignore this option. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GetResourceResponse | | description | Response message for GetResource. |
|---|
| id | GetResourceResponse |
|---|
| properties | | additionalResources | | description | Additional resources that the client should cache. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| resource | | $ref | Resource |
|---|
| description | The returned resource. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GetScreenRequest | | description | Request message for GetScreen. |
|---|
| id | GetScreenRequest |
|---|
| properties | | context | | $ref | RequestContext |
|---|
| description | Information sent with every request. |
|---|
|
|---|
| screenId | | description | Identifies the screen being requested. See ScreenId enum for possible values. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| screensToOmit | | description | Specify the screens to omit from the response. The server is allowed to ignore this option. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GetScreenResponse | | description | Response message for GetScreen. |
|---|
| id | GetScreenResponse |
|---|
| properties | | additionalScreens | | description | Additional screens that the client should cache. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| screen | | $ref | Screen |
|---|
| description | The returned screen. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GetSignedOutResourceRequest | | description | Request message for GetSignedOutResource. |
|---|
| id | GetSignedOutResourceRequest |
|---|
| properties | | context | | $ref | RequestContext |
|---|
| description | Information sent with every request. |
|---|
|
|---|
| resourceKey | | $ref | ResourceKey |
|---|
| description | Identifies the Resource being requested. |
|---|
|
|---|
| resourcesToOmit | | description | Specify the resources to omit from the response. The server is allowed to ignore this option. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GetSignedOutResourceResponse | | description | Response message for GetSignedOutResource. |
|---|
| id | GetSignedOutResourceResponse |
|---|
| properties | | additionalResources | | description | Additional resources that the client should cache. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| resource | | $ref | Resource |
|---|
| description | The returned resource. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleAccountVisualElementConfig | | description | Config for Google Account visual elements. It should contain all information required for VE logging such as id and metadata. |
|---|
| id | GoogleAccountVisualElementConfig |
|---|
| properties | | metadata | | $ref | GoogleAccountVisualElementMetadata |
|---|
| description | Additional metadata for Google Account visual elements |
|---|
|
|---|
| veid | | description | Visual Element Id from logs/gws/config/identity_metrics/google_account_configuration |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleAccountVisualElementMetadata | | description | Container to hold optional metadata associated with a visual element event in the google-account namespace. Will be used as an extension for the IdentityCommonVisualElementMetadata which will be interpreted by all nodes that are depending on the IdentityCommonVeloggingWeb node. |
|---|
| id | GoogleAccountVisualElementMetadata |
|---|
| properties | | accountSettingsArea | |
|---|
| linkMetadata | | $ref | LinkMetadata |
|---|
| description | Metadata containing information about the link attached to ASMS resources. |
|---|
|
|---|
| productProfileMetadata | | $ref | ProductProfileMetadata |
|---|
| description | Metadata containing information about Product Profile resources. |
|---|
|
|---|
| resourceMetadata | | $ref | ResourceMetadata |
|---|
| description | Metadata containing information about ASMS resources |
|---|
|
|---|
| searchOneboxMetadata | | $ref | SearchOneboxMetadata |
|---|
| description | Additional VE logging metadata for the Onebox. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| HaTSSurvey | | description | HaTS survey details. |
|---|
| id | HaTSSurvey |
|---|
| properties | | siteId | | description | Site id of the survey |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Header | | description | The header shown in the SearchResult card. |
|---|
| id | Header |
|---|
| properties | | displayEmail | | description | The users' display name, displayed underneath the display_name. |
|---|
| type | string |
|---|
|
|---|
| displayName | | description | The users' display name, displayed underneath the profile picture. |
|---|
| type | string |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | Optional illustration to be shown instead of a personal header. |
|---|
|
|---|
| profilePictureImage | | $ref | Image |
|---|
| description | The users' profile picture. |
|---|
|
|---|
| visibilityInfoText | | description | A informational text (containing also a link) explaining the limited visibiliy of the SearcResultCard. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| HelpCenterNavigationMetadata | | description | Additional information about navigation to the Help Center to distinguish between different articles |
|---|
| id | HelpCenterNavigationMetadata |
|---|
| properties | | articleId | | description | Identifier of the answer, e.g. https://support.google.com/accounts/answer/6304920 |
|---|
| type | string |
|---|
|
|---|
| category | | description | Help center, e.g. "accounts" or "googlepay". For example https://support.google.com/accounts/answer/6304920 |
|---|
| type | string |
|---|
|
|---|
| plink | | description | Shortcut for the article, e.g. https://support.google.com/families?p=noteligible_kid |
|---|
| type | string |
|---|
|
|---|
| topicId | | description | Topic, e.g. https://support.google.com/families#topic=7327571 |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| HelpCenterSearchItem | | description | Special search item shown below all results that links to a help center article for the entered query. Next id: 5 |
|---|
| id | HelpCenterSearchItem |
|---|
| properties | | icon | | $ref | Image |
|---|
| description | Icon shown on the right of the item, e.g. chevron icon. |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | Image displayed on the left of the item. |
|---|
|
|---|
| target | | $ref | Target |
|---|
| description | Item target. |
|---|
|
|---|
| title | | $ref | Title |
|---|
| description | Item title. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| HelpInfo | | deprecated | True |
|---|
| description | DEPRECATED Holds the data to open help for a specific screen. See go/mobilehelpguide Next Id: 3 |
|---|
| id | HelpInfo |
|---|
| properties | | fallbackSupportUri | | description | Url to help center articles, which is used when contextual help is not available (e.g. Android pre-ICS). |
|---|
| type | string |
|---|
|
|---|
| helpCenterContext | | description | The helpcenterContext used for contextual help, can be empty on Android. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| HelpParams | | description | used. Next Id: 5 |
|---|
| id | HelpParams |
|---|
| properties | | androidFeedbackCategoryTag | | description | This field is used to map a specific category tag for Android feedback. Defaults to "com.google.android.gms.accountsettings.feedback" |
|---|
| type | string |
|---|
|
|---|
| androidPackageOverrideName | | description | Allows overriding the default Android package name for IPH requests, enabling 1Ps to customize IPH flows. Defaults to "com.google.android.gms.accountsettings". |
|---|
| type | string |
|---|
|
|---|
| context | | description | This string is used by IPH to generate contextual/personalized list of articles. In open-to-content mode, the context is not directly used by IPH, but should have a sensible value if possible (see http://b/221108360). If omitted, defaults to "MY_GOOGLE_ANDROID_MAIN_SCREEN", "MY_GOOGLE_IOS_MAIN_SCREEN" or "HOME_SCREEN" (web), depending on the platform. |
|---|
| type | string |
|---|
|
|---|
| fallbackUrl | | description | FallbackUrl used when In-Product Help fails to load IPH. Not all iOS apps have IPH integrated, so there must always be a sensible fallback. If omitted, defaults to url or themed_url. If they are also omitted, defaults to "https://support.google.com/accounts" |
|---|
| type | string |
|---|
|
|---|
| iosFeedbackCategoryTag | | description | This field is used to map a specific category tag for iOS feedback. Defaults to "com.google.account.USER_INITIATED_FEEDBACK_REPORT" |
|---|
| type | string |
|---|
|
|---|
| iosPackageOverrideName | | description | Allows overriding the default iOS package name for IPH requests, enabling 1Ps to customize IPH flows. Defaults to "com.google.accountsettings.ios". |
|---|
| type | string |
|---|
|
|---|
| themedUrl | |
|---|
| url | | description | Help Center article URL which can be opened with IPH (In Product Help) |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Icon | | description | Specifies an icon and its description to be rendered in screen element like a menu. Next Id: 3 |
|---|
| id | Icon |
|---|
| properties | | contentDescription | | description | Optional content description of the icon for better accessibility. |
|---|
| type | string |
|---|
|
|---|
| iconId | | description | Icon IDs (and the icons themselves) are hard-coded into the client. This field is ignored if the client does not support the given ID. See IconId for possible values. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Image | | description | Image with a placeholder id, source url, and dimensions. Source URL may be specified in four distinct ways, depending on the client's capability set: +------------------------+---------------------------------+ | | uses_all_image_urls | | | == false | == true | +------------+-----------+-------------------+-------------+ | == false | url | image_urls | | seamless_ ------------+-------------------+-------------+ | dark_mode == true | themed_url.light | light_urls | | | themed_url.dark¹ | dark_urls¹ | +------------+-----------+-------------------+-------------+ ¹ Dark URLs are only specified when they are different from the light ones. Oneof is not used due to backwards compatibility reasons on iOS. Next id: 11 |
|---|
| id | Image |
|---|
| properties | | accessibilityLabel | | description | Localized accessibility label. |
|---|
| type | string |
|---|
|
|---|
| animatedThemedUrl | | $ref | ThemedUrl |
|---|
| description | A URL-wrapper containing values linking to Lottie animation files for different themes / user interface styles. Note that this field is only supported where explicitly stated when used. Additionally, there should always be a themed_url present that can be used as a fallback in case animation is not possible (e.g., Lottie is not available or the animation could not be loaded because of network / time / space constraints). |
|---|
|
|---|
| darkUrls | | $ref | ImageUrls |
|---|
| description | URLs to images for all screen density buckets in dark theme. Optional, light_urls is used, when absent. |
|---|
|
|---|
| height | | description | Height of the image bounding box. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| imageId | | description | Client-side placeholder image to use until URL has loaded. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| imageUrls | | $ref | ImageUrls |
|---|
| deprecated | True |
|---|
| description | URLs to images for all screen density buckets. Deprecated, use light_urls and dark_urls instead. |
|---|
|
|---|
| lightUrls | | $ref | ImageUrls |
|---|
| description | URLs to images for all screen density buckets in light theme. |
|---|
|
|---|
| themedUrl | | $ref | ThemedUrl |
|---|
| description | A URL-wrapper containing links to PNG, GIF, JPEG, or BMP files for different themes / user interface styles. The linked image should be optimized for the viewer's screen density. |
|---|
|
|---|
| url | | deprecated | True |
|---|
| description | The URL of a PNG, GIF, JPEG, or BMP file. The linked image should be optimized for the viewer's screen density. Deprecated, use themed_url instead. |
|---|
| type | string |
|---|
|
|---|
| width | | description | Width of the image bounding box. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ImageBlock | | description | A block containing an image. |
|---|
| id | ImageBlock |
|---|
| properties | | image | | $ref | Image |
|---|
| description | Image. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ImageUnit | | description | Image unit |
|---|
| id | ImageUnit |
|---|
| properties | | image | | $ref | Image |
|---|
| description | Image |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ImageUrls | | description | This proto holds all image URLs for all screen density buckets. This proto is returned instead of one optimized URL when this optimization should be done by the client, not ASMS (for example on web platform it is made by the browser). This is indicated by the uses_all_image_urls in request_context being set to true. |
|---|
| id | ImageUrls |
|---|
| properties | | urlX1 | | description | The URL of a PNG, GIF, JPEG, or BMP image. |
|---|
| type | string |
|---|
|
|---|
| urlX2 | | description | The URL of the X2 version of the image. |
|---|
| type | string |
|---|
|
|---|
| urlX3 | | description | The URL of the X3 version of the image. |
|---|
| type | string |
|---|
|
|---|
| urlX4 | | description | The URL of the X4 version of the image. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| InitialSearchScreenComponents | | description | Data required to render the initial search screen. Next id: 5 |
|---|
| id | InitialSearchScreenComponents |
|---|
| properties | | allowedPrecheckedResources | | description | List of allowed (searchable) Screen ResourceKeys. By default this is a list of SearchItem targets (though it can contain different list of ResourceKeys) |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| searchItemsSections | | description | List of items shown when no search terms are entered. The items are sorted by title. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| IntArray | | description | An int array |
|---|
| id | IntArray |
|---|
| properties | | values | | description | values of int array |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Item | | description | A single menu item, which generally opens up another screen when tapped. Items can be either SimpleItems or PromoItems. Exactly one of the item fields will be set. To allow for the addition of future item types, this menu item should be ignored by clients if none of the item fields are set. Next Id: 7 |
|---|
| id | Item |
|---|
| properties | | itemId | | description | The item's ID, unique within the scope of its section. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| mainScreenItem | | $ref | MainScreenItem |
|---|
| description | Set if it is a main screen item having a title, subtitle, and an icon. |
|---|
|
|---|
| profilePictureItem | | $ref | ProfilePictureItem |
|---|
| description | Set if the item is a profile-picture menu item, having a title and subtitle and locally rendered profile picture. |
|---|
|
|---|
| profilePicturePromoItem | | $ref | ProfilePicturePromoItem |
|---|
| description | Set if the item is a main screen profile-picture menu item, having a button in addition to the title and subtitle and locally rendered profile picture. |
|---|
|
|---|
| promoItem | | $ref | PromoItem |
|---|
| description | Set if the item is a promo item, having a button in addition to the title and subtitle. |
|---|
|
|---|
| simpleItem | | $ref | SimpleItem |
|---|
| description | Set if the item is a simple item, having a title and subtitle. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| JamMetadata | | description | Metadata containing information about JAM associated with VE data |
|---|
| id | JamMetadata |
|---|
| properties | | jamPage | | description | The JAM page the VE was logged on |
|---|
| enum | - UNKNOWN
- ADDRESS_EDIT
- ADD_ABOUT
- ADD_CONTACT_INFO
- ADD_WORK_AND_EDUCATION
- CHAT_EDIT
- CUSTOM_URLS
- DISCOVERABILITY
- DISPLAY_NAME_EDIT
- EDUCATION_EDIT
- EDUCATION
- EMAIL_EDIT
- INTRODUCTION_EDIT
- LIMITED_PROFILE
- LIMITED_PROFILE_EDIT
- LINKS_EDIT
- LINKS
- NAME_EDIT
- NAME
- NICKNAME_EDIT
- OCCUPATION_EDIT
- PHONE_EDIT
- PHOTO_EDIT
- PLACES_EDIT
- PLACES
- PRODUCT_PROFILE
- PRONOUNS_EDIT
- WORK_HISTORY_EDIT
- WORK_HISTORY
- WORKSPACE
|
|---|
| enumDescriptions | - unknown page
- addresss edit page
- add about page
- add contact info page
- add work and education page
- chat edit page
- custom url page
- discoverability page
- display name edit page
- education edit page
- education page
- email edit page
- introduction edit page
- limited profile page
- limited profile edit page
- links edit page
- links page
- name edit page
- name page
- nickname edit page
- occupation edit page
- phone edit page
- photo edit page
- places edit page
- places page
- product profile page
- pronouns edit page
- work history edit page
- work history page
- workspace page
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| LeftNav | | description | Left navigation bar with buttons. |
|---|
| id | LeftNav |
|---|
| properties | | blocks | | description | List of blocks. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| LeftNavBlock | | description | A building block of the left navigation. |
|---|
| id | LeftNavBlock |
|---|
| properties | | divider | | $ref | LeftNavDivider |
|---|
| description | A horizontal divider. |
|---|
|
|---|
| item | | $ref | LeftNavItem |
|---|
| description | A menu item. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| LeftNavDivider | | description | A horizontal divider for the left navigation. |
|---|
| id | LeftNavDivider |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| LeftNavItem | | description | One of the LeftNav buttons. Next id: 7 |
|---|
| id | LeftNavItem |
|---|
| properties | | accessibilityLabel | | description | A11y label attached to current item. |
|---|
| type | string |
|---|
|
|---|
| icon | | $ref | Image |
|---|
| description | Button icon. |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| selectedIcon | | $ref | Image |
|---|
| description | Button icon to be displayed when the item is selected. |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | The target screen. DEPRECATED: Use link instead. |
|---|
|
|---|
| title | | description | Button caption. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| LegendBlock | | description | Block to provide text definitions for image icons. |
|---|
| id | LegendBlock |
|---|
| properties | | legendItems | | description | Items to be define within the legend. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| LegendItem | | description | An individual item within a legend block. |
|---|
| id | LegendItem |
|---|
| properties | | accessibilityLabel | | description | Accessibility label for the legend item, used by screen readers instead of label. |
|---|
| type | string |
|---|
|
|---|
| delineator | | description | Symbol between the icon and the label. |
|---|
| type | string |
|---|
|
|---|
| icon | | $ref | Image |
|---|
| description | Icon to be defined. |
|---|
|
|---|
| label | | description | Label containing the definition of the icon. |
|---|
| type | string |
|---|
|
|---|
| stackFooterImage | | $ref | Image |
|---|
| description | When LegendItem is converted to StackFooter, this is the image displayed on the left of the new StackFooter. This is a temporary solution in use to convert SummaryCard to CollectionCard. This field should not be used by new cards. New cards should directly use CollectionCard. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Link | | description | Each navigation is represented as a Link, which contains the resource key of the target resource, anchor navigation params of the target element and the optional visual element config of the link. Eventually should completely replace the `target` field. |
|---|
| id | Link |
|---|
| properties | | anchorParams | | $ref | AnchorNavigationParams |
|---|
| description | Parameters of the anchor navigation. Occurs on the target resource, if present, otherwise, on the current one. |
|---|
|
|---|
| ariaLabel | | description | Aria label for the link. |
|---|
| type | string |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| description | ResourceKey of the target resource. If nil, navigation occurs on the same screen. |
|---|
|
|---|
| visualElementConfig | | $ref | GoogleAccountVisualElementConfig |
|---|
| description | Visual element configuration for the link. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| LinkMetadata | | description | Metadata containing information about the link inside a visual element |
|---|
| id | LinkMetadata |
|---|
| properties | | targetResourceId | | description | ResourceId in ASMS: google/internal/identity/accountsettings/mobile/v1/resource_id.proto |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ListItemBlock | | description | A vertical list item block. Next id: 16 |
|---|
| id | ListItemBlock |
|---|
| properties | | descriptions | | description | List of item descriptions. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| icon | | $ref | Image |
|---|
| description | icon shown on the right of the list item, e.g. chevron icon. |
|---|
|
|---|
| iconVerticalAlignment | | deprecated | True |
|---|
| description | Vertical alignment of chevron. See VerticalAlignment enum. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | Image displayed on the left of the list item. |
|---|
|
|---|
| label | | description | Label of the list item. |
|---|
| type | string |
|---|
|
|---|
| preferredLayout | | description | Preferred block layout. See BlockLayout enum. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| secondaryIcon | | $ref | Image |
|---|
| description | Secondary icon shown on the right of the list item and to the left of the main icon, e.g. ACL icons. |
|---|
|
|---|
| specialDescription | | $ref | SpecialDescription |
|---|
| description | Special description. |
|---|
|
|---|
| stackItemImage | | $ref | Image |
|---|
| description | When ListItemBlock is converted to StackItem, this is the image displayed on the left of the new StackItem. This is a temporary solution in use to convert SummaryCard to CollectionCard. This field should not be used by new cards. New cards should directly use CollectionCard. |
|---|
|
|---|
| textEntries | | deprecated | True |
|---|
| description | Text entries of the list item. Use label, titles, etc. instead. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| titles | | description | List of item titles. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| trailingImage | | $ref | Image |
|---|
| description | When ListItemBlock is converted to StackItem, this is the image displayed on the right of the new StackItem. This is a temporary solution in use to convert SummaryCard to CollectionCard. This field should not be used by new cards. New cards should directly use CollectionCard. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ListPreviewUnit | | description | screen/BDheWvg6VHnWYmA |
|---|
| id | ListPreviewUnit |
|---|
| properties | | items | | description | List of images. Should respect the max number of visible items on the unit. This number is currently limited to 5. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| total | | description | The total number of items in the list. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| LoadingCard | | description | Card with a loading spinner on it. |
|---|
| id | LoadingCard |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| Local | | description | Resource type used when the resource should be produced locally. |
|---|
| id | Local |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| LongArray | | description | A long array |
|---|
| id | LongArray |
|---|
| properties | | values | | description | values of long array |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| MainScreenItem | | description | A menu item with title, subtitle, and icon. Android-only Next Id: 5 |
|---|
| id | MainScreenItem |
|---|
| properties | | icon | | $ref | Icon |
|---|
| description | Optional icon. |
|---|
|
|---|
| screenId | | description | The screen ID that should be requested when this menu item is tapped. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| subtitleText | | description | Optional additional text, displayed in a smaller size and/or lighter color. Subtitles may contain explanatory text, or the current value of a setting. |
|---|
| type | string |
|---|
|
|---|
| titleText | | description | The main item text. Can be the name of a setting or group of settings. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| MenuAlternative | | description | Displays a screen as a native menu. Next Id: 6 |
|---|
| id | MenuAlternative |
|---|
| properties | | hatsSurvey | | $ref | HaTSSurvey |
|---|
| description | HaTS survey to be shown. |
|---|
|
|---|
| helpInfo | | $ref | HelpInfo |
|---|
| description | The data to open GoogleHelp |
|---|
|
|---|
| sections | | description | The sections that make up the menu's contents. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| showLogo | | description | Whether or not to show the Google logo |
|---|
| type | boolean |
|---|
|
|---|
| titleText | | description | The title to display in the menu's app bar. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| MessageAlternative | | description | Displays a screen by showing a message to the user. For instance, a user may be presented with a message such as 'Your administrator has disabled this setting' when their account policy does not allow them to edit some of their information. Next Id: 4 |
|---|
| id | MessageAlternative |
|---|
| properties | | helpInfo | | $ref | HelpInfo |
|---|
| deprecated | True |
|---|
| description | DEPRECATED The data to open GoogleHelp. |
|---|
|
|---|
| messageText | | description | The message to display. Required. |
|---|
| type | string |
|---|
|
|---|
| titleText | | deprecated | True |
|---|
| description | DEPRECATED The title to display in the menu's app bar. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| NativeAlternative | | description | Displays a screen as a native setting. Next Id: 8 |
|---|
| id | NativeAlternative |
|---|
| properties | | anchorNavigationParams | | $ref | AnchorNavigationParams |
|---|
| description | Contains the necessary information to scroll to particular place on the screen. |
|---|
|
|---|
| feedbackParams | | $ref | FeedbackParams |
|---|
| description | Contains the necessary information to launch the Feedback Client with the proper configuration. |
|---|
|
|---|
| helpParams | | $ref | HelpParams |
|---|
| description | Contains fields used for opening IPH (In Product Help) |
|---|
|
|---|
| nativeActionId | | description | An ID identifying the native setting. See NativeActionId for possible values. Required. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| profilePicturePickerParams | | $ref | ProfilePicturePickerParams |
|---|
| description | Contains the necessary information to launch the profile picture picker. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| NativeCapabilities | | description | The capabilities of the native actions. Field names should be without a "supports" prefix. It is implicit in the message, since it's about which features the client supports. |
|---|
| id | NativeCapabilities |
|---|
| properties | | fauxbakeImageCropping | | description | Whether the client supports the custom Fauxbake image cropping UI. |
|---|
| type | boolean |
|---|
|
|---|
| postGplusApiSunsetProfilePictureFlow | | description | Whether the client supports a native profile picture flow that will continue to work after the go/gplus-1p-sunset. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| NativeNavigationAlternative | | description | Navigates to a native screen from a web or webview screen. Will fallback to open an url in browser when not possible. |
|---|
| id | NativeNavigationAlternative |
|---|
| properties | | link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| navigateBack | |
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Target native screen. DEPRECATED: Use link instead. |
|---|
|
|---|
| url | | description | Fallback url for the native screen, will be opened when a native experience is not available. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| NavigationMetadata | | description | Additional information about the navigation |
|---|
| id | NavigationMetadata |
|---|
| properties | | dashboardMetadata | | $ref | DashboardNavigationMetadata |
|---|
| description | Additional information about navigations from Google Dashboard. |
|---|
|
|---|
| dashboardServiceMetadata | | $ref | DashboardServiceCardOutboundNavigationMetadata |
|---|
| description | Additional information about outbound navigations from service cards on Google Dashboard. |
|---|
|
|---|
| helpCenterMetadata | | $ref | HelpCenterNavigationMetadata |
|---|
| description | Additional information about navigation to the Help Center to distinguish between different articles |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| OnboardingAlternative | | deprecated | True |
|---|
| description | A screen with onboarding flow |
|---|
| id | OnboardingAlternative |
|---|
| properties | | onboardingFlow | | $ref | OnboardingFlow |
|---|
| description | The onboarding flow data. |
|---|
|
|---|
| onboardingFlowKey | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | The representation of the onboarding flow. DEPRECATED: use onboarding flow directly. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| OnboardingFlow | | deprecated | True |
|---|
| description | A resource encapsulating multiple onboarding steps, an animation, and a button. Next Id: 8 |
|---|
| id | OnboardingFlow |
|---|
| properties | | animationThemedUrl | | $ref | ThemedUrl |
|---|
| description | The decorative Lottie animation urls for both themes. Required. |
|---|
|
|---|
| animationUrl | | deprecated | True |
|---|
| description | The decorative Lottie animation url. Deprecated, use animation_themed_url instead. |
|---|
| type | string |
|---|
|
|---|
| buttonTarget | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | The resource to open when onboarding is skipped or finished. Only used when the OnboardingFlow is referenced from an OnboardingAlternative. When referenced from a CardsAlternative, the CardsAlternative is shown when the onboarding flow has finished. DEPRECATED: Use link instead. |
|---|
|
|---|
| buttonText | | description | The text to be shown on the button that skips onboarding. e.g.: "Get started". Required. |
|---|
| type | string |
|---|
|
|---|
| dismissalId | | description | An identifier used to record which OnboardingFlows have been dismissed. Required. |
|---|
| format | int64 |
|---|
| type | string |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | The link of the element to open when onboarding is skipped or finished. Only used when the OnboardingFlow is referenced from an OnboardingAlternative. When referenced from a CardsAlternative, the CardsAlternative is shown when the onboarding flow has finished. Eventually should completely replace the `target` field. |
|---|
|
|---|
| steps | | description | The steps containing onboarding content. At least one is required. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| OnboardingStep | | deprecated | True |
|---|
| description | Describes the contents of an onboarding step. An OnboardingStep must contain at least a title or a message. Next Id: 6 |
|---|
| id | OnboardingStep |
|---|
| properties | | exitAnimation | | $ref | AnimationSegment |
|---|
| description | A segment of animation played once the skip button is clicked. |
|---|
|
|---|
| message | | description | The onboarding step message text. |
|---|
| type | string |
|---|
|
|---|
| stepId | | description | A unique StepId used for logging. Required. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| title | | description | The onboarding step title text. |
|---|
| type | string |
|---|
|
|---|
| transitionAnimation | | $ref | AnimationSegment |
|---|
| description | A segment of the animation played as we slide from the last step to the current step. When sliding back to the previous step, the animation will be played in reverse. For the first step, this animation will be auto-played while the content of the screen fades in. Required. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| OneBoxBlock | | description | Building block of a card Next id: 35 |
|---|
| id | OneBoxBlock |
|---|
| properties | | actionChipBlock | | $ref | ActionChipBlock |
|---|
| description | Action Chip Block |
|---|
|
|---|
| actionLineBlock | | $ref | ActionLineBlock |
|---|
| description | Navigation Link Block |
|---|
|
|---|
| activityListItemBlock | | $ref | ActivityListItemBlock |
|---|
| description | List Item Block used for showing user activities. |
|---|
|
|---|
| collapsableBlock | | $ref | CollapsableBlock |
|---|
| description | A block that can be collapsed |
|---|
|
|---|
| descriptionBlock | | $ref | DescriptionBlock |
|---|
| description | Description block |
|---|
|
|---|
| dividerBlock | | $ref | DividerBlock |
|---|
| description | Divider Block |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| listItemBlock | | $ref | ListItemBlock |
|---|
| description | List Item Block |
|---|
|
|---|
| oneBoxSignedOutButtonsBlock | | $ref | OneBoxSignedOutButtonsBlock |
|---|
| description | A block that consists of Sign in and Sign up buttons |
|---|
|
|---|
| oneboxCustomGwsBlock | | $ref | OneboxCustomGwsBlock |
|---|
| description | A block that can be rendered using GWS. |
|---|
|
|---|
| oneboxDisclaimerBlock | | $ref | OneboxDisclaimerBlock |
|---|
| description | Disclaimer block currently used in the Oneboxes. |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of tap destination resource. DEPRECATED: Use link instead. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| OneBoxSignedOutButtonsBlock | | description | A block consisting of Sign in and Sign up buttons, used when Signed out. |
|---|
| id | OneBoxSignedOutButtonsBlock |
|---|
| properties | | signInLink | | $ref | SignedOutBlockLink |
|---|
| description | Link that leads to the sing in page. Required. |
|---|
|
|---|
| signUpLink | | $ref | SignedOutBlockLink |
|---|
| description | Link that leads to the sing up page. Required. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| OneGoogleCard | | description | Card representing an entry in the OneGoogle Account Menu. |
|---|
| id | OneGoogleCard |
|---|
| properties | | actionChip | | $ref | ActionChip |
|---|
| description | A chip that allows users to take action on the card. |
|---|
|
|---|
| leadingImage | | $ref | Image |
|---|
| description | An image that may be shown at the leading edge of the card. |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| priority | | description | The priority of the card. Can influence ordering and styling of the cards. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| progressBar | | $ref | OneGoogleProgressBar |
|---|
| description | An optional progress bar |
|---|
|
|---|
| subtitle | | description | The subtitle of the card. |
|---|
| type | string |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of tap destination resource. DEPRECATED: Use link instead. |
|---|
|
|---|
| title | | description | The main title of the card. |
|---|
| type | string |
|---|
|
|---|
| trailingImage | | $ref | Image |
|---|
| description | An image that may be shown at the trailing edge of the card. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| OneGoogleProgressBar | | description | A progress bar that can be shown in the OneGoogle Account Menu Card. ProgressBar message could be used here instead, but it supports two labels, whereas OneGoogle's UI only supports one and it supports setting the background color (which OG also does not support). |
|---|
| id | OneGoogleProgressBar |
|---|
| properties | | color | | $ref | Color |
|---|
| description | The color of the progress bar. |
|---|
|
|---|
| description | | description | An optional description for the progress bar. |
|---|
| type | string |
|---|
|
|---|
| progress | | description | The progress of the progress bar. Should be between 0 and 1. |
|---|
| format | float |
|---|
| type | number |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| OneboxCustomGwsBlock | | description | A block that can be rendered using GWS. |
|---|
| id | OneboxCustomGwsBlock |
|---|
| properties | | type | | description | The type of the custom block. |
|---|
| enum | |
|---|
| enumDescriptions | - Unknown block type.
- Safesearch block type.
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| OneboxDisclaimerBlock | | description | A block containing a disclaimer of some sort. Next id: 4 |
|---|
| id | OneboxDisclaimerBlock |
|---|
| properties | | disclaimerContent | | $ref | Text |
|---|
| description | The content of the disclaimer. Use this in favor of disclaimer_text. |
|---|
|
|---|
| disclaimerText | | deprecated | True |
|---|
| description | The text content of the disclaimer. |
|---|
| type | string |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | Optional illustration shown near the disclaimer text. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Placeholder | | description | Placeholder used when a resource hasn't loaded yet. |
|---|
| id | Placeholder |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| PlaceholderAlternative | | description | Placeholder for when a resource hasn't loaded yet. |
|---|
| id | PlaceholderAlternative |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| PrefetchRelatedScreensRequest | | description | Request message for PrefetchRelatedScreens. |
|---|
| id | PrefetchRelatedScreensRequest |
|---|
| properties | | context | | $ref | RequestContext |
|---|
| description | Information sent with every request. |
|---|
|
|---|
| screenId | | description | Identifies the target screen. See ScreenId enum for possible values. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| screensToOmit | | description | Specify the screens to omit from the response. The server is allowed to ignore this option. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| PrefetchRelatedScreensResponse | | description | Response message for PrefetchRelatedScreens. |
|---|
| id | PrefetchRelatedScreensResponse |
|---|
| properties | | screens | | description | The returned screens. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ProductProfileMetadata | | description | Metadata containing information about Product Profile resources associated with the VE |
|---|
| id | ProductProfileMetadata |
|---|
| properties | | productProfile | | description | Product profile |
|---|
| enum | - PRODUCT_PROFILE_UNKNOWN
- PLAY_GAMES
- GPAY
- WORKSPACE
- MAPS
- OTHER_GOOGLE_SERVICES
- YOUTUBE
|
|---|
| enumDescriptions | - Unknown product profile
- Play Games
- GPay
- Workspace
- Maps
- Other Google services
- Youtube
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ProfilePictureBlock | | description | A special block containing a label, title, description, and a tappable profile picture to the right. |
|---|
| id | ProfilePictureBlock |
|---|
| properties | | avatarAccessibilityTapText | | description | Tap action text read by a screen reader before the phrase "double-tap to activate" when focus moves to the profile picture image. |
|---|
| type | string |
|---|
|
|---|
| descriptionText | | description | Description text of the profile picture block. |
|---|
| type | string |
|---|
|
|---|
| label | | description | Label of the profile picture block. |
|---|
| type | string |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click on the profile picture. Eventually should completely replace the `target` field. |
|---|
|
|---|
| preferredLayout | | description | Preferred block layout. See BlockLayout enum. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| profilePictureImage | | $ref | Image |
|---|
| description | Profile picture image. |
|---|
|
|---|
| stackItemImage | | $ref | Image |
|---|
| description | When ProfilePictureBlock is converted to StackItem, this is the image displayed on the left of the new StackItem. screen/72S3nvYEKnuscar. This is a temporary solution in use to convert SummaryCard to CollectionCard. This field should not be used by new cards. New cards should directly use CollectionCard. |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of tap destination resource of the profile picture. DEPRECATED: Use link instead. |
|---|
|
|---|
| textEntries | | deprecated | True |
|---|
| description | Text entries of the profile picture block. Use label, title, etc. instead. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| title | | description | Title of the profile picture block. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ProfilePictureItem | | description | A menu item, with title and subtitle, renders profile picture locally. Next Id: 4 |
|---|
| id | ProfilePictureItem |
|---|
| properties | | screenId | | description | The screen ID that should be requested when this menu item is tapped. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| subtitleText | | description | Optional additional text, displayed in a smaller size and/or lighter color. Subtitles may contain explanatory text, or the current value of a setting. |
|---|
| type | string |
|---|
|
|---|
| titleText | | description | The main item text. Can be the name of a setting or group of settings. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ProfilePicturePickerParams | | description | Params used when launching the profile picture picker. Next Id: 2 |
|---|
| id | ProfilePicturePickerParams |
|---|
| properties | | usePeopleApi | | description | If true, iOS client will use the People API to upload the photo. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ProfilePicturePromoItem | | description | A promo with text, subtitle, renders profile picture locally. Only the button is a tappable. May be styled differently from a ProfileItem. Android-only Next Id: 5 |
|---|
| id | ProfilePicturePromoItem |
|---|
| properties | | buttonText | | description | The button text. |
|---|
| type | string |
|---|
|
|---|
| screenId | | description | The screen ID that should be requested when this menu item is tapped. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| subtitleText | | description | Optional additional text, displayed in a smaller size and/or lighter color. Contains the user's primary email address. |
|---|
| type | string |
|---|
|
|---|
| titleText | | description | The main item text. Contains the user's display name. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ProfilePictureUnit | | description | screen/8UcDB3nx9wRtoPg |
|---|
| id | ProfilePictureUnit |
|---|
| properties | | accessibilityTapText | | description | Accessibility label for the profile picture, used by screen readers. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ProgressBar | | description | Progress bar. Supports settings colors for progress and background and labeling these parts. |
|---|
| id | ProgressBar |
|---|
| properties | | backgroundColor | | $ref | Color |
|---|
| deprecated | True |
|---|
| description | Color of the not completed part of the progress bar. Deprecated. Use background_themed_color instead. |
|---|
|
|---|
| backgroundThemedColor | | $ref | ThemedColor |
|---|
| description | Color of the not completed part of the progress bar. |
|---|
|
|---|
| endLabelText | | deprecated | True |
|---|
| description | Text of the label on the ending (high) end of the progress bar |
|---|
| type | string |
|---|
|
|---|
| labelColor | | $ref | Color |
|---|
| deprecated | True |
|---|
| description | Color of the text. Deprecated. Use label_themed_color instead. |
|---|
|
|---|
| labelIcon | | $ref | Image |
|---|
| deprecated | True |
|---|
| description | Icon, shown to the start of the text. Center-aligned vertically. DEPRECATED: Use the icon in the PromptItem instead. This field should only be used by old clients that do not support the new advice_severity field. |
|---|
|
|---|
| labelText | | description | Text shown below the progress bar |
|---|
| type | string |
|---|
|
|---|
| labelThemedColor | | $ref | ThemedColor |
|---|
| description | Color of the text. |
|---|
|
|---|
| progress | | description | Percentage of the progressbar to be filled in a range of 0 - 1. |
|---|
| format | float |
|---|
| type | number |
|---|
|
|---|
| progressColor | | $ref | Color |
|---|
| deprecated | True |
|---|
| description | Color of the progressbar. Deprecated. Use progress_themed_color instead. |
|---|
|
|---|
| progressThemedColor | | $ref | ThemedColor |
|---|
| description | Color of the progress bar. |
|---|
|
|---|
| stackItemImage | | $ref | Image |
|---|
| description | When ProgressBar becomes part of the StackItem, this is the image displayed on the left of the new StackItem. This is a temporary solution in use to convert SummaryCard to CollectionCard. This field should not be used by new cards. New cards should directly use CollectionCard. |
|---|
|
|---|
| startLabelText | | deprecated | True |
|---|
| description | Text of the label on the starting (low) end of the progress bar |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ProgressBarBlock | | description | A block containing styled text entries and a progress bar. |
|---|
| id | ProgressBarBlock |
|---|
| properties | | progressBar | | $ref | ProgressBar |
|---|
| description | Progress bar. |
|---|
|
|---|
| textEntries | | deprecated | True |
|---|
| description | Text entries for the progress bar block. Shown above the progress bar. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ProgressBarListItemBlock | | description | List item-like block that contains a progress bar |
|---|
| id | ProgressBarListItemBlock |
|---|
| properties | | icon | | $ref | Image |
|---|
| description | icon shown on the right of the list item, e.g. chevron icon. |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | Image displayed on the left of the list item. |
|---|
|
|---|
| progressBar | | $ref | ProgressBar |
|---|
| description | Progress bar |
|---|
|
|---|
| title | | description | Item title. |
|---|
| type | string |
|---|
|
|---|
| trailingImage | | $ref | Image |
|---|
| description | When ProgressBarListItemBlock is converted to StackItem, this is the image displayed on the right of the new StackItem. This is a temporary solution in use to convert SummaryCard to CollectionCard. This field should not be used by new cards. New cards should directly use CollectionCard. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ProgressBarUnit | | description | screen/9LsrL7URSifxp3G |
|---|
| id | ProgressBarUnit |
|---|
| properties | | barBackgroundColor | | $ref | ThemedColor |
|---|
| description | The color of the background. |
|---|
|
|---|
| barForegroundColor | | $ref | ThemedColor |
|---|
| description | The color of the progress |
|---|
|
|---|
| labelText | | description | Label “1.5GB of 15GB used” |
|---|
| type | string |
|---|
|
|---|
| progress | | description | Progress of the Bar |
|---|
| format | float |
|---|
| type | number |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| PromoItem | | description | A promo with text, subtitle, icon and button. Only the button is a tappable. May be styled differently from a SimpleItem. Next Id: 7 |
|---|
| id | PromoItem |
|---|
| properties | | buttonText | | description | The button text. |
|---|
| type | string |
|---|
|
|---|
| icon | | $ref | Icon |
|---|
| description | Optional icon. |
|---|
|
|---|
| screenId | | description | The screen ID that should be requested when this menu item is tapped. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| statusText | | description | Optional text, to display an additional status message (e.g. 'Last checked at...') in the promo. |
|---|
| type | string |
|---|
|
|---|
| subtitleText | | description | Optional additional text, displayed in a smaller size and/or lighter color. Subtitles may contain explanatory text, or the current value of a setting. |
|---|
| type | string |
|---|
|
|---|
| titleText | | description | The main item text. Can be the name of a setting or group of settings. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| PromptBlock | | description | Building block of a prompt card |
|---|
| id | PromptBlock |
|---|
| properties | | descriptionBlock | | $ref | PromptDescriptionBlock |
|---|
| description | Description Block |
|---|
|
|---|
| progressBlock | | $ref | PromptProgressBarBlock |
|---|
| description | Progress Bar Block |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| PromptCarouselCard | | description | A horizontally scrolling carousel of prompt items. |
|---|
| id | PromptCarouselCard |
|---|
| properties | | items | | deprecated | True |
|---|
| description | The order of the items is the order they should appear in the UI. Deprecated, clients should expect prompt_item_keys instead. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| maxVisibleItems | | description | The maximum number of items to show. If the number of items is greater than this number, the overflow item will be shown. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| overflowCollapseAccessibilityTapText | | description | Tap action text read by a screen reader instead of the default "double-tap to activate" when focus moves to the collapsed card in the expanded state. |
|---|
| type | string |
|---|
|
|---|
| overflowCollapseTitle | | description | The title of the overflow item when the prompt items are expanded. |
|---|
| type | string |
|---|
|
|---|
| overflowExpandAccessibilityTapText | | description | Tap action text read by a screen reader instead of the default "double-tap to activate" when focus moves to the overflow card in the collapsed state. |
|---|
| type | string |
|---|
|
|---|
| overflowExpandTitle | | description | The title of the overflow item when the prompt items are collapsed. |
|---|
| type | string |
|---|
|
|---|
| promptItemKeys | | description | The order of the prompt items is the order they should appear in the UI. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| visualElementConfig | | $ref | GoogleAccountVisualElementConfig |
|---|
| description | Visual element configuration for the prompt carousel card. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| PromptDescriptionBlock | | description | A block containing a title and descriptive text, with an image displayed on the left side optionally. |
|---|
| id | PromptDescriptionBlock |
|---|
| properties | | image | | $ref | Image |
|---|
| deprecated | True |
|---|
| description | Optional image to be displayed in the Prompt Item. DEPRECATED: Use the icon in the PromptItem instead. This field should only be used by old clients that do not support the new advice_severity field. |
|---|
|
|---|
| text | | description | Descriptive text of the block. |
|---|
| type | string |
|---|
|
|---|
| title | | description | Title of the block. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| PromptItem | | description | Prompt items for the user to be taken care of in a timely manner, e.g., updating their credit card. Next id: 17 |
|---|
| id | PromptItem |
|---|
| properties | | adviceSeverity | | description | Severity of the prompt from the AdviceSeverity enum |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| callToActionText | | description | Call to action text. In the context of the Advice Framework, It can be styled the same way as the secondary button by setting `equally_weighted_action_buttons` to true. If not specified, no primary call to action button is shown. |
|---|
| type | string |
|---|
|
|---|
| dismissible | | description | Dismisses the card on all user devices and surfaces. |
|---|
| type | boolean |
|---|
|
|---|
| equallyWeightedActionButtons | | description | If true, the action buttons will be styled equally and the card body won't be tappable. This is a special handling for primary CTA having the same style as the secondary (e.g. for legal reasons). |
|---|
| type | boolean |
|---|
|
|---|
| expandCardAccessibilityTapText | | description | Tap action text read by a screen reader instead of the default "double-tap to activate" when focus moves to the collapsed card. |
|---|
| type | string |
|---|
|
|---|
| hintText | | description | Text to be shown as hint. In the Advice Framework, this is used as the text that goes next to the chevron icon on simple list items. |
|---|
| type | string |
|---|
|
|---|
| icon | | $ref | Image |
|---|
| description | Icon to be shown on the advice card. |
|---|
|
|---|
| id | | deprecated | True |
|---|
| description | Prompt card identifier. Used by the client to record which PromptItems have been dismissed so that they are not reshown. Deprecated, clients should use ResourceKey of the Resource wrapper instead. |
|---|
| format | int64 |
|---|
| type | string |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. In the context of the Advice Framework, 'link' is used to represent the primary CTA destination and the card body destination in case no 'secondary_button_text' and 'secondary_button_link' are specified. Eventually should completely replace the `target` field. |
|---|
|
|---|
| mainBlock | | $ref | PromptBlock |
|---|
| description | Main content of the prompt card |
|---|
|
|---|
| secondaryButtonLink | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. This is used to navigate to a different resource via secondary button. |
|---|
|
|---|
| secondaryButtonText | | description | Secondary call to action block If not specified, no secondary call to action button is shown. |
|---|
| type | string |
|---|
|
|---|
| severity | | deprecated | True |
|---|
| description | Severity of the prompt from the PromptSeverity enum DEPRECATED: Use advice_severity instead. This field should only be used by old clients that do not support the new advice_severity field. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of tap destination resource DEPRECATED: Use link instead. |
|---|
|
|---|
| title | | description | Prompt card title |
|---|
| type | string |
|---|
|
|---|
| visualElementConfig | | $ref | GoogleAccountVisualElementConfig |
|---|
| description | Visual element configuration for the prompt card. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| PromptProgressBarBlock | | description | A block containing a progress bar with a label underneath each end |
|---|
| id | PromptProgressBarBlock |
|---|
| properties | | endLabelText | | deprecated | True |
|---|
| description | Text of the label on the ending (high) end of the progress bar Deprecated, clients should use progress_bar instead. |
|---|
| type | string |
|---|
|
|---|
| progress | | deprecated | True |
|---|
| description | Percentage of the progressbar to be filled in a range of 0 - 1. Deprecated, clients should use progress_bar instead. |
|---|
| format | float |
|---|
| type | number |
|---|
|
|---|
| progressBar | | $ref | ProgressBar |
|---|
| description | Progress bar |
|---|
|
|---|
| progressColor | | $ref | Color |
|---|
| deprecated | True |
|---|
| description | Color of the progressbar. Deprecated, clients should use progress_bar instead. |
|---|
|
|---|
| startLabelText | | deprecated | True |
|---|
| description | Text of the label on the starting (low) end of the progress bar Deprecated, clients should use progress_bar instead. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| RequestContext | | description | Information sent with every request. A subset of this information is logged to Clearcut logs. If you change anything here consider updating the logging proto google3/logs/proto/identity/mobile/accountsettings/asm_client_info_extension.proto as well. Next Id: 14 |
|---|
| id | RequestContext |
|---|
| properties | | callingAndroidApp | | description | ApplicationId (package name) or alias of the app that launched My Google. If launched from - a first-party app: the app's ApplicationId (package name) - a third-party app: empty (if the app was started with startActivityForResult, the package name of the third-party app will be logged instead of an empty string) - within GmsCore or Android Settings: "com.google.android.gms" - Otherwise: unset |
|---|
| type | string |
|---|
|
|---|
| clientCapabilities | | $ref | ClientCapabilities |
|---|
| description | Tells the server which features this version of the client supports. |
|---|
|
|---|
| clientVersions | | $ref | ClientVersions |
|---|
| description | Version numbers for the client software. |
|---|
|
|---|
| googleAccountReferrer | | description | Serialized GoogleAccountReferrer that provided by caller of Google Account as query param. |
|---|
| type | string |
|---|
|
|---|
| isAuto | | description | Whether the device the request came from is an Auto device. |
|---|
| type | boolean |
|---|
|
|---|
| isDarkModeEnabled | | deprecated | True |
|---|
| description | Whether the client has dark mode enabled (and thus expects content from the server to be similarly themed). Deprecated. Provide theme-agnostic resources instead of relying on this field. |
|---|
| type | boolean |
|---|
|
|---|
| isPayModuleAvailable | | description | Whether the client has the pay gmscore module available (only relevant for Android clients). |
|---|
| type | boolean |
|---|
|
|---|
| isRtl | | description | Tells whether the client is currently displaying in RTL mode. |
|---|
| type | boolean |
|---|
|
|---|
| logicalScreenDensity | | description | The logical screen density of the device, following the Android convention that logical_screen_density = scaling_factor * 160ppi. Used by the server to select images with the most appropriate scaling factor. Will usually differ from the physical screen density. Examples: * a Nexus 5 will report 480ppi (xxhdpi), but has a 445ppi screen * an iPhone 4 will report 320dpi (2x), but has a 326ppi screen |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| platform | | description | The client's OS platform. |
|---|
| enum | - PLATFORM_UNSPECIFIED
- ANDROID
- IOS
- WEB
|
|---|
| enumDescriptions | - The platform is unspecified.
- The Android operating system.
- The iOS operating system.
- Web browser.
|
|---|
| type | string |
|---|
|
|---|
| timeZone | | description | The time zone of the user's device, as a Unix time zone ID. e.g. "Europe/Berlin". |
|---|
| type | string |
|---|
|
|---|
| usesAllImageUrls | | description | When set to true ASMS will return image urls for all screen density buckets instead of one already optimized url. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Resource | | description | Resources are the core component of the API. Resources can be screens, but also parts of screens, such as tab bars or decks of cards. Resources can be requested and cached by the client independently of each other. |
|---|
| id | Resource |
|---|
| properties | | accountMenuInformation | | $ref | AccountMenuInformation |
|---|
| description | Information provided to the OGL account menu. |
|---|
|
|---|
| bottomNav | | $ref | BottomNav |
|---|
| description | Bottom buttons navigation. |
|---|
|
|---|
| card | |
|---|
| cardDeck | | $ref | CardDeck |
|---|
| description | Set of cards. |
|---|
|
|---|
| footer | | $ref | Footer |
|---|
| description | Footer. |
|---|
|
|---|
| initialSearchScreenComponents | | $ref | InitialSearchScreenComponents |
|---|
| description | Components for initial search screen on mobile. |
|---|
|
|---|
| isDismissed | | description | Resource with is_dismissed=true shouldn't be shown to the user. It is provided for a short time after dismissal on the server, to allow the dismissed resource to be recovered on the client (e.g. for "undo" action). |
|---|
| type | boolean |
|---|
|
|---|
| isStable | | description | Affects the client caching policy. A resource is unstable if it shows user data which is prone to change, e.g. a menu displaying the user's phone numbers, or a setting allowing the user to edit their phone numbers. Stable resources do not change after user action, e.g. a resource which opens a given URL in the browser. When the user opens a setting, all unstable resources are marked dirty and reloaded the next time the user navigates to them. Stable resources don't need to be immediately reloaded after a user action. |
|---|
| type | boolean |
|---|
|
|---|
| leftNav | | $ref | LeftNav |
|---|
| description | Left navigation. |
|---|
|
|---|
| local | | $ref | Local |
|---|
| description | A resource that should be produced locally (i.e., on the target device). |
|---|
|
|---|
| onboardingFlow | | $ref | OnboardingFlow |
|---|
| deprecated | True |
|---|
| description | Onboarding flow. |
|---|
|
|---|
| placeholder | | $ref | Placeholder |
|---|
| description | Reserved for internal use by clients. |
|---|
|
|---|
| promptItem | | $ref | PromptItem |
|---|
| description | Prompt Card. |
|---|
|
|---|
| resourceKey | | $ref | ResourceKey |
|---|
| description | Identifies a resource. |
|---|
|
|---|
| screen | | $ref | ScreenResource |
|---|
| description | Description of the screen structure. |
|---|
|
|---|
| searchCorpus | | $ref | SearchCorpus |
|---|
| description | Search data for all searchable items. |
|---|
|
|---|
| securityHubPromptItem | | $ref | SecurityHubPromptItem |
|---|
| description | Security Hub Prompt Card. |
|---|
|
|---|
| simpleHeader | | $ref | SimpleHeader |
|---|
| description | Simple header. |
|---|
|
|---|
| supportPanel | | $ref | SupportPanel |
|---|
| description | Support panel |
|---|
|
|---|
| topNav | | $ref | TopNav |
|---|
| description | Top tabs bar. |
|---|
|
|---|
| welcomeHeader | | $ref | WelcomeHeader |
|---|
| description | Main header. |
|---|
|
|---|
| welcomeScreenIntro | | $ref | WelcomeScreenIntro |
|---|
| description | The welcome screen intro shown on home page on web. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ResourceKey | | description | Each resource will be identified by a resource key, which contains a resource ID and resource parameters. Clients will use the ResourceKey as a cache key. |
|---|
| id | ResourceKey |
|---|
| properties | | resourceId | | description | a value from the ResourceId enum |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| resourceParams | | additionalProperties | |
|---|
| description | key-value map of request parameters |
|---|
| type | object |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ResourceMetadata | | description | Metadata containing information about ASMS resources associated with the VE go/my-google/asms#resources |
|---|
| id | ResourceMetadata |
|---|
| properties | | jamMetadata | | $ref | JamMetadata |
|---|
| description | Metadata for JAM specific pages |
|---|
|
|---|
| resourceId | | description | ResourceId in ASMS: google/internal/identity/accountsettings/mobile/v1/resource_id.proto |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ResourceToOmit | | description | A resource to omit from the results |
|---|
| id | ResourceToOmit |
|---|
| properties | | resourceKey | | $ref | ResourceKey |
|---|
| description | Identifies the Resource. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Screen | | description | Screens are the core component of the API. When requesting a screen, the client does not necessarily know whether the screen represents a menu, a native setting, a message etc. Both menus and individual settings are thus represented using the same proto, which allows us to support use cases such as deep-linking from 1P apps. Next Id: 4 |
|---|
| id | Screen |
|---|
| properties | | alternatives | | description | A list of alternatives, in order of preference. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| isStable | | description | Affects the client caching policy. A screen is unstable if it shows user data which is prone to change, e.g. a menu displaying the user's phone numbers, or a setting allowing the user to edit their phone numbers. Stable screens do not change after user action, e.g. a screen which opens a given URL in the browser. When the user opens a setting, all unstable screens are marked dirty and reloaded the next time the user navigates to them. Stable screens don't need to be immediately reloaded after a user action. |
|---|
| type | boolean |
|---|
|
|---|
| screenId | | description | The screen's ID. See ScreenId for possible values. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ScreenIntro | | description | Framing for the screen content. May contain an image, a title and a description. |
|---|
| id | ScreenIntro |
|---|
| properties | | description | | description | Description text for the screen intro. May be omitted. |
|---|
| type | string |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | Image for the screen intro. May be omitted. |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click on the link. Eventually should completely replace the `target` field. |
|---|
|
|---|
| linkAccessibilityLabel | | deprecated | True |
|---|
| description | Accessibility label for the link, used by screen readers instead of link_text. DEPRECATED: Use link.aria_label instead. |
|---|
| type | string |
|---|
|
|---|
| linkIcon | | $ref | Image |
|---|
| description | Icon to append after the link text. |
|---|
|
|---|
| linkTarget | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of link destination resource. DEPRECATED: Use link instead. |
|---|
|
|---|
| linkText | | description | Description block link text. |
|---|
| type | string |
|---|
|
|---|
| title | | description | Title text for the screen intro. May be omitted. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ScreenResource | | description | A type of a resource. Similar to a Screen, a ScreenResource can represent a menu, a native setting, a message etc. Next Id: 3 |
|---|
| id | ScreenResource |
|---|
| properties | | alternatives | | description | A list of alternatives, in order of preference. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| navigationMetadata | | $ref | NavigationMetadata |
|---|
| description | Additional information about the navigation |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ScreenToOmit | | description | A screen to omit from the results |
|---|
| id | ScreenToOmit |
|---|
| properties | | screenId | | description | Identifies the screen. See ScreenId enum for possible values. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchAlternative | | description | A screen with a search box, search results, and bottom nav. |
|---|
| id | SearchAlternative |
|---|
| properties | | bottomNavKey | | $ref | ResourceKey |
|---|
| description | Id of the bottom buttons bar. |
|---|
|
|---|
| bottomNavSelection | | $ref | ResourceKey |
|---|
| description | Identifies which bottom button should appear selected. If omitted or if there is no button with this key, the first button with a target is selected. |
|---|
|
|---|
| initialSearchScreenComponentsKey | | $ref | ResourceKey |
|---|
| description | Id of the initial search screen components. |
|---|
|
|---|
| searchBox | | $ref | SearchBox |
|---|
| description | Search box data. |
|---|
|
|---|
| searchCorpusKey | | $ref | ResourceKey |
|---|
| description | Id of the search corpus. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchBlock | | description | An in-page search bar. Next id: 0 |
|---|
| id | SearchBlock |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| SearchBox | | description | Search box data. Next id: 2 |
|---|
| id | SearchBox |
|---|
| properties | | placeholderText | | description | Placeholder text if there is no query yet. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchCorpus | | description | Data for all searchable items. Next id: 5 |
|---|
| id | SearchCorpus |
|---|
| properties | | allowedPrecheckedResources | | description | List of allowed (searchable) Screen ResourceKeys. By default this is a list of SearchItem targets (though it can contain different list of ResourceKeys) |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| helpCenterSearchItem | | $ref | HelpCenterSearchItem |
|---|
| description | Special search item shown below all results that links to a help center article for the entered query. |
|---|
|
|---|
| noResultsImage | | $ref | Image |
|---|
| description | Image to show if there are no results for the entered query. |
|---|
|
|---|
| searchItems | | description | List of available items for search. The items are sorted by title. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchItem | | description | A searchable item. Next id: 8 |
|---|
| id | SearchItem |
|---|
| properties | | description | | description | Item description. |
|---|
| type | string |
|---|
|
|---|
| icon | | $ref | Image |
|---|
| description | Icon shown on the right of the item, e.g. chevron icon. |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | Image displayed on the left of the item. |
|---|
|
|---|
| keywords | | description | List of keywords that can be used for matching, beside title and description. Each keyword can be a single word or a phrase. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the tap event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of tap destination resource. DEPRECATED: Use link instead. |
|---|
|
|---|
| title | | description | Item title. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchItemSection | | description | Message to represent a section of search items. Next id: 4 |
|---|
| id | SearchItemSection |
|---|
| properties | | fallbackSearchItem | | $ref | SearchItem |
|---|
| description | Fallback item shown at the bottom of the section. This item is rendered different from the other items, and for some section this item will not be present (like Google Account results section). |
|---|
|
|---|
| searchItems | | description | List of items shown when no search terms are entered. The items are sorted by title. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| title | | description | Title of the section. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchOneboxMetadata | | description | Metadata containing information about Search Onebox resources associated with the VE. |
|---|
| id | SearchOneboxMetadata |
|---|
| properties | | searchOneboxVariant | | enum | - SEARCH_ONEBOX_VARIANT_TYPE_UNSPECIFIED
- PARENTAL_CONTROLS_SUPERVISOR_NO_KIDS
- PARENTAL_CONTROLS_SUPERVISOR
- PARENTAL_CONTROLS_MEMBER
|
|---|
| enumDescriptions | - A viewer of the Parental Controls Onebox who has supervising capabilities but no child accounts set up in their family group.
- A viewer of the Parental Controls Onebox who has supervising capabilities and child(ren) account(s) set up in their family group.
- A viewer of the Parental Controls Onebox who is a member of a family group with child(ren) account(s) set up.
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchQuery | | description | User defined query. |
|---|
| id | SearchQuery |
|---|
| properties | | query | | description | Raw user defined query. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchRequest | | description | Request message for Search |
|---|
| id | SearchRequest |
|---|
| properties | | allowedPrecheckedResources | | description | List of allowed (searchable) Screen ResourceKeys. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| context | | $ref | RequestContext |
|---|
| description | Information sent with every request. |
|---|
|
|---|
| resourcesToOmit | | description | Specify the screen resources to omit from the response. The server uses this field for optimization by not including omitted resources in additional_resources. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| searchQuery | | $ref | SearchQuery |
|---|
| description | User defined query. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchResponse | | description | Response message for Search. |
|---|
| id | SearchResponse |
|---|
| properties | | additionalResources | | description | Additional resources that the client should cache. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| helpCenterSearchItem | | $ref | HelpCenterSearchItem |
|---|
| deprecated | True |
|---|
| description | Special search item shown below all results that links to a help center search result page for the entered query. |
|---|
|
|---|
| searchItemSections | | description | Search item sections for Help Center results. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| searchItems | | deprecated | True |
|---|
| description | Search items. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchResultCard | | description | Card presenting the result to query on Google Search. Next id: 8 |
|---|
| id | SearchResultCard |
|---|
| properties | | answerBlock | | $ref | OneBoxBlock |
|---|
| description | An answer block |
|---|
|
|---|
| contentBlocks | | description | The content blocks following the general answer. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| header | | $ref | Header |
|---|
| description | The header shown in the SearchResult card. |
|---|
|
|---|
| showInMainColumnOnDesktop | | description | Whether the Onebox should be also shown on the Main Column on Desktop. Note that this will force Tetris ranking on Desktop as well, so it may impact positioning of the Onebox to lower ranks. |
|---|
| type | boolean |
|---|
|
|---|
| visualElementConfig | | $ref | GoogleAccountVisualElementConfig |
|---|
| description | Visual element configuration for the Onebox. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Section | | description | A menu section groups up one or more menu items into a single logical unit. For instance, the Privacy menu has a Personal Info section which groups together several related items (such as the user's email, phone, birthday, or location sharing settings). Many sections contain a single item. Next Id: 4 |
|---|
| id | Section |
|---|
| properties | | items | | description | The menu items in this section. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| sectionId | | description | The section's ID, unique within the scope of its menu. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| titleText | | description | Optional section title. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SecurityHubButton | | description | Button to be shown in a warning card. |
|---|
| id | SecurityHubButton |
|---|
| properties | | label | | description | The text label for the button. |
|---|
| type | string |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of tap destination resource. DEPRECATED: Use link instead. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SecurityHubPromptCarouselCard | | description | A horizontally scrolling carousel of prompt items for the SecurityHub. |
|---|
| id | SecurityHubPromptCarouselCard |
|---|
| properties | | promptItemKeys | | description | The order of the prompt items is the order they should appear in the UI. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SecurityHubPromptItem | | description | Prompt items on the Security Hub for the user to be taken care of in a timely manner. |
|---|
| id | SecurityHubPromptItem |
|---|
| properties | | adviceTypes | | description | The types of Security Advisor advices that contributed to the overall severity. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| body | | description | The body shown in the warning card. |
|---|
| type | string |
|---|
|
|---|
| primaryButton | | $ref | SecurityHubButton |
|---|
| description | The primary button to be shown in the warning card. It will be used to perform an inline action or to navigate to the warning's Security Source. Required |
|---|
|
|---|
| severity | | description | The severity of the warning. It will contribute to the Overall Status Indicator shown at the top of SecurityHub UI. |
|---|
| enum | - SECURITY_HUB_SEVERITY_UNSPECIFIED
- CRITICAL_WARNING
- RECOMMENDATION
- INFORMATION
|
|---|
| enumDescriptions | - Default SeverityLevel.
- Indicates the presence of a critical or urgent security issue that should be addressed by the user. This severity will be reflected in the UI through a red icon.
- Indicates the presence of a medium-severity issue which the user is encouraged to act on. This severity will be reflected in the UI through a yellow icon.
- Indicates an informational message. This severity will be reflected in the UI through a green icon.
|
|---|
| type | string |
|---|
|
|---|
| title | | description | The title shown in the warning card. Required |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SegmentHeaderCard | | description | A segment header |
|---|
| id | SegmentHeaderCard |
|---|
| properties | | descriptionText | | description | Localized description text. |
|---|
| type | string |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | The image is displayed to the right of the text for one-column layout |
|---|
|
|---|
| largeImage | | $ref | Image |
|---|
| description | The image is displayed to the right of the text for two-column layout |
|---|
|
|---|
| linkAccessibilityLabel | | deprecated | True |
|---|
| description | Accessibility label for the link, used by screen readers instead of link_text. DEPRECATED: Use link_target_link.aria_label instead. |
|---|
| type | string |
|---|
|
|---|
| linkIcon | | $ref | Image |
|---|
| description | Icon to append after the link text. |
|---|
|
|---|
| linkTargetLink | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click on link. Eventually should completely replace the `link_target` field. |
|---|
|
|---|
| linkText | | description | Localized text of optional link shown at the end of the description (e.g. "learn more"). |
|---|
| type | string |
|---|
|
|---|
| title | | description | Title for the section. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SetResourceDismissalStateRequest | | description | Request message for SetResourceDismissalState. |
|---|
| id | SetResourceDismissalStateRequest |
|---|
| properties | | context | | $ref | RequestContext |
|---|
| description | Information sent with every request. |
|---|
|
|---|
| resourceDismissalState | | description | New resource state. |
|---|
| enum | - RESOURCE_DISMISSAL_STATE_UNSPECIFIED
- DISMISSED
- SERVED
|
|---|
| enumDescriptions | - Default value
- Resource was dismissed by the user
- Resource was selected to be displayed to the user, e.g. dismissal was undone
|
|---|
| type | string |
|---|
|
|---|
| resourceKey | | $ref | ResourceKey |
|---|
| description | Resource key which needs to be updated. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SetResourceDismissalStateResponse | | description | Response message for SetResourceDismissalState. |
|---|
| id | SetResourceDismissalStateResponse |
|---|
| properties | | additionalResources | | description | Additional resources that are related to the modified resource the client should cache. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| resource | | $ref | Resource |
|---|
| description | Resource for which dismissal state was modified. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ShortArray | | description | A short array |
|---|
| id | ShortArray |
|---|
| properties | | values | | description | values of short array int16 scale |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SignInBlock | | description | A block containing a CTA to sign in, including optional illustration and description. Next id: 10 |
|---|
| id | SignInBlock |
|---|
| properties | | additionalParagraphs | | description | The additional paragraphs shown below the CTA button. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| buttonTarget | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Optional target for the CTA button. DEPRECATED: Use link instead. |
|---|
|
|---|
| description | | description | Description of the sign in block. Shown above the CTA button. |
|---|
| type | string |
|---|
|
|---|
| descriptionParagraphs | | description | The additional paragraphs describing the page shown above the CTA button. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | Optional image to be displayed in the sign in block on small screens. |
|---|
|
|---|
| largeImage | | $ref | Image |
|---|
| description | Optional image to be displayed in the sign in block on large screens instead of the small image. |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `button_target` field. |
|---|
|
|---|
| signInCtaText | | description | Text on the sign in CTA button. |
|---|
| type | string |
|---|
|
|---|
| title | | description | The title of the sign in block. Shown under the image. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SignedOutBlockLink | | description | Message for a link in the SignedOutButtonsBlock. |
|---|
| id | SignedOutBlockLink |
|---|
| properties | | link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Link target for the CTA. Required. DEPRECATED: Use link instead. |
|---|
|
|---|
| text | | description | Text on the link CTA. Required. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SimpleHeader | | description | My Google simple header with action items. |
|---|
| id | SimpleHeader |
|---|
| properties | | actionItems | | description | Action items to show on the top of the header area. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| title | | description | The title text to be displayed. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SimpleItem | | description | A simple menu item, with title and subtitle. Next Id: 4 |
|---|
| id | SimpleItem |
|---|
| properties | | screenId | | description | The screen ID that should be requested when this menu item is tapped. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| subtitleText | | description | Optional additional text, displayed in a smaller size and/or lighter color. Subtitles may contain explanatory text, or the current value of a setting. |
|---|
| type | string |
|---|
|
|---|
| titleText | | description | The main item text. Can be the name of a setting or group of settings. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SpecialDescription | | description | A special description block containing an icon, and text of a custom color. |
|---|
| id | SpecialDescription |
|---|
| properties | | color | | $ref | Color |
|---|
| deprecated | True |
|---|
| description | Description color. Deprecated. Use themed_color instead. |
|---|
|
|---|
| icon | | $ref | Image |
|---|
| description | Description icon. |
|---|
|
|---|
| stateChipUnit | | $ref | StateChipUnit |
|---|
| description | The field to be used when SpecialDescription is converted to StateChipUnit. This is a temporary solution in use to convert SummaryCard to CollectionCard. This field should not be used by new cards. New cards should directly use CollectionCard. |
|---|
|
|---|
| text | | description | Description text. |
|---|
| type | string |
|---|
|
|---|
| themedColor | | $ref | ThemedColor |
|---|
| description | Description color. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Stack | | description | A stack of zero or more StackItems & StackFooters. screen/7i7pzGTANcvyDn8 |
|---|
| id | Stack |
|---|
| properties | | footers | | description | Zero or more StackFooter at the bottom of the stack. screen/5psKAHrTqdCMTts |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| infoOnly | | description | Indicates whether the stack is info only. An info only stack is not tappable, the items do not have a link and is rendered differently. |
|---|
| type | boolean |
|---|
|
|---|
| items | | description | Zero or more StackItem at the top of the stack. screen/oRyFdxeMdxCWDWs. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| StackFooter | | description | Footer of the stack - screen/5psKAHrTqdCMTts |
|---|
| id | StackFooter |
|---|
| properties | | contentUnits | | description | Content units of the footer. |
|---|
| items | | $ref | StackFooterContentUnit |
|---|
|
|---|
| type | array |
|---|
|
|---|
| description | | description | Description of the footer. |
|---|
| type | string |
|---|
|
|---|
| hyperlink | | $ref | Link |
|---|
| description | Link of the hyperlink_text. |
|---|
|
|---|
| hyperlinkText | | description | Hyperlink text/label of the footer displayed after the description. |
|---|
| type | string |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | Image placed on the left side of the footer. |
|---|
|
|---|
| trailingUnits | | description | Trailing units of the footer. |
|---|
| items | | $ref | StackFooterTrailingUnit |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| StackFooterContentUnit | | description | Content unit of the footer |
|---|
| id | StackFooterContentUnit |
|---|
| properties | | actionChipsUnit | | $ref | ActionChipsUnit |
|---|
| description | screen/82c8fpyatXbybbe |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| StackFooterTrailingUnit | | description | Trailing unit of the footer |
|---|
| id | StackFooterTrailingUnit |
|---|
| properties | | imageUnit | | $ref | ImageUnit |
|---|
| description | screen/6Bi4EhgcFY2drWP |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| StackItem | | description | Stack item - screen/3RAFcZbV7vh3U6c. |
|---|
| id | StackItem |
|---|
| properties | | contentUnits | | description | Content units of the item. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| description | | description | Description of the item. |
|---|
| type | string |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | Image placed on the left side of the item. |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link of the item. |
|---|
|
|---|
| title | | description | Title of the item. |
|---|
| type | string |
|---|
|
|---|
| trailingUnits | | description | Trailing units of the item. |
|---|
| items | | $ref | StackItemTrailingUnit |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| StackItemContentUnit | | description | Content unit of the stack item screen/5GZv5iNqquGsPSU |
|---|
| id | StackItemContentUnit |
|---|
| properties | | attributesUnit | | $ref | AttributesUnit |
|---|
| description | screen/8vM3aFoKwwLD7FN |
|---|
|
|---|
| listPreviewUnit | | $ref | ListPreviewUnit |
|---|
| description | screen/BDheWvg6VHnWYmA |
|---|
|
|---|
| progressBarUnit | | $ref | ProgressBarUnit |
|---|
| description | screen/9LsrL7URSifxp3G |
|---|
|
|---|
| stateChipUnit | | $ref | StateChipUnit |
|---|
| description | screen/7pKYihngrugyLqg |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| StackItemTrailingUnit | | description | Trailing unit of the stack item screen/6skuPGfowwQkurH |
|---|
| id | StackItemTrailingUnit |
|---|
| properties | | expansionUnit | | $ref | ExpansionUnit |
|---|
| description | screen/9fYD3c8gNSJH6Aj |
|---|
|
|---|
| imageUnit | | $ref | ImageUnit |
|---|
| description | screen/A333or6Vw6tZcxf |
|---|
|
|---|
| profilePictureUnit | | $ref | ProfilePictureUnit |
|---|
| description | screen/8UcDB3nx9wRtoPg |
|---|
|
|---|
| stateChipUnit | | $ref | StateChipUnit |
|---|
| description | screen/7EBeXzYEArApyVZ |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| StateChipUnit | | description | screen/7pKYihngrugyLqg & screen/7EBeXzYEArApyVZ |
|---|
| id | StateChipUnit |
|---|
| properties | | backgroundColor | | $ref | ThemedColor |
|---|
| description | Color to tint the background and serve as container for Icon and Label. TODO(b/397607598) |
|---|
|
|---|
| icon | | $ref | Image |
|---|
| description | Icon of the chip |
|---|
|
|---|
| label | | description | Label of the chip |
|---|
| type | string |
|---|
|
|---|
| labelColor | | $ref | ThemedColor |
|---|
| description | Color to tint label |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| StringArray | | description | A string array |
|---|
| id | StringArray |
|---|
| properties | | values | | description | values of string array |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| StyledTextEntry | | description | Styled text entry. Supports colored text, drawing one icon to the left and different styles, defined by client. |
|---|
| id | StyledTextEntry |
|---|
| properties | | color | | $ref | Color |
|---|
| deprecated | True |
|---|
| description | Color of the text. Deprecated. Use themed_color instead. |
|---|
|
|---|
| icon | | $ref | Image |
|---|
| description | Icon, shown to the left of the text. Center-aligned vertically. |
|---|
|
|---|
| style | | description | Style used for the text, e.g. TITLE or DESCRIPTION |
|---|
| enum | - TEXT_STYLE_UNSPECIFIED
- LABEL
- TITLE
- DESCRIPTION
- STATUS
- CAPTION
|
|---|
| enumDescriptions | - Unspecified text style.
- Style for labels.
- Style for titles.
- Style for description texts.
- Style for statuses.
- Style for captions.
|
|---|
| type | string |
|---|
|
|---|
| text | | description | Text. |
|---|
| type | string |
|---|
|
|---|
| themedColor | | $ref | ThemedColor |
|---|
| description | Color of the text. |
|---|
|
|---|
| truncation | | $ref | TextTruncation |
|---|
| description | Truncation logic used for the text. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SummaryCard | | description | Card presenting one or more settings. Next id: 10 |
|---|
| id | SummaryCard |
|---|
| properties | | blocks | | description | At least one block must be present. Clients will ignore blocks that they don't understand. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| borderless | | description | Whether to disable drawing border for the card |
|---|
| type | boolean |
|---|
|
|---|
| disableHorizontalPadding | | description | Warning: this is not implemented on native is likely temporary. |
|---|
| type | boolean |
|---|
|
|---|
| infoOnly | | description | Indicates whether the collection card stacks generated from this summary card are going to be info only. An info only card is not tappable, does not have a link and is rendered differently as a CollectionCard. This is a temporary solution in use to convert SummaryCard to CollectionCard. This field should not be used by new cards. New cards should directly use CollectionCard. |
|---|
| type | boolean |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| preferredSize | | description | The preferred size of the card. See CardPreferredSize enum. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of tap destination resource. DEPRECATED: Use link instead. |
|---|
|
|---|
| visualElementConfig | | $ref | GoogleAccountVisualElementConfig |
|---|
| description | Visual element configuration for the summary card. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SupportAlternative | | description | Support related alternative, like support panel and support screen. |
|---|
| id | SupportAlternative |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| SupportPanel | | description | A panel with cards and intro. Next Id: 4 |
|---|
| id | SupportPanel |
|---|
| properties | | deckKey | | $ref | ResourceKey |
|---|
| description | Id of the deck of cards displayed in support panel. |
|---|
|
|---|
| screenIntro | | $ref | ScreenIntro |
|---|
| description | Intro displayed just before the cards. |
|---|
|
|---|
| visualElementConfig | | $ref | GoogleAccountVisualElementConfig |
|---|
| description | Visual element configuration for the support panel. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SupportedAlternativeType | | description | A supported alternative. |
|---|
| id | SupportedAlternativeType |
|---|
| properties | | alternativeType | | description | The alternative type. See AlternativeType for possible values. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SupportedAndroidIntentCheck | | description | Android intent checks supported by the client |
|---|
| id | SupportedAndroidIntentCheck |
|---|
| properties | | androidIntentCheck | | description | List of Android intent checks |
|---|
| enum | - CHECK_UNSPECIFIED
- FIRST_PARTY_CHECK
- SYSTEM_CHECK
- THIRD_PARTY_CHECK
|
|---|
| enumDescriptions | - This is treated same as the first party check.
- * Performs following checks: - class name or action is present - package name is present - package is Google signed
- * Performs following checks: - intent resolves - package name of resolved intent is in the system partition
- * Performs following checks: - class name is present TODO(b/119490916) Verify that we can allow intent actions as well.
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SupportedIcon | | description | A supported icon. |
|---|
| id | SupportedIcon |
|---|
| properties | | iconId | | description | The icon ID. See IconId for possible values. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SupportedItemType | | description | A supported item type. |
|---|
| id | SupportedItemType |
|---|
| properties | | itemType | | description | The item type. See ItemType for possible values. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SupportedNativeAction | | description | A supported native action. |
|---|
| id | SupportedNativeAction |
|---|
| properties | | nativeActionId | | description | The native action's ID. See NativeActionId for possible values. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SupportedOfflineScreen | | description | A supported offline screen. |
|---|
| id | SupportedOfflineScreen |
|---|
| properties | | screenId | | description | Required |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| version | | description | Optional. If omitted, version 1 is assumed. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Target | | description | Item link target. Next id: 5 |
|---|
| id | Target |
|---|
| properties | | queryPlaceholder | | description | The placeholder text in url_with_query_placeholder which should be replaced by the search query. |
|---|
| type | string |
|---|
|
|---|
| resourceId | | description | Target resource_id. Used for logging. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| themedUrlWithQueryPlaceholder | | $ref | ThemedUrl |
|---|
| description | Destination help center URLs for both light and dark themes. Contain a placeholder string which should be replaced by the URL-encoded search query. |
|---|
|
|---|
| urlWithQueryPlaceholder | | description | Destination help center URL. Contains a placeholder string which should be replaced by the URL-encoded search query. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Text | | description | This message represents the a text that consists of multiple items. Items can be either plain text or links. |
|---|
| id | Text |
|---|
| properties | | textItems | | description | List or text items. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| TextItem | | description | This message represents one text item in the entire text. It should be rendered like this: $text if target is present, otherwise — as text. |
|---|
| id | TextItem |
|---|
| properties | | link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | The id of the target resource. DEPRECATED: Use link instead. |
|---|
|
|---|
| text | | description | Text to display. required |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| TextTruncation | | description | Text truncation. |
|---|
| id | TextTruncation |
|---|
| properties | | numberOfLines | | description | Number of lines after which truncation happens. 0 means no truncation. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ThemedColor | | description | Wrapper around Colors for specific themes / user interface styles. Next id: 3 |
|---|
| id | ThemedColor |
|---|
| properties | | dark | | $ref | Color |
|---|
| description | The color for dark theme. Required. |
|---|
|
|---|
| light | | $ref | Color |
|---|
| description | The color for light theme. Required. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ThemedUrl | | description | Wrapper around URLs for specific themes / user interface styles. Next id: 3 |
|---|
| id | ThemedUrl |
|---|
| properties | | dark | | description | The URL for a dark theme / user interface style. |
|---|
| type | string |
|---|
|
|---|
| light | | description | The URL for a light theme / user interface style. If a URL for a specific theme is missing, the light URL will be used in its place. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Title | | description | Item title. Next id: 3 |
|---|
| id | Title |
|---|
| properties | | queryPlaceholder | | description | The placeholder text in title_with_placeholder which should be replaced by the search query. |
|---|
| type | string |
|---|
|
|---|
| textWithQueryPlaceholder | | description | Item title. Contains a placeholder string which should be replaced by the search query. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| TopNav | | description | Top navigation bar with tabs. |
|---|
| id | TopNav |
|---|
| properties | | tabs | | description | List of tabs. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| TopTab | | description | One of the TopNav tabs. |
|---|
| id | TopTab |
|---|
| properties | | icon | | $ref | Image |
|---|
| description | Icon (default version) to be displayed next to the tab title in the dropdown version of the menu. |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link to the screen that should be displayed when the tab becomes active. Only supports the link target and no other link parameters. |
|---|
|
|---|
| selectedIcon | | $ref | Image |
|---|
| description | Icon (hovered/selected version) to be displayed next to the tab title in the dropdown version of the menu. |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Target screen of the tab. DEPRECATED: Use link instead. |
|---|
|
|---|
| title | | description | Tab title. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| TwoColumnTableBlock | | description | A block to show a list of image - description pairs in tabular form where images and descriptions are aligned in separate columns. |
|---|
| id | TwoColumnTableBlock |
|---|
| properties | | rows | | description | List of rows to populate the TwoColumnTableBlock. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| TwoColumnTableRow | | description | Data row to populate the TwoColumnTableBlock. |
|---|
| id | TwoColumnTableRow |
|---|
| properties | | descriptions | | description | List of descriptions, each of which is printed on a new line. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| image | | $ref | Image |
|---|
| description | Optional image for the table row. |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field. |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of tap destination resource. DEPRECATED: Use link instead. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| WebviewAlternative | | description | Displays a screen by opening an URL in a WebView. Next Id: 3 |
|---|
| id | WebviewAlternative |
|---|
| properties | | themedUrl | | $ref | ThemedUrl |
|---|
| description | The set of theme-dependent URLs to open. One of url or themed_url required. |
|---|
|
|---|
| url | | description | The URL to open. One of url or themed_url required. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| WebviewCapabilities | | description | The capabilities of the webview client. Field names should be without a "supports" prefix. It is implicit in the message, since it's about which features the client supports. Next Id: 7 |
|---|
| id | WebviewCapabilities |
|---|
| properties | | obakeWeb | | description | Whether the client supports all changes necessary to work with Obake web. |
|---|
| type | boolean |
|---|
|
|---|
| passkey | | description | Whether the client supports passkey-based auth in Octarine. iOS only. |
|---|
| type | boolean |
|---|
|
|---|
| securityKey | | description | Whether the client supports security key authentication. |
|---|
| type | boolean |
|---|
|
|---|
| telephony | | description | Whether the client supports the telephony JS bridge. |
|---|
| type | boolean |
|---|
|
|---|
| termsAndPolicyPages | | description | Whether the client supports opening the PP and ToS pages in Octarine. |
|---|
| type | boolean |
|---|
|
|---|
| trustAgent | | description | Whether the client supports the trust agent JS bridge. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| WelcomeHeader | | description | My Google header with user name and avatar. |
|---|
| id | WelcomeHeader |
|---|
| properties | | actionItems | | description | Action items to show on the top of the header area. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| avatarAccessibilityTapText | | description | Tap action text read by a screen reader after the phrase "double-tap to .." when focus moves to the avatar. |
|---|
| type | string |
|---|
|
|---|
| chip | | $ref | ActionChip |
|---|
| deprecated | True |
|---|
| description | Used for displaying link to launch Google Account from contextual landing page. DEPRECATED: chip is no longer supported in the welcome header. |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the tap on the avatar. Eventually should completely replace the `target` field. |
|---|
|
|---|
| name | | description | User's name as displayed in the header. |
|---|
| type | string |
|---|
|
|---|
| showProductLockup | | description | Controls showing the product view in the header area. |
|---|
| type | boolean |
|---|
|
|---|
| target | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Id of tap destination resource of the avatar. DEPRECATED: Use link instead. |
|---|
|
|---|
| title | | description | Title text to show in the header area. |
|---|
| type | string |
|---|
|
|---|
| welcomeText | | description | Header welcome text (e.g. 'Welcome, Janelle'). |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| WelcomeScreenIntro | | description | My Google header with user name, profile picture, and welcome message. Next id: 17 |
|---|
| id | WelcomeScreenIntro |
|---|
| properties | | additionalDescription | | $ref | AdditionalDescription |
|---|
| description | The additional description for some account types. |
|---|
|
|---|
| description | | description | The welcome message to the user (e.g. 'You're in control...'). |
|---|
| type | string |
|---|
|
|---|
| displayName | | description | The user's name to display. Currently only in use for Android, taking precedence over the `title` field. |
|---|
| type | string |
|---|
|
|---|
| isGoogleOneMember | | description | Whether the user is a Google One member. |
|---|
| type | boolean |
|---|
|
|---|
| link | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click on the link. Eventually should completely replace the `target` field. |
|---|
|
|---|
| linkAccessibilityLabel | | deprecated | True |
|---|
| description | Accessibility label for the link that appears after the description, used by screen readers instead of link_text. DEPRECATED: Use link.aria_label instead. |
|---|
| type | string |
|---|
|
|---|
| linkIcon | | $ref | Image |
|---|
| description | Icon to append after the link text. |
|---|
|
|---|
| linkTarget | | $ref | ResourceKey |
|---|
| deprecated | True |
|---|
| description | Target resource for the link. DEPRECATED: Use link instead. |
|---|
|
|---|
| linkText | | description | Text for the link that appears after the 'description'. |
|---|
| type | string |
|---|
|
|---|
| primaryEmail | | description | The user's email id to display to the user. |
|---|
| type | string |
|---|
|
|---|
| profilePictureAccessibilityLabel | | description | Tap action text read by a screen reader after the phrase "double-tap to .." when focus moves to the profile picture. |
|---|
| type | string |
|---|
|
|---|
| profilePictureImage | | $ref | Image |
|---|
| description | Profile picture image. |
|---|
|
|---|
| profilePictureLink | | $ref | Link |
|---|
| description | Link which consists of the target ResourceKey and additional params to follow on the click on the profile picture. Eventually should completely replace the `target` field.ure link. |
|---|
|
|---|
| profilePictureTarget | | $ref | ResourceKey |
|---|
| description | Profile picture target. |
|---|
|
|---|
| title | | description | Header welcome title (e.g. 'Welcome, Janelle'). |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|