| sandbox/alpha-chromesyncentities-pa- | | dictionary_item_added | - root['schemas']['SyncPbSharedTabGroupAccountDataSpecifics']['properties']['version']
- root['schemas']['SyncPbSharedTabGroupDataSpecifics']['properties']['version']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/alpha-chromesyncentities-pa-v1 | | dictionary_item_added | - root['schemas']['SyncPbSharedTabGroupAccountDataSpecifics']['properties']['version']
- root['schemas']['SyncPbSharedTabGroupDataSpecifics']['properties']['version']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/alpha-chromesyncpasswords-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/alpha-chromesyncpasswords-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/alpha-scone-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['CustomerSupportContentFrdVrgSetContainer']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['CustomerSupportContentScFrdValues']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
|
|---|
|
|---|
| sandbox/alpha-scone-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['CustomerSupportContentFrdVrgSetContainer']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['CustomerSupportContentScFrdValues']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
|
|---|
|
|---|
| sandbox/autopush-accountsettingsmobile-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-accountsettingsmobile-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-afwprovisioning-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-afwprovisioning-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-auditrecording-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-auditrecording-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-cryptauthvault- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-cryptauthvault-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-discoverlabs-pa- | | values_changed | | root['baseUrl'] | | new_value | https://autopush-discoverlabs.corp.googleapis.com/ |
|---|
| old_value | https://staging-discoverlabs-pa.sandbox.googleapis.com/ |
|---|
|
|---|
| root['canonicalName'] | | new_value | Discoverlabs |
|---|
| old_value | Discover Labs |
|---|
|
|---|
| root['description'] | | new_value | |
|---|
| old_value | discoverlabs-pa.googleapis.com API. |
|---|
|
|---|
| root['documentationLink'] | | new_value | http://boq/java/com/google/search/now/labs/server |
|---|
| old_value | http://go/discover-labs-docs |
|---|
|
|---|
| root['id'] | | new_value | corp_autopush_discoverlabs:v1alpha |
|---|
| old_value | discoverlabs_pa:v1 |
|---|
|
|---|
| root['mtlsRootUrl'] | | new_value | https://autopush-discoverlabs.corp.mtls.googleapis.com/ |
|---|
| old_value | https://staging-discoverlabs-pa.mtls.sandbox.googleapis.com/ |
|---|
|
|---|
| root['name'] | | new_value | corp_autopush_discoverlabs |
|---|
| old_value | discoverlabs_pa |
|---|
|
|---|
| root['resources'] | | new_value | | project | | methods | | saveUserProjectParameter | | description | Updates a user's project parameter selections. |
|---|
| flatPath | v1alpha/project/{projectId}:saveUserProjectParameter |
|---|
| httpMethod | POST |
|---|
| id | corp_autopush_discoverlabs.project.saveUserProjectParameter |
|---|
| parameterOrder | |
|---|
| parameters | | name | | description | Required. The unique name of the Labs project to add as favorite. |
|---|
| location | path |
|---|
| pattern | ^[^/]+$ |
|---|
| required | True |
|---|
| type | string |
|---|
|
|---|
|
|---|
| path | v1alpha/project/{+name}:saveUserProjectParameter |
|---|
| request | | $ref | GoogleCorpDiscoverlabsV1alphaSaveUserProjectParameterRequest |
|---|
|
|---|
| response | | $ref | GoogleCorpDiscoverlabsV1alphaSaveUserProjectParameterResponse |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| projectOverrides | | methods | | delete | | description | Deletes the locally built override for the project with the given unique name for the authenticated user. If there is no override stored for the given user and project, a 200 OK response is still returned. |
|---|
| flatPath | v1alpha/projectOverrides/{projectOverridesId} |
|---|
| httpMethod | DELETE |
|---|
| id | corp_autopush_discoverlabs.projectOverrides.delete |
|---|
| parameterOrder | |
|---|
| parameters | | name | | description | Required. The unique name of the Labs project to delete the override for. |
|---|
| location | path |
|---|
| pattern | ^[^/]+$ |
|---|
| required | True |
|---|
| type | string |
|---|
|
|---|
|
|---|
| path | v1alpha/projectOverrides/{+name} |
|---|
| response | | $ref | GoogleCorpDiscoverlabsV1alphaDeleteProjectOverrideResponse |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| projects | | methods | | addFavorite | | description | Sets the favorited bit true on the project with the given unique name for the authenticated user. If the project is already favorited, a 200 OK response is still returned. |
|---|
| flatPath | v1alpha/projects/{projectsId}:addFavorite |
|---|
| httpMethod | POST |
|---|
| id | corp_autopush_discoverlabs.projects.addFavorite |
|---|
| parameterOrder | |
|---|
| parameters | | name | | description | Required. The unique name of the Labs project to add as favorite. |
|---|
| location | path |
|---|
| pattern | ^[^/]+$ |
|---|
| required | True |
|---|
| type | string |
|---|
|
|---|
|
|---|
| path | v1alpha/projects/{+name}:addFavorite |
|---|
| request | | $ref | GoogleCorpDiscoverlabsV1alphaAddFavoriteProjectRequest |
|---|
|
|---|
| response | | $ref | GoogleCorpDiscoverlabsV1alphaAddFavoriteProjectResponse |
|---|
|
|---|
|
|---|
| deleteUserData | | description | Deletes all UserDataTable entries for the given project for the authenticated user. |
|---|
| flatPath | v1alpha/projects/{projectsId}/UserData |
|---|
| httpMethod | DELETE |
|---|
| id | corp_autopush_discoverlabs.projects.deleteUserData |
|---|
| parameterOrder | |
|---|
| parameters | | name | | description | Required. The unique name of the Labs project to delete user data for. |
|---|
| location | path |
|---|
| pattern | ^[^/]+$ |
|---|
| required | True |
|---|
| type | string |
|---|
|
|---|
|
|---|
| path | v1alpha/projects/{+name}/UserData |
|---|
| response | |
|---|
|
|---|
| deselect | | description | Deselects the project with the given unique name for the authenticated user. If the project is already unselected, a 200 OK response is still returned. |
|---|
| flatPath | v1alpha/projects/{projectsId}:deselect |
|---|
| httpMethod | POST |
|---|
| id | corp_autopush_discoverlabs.projects.deselect |
|---|
| parameterOrder | |
|---|
| parameters | | name | | description | Required. The unique name of the Labs project to deselect. |
|---|
| location | path |
|---|
| pattern | ^[^/]+$ |
|---|
| required | True |
|---|
| type | string |
|---|
|
|---|
|
|---|
| path | v1alpha/projects/{+name}:deselect |
|---|
| request | | $ref | GoogleCorpDiscoverlabsV1alphaDeselectProjectRequest |
|---|
|
|---|
| response | | $ref | GoogleCorpDiscoverlabsV1alphaDeselectProjectResponse |
|---|
|
|---|
|
|---|
| list | | description | Returns the list of projects that are currently available. |
|---|
| flatPath | v1alpha/projects |
|---|
| httpMethod | GET |
|---|
| id | corp_autopush_discoverlabs.projects.list |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1alpha/projects |
|---|
| response | | $ref | GoogleCorpDiscoverlabsV1alphaListProjectsResponse |
|---|
|
|---|
|
|---|
| preview | | description | Returns a screenshot of the feed generated by a emulator as the preview of a project. |
|---|
| flatPath | v1alpha/projects/{projectsId}:preview |
|---|
| httpMethod | GET |
|---|
| id | corp_autopush_discoverlabs.projects.preview |
|---|
| parameterOrder | |
|---|
| parameters | | name | | description | Required. The unique name of the Labs project to preview. Keeping it empty will apply Labs organic project selection. |
|---|
| location | path |
|---|
| pattern | ^[^/]+$ |
|---|
| required | True |
|---|
| type | string |
|---|
|
|---|
| runDiagnosticOnClientTriggeredLog | | description | Optional. If true run diagnose on the latest Sherlog associated with a feed request triggered by the xga client and handled by GWS/DiscoFeed. |
|---|
| location | query |
|---|
| type | boolean |
|---|
|
|---|
| runProjectSherlogDiagnostic | | description | Optional. Whether to read project configured Sherlog debugging or not. |
|---|
| location | query |
|---|
| type | boolean |
|---|
|
|---|
| runSherlogDiagnostic | | description | Optional. Whether to read and analyze the sherlog associated with the preview for diagnosing Labs problems. |
|---|
| location | query |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| path | v1alpha/projects/{+name}:preview |
|---|
| response | | $ref | GoogleCorpDiscoverlabsV1alphaPreviewProjectResponse |
|---|
|
|---|
|
|---|
| removeFavorite | | description | Sets the favorited bit false on the project with the given unique name for the authenticated user. If the project is already favorited, a 200 OK response is still returned. |
|---|
| flatPath | v1alpha/projects/{projectsId}:removeFavorite |
|---|
| httpMethod | POST |
|---|
| id | corp_autopush_discoverlabs.projects.removeFavorite |
|---|
| parameterOrder | |
|---|
| parameters | | name | | description | Required. The unique name of the Labs project to remove as favorite. |
|---|
| location | path |
|---|
| pattern | ^[^/]+$ |
|---|
| required | True |
|---|
| type | string |
|---|
|
|---|
|
|---|
| path | v1alpha/projects/{+name}:removeFavorite |
|---|
| request | | $ref | GoogleCorpDiscoverlabsV1alphaRemoveFavoriteProjectRequest |
|---|
|
|---|
| response | | $ref | GoogleCorpDiscoverlabsV1alphaRemoveFavoriteProjectResponse |
|---|
|
|---|
|
|---|
| select | | description | Selects the project with the given unique name for the authenticated user. If the project is already selected, a 200 OK response is still returned. |
|---|
| flatPath | v1alpha/projects/{projectsId}:select |
|---|
| httpMethod | POST |
|---|
| id | corp_autopush_discoverlabs.projects.select |
|---|
| parameterOrder | |
|---|
| parameters | | name | | description | Required. The unique name of the Labs project to select. |
|---|
| location | path |
|---|
| pattern | ^[^/]+$ |
|---|
| required | True |
|---|
| type | string |
|---|
|
|---|
|
|---|
| path | v1alpha/projects/{+name}:select |
|---|
| request | | $ref | GoogleCorpDiscoverlabsV1alphaSelectProjectRequest |
|---|
|
|---|
| response | | $ref | GoogleCorpDiscoverlabsV1alphaSelectProjectResponse |
|---|
|
|---|
|
|---|
|
|---|
| resources | | UserData | | methods | | list | | description | Lists all UserDataTable entries for the given project for the authenticated user. |
|---|
| flatPath | v1alpha/projects/{projectsId}/UserData |
|---|
| httpMethod | GET |
|---|
| id | corp_autopush_discoverlabs.projects.UserData.list |
|---|
| parameterOrder | |
|---|
| parameters | | name | | description | Required. The unique name of the Labs project to list user data for. |
|---|
| location | path |
|---|
| pattern | ^[^/]+$ |
|---|
| required | True |
|---|
| type | string |
|---|
|
|---|
|
|---|
| path | v1alpha/projects/{+name}/UserData |
|---|
| response | | $ref | GoogleCorpDiscoverlabsV1alphaListProjectUserDataResponse |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| studies | | methods | | assignParticipants | | description | Assigns study participants and updates UserStudy table. |
|---|
| flatPath | v1alpha/studies/{studiesId}:assignParticipants |
|---|
| httpMethod | POST |
|---|
| id | corp_autopush_discoverlabs.studies.assignParticipants |
|---|
| parameterOrder | |
|---|
| parameters | | name | | description | Required. The unique name of the study to assign participants. |
|---|
| location | path |
|---|
| pattern | ^[^/]+$ |
|---|
| required | True |
|---|
| type | string |
|---|
|
|---|
|
|---|
| path | v1alpha/studies/{+name}:assignParticipants |
|---|
| request | | $ref | GoogleCorpDiscoverlabsV1alphaAssignStudyParticipantsRequest |
|---|
|
|---|
| response | | $ref | GoogleCorpDiscoverlabsV1alphaAssignStudyParticipantsResponse |
|---|
|
|---|
|
|---|
| list | | description | Returns the list of projects that are currently available. |
|---|
| flatPath | v1alpha/studies |
|---|
| httpMethod | GET |
|---|
| id | corp_autopush_discoverlabs.studies.list |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1alpha/studies |
|---|
| response | | $ref | GoogleCorpDiscoverlabsV1alphaListStudiesResponse |
|---|
|
|---|
|
|---|
| listParticipants | | description | List email address of study participants. |
|---|
| flatPath | v1alpha/studies/{studiesId}:listParticipants |
|---|
| httpMethod | GET |
|---|
| id | corp_autopush_discoverlabs.studies.listParticipants |
|---|
| parameterOrder | |
|---|
| parameters | | name | | description | Required. The unique name of the study to list participants. |
|---|
| location | path |
|---|
| pattern | ^[^/]+$ |
|---|
| required | True |
|---|
| type | string |
|---|
|
|---|
|
|---|
| path | v1alpha/studies/{+name}:listParticipants |
|---|
| response | | $ref | GoogleCorpDiscoverlabsV1alphaListStudyParticipantsResponse |
|---|
|
|---|
|
|---|
| listStats | | description | List engagement stats of a study. |
|---|
| flatPath | v1alpha/studies/{studiesId}:listStats |
|---|
| httpMethod | GET |
|---|
| id | corp_autopush_discoverlabs.studies.listStats |
|---|
| parameterOrder | |
|---|
| parameters | | activityTypeWrapper.activityType | | default | ACTIVITY_FEATURE_INTERACTION |
|---|
| enum | - ACTIVITY_UNSPECIFIED
- ACTIVITY_ONBOARD_CARD_SEEN
- ACTIVITY_FEED_SEEN
- ACTIVITY_INTERCEPT_SURVEY_CLICKED
- ACTIVITY_FEATURE_INTERACTION
- ACTIVITY_FEED_QUERY
- ACTIVITY_TOOK_SURVEY
|
|---|
| enumDescriptions | |
|---|
| location | query |
|---|
| type | string |
|---|
|
|---|
| name | | description | Required. The unique name of the study to list stats. |
|---|
| location | path |
|---|
| pattern | ^[^/]+$ |
|---|
| required | True |
|---|
| type | string |
|---|
|
|---|
|
|---|
| path | v1alpha/studies/{+name}:listStats |
|---|
| response | | $ref | GoogleCorpDiscoverlabsV1alphaListStudyStatsResponse |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| v1alpha | | methods | | getSettings | | description | Returns the authenticated user's settings. |
|---|
| flatPath | v1alpha/settings |
|---|
| httpMethod | GET |
|---|
| id | corp_autopush_discoverlabs.getSettings |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1alpha/settings |
|---|
| response | | $ref | GoogleCorpDiscoverlabsV1alphaSettings |
|---|
|
|---|
|
|---|
| updateSettings | | description | Updates the authenticated user's settings with those contained in the request. |
|---|
| flatPath | v1alpha/settings |
|---|
| httpMethod | PATCH |
|---|
| id | corp_autopush_discoverlabs.updateSettings |
|---|
| parameterOrder | |
|---|
| parameters | | updateMask | | description | The list of fields to update. |
|---|
| format | google-fieldmask |
|---|
| location | query |
|---|
| type | string |
|---|
|
|---|
|
|---|
| path | v1alpha/settings |
|---|
| request | | $ref | GoogleCorpDiscoverlabsV1alphaSettings |
|---|
|
|---|
| response | | $ref | GoogleCorpDiscoverlabsV1alphaSettings |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| old_value | | dailydigest | | methods | | get | | description | Directly stream back an audio file for Daily Digest. This is temporary for a demo only. |
|---|
| flatPath | v1/dailydigest/{dailydigestId} |
|---|
| httpMethod | GET |
|---|
| id | discoverlabs_pa.dailydigest.get |
|---|
| parameterOrder | |
|---|
| parameters | | name | | description | Required. In the format dailydigest/ |
|---|
| location | path |
|---|
| pattern | ^dailydigest/[^/]+$ |
|---|
| required | True |
|---|
| type | string |
|---|
|
|---|
|
|---|
| path | v1/{+name} |
|---|
| response | |
|---|
|
|---|
|
|---|
|
|---|
| uiaction | | methods | | add | | description | Add UI Actions in Discover Labs' user store. |
|---|
| flatPath | v1/uiaction:add |
|---|
| httpMethod | POST |
|---|
| id | discoverlabs_pa.uiaction.add |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1/uiaction:add |
|---|
| request | |
|---|
| response | |
|---|
|
|---|
|
|---|
|
|---|
| userprojectparameter | | methods | | save | | description | Update User's project parameter. |
|---|
| flatPath | v1/userprojectparameter:save |
|---|
| httpMethod | POST |
|---|
| id | discoverlabs_pa.userprojectparameter.save |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1/userprojectparameter:save |
|---|
| request | | $ref | SaveUserProjectParameterRequest |
|---|
|
|---|
| response | | $ref | SaveUserProjectParameterResponse |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| v1 | | methods | | getxblendfeature | | description | Returns an XBlendResponse for a feature identified by the `XBlendDiscoverLabsParameters` contained within the given request. |
|---|
| flatPath | v1/getxblendfeature |
|---|
| httpMethod | POST |
|---|
| id | discoverlabs_pa.getxblendfeature |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1/getxblendfeature |
|---|
| request | |
|---|
| response | |
|---|
|
|---|
| handleasyncdata | | description | Handles an xUIKit AsyncDataCommand for a Discover Labs project. |
|---|
| flatPath | v1/handleasyncdata |
|---|
| httpMethod | POST |
|---|
| id | discoverlabs_pa.handleasyncdata |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1/handleasyncdata |
|---|
| request | | $ref | HandleAsyncDataRequest |
|---|
|
|---|
| response | | $ref | HandleAsyncDataResponse |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
| root['rootUrl'] | | new_value | https://autopush-discoverlabs.corp.googleapis.com/ |
|---|
| old_value | https://staging-discoverlabs-pa.sandbox.googleapis.com/ |
|---|
|
|---|
| root['schemas'] | | new_value | | GoogleCorpDiscoverlabsV1alphaAddFavoriteProjectRequest | | description | The request message for the `AddFavoriteProject` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaAddFavoriteProjectRequest |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaAddFavoriteProjectResponse | | description | The response message for the `AddFavoriteProject` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaAddFavoriteProjectResponse |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaAssignStudyParticipantsRequest | | description | The request message for the `AssignStudyParticipants` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaAssignStudyParticipantsRequest |
|---|
| properties | | appendOnly | | description | Whether to append to existing participants in the study without removing existing participants in the manual override mode. Use this option to add participants in small batches in case gaia lookup failed for a larger batch. |
|---|
| type | boolean |
|---|
|
|---|
| manualOverride | | description | Whether to disable auto-assignment and use a list of manually specified parcipant emails for assignment disregarding all auto-assignment requirements specified in the study. |
|---|
| type | boolean |
|---|
|
|---|
| participantEmails | | description | A list of participant emails for manual override. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaAssignStudyParticipantsResponse | | description | The response message for the `AssignStudyParticipants` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaAssignStudyParticipantsResponse |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaDeleteProjectOverrideResponse | | description | The response message for the `DeleteProjectOverride` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaDeleteProjectOverrideResponse |
|---|
| properties | | project | | $ref | GoogleCorpDiscoverlabsV1alphaProject |
|---|
| description | The updated Project configuration after the override was deleted. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaDeselectProjectRequest | | description | The request message for the `DeselectProject` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaDeselectProjectRequest |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaDeselectProjectResponse | | description | The response message for the `DeselectProject` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaDeselectProjectResponse |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaListProjectUserDataResponse | | description | The response message for the `ListProjectUserData` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaListProjectUserDataResponse |
|---|
| properties | | userData | | description | All entries of UserDataTable for the given project. |
|---|
| items | | $ref | SearchNowLabsSpannerConfigUserdataUserData |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaListProjectsResponse | | description | The response message for the `ListProjects` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaListProjectsResponse |
|---|
| properties | | projects | | description | The list of projects that are currently available. |
|---|
| items | | $ref | GoogleCorpDiscoverlabsV1alphaProject |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaListStudiesResponse | | description | The response message for the `ListStudies` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaListStudiesResponse |
|---|
| properties | | studies | | description | The list of studies. |
|---|
| items | | $ref | GoogleCorpDiscoverlabsV1alphaStudy |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaListStudyParticipantsResponse | | description | The response message for the `ListStudyParticipants` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaListStudyParticipantsResponse |
|---|
| properties | | participantEmails | | description | The list of participant emails. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaListStudyStatsResponse | | description | The response message for the `ListStudyStats` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaListStudyStatsResponse |
|---|
| properties | | studyStats | | $ref | GoogleCorpDiscoverlabsV1alphaStudyStats |
|---|
| description | Coarse-grained engagement stats of the study. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaPreviewProjectResponse | | description | The response message for the `PreviewProject` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaPreviewProjectResponse |
|---|
| properties | | debugMessages | | description | Debug messages related to the request. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| projectDebugNode | | $ref | SearchNowLabsDebugSherlogDebugNode |
|---|
| description | DebugNode related to specific project error handling. |
|---|
|
|---|
| sherlogLink | | description | Sherlog link of the request for debugging. |
|---|
| type | string |
|---|
|
|---|
| wholeFeedImage | | description | Image data string for a screenshot of the entire feed to be used as the src attribute for the html img tag. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaProject | | description | The top-level representation for a Discover Labs project. Next ID: 14 |
|---|
| id | GoogleCorpDiscoverlabsV1alphaProject |
|---|
| properties | | description | | $ref | WebutilHtmlTypesSafeHtmlProto |
|---|
| description | A detailed description of this project. |
|---|
|
|---|
| favorited | | description | True if this project has been selected as a favorite by the user. To change this field, call `AddFavoriteProject` or `RemoveFavoriteProject`. |
|---|
| type | boolean |
|---|
|
|---|
| featuredImageUri | | description | A URI to an image of this project to feature alongside its description. |
|---|
| type | string |
|---|
|
|---|
| feedbackLink | | description | A URL where a user can submit feedback, if provided. |
|---|
| type | string |
|---|
|
|---|
| isLocalOverride | | description | True if this project is a locally built override that was deployed via the CLI's edit-refresh command. |
|---|
| type | boolean |
|---|
|
|---|
| name | | description | The unique name of this project. |
|---|
| type | string |
|---|
|
|---|
| owners | | description | The list of email addresses that effectively own this project. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| parameter | | description | A list of parameters associated with this project. |
|---|
| items | | $ref | GoogleCorpDiscoverlabsV1alphaProjectProjectParameter |
|---|
|
|---|
| type | array |
|---|
|
|---|
| selected | | description | Output only. Whether this project is currently selected by the authenticated user. To change this field, call `SelectProject` or `DeselectProject`. |
|---|
| readOnly | True |
|---|
| type | boolean |
|---|
|
|---|
| title | | description | The user-visible title for this project. If not set, then the `name` field will be shown instead. Note that unlike `name`, this does not have to be globally unique. |
|---|
| type | string |
|---|
|
|---|
| updateClNumber | | description | The CL number of the latest update for this project. |
|---|
| format | int64 |
|---|
| type | string |
|---|
|
|---|
| updateTime | | description | Output only. The time that this project was last updated. |
|---|
| format | google-datetime |
|---|
| readOnly | True |
|---|
| type | string |
|---|
|
|---|
| users | | description | The number of users that have this project currently selected. |
|---|
| format | int64 |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaProjectProjectParameter | | description | A parameter that is configurable for a Discover Lab's project. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaProjectProjectParameter |
|---|
| properties | | parameterDescription | | description | A field describing what this parameter does and if the person filling out a value should follow restrictions. |
|---|
| type | string |
|---|
|
|---|
| parameterDisplayTitle | | description | A human readable name for the parameter displayed to users. |
|---|
| type | string |
|---|
|
|---|
| parameterId | | description | An ID that will be used in the code to access parameter values. |
|---|
| type | string |
|---|
|
|---|
| parameterValue | | description | The current value to be used as the configured value for the user. |
|---|
| type | string |
|---|
|
|---|
| possibleValue | | description | If provided, only one of the following values can be selected. Otherwise, any value the user enter is acceptable. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| qualifiedProto | | description | The package and proto name this parameter represents. Example: search_now_labs.config.Project |
|---|
| type | string |
|---|
|
|---|
| required | | description | If a value is required. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaRemoveFavoriteProjectRequest | | description | The request message for the `RemoveFavoriteProject` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaRemoveFavoriteProjectRequest |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaRemoveFavoriteProjectResponse | | description | The response message for the `RemoveFavoriteProject` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaRemoveFavoriteProjectResponse |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaSaveUserProjectParameterRequest | | description | The request message to save a user project parameter. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaSaveUserProjectParameterRequest |
|---|
| properties | | parameterValue | | description | Required. The parameters and their values being updated. |
|---|
| items | | $ref | GoogleCorpDiscoverlabsV1alphaSaveUserProjectParameterRequestParameterValue |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaSaveUserProjectParameterRequestParameterValue | | description | Represents a value being set. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaSaveUserProjectParameterRequestParameterValue |
|---|
| properties | | parameterId | | description | Required. The id used to represent the parameter whose value we want to set. |
|---|
| type | string |
|---|
|
|---|
| parameterValue | | description | Required. The new value of the parameter. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaSaveUserProjectParameterResponse | | description | The response message for SaveUserProjectParameter |
|---|
| id | GoogleCorpDiscoverlabsV1alphaSaveUserProjectParameterResponse |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaSelectProjectRequest | | description | The request message for the `SelectProject` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaSelectProjectRequest |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaSelectProjectResponse | | description | The response message for the `SelectProject` method. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaSelectProjectResponse |
|---|
| properties | | conflictingProjects | | description | A list of projects that would conflict with the matching logic of this project. The enrollment is still completed, but a warning should be displayed to the user of potential side effects. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaSettings | | description | The stored collection of user preferences for Discover Labs. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaSettings |
|---|
| properties | | labsEnabled | |
|---|
| labsOptinEnabled | | description | True if the authenticated user is opted into Labs via mendel opt-in. Once opted-in, the user's requests to Discover production frontends (like GWS and DiscoFeed) will be rerouted to the Labs frontend services for processing. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaStudy | | description | Information related to a UXR study |
|---|
| id | GoogleCorpDiscoverlabsV1alphaStudy |
|---|
| properties | | assignedParticipantCount | | description | Output only. The number of participants assigned to the study when using auto assignment. |
|---|
| format | int64 |
|---|
| readOnly | True |
|---|
| type | string |
|---|
|
|---|
| endDateTime | | description | The end date time string of the study. |
|---|
| type | string |
|---|
|
|---|
| googleGroup | | description | The gaia of the unique GoogleGroup associated with this study. |
|---|
| type | string |
|---|
|
|---|
| name | | description | The name of this study. This name will be round-tripped to the client. Keep it brief and do not reveal sensitive info. |
|---|
| type | string |
|---|
|
|---|
| project | | description | The name of the project to be applied for this study. |
|---|
| type | string |
|---|
|
|---|
| requiredParticipantCount | | description | The number of participants requested for the study when using auto assignment. |
|---|
| format | int64 |
|---|
| type | string |
|---|
|
|---|
| startDateTime | | description | The start date time string of the study. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaStudyStats | | description | Coarse-grained engagement stats of a study. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaStudyStats |
|---|
| properties | | activeDayCountOfUsers | | description | Active day counts in the past x days of users. |
|---|
| items | | $ref | GoogleCorpDiscoverlabsV1alphaStudyStatsActiveDayCountOfUser |
|---|
|
|---|
| type | array |
|---|
|
|---|
| activeUserCountOnDates | | description | The number of active users by date in the past x days. |
|---|
| items | | $ref | GoogleCorpDiscoverlabsV1alphaStudyStatsActiveUserCountOnDate |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaStudyStatsActiveDayCountOfUser | | description | A user and the number of days the user is active in the past x days. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaStudyStatsActiveDayCountOfUser |
|---|
| properties | | count | | description | The number of days the user is active. |
|---|
| format | int64 |
|---|
| type | string |
|---|
|
|---|
| email | | description | The user email. It is only returned for study owners and otherwise redacted. |
|---|
| type | string |
|---|
|
|---|
| gaiaId | | description | The user GaiaId. It is only returned for study owners and otherwise redacted. |
|---|
| format | int64 |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleCorpDiscoverlabsV1alphaStudyStatsActiveUserCountOnDate | | description | A date and the number of users active on the day. |
|---|
| id | GoogleCorpDiscoverlabsV1alphaStudyStatsActiveUserCountOnDate |
|---|
| properties | | count | | description | The number of users active on the day. |
|---|
| format | int64 |
|---|
| type | string |
|---|
|
|---|
| date | | description | The date of the stat. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleProtobufEmpty | | description | A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
|---|
| id | GoogleProtobufEmpty |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| SearchNowLabsConfigProjectsProactiveaiTopicSpacesActionsCustomTopicSpaceData | | id | SearchNowLabsConfigProjectsProactiveaiTopicSpacesActionsCustomTopicSpaceData |
|---|
| properties | | submissionTime | | format | google-datetime |
|---|
| type | string |
|---|
|
|---|
| topicKey | |
|---|
| userInput | |
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchNowLabsConfigProjectsProactiveaiTopicSpacesActionsCustomTopicSpaceUserData | | id | SearchNowLabsConfigProjectsProactiveaiTopicSpacesActionsCustomTopicSpaceUserData |
|---|
| properties | | customTopicSpaceData | | items | | $ref | SearchNowLabsConfigProjectsProactiveaiTopicSpacesActionsCustomTopicSpaceData |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchNowLabsDebugSherlogDebugNode | | description | Holds debug messages for display on Discover Labs in a tree structure. |
|---|
| id | SearchNowLabsDebugSherlogDebugNode |
|---|
| properties | | children | | description | Children of this node. |
|---|
| items | | $ref | SearchNowLabsDebugSherlogDebugNode |
|---|
|
|---|
| type | array |
|---|
|
|---|
| collapsed | | description | If this has Children, if this section should be displayed collapsed by default or not. |
|---|
| type | boolean |
|---|
|
|---|
| link | | description | A link for this particular record. Parent nodes/root should link to sherlog specifically. Children nodes may use this to link to additional data pertaining to the result. |
|---|
| type | string |
|---|
|
|---|
| text | | description | If this node has children, this is the title of the grouping. otherwise, it is the debug message displayed to the user. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchNowLabsSpannerConfigUserdataCodelabData | | description | UserData specifically related to setting up and maintain codelabs. |
|---|
| id | SearchNowLabsSpannerConfigUserdataCodelabData |
|---|
| properties | | filterCodelabValue | | enum | - FILTER_CODELAB_VALUE_UNKNOWN
- FILTER_CODELAB_VALUE_AZ
- FILTER_CODELAB_VALUE_AM
- FILTER_CODELAB_VALUE_NZ
|
|---|
| enumDescriptions | |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchNowLabsSpannerConfigUserdataReactionData | | id | SearchNowLabsSpannerConfigUserdataReactionData |
|---|
| properties | | packedData | | additionalProperties | | description | Properties of the object. Contains field @type with type URL. |
|---|
| type | any |
|---|
|
|---|
| description | This wraps search.now.labs.config.projects.pby.taste_builder.ReactionList. |
|---|
| type | object |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchNowLabsSpannerConfigUserdataSparksData | | id | SearchNowLabsSpannerConfigUserdataSparksData |
|---|
| properties | | cacheCreatedTimestamp | | description | The timestamp from server time, when the cache was being written. |
|---|
| format | google-datetime |
|---|
| type | string |
|---|
|
|---|
| cachedSparkId | | description | The Spark IDs present in this cache. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| processingTimestamp | | description | The timestamp in which we started processing an offline Sparks request for caching. This is so we can throttle requests. |
|---|
| format | google-datetime |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchNowLabsSpannerConfigUserdataUiAction | | description | Generic UI actions that are recorded in Labs infra. |
|---|
| id | SearchNowLabsSpannerConfigUserdataUiAction |
|---|
| properties | | actionType | | enum | - ACTION_TYPE_UNSPECIFIED
- ACTION_TYPE_VIEW
- ACTION_TYPE_CLICK
- ACTION_TYPE_DISMISS
- ACTION_TYPE_SNOOZE
- ACTION_TYPE_PIN
- ACTION_TYPE_UNPIN
- ACTION_TYPE_UNDO_DISMISS
|
|---|
| enumDescriptions | |
|---|
| type | string |
|---|
|
|---|
| requestId | | description | An ID to identify the instance where this action was created. This can be used to dedupe actions such as raw views versus views per instance of feed refresh. |
|---|
| type | string |
|---|
|
|---|
| timestamp | | description | The server time when this action was received. |
|---|
| format | google-datetime |
|---|
| type | string |
|---|
|
|---|
| uiData | | additionalProperties | | description | Properties of the object. Contains field @type with type URL. |
|---|
| type | any |
|---|
|
|---|
| description | Data specific to the particular UI implementation and action type. This data is passed back and forth between the client and server. It is also passed along on the API between Labs server communication. Generic Labs infrastructure does not translate or process this information. It should only be generated and processed via project specific implementations. Anything passed here should be treated with binary compatibility and handle versioning directly. |
|---|
| type | object |
|---|
|
|---|
| uiId | | description | A unique identifier for the UI. Clients are responsible for designing this; optionally, they can use a namespace design (e.g. “WYWA/world news”) to group UIs together (e.g. under a “WYWA” container) or to imply hierarchical structures. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SearchNowLabsSpannerConfigUserdataUserData | | description | All data for your project should be sub-messaged under this proto. This should only contain messages as field values. |
|---|
| id | SearchNowLabsSpannerConfigUserdataUserData |
|---|
| properties | | cachedDiscoverStream | | description | This is a cached response. The byte representation is of type DiscoverStream. However, since DiscoverStream is not a storage proto and API proto, we store raw bytes. Any access to these bytes should verify that the proto parses correctly. If it does not, then it should treat that there is nothing cached. |
|---|
| format | byte |
|---|
| type | string |
|---|
|
|---|
| cachedResponse | | description | The byte representation of cached response of type com.google.search.now.proto.wire.feed.ResponseProto.Response. However, since Response is not a storage proto and API proto, we store raw bytes. Any access to these bytes should verify that the proto parses correctly. If it does not, then it should treat that there is nothing cached. |
|---|
| format | byte |
|---|
| type | string |
|---|
|
|---|
| codelabData | | $ref | SearchNowLabsSpannerConfigUserdataCodelabData |
|---|
| description | UserData specifically for codelabs. |
|---|
|
|---|
| customTopicSpaceUserData | | $ref | SearchNowLabsConfigProjectsProactiveaiTopicSpacesActionsCustomTopicSpaceUserData |
|---|
|
|---|
| debugData | | description | No sensitive information. Assume it is debug/test data. |
|---|
| type | string |
|---|
|
|---|
| reactionData | | $ref | SearchNowLabsSpannerConfigUserdataReactionData |
|---|
|
|---|
| sparksData | | $ref | SearchNowLabsSpannerConfigUserdataSparksData |
|---|
|
|---|
| uiAction | | description | Generic action data taken on the UI. |
|---|
| items | | $ref | SearchNowLabsSpannerConfigUserdataUiAction |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| WebutilHtmlTypesSafeHtmlProto | | description | IMPORTANT: It is unsafe to accept this message from an untrusted source, since it's trivial for an attacker to forge serialized messages that don't fulfill the type's safety contract -- for example, it could contain attacker controlled script. A system which receives a SafeHtmlProto implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe to return this message in RPC responses, but generally unsafe to accept it in RPC requests. |
|---|
| id | WebutilHtmlTypesSafeHtmlProto |
|---|
| properties | | privateDoNotAccessOrElseSafeHtmlWrappedValue | | description | IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
|
|---|
| old_value | | AddUiActionRequest | | description | The request message for `AddUiAction`. |
|---|
| id | AddUiActionRequest |
|---|
| properties | | requestData | | description | The internal data for this request. This is always of type AddUiActionRequestData. It is bytes as a work around to the OnePlatform proto type checker with the user of dynamic protos. Every proto, including 'Any' protos, must be explicitly listed at API definition compile time. This means we wouldn't be able to dynamically create/pass project data on this request unless we obfuscate the value. |
|---|
| format | byte |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AddUiActionResponse | | description | The response message for `AddUiAction`. |
|---|
| id | AddUiActionResponse |
|---|
| properties | | responseData | | $ref | AddUiActionResponseData |
|---|
| description | The internal data for this response. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AddUiActionResponseData | | description | Response data when invoking AddUiAction. |
|---|
| id | AddUiActionResponseData |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| ClickTrackingCGI | | description | Next ID: 17 |
|---|
| id | ClickTrackingCGI |
|---|
| properties | | doNotLogUrl | | description | Marks this URL as being tainted (eg, with PII) so that it should not be written to archival logs. Currently this gets only honored by gws. |
|---|
| type | boolean |
|---|
|
|---|
| elementIndex | | description | The value of the corresponding VisualElementProto's element_index field. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| nonArchivalVeIndex | | description | Similar to ve_index but referencing a VE in GWSLogEntryProto::non_archival_visual_elements::elements. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| odelaySeLinker | | description | Used by odelay as a server event linker, replaces (deprecated) style. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| pageStart | | description | Used for next pages. The absolute index of the first search result in the page, with respect to the full set of possible search results. Zero indexed. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| resultFprint | | description | A 64-bit fingerprint used to identify the result. This field may be set instead of the VE element index in cases where we do not have server-side logging as well as for client-generated content. In such cases, the result fingerprint will be useful in order to filter duplicate impression logs and parent clicks to the right impression. For example, this may be used by PaintFE to store the feature ID of Spotlight Server features that are not associated with a search, such as ads or personal POIs, in the ClickTrackingCGI proto. This field may be deprecated in the longer run as part of a redesign to log more details about on-map POIs in GMM. See http://go/gmm-onmap. |
|---|
| format | uint64 |
|---|
| type | string |
|---|
|
|---|
| resultGroupElementIndex | | deprecated | True |
|---|
| description | NOTE(jurban): For use *only* in maps/placepage logging. Note that we don't use result_index as that must always be a reference to the GwsLogEntry.Results.Result array, which isn't useful for placepage data. Records the relative ordering of result-like elements within a result group. So if this is a click on a link under a result, this is the element_index of the enclosing result. In maps/placepage it's used to record the result position within journalists (modules), e.g. reviews, photos. For the following journalist's subtree, the links marked with *** would have their result_group_element_index set to 1, i.e. the element_index of their PhotoJournalistResult ancestor: PhotoJournalist 0 PhotoJournalistResult . PhotoJournalistResultLink . PhotoJournalistResultAttributionLink 1 PhotoJournalistResult . PhotoJournalistResultLink *** . PhotoJournalistResultAttributionLink *** |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| resultIndex | | description | If this is a click on a search result, this is the corresponding search result's result_index field (see visual_element.proto for further details). This field is not saved to logs for GWS traffic excluding Tier 3 heirloom as of 2019/11/14, and for all GWS trafic as of 2020/07/09 (go/result-index-deprecation). |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| veEventId | | $ref | ClientEventIdMessage |
|---|
| description | The event ID of the event that caused the logging of the referenced VE. This is to distinguish from the event or context where a VE was clicked, which is not necessarily the same thing. Not all VE have a logging-event, and those should not use this field. In cases where the logging-event is equivalent to the context or event where the VE is clicked, this field may be redundant. |
|---|
|
|---|
| veIndex | | description | The index of the visual element in the original VisualElements array -- one int. To be useful, this requires sessions processing. The fields ve_index, non_archival_ve_index, and ve_offset_identifier are all alternate ways to reference a VE. One and only one of the fields should always be set. Although they are logically a oneof, they are not specified as such because: a) the existing default values don't make a ton of sense in a oneof. b) proto1 does not support oneof, anyway. Note that with the current version of mr_sessions (2010/05/06), the parent_event_index might not be the event with the corresponding visual element tree. In szl, consider using SessionGetParentForVed from logs/lib/session_lib.szl. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| veOffsetIdentifier | | $ref | VeOffsetIdentifier |
|---|
| description | References a VE by explicitly identifying a base VE and an offset from that VE. See go/explicit-ve-indexing for details. |
|---|
|
|---|
| veType | | description | In general, this is the type of the clicked visual element. Barring bugs in frontends (e.g., query rewriting propagating the wrong cgi parameters), this should always be the same as the ui_type of the original visual element. In some cases (currently Tactile and GMM only), the server will put a request_configuration ui_type in the ve_type field. These can be treated exactly like ve ui_types (feature properties, interactions, etc), EXCEPT that they will not be present in a visual element tree and may not indicate that the user took action (check for user_action AUTOMATED to tell if a user did not initiate this event). This field is used to distinguish a web search result from an ad click from a cached click from a specific type of onebox click and is included here as a convenience for logs analysis without sessions. The full list of visual element types is under logs/gws/config/... |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| youtubeVeCounter | | description | YouTube-only. Will never be encoded into URL params and will not be used past the Sessions builder. Used to distinguish between multiple VEs of the same type created by a client. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| youtubeVeIdentifier | | description | YouTube only. A unique value within the VE tree. It will be used to identify the visual element in the original VisualElements array. This field should ONLY be set in recursive InnerTube requests when ve_index is unavailable yet. See go/recursive-clicktracking for details. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ClientEventIdMessage | | description | Some clients need to define an ID of an event before it reaches any server. In order to make it unique globally for all Google services, all users and all days, the main way is to use an existing server event ID from a previous request (the homepage for example) and append a client-controlled counter. |
|---|
| id | ClientEventIdMessage |
|---|
| properties | | base | | $ref | EventIdMessage |
|---|
| description | Base server event ID. |
|---|
|
|---|
| clientCounter | | description | Counter from client. Clients need to make sure to keep this unique per event sent with a client event ID for a common base. |
|---|
| format | int64 |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ClientResource | | description | Represents some set of image bytes that are stored locally on disk on a device. This message provides the set of information that’s required to fetch these bytes off of disk. Next ID: 4 |
|---|
| id | ClientResource |
|---|
| properties | | bundleId | | description | The identifier of the resource bundle where the image resides. Also see [iOS App Bundle Docs] (http://shortn/_x06UQS3rdh). |
|---|
| type | string |
|---|
|
|---|
| imageColor | | description | Deprecated, please use BorderImageProcessor.image_tint instead. The color applied to the loaded image in 0xAARRGGBB format. In Elements runtime, "Source In" is the default blend mode used for applying color on an image. [iOS Blend Modes]( https://developer.apple.com/documentation/coregraphics/cgblendmode?language=objc) [Android Blend Modes]( https://developer.android.com/reference/android/graphics/PorterDuff.Mode) |
|---|
| format | uint32 |
|---|
| type | integer |
|---|
|
|---|
| imageName | | description | The name of the client-side image that the resource loader loads within the Elements framework. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Command | | id | Command |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| DataElement | | description | An extension proto attached to VisualElementProto to point the data sources. |
|---|
| id | DataElement |
|---|
| properties | | reference | | $ref | VisualElementTreeRef |
|---|
| description | A reference to the data element node that represents the data source. Note that we're using the same format for visual and data elements, but they're separate in terms of semantics. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| DataStoreBatchUpdate | | description | The data store batch update. |
|---|
| id | DataStoreBatchUpdate |
|---|
| properties | | mutations | | description | List of data store mutation. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| DataStoreMutation | | description | The data store mutation. |
|---|
| id | DataStoreMutation |
|---|
| properties | | dataStoreKey | | description | The key for the entity affected by this mutation. |
|---|
| type | string |
|---|
|
|---|
| payload | | $ref | DataStoreMutationPayload |
|---|
| description | The payload for data store mutation. |
|---|
|
|---|
| type | | description | The type for data store mutation. |
|---|
| enum | - UNKNOWN_DATA_STORE_MUTATION_TYPE
- REPLACE
- DELETE
|
|---|
| enumDescriptions | - This is the default, but should never be sent, and is strictly an error if a client receives this type.
- Clients should replace any existing entity with the same entity_key with the contents of this one, or add it if an existing entity does not exist with the same key. An REPLACE mutation should send a complete entity, not partial information.
- Clients should remove/purge entity instances with given entity_key.
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| DataStoreMutationPayload | | description | The payload for data store mutation. |
|---|
| id | DataStoreMutationPayload |
|---|
| properties | | payload | | additionalProperties | | description | Properties of the object. Contains field @type with type URL. |
|---|
| type | any |
|---|
|
|---|
| description | When client doesn't need to unpack the contents of the payload, e.g. because it is only going to be used internally for Elements rendering, we are wrapping it in Any proto. + there is no need to serialize these protos into bytes on the client before putting them into the data store; they are already available as bytes. + Any provides better debuggability and testability than bytes field. - in this case (unlike for Any used in ElementsOutput.element_tree or EMLTemplateData.template_config) payload will be used to store various proto messages. This shouldn't be an issue though, because we should never use unpack() on 'payload' field anyway. If there is a need to unpack(), developers should add typed extensions to send such data to the client instead (see below). |
|---|
| type | object |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| EMLParcel | | description | Message for holding any data the EML serving stack needs to transmit to the client so that an Elements response can be correctly rendered. Presently is limited to TemplateConfig data. |
|---|
| id | EMLParcel |
|---|
| properties | | emlTemplateData | | description | The eml template data to be rendered on client side. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| EMLTemplateData | | description | NOTE: xUIKit and Youtube intended to share this proto in 2019. However, this is only used by xUIKit. |
|---|
| id | EMLTemplateData |
|---|
| properties | | directDependencies | | description | Identifiers of resources that this template is DIRECTLY dependent upon. If the resource being depended on is an EML template, its identifier is template URI. EML could depend upon other EML or on Javascript modules. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| identifier | | description | Identifier generated at build time. Also known as template URI. |
|---|
| type | string |
|---|
|
|---|
| resourceStatus | | description | If resource_status = ELEMENTS_RESOURCE_STATUS_OMITTED, template_config should be empty |
|---|
| enum | - ELEMENTS_RESOURCE_STATUS_UNKNOWN
- ELEMENTS_RESOURCE_STATUS_OMITTED
- ELEMENTS_RESOURCE_STATUS_ATTACHED
|
|---|
| enumDescriptions | - The default elements resource status.
- The server expects the client already has the resource (in memory or on disk). The resource is omitted from the response.
- The server expects the client doesn't have the resource. The resource is attached to the response.
|
|---|
| type | string |
|---|
|
|---|
| resourceTag | | description | The tag for this resource. If this field is present the client is expected to echo it back to the server after resource validation has completed. |
|---|
| format | int64 |
|---|
| type | string |
|---|
|
|---|
| templateConfig | | additionalProperties | | description | Properties of the object. Contains field @type with type URL. |
|---|
| type | any |
|---|
|
|---|
| description | Templates remain in serialized form so that the Elements runtime is able to choose when parsing happens and will only parse the template data if it is needed. At present this will be a TemplateConfig containing an EkoTemplateConfig. |
|---|
| type | object |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ElementsOutput | | description | This proto is a container for output of Elements templating system rendering. NEXT ID: 9 |
|---|
| id | ElementsOutput |
|---|
| properties | | dataStoreBatchUpdate | | $ref | DataStoreBatchUpdate |
|---|
| description | Data stored in client-side data store for client-side rendering |
|---|
|
|---|
| elementTree | | additionalProperties | | description | Properties of the object. Contains field @type with type URL. |
|---|
| type | any |
|---|
|
|---|
| description | Serialized youtube.elements.Element that is either a static (server-resolved) or dynamic (client-resolved) tree. go/xuikit-elements-output#element-tree This is an Any proto simply to allow for deferred parsing of the Element until the proto is passed to the xUIKit runtime. |
|---|
| type | object |
|---|
|
|---|
| jsModuleSetUpdate | | $ref | JsModuleSetUpdate |
|---|
| description | Transitive closure of all the JavaScript modules needed by the templates. JavaScript support in xUIKit is still experimental, please do not use without talking to xuikit-eng@. |
|---|
|
|---|
| templateParcel | | $ref | EMLParcel |
|---|
| description | Transitive closure of all the TemplateConfigs needed to render the root template (including the TemplateConfig for the root template itself). |
|---|
|
|---|
| veId | | description | Visual element ID for the Element tree, if applicable. Used for client-side VE logging in Zero State. Do not use for other applications. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| EventIdMessage | | description | An EventId is a 128 bit identifier that uniquely identifies an event, such as a query. The event time recorded to the nearest microsecond, along with information about the process generating the event, ensures that all EventIds are unique. Details of this EventId are described in a design document: http://www/eng/designdocs/sawmill/adlogs.html |
|---|
| id | EventIdMessage |
|---|
| properties | | processId | | description | process_id is an integer that identifies the process on this machine that generated this event. This id is calculated once when the server generates its first event, and may change if the process is migrated to a different host. This field has a very specific format mandated by the logs collection infrastructure, which is subject to change WITHOUT NOTICE. As of 2013-01-09, this format is: uint32 process_id = (time(NULL) << 24) + (getpid() & 0xFFFFFF); If you are generating an extended_pid directly, you MUST use one of the maintained library implementations in order to generate it properly: C++ //borg/borgletlib:extended_pid; call borg::ExtendedPid() Python //borg/borgletlib/python:pyextendedpid; call ExtendedPid() Go //borg/borgletlib/go:extendedpid; call Get() Java //java/com/google/common/logging; call EventId.getPid() If you think that you need to parse the values of this field, please contact logs-collection-dev@ to discuss your requirement. |
|---|
| format | uint32 |
|---|
| type | integer |
|---|
|
|---|
| serverIp | | description | server_ip is the IPv4 address or http://go/ghostid of the machine running the server that created this event message. This allows us to distinguish between events that occur at the same time on different servers. Format: 10.1.2.3 is stored as 0x0a010203, and GHostId 1 as 0x00000001. |
|---|
| format | uint32 |
|---|
| type | integer |
|---|
|
|---|
| timeUsec | | description | time_usec is the number of microseconds since the epoch (i.e., since 1970-01-01 00:00:00 UTC) as an int64: 1e6 * (unix time) + microseconds. Applications must ensure that EventIdMessages have increasing times, artificially increasing time_usec to one greater than the previous value if necessary. Alternate implementations were considered: 1. storing unix time and microseconds separately would require a bit more storage, and the convenience of having a single value representing the time seemed more useful than having trivial access to a unix time. 2. storing unix time in the upper 32 bits would allow for more precision - up to 4G events/second, but it wouldn't print nicely as a decimal value and it seems unlikely that any single server would ever sustain more than 1M events/second. 3. Java-compatible time uses millis - this would limit servers to 1000 events per second - too small. Other names for this field were considered, including time, time_stamp, and utime. We felt that including the units in the name would tend to produce more readable code. utime might be interpreted as user time. |
|---|
| format | int64 |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| FeatureOffsetIdentifier | | description | Explicit feature index (see go/explicit-feature-indexing for details). The identifier_base field is a field that gets incremented with each feature and with each response from superroot. The offset is a field that may go unset but can be used to look up features in a subtree. |
|---|
| id | FeatureOffsetIdentifier |
|---|
| properties | | identifierBase | | description | Unique identifier of a feature. This must be set to a non-empty value. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| offset | | description | Offset of a feature within the feature subtree which may be unset but is expected to be non-negative. The offset is used because it is more efficient in terms of log storage and because the features in a subtree are expected to be consecutive. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| HandleAsyncDataRequest | | description | The request message for `HandleAsyncData`. |
|---|
| id | HandleAsyncDataRequest |
|---|
| properties | | requestData | | $ref | HandleAsyncRequestData |
|---|
| description | The internal data for this request. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| HandleAsyncDataResponse | | description | The response message for `HandleAsyncData`. |
|---|
| id | HandleAsyncDataResponse |
|---|
| properties | | responseData | | $ref | HandleAsyncResponseData |
|---|
| description | The internal data for this response. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| HandleAsyncRequestData | | description | The internal request data for calls to the `HandleAsyncData` method. |
|---|
| id | HandleAsyncRequestData |
|---|
| properties | | projectId | | description | The Discover Labs' project ID this request is associated with. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| HandleAsyncResponseData | | description | The internal response data for calls to the `HandleAsyncData` method. |
|---|
| id | HandleAsyncResponseData |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| HttpBody | | description | Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. |
|---|
| id | HttpBody |
|---|
| properties | | contentType | | description | The HTTP Content-Type header value specifying the content type of the body. |
|---|
| type | string |
|---|
|
|---|
| data | | description | The HTTP request/response body as raw binary. |
|---|
| format | byte |
|---|
| type | string |
|---|
|
|---|
| extensions | | description | Application specific response metadata. Must be set in the first response for streaming APIs. |
|---|
| items | | additionalProperties | | description | Properties of the object. Contains field @type with type URL. |
|---|
| type | any |
|---|
|
|---|
| type | object |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| JsModule | | description | Next ID: 5 |
|---|
| id | JsModule |
|---|
| properties | | dependencies | | description | Identifier for each module dependency. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| identifier | | description | The unique versioned identifier for this module. This will include the module name, as well as a hash of its contents. This will take the form: | |
|---|
| type | string |
|---|
|
|---|
| resourceTag | | description | The resource tag for SRS. See go/eml-token-v2 for details. |
|---|
| format | int64 |
|---|
| type | string |
|---|
|
|---|
| serializedModuleConfig | | description | The script data. This field is consumed by C++ code only and so is serialized to avoid unneeded parsing/reserialization/codegen on the client and to better match the client APIs. Note: serialized_proto_type annotations is used in GwsDiff. parsing_options annotation is used in Sherlog. |
|---|
| format | byte |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| JsModuleSetUpdate | | description | Provides a means to send JS modules to clients. Next ID: 2 |
|---|
| id | JsModuleSetUpdate |
|---|
| properties | | jsModules | | description | List of js modules that will be sent to clients. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| ProductInfo | | description | Product information, used for DMA compliance. |
|---|
| id | ProductInfo |
|---|
| properties | | productId | | description | Google product ID as derived from Team graph API for the xBlend server feature. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SaveUserProjectParameterRequest | | description | The request for updating user's project parameters. |
|---|
| id | SaveUserProjectParameterRequest |
|---|
| properties | | requestData | | $ref | SaveUserProjectParameterRequestData |
|---|
| description | Required. The data required for this action |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SaveUserProjectParameterRequestData | | description | Data for updating a user's project parameter. |
|---|
| id | SaveUserProjectParameterRequestData |
|---|
| properties | | parameterId | | description | Required. The ID of the parameter being updated. |
|---|
| type | string |
|---|
|
|---|
| parameterValue | | description | Optional. The new value to set for the parameter. |
|---|
| type | string |
|---|
|
|---|
| projectId | | description | Required. The Discover Labs' project ID this request is associated with. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SaveUserProjectParameterResponse | | description | The response for updating user's project parameters. |
|---|
| id | SaveUserProjectParameterResponse |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| SwipeAction | | description | Represents a swipe action for a list item. On iOS, the metadata will be used to create the action. Arbitrary view are not supported by the native swipe action. NEXT ID: 5 |
|---|
| id | SwipeAction |
|---|
| properties | | onTriggeredCommand | | $ref | Command |
|---|
| description | The command to execute when the action is triggered (e.g. full-swiped, clicked, etc). |
|---|
|
|---|
| text | | description | The text displayed for the action. The text should be an already localized string. |
|---|
| type | string |
|---|
|
|---|
| themes | | $ref | SwipeActionsThemes |
|---|
| description | The themes for the action. |
|---|
|
|---|
| type | | description | The type of action. |
|---|
| enum | - SWIPE_ACTION_TYPE_UNSPECIFIED
- SWIPE_ACTION_TYPE_NONDESTRUCTIVE
- SWIPE_ACTION_TYPE_DESTRUCTIVE
|
|---|
| enumDescriptions | |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SwipeActionsTheme | | description | Represents the theme for a swipe action. NEXT ID: 3 |
|---|
| id | SwipeActionsTheme |
|---|
| properties | | backgroundColor | | description | The background color for the action. |
|---|
| format | uint32 |
|---|
| type | integer |
|---|
|
|---|
| clientResource | | $ref | ClientResource |
|---|
| description | The client resource for the image icon (go/swipe-action-icons-xblend-list). Note: image_color in ClientResource only impacts the icon color and not the background color of the swipe action. Use `background_color` in SwipeActionsTheme to control the background color of the swipe action. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| SwipeActionsThemes | | description | Represents the theme for a swipe action. NEXT ID: 3 |
|---|
| id | SwipeActionsThemes |
|---|
| properties | | darkModeTheme | | $ref | SwipeActionsTheme |
|---|
| description | The theme for the action in dark mode. |
|---|
|
|---|
| lightModeTheme | | $ref | SwipeActionsTheme |
|---|
| description | The theme for the action in light mode. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| TreeRef | | description | Pointer to a particular node in a feature tree for a given logs event. This pointer consists of an (event ID, feature index) pair, which suffices to identify a single feature in the flattened feature tree stored in GWSLogEntryProto's features field. |
|---|
| id | TreeRef |
|---|
| properties | | clientEventId | | $ref | ClientEventIdMessage |
|---|
| description | Client-side event ID referring to a request processed on the client and logged to the server later on. This can be used to address a client-originated feature subtree. |
|---|
|
|---|
| eventId | | $ref | EventIdMessage |
|---|
| description | Server-side event ID referring to a request processed and logged by the server at request processing time. |
|---|
|
|---|
| featureIndex | | description | Index of the feature referred to within the flattened feature tree addressed by the event oneof. This is an index into the features list of the GWSLogEntryProto with the event ID given above. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| featureOffsetIdentifier | | $ref | FeatureOffsetIdentifier |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| UndoRemoveBubbleConfig | | description | Configuration for information displayed for undoing removing the bubble. NEXT ID: 5 |
|---|
| id | UndoRemoveBubbleConfig |
|---|
| properties | | actionText | | description | The action text which the user clicks on in the snackbar to Undo. |
|---|
| type | string |
|---|
|
|---|
| bodyText | | description | The main text/description of the snackbar ("Live score removed"). |
|---|
| type | string |
|---|
|
|---|
| disableUndo | | description | When this is set to true the undo snackbar will not be displayed. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| VeOffsetIdentifier | | description | Next id: 3 |
|---|
| id | VeOffsetIdentifier |
|---|
| properties | | base | | description | Corresponds to VisualElement.identifier_base. Should be a unique value within a single VE tree. If unset, then the offset of this identifier refers to the global offset within the entire VE tree. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| offset | | description | The offset of the VE from the element identified by base (or within the full VE tree, if base is unset). |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| VisualElementProto | | description | Note: When working with a VisualElementProto in Go or Lingo, it's highly recommended that you use the wrapper objects provided by importing google3/logs/lib/ve/ve. Note: IDs lower than 16 are reserved for use by the logs quality team for extremely commonly logged fields. The next ID in this range is 12. Next >=17 id to use: 1216. |
|---|
| id | VisualElementProto |
|---|
| properties | | adImpressionIndex | | description | For ad-like VEs, where to find further information in GWSLogEntryProto's AdImpression array. * When specified, ad_impression_index *must* be a zero-based index into the gwslog's AdImpression array. NOTE(mcruikshank): In a more pure world, all ad impression data would probably be stored in an optional message, here, or logged as visual elements of their own. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| associatedVeIndex | | description | The VE index of the associated element. Used to make a link across the VE tree structure to link a visual element with the result it relates to. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| consentInterstitialData | | deprecated | True |
|---|
| description | DEPRECATED (2015-05-21): Never used; superseded by consent_bump_data. |
|---|
| format | byte |
|---|
| type | string |
|---|
|
|---|
| containsElements | | description | Other VisualElement(s) contained within this one. Note: * The intended use of VisualElement is something like: repeated VisualElementProto visual_elements; This array contains indices of that master array. * This set of linkages shall be acyclic. * The contained elements are *not* contained in any particular order. Any ordering information that needs to be preserved should be by way of element_index, above. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| crossPropertyRevisionsData | | description | This was originally logs.CrossPropertyRevisionsData, but the CrossPropertyRevisions page element is no longer used. Logs containing this data can be converted manually using the original proto. |
|---|
| type | string |
|---|
|
|---|
| dataElement | | $ref | DataElement |
|---|
| description | Use this field to point the source data used to render this VE. |
|---|
|
|---|
| doNotLogUrls | | description | Set if this VE and all its descendant VEs should have their result URLs (GWSLogEntryProto::Results::Result::ShortUrl) elided in archival logs. |
|---|
| type | boolean |
|---|
|
|---|
| elementIndex | | description | Useful for representing ordered lists, e.g. search results, rhs ads, sitelinks. * When specified, this field *must* represent the order of this element with respect to its siblings. * Note that the ordering of the parent's ContainsElements array (see below) may *not* be relied upon for ordering information. * The first element index *should* be 0. * When set, element_index *must* *not* be negative. (explosive log size and page size implications) * Sibling ordering involving elements *without* element_index set is to be regarded as undefined. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| evalIdentifier | | deprecated | True |
|---|
| description | Deprecated on 11/13/2013 |
|---|
| type | string |
|---|
|
|---|
| featureTreeRef | | $ref | TreeRef |
|---|
| description | The backend feature rendered by this visual element and its descendants. If set, indicates that this VE is the root of the subtree rendering the specified feature. The feature need not be from the same logging event as the visual element. Only the rootmost visual element for a given feature should set this field. It is an error for two VEs to refer to the same feature unless at least one of them is counterfactual. This field replaces the old result_index and ad_impression_index fields. If it is unset, the logs will fall back on the old fields. See also: Feature tree logging design . |
|---|
|
|---|
| hotelPriceId | |
|---|
| identifierBase | | description | If present, should be a unique value within the VE tree that identifies this VE without relying on its position in GWSLogEntryProto::visual_elements. See go/explicit-ve-indexing for details. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| index | | description | index is only meaningful if the VE is stored in the primary VE array GWSLogEntryProto::visual_elements or copied VE subtrees GWSLogEntryProto::copied_ve_subtrees::visual_elements; if populated it is the index of the VE in the original array. However, it will usually not be populated in logs on disk where index == array index. One use case is when the VE tree is scrubbed and we only want to retain a VE subtree. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| language | | description | NOTE: Please use the field only if the other six or so language fields in gwslog.proto are insufficient! |
|---|
| type | string |
|---|
|
|---|
| mid | | description | Machine Identifier (mid) -- an identifier for entities in the Knowledge Graph. MIDs are persistent and do not change. They are 8-character strings usually beginning with '/m/' or '/g/'. This field is primarily intended for single mids that are clearly associated with a single visual element. If you need to use the repeated capacity of this field, please contact search-logs-quality@ so that we can discuss your use case. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| nonArchivalIndex | | description | non_archival_index is only meaningful if the VE is stored in the VE array GWSLogEntryProto::non_archival_visual_elements::elements; if populated it is the index of the VE in that array. However, it will usually not be populated in logs on disk. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| numImpressions | | description | The number of visual element impressions that this proto represents. This number is filled in by JsLayout visual element deduping when an ancestor of this visual element has dedup_impressions set. It counts the number of times the JsLayout template requested that this visual element type be logged. (If 3 jslog= attributes requested that a particular visual element be logged, within the scope of a single outer VE with dedup_impressions set, then one visual element of that type will be logged, with num_impressions set to 3.) dedup_impressions is described at go/ve-deduping |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| obsoleteWebHistoryExperiment | | deprecated | True |
|---|
| description | Deprecated in cl/29776257. |
|---|
| format | byte |
|---|
| type | string |
|---|
|
|---|
| parentPrimaryIndex | | description | If the parent of this VE is in the primary VE array (ie in GWSLogEntryProto::visual_elements) and this VE is in the secondary VE array (ie in GWSLogEntryProto::non_archival_visual_elements::elements) then this index will point to the parent's position in the primary VE array. Otherwise this field will not be populated. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| relativeContainsElements | | description | This serves the same purpose as "contains_elements". The only difference is that this stores child VEs' relative array indices to this VE, in order to save serialized byte size of the proto. Only one of "relative_contains_elements" or "contains_elements" can be set. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| resultIndex | | description | For result-like VEs, where to find further information in GWSLogEntryProto's Results.Result array. * When specified, result_index *must* be a zero-based index into the gwslog's Results.Result array. This field is not populated for GWS traffic (excluding Tier: 3 heirloom) as of 2019/11/14 (go/result-index-deprecation). |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| targetUrl | | description | Actual URL (possibly shortened) that is linked |
|---|
| type | string |
|---|
|
|---|
| uiType | | description | Type of thing on the page: container, result, group, ad, sitelink, infowindow. The number is *canonical* with respect to the property involved. Semantic documentation is stored in: - The old visual_element_configuration file: google3/logs/gws/config/visual_element_configuration which rarely should be added to. - Sharded visual_element_configuration files cs/f:logs/gws/config/.*_visual_element_configuration where new visual elements should go. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| visible | | enum | - VISIBILITY_VISIBLE
- VISIBILITY_HIDDEN
- VISIBILITY_CHILDREN_HIDDEN
- VISIBILITY_REPRESSED_COUNTERFACTUAL
- VISIBILITY_REPRESSED_PRIVACY
|
|---|
| enumDescriptions | - Shown to the user. Default value. Nothing tricky, here.
- Not initially visible, but may be revealed by user action. For example, the elements at the end of a collapsed list are not initially visible, but can be made visible by the user if she uncollapses the list.
- The element is visible, but its children are hidden. The children may be revealed by user action. One example use case is the "More" button on the toolbelt where all its children toolbelt links are hidden initially. Clicking on the "More" button would turn these toolbelt links visible. Note that semantically, this is *not* equivalent to explicitly marking the element as VISIBLE and all children as HIDDEN. In the initial view, these two ways of marking visibility are equivalent. However, when user starts to interact with the VEs, they have different logging consequence. When all the children VEs are explicitly marked with HIDDEN, their visibility could be toggled independently. On the other hand, when the parent is marked as CHILDREN_HIDDEN, any grafting ping that tries to toggle the visibility of its children to VISIBLE has no effect as their visibility settings are already VISIBLE by themselves. A visibility change only takes effect when it is applied to the parent. For example, consider a tree with the following visibility setting, - Foo1 (CHILDREN_HIDDEN) - Foo2 - Foo3 In the initial view, Foo1 is visible and Foo2/Foo3 are hidden. If a ping like /gen_204&vet={show_Foo1} is triggered by some user action, then Foo2 and Foo3 will become visible meaning Foo1/Foo2/Foo3 will all be visible. On the other hand, if a ping like /gen_204&vet={show_Foo2} is sent, the ping is a no-op.
- Used for experiments. The element would have been displayed, but we have chosen not to. e.g. used to repress new UI features in control groups, existing UI features in holdbacks.
- Used by Geo ONLY. Should not be used by search or youtube. Used when the presence of a visual element in the tree could leak private data about a user (for example, if they have visited a specific location in the past). Affected features include LU and GMM on the place sheet, and anywhere else where they show location derived data without writing a footprints entry.
|
|---|
| type | string |
|---|
|
|---|
| youtubeVeCounter | | description | YouTube only. A counter to distinguish between different VEs of the same type created by a client. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| VisualElementTreeRef | | description | Reference to a Visual Element, which may have children. |
|---|
| id | VisualElementTreeRef |
|---|
| properties | | clientEvent | | $ref | ClientEventIdMessage |
|---|
| description | If clients need to point the event that is not determined its event ID, use this field instead of "event" field above. This can happen when the VE tree generator is the client itself, for example in case of using cache or other offline-feature. |
|---|
|
|---|
| ei | | description | GEO ONLY FIELD. A serialized event ID to send across the wire. This field may also contain a client event ID, i.e. suffixed with a colon + a counter (go/client-side-event-id). |
|---|
| type | string |
|---|
|
|---|
| event | | $ref | EventIdMessage |
|---|
| description | ID of the event in which the tree is defined. |
|---|
|
|---|
| rootVe | | $ref | ClickTrackingCGI |
|---|
| description | Reference to the Visual Element that is the root of the tree. |
|---|
|
|---|
| ved | | description | A serialized reference to the root VE to send across the wire. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendAndroidConfig | | description | Configuration specific to the Android xBlend runtime. NEXT ID: 2 |
|---|
| id | XBlendAndroidConfig |
|---|
| properties | | navigationBarConfig | | $ref | XBlendSystemBarConfig |
|---|
| description | Configuration for the appearance of the bottom navigation bar on Android. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendCacheConfig | | description | Configuration for the caching of xBlend responses at the client side. For more information, see go/xblend-caching-v2-on-android. NEXT ID: 5 |
|---|
| id | XBlendCacheConfig |
|---|
| properties | | cacheDurationInSeconds | | description | Expiration duration in seconds. This value cannot be 0. The clients will apply a minimum value of 1 second if this value is < 1. If this response should NOT be cached at all, set do_not_cache instead. |
|---|
| format | uint64 |
|---|
| type | string |
|---|
|
|---|
| cacheExpirationStrategy | | enum | - STRATEGY_DEFAULT
- STRATEGY_SERVE_EXPIRED
- STRATEGY_DO_NOT_SERVE_EXPIRED
|
|---|
| enumDescriptions | - Default (or unset), behaves like STRATEGY_SERVE_EXPIRED.
- If a cached response is expired, it will still be shown to the users while a new response is being fetched. This means: - xBlend will show the expired response and a loading spinner, and perform a fetch. - If the fetch succeeds, xBlend will replace the screen with the new response. - If the fetch fails, xBlend will show an error and keep the expired screen.
- If a cached response is expired, it will not be shown to the users.
|
|---|
| type | string |
|---|
|
|---|
| cacheExpirationUnixTimestampMillis | | description | The absolute millisecond timestamp (measured using the device clock) at which this response will be expired. Similar to cache_duration_in_seconds the client will set a timestamp of at least 1 second into the future after the response is received, if this timestamp is some time in the past. |
|---|
| format | uint64 |
|---|
| type | string |
|---|
|
|---|
| doNotCache | | description | Default: false. If true, do not cache this response at all. When this is set, the response is displayed once, and will not be stored in the cache at all. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendClientInfo | | description | NEXT ID: 13 |
|---|
| id | XBlendClientInfo |
|---|
| properties | | clientApp | | description | The client app where the request originated from. |
|---|
| enum | - APP_UNSPECIFIED
- APP_GOOGLE_APP
- APP_DEV_APP
|
|---|
| enumDescriptions | |
|---|
| type | string |
|---|
|
|---|
| clientAppId | | description | The client app identifier (app package name for Android, app bundle ID for iOS). Ex: "com.google.GoogleMobile" |
|---|
| type | string |
|---|
|
|---|
| clientAppVersion | | description | The client app version. Ex: "180.0.400278405" |
|---|
| type | string |
|---|
|
|---|
| clientPlatform | | description | The client platform where the request originated from. |
|---|
| enum | - PLATFORM_UNSPECIFIED
- PLATFORM_ANDROID
- PLATFORM_IOS
|
|---|
| enumDescriptions | |
|---|
| type | string |
|---|
|
|---|
| deviceManufacturer | | description | The manufacturer of the device where the request originated from. Android: https://developer.android.com/reference/android/os/Build#MANUFACTURER iOS: Always "Apple" |
|---|
| type | string |
|---|
|
|---|
| deviceModel | | description | The model of the device where the request originated from. Android: https://developer.android.com/reference/android/os/Build#MODEL iOS: From uname() machine field. See https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/uname.3.html https://everyi.com/by-identifier/ipod-iphone-ipad-specs-by-model-identifier.html |
|---|
| type | string |
|---|
|
|---|
| optionalClientInfo | | $ref | XBlendOptionalClientInfo |
|---|
| description | Optional client info fields which are not included by default in the XBlendClientInfo. To include a field in the request, the corresponding XBlendOptionalClientInfoType needs to be included in the XBlendAddress. |
|---|
|
|---|
| osVersion | | description | The version of the OS (Android, iOS) on the client. Ex: "14.8" |
|---|
| type | string |
|---|
|
|---|
| preferredLanguages | | description | List of languages applicable to the user in order of preference. Android: https://developer.android.com/reference/android/content/res/Configuration#getLocales() iOS: https://developer.apple.com/documentation/foundation/nsbundle/1413220-preferredlocalizations |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| timezoneDbName | | description | The client timezone database name. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
|---|
| type | string |
|---|
|
|---|
| xuikitVersioningClientType | | description | The client type used by the versioning infrastructure go/xuikit-versioning. If your xBlend integration uses your own xUIKit runtime or view controller, you need a new client_type. The provided xuikit_versioning_client_type needs to match one of the capsfiles prefixes that are described in go/xuikit-versioning-surfaces. If you don't provide a value, the xBlend backend library will try to deduce a client_type from client_app_id. If you have any questions, please contact xblend-eng@. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendConfig | | description | This is the root message containing the various configurations for xBlend features. The message will be included as part of the xBlend response to the client. On the client, the necessary environment configuration changes should be made before the UI is rendered. For more information, view go/xblend-container-configuration-proto. NEXT ID: 12 |
|---|
| id | XBlendConfig |
|---|
| properties | | attributionId | | description | An identifier to be passed into the xUIKit and Silk Clearcut Loggers in order to attribute panes. The value of the attribution id here should come from: google3/search/rendering/xuikit/elements/proto/logging/xblend_feature_id.proto NOTE: Client code should NEVER try to convert this back to the enum value, because there is a risk of breaking forward compatibility. TODO(b/226985398) Migrate attribution id to XBlendLoggingMetadata. |
|---|
| format | uint32 |
|---|
| type | integer |
|---|
|
|---|
| cacheConfig | | $ref | XBlendCacheConfig |
|---|
| description | Configuration for clients on how to cache this response. NOTE: If this is omitted, the xBlend response will be cached by a default duration of 1 minute, and with a default cache expiration-strategy of serving expired responses. |
|---|
|
|---|
| loggingMetadata | | $ref | XBlendLoggingMetadata |
|---|
| description | Logging metadata. |
|---|
|
|---|
| orientationLock | | $ref | XBlendOrientationLock |
|---|
| description | Orientation lock for the container. |
|---|
|
|---|
| productInfo | | $ref | ProductInfo |
|---|
| description | Configurations related to the product of this xBlend feature. Due to DMA, this is required for all production features. |
|---|
|
|---|
| statusBarConfig | | $ref | XBlendSystemBarConfig |
|---|
| description | Configuration for the appearance of the status bar. |
|---|
|
|---|
| xblendAndroidConfig | | $ref | XBlendAndroidConfig |
|---|
| description | Configuration specific to the Android xBlend runtime. |
|---|
|
|---|
| xblendIosConfig | | $ref | XBlendIosConfig |
|---|
| description | Configuration specific to the iOS xBlend runtime. |
|---|
|
|---|
| xuikitAndroidConfig | | $ref | XUIKitAndroidConfig |
|---|
| description | Configurations specific to the Android xUIKit runtime. |
|---|
|
|---|
| xuikitConfig | | $ref | XUIKitConfig |
|---|
| description | Configurations for the xUIKit runtime. |
|---|
|
|---|
| xuikitIosConfig | | $ref | XUIKitIosConfig |
|---|
| description | Configurations specific to the iOS xUIKit runtime. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendExistingVeTreeLoggingMetadata | | description | This message specifies metadata to have the xBlend feature to be grafted into an existing VE tree that is impressed on the client prior to receiving the XBlendResponse. NEXT ID: 3 |
|---|
| id | XBlendExistingVeTreeLoggingMetadata |
|---|
| properties | | veForExtensions | | $ref | VisualElementProto |
|---|
| description | Additional feature-specific VE metadata logged with the visual element specified by the ve_id. Copies over any extensions of VisualElementProto, and not any fields of VisualElementProto itself. |
|---|
|
|---|
| veId | | description | The VE ID for the native container that contains the xBlend feature. |
|---|
| format | uint32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendIosConfig | | description | Configuration specific to the iOS xBlend runtime. NEXT ID: 1 |
|---|
| id | XBlendIosConfig |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| XBlendListItem | | description | Represents a list item. NEXT ID: 5 |
|---|
| id | XBlendListItem |
|---|
| properties | | elementsOutput | | $ref | ElementsOutput |
|---|
| description | Elements outputs for the item. |
|---|
|
|---|
| identifier | | description | Items require a globally unique, non-user-identifiable identifier for efficient deletion, updates, and scrolling. The feature team should determine this identifier, preferably using the root EML component's identifier if available. |
|---|
| type | string |
|---|
|
|---|
| leadingSwipeActions | | description | Swipe actions for the leading list item (typically the left side). The order of the actions specified in the field is the order they will be displayed. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| trailingSwipeActions | | description | Swipe actions for the trailing list item (typically the right side). The order of the actions specified in the field is the order they will be displayed. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendListResponse | | description | Response that represents a list (go/xblend-list-container). NEXT ID: 3 |
|---|
| id | XBlendListResponse |
|---|
| properties | | onVisibleCommand | | $ref | Command |
|---|
| description | Command executed when the container is visible. |
|---|
|
|---|
| sections | | description | Sections of the list. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendListSection | | description | Represents a section of a list. NEXT ID: 3 |
|---|
| id | XBlendListSection |
|---|
| properties | | headerElementsOutput | | $ref | ElementsOutput |
|---|
| description | The header view for the section. |
|---|
|
|---|
| item | | description | Represents a list of items in the section. |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendLoggingMetadata | | description | Additional logging metadata the xBlend feature can specify. The server does not know what container type the content will be rendered in but can provide metadata to use for each case. If both new_ve_tree_logging_metadata and existing_ve_tree_logging_metadata are set, the client should decided which field to use based on whether it has impressed a root VE prior to receiving the XBlendResponse . NEXT ID: 3 |
|---|
| id | XBlendLoggingMetadata |
|---|
| properties | | existingVeTreeLoggingMetadata | | $ref | XBlendExistingVeTreeLoggingMetadata |
|---|
|
|---|
| newVeTreeLoggingMetadata | | $ref | XBlendNewVeTreeLoggingMetadata |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendNewVeTreeLoggingMetadata | | description | Additional logging metadata the xBlend feature can specify in cases where a new VE tree is created. Note: This information will only be applied the first time a client visual element is created, e.g. on the initial server response, and not on any "update content" API calls. In those subsequent cases, this information will be ignored. |
|---|
| id | XBlendNewVeTreeLoggingMetadata |
|---|
| properties | | rootImpressionEventIdOverride | | description | Container types that create a new VE tree (rather than grafting onto a previous one) will have a root impression event specified by the xBlend runtime. This is primarily needed for logs in PROPERTY_GOOGLE to have their events contribute towards metrics. In such cases, the event should have a BASE_METRICS_EVENT transition type (or subtype). xBlend will provide a default value of this but you can override it by setting this property. e.g. By default the impression event for a full screen pane will be XBlendFullScreenPaneRootImpressionEvent (see logs/gws/config/xblend_impression_event_configuration) |
|---|
| format | uint32 |
|---|
| type | integer |
|---|
|
|---|
| rootVeIdOverride | | description | Container types that create a new VE tree (rather than grafting onto a previous one) will have a root VE specified by the xBlend runtime. xBlend will provide a default value of this but you can override it by setting this property. e.g. By default the root VE for a full screen pane will be XBlendFullScreenPane (see logs/gws/config/xblend_visual_element_configuration) |
|---|
| format | uint32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendOptionalClientInfo | | description | NEXT ID: 4 LINT.IfChange(XBlendOptionalClientInfo) |
|---|
| id | XBlendOptionalClientInfo |
|---|
| properties | | fontScale | | description | User's selected font scaling multiplier from system settings. |
|---|
| format | float |
|---|
| type | number |
|---|
|
|---|
| preferredTemperatureUnit | | description | User's preference for temperature units from system settings. |
|---|
| enum | - TEMPERATURE_UNIT_UNSPECIFIED
- TEMPERATURE_UNIT_CELSIUS
- TEMPERATURE_UNIT_FAHRENHEIT
|
|---|
| enumDescriptions | - no explicit selection, use app default
- Celsius setting selected
- Fahrenheit setting selected
|
|---|
| type | string |
|---|
|
|---|
| preferredTimeFormat | | description | User's preference for time format from system settings. |
|---|
| enum | - TIME_FORMAT_UNSPECIFIED
- TIME_FORMAT_12_HOUR
- TIME_FORMAT_24_HOUR
|
|---|
| enumDescriptions | - no explicit selection
- 12 hour format selected
- 24 hour format selected
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendOrientationLock | | description | This message contains the configurations for the orientation of the xBlend container. For more information, view go/xblend-container-orientation. NEXT ID: 4 |
|---|
| id | XBlendOrientationLock |
|---|
| properties | | errorMessageIfIncompatible | | description | If the specified `orientation` is incompatible with the supported orientations of the app and `show_error_if_incompatible` is set to `true`, an error screen will be shown with this message. If no error message is provided, the error screen will use the default generic error message from the xBlend runtime. |
|---|
| type | string |
|---|
|
|---|
| orientation | | description | Orientation for the container. |
|---|
| enum | - ORIENTATION_UNSPECIFIED
- ORIENTATION_PORTRAIT
- ORIENTATION_LANDSCAPE
|
|---|
| enumDescriptions | - The container will rotate to match the device orientation when unspecified.
- On iOS: For left to right (LTR) languages, the notch will be on the right side. The idea is that, with LTR languages, there will be more content starting on the left side of the screen. Less content will be cut off if the notch is on the right. For right to left (RTL) languages, the notch will be on the left. If the app only supports one landscape orientation, that orientation will be used.
|
|---|
| type | string |
|---|
|
|---|
| showErrorIfIncompatible | | description | The specified `orientation` may be incompatible with the supported orientations of the app. If the orientation is incompatible, then setting this field to `true` will display an error screen on the client. Customize the error message with `error_message_if_incompatible`. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendParameters | | description | The base parameters message that different services can extend with custom messages. |
|---|
| id | XBlendParameters |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| XBlendRequest | | description | This message will contain the necessary information for a xBlend request. NEXT ID: 4 |
|---|
| id | XBlendRequest |
|---|
| properties | | clientInfo | |
|---|
| parameters | | $ref | XBlendParameters |
|---|
| description | Feature specific fields. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendResponse | | description | This message will contain the necessary information needed to render a xBlend feature in the client runtime. NEXT ID: 5 |
|---|
| id | XBlendResponse |
|---|
| properties | | bubbleResponse | | $ref | XBubbleResponse |
|---|
| description | A response for XBubble. |
|---|
|
|---|
| config | | $ref | XBlendConfig |
|---|
| description | Configurations for the feature. |
|---|
|
|---|
| listResponse | | $ref | XBlendListResponse |
|---|
| description | A response for a list. |
|---|
|
|---|
| standaloneResponse | | $ref | XBlendStandaloneResponse |
|---|
| description | A basic standalone response. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendStandaloneResponse | | description | Represents a basic response that contains only one ElementsOutput. NEXT ID: 2 |
|---|
| id | XBlendStandaloneResponse |
|---|
| properties | | elementsOutput | | $ref | ElementsOutput |
|---|
| description | Elements outputs for the feature. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBlendSystemBarConfig | | description | Configuration for the appearance of a system bar (e.g. status or navigation bar) in xBlend. For more information, see go/xpane-system-bars. NEXT ID: 5 |
|---|
| id | XBlendSystemBarConfig |
|---|
| properties | | backgroundColor | | deprecated | True |
|---|
| description | DEPRECATED: Use for backwards compatibility only. From AGSA 16.10, xPane is rendered edge-to-edge by default and this field is ignored. |
|---|
| format | uint32 |
|---|
| type | integer |
|---|
|
|---|
| opacity | | deprecated | True |
|---|
| description | DEPRECATED: Use for backwards compatibility only. From AGSA 16.10, xPane is rendered edge-to-edge by default and this field is ignored. |
|---|
| format | float |
|---|
| type | number |
|---|
|
|---|
| renderContentBehind | | deprecated | True |
|---|
| description | DEPRECATED: Use for backwards compatibility only. From AGSA 16.10, xPane is rendered edge-to-edge by default and this field is ignored. |
|---|
| type | boolean |
|---|
|
|---|
| theme | | description | Overrides the theme of the system bar to always light or always dark. If unspecified, system theme settings will be used, i.e. light theme in light mode and dark theme in dark mode. |
|---|
| enum | - THEME_UNSPECIFIED
- THEME_ALWAYS_LIGHT
- THEME_ALWAYS_DARK
|
|---|
| enumDescriptions | - Follow the system theme settings, i.e. light theme in light mode and dark theme in dark mode.
- Light theme, suitable for use with light backgrounds. The system bar will remain light themed regardless of the user's light/dark mode settings.
- Dark theme, suitable for use with dark backgrounds. The system bar will remain dark themed regardless of the user's light/dark mode settings.
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBubbleExpandedOverlayConfig | | description | Configuration for displaying the details around expanded bubble. NEXT ID: 4 |
|---|
| id | XBubbleExpandedOverlayConfig |
|---|
| properties | | feedbackButtonText | | description | Text for the feedback button. If empty, use the client default behavior. |
|---|
| type | string |
|---|
|
|---|
| removeButtonText | | description | Text for the remove button. If empty, use the client default behavior. |
|---|
| type | string |
|---|
|
|---|
| undoRemoveBubbleConfig | | $ref | UndoRemoveBubbleConfig |
|---|
| description | Text for the undo remove button. If empty, use the client default behavior. |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBubblePersistentNotificationData | | description | Data for displaying the persistent notification shown when the xBubble is on screen. NEXT ID: 4 |
|---|
| id | XBubblePersistentNotificationData |
|---|
| properties | | additionalContextText | | description | Additional context to be shown in the persistent notification for a single bubble. If there are multiple bubbles, this text will not be shown. |
|---|
| type | string |
|---|
|
|---|
| bubbleContentDescription | | description | Text that will be shown in the persistent notification, which describes the contents of this particular bubble. For example, "South Africa vs England" for a sports match. |
|---|
| type | string |
|---|
|
|---|
| multipleBubblesTitle | | description | Notification title if there are multiple bubbles on the screen at the same time, and all the bubbles have the same multiple_bubbles_title. If there are different multiple_bubbles_title strings amongst the displayed bubbles, a client default string will be used as the notification title. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XBubbleResponse | | description | Represents a response that could be rendered in the xBlend's xBubble container from the client. NEXT ID: 5 |
|---|
| id | XBubbleResponse |
|---|
| properties | | collapsedElementsOutput | | $ref | ElementsOutput |
|---|
| description | Elements outputs for the collapsed Bubble. |
|---|
|
|---|
| expandedElementsOutput | | $ref | ElementsOutput |
|---|
| description | Elements outputs for the expanded Bubble. |
|---|
|
|---|
| expandedOverlayConfig | | $ref | XBubbleExpandedOverlayConfig |
|---|
|
|---|
| persistentNotificationData | | $ref | XBubblePersistentNotificationData |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XUIKitAndroidConfig | | description | The Android xUIKit/Elements runtime configurations within the xBlend feature. The fields in the message should map to: http://google3/java/com/google/android/libraries/elements/interfaces/ElementsConfig.java Add additional fields as needed. NEXT ID: 3 |
|---|
| id | XUIKitAndroidConfig |
|---|
| properties | | logTag | | description | The tag to be used for logging (e.g. `feature_name`). Setting the tag is highly encouraged. If the value is not set, the Android runtime will use the default value of "xUIKit": http://google3/java/com/google/android/libraries/search/rendering/xuikit/runtime/module/XUiKitElementsConfigModule.java?l=25&rcl=333516247 |
|---|
| type | string |
|---|
|
|---|
| nestedScrollingEnabled | | description | Whether nested scrolling is enabled on collection and scrollable container types. If the value is not set, the Android runtime will use the default value of `true`: http://google3/java/com/google/android/libraries/elements/interfaces/ElementsConfig.java?l=52&rcl=333792706 |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| XUIKitConfig | | description | The proto for the xUIKit configurations within the xBlend feature. NEXT ID: 1 |
|---|
| id | XUIKitConfig |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| XUIKitIosConfig | | description | The iOS xUIKit/Elements runtime configurations within the xBlend container. The fields in the message should map to: http://google3/googlemac/iPhone/Shared/xUIKit/API/RuntimeConfiguration/XUIElementsRuntimeConfig.h http://google3/googlemac/iPhone/YouTube/Tools/Elements/Core/Public/ELMRuntimeConfig.h Add additional fields as needed. NEXT ID: 2 |
|---|
| id | XUIKitIosConfig |
|---|
| properties | | useEditableTextCanaryMode | | description | Whether to enable experimental implementation of EditableText type. If the value is not set, the iOS runtime will use the default value of `false`. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
|
|---|
|
|---|
| root['title'] | | new_value | Corp discoverlabs API (autopush) |
|---|
| old_value | Discover Labs Private API (Staging) |
|---|
|
|---|
| root['version'] | | new_value | v1alpha |
|---|
| old_value | v1 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-familymanagement-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-familymanagement-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-gboardimagen-pa- | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-gboardimagen-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-generativelanguage- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-generativelanguage-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-generativelanguage-v1alpha | | dictionary_item_added | - root['schemas']['FunctionDeclaration']['properties']['parametersJsonSchema']
- root['schemas']['FunctionDeclaration']['properties']['responseJsonSchema']
- root['schemas']['GenerationConfig']['properties']['responseJsonSchema']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-generativelanguage-v1beta | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-generativelanguage-v1beta1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-generativelanguage-v1beta2 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-generativelanguage-v1beta3 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-hangouts- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-hangouts-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-myphonenumbers-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-myphonenumbers-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-notifications-pa- | | dictionary_item_added | - root['schemas']['GoogleLogsTapandpayAndroid_Tp2AppLogEvent_WearExpressTransit']
- root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['properties']['wearExpressTransit']
- root['schemas']['GoogleLogsTapandpayAndroid__TransitHceSessionEvent']['properties']['provisioningAndroidProfileOrigin']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['description'] | | new_value | Top-level extension to be reported Next id: 210 |
|---|
| old_value | Top-level extension to be reported Next id: 209 |
|---|
|
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__TransitHceSessionEvent']['description'] | | new_value | Event related to communication over NFC using close loop transit tap. Next id: 34 |
|---|
| old_value | Event related to communication over NFC using close loop transit tap. Next id: 33 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['ComGoogleCommerceTapandpayNotifications_TapAndPayNotificationAppPayload_TokenProvisioningData']['properties']['paymentBundleType']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['GoogleInternalTapandpayV1__CheckEligibilityRequest']['properties']['supportedPaymentBundleTypes']['items']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__MdocPresentationEvent']['properties']['presentationType']['enum'][6] | CREDMAN_IN_APP_OPENID4VP_DRAFT24 |
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__MdocPresentationEvent']['properties']['presentationType']['enum'][7] | CREDMAN_WEB_OPENID4VP_DRAFT24 |
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__SettingState']['properties']['setting']['enum'][23] | WEAR_AUTH_REQUIRED_OPEN_LOOP_TRANSIT |
|---|
| root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enum'][6] | MAGIC_ENHANCE |
|---|
| root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][6] | Represents the Magic Enhance editing effect from Conversational Editing. Note as of 2025/05/13, Magic Enhance in Magic Editor is mapped to MAGIC_EDITOR, not this enum. http://google3/googlex/gcam/creative_camera/intuitive_editing/conversational_editing/common/abstract_syntax_tree.proto?q=symbol:%5CbFN_ENHANCE%5Cb |
|---|
| root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][442] | CONTENT_EXPLORATION_SFV |
|---|
| root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][442] | For exploring new short video content. go/discover-exploration-dd。 |
|---|
| root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1086] | FINANCE_WATCHLIST_WIDGET |
|---|
| root['schemas']['Tapandpay_TokenizationOperationRequest_TokenizeCard']['properties']['auxiliaryPaymentBundleType']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['Tapandpay_TokenizationOperationRequest_TokenizeCard']['properties']['paymentBundleType']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['WalletGooglepayFrontendApiTransactions_CoreTransaction_SecureDataKey']['properties']['secureDataType']['enum'][12] | COURIER_IN_SESSION_TRANSIT_OPAQUE_AUTHENTICATION_CREDENTIAL |
|---|
| root['schemas']['WalletGooglepayFrontendApiTransactions_CoreTransaction_SecureDataKey']['properties']['secureDataType']['enumDescriptions'][12] | Opaque account credential used to provision transit private label cards. See go/transit-plc-native-provisioning for details. |
|---|
|
|---|
|
|---|
| sandbox/autopush-notifications-pa-v1 | | dictionary_item_added | - root['schemas']['GoogleLogsTapandpayAndroid_Tp2AppLogEvent_WearExpressTransit']
- root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['properties']['wearExpressTransit']
- root['schemas']['GoogleLogsTapandpayAndroid__TransitHceSessionEvent']['properties']['provisioningAndroidProfileOrigin']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['description'] | | new_value | Top-level extension to be reported Next id: 210 |
|---|
| old_value | Top-level extension to be reported Next id: 209 |
|---|
|
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__TransitHceSessionEvent']['description'] | | new_value | Event related to communication over NFC using close loop transit tap. Next id: 34 |
|---|
| old_value | Event related to communication over NFC using close loop transit tap. Next id: 33 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['ComGoogleCommerceTapandpayNotifications_TapAndPayNotificationAppPayload_TokenProvisioningData']['properties']['paymentBundleType']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['GoogleInternalTapandpayV1__CheckEligibilityRequest']['properties']['supportedPaymentBundleTypes']['items']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__MdocPresentationEvent']['properties']['presentationType']['enum'][6] | CREDMAN_IN_APP_OPENID4VP_DRAFT24 |
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__MdocPresentationEvent']['properties']['presentationType']['enum'][7] | CREDMAN_WEB_OPENID4VP_DRAFT24 |
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__SettingState']['properties']['setting']['enum'][23] | WEAR_AUTH_REQUIRED_OPEN_LOOP_TRANSIT |
|---|
| root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enum'][6] | MAGIC_ENHANCE |
|---|
| root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][6] | Represents the Magic Enhance editing effect from Conversational Editing. Note as of 2025/05/13, Magic Enhance in Magic Editor is mapped to MAGIC_EDITOR, not this enum. http://google3/googlex/gcam/creative_camera/intuitive_editing/conversational_editing/common/abstract_syntax_tree.proto?q=symbol:%5CbFN_ENHANCE%5Cb |
|---|
| root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][442] | CONTENT_EXPLORATION_SFV |
|---|
| root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][442] | For exploring new short video content. go/discover-exploration-dd。 |
|---|
| root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1086] | FINANCE_WATCHLIST_WIDGET |
|---|
| root['schemas']['Tapandpay_TokenizationOperationRequest_TokenizeCard']['properties']['auxiliaryPaymentBundleType']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['Tapandpay_TokenizationOperationRequest_TokenizeCard']['properties']['paymentBundleType']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['WalletGooglepayFrontendApiTransactions_CoreTransaction_SecureDataKey']['properties']['secureDataType']['enum'][12] | COURIER_IN_SESSION_TRANSIT_OPAQUE_AUTHENTICATION_CREDENTIAL |
|---|
| root['schemas']['WalletGooglepayFrontendApiTransactions_CoreTransaction_SecureDataKey']['properties']['secureDataType']['enumDescriptions'][12] | Opaque account credential used to provision transit private label cards. See go/transit-plc-native-provisioning for details. |
|---|
|
|---|
|
|---|
| sandbox/autopush-oauthaccountmanager-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-ogads-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-ogads-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-people-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['InternalExternal']['properties']['application']['enum'][460] | MSS_JUPITER |
|---|
|
|---|
|
|---|
| sandbox/autopush-people-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['InternalExternal']['properties']['application']['enum'][460] | MSS_JUPITER |
|---|
|
|---|
|
|---|
| sandbox/autopush-people-pa-v2 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['InternalExternal']['properties']['application']['enum'][460] | MSS_JUPITER |
|---|
|
|---|
|
|---|
| sandbox/autopush-peoplestack-pa- | | dictionary_item_added | - root['schemas']['PeoplestackGroupMemberInfo']['properties']['createdAt']
- root['schemas']['PeoplestackGroupMemberInfo']['properties']['lastUpdatedAt']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['PeoplestackFlexorgsProtoInternalExternal']['properties']['application']['enum'][460] | MSS_JUPITER |
|---|
| root['schemas']['PeoplestackFlexorgsProtoInternalExternal']['properties']['application']['enumDescriptions'][460] | Mss Jupiter Team contact: jupiter-eng@google.com |
|---|
| root['schemas']['SocialClientsApplicationProto3Wrapper']['properties']['application']['enum'][460] | MSS_JUPITER |
|---|
| root['schemas']['SocialClientsApplicationProto3Wrapper']['properties']['application']['enumDescriptions'][460] | Mss Jupiter Team contact: jupiter-eng@google.com |
|---|
|
|---|
| iterable_item_removed | | root['resources']['autocomplete']['methods']['joinGroup']['scopes'][0] | https://www.googleapis.com/auth/peopleapi.readonly |
|---|
| root['resources']['autocomplete']['methods']['leaveGroup']['scopes'][0] | https://www.googleapis.com/auth/peopleapi.readonly |
|---|
|
|---|
|
|---|
| sandbox/autopush-peoplestack-pa-v1 | | dictionary_item_added | - root['schemas']['PeoplestackGroupMemberInfo']['properties']['createdAt']
- root['schemas']['PeoplestackGroupMemberInfo']['properties']['lastUpdatedAt']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250513 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['PeoplestackFlexorgsProtoInternalExternal']['properties']['application']['enum'][460] | MSS_JUPITER |
|---|
| root['schemas']['PeoplestackFlexorgsProtoInternalExternal']['properties']['application']['enumDescriptions'][460] | Mss Jupiter Team contact: jupiter-eng@google.com |
|---|
| root['schemas']['SocialClientsApplicationProto3Wrapper']['properties']['application']['enum'][460] | MSS_JUPITER |
|---|
| root['schemas']['SocialClientsApplicationProto3Wrapper']['properties']['application']['enumDescriptions'][460] | Mss Jupiter Team contact: jupiter-eng@google.com |
|---|
|
|---|
| iterable_item_removed | | root['resources']['autocomplete']['methods']['joinGroup']['scopes'][0] | https://www.googleapis.com/auth/peopleapi.readonly |
|---|
| root['resources']['autocomplete']['methods']['leaveGroup']['scopes'][0] | https://www.googleapis.com/auth/peopleapi.readonly |
|---|
|
|---|
|
|---|
| sandbox/autopush-phonedeviceverification-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-phonedeviceverification-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-reach-pa- | | dictionary_item_removed | - root['fullyEncodeReservedExpansion']
|
|---|
| values_changed | | root['baseUrl'] | | new_value | https://autopush-accountsettingsmobile-pa.sandbox.googleapis.com/ |
|---|
| old_value | https://staging-reach-pa.sandbox.googleapis.com/ |
|---|
|
|---|
| root['canonicalName'] | | new_value | Account Settings Mobile |
|---|
| old_value | Reach Presentation Service |
|---|
|
|---|
| root['description'] | | new_value | An API which services Google account settings UIs on Android and iOS. |
|---|
| old_value | reach-pa.googleapis.com API. |
|---|
|
|---|
| root['documentationLink'] | | new_value | http://go/asm |
|---|
| old_value | http://go/safetyexp-entry-point-dd |
|---|
|
|---|
| root['id'] | | new_value | autopush_accountsettingsmobile_pa_sandbox:v1 |
|---|
| old_value | reach_pa:v1 |
|---|
|
|---|
| root['mtlsRootUrl'] | | new_value | https://autopush-accountsettingsmobile-pa.mtls.sandbox.googleapis.com/ |
|---|
| old_value | https://staging-reach-pa.mtls.sandbox.googleapis.com/ |
|---|
|
|---|
| root['name'] | | new_value | autopush_accountsettingsmobile_pa_sandbox |
|---|
| old_value | reach_pa |
|---|
|
|---|
| root['resources']['v1']['methods'] | | new_value | | getClientConfig | | description | Requests config data for iOS clients. |
|---|
| flatPath | v1:getClientConfig |
|---|
| httpMethod | POST |
|---|
| id | autopush_accountsettingsmobile_pa_sandbox.getClientConfig |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getClientConfig |
|---|
| request | | $ref | GetClientConfigRequest |
|---|
|
|---|
| response | | $ref | GetClientConfigResponse |
|---|
|
|---|
|
|---|
| getResource | | description | Requests a resource. |
|---|
| flatPath | v1:getResource |
|---|
| httpMethod | POST |
|---|
| id | autopush_accountsettingsmobile_pa_sandbox.getResource |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getResource |
|---|
| request | |
|---|
| response | |
|---|
|
|---|
| getScreen | | description | Requests a screen. |
|---|
| flatPath | v1:getScreen |
|---|
| httpMethod | POST |
|---|
| id | autopush_accountsettingsmobile_pa_sandbox.getScreen |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getScreen |
|---|
| request | |
|---|
| response | |
|---|
|
|---|
| getSignedOutResource | | description | Requests a resource from a signed-out context. |
|---|
| flatPath | v1:getSignedOutResource |
|---|
| httpMethod | POST |
|---|
| id | autopush_accountsettingsmobile_pa_sandbox.getSignedOutResource |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getSignedOutResource |
|---|
| request | | $ref | GetSignedOutResourceRequest |
|---|
|
|---|
| response | | $ref | GetSignedOutResourceResponse |
|---|
|
|---|
|
|---|
| prefetchRelatedScreens | | description | Requests a list of screens which are related to a specified one, with the purpose of prefetching them in the client application. |
|---|
| flatPath | v1:prefetchRelatedScreens |
|---|
| httpMethod | POST |
|---|
| id | autopush_accountsettingsmobile_pa_sandbox.prefetchRelatedScreens |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:prefetchRelatedScreens |
|---|
| request | | $ref | PrefetchRelatedScreensRequest |
|---|
|
|---|
| response | | $ref | PrefetchRelatedScreensResponse |
|---|
|
|---|
|
|---|
| search | | description | Searches through resources |
|---|
| flatPath | v1:search |
|---|
| httpMethod | POST |
|---|
| id | autopush_accountsettingsmobile_pa_sandbox.search |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:search |
|---|
| request | |
|---|
| response | |
|---|
|
|---|
| setResourceDismissalState | | description | Sets the resource state, e.g. resource is dismissed |
|---|
| flatPath | v1:setResourceDismissalState |
|---|
| httpMethod | POST |
|---|
| id | autopush_accountsettingsmobile_pa_sandbox.setResourceDismissalState |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:setResourceDismissalState |
|---|
| request | | $ref | SetResourceDismissalStateRequest |
|---|
|
|---|
| response | | $ref | SetResourceDismissalStateResponse |
|---|
|
|---|
|
|---|
|
|---|
| old_value | | getAccountMessages | | description | Fetches user's current advice state, potentially updates respective badge dismissal |
|---|
| flatPath | v1:getAccountMessages |
|---|
| httpMethod | POST |
|---|
| id | reach_pa.getAccountMessages |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getAccountMessages |
|---|
| request | | $ref | AccountMessagesRequest |
|---|
|
|---|
| response | | $ref | AccountMessagesResponse |
|---|
|
|---|
|
|---|
| updateAccountMessages | | description | Updates user's current advice state, like updating the advice dismissal status |
|---|
| flatPath | v1:updateAccountMessages |
|---|
| httpMethod | POST |
|---|
| id | reach_pa.updateAccountMessages |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:updateAccountMessages |
|---|
| request | | $ref | UpdateAccountMessagesRequest |
|---|
|
|---|
| response | | $ref | UpdateAccountMessagesResponse |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
| root['rootUrl'] | | new_value | https://autopush-accountsettingsmobile-pa.sandbox.googleapis.com/ |
|---|
| old_value | https://staging-reach-pa.sandbox.googleapis.com/ |
|---|
|
|---|
| root['schemas'] | | new_value | | 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 |
|---|
|
|---|
|
|---|
| old_value | | AccountAdvice | | description | Data to render OneGoogle bento account advice |
|---|
| id | AccountAdvice |
|---|
| properties | | additionalInfo | | $ref | AdditionalInfo |
|---|
| description | Optional additional information included with the advice. Currently only used for recovery factor advice. |
|---|
|
|---|
| adviceId | | description | Unique identifier of the advice type. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| ctaText | | description | Text to display on the CTA button. |
|---|
| type | string |
|---|
|
|---|
| description | | description | Description of the advice. |
|---|
| type | string |
|---|
|
|---|
| destination | | $ref | AdviceDestination |
|---|
| description | Destination to open once Bento account advice CTA is clicked |
|---|
|
|---|
| dismissalText | | description | Text to display on the dismissal button. |
|---|
| type | string |
|---|
|
|---|
| title | | description | Title of the advice. |
|---|
| type | string |
|---|
|
|---|
| uiTreatment | | description | UI treatment of the advice. |
|---|
| enum | - UI_TREATMENT_UNSPECIFIED
- YELLOW_CARD
- BLUE_CARD_SLIM
- BLUE_CARD_EXTENDED
|
|---|
| enumDescriptions | - No information about UI treatment, should never be used.
- Yellow card UI treatment for recovery phone advice.
- Blue card slim version UI treatment for home address advice.
- Blue card extended version UI treatment for home address advice.
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountMenu | | description | Data to render OneGoogle account menu only for SafetyExp |
|---|
| id | AccountMenu |
|---|
| properties | | alertLevel | | enum | - ALERT_LEVEL_UNSPECIFIED
- NO_ADVICE
- ADVICE
- ADVICE_REQUIRING_ATTENTION
|
|---|
| enumDescriptions | - No information about alert level
- No advice — account is in a good shape
- There is advice available
- There is advice that require attention
|
|---|
| type | string |
|---|
|
|---|
| destination | |
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountMessagesRequest | | description | Request for the GetAccountMessages RPC |
|---|
| id | AccountMessagesRequest |
|---|
| properties | | accountParticleDiscVersion | | $ref | Version |
|---|
| description | Version of the AccountParticleDisc that is currently present on the device, iff present. |
|---|
|
|---|
| adviceFlavours | | description | The flavour of advice applicable to the request. Response data will be accordingly produced. |
|---|
| items | | enum | - UNSPECIFIED_ADVICE_FLAVOUR
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_VARIANT_1
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_NO_DESCRIPTION_VARIANT_1
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_GMAIL_VARIANT_1
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_NO_BADGE_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_VARIANT_2
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_PHOTOS_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_DRIVE_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_GMAIL_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_PHOTOS_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_DRIVE_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_GMAIL_VARIANT_1
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_VARIANT_1
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_VARIANT_2
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_MAPS_EXTENDED
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_MAPS_SLIM
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_SEARCH_EXTENDED
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_SEARCH_SLIM
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_ISOLATED_MAPS_EXTENDED
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_ISOLATED_SEARCH_EXTENDED
|
|---|
| enumDescriptions | - Show Add recovery phone advice with variant 1 IFF user has no recovery option.
- Show Add recovery phone advice with no description variant 1 IFF user has no recovery option.
- Show Add recovery phone advice with gmail variant 1 IFF user has no recovery option.
- Show Add recovery phone advice with variant 1 IFF user has no recovery option. Never show badge.
- Show Add recovery phone advice IFF user has no recovery phone set.
- Show Add recovery phone advice IFF user has no recovery phone set.
- Show Add recovery phone photos variant advice IFF user has no recovery phone set.
- Show Add recovery phone drive variant advice IFF user has no recovery phone set.
- Show Add recovery phone gmail variant advice IFF user has no recovery phone set.
- Show Add recovery email advice IFF user has no recovery email and already has a recovery phone set.
- Show Add recovery email photos variant advice IFF user has no recovery email and already has a recovery phone set.
- Show Add recovery email drive variant advice IFF user has no recovery email and already has a recovery phone set.
- Show Add recovery email gmail variant advice IFF user has no recovery email and already has a recovery phone set.
- Show Add home address advice with variant 1 IFF user has no home address present.
- Show Add home address advice with variant 2 IFF user has no home address present.
- Show Add home address advice with maps variant 1 IFF user has no home address present.
- Show Add home address advice with maps variant 2 IFF user has no home address present.
- Show Add home address advice with search variant 1 IFF user has no home address present.
- Show Add home address advice with search variant 2 IFF user has no home address present.
- Show Add home address advice with maps variant 1 IFF user has no home address present with other non critical advice disabled.
- Show Add home address advice with search variant 1 IFF user has no home address present with other non critical advice disabled.
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
| context | | $ref | Context |
|---|
| description | Context of the triggering call, e.g. version/CL, platform, etc |
|---|
|
|---|
| surfaces | | description | List of surfaces to fetch messages for: OneGoogle account particle disk, OneGoogle account menu, etc |
|---|
| items | | enum | - SURFACE_UNSPECIFIED
- ACCOUNT_PARTICLE_DISC
- ACCOUNT_MENU
- BENTO_ACCOUNT_MENU
- BENTO_ACCOUNT_PARTICLE_DISC
|
|---|
| enumDescriptions | - Default value, should never be used
- OneGoogle account particle disc which will open SafetyExp account menu on tap.
- OneGoogle account menu only used for SafetyExp
- OneGoogle bento account menu
- OneGoogle account particle disc which will open Bento account menu on tap.
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
| triggeringEvent | | $ref | TriggeringEvent |
|---|
| description | The event that triggered the fetching, e.g. OneGoogle account menu has opened. Allows server to decide what data source to use (cached or live data) and what other actions to perform, e.g. dismiss the badge if account menu was open |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountMessagesResponse | | description | Response for the GetAccountMessages RPC |
|---|
| id | AccountMessagesResponse |
|---|
| properties | | accountAdvices | | description | List of active advices to show the user |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| accountMenu | | $ref | AccountMenu |
|---|
| description | Only used for SafetyExp |
|---|
|
|---|
| accountParticleDisc | |
|---|
| isServerDarkLaunch | | description | The server is currently in a ‘dark launch’ state. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountParticleDisc | | description | Data to render OneGoogle account particle disc |
|---|
| id | AccountParticleDisc |
|---|
| properties | | badgeDismissalEvents | | items | | enum | - BADGE_DISMISSAL_EVENT_UNSPECIFIED
- ACCOUNT_MENU_OPENED
|
|---|
| enumDescriptions | - Shouldn't be used
- User has opened account menu
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
| badgeStatus | | enum | - BADGE_STATUS_UNSPECIFIED
- NONE
- ATTENTION
|
|---|
| enumDescriptions | - No information about badge status
- No badge
- Attention badge (yellow)
|
|---|
| type | string |
|---|
|
|---|
| version | |
|---|
|
|---|
| type | object |
|---|
|
|---|
| AdditionalInfo | | description | Additional miscellaneous information included with the advice. |
|---|
| id | AdditionalInfo |
|---|
| properties | | numExistingRecoveryFactors | | description | Number of existing recovery factors the user has. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AdviceDestination | | description | Destination to open once Bento account advice CTA is clicked |
|---|
| id | AdviceDestination |
|---|
| properties | | resourceKey | | $ref | ResourceKey |
|---|
| description | Resource to open in the Google Account |
|---|
|
|---|
| url | | $ref | SafeUrlProto |
|---|
| description | URL to open in the browser |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AlertDestination | | description | Destination to open once OneGoogle account menu entrypoint is clicked |
|---|
| id | AlertDestination |
|---|
| properties | | resourceKey | | $ref | ResourceKey |
|---|
| description | Resource to open in the Google Account |
|---|
|
|---|
| url | | $ref | SafeUrlProto |
|---|
| description | URL to open in the browser |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AndroidClientVersion | | id | AndroidClientVersion |
|---|
| properties | | androidOsSdk | | description | The Android OS SDK version, e.g. 28 (Android 9 is SDK 28). |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| androidOsVersion | | description | The Android OS version, e.g. "5.1.1" |
|---|
| type | string |
|---|
|
|---|
| callingAndroidApp | | description | ApplicationId (package name) or alias of the app that initiated the request |
|---|
| type | string |
|---|
|
|---|
| gmscoreVersionCode | | description | GmsCore version code which is defined in google3/java/com/google/android/gmscore/integ/package/common-base/src/com/google/android/gms/common/util/VersionUtils.java getVersionCode(), e.g. 18477021 |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| gmscoreVersionName | | description | GmsCore info which is defined in google3/java/com/google/android/gmscore/integ/package/common-base/src/com/google/android/gms/common/util/VersionUtils.java getVersionName(), e.g. "18.4.77 (eng-040408-254230773)" |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Context | | description | The version of a specific piece of client software. Used mainly for logging, metrics and debugging. Can be used in future for graceful degradation of features for outdated client versions |
|---|
| id | Context |
|---|
| properties | | androidClientVersion | |
|---|
| hideEntryPointIfViewed | | description | If true, don't show EP once Y days have passed since the user viewed it. |
|---|
| type | boolean |
|---|
|
|---|
| hideEntryPointIfVisited | | description | If true, don't show EP once X days have passed since the user clicked it. |
|---|
| type | boolean |
|---|
|
|---|
| iosClientVersion | |
|---|
| isClientDarkLaunch | | description | The client is currently in a ‘dark launch’ state. |
|---|
| type | boolean |
|---|
|
|---|
| webClientVersion | |
|---|
|
|---|
| type | object |
|---|
|
|---|
| IOSClientVersion | | id | IOSClientVersion |
|---|
| properties | | 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 |
|---|
|
|---|
| iosBuildChangelist | | description | Changelist that this client was built at. Obtained from google3/googlemac/Shared/Metrics/Phenotype/Classes/PHTPhenotypeBuildData.h |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| OneGoogleTriggeringEvent | | description | OneGoogle specific event that triggered client to fetch the data |
|---|
| id | OneGoogleTriggeringEvent |
|---|
| properties | | reason | | description | Enum describing the reason for the triggering event, e.g. account menu open |
|---|
| enum | - ONE_GOOGLE_TRIGGERING_EVENT_REASON_UNSPECIFIED
- ACCOUNT_MENU_OPENED
- ACCOUNT_SWITCHED
- PERIODIC_POLL
- TICKLE_RECEIVED
- TAB_SWITCH
- SECURITY_ADVISOR_FLOW_COMPLETED
- WEB_PAGE_LOAD
|
|---|
| enumDescriptions | - Default value, should never be used
- User has opened account menu
- User has switched the account
- Library initiated periodic poll
- Library received a tickle to invalidate the state
- User switched tab (using visibility API).
- Security Advisor flow was completed. Only implemented on iOS.
- The page was loaded and APD was rendered. See go/og-badge-ads.
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| 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 |
|---|
|
|---|
| SafeUrlProto | | description | Message containing a string that is safe to use in URL contexts in DOM APIs and HTML documents, where the URL context does not refer to a resource that loads code. |
|---|
| id | SafeUrlProto |
|---|
| properties | | privateDoNotAccessOrElseSafeUrlWrappedValue | | description | IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| TriggeringEvent | | description | Event that triggered client to fetch the data |
|---|
| id | TriggeringEvent |
|---|
| properties | | onegoogleTriggeringEvent | | $ref | OneGoogleTriggeringEvent |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| UpdateAccountMessagesRequest | | description | Request for the UpdateAccountMessages RPC |
|---|
| id | UpdateAccountMessagesRequest |
|---|
| properties | | dismissedAdviceIds | | description | List of advices which are dismissed in this request. E.g. when user explicitly clicked on "Not now/Dismiss" to dismiss the advice screen/7vixUwswqjT7APa |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| UpdateAccountMessagesResponse | | description | Response for the UpdateAccountMessages RPC. Empty response means success |
|---|
| id | UpdateAccountMessagesResponse |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| Version | | description | A version of account particle disc status that is opaque to the client. To be defined by server and passed to client to pass it back, when needed |
|---|
| id | Version |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| WebClientVersion | | id | WebClientVersion |
|---|
| properties | | buildLabel | | description | Label associated with the build of this binary. See google3/java/com/google/apps/framework/blaze/ImmutableBuildData.kt |
|---|
| type | string |
|---|
|
|---|
| cachedAlertLevel | | description | AlertLevel web client obtained from OGS. This will be used to compare OGS's AlertLevel generation logic with RPS's AlertLevel generation logic. Web client will populate this field on first AM open of their session. See go/safetyexp-state-mismatch |
|---|
| enum | - ALERT_LEVEL_UNSPECIFIED
- NO_ADVICE
- ADVICE
- ADVICE_REQUIRING_ATTENTION
|
|---|
| enumDescriptions | - No information about alert level
- No advice — account is in a good shape
- There is advice available
- There is advice that require attention
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
|
|---|
|
|---|
| root['title'] | | new_value | Account Settings Mobile Private API (Autopush) |
|---|
| old_value | Reach Private API (Staging) |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-reach-pa-v1 | | dictionary_item_removed | - root['fullyEncodeReservedExpansion']
|
|---|
| values_changed | | root['baseUrl'] | | new_value | https://autopush-accountsettingsmobile-pa.sandbox.googleapis.com/ |
|---|
| old_value | https://staging-reach-pa.sandbox.googleapis.com/ |
|---|
|
|---|
| root['canonicalName'] | | new_value | Account Settings Mobile |
|---|
| old_value | Reach Presentation Service |
|---|
|
|---|
| root['description'] | | new_value | An API which services Google account settings UIs on Android and iOS. |
|---|
| old_value | reach-pa.googleapis.com API. |
|---|
|
|---|
| root['documentationLink'] | | new_value | http://go/asm |
|---|
| old_value | http://go/safetyexp-entry-point-dd |
|---|
|
|---|
| root['id'] | | new_value | autopush_accountsettingsmobile_pa_sandbox:v1 |
|---|
| old_value | reach_pa:v1 |
|---|
|
|---|
| root['mtlsRootUrl'] | | new_value | https://autopush-accountsettingsmobile-pa.mtls.sandbox.googleapis.com/ |
|---|
| old_value | https://staging-reach-pa.mtls.sandbox.googleapis.com/ |
|---|
|
|---|
| root['name'] | | new_value | autopush_accountsettingsmobile_pa_sandbox |
|---|
| old_value | reach_pa |
|---|
|
|---|
| root['resources']['v1']['methods'] | | new_value | | getClientConfig | | description | Requests config data for iOS clients. |
|---|
| flatPath | v1:getClientConfig |
|---|
| httpMethod | POST |
|---|
| id | autopush_accountsettingsmobile_pa_sandbox.getClientConfig |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getClientConfig |
|---|
| request | | $ref | GetClientConfigRequest |
|---|
|
|---|
| response | | $ref | GetClientConfigResponse |
|---|
|
|---|
|
|---|
| getResource | | description | Requests a resource. |
|---|
| flatPath | v1:getResource |
|---|
| httpMethod | POST |
|---|
| id | autopush_accountsettingsmobile_pa_sandbox.getResource |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getResource |
|---|
| request | |
|---|
| response | |
|---|
|
|---|
| getScreen | | description | Requests a screen. |
|---|
| flatPath | v1:getScreen |
|---|
| httpMethod | POST |
|---|
| id | autopush_accountsettingsmobile_pa_sandbox.getScreen |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getScreen |
|---|
| request | |
|---|
| response | |
|---|
|
|---|
| getSignedOutResource | | description | Requests a resource from a signed-out context. |
|---|
| flatPath | v1:getSignedOutResource |
|---|
| httpMethod | POST |
|---|
| id | autopush_accountsettingsmobile_pa_sandbox.getSignedOutResource |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getSignedOutResource |
|---|
| request | | $ref | GetSignedOutResourceRequest |
|---|
|
|---|
| response | | $ref | GetSignedOutResourceResponse |
|---|
|
|---|
|
|---|
| prefetchRelatedScreens | | description | Requests a list of screens which are related to a specified one, with the purpose of prefetching them in the client application. |
|---|
| flatPath | v1:prefetchRelatedScreens |
|---|
| httpMethod | POST |
|---|
| id | autopush_accountsettingsmobile_pa_sandbox.prefetchRelatedScreens |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:prefetchRelatedScreens |
|---|
| request | | $ref | PrefetchRelatedScreensRequest |
|---|
|
|---|
| response | | $ref | PrefetchRelatedScreensResponse |
|---|
|
|---|
|
|---|
| search | | description | Searches through resources |
|---|
| flatPath | v1:search |
|---|
| httpMethod | POST |
|---|
| id | autopush_accountsettingsmobile_pa_sandbox.search |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:search |
|---|
| request | |
|---|
| response | |
|---|
|
|---|
| setResourceDismissalState | | description | Sets the resource state, e.g. resource is dismissed |
|---|
| flatPath | v1:setResourceDismissalState |
|---|
| httpMethod | POST |
|---|
| id | autopush_accountsettingsmobile_pa_sandbox.setResourceDismissalState |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:setResourceDismissalState |
|---|
| request | | $ref | SetResourceDismissalStateRequest |
|---|
|
|---|
| response | | $ref | SetResourceDismissalStateResponse |
|---|
|
|---|
|
|---|
|
|---|
| old_value | | getAccountMessages | | description | Fetches user's current advice state, potentially updates respective badge dismissal |
|---|
| flatPath | v1:getAccountMessages |
|---|
| httpMethod | POST |
|---|
| id | reach_pa.getAccountMessages |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getAccountMessages |
|---|
| request | | $ref | AccountMessagesRequest |
|---|
|
|---|
| response | | $ref | AccountMessagesResponse |
|---|
|
|---|
|
|---|
| updateAccountMessages | | description | Updates user's current advice state, like updating the advice dismissal status |
|---|
| flatPath | v1:updateAccountMessages |
|---|
| httpMethod | POST |
|---|
| id | reach_pa.updateAccountMessages |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:updateAccountMessages |
|---|
| request | | $ref | UpdateAccountMessagesRequest |
|---|
|
|---|
| response | | $ref | UpdateAccountMessagesResponse |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
| root['rootUrl'] | | new_value | https://autopush-accountsettingsmobile-pa.sandbox.googleapis.com/ |
|---|
| old_value | https://staging-reach-pa.sandbox.googleapis.com/ |
|---|
|
|---|
| root['schemas'] | | new_value | | 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 |
|---|
|
|---|
|
|---|
| old_value | | AccountAdvice | | description | Data to render OneGoogle bento account advice |
|---|
| id | AccountAdvice |
|---|
| properties | | additionalInfo | | $ref | AdditionalInfo |
|---|
| description | Optional additional information included with the advice. Currently only used for recovery factor advice. |
|---|
|
|---|
| adviceId | | description | Unique identifier of the advice type. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| ctaText | | description | Text to display on the CTA button. |
|---|
| type | string |
|---|
|
|---|
| description | | description | Description of the advice. |
|---|
| type | string |
|---|
|
|---|
| destination | | $ref | AdviceDestination |
|---|
| description | Destination to open once Bento account advice CTA is clicked |
|---|
|
|---|
| dismissalText | | description | Text to display on the dismissal button. |
|---|
| type | string |
|---|
|
|---|
| title | | description | Title of the advice. |
|---|
| type | string |
|---|
|
|---|
| uiTreatment | | description | UI treatment of the advice. |
|---|
| enum | - UI_TREATMENT_UNSPECIFIED
- YELLOW_CARD
- BLUE_CARD_SLIM
- BLUE_CARD_EXTENDED
|
|---|
| enumDescriptions | - No information about UI treatment, should never be used.
- Yellow card UI treatment for recovery phone advice.
- Blue card slim version UI treatment for home address advice.
- Blue card extended version UI treatment for home address advice.
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountMenu | | description | Data to render OneGoogle account menu only for SafetyExp |
|---|
| id | AccountMenu |
|---|
| properties | | alertLevel | | enum | - ALERT_LEVEL_UNSPECIFIED
- NO_ADVICE
- ADVICE
- ADVICE_REQUIRING_ATTENTION
|
|---|
| enumDescriptions | - No information about alert level
- No advice — account is in a good shape
- There is advice available
- There is advice that require attention
|
|---|
| type | string |
|---|
|
|---|
| destination | |
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountMessagesRequest | | description | Request for the GetAccountMessages RPC |
|---|
| id | AccountMessagesRequest |
|---|
| properties | | accountParticleDiscVersion | | $ref | Version |
|---|
| description | Version of the AccountParticleDisc that is currently present on the device, iff present. |
|---|
|
|---|
| adviceFlavours | | description | The flavour of advice applicable to the request. Response data will be accordingly produced. |
|---|
| items | | enum | - UNSPECIFIED_ADVICE_FLAVOUR
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_VARIANT_1
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_NO_DESCRIPTION_VARIANT_1
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_GMAIL_VARIANT_1
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_NO_BADGE_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_VARIANT_2
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_PHOTOS_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_DRIVE_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_GMAIL_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_PHOTOS_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_DRIVE_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_GMAIL_VARIANT_1
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_VARIANT_1
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_VARIANT_2
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_MAPS_EXTENDED
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_MAPS_SLIM
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_SEARCH_EXTENDED
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_SEARCH_SLIM
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_ISOLATED_MAPS_EXTENDED
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_ISOLATED_SEARCH_EXTENDED
|
|---|
| enumDescriptions | - Show Add recovery phone advice with variant 1 IFF user has no recovery option.
- Show Add recovery phone advice with no description variant 1 IFF user has no recovery option.
- Show Add recovery phone advice with gmail variant 1 IFF user has no recovery option.
- Show Add recovery phone advice with variant 1 IFF user has no recovery option. Never show badge.
- Show Add recovery phone advice IFF user has no recovery phone set.
- Show Add recovery phone advice IFF user has no recovery phone set.
- Show Add recovery phone photos variant advice IFF user has no recovery phone set.
- Show Add recovery phone drive variant advice IFF user has no recovery phone set.
- Show Add recovery phone gmail variant advice IFF user has no recovery phone set.
- Show Add recovery email advice IFF user has no recovery email and already has a recovery phone set.
- Show Add recovery email photos variant advice IFF user has no recovery email and already has a recovery phone set.
- Show Add recovery email drive variant advice IFF user has no recovery email and already has a recovery phone set.
- Show Add recovery email gmail variant advice IFF user has no recovery email and already has a recovery phone set.
- Show Add home address advice with variant 1 IFF user has no home address present.
- Show Add home address advice with variant 2 IFF user has no home address present.
- Show Add home address advice with maps variant 1 IFF user has no home address present.
- Show Add home address advice with maps variant 2 IFF user has no home address present.
- Show Add home address advice with search variant 1 IFF user has no home address present.
- Show Add home address advice with search variant 2 IFF user has no home address present.
- Show Add home address advice with maps variant 1 IFF user has no home address present with other non critical advice disabled.
- Show Add home address advice with search variant 1 IFF user has no home address present with other non critical advice disabled.
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
| context | | $ref | Context |
|---|
| description | Context of the triggering call, e.g. version/CL, platform, etc |
|---|
|
|---|
| surfaces | | description | List of surfaces to fetch messages for: OneGoogle account particle disk, OneGoogle account menu, etc |
|---|
| items | | enum | - SURFACE_UNSPECIFIED
- ACCOUNT_PARTICLE_DISC
- ACCOUNT_MENU
- BENTO_ACCOUNT_MENU
- BENTO_ACCOUNT_PARTICLE_DISC
|
|---|
| enumDescriptions | - Default value, should never be used
- OneGoogle account particle disc which will open SafetyExp account menu on tap.
- OneGoogle account menu only used for SafetyExp
- OneGoogle bento account menu
- OneGoogle account particle disc which will open Bento account menu on tap.
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
| triggeringEvent | | $ref | TriggeringEvent |
|---|
| description | The event that triggered the fetching, e.g. OneGoogle account menu has opened. Allows server to decide what data source to use (cached or live data) and what other actions to perform, e.g. dismiss the badge if account menu was open |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountMessagesResponse | | description | Response for the GetAccountMessages RPC |
|---|
| id | AccountMessagesResponse |
|---|
| properties | | accountAdvices | | description | List of active advices to show the user |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| accountMenu | | $ref | AccountMenu |
|---|
| description | Only used for SafetyExp |
|---|
|
|---|
| accountParticleDisc | |
|---|
| isServerDarkLaunch | | description | The server is currently in a ‘dark launch’ state. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountParticleDisc | | description | Data to render OneGoogle account particle disc |
|---|
| id | AccountParticleDisc |
|---|
| properties | | badgeDismissalEvents | | items | | enum | - BADGE_DISMISSAL_EVENT_UNSPECIFIED
- ACCOUNT_MENU_OPENED
|
|---|
| enumDescriptions | - Shouldn't be used
- User has opened account menu
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
| badgeStatus | | enum | - BADGE_STATUS_UNSPECIFIED
- NONE
- ATTENTION
|
|---|
| enumDescriptions | - No information about badge status
- No badge
- Attention badge (yellow)
|
|---|
| type | string |
|---|
|
|---|
| version | |
|---|
|
|---|
| type | object |
|---|
|
|---|
| AdditionalInfo | | description | Additional miscellaneous information included with the advice. |
|---|
| id | AdditionalInfo |
|---|
| properties | | numExistingRecoveryFactors | | description | Number of existing recovery factors the user has. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AdviceDestination | | description | Destination to open once Bento account advice CTA is clicked |
|---|
| id | AdviceDestination |
|---|
| properties | | resourceKey | | $ref | ResourceKey |
|---|
| description | Resource to open in the Google Account |
|---|
|
|---|
| url | | $ref | SafeUrlProto |
|---|
| description | URL to open in the browser |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AlertDestination | | description | Destination to open once OneGoogle account menu entrypoint is clicked |
|---|
| id | AlertDestination |
|---|
| properties | | resourceKey | | $ref | ResourceKey |
|---|
| description | Resource to open in the Google Account |
|---|
|
|---|
| url | | $ref | SafeUrlProto |
|---|
| description | URL to open in the browser |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AndroidClientVersion | | id | AndroidClientVersion |
|---|
| properties | | androidOsSdk | | description | The Android OS SDK version, e.g. 28 (Android 9 is SDK 28). |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| androidOsVersion | | description | The Android OS version, e.g. "5.1.1" |
|---|
| type | string |
|---|
|
|---|
| callingAndroidApp | | description | ApplicationId (package name) or alias of the app that initiated the request |
|---|
| type | string |
|---|
|
|---|
| gmscoreVersionCode | | description | GmsCore version code which is defined in google3/java/com/google/android/gmscore/integ/package/common-base/src/com/google/android/gms/common/util/VersionUtils.java getVersionCode(), e.g. 18477021 |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| gmscoreVersionName | | description | GmsCore info which is defined in google3/java/com/google/android/gmscore/integ/package/common-base/src/com/google/android/gms/common/util/VersionUtils.java getVersionName(), e.g. "18.4.77 (eng-040408-254230773)" |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Context | | description | The version of a specific piece of client software. Used mainly for logging, metrics and debugging. Can be used in future for graceful degradation of features for outdated client versions |
|---|
| id | Context |
|---|
| properties | | androidClientVersion | |
|---|
| hideEntryPointIfViewed | | description | If true, don't show EP once Y days have passed since the user viewed it. |
|---|
| type | boolean |
|---|
|
|---|
| hideEntryPointIfVisited | | description | If true, don't show EP once X days have passed since the user clicked it. |
|---|
| type | boolean |
|---|
|
|---|
| iosClientVersion | |
|---|
| isClientDarkLaunch | | description | The client is currently in a ‘dark launch’ state. |
|---|
| type | boolean |
|---|
|
|---|
| webClientVersion | |
|---|
|
|---|
| type | object |
|---|
|
|---|
| IOSClientVersion | | id | IOSClientVersion |
|---|
| properties | | 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 |
|---|
|
|---|
| iosBuildChangelist | | description | Changelist that this client was built at. Obtained from google3/googlemac/Shared/Metrics/Phenotype/Classes/PHTPhenotypeBuildData.h |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| OneGoogleTriggeringEvent | | description | OneGoogle specific event that triggered client to fetch the data |
|---|
| id | OneGoogleTriggeringEvent |
|---|
| properties | | reason | | description | Enum describing the reason for the triggering event, e.g. account menu open |
|---|
| enum | - ONE_GOOGLE_TRIGGERING_EVENT_REASON_UNSPECIFIED
- ACCOUNT_MENU_OPENED
- ACCOUNT_SWITCHED
- PERIODIC_POLL
- TICKLE_RECEIVED
- TAB_SWITCH
- SECURITY_ADVISOR_FLOW_COMPLETED
- WEB_PAGE_LOAD
|
|---|
| enumDescriptions | - Default value, should never be used
- User has opened account menu
- User has switched the account
- Library initiated periodic poll
- Library received a tickle to invalidate the state
- User switched tab (using visibility API).
- Security Advisor flow was completed. Only implemented on iOS.
- The page was loaded and APD was rendered. See go/og-badge-ads.
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| 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 |
|---|
|
|---|
| SafeUrlProto | | description | Message containing a string that is safe to use in URL contexts in DOM APIs and HTML documents, where the URL context does not refer to a resource that loads code. |
|---|
| id | SafeUrlProto |
|---|
| properties | | privateDoNotAccessOrElseSafeUrlWrappedValue | | description | IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| TriggeringEvent | | description | Event that triggered client to fetch the data |
|---|
| id | TriggeringEvent |
|---|
| properties | | onegoogleTriggeringEvent | | $ref | OneGoogleTriggeringEvent |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| UpdateAccountMessagesRequest | | description | Request for the UpdateAccountMessages RPC |
|---|
| id | UpdateAccountMessagesRequest |
|---|
| properties | | dismissedAdviceIds | | description | List of advices which are dismissed in this request. E.g. when user explicitly clicked on "Not now/Dismiss" to dismiss the advice screen/7vixUwswqjT7APa |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| UpdateAccountMessagesResponse | | description | Response for the UpdateAccountMessages RPC. Empty response means success |
|---|
| id | UpdateAccountMessagesResponse |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| Version | | description | A version of account particle disc status that is opaque to the client. To be defined by server and passed to client to pass it back, when needed |
|---|
| id | Version |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| WebClientVersion | | id | WebClientVersion |
|---|
| properties | | buildLabel | | description | Label associated with the build of this binary. See google3/java/com/google/apps/framework/blaze/ImmutableBuildData.kt |
|---|
| type | string |
|---|
|
|---|
| cachedAlertLevel | | description | AlertLevel web client obtained from OGS. This will be used to compare OGS's AlertLevel generation logic with RPS's AlertLevel generation logic. Web client will populate this field on first AM open of their session. See go/safetyexp-state-mismatch |
|---|
| enum | - ALERT_LEVEL_UNSPECIFIED
- NO_ADVICE
- ADVICE
- ADVICE_REQUIRING_ATTENTION
|
|---|
| enumDescriptions | - No information about alert level
- No advice — account is in a good shape
- There is advice available
- There is advice that require attention
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
|
|---|
|
|---|
| root['title'] | | new_value | Account Settings Mobile Private API (Autopush) |
|---|
| old_value | Reach Private API (Staging) |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-secureconnect-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-secureconnect-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-tenor- | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-tenor-v1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-tenor-v2 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-youtube- | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-youtube-v1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/autopush-youtube-v3 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/canary-spot-pa- | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250508 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/canary-spot-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250508 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/cloud-speech-staging- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/cloud-speech-staging-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/cloud-speech-staging-v1p1beta1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/cloud-speech-staging-v2 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/cloud-speech-test- | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/cloud-speech-test-v1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/cloud-speech-test-v1p1beta1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/cloud-speech-test-v2 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/content-autopush-notifications-pa- | | dictionary_item_added | - root['schemas']['GoogleLogsTapandpayAndroid_Tp2AppLogEvent_WearExpressTransit']
- root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['properties']['wearExpressTransit']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['description'] | | new_value | Top-level extension to be reported Next id: 210 |
|---|
| old_value | Top-level extension to be reported Next id: 209 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['ComGoogleCommerceTapandpayNotifications_TapAndPayNotificationAppPayload_TokenProvisioningData']['properties']['paymentBundleType']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['GoogleInternalTapandpayV1__CheckEligibilityRequest']['properties']['supportedPaymentBundleTypes']['items']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__MdocPresentationEvent']['properties']['presentationType']['enum'][6] | CREDMAN_IN_APP_OPENID4VP_DRAFT24 |
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__MdocPresentationEvent']['properties']['presentationType']['enum'][7] | CREDMAN_WEB_OPENID4VP_DRAFT24 |
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__SettingState']['properties']['setting']['enum'][23] | WEAR_AUTH_REQUIRED_OPEN_LOOP_TRANSIT |
|---|
| root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enum'][6] | MAGIC_ENHANCE |
|---|
| root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][6] | Represents the Magic Enhance editing effect from Conversational Editing. Note as of 2025/05/13, Magic Enhance in Magic Editor is mapped to MAGIC_EDITOR, not this enum. http://google3/googlex/gcam/creative_camera/intuitive_editing/conversational_editing/common/abstract_syntax_tree.proto?q=symbol:%5CbFN_ENHANCE%5Cb |
|---|
| root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1086] | FINANCE_WATCHLIST_WIDGET |
|---|
| root['schemas']['Tapandpay_TokenizationOperationRequest_TokenizeCard']['properties']['auxiliaryPaymentBundleType']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['Tapandpay_TokenizationOperationRequest_TokenizeCard']['properties']['paymentBundleType']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['WalletGooglepayFrontendApiTransactions_CoreTransaction_SecureDataKey']['properties']['secureDataType']['enum'][12] | COURIER_IN_SESSION_TRANSIT_OPAQUE_AUTHENTICATION_CREDENTIAL |
|---|
| root['schemas']['WalletGooglepayFrontendApiTransactions_CoreTransaction_SecureDataKey']['properties']['secureDataType']['enumDescriptions'][12] | Opaque account credential used to provision transit private label cards. See go/transit-plc-native-provisioning for details. |
|---|
|
|---|
|
|---|
| sandbox/content-autopush-notifications-pa-v1 | | dictionary_item_added | - root['schemas']['GoogleLogsTapandpayAndroid_Tp2AppLogEvent_WearExpressTransit']
- root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['properties']['wearExpressTransit']
- root['schemas']['GoogleLogsTapandpayAndroid__TransitHceSessionEvent']['properties']['provisioningAndroidProfileOrigin']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['description'] | | new_value | Top-level extension to be reported Next id: 210 |
|---|
| old_value | Top-level extension to be reported Next id: 209 |
|---|
|
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__TransitHceSessionEvent']['description'] | | new_value | Event related to communication over NFC using close loop transit tap. Next id: 34 |
|---|
| old_value | Event related to communication over NFC using close loop transit tap. Next id: 33 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['ComGoogleCommerceTapandpayNotifications_TapAndPayNotificationAppPayload_TokenProvisioningData']['properties']['paymentBundleType']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['GoogleInternalTapandpayV1__CheckEligibilityRequest']['properties']['supportedPaymentBundleTypes']['items']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__MdocPresentationEvent']['properties']['presentationType']['enum'][6] | CREDMAN_IN_APP_OPENID4VP_DRAFT24 |
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__MdocPresentationEvent']['properties']['presentationType']['enum'][7] | CREDMAN_WEB_OPENID4VP_DRAFT24 |
|---|
| root['schemas']['GoogleLogsTapandpayAndroid__SettingState']['properties']['setting']['enum'][23] | WEAR_AUTH_REQUIRED_OPEN_LOOP_TRANSIT |
|---|
| root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enum'][6] | MAGIC_ENHANCE |
|---|
| root['schemas']['PhotosEffects__NonSerializableEffectParams']['properties']['effects']['items']['enumDescriptions'][6] | Represents the Magic Enhance editing effect from Conversational Editing. Note as of 2025/05/13, Magic Enhance in Magic Editor is mapped to MAGIC_EDITOR, not this enum. http://google3/googlex/gcam/creative_camera/intuitive_editing/conversational_editing/common/abstract_syntax_tree.proto?q=symbol:%5CbFN_ENHANCE%5Cb |
|---|
| root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][442] | CONTENT_EXPLORATION_SFV |
|---|
| root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][442] | For exploring new short video content. go/discover-exploration-dd。 |
|---|
| root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1086] | FINANCE_WATCHLIST_WIDGET |
|---|
| root['schemas']['Tapandpay_TokenizationOperationRequest_TokenizeCard']['properties']['auxiliaryPaymentBundleType']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['Tapandpay_TokenizationOperationRequest_TokenizeCard']['properties']['paymentBundleType']['enum'][31] | CANONICAL_CPACE_BUNDLE |
|---|
| root['schemas']['WalletGooglepayFrontendApiTransactions_CoreTransaction_SecureDataKey']['properties']['secureDataType']['enum'][12] | COURIER_IN_SESSION_TRANSIT_OPAQUE_AUTHENTICATION_CREDENTIAL |
|---|
| root['schemas']['WalletGooglepayFrontendApiTransactions_CoreTransaction_SecureDataKey']['properties']['secureDataType']['enumDescriptions'][12] | Opaque account credential used to provision transit private label cards. See go/transit-plc-native-provisioning for details. |
|---|
|
|---|
|
|---|
| sandbox/content-autopush-people-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['InternalExternal']['properties']['application']['enum'][460] | MSS_JUPITER |
|---|
|
|---|
|
|---|
| sandbox/content-autopush-people-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['InternalExternal']['properties']['application']['enum'][460] | MSS_JUPITER |
|---|
|
|---|
|
|---|
| sandbox/content-autopush-people-pa-v2 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['InternalExternal']['properties']['application']['enum'][460] | MSS_JUPITER |
|---|
|
|---|
|
|---|
| sandbox/content-autopush-youtube- | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/content-autopush-youtube-v1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/content-autopush-youtube-v3 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/content-staging-testing- | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250508 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/content-staging-testing-v1 | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250508 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/daily-3-paisa-pa- | | dictionary_item_added | - root['schemas']['GoogleInternalPaisaV1Presentation.CreditMoneySectionConfig_NudgeFabCondition']
- root['schemas']['PaisaLogs._FopModuleCellV2Data']
- root['schemas']['PaisaLogs._IssuerDisplayInfoConsistency']
- root['schemas']['GoogleInternalPaisaV1Presentation._CreditMoneySectionConfig']['properties']['nudgeFabConditions']
- root['schemas']['NbuPaisaFrontendActions.PayflowPageParams_BottomSheetSupplementaryInfo']['properties']['visualElementId']
- root['schemas']['PaisaLogs._PaisaVisualElementMetadata']['properties']['fopModuleCellV2Data']
- root['schemas']['PaisaLogs._PaisaVisualElementMetadata']['properties']['issuerDisplayInfoConsistency']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250506 |
|---|
|
|---|
| root['schemas']['PaisaLogs._PaisaVisualElementMetadata']['description'] | | new_value | Visual elements metadata for NBU Paisa app (go/paisa-ve2). All Metadata related to Visual Elements in Paisa app go here. IMPORTANT: All new extensions should be added into the {@link wireless_android_play_playlog.MessagesUsedAsWeakFieldsOrExtensions} to be statically linked into ClearCut c++ binaries. NextId: 299 |
|---|
| old_value | Visual elements metadata for NBU Paisa app (go/paisa-ve2). All Metadata related to Visual Elements in Paisa app go here. IMPORTANT: All new extensions should be added into the {@link wireless_android_play_playlog.MessagesUsedAsWeakFieldsOrExtensions} to be statically linked into ClearCut c++ binaries. NextId: 297 |
|---|
|
|---|
| root['schemas']['Geostore._InternalSourceSummaryProto']['properties']['provider']['enumDescriptions'][14] | | new_value | All new "Google" provider entries must be full ints. The next available ID is: 0x111730CA |
|---|
| old_value | All new "Google" provider entries must be full ints. The next available ID is: 0x111730C9 |
|---|
|
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enumDescriptions'][162] | | new_value | Source based enrollment for Tap & Pay Arm2. b/408906218 |
|---|
| old_value | Source based enrollment for Tap & Pay. b/408906218 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['Geostore._InternalSourceSummaryProto']['properties']['provider']['enum'][204] | PROVIDER_GOOGLE_MAP_GEOMETRY_TEAM |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enum'][164] | TAP_AND_PAY_SOURCE_BASED_OFFER_ARM1 |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enum'][165] | TAP_AND_PAY_SOURCE_BASED_OFFER_ARM3 |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enumDescriptions'][164] | Source based enrollment for Tap & Pay Arm1. b/408906218 |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enumDescriptions'][165] | Source based enrollment for Tap & Pay Arm3. b/408906218 |
|---|
| root['schemas']['NbuPaisaFrontendBillpay._OperatorCategory']['properties']['type']['enumDescriptions'][12] | Please use MOBILE instead. |
|---|
| root['schemas']['PaisaLogs._BillPayConversationMetadata']['properties']['operatorCategoryType']['enumDescriptions'][12] | Please use MOBILE instead. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][9] | APPROVE_RELATIONSHIP_FULL_DELEGATE |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][10] | REJECT_RELATIONSHIP_FULL_DELEGATE |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][11] | DELETE_RELATIONSHIP_PARTIAL_DELEGATE_ENABLER |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][12] | DELETE_RELATIONSHIP_PARTIAL_DELEGATE_DEPENDANT |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][13] | DELETE_RELATIONSHIP_FULL_DELEGATE_ENABLER |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][14] | DELETE_RELATIONSHIP_FULL_DELEGATE_DEPENDANT |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][9] | Dependent approves full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][10] | Dependent rejects full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][11] | Enabler deletes partial delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][12] | Dependent deletes partial delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][13] | Enabler deletes full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][14] | Dependent deletes full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._MobilePlanCategoryData']['properties']['categoryType']['enum'][68] | UNLIMITED_5G |
|---|
| root['schemas']['PaisaLogs._MobilePlanCategoryData']['properties']['categoryType']['enumDescriptions'][68] | 5G Unlimited |
|---|
| root['schemas']['PaisaLogs._SubscriptionFlowData']['properties']['operatorCategoryType']['enumDescriptions'][12] | Please use MOBILE instead. |
|---|
|
|---|
|
|---|
| sandbox/daily-3-paisa-pa-v1 | | dictionary_item_added | - root['schemas']['GoogleInternalPaisaV1Presentation.CreditMoneySectionConfig_NudgeFabCondition']
- root['schemas']['PaisaLogs._FopModuleCellV2Data']
- root['schemas']['PaisaLogs._IssuerDisplayInfoConsistency']
- root['schemas']['GoogleInternalPaisaV1Presentation._CreditMoneySectionConfig']['properties']['nudgeFabConditions']
- root['schemas']['NbuPaisaFrontendActions.PayflowPageParams_BottomSheetSupplementaryInfo']['properties']['visualElementId']
- root['schemas']['PaisaLogs._PaisaVisualElementMetadata']['properties']['fopModuleCellV2Data']
- root['schemas']['PaisaLogs._PaisaVisualElementMetadata']['properties']['issuerDisplayInfoConsistency']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250506 |
|---|
|
|---|
| root['schemas']['PaisaLogs._PaisaVisualElementMetadata']['description'] | | new_value | Visual elements metadata for NBU Paisa app (go/paisa-ve2). All Metadata related to Visual Elements in Paisa app go here. IMPORTANT: All new extensions should be added into the {@link wireless_android_play_playlog.MessagesUsedAsWeakFieldsOrExtensions} to be statically linked into ClearCut c++ binaries. NextId: 299 |
|---|
| old_value | Visual elements metadata for NBU Paisa app (go/paisa-ve2). All Metadata related to Visual Elements in Paisa app go here. IMPORTANT: All new extensions should be added into the {@link wireless_android_play_playlog.MessagesUsedAsWeakFieldsOrExtensions} to be statically linked into ClearCut c++ binaries. NextId: 297 |
|---|
|
|---|
| root['schemas']['Geostore._InternalSourceSummaryProto']['properties']['provider']['enumDescriptions'][14] | | new_value | All new "Google" provider entries must be full ints. The next available ID is: 0x111730CA |
|---|
| old_value | All new "Google" provider entries must be full ints. The next available ID is: 0x111730C9 |
|---|
|
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enumDescriptions'][162] | | new_value | Source based enrollment for Tap & Pay Arm2. b/408906218 |
|---|
| old_value | Source based enrollment for Tap & Pay. b/408906218 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['Geostore._InternalSourceSummaryProto']['properties']['provider']['enum'][204] | PROVIDER_GOOGLE_MAP_GEOMETRY_TEAM |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enum'][164] | TAP_AND_PAY_SOURCE_BASED_OFFER_ARM1 |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enum'][165] | TAP_AND_PAY_SOURCE_BASED_OFFER_ARM3 |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enumDescriptions'][164] | Source based enrollment for Tap & Pay Arm1. b/408906218 |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enumDescriptions'][165] | Source based enrollment for Tap & Pay Arm3. b/408906218 |
|---|
| root['schemas']['NbuPaisaFrontendBillpay._OperatorCategory']['properties']['type']['enumDescriptions'][12] | Please use MOBILE instead. |
|---|
| root['schemas']['PaisaLogs._BillPayConversationMetadata']['properties']['operatorCategoryType']['enumDescriptions'][12] | Please use MOBILE instead. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][9] | APPROVE_RELATIONSHIP_FULL_DELEGATE |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][10] | REJECT_RELATIONSHIP_FULL_DELEGATE |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][11] | DELETE_RELATIONSHIP_PARTIAL_DELEGATE_ENABLER |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][12] | DELETE_RELATIONSHIP_PARTIAL_DELEGATE_DEPENDANT |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][13] | DELETE_RELATIONSHIP_FULL_DELEGATE_ENABLER |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][14] | DELETE_RELATIONSHIP_FULL_DELEGATE_DEPENDANT |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][9] | Dependent approves full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][10] | Dependent rejects full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][11] | Enabler deletes partial delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][12] | Dependent deletes partial delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][13] | Enabler deletes full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][14] | Dependent deletes full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._MobilePlanCategoryData']['properties']['categoryType']['enum'][68] | UNLIMITED_5G |
|---|
| root['schemas']['PaisaLogs._MobilePlanCategoryData']['properties']['categoryType']['enumDescriptions'][68] | 5G Unlimited |
|---|
| root['schemas']['PaisaLogs._SubscriptionFlowData']['properties']['operatorCategoryType']['enumDescriptions'][12] | Please use MOBILE instead. |
|---|
|
|---|
|
|---|
| sandbox/daily-4-paisa-pa- | | dictionary_item_added | - root['schemas']['GoogleInternalPaisaV1Presentation.CreditMoneySectionConfig_NudgeFabCondition']
- root['schemas']['PaisaLogs._FopModuleCellV2Data']
- root['schemas']['PaisaLogs._IssuerDisplayInfoConsistency']
- root['schemas']['GoogleInternalPaisaV1Presentation._CreditMoneySectionConfig']['properties']['nudgeFabConditions']
- root['schemas']['NbuPaisaFrontendActions.PayflowPageParams_BottomSheetSupplementaryInfo']['properties']['visualElementId']
- root['schemas']['PaisaLogs._PaisaVisualElementMetadata']['properties']['fopModuleCellV2Data']
- root['schemas']['PaisaLogs._PaisaVisualElementMetadata']['properties']['issuerDisplayInfoConsistency']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250507 |
|---|
|
|---|
| root['schemas']['PaisaLogs._PaisaVisualElementMetadata']['description'] | | new_value | Visual elements metadata for NBU Paisa app (go/paisa-ve2). All Metadata related to Visual Elements in Paisa app go here. IMPORTANT: All new extensions should be added into the {@link wireless_android_play_playlog.MessagesUsedAsWeakFieldsOrExtensions} to be statically linked into ClearCut c++ binaries. NextId: 299 |
|---|
| old_value | Visual elements metadata for NBU Paisa app (go/paisa-ve2). All Metadata related to Visual Elements in Paisa app go here. IMPORTANT: All new extensions should be added into the {@link wireless_android_play_playlog.MessagesUsedAsWeakFieldsOrExtensions} to be statically linked into ClearCut c++ binaries. NextId: 297 |
|---|
|
|---|
| root['schemas']['NbuPaisaFrontendDiscovery._SearchResultLookupDetails']['properties']['matchType']['enum'][1] | | new_value | PHONE_NUMBER |
|---|
| old_value | PARTIAL_PHONE_NUMBER |
|---|
|
|---|
| root['schemas']['NbuPaisaFrontendDiscovery._SearchResultLookupDetails']['properties']['matchType']['enumDescriptions'][1] | | new_value | If the result only has matches (partial or complete) with the user's query using phone number keywords. This is also used in cases where the phone number lookup may be implicitly done for non-phone number queries (usually on the server). |
|---|
| old_value | If the result only has partial matches with user's query using phone number keywords. |
|---|
|
|---|
| root['schemas']['PaisaLogs._SearchResultLookupDetailsLogging']['properties']['matchType']['enum'][1] | | new_value | PHONE_NUMBER |
|---|
| old_value | PARTIAL_PHONE_NUMBER |
|---|
|
|---|
| root['schemas']['NbuPaisaFrontendDiscovery._SearchResultLookupDetails']['properties']['matchType']['enumDescriptions'][4] | | new_value | If the result was resolved via UPI Mapper (numeric ID). |
|---|
| old_value | If the result was resolved via UPI Mapper (phone number). Takes precedence over FULL_PHONE_NUMBER. |
|---|
|
|---|
| root['schemas']['Geostore._InternalSourceSummaryProto']['properties']['provider']['enumDescriptions'][14] | | new_value | All new "Google" provider entries must be full ints. The next available ID is: 0x111730CA |
|---|
| old_value | All new "Google" provider entries must be full ints. The next available ID is: 0x111730C9 |
|---|
|
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enumDescriptions'][162] | | new_value | Source based enrollment for Tap & Pay Arm2. b/408906218 |
|---|
| old_value | Source based enrollment for Tap & Pay. b/408906218 |
|---|
|
|---|
| root['schemas']['PaisaLogs._SearchResultLookupDetailsLogging']['properties']['matchType']['enumDescriptions'][1] | | new_value | If the result only has matches (partial or complete) with the user's query using phone number keywords. This is also used in cases where the phone number lookup may be implicitly done for non-phone number queries (usually on the server). |
|---|
| old_value | If the result only has partial matches with user's query using phone number keywords. |
|---|
|
|---|
| root['schemas']['PaisaLogs._SearchResultLookupDetailsLogging']['properties']['matchType']['enumDescriptions'][4] | | new_value | If the result was resolved via UPI Mapper (numeric ID). |
|---|
| old_value | If the result was resolved via UPI Mapper (phone number). Takes precedence over FULL_PHONE_NUMBER. |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['Geostore._InternalSourceSummaryProto']['properties']['provider']['enum'][204] | PROVIDER_GOOGLE_MAP_GEOMETRY_TEAM |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enum'][164] | TAP_AND_PAY_SOURCE_BASED_OFFER_ARM1 |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enum'][165] | TAP_AND_PAY_SOURCE_BASED_OFFER_ARM3 |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enumDescriptions'][164] | Source based enrollment for Tap & Pay Arm1. b/408906218 |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enumDescriptions'][165] | Source based enrollment for Tap & Pay Arm3. b/408906218 |
|---|
| root['schemas']['MonetaSecurityApi._SecureDataKey']['properties']['secureDataType']['enum'][220] | FAMILY_ISSUED_CARD |
|---|
| root['schemas']['MonetaSecurityApi._SecureDataKey']['properties']['secureDataType']['enumDescriptions'][220] | A card number for a card issued by a partner bank for issued cards backed by 'gru' supervised stored value product. go/sv-supervised-design |
|---|
| root['schemas']['NbuPaisaFrontendBillpay._OperatorCategory']['properties']['type']['enumDescriptions'][12] | Please use MOBILE instead. |
|---|
| root['schemas']['NbuPaisaFrontendDiscovery._SearchResultLookupDetails']['properties']['matchType']['enumDescriptions'][3] | If the result was resolved via UPI Mapper (phone number). Takes precedence over PHONE_NUMBER. |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enum'][1] | SIZE_1_1 |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enum'][2] | SIZE_1_2 |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enum'][4] | SIZE_2_1 |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enum'][5] | SIZE_2_2 |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enumDescriptions'][1] | For India merchants, SIZE_1_1 represents businesses with an annual turnover of < 5 lakh INR (0.5 million). |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enumDescriptions'][2] | For India merchants, SIZE_1_2 represents businesses with an annual turnover of >= 5 lakh and < 20 lakh INR (0.5 - 2 million INR). |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enumDescriptions'][4] | For India merchants, SIZE_2_1 represents businesses with an annual turnover of >=20 and < 40 lakh INR (2-4 million INR). |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enumDescriptions'][5] | For India merchants, SIZE_2_2 represents businesses with an annual turnover of >=40 lakh (4 million INR). |
|---|
| root['schemas']['PaisaLogs._BillPayConversationMetadata']['properties']['operatorCategoryType']['enumDescriptions'][12] | Please use MOBILE instead. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][9] | APPROVE_RELATIONSHIP_FULL_DELEGATE |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][10] | REJECT_RELATIONSHIP_FULL_DELEGATE |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][11] | DELETE_RELATIONSHIP_PARTIAL_DELEGATE_ENABLER |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][12] | DELETE_RELATIONSHIP_PARTIAL_DELEGATE_DEPENDANT |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][13] | DELETE_RELATIONSHIP_FULL_DELEGATE_ENABLER |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][14] | DELETE_RELATIONSHIP_FULL_DELEGATE_DEPENDANT |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][9] | Dependent approves full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][10] | Dependent rejects full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][11] | Enabler deletes partial delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][12] | Dependent deletes partial delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][13] | Enabler deletes full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][14] | Dependent deletes full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._MobilePlanCategoryData']['properties']['categoryType']['enum'][68] | UNLIMITED_5G |
|---|
| root['schemas']['PaisaLogs._MobilePlanCategoryData']['properties']['categoryType']['enumDescriptions'][68] | 5G Unlimited |
|---|
| root['schemas']['PaisaLogs._SearchResultLookupDetailsLogging']['properties']['matchType']['enumDescriptions'][3] | If the result was resolved via UPI Mapper (phone number). Takes precedence over PHONE_NUMBER. |
|---|
| root['schemas']['PaisaLogs._SubscriptionFlowData']['properties']['operatorCategoryType']['enumDescriptions'][12] | Please use MOBILE instead. |
|---|
|
|---|
| iterable_item_removed | | root['schemas']['NbuPaisaFrontendDiscovery._SearchResultLookupDetails']['properties']['matchType']['enum'][2] | FULL_PHONE_NUMBER |
|---|
| root['schemas']['NbuPaisaFrontendDiscovery._SearchResultLookupDetails']['properties']['matchType']['enumDescriptions'][2] | If the result only has complete matches with user's query using phone number keywords. This is also used in cases where the phone number lookup may be implicitly done for non-phone number queries (usually on the server). |
|---|
| root['schemas']['NbuPaisaFrontendDiscovery._SearchResultLookupDetails']['properties']['matchType']['enumDescriptions'][5] | If the result was resolved via UPI Mapper (numeric ID). Takes precedence over PARTIAL_PHONE_NUMBER. |
|---|
| root['schemas']['PaisaLogs._SearchResultLookupDetailsLogging']['properties']['matchType']['enum'][2] | FULL_PHONE_NUMBER |
|---|
| root['schemas']['PaisaLogs._SearchResultLookupDetailsLogging']['properties']['matchType']['enumDescriptions'][2] | If the result only has complete matches with user's query using phone number keywords. This is also used in cases where the phone number lookup may be implicitly done for non-phone number queries (usually on the server). |
|---|
| root['schemas']['PaisaLogs._SearchResultLookupDetailsLogging']['properties']['matchType']['enumDescriptions'][5] | If the result was resolved via UPI Mapper (numeric ID). Takes precedence over PARTIAL_PHONE_NUMBER. |
|---|
|
|---|
|
|---|
| sandbox/daily-4-paisa-pa-v1 | | dictionary_item_added | - root['schemas']['GoogleInternalPaisaV1Presentation.CreditMoneySectionConfig_NudgeFabCondition']
- root['schemas']['PaisaLogs._FopModuleCellV2Data']
- root['schemas']['PaisaLogs._IssuerDisplayInfoConsistency']
- root['schemas']['GoogleInternalPaisaV1Presentation._CreditMoneySectionConfig']['properties']['nudgeFabConditions']
- root['schemas']['NbuPaisaFrontendActions.PayflowPageParams_BottomSheetSupplementaryInfo']['properties']['visualElementId']
- root['schemas']['PaisaLogs._PaisaVisualElementMetadata']['properties']['fopModuleCellV2Data']
- root['schemas']['PaisaLogs._PaisaVisualElementMetadata']['properties']['issuerDisplayInfoConsistency']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250507 |
|---|
|
|---|
| root['schemas']['PaisaLogs._PaisaVisualElementMetadata']['description'] | | new_value | Visual elements metadata for NBU Paisa app (go/paisa-ve2). All Metadata related to Visual Elements in Paisa app go here. IMPORTANT: All new extensions should be added into the {@link wireless_android_play_playlog.MessagesUsedAsWeakFieldsOrExtensions} to be statically linked into ClearCut c++ binaries. NextId: 299 |
|---|
| old_value | Visual elements metadata for NBU Paisa app (go/paisa-ve2). All Metadata related to Visual Elements in Paisa app go here. IMPORTANT: All new extensions should be added into the {@link wireless_android_play_playlog.MessagesUsedAsWeakFieldsOrExtensions} to be statically linked into ClearCut c++ binaries. NextId: 297 |
|---|
|
|---|
| root['schemas']['NbuPaisaFrontendDiscovery._SearchResultLookupDetails']['properties']['matchType']['enum'][1] | | new_value | PHONE_NUMBER |
|---|
| old_value | PARTIAL_PHONE_NUMBER |
|---|
|
|---|
| root['schemas']['NbuPaisaFrontendDiscovery._SearchResultLookupDetails']['properties']['matchType']['enumDescriptions'][1] | | new_value | If the result only has matches (partial or complete) with the user's query using phone number keywords. This is also used in cases where the phone number lookup may be implicitly done for non-phone number queries (usually on the server). |
|---|
| old_value | If the result only has partial matches with user's query using phone number keywords. |
|---|
|
|---|
| root['schemas']['PaisaLogs._SearchResultLookupDetailsLogging']['properties']['matchType']['enum'][1] | | new_value | PHONE_NUMBER |
|---|
| old_value | PARTIAL_PHONE_NUMBER |
|---|
|
|---|
| root['schemas']['NbuPaisaFrontendDiscovery._SearchResultLookupDetails']['properties']['matchType']['enumDescriptions'][4] | | new_value | If the result was resolved via UPI Mapper (numeric ID). |
|---|
| old_value | If the result was resolved via UPI Mapper (phone number). Takes precedence over FULL_PHONE_NUMBER. |
|---|
|
|---|
| root['schemas']['Geostore._InternalSourceSummaryProto']['properties']['provider']['enumDescriptions'][14] | | new_value | All new "Google" provider entries must be full ints. The next available ID is: 0x111730CA |
|---|
| old_value | All new "Google" provider entries must be full ints. The next available ID is: 0x111730C9 |
|---|
|
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enumDescriptions'][162] | | new_value | Source based enrollment for Tap & Pay Arm2. b/408906218 |
|---|
| old_value | Source based enrollment for Tap & Pay. b/408906218 |
|---|
|
|---|
| root['schemas']['PaisaLogs._SearchResultLookupDetailsLogging']['properties']['matchType']['enumDescriptions'][1] | | new_value | If the result only has matches (partial or complete) with the user's query using phone number keywords. This is also used in cases where the phone number lookup may be implicitly done for non-phone number queries (usually on the server). |
|---|
| old_value | If the result only has partial matches with user's query using phone number keywords. |
|---|
|
|---|
| root['schemas']['PaisaLogs._SearchResultLookupDetailsLogging']['properties']['matchType']['enumDescriptions'][4] | | new_value | If the result was resolved via UPI Mapper (numeric ID). |
|---|
| old_value | If the result was resolved via UPI Mapper (phone number). Takes precedence over FULL_PHONE_NUMBER. |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['Geostore._InternalSourceSummaryProto']['properties']['provider']['enum'][204] | PROVIDER_GOOGLE_MAP_GEOMETRY_TEAM |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enum'][164] | TAP_AND_PAY_SOURCE_BASED_OFFER_ARM1 |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enum'][165] | TAP_AND_PAY_SOURCE_BASED_OFFER_ARM3 |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enumDescriptions'][164] | Source based enrollment for Tap & Pay Arm1. b/408906218 |
|---|
| root['schemas']['GoogleInternalPaisaV1Social._SocialCampaignMetadata']['properties']['clientId']['enumDescriptions'][165] | Source based enrollment for Tap & Pay Arm3. b/408906218 |
|---|
| root['schemas']['MonetaSecurityApi._SecureDataKey']['properties']['secureDataType']['enum'][220] | FAMILY_ISSUED_CARD |
|---|
| root['schemas']['MonetaSecurityApi._SecureDataKey']['properties']['secureDataType']['enumDescriptions'][220] | A card number for a card issued by a partner bank for issued cards backed by 'gru' supervised stored value product. go/sv-supervised-design |
|---|
| root['schemas']['NbuPaisaFrontendBillpay._OperatorCategory']['properties']['type']['enumDescriptions'][12] | Please use MOBILE instead. |
|---|
| root['schemas']['NbuPaisaFrontendDiscovery._SearchResultLookupDetails']['properties']['matchType']['enumDescriptions'][3] | If the result was resolved via UPI Mapper (phone number). Takes precedence over PHONE_NUMBER. |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enum'][1] | SIZE_1_1 |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enum'][2] | SIZE_1_2 |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enum'][4] | SIZE_2_1 |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enum'][5] | SIZE_2_2 |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enumDescriptions'][1] | For India merchants, SIZE_1_1 represents businesses with an annual turnover of < 5 lakh INR (0.5 million). |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enumDescriptions'][2] | For India merchants, SIZE_1_2 represents businesses with an annual turnover of >= 5 lakh and < 20 lakh INR (0.5 - 2 million INR). |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enumDescriptions'][4] | For India merchants, SIZE_2_1 represents businesses with an annual turnover of >=20 and < 40 lakh INR (2-4 million INR). |
|---|
| root['schemas']['NbuPaisaFrontendMerchant._BusinessSize']['properties']['size']['enumDescriptions'][5] | For India merchants, SIZE_2_2 represents businesses with an annual turnover of >=40 lakh (4 million INR). |
|---|
| root['schemas']['PaisaLogs._BillPayConversationMetadata']['properties']['operatorCategoryType']['enumDescriptions'][12] | Please use MOBILE instead. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][9] | APPROVE_RELATIONSHIP_FULL_DELEGATE |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][10] | REJECT_RELATIONSHIP_FULL_DELEGATE |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][11] | DELETE_RELATIONSHIP_PARTIAL_DELEGATE_ENABLER |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][12] | DELETE_RELATIONSHIP_PARTIAL_DELEGATE_DEPENDANT |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][13] | DELETE_RELATIONSHIP_FULL_DELEGATE_ENABLER |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enum'][14] | DELETE_RELATIONSHIP_FULL_DELEGATE_DEPENDANT |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][9] | Dependent approves full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][10] | Dependent rejects full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][11] | Enabler deletes partial delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][12] | Dependent deletes partial delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][13] | Enabler deletes full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._DelegatePaymentsActionData']['properties']['actionType']['enumDescriptions'][14] | Dependent deletes full delegate relationship. |
|---|
| root['schemas']['PaisaLogs._MobilePlanCategoryData']['properties']['categoryType']['enum'][68] | UNLIMITED_5G |
|---|
| root['schemas']['PaisaLogs._MobilePlanCategoryData']['properties']['categoryType']['enumDescriptions'][68] | 5G Unlimited |
|---|
| root['schemas']['PaisaLogs._SearchResultLookupDetailsLogging']['properties']['matchType']['enumDescriptions'][3] | If the result was resolved via UPI Mapper (phone number). Takes precedence over PHONE_NUMBER. |
|---|
| root['schemas']['PaisaLogs._SubscriptionFlowData']['properties']['operatorCategoryType']['enumDescriptions'][12] | Please use MOBILE instead. |
|---|
|
|---|
| iterable_item_removed | | root['schemas']['NbuPaisaFrontendDiscovery._SearchResultLookupDetails']['properties']['matchType']['enum'][2] | FULL_PHONE_NUMBER |
|---|
| root['schemas']['NbuPaisaFrontendDiscovery._SearchResultLookupDetails']['properties']['matchType']['enumDescriptions'][2] | If the result only has complete matches with user's query using phone number keywords. This is also used in cases where the phone number lookup may be implicitly done for non-phone number queries (usually on the server). |
|---|
| root['schemas']['NbuPaisaFrontendDiscovery._SearchResultLookupDetails']['properties']['matchType']['enumDescriptions'][5] | If the result was resolved via UPI Mapper (numeric ID). Takes precedence over PARTIAL_PHONE_NUMBER. |
|---|
| root['schemas']['PaisaLogs._SearchResultLookupDetailsLogging']['properties']['matchType']['enum'][2] | FULL_PHONE_NUMBER |
|---|
| root['schemas']['PaisaLogs._SearchResultLookupDetailsLogging']['properties']['matchType']['enumDescriptions'][2] | If the result only has complete matches with user's query using phone number keywords. This is also used in cases where the phone number lookup may be implicitly done for non-phone number queries (usually on the server). |
|---|
| root['schemas']['PaisaLogs._SearchResultLookupDetailsLogging']['properties']['matchType']['enumDescriptions'][5] | If the result was resolved via UPI Mapper (numeric ID). Takes precedence over PARTIAL_PHONE_NUMBER. |
|---|
|
|---|
|
|---|
| sandbox/dev-scone-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['CustomerSupportContentFrdVrgSetContainer']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['CustomerSupportContentScFrdValues']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
|
|---|
|
|---|
| sandbox/dev-scone-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['CustomerSupportContentFrdVrgSetContainer']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['CustomerSupportContentScFrdValues']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
|
|---|
|
|---|
| sandbox/phonedeviceverification-pa-prod- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/phonedeviceverification-pa-prod-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/preprod-bifrost-firealerts-c2p- | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250506 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/preprod-bifrost-firealerts-c2p-v1 | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250506 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/preprod-fitbit-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/preprod-fitbit-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/preprod-fitbit-pa-v3 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/preprod-fitbit-pa-v4 | | dictionary_item_added | - root['schemas']['RecommendedSleepScheduleComponent']
- root['schemas']['SleepNeed']
- root['schemas']['RichElement']['properties']['recommendedSleepScheduleComponent']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/preprod-growth-pa- | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/preprod-growth-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/preprod-nestauthz-pa- | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/preprod-nestauthz-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/prod-phonedeviceverification-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/prod-phonedeviceverification-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/qa-admin-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/qa-admin-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-accountsettingsmobile-pa- | | dictionary_item_added | - root['fullyEncodeReservedExpansion']
|
|---|
| values_changed | | root['baseUrl'] | | new_value | https://reach-pa.googleapis.com/ |
|---|
| old_value | https://staging-accountsettingsmobile-pa.sandbox.googleapis.com/ |
|---|
|
|---|
| root['canonicalName'] | | new_value | Reach Presentation Service |
|---|
| old_value | Account Settings Mobile |
|---|
|
|---|
| root['description'] | | new_value | reach-pa.googleapis.com API. |
|---|
| old_value | An API which services Google account settings UIs on Android and iOS. |
|---|
|
|---|
| root['documentationLink'] | | new_value | http://go/safetyexp-entry-point-dd |
|---|
| old_value | http://go/asm |
|---|
|
|---|
| root['id'] | | new_value | reach_pa:v1 |
|---|
| old_value | accountsettingsmobile_pa:v1 |
|---|
|
|---|
| root['mtlsRootUrl'] | | new_value | https://reach-pa.mtls.googleapis.com/ |
|---|
| old_value | https://staging-accountsettingsmobile-pa.mtls.sandbox.googleapis.com/ |
|---|
|
|---|
| root['name'] | | new_value | reach_pa |
|---|
| old_value | accountsettingsmobile_pa |
|---|
|
|---|
| root['resources']['v1']['methods'] | | new_value | | getAccountMessages | | description | Fetches user's current advice state, potentially updates respective badge dismissal |
|---|
| flatPath | v1:getAccountMessages |
|---|
| httpMethod | POST |
|---|
| id | reach_pa.getAccountMessages |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getAccountMessages |
|---|
| request | | $ref | AccountMessagesRequest |
|---|
|
|---|
| response | | $ref | AccountMessagesResponse |
|---|
|
|---|
|
|---|
| updateAccountMessages | | description | Updates user's current advice state, like updating the advice dismissal status |
|---|
| flatPath | v1:updateAccountMessages |
|---|
| httpMethod | POST |
|---|
| id | reach_pa.updateAccountMessages |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:updateAccountMessages |
|---|
| request | | $ref | UpdateAccountMessagesRequest |
|---|
|
|---|
| response | | $ref | UpdateAccountMessagesResponse |
|---|
|
|---|
|
|---|
|
|---|
| old_value | | getClientConfig | | description | Requests config data for iOS clients. |
|---|
| flatPath | v1:getClientConfig |
|---|
| httpMethod | POST |
|---|
| id | accountsettingsmobile_pa.getClientConfig |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getClientConfig |
|---|
| request | | $ref | GetClientConfigRequest |
|---|
|
|---|
| response | | $ref | GetClientConfigResponse |
|---|
|
|---|
|
|---|
| getResource | | description | Requests a resource. |
|---|
| flatPath | v1:getResource |
|---|
| httpMethod | POST |
|---|
| id | accountsettingsmobile_pa.getResource |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getResource |
|---|
| request | |
|---|
| response | |
|---|
|
|---|
| getScreen | | description | Requests a screen. |
|---|
| flatPath | v1:getScreen |
|---|
| httpMethod | POST |
|---|
| id | accountsettingsmobile_pa.getScreen |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getScreen |
|---|
| request | |
|---|
| response | |
|---|
|
|---|
| getSignedOutResource | | description | Requests a resource from a signed-out context. |
|---|
| flatPath | v1:getSignedOutResource |
|---|
| httpMethod | POST |
|---|
| id | accountsettingsmobile_pa.getSignedOutResource |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getSignedOutResource |
|---|
| request | | $ref | GetSignedOutResourceRequest |
|---|
|
|---|
| response | | $ref | GetSignedOutResourceResponse |
|---|
|
|---|
|
|---|
| prefetchRelatedScreens | | description | Requests a list of screens which are related to a specified one, with the purpose of prefetching them in the client application. |
|---|
| flatPath | v1:prefetchRelatedScreens |
|---|
| httpMethod | POST |
|---|
| id | accountsettingsmobile_pa.prefetchRelatedScreens |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:prefetchRelatedScreens |
|---|
| request | | $ref | PrefetchRelatedScreensRequest |
|---|
|
|---|
| response | | $ref | PrefetchRelatedScreensResponse |
|---|
|
|---|
|
|---|
| search | | description | Searches through resources |
|---|
| flatPath | v1:search |
|---|
| httpMethod | POST |
|---|
| id | accountsettingsmobile_pa.search |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:search |
|---|
| request | |
|---|
| response | |
|---|
|
|---|
| setResourceDismissalState | | description | Sets the resource state, e.g. resource is dismissed |
|---|
| flatPath | v1:setResourceDismissalState |
|---|
| httpMethod | POST |
|---|
| id | accountsettingsmobile_pa.setResourceDismissalState |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:setResourceDismissalState |
|---|
| request | | $ref | SetResourceDismissalStateRequest |
|---|
|
|---|
| response | | $ref | SetResourceDismissalStateResponse |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
| root['rootUrl'] | | new_value | https://reach-pa.googleapis.com/ |
|---|
| old_value | https://staging-accountsettingsmobile-pa.sandbox.googleapis.com/ |
|---|
|
|---|
| root['schemas'] | | new_value | | AccountAdvice | | description | Data to render OneGoogle bento account advice |
|---|
| id | AccountAdvice |
|---|
| properties | | additionalInfo | | $ref | AdditionalInfo |
|---|
| description | Optional additional information included with the advice. Currently only used for recovery factor advice. |
|---|
|
|---|
| adviceId | | description | Unique identifier of the advice type. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| ctaText | | description | Text to display on the CTA button. |
|---|
| type | string |
|---|
|
|---|
| description | | description | Description of the advice. |
|---|
| type | string |
|---|
|
|---|
| destination | | $ref | AdviceDestination |
|---|
| description | Destination to open once Bento account advice CTA is clicked |
|---|
|
|---|
| dismissalText | | description | Text to display on the dismissal button. |
|---|
| type | string |
|---|
|
|---|
| title | | description | Title of the advice. |
|---|
| type | string |
|---|
|
|---|
| uiTreatment | | description | UI treatment of the advice. |
|---|
| enum | - UI_TREATMENT_UNSPECIFIED
- YELLOW_CARD
- BLUE_CARD_SLIM
- BLUE_CARD_EXTENDED
|
|---|
| enumDescriptions | - No information about UI treatment, should never be used.
- Yellow card UI treatment for recovery phone advice.
- Blue card slim version UI treatment for home address advice.
- Blue card extended version UI treatment for home address advice.
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountMenu | | description | Data to render OneGoogle account menu only for SafetyExp |
|---|
| id | AccountMenu |
|---|
| properties | | alertLevel | | enum | - ALERT_LEVEL_UNSPECIFIED
- NO_ADVICE
- ADVICE
- ADVICE_REQUIRING_ATTENTION
|
|---|
| enumDescriptions | - No information about alert level
- No advice — account is in a good shape
- There is advice available
- There is advice that require attention
|
|---|
| type | string |
|---|
|
|---|
| destination | |
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountMessagesRequest | | description | Request for the GetAccountMessages RPC |
|---|
| id | AccountMessagesRequest |
|---|
| properties | | accountParticleDiscVersion | | $ref | Version |
|---|
| description | Version of the AccountParticleDisc that is currently present on the device, iff present. |
|---|
|
|---|
| adviceFlavours | | description | The flavour of advice applicable to the request. Response data will be accordingly produced. |
|---|
| items | | enum | - UNSPECIFIED_ADVICE_FLAVOUR
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_VARIANT_1
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_NO_DESCRIPTION_VARIANT_1
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_GMAIL_VARIANT_1
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_NO_BADGE_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_VARIANT_2
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_PHOTOS_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_DRIVE_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_GMAIL_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_PHOTOS_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_DRIVE_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_GMAIL_VARIANT_1
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_VARIANT_1
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_VARIANT_2
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_MAPS_EXTENDED
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_MAPS_SLIM
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_SEARCH_EXTENDED
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_SEARCH_SLIM
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_ISOLATED_MAPS_EXTENDED
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_ISOLATED_SEARCH_EXTENDED
|
|---|
| enumDescriptions | - Show Add recovery phone advice with variant 1 IFF user has no recovery option.
- Show Add recovery phone advice with no description variant 1 IFF user has no recovery option.
- Show Add recovery phone advice with gmail variant 1 IFF user has no recovery option.
- Show Add recovery phone advice with variant 1 IFF user has no recovery option. Never show badge.
- Show Add recovery phone advice IFF user has no recovery phone set.
- Show Add recovery phone advice IFF user has no recovery phone set.
- Show Add recovery phone photos variant advice IFF user has no recovery phone set.
- Show Add recovery phone drive variant advice IFF user has no recovery phone set.
- Show Add recovery phone gmail variant advice IFF user has no recovery phone set.
- Show Add recovery email advice IFF user has no recovery email and already has a recovery phone set.
- Show Add recovery email photos variant advice IFF user has no recovery email and already has a recovery phone set.
- Show Add recovery email drive variant advice IFF user has no recovery email and already has a recovery phone set.
- Show Add recovery email gmail variant advice IFF user has no recovery email and already has a recovery phone set.
- Show Add home address advice with variant 1 IFF user has no home address present.
- Show Add home address advice with variant 2 IFF user has no home address present.
- Show Add home address advice with maps variant 1 IFF user has no home address present.
- Show Add home address advice with maps variant 2 IFF user has no home address present.
- Show Add home address advice with search variant 1 IFF user has no home address present.
- Show Add home address advice with search variant 2 IFF user has no home address present.
- Show Add home address advice with maps variant 1 IFF user has no home address present with other non critical advice disabled.
- Show Add home address advice with search variant 1 IFF user has no home address present with other non critical advice disabled.
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
| context | | $ref | Context |
|---|
| description | Context of the triggering call, e.g. version/CL, platform, etc |
|---|
|
|---|
| surfaces | | description | List of surfaces to fetch messages for: OneGoogle account particle disk, OneGoogle account menu, etc |
|---|
| items | | enum | - SURFACE_UNSPECIFIED
- ACCOUNT_PARTICLE_DISC
- ACCOUNT_MENU
- BENTO_ACCOUNT_MENU
- BENTO_ACCOUNT_PARTICLE_DISC
|
|---|
| enumDescriptions | - Default value, should never be used
- OneGoogle account particle disc which will open SafetyExp account menu on tap.
- OneGoogle account menu only used for SafetyExp
- OneGoogle bento account menu
- OneGoogle account particle disc which will open Bento account menu on tap.
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
| triggeringEvent | | $ref | TriggeringEvent |
|---|
| description | The event that triggered the fetching, e.g. OneGoogle account menu has opened. Allows server to decide what data source to use (cached or live data) and what other actions to perform, e.g. dismiss the badge if account menu was open |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountMessagesResponse | | description | Response for the GetAccountMessages RPC |
|---|
| id | AccountMessagesResponse |
|---|
| properties | | accountAdvices | | description | List of active advices to show the user |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| accountMenu | | $ref | AccountMenu |
|---|
| description | Only used for SafetyExp |
|---|
|
|---|
| accountParticleDisc | |
|---|
| isServerDarkLaunch | | description | The server is currently in a ‘dark launch’ state. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountParticleDisc | | description | Data to render OneGoogle account particle disc |
|---|
| id | AccountParticleDisc |
|---|
| properties | | badgeDismissalEvents | | items | | enum | - BADGE_DISMISSAL_EVENT_UNSPECIFIED
- ACCOUNT_MENU_OPENED
|
|---|
| enumDescriptions | - Shouldn't be used
- User has opened account menu
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
| badgeStatus | | enum | - BADGE_STATUS_UNSPECIFIED
- NONE
- ATTENTION
|
|---|
| enumDescriptions | - No information about badge status
- No badge
- Attention badge (yellow)
|
|---|
| type | string |
|---|
|
|---|
| version | |
|---|
|
|---|
| type | object |
|---|
|
|---|
| AdditionalInfo | | description | Additional miscellaneous information included with the advice. |
|---|
| id | AdditionalInfo |
|---|
| properties | | numExistingRecoveryFactors | | description | Number of existing recovery factors the user has. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AdviceDestination | | description | Destination to open once Bento account advice CTA is clicked |
|---|
| id | AdviceDestination |
|---|
| properties | | resourceKey | | $ref | ResourceKey |
|---|
| description | Resource to open in the Google Account |
|---|
|
|---|
| url | | $ref | SafeUrlProto |
|---|
| description | URL to open in the browser |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AlertDestination | | description | Destination to open once OneGoogle account menu entrypoint is clicked |
|---|
| id | AlertDestination |
|---|
| properties | | resourceKey | | $ref | ResourceKey |
|---|
| description | Resource to open in the Google Account |
|---|
|
|---|
| url | | $ref | SafeUrlProto |
|---|
| description | URL to open in the browser |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AndroidClientVersion | | id | AndroidClientVersion |
|---|
| properties | | androidOsSdk | | description | The Android OS SDK version, e.g. 28 (Android 9 is SDK 28). |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| androidOsVersion | | description | The Android OS version, e.g. "5.1.1" |
|---|
| type | string |
|---|
|
|---|
| callingAndroidApp | | description | ApplicationId (package name) or alias of the app that initiated the request |
|---|
| type | string |
|---|
|
|---|
| gmscoreVersionCode | | description | GmsCore version code which is defined in google3/java/com/google/android/gmscore/integ/package/common-base/src/com/google/android/gms/common/util/VersionUtils.java getVersionCode(), e.g. 18477021 |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| gmscoreVersionName | | description | GmsCore info which is defined in google3/java/com/google/android/gmscore/integ/package/common-base/src/com/google/android/gms/common/util/VersionUtils.java getVersionName(), e.g. "18.4.77 (eng-040408-254230773)" |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Context | | description | The version of a specific piece of client software. Used mainly for logging, metrics and debugging. Can be used in future for graceful degradation of features for outdated client versions |
|---|
| id | Context |
|---|
| properties | | androidClientVersion | |
|---|
| hideEntryPointIfViewed | | description | If true, don't show EP once Y days have passed since the user viewed it. |
|---|
| type | boolean |
|---|
|
|---|
| hideEntryPointIfVisited | | description | If true, don't show EP once X days have passed since the user clicked it. |
|---|
| type | boolean |
|---|
|
|---|
| iosClientVersion | |
|---|
| isClientDarkLaunch | | description | The client is currently in a ‘dark launch’ state. |
|---|
| type | boolean |
|---|
|
|---|
| webClientVersion | |
|---|
|
|---|
| type | object |
|---|
|
|---|
| IOSClientVersion | | id | IOSClientVersion |
|---|
| properties | | 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 |
|---|
|
|---|
| iosBuildChangelist | | description | Changelist that this client was built at. Obtained from google3/googlemac/Shared/Metrics/Phenotype/Classes/PHTPhenotypeBuildData.h |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| OneGoogleTriggeringEvent | | description | OneGoogle specific event that triggered client to fetch the data |
|---|
| id | OneGoogleTriggeringEvent |
|---|
| properties | | reason | | description | Enum describing the reason for the triggering event, e.g. account menu open |
|---|
| enum | - ONE_GOOGLE_TRIGGERING_EVENT_REASON_UNSPECIFIED
- ACCOUNT_MENU_OPENED
- ACCOUNT_SWITCHED
- PERIODIC_POLL
- TICKLE_RECEIVED
- TAB_SWITCH
- SECURITY_ADVISOR_FLOW_COMPLETED
- WEB_PAGE_LOAD
|
|---|
| enumDescriptions | - Default value, should never be used
- User has opened account menu
- User has switched the account
- Library initiated periodic poll
- Library received a tickle to invalidate the state
- User switched tab (using visibility API).
- Security Advisor flow was completed. Only implemented on iOS.
- The page was loaded and APD was rendered. See go/og-badge-ads.
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| 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 |
|---|
|
|---|
| SafeUrlProto | | description | Message containing a string that is safe to use in URL contexts in DOM APIs and HTML documents, where the URL context does not refer to a resource that loads code. |
|---|
| id | SafeUrlProto |
|---|
| properties | | privateDoNotAccessOrElseSafeUrlWrappedValue | | description | IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| TriggeringEvent | | description | Event that triggered client to fetch the data |
|---|
| id | TriggeringEvent |
|---|
| properties | | onegoogleTriggeringEvent | | $ref | OneGoogleTriggeringEvent |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| UpdateAccountMessagesRequest | | description | Request for the UpdateAccountMessages RPC |
|---|
| id | UpdateAccountMessagesRequest |
|---|
| properties | | dismissedAdviceIds | | description | List of advices which are dismissed in this request. E.g. when user explicitly clicked on "Not now/Dismiss" to dismiss the advice screen/7vixUwswqjT7APa |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| UpdateAccountMessagesResponse | | description | Response for the UpdateAccountMessages RPC. Empty response means success |
|---|
| id | UpdateAccountMessagesResponse |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| Version | | description | A version of account particle disc status that is opaque to the client. To be defined by server and passed to client to pass it back, when needed |
|---|
| id | Version |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| WebClientVersion | | id | WebClientVersion |
|---|
| properties | | buildLabel | | description | Label associated with the build of this binary. See google3/java/com/google/apps/framework/blaze/ImmutableBuildData.kt |
|---|
| type | string |
|---|
|
|---|
| cachedAlertLevel | | description | AlertLevel web client obtained from OGS. This will be used to compare OGS's AlertLevel generation logic with RPS's AlertLevel generation logic. Web client will populate this field on first AM open of their session. See go/safetyexp-state-mismatch |
|---|
| enum | - ALERT_LEVEL_UNSPECIFIED
- NO_ADVICE
- ADVICE
- ADVICE_REQUIRING_ATTENTION
|
|---|
| enumDescriptions | - No information about alert level
- No advice — account is in a good shape
- There is advice available
- There is advice that require attention
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
|
|---|
| old_value | | 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 |
|---|
|
|---|
|
|---|
|
|---|
| root['title'] | | new_value | Reach Private API |
|---|
| old_value | Account Settings Mobile Private API (Staging) |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-accountsettingsmobile-pa-v1 | | dictionary_item_added | - root['fullyEncodeReservedExpansion']
|
|---|
| values_changed | | root['baseUrl'] | | new_value | https://reach-pa.googleapis.com/ |
|---|
| old_value | https://staging-accountsettingsmobile-pa.sandbox.googleapis.com/ |
|---|
|
|---|
| root['canonicalName'] | | new_value | Reach Presentation Service |
|---|
| old_value | Account Settings Mobile |
|---|
|
|---|
| root['description'] | | new_value | reach-pa.googleapis.com API. |
|---|
| old_value | An API which services Google account settings UIs on Android and iOS. |
|---|
|
|---|
| root['documentationLink'] | | new_value | http://go/safetyexp-entry-point-dd |
|---|
| old_value | http://go/asm |
|---|
|
|---|
| root['id'] | | new_value | reach_pa:v1 |
|---|
| old_value | accountsettingsmobile_pa:v1 |
|---|
|
|---|
| root['mtlsRootUrl'] | | new_value | https://reach-pa.mtls.googleapis.com/ |
|---|
| old_value | https://staging-accountsettingsmobile-pa.mtls.sandbox.googleapis.com/ |
|---|
|
|---|
| root['name'] | | new_value | reach_pa |
|---|
| old_value | accountsettingsmobile_pa |
|---|
|
|---|
| root['resources']['v1']['methods'] | | new_value | | getAccountMessages | | description | Fetches user's current advice state, potentially updates respective badge dismissal |
|---|
| flatPath | v1:getAccountMessages |
|---|
| httpMethod | POST |
|---|
| id | reach_pa.getAccountMessages |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getAccountMessages |
|---|
| request | | $ref | AccountMessagesRequest |
|---|
|
|---|
| response | | $ref | AccountMessagesResponse |
|---|
|
|---|
|
|---|
| updateAccountMessages | | description | Updates user's current advice state, like updating the advice dismissal status |
|---|
| flatPath | v1:updateAccountMessages |
|---|
| httpMethod | POST |
|---|
| id | reach_pa.updateAccountMessages |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:updateAccountMessages |
|---|
| request | | $ref | UpdateAccountMessagesRequest |
|---|
|
|---|
| response | | $ref | UpdateAccountMessagesResponse |
|---|
|
|---|
|
|---|
|
|---|
| old_value | | getClientConfig | | description | Requests config data for iOS clients. |
|---|
| flatPath | v1:getClientConfig |
|---|
| httpMethod | POST |
|---|
| id | accountsettingsmobile_pa.getClientConfig |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getClientConfig |
|---|
| request | | $ref | GetClientConfigRequest |
|---|
|
|---|
| response | | $ref | GetClientConfigResponse |
|---|
|
|---|
|
|---|
| getResource | | description | Requests a resource. |
|---|
| flatPath | v1:getResource |
|---|
| httpMethod | POST |
|---|
| id | accountsettingsmobile_pa.getResource |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getResource |
|---|
| request | |
|---|
| response | |
|---|
|
|---|
| getScreen | | description | Requests a screen. |
|---|
| flatPath | v1:getScreen |
|---|
| httpMethod | POST |
|---|
| id | accountsettingsmobile_pa.getScreen |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getScreen |
|---|
| request | |
|---|
| response | |
|---|
|
|---|
| getSignedOutResource | | description | Requests a resource from a signed-out context. |
|---|
| flatPath | v1:getSignedOutResource |
|---|
| httpMethod | POST |
|---|
| id | accountsettingsmobile_pa.getSignedOutResource |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:getSignedOutResource |
|---|
| request | | $ref | GetSignedOutResourceRequest |
|---|
|
|---|
| response | | $ref | GetSignedOutResourceResponse |
|---|
|
|---|
|
|---|
| prefetchRelatedScreens | | description | Requests a list of screens which are related to a specified one, with the purpose of prefetching them in the client application. |
|---|
| flatPath | v1:prefetchRelatedScreens |
|---|
| httpMethod | POST |
|---|
| id | accountsettingsmobile_pa.prefetchRelatedScreens |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:prefetchRelatedScreens |
|---|
| request | | $ref | PrefetchRelatedScreensRequest |
|---|
|
|---|
| response | | $ref | PrefetchRelatedScreensResponse |
|---|
|
|---|
|
|---|
| search | | description | Searches through resources |
|---|
| flatPath | v1:search |
|---|
| httpMethod | POST |
|---|
| id | accountsettingsmobile_pa.search |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:search |
|---|
| request | |
|---|
| response | |
|---|
|
|---|
| setResourceDismissalState | | description | Sets the resource state, e.g. resource is dismissed |
|---|
| flatPath | v1:setResourceDismissalState |
|---|
| httpMethod | POST |
|---|
| id | accountsettingsmobile_pa.setResourceDismissalState |
|---|
| parameterOrder | |
|---|
| parameters | |
|---|
| path | v1:setResourceDismissalState |
|---|
| request | | $ref | SetResourceDismissalStateRequest |
|---|
|
|---|
| response | | $ref | SetResourceDismissalStateResponse |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
| root['rootUrl'] | | new_value | https://reach-pa.googleapis.com/ |
|---|
| old_value | https://staging-accountsettingsmobile-pa.sandbox.googleapis.com/ |
|---|
|
|---|
| root['schemas'] | | new_value | | AccountAdvice | | description | Data to render OneGoogle bento account advice |
|---|
| id | AccountAdvice |
|---|
| properties | | additionalInfo | | $ref | AdditionalInfo |
|---|
| description | Optional additional information included with the advice. Currently only used for recovery factor advice. |
|---|
|
|---|
| adviceId | | description | Unique identifier of the advice type. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| ctaText | | description | Text to display on the CTA button. |
|---|
| type | string |
|---|
|
|---|
| description | | description | Description of the advice. |
|---|
| type | string |
|---|
|
|---|
| destination | | $ref | AdviceDestination |
|---|
| description | Destination to open once Bento account advice CTA is clicked |
|---|
|
|---|
| dismissalText | | description | Text to display on the dismissal button. |
|---|
| type | string |
|---|
|
|---|
| title | | description | Title of the advice. |
|---|
| type | string |
|---|
|
|---|
| uiTreatment | | description | UI treatment of the advice. |
|---|
| enum | - UI_TREATMENT_UNSPECIFIED
- YELLOW_CARD
- BLUE_CARD_SLIM
- BLUE_CARD_EXTENDED
|
|---|
| enumDescriptions | - No information about UI treatment, should never be used.
- Yellow card UI treatment for recovery phone advice.
- Blue card slim version UI treatment for home address advice.
- Blue card extended version UI treatment for home address advice.
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountMenu | | description | Data to render OneGoogle account menu only for SafetyExp |
|---|
| id | AccountMenu |
|---|
| properties | | alertLevel | | enum | - ALERT_LEVEL_UNSPECIFIED
- NO_ADVICE
- ADVICE
- ADVICE_REQUIRING_ATTENTION
|
|---|
| enumDescriptions | - No information about alert level
- No advice — account is in a good shape
- There is advice available
- There is advice that require attention
|
|---|
| type | string |
|---|
|
|---|
| destination | |
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountMessagesRequest | | description | Request for the GetAccountMessages RPC |
|---|
| id | AccountMessagesRequest |
|---|
| properties | | accountParticleDiscVersion | | $ref | Version |
|---|
| description | Version of the AccountParticleDisc that is currently present on the device, iff present. |
|---|
|
|---|
| adviceFlavours | | description | The flavour of advice applicable to the request. Response data will be accordingly produced. |
|---|
| items | | enum | - UNSPECIFIED_ADVICE_FLAVOUR
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_VARIANT_1
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_NO_DESCRIPTION_VARIANT_1
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_GMAIL_VARIANT_1
- NO_RECOVERY_OPTIONS_ADD_RECOVERY_PHONE_ADVICE_NO_BADGE_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_VARIANT_2
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_PHOTOS_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_DRIVE_VARIANT_1
- NO_RECOVERY_PHONE_ADD_RECOVERY_PHONE_ADVICE_GMAIL_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_PHOTOS_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_DRIVE_VARIANT_1
- ONLY_RECOVERY_PHONE_ADD_RECOVERY_EMAIL_ADVICE_GMAIL_VARIANT_1
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_VARIANT_1
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_VARIANT_2
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_MAPS_EXTENDED
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_MAPS_SLIM
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_SEARCH_EXTENDED
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_SEARCH_SLIM
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_ISOLATED_MAPS_EXTENDED
- HOME_ADDRESS_MISSING_ADD_HOME_ADDRESS_ADVICE_ISOLATED_SEARCH_EXTENDED
|
|---|
| enumDescriptions | - Show Add recovery phone advice with variant 1 IFF user has no recovery option.
- Show Add recovery phone advice with no description variant 1 IFF user has no recovery option.
- Show Add recovery phone advice with gmail variant 1 IFF user has no recovery option.
- Show Add recovery phone advice with variant 1 IFF user has no recovery option. Never show badge.
- Show Add recovery phone advice IFF user has no recovery phone set.
- Show Add recovery phone advice IFF user has no recovery phone set.
- Show Add recovery phone photos variant advice IFF user has no recovery phone set.
- Show Add recovery phone drive variant advice IFF user has no recovery phone set.
- Show Add recovery phone gmail variant advice IFF user has no recovery phone set.
- Show Add recovery email advice IFF user has no recovery email and already has a recovery phone set.
- Show Add recovery email photos variant advice IFF user has no recovery email and already has a recovery phone set.
- Show Add recovery email drive variant advice IFF user has no recovery email and already has a recovery phone set.
- Show Add recovery email gmail variant advice IFF user has no recovery email and already has a recovery phone set.
- Show Add home address advice with variant 1 IFF user has no home address present.
- Show Add home address advice with variant 2 IFF user has no home address present.
- Show Add home address advice with maps variant 1 IFF user has no home address present.
- Show Add home address advice with maps variant 2 IFF user has no home address present.
- Show Add home address advice with search variant 1 IFF user has no home address present.
- Show Add home address advice with search variant 2 IFF user has no home address present.
- Show Add home address advice with maps variant 1 IFF user has no home address present with other non critical advice disabled.
- Show Add home address advice with search variant 1 IFF user has no home address present with other non critical advice disabled.
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
| context | | $ref | Context |
|---|
| description | Context of the triggering call, e.g. version/CL, platform, etc |
|---|
|
|---|
| surfaces | | description | List of surfaces to fetch messages for: OneGoogle account particle disk, OneGoogle account menu, etc |
|---|
| items | | enum | - SURFACE_UNSPECIFIED
- ACCOUNT_PARTICLE_DISC
- ACCOUNT_MENU
- BENTO_ACCOUNT_MENU
- BENTO_ACCOUNT_PARTICLE_DISC
|
|---|
| enumDescriptions | - Default value, should never be used
- OneGoogle account particle disc which will open SafetyExp account menu on tap.
- OneGoogle account menu only used for SafetyExp
- OneGoogle bento account menu
- OneGoogle account particle disc which will open Bento account menu on tap.
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
| triggeringEvent | | $ref | TriggeringEvent |
|---|
| description | The event that triggered the fetching, e.g. OneGoogle account menu has opened. Allows server to decide what data source to use (cached or live data) and what other actions to perform, e.g. dismiss the badge if account menu was open |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountMessagesResponse | | description | Response for the GetAccountMessages RPC |
|---|
| id | AccountMessagesResponse |
|---|
| properties | | accountAdvices | | description | List of active advices to show the user |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
| accountMenu | | $ref | AccountMenu |
|---|
| description | Only used for SafetyExp |
|---|
|
|---|
| accountParticleDisc | |
|---|
| isServerDarkLaunch | | description | The server is currently in a ‘dark launch’ state. |
|---|
| type | boolean |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AccountParticleDisc | | description | Data to render OneGoogle account particle disc |
|---|
| id | AccountParticleDisc |
|---|
| properties | | badgeDismissalEvents | | items | | enum | - BADGE_DISMISSAL_EVENT_UNSPECIFIED
- ACCOUNT_MENU_OPENED
|
|---|
| enumDescriptions | - Shouldn't be used
- User has opened account menu
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
| badgeStatus | | enum | - BADGE_STATUS_UNSPECIFIED
- NONE
- ATTENTION
|
|---|
| enumDescriptions | - No information about badge status
- No badge
- Attention badge (yellow)
|
|---|
| type | string |
|---|
|
|---|
| version | |
|---|
|
|---|
| type | object |
|---|
|
|---|
| AdditionalInfo | | description | Additional miscellaneous information included with the advice. |
|---|
| id | AdditionalInfo |
|---|
| properties | | numExistingRecoveryFactors | | description | Number of existing recovery factors the user has. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AdviceDestination | | description | Destination to open once Bento account advice CTA is clicked |
|---|
| id | AdviceDestination |
|---|
| properties | | resourceKey | | $ref | ResourceKey |
|---|
| description | Resource to open in the Google Account |
|---|
|
|---|
| url | | $ref | SafeUrlProto |
|---|
| description | URL to open in the browser |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AlertDestination | | description | Destination to open once OneGoogle account menu entrypoint is clicked |
|---|
| id | AlertDestination |
|---|
| properties | | resourceKey | | $ref | ResourceKey |
|---|
| description | Resource to open in the Google Account |
|---|
|
|---|
| url | | $ref | SafeUrlProto |
|---|
| description | URL to open in the browser |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| AndroidClientVersion | | id | AndroidClientVersion |
|---|
| properties | | androidOsSdk | | description | The Android OS SDK version, e.g. 28 (Android 9 is SDK 28). |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| androidOsVersion | | description | The Android OS version, e.g. "5.1.1" |
|---|
| type | string |
|---|
|
|---|
| callingAndroidApp | | description | ApplicationId (package name) or alias of the app that initiated the request |
|---|
| type | string |
|---|
|
|---|
| gmscoreVersionCode | | description | GmsCore version code which is defined in google3/java/com/google/android/gmscore/integ/package/common-base/src/com/google/android/gms/common/util/VersionUtils.java getVersionCode(), e.g. 18477021 |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| gmscoreVersionName | | description | GmsCore info which is defined in google3/java/com/google/android/gmscore/integ/package/common-base/src/com/google/android/gms/common/util/VersionUtils.java getVersionName(), e.g. "18.4.77 (eng-040408-254230773)" |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| Context | | description | The version of a specific piece of client software. Used mainly for logging, metrics and debugging. Can be used in future for graceful degradation of features for outdated client versions |
|---|
| id | Context |
|---|
| properties | | androidClientVersion | |
|---|
| hideEntryPointIfViewed | | description | If true, don't show EP once Y days have passed since the user viewed it. |
|---|
| type | boolean |
|---|
|
|---|
| hideEntryPointIfVisited | | description | If true, don't show EP once X days have passed since the user clicked it. |
|---|
| type | boolean |
|---|
|
|---|
| iosClientVersion | |
|---|
| isClientDarkLaunch | | description | The client is currently in a ‘dark launch’ state. |
|---|
| type | boolean |
|---|
|
|---|
| webClientVersion | |
|---|
|
|---|
| type | object |
|---|
|
|---|
| IOSClientVersion | | id | IOSClientVersion |
|---|
| properties | | 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 |
|---|
|
|---|
| iosBuildChangelist | | description | Changelist that this client was built at. Obtained from google3/googlemac/Shared/Metrics/Phenotype/Classes/PHTPhenotypeBuildData.h |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| OneGoogleTriggeringEvent | | description | OneGoogle specific event that triggered client to fetch the data |
|---|
| id | OneGoogleTriggeringEvent |
|---|
| properties | | reason | | description | Enum describing the reason for the triggering event, e.g. account menu open |
|---|
| enum | - ONE_GOOGLE_TRIGGERING_EVENT_REASON_UNSPECIFIED
- ACCOUNT_MENU_OPENED
- ACCOUNT_SWITCHED
- PERIODIC_POLL
- TICKLE_RECEIVED
- TAB_SWITCH
- SECURITY_ADVISOR_FLOW_COMPLETED
- WEB_PAGE_LOAD
|
|---|
| enumDescriptions | - Default value, should never be used
- User has opened account menu
- User has switched the account
- Library initiated periodic poll
- Library received a tickle to invalidate the state
- User switched tab (using visibility API).
- Security Advisor flow was completed. Only implemented on iOS.
- The page was loaded and APD was rendered. See go/og-badge-ads.
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| 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 |
|---|
|
|---|
| SafeUrlProto | | description | Message containing a string that is safe to use in URL contexts in DOM APIs and HTML documents, where the URL context does not refer to a resource that loads code. |
|---|
| id | SafeUrlProto |
|---|
| properties | | privateDoNotAccessOrElseSafeUrlWrappedValue | | description | IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| TriggeringEvent | | description | Event that triggered client to fetch the data |
|---|
| id | TriggeringEvent |
|---|
| properties | | onegoogleTriggeringEvent | | $ref | OneGoogleTriggeringEvent |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| UpdateAccountMessagesRequest | | description | Request for the UpdateAccountMessages RPC |
|---|
| id | UpdateAccountMessagesRequest |
|---|
| properties | | dismissedAdviceIds | | description | List of advices which are dismissed in this request. E.g. when user explicitly clicked on "Not now/Dismiss" to dismiss the advice screen/7vixUwswqjT7APa |
|---|
| items | |
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| UpdateAccountMessagesResponse | | description | Response for the UpdateAccountMessages RPC. Empty response means success |
|---|
| id | UpdateAccountMessagesResponse |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| Version | | description | A version of account particle disc status that is opaque to the client. To be defined by server and passed to client to pass it back, when needed |
|---|
| id | Version |
|---|
| properties | |
|---|
| type | object |
|---|
|
|---|
| WebClientVersion | | id | WebClientVersion |
|---|
| properties | | buildLabel | | description | Label associated with the build of this binary. See google3/java/com/google/apps/framework/blaze/ImmutableBuildData.kt |
|---|
| type | string |
|---|
|
|---|
| cachedAlertLevel | | description | AlertLevel web client obtained from OGS. This will be used to compare OGS's AlertLevel generation logic with RPS's AlertLevel generation logic. Web client will populate this field on first AM open of their session. See go/safetyexp-state-mismatch |
|---|
| enum | - ALERT_LEVEL_UNSPECIFIED
- NO_ADVICE
- ADVICE
- ADVICE_REQUIRING_ATTENTION
|
|---|
| enumDescriptions | - No information about alert level
- No advice — account is in a good shape
- There is advice available
- There is advice that require attention
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
|
|---|
| old_value | | 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 |
|---|
|
|---|
|
|---|
|
|---|
| root['title'] | | new_value | Reach Private API |
|---|
| old_value | Account Settings Mobile Private API (Staging) |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-afwprovisioning-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-afwprovisioning-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-alioth-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-alioth-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-analyticsintelligence-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['AnalyticsBeReportSearchV2ReportConfig']['properties']['navId']['enum'][225] | ADVERTISING_KEY_EVENTS_SECTION |
|---|
| root['schemas']['AnalyticsBeReportSearchV2ReportConfig']['properties']['navId']['enum'][226] | ADVERTISING_KEY_EVENT_ATTRIBUTION_SECTION |
|---|
| root['schemas']['AnalyticsBeReportSearchV2ReportConfig']['properties']['navId']['enum'][227] | ADVERTISING_CONVERSIONS_SECTION |
|---|
| root['schemas']['AnalyticsBeReportSearchV2ReportConfig']['properties']['navId']['enum'][228] | ADVERTISING_CONVERSION_ATTRIBUTION_SECTION |
|---|
| root['schemas']['AnalyticsBeReportSearchV2ReportConfig']['properties']['navId']['enum'][229] | ADVERTISING_TOOLS_SECTION_V2 |
|---|
| root['schemas']['AnalyticsConfigDataProtoGaCommonCardDeepLink']['properties']['goldNavId']['enum'][225] | ADVERTISING_KEY_EVENTS_SECTION |
|---|
| root['schemas']['AnalyticsConfigDataProtoGaCommonCardDeepLink']['properties']['goldNavId']['enum'][226] | ADVERTISING_KEY_EVENT_ATTRIBUTION_SECTION |
|---|
| root['schemas']['AnalyticsConfigDataProtoGaCommonCardDeepLink']['properties']['goldNavId']['enum'][227] | ADVERTISING_CONVERSIONS_SECTION |
|---|
| root['schemas']['AnalyticsConfigDataProtoGaCommonCardDeepLink']['properties']['goldNavId']['enum'][228] | ADVERTISING_CONVERSION_ATTRIBUTION_SECTION |
|---|
| root['schemas']['AnalyticsConfigDataProtoGaCommonCardDeepLink']['properties']['goldNavId']['enum'][229] | ADVERTISING_TOOLS_SECTION_V2 |
|---|
|
|---|
|
|---|
| sandbox/staging-analyticsintelligence-pa-v2 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['AnalyticsBeReportSearchV2ReportConfig']['properties']['navId']['enum'][225] | ADVERTISING_KEY_EVENTS_SECTION |
|---|
| root['schemas']['AnalyticsBeReportSearchV2ReportConfig']['properties']['navId']['enum'][226] | ADVERTISING_KEY_EVENT_ATTRIBUTION_SECTION |
|---|
| root['schemas']['AnalyticsBeReportSearchV2ReportConfig']['properties']['navId']['enum'][227] | ADVERTISING_CONVERSIONS_SECTION |
|---|
| root['schemas']['AnalyticsBeReportSearchV2ReportConfig']['properties']['navId']['enum'][228] | ADVERTISING_CONVERSION_ATTRIBUTION_SECTION |
|---|
| root['schemas']['AnalyticsBeReportSearchV2ReportConfig']['properties']['navId']['enum'][229] | ADVERTISING_TOOLS_SECTION_V2 |
|---|
| root['schemas']['AnalyticsConfigDataProtoGaCommonCardDeepLink']['properties']['goldNavId']['enum'][225] | ADVERTISING_KEY_EVENTS_SECTION |
|---|
| root['schemas']['AnalyticsConfigDataProtoGaCommonCardDeepLink']['properties']['goldNavId']['enum'][226] | ADVERTISING_KEY_EVENT_ATTRIBUTION_SECTION |
|---|
| root['schemas']['AnalyticsConfigDataProtoGaCommonCardDeepLink']['properties']['goldNavId']['enum'][227] | ADVERTISING_CONVERSIONS_SECTION |
|---|
| root['schemas']['AnalyticsConfigDataProtoGaCommonCardDeepLink']['properties']['goldNavId']['enum'][228] | ADVERTISING_CONVERSION_ATTRIBUTION_SECTION |
|---|
| root['schemas']['AnalyticsConfigDataProtoGaCommonCardDeepLink']['properties']['goldNavId']['enum'][229] | ADVERTISING_TOOLS_SECTION_V2 |
|---|
|
|---|
|
|---|
| sandbox/staging-analyticsmobile-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-analyticsmobile-pa-v2 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-androidauthnimblegateway-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-androidauthnimblegateway-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-auditrecording-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-auditrecording-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-bobaucpcommunity-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-bobaucpcommunity-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-chromereporting-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-chromereporting-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-clientauthconfig- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-clientauthconfig-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-cloudresourcemanager- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250508 |
|---|
|
|---|
| root['schemas']['TagKey']['properties']['shortName']['description'] | | new_value | Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-256 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. |
|---|
| old_value | Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. |
|---|
|
|---|
| root['schemas']['TagValue']['properties']['shortName']['description'] | | new_value | Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey. The short name must be 256 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. |
|---|
| old_value | Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey. The short name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-cloudresourcemanager-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250508 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-cloudresourcemanager-v1beta1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250508 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-cloudresourcemanager-v2 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250508 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-cloudresourcemanager-v2alpha1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250508 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-cloudresourcemanager-v2beta1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250508 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-cloudresourcemanager-v3 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250508 |
|---|
|
|---|
| root['schemas']['TagKey']['properties']['shortName']['description'] | | new_value | Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-256 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. |
|---|
| old_value | Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. |
|---|
|
|---|
| root['schemas']['TagValue']['properties']['shortName']['description'] | | new_value | Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey. The short name must be 256 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. |
|---|
| old_value | Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey. The short name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-enterprisedeviceauth-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-enterprisedeviceauth-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-familymanagement-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-familymanagement-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-fcm- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-fcm-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-fitbit-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-fitbit-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-fitbit-pa-v3 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-fitbit-pa-v4 | | dictionary_item_added | - root['schemas']['RecommendedSleepScheduleComponent']
- root['schemas']['SleepNeed']
- root['schemas']['RichElement']['properties']['recommendedSleepScheduleComponent']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-growth-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-growth-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-identitydevicegateway-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-identitydevicegateway-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-instantmessaging-pa- | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['InstantmessagingStagingPaSandboxPeoplestackFlexorgsProtoInternalExternal']['properties']['application']['enum'][460] | MSS_JUPITER |
|---|
| root['schemas']['InstantmessagingStagingPaSandboxPeoplestackFlexorgsProtoInternalExternal']['properties']['application']['enumDescriptions'][460] | Mss Jupiter Team contact: jupiter-eng@google.com |
|---|
|
|---|
|
|---|
| sandbox/staging-instantmessaging-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['InstantmessagingStagingPaSandboxPeoplestackFlexorgsProtoInternalExternal']['properties']['application']['enum'][460] | MSS_JUPITER |
|---|
| root['schemas']['InstantmessagingStagingPaSandboxPeoplestackFlexorgsProtoInternalExternal']['properties']['application']['enumDescriptions'][460] | Mss Jupiter Team contact: jupiter-eng@google.com |
|---|
|
|---|
|
|---|
| sandbox/staging-jibemessagestore- | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-jibemessagestore-v1 | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-kidsmanagement-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-kidsmanagement-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-kidsnotification-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-kidsnotification-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-locationhistory-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-locationhistory-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-locationhistoryplacedetails-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-locationhistoryplacedetails-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-myphonenumbers-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-myphonenumbers-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-nearbypresence-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-nearbypresence-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-nestauthz-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-nestauthz-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-ogads-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-ogads-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-optimizationguide-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-optimizationguide-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-people-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-people-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-people-pa-v2 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-peoplestack-pa- | | dictionary_item_added | - root['schemas']['PeoplestackGroupMemberInfo']['properties']['createdAt']
- root['schemas']['PeoplestackGroupMemberInfo']['properties']['lastUpdatedAt']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_removed | | root['resources']['autocomplete']['methods']['joinGroup']['scopes'][0] | https://www.googleapis.com/auth/peopleapi.readonly |
|---|
| root['resources']['autocomplete']['methods']['leaveGroup']['scopes'][0] | https://www.googleapis.com/auth/peopleapi.readonly |
|---|
|
|---|
|
|---|
| sandbox/staging-peoplestack-pa-v1 | | dictionary_item_added | - root['schemas']['PeoplestackGroupMemberInfo']['properties']['createdAt']
- root['schemas']['PeoplestackGroupMemberInfo']['properties']['lastUpdatedAt']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_removed | | root['resources']['autocomplete']['methods']['joinGroup']['scopes'][0] | https://www.googleapis.com/auth/peopleapi.readonly |
|---|
| root['resources']['autocomplete']['methods']['leaveGroup']['scopes'][0] | https://www.googleapis.com/auth/peopleapi.readonly |
|---|
|
|---|
|
|---|
| sandbox/staging-phonedeviceverification-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-phonedeviceverification-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-phosphor-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-phosphor-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-playconsoleaudiences-pa- | | dictionary_item_removed | - root['schemas']['DataProjectionUserTagFilter']['properties']['negate']
- root['schemas']['LapsedUserFilterCriteria']['properties']['negate']
- root['schemas']['PurchaseFilterCriteria']['properties']['negate']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-playconsoleaudiences-pa-v1 | | dictionary_item_removed | - root['schemas']['DataProjectionUserTagFilter']['properties']['negate']
- root['schemas']['LapsedUserFilterCriteria']['properties']['negate']
- root['schemas']['PurchaseFilterCriteria']['properties']['negate']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-playconsoledataprojection-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-playconsoledataprojection-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-reach-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-reach-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-restrictedapps-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-restrictedapps-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-safebrowsingohttpgateway- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-safebrowsingohttpgateway-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-scone-pa- | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['CustomerSupportContentFrdVrgSetContainer']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['CustomerSupportContentScFrdValues']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
|
|---|
|
|---|
| sandbox/staging-scone-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['CustomerSupportContentFrdVrgSetContainer']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['CustomerSupportContentScFrdValues']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
|
|---|
|
|---|
| sandbox/staging-semanticlocation-pa- | | dictionary_item_added | - root['schemas']['GeostoreRoadDisruptionProtoIntersectionTraversalProto']
- root['schemas']['GeostoreRoadDisruptionProto']['properties']['affectedIntersectionTraversals']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
| root['schemas']['GeostoreRoadDisruptionProto']['properties']['affectedSegmentPortions']['description'] | | new_value | The set of segments that are affected by this disruption and the portions of those segments that are affected. There must not be more than 750 total values among the 'effects' fields (affected_segment_portions and affected_intersection_traversals) to avoid making FeatureProtos inordinately expensive to read. At least one of affected_segment_portions or affected_intersection_traversals must be set. |
|---|
| old_value | The set of segments that are affected by this disruption. Must have at least one value and not more than 750 values (per downstream processing limitations). |
|---|
|
|---|
| root['schemas']['GeostoreSegmentPortionProto']['properties']['startFraction']['description'] | | new_value | If present, the start and/or end fraction of the segment. Value is in the range [0.0, 1.0]. Start <= end. This can be [1.0, 1.0] to indicate that only the very end of the segment is affected. |
|---|
| old_value | If present, the start and/or end fraction of the segment. Value is in the range [0.0, 1.0]. Start <= end. |
|---|
|
|---|
| root['schemas']['GeostoreSegmentProto']['properties']['gradeLevel']['description'] | | new_value | Detailed information about grade levels along the segment. If a GradeLevelProto is not present for any point (index) along the segment, the default grade level is zero. In between two points (indexes), the grade level of the segment is taken to be the max of the grade levels on either side of it, where the max is taken on the absolute values of the grade level. Mathematically, for a pair of grade levels g_a and g_b, the grade level for the range in-between is the value farther from 0, i.e.: g_ab = |g_a| > |g_b| ? g_a : g_b. See gradelevel.proto for semantics of repeated indexes. |
|---|
| old_value | Detailed information about grade levels along the segment. If a GradeLevelProto is not present for any point (index) along the segment, the default grade level is zero. In between two points (indexes), the grade level of the segment is taken to be the max of the grade levels on either side of it. See gradelevel.proto for semantics of repeated indexes. |
|---|
|
|---|
| root['schemas']['GeostoreSegmentProto']['properties']['roadDisruption']['description'] | | new_value | The road disruptions that affect this segment, whether as a directly affected segment or via an affected intersection traversal. All referenced features should be a subtype of type gcid:road_disruption. This field is not guaranteed to be perfectly in sync with road_disruption's fields because they are not updated together transactionally. |
|---|
| old_value | The road disruptions that affect this segment, whether as a directly affected segment or via an affected segment transition. All referenced features should be a subtype of type gcid:road_disruption. This field is not guaranteed to be perfectly in sync with road_disruption's fields because they are not updated together transactionally. |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['GeostoreFeaturePropertyIdProto']['properties']['fieldType']['enum'][115] | ROAD_DISRUPTION_AFFECTED_INTERSECTION_TRAVERSAL |
|---|
|
|---|
|
|---|
| sandbox/staging-semanticlocation-pa-v1 | | dictionary_item_added | - root['schemas']['GeostoreRoadDisruptionProtoIntersectionTraversalProto']
- root['schemas']['GeostoreRoadDisruptionProto']['properties']['affectedIntersectionTraversals']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
| root['schemas']['GeostoreRoadDisruptionProto']['properties']['affectedSegmentPortions']['description'] | | new_value | The set of segments that are affected by this disruption and the portions of those segments that are affected. There must not be more than 750 total values among the 'effects' fields (affected_segment_portions and affected_intersection_traversals) to avoid making FeatureProtos inordinately expensive to read. At least one of affected_segment_portions or affected_intersection_traversals must be set. |
|---|
| old_value | The set of segments that are affected by this disruption. Must have at least one value and not more than 750 values (per downstream processing limitations). |
|---|
|
|---|
| root['schemas']['GeostoreSegmentPortionProto']['properties']['startFraction']['description'] | | new_value | If present, the start and/or end fraction of the segment. Value is in the range [0.0, 1.0]. Start <= end. This can be [1.0, 1.0] to indicate that only the very end of the segment is affected. |
|---|
| old_value | If present, the start and/or end fraction of the segment. Value is in the range [0.0, 1.0]. Start <= end. |
|---|
|
|---|
| root['schemas']['GeostoreSegmentProto']['properties']['gradeLevel']['description'] | | new_value | Detailed information about grade levels along the segment. If a GradeLevelProto is not present for any point (index) along the segment, the default grade level is zero. In between two points (indexes), the grade level of the segment is taken to be the max of the grade levels on either side of it, where the max is taken on the absolute values of the grade level. Mathematically, for a pair of grade levels g_a and g_b, the grade level for the range in-between is the value farther from 0, i.e.: g_ab = |g_a| > |g_b| ? g_a : g_b. See gradelevel.proto for semantics of repeated indexes. |
|---|
| old_value | Detailed information about grade levels along the segment. If a GradeLevelProto is not present for any point (index) along the segment, the default grade level is zero. In between two points (indexes), the grade level of the segment is taken to be the max of the grade levels on either side of it. See gradelevel.proto for semantics of repeated indexes. |
|---|
|
|---|
| root['schemas']['GeostoreSegmentProto']['properties']['roadDisruption']['description'] | | new_value | The road disruptions that affect this segment, whether as a directly affected segment or via an affected intersection traversal. All referenced features should be a subtype of type gcid:road_disruption. This field is not guaranteed to be perfectly in sync with road_disruption's fields because they are not updated together transactionally. |
|---|
| old_value | The road disruptions that affect this segment, whether as a directly affected segment or via an affected segment transition. All referenced features should be a subtype of type gcid:road_disruption. This field is not guaranteed to be perfectly in sync with road_disruption's fields because they are not updated together transactionally. |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['GeostoreFeaturePropertyIdProto']['properties']['fieldType']['enum'][115] | ROAD_DISRUPTION_AFFECTED_INTERSECTION_TRAVERSAL |
|---|
|
|---|
|
|---|
| sandbox/staging-servicemanagement- | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-servicemanagement-v1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-shieldedids-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-shieldedids-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-speech- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-speech-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-speech-v1p1beta1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-speech-v2 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-speechtotext- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-speechtotext-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-speechtotext-v1p1beta1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-speechtotext-v2 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250509 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-taskassist-pa- | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-taskassist-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-taskassist-pa-v2 | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250511 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-testing- | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250508 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-testing-v1 | | values_changed | | root['revision'] | | new_value | 20250513 |
|---|
| old_value | 20250508 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-threadcredentialsdistribution- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-threadcredentialsdistribution-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-userpanelmobile-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-userpanelmobile-pa-v2 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-verifiablecredentials-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/staging-verifiablecredentials-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-admin- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-admin-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-safebrowsing- | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-safebrowsing-v4 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-safebrowsing-v5 | | dictionary_item_added | - root['resources']['hashList']
- root['resources']['hashLists']
|
|---|
| values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
| root['schemas'] | | new_value | | GoogleSecuritySafebrowsingV5BatchGetHashListsResponse | | description | The response containing multiple hash lists. |
|---|
| id | GoogleSecuritySafebrowsingV5BatchGetHashListsResponse |
|---|
| properties | | hashLists | | description | The hash lists in the same order given in the request. |
|---|
| items | | $ref | GoogleSecuritySafebrowsingV5HashList |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleSecuritySafebrowsingV5FullHash | | description | The full hash identified with one or more matches. |
|---|
| id | GoogleSecuritySafebrowsingV5FullHash |
|---|
| properties | | fullHash | | description | The matching full hash. This is the SHA256 hash. The length will be exactly 32 bytes. |
|---|
| format | byte |
|---|
| type | string |
|---|
|
|---|
| fullHashDetails | | description | Unordered list. A repeated field identifying the details relevant to this full hash. |
|---|
| items | | $ref | GoogleSecuritySafebrowsingV5FullHashFullHashDetail |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleSecuritySafebrowsingV5FullHashFullHashDetail | | description | Details about a matching full hash. An important note about forward compatibility: new threat types and threat attributes may be added by the server at any time; those additions are considered minor version changes. It is Google's policy not to expose minor version numbers in APIs (see https://cloud.google.com/apis/design/versioning for the versioning policy), so clients MUST be prepared to receive `FullHashDetail` messages containing `ThreatType` enum values or `ThreatAttribute` enum values that are considered invalid by the client. Therefore, it is the client's responsibility to check for the validity of all `ThreatType` and `ThreatAttribute` enum values; if any value is considered invalid, the client MUST disregard the entire `FullHashDetail` message. |
|---|
| id | GoogleSecuritySafebrowsingV5FullHashFullHashDetail |
|---|
| properties | | attributes | | description | Unordered list. Additional attributes about those full hashes. This may be empty. |
|---|
| items | | enum | - THREAT_ATTRIBUTE_UNSPECIFIED
- CANARY
- FRAME_ONLY
|
|---|
| enumDescriptions | - Unknown attribute. If this is returned by the server, the client shall disregard the enclosing `FullHashDetail` altogether.
- Indicates that the threat_type should not be used for enforcement.
- Indicates that the threat_type should only be used for enforcement on frames.
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
| threatType | | description | The type of threat. This field will never be empty. |
|---|
| enum | - THREAT_TYPE_UNSPECIFIED
- MALWARE
- SOCIAL_ENGINEERING
- UNWANTED_SOFTWARE
- POTENTIALLY_HARMFUL_APPLICATION
|
|---|
| enumDescriptions | - Unknown threat type. If this is returned by the server, the client shall disregard the enclosing `FullHashDetail` altogether.
- Malware threat type. Malware is any software or mobile application specifically designed to harm a computer, a mobile device, the software it's running, or its users. Malware exhibits malicious behavior that can include installing software without user consent and installing harmful software such as viruses. More information can be found [here](https://developers.google.com/search/docs/monitor-debug/security/malware).
- Social engineering threat type. Social engineering pages falsely purport to act on behalf of a third party with the intention of confusing viewers into performing an action with which the viewer would only trust a true agent of that third party. Phishing is a type of social engineering that tricks the viewer into performing the specific action of providing information, such as login credentials. More information can be found [here](https://developers.google.com/search/docs/monitor-debug/security/social-engineering).
- Unwanted software threat type. Unwanted software is any software that does not adhere to [Google's Software Principles](https://www.google.com/about/software-principles.html) but isn't malware.
- Potentially harmful application threat type [as used by Google Play Protect for the Play Store](https://developers.google.com/android/play-protect/potentially-harmful-applications).
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleSecuritySafebrowsingV5HashList | | description | A list of hashes identified by its name. |
|---|
| id | GoogleSecuritySafebrowsingV5HashList |
|---|
| properties | | additionsEightBytes | | $ref | GoogleSecuritySafebrowsingV5RiceDeltaEncoded64Bit |
|---|
| description | The 8-byte additions. |
|---|
|
|---|
| additionsFourBytes | | $ref | GoogleSecuritySafebrowsingV5RiceDeltaEncoded32Bit |
|---|
| description | The 4-byte additions. |
|---|
|
|---|
| additionsSixteenBytes | | $ref | GoogleSecuritySafebrowsingV5RiceDeltaEncoded128Bit |
|---|
| description | The 16-byte additions. |
|---|
|
|---|
| additionsThirtyTwoBytes | | $ref | GoogleSecuritySafebrowsingV5RiceDeltaEncoded256Bit |
|---|
| description | The 32-byte additions. |
|---|
|
|---|
| compressedRemovals | | $ref | GoogleSecuritySafebrowsingV5RiceDeltaEncoded32Bit |
|---|
| description | The Rice-delta encoded version of removal indices. Since each hash list definitely has less than 2^32 entries, the indices are treated as 32-bit integers and encoded. |
|---|
|
|---|
| metadata | | $ref | GoogleSecuritySafebrowsingV5HashListMetadata |
|---|
| description | Metadata about the hash list. This is not populated by the `GetHashList` method, but this is populated by the `ListHashLists` method. |
|---|
|
|---|
| minimumWaitDuration | | description | Clients should wait at least this long to get the hash list again. If omitted or zero, clients SHOULD fetch immediately because it indicates that the server has an additional update to be sent to the client, but could not due to the client-specified constraints. |
|---|
| format | google-duration |
|---|
| type | string |
|---|
|
|---|
| name | | description | The name of the hash list. Note that the Global Cache is also just a hash list and can be referred to here. |
|---|
| type | string |
|---|
|
|---|
| partialUpdate | | description | When true, this is a partial diff containing additions and removals based on what the client already has. When false, this is the complete hash list. When false, the client MUST delete any locally stored version for this hash list. This means that either the version possessed by the client is seriously out-of-date or the client data is believed to be corrupt. The `compressed_removals` field will be empty. When true, the client MUST apply an incremental update by applying removals and then additions. |
|---|
| type | boolean |
|---|
|
|---|
| sha256Checksum | | description | The sorted list of all hashes, hashed again with SHA256. This is the checksum for the sorted list of all hashes present in the database after applying the provided update. In the case that no updates were provided, the server will omit this field to indicate that the client should use the existing checksum. |
|---|
| format | byte |
|---|
| type | string |
|---|
|
|---|
| version | | description | The version of the hash list. The client MUST NOT manipulate those bytes. |
|---|
| format | byte |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleSecuritySafebrowsingV5HashListMetadata | | description | Metadata about a particular hash list. |
|---|
| id | GoogleSecuritySafebrowsingV5HashListMetadata |
|---|
| properties | | description | | description | A human-readable description about this list. Written in English. |
|---|
| type | string |
|---|
|
|---|
| hashLength | | description | The supported hash length for this hash list. Each hash list will support exactly one length. If a different hash length is introduced for the same set of threat types or safe types, it will be introduced as a separate list with a distinct name and respective hash length set. |
|---|
| enum | - HASH_LENGTH_UNSPECIFIED
- FOUR_BYTES
- EIGHT_BYTES
- SIXTEEN_BYTES
- THIRTY_TWO_BYTES
|
|---|
| enumDescriptions | - Unspecified length.
- Each hash is a four-byte prefix.
- Each hash is an eight-byte prefix.
- Each hash is a sixteen-byte prefix.
- Each hash is a thirty-two-byte full hash.
|
|---|
| type | string |
|---|
|
|---|
| likelySafeTypes | | description | Unordered list. If not empty, this specifies that the hash list represents a list of likely safe hashes, and this enumerates the ways they are considered likely safe. This field is mutually exclusive with the threat_types field. |
|---|
| items | | enum | - LIKELY_SAFE_TYPE_UNSPECIFIED
- GENERAL_BROWSING
- CSD
- DOWNLOAD
|
|---|
| enumDescriptions | - Unknown.
- This site is likely safe enough for general browsing. This is also known as the global cache.
- This site is likely safe enough that there is no need to run Client-Side Detection models or password protection checks.
- This site is likely safe enough that downloads from the site need not be checked.
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
| threatTypes | | description | Unordered list. If not empty, this specifies that the hash list is a kind of threat list, and this enumerates the kind of threats associated with hashes or hash prefixes in this hash list. May be empty if the entry does not represent a threat, i.e. in the case that it represents a likely safe type. |
|---|
| items | | enum | - THREAT_TYPE_UNSPECIFIED
- MALWARE
- SOCIAL_ENGINEERING
- UNWANTED_SOFTWARE
- POTENTIALLY_HARMFUL_APPLICATION
|
|---|
| enumDescriptions | - Unknown threat type. If this is returned by the server, the client shall disregard the enclosing `FullHashDetail` altogether.
- Malware threat type. Malware is any software or mobile application specifically designed to harm a computer, a mobile device, the software it's running, or its users. Malware exhibits malicious behavior that can include installing software without user consent and installing harmful software such as viruses. More information can be found [here](https://developers.google.com/search/docs/monitor-debug/security/malware).
- Social engineering threat type. Social engineering pages falsely purport to act on behalf of a third party with the intention of confusing viewers into performing an action with which the viewer would only trust a true agent of that third party. Phishing is a type of social engineering that tricks the viewer into performing the specific action of providing information, such as login credentials. More information can be found [here](https://developers.google.com/search/docs/monitor-debug/security/social-engineering).
- Unwanted software threat type. Unwanted software is any software that does not adhere to [Google's Software Principles](https://www.google.com/about/software-principles.html) but isn't malware.
- Potentially harmful application threat type [as used by Google Play Protect for the Play Store](https://developers.google.com/android/play-protect/potentially-harmful-applications).
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleSecuritySafebrowsingV5ListHashListsResponse | | description | The response containing metadata about hash lists. |
|---|
| id | GoogleSecuritySafebrowsingV5ListHashListsResponse |
|---|
| properties | | hashLists | | description | The hash lists in an arbitrary order. Only metadata about the hash lists will be included, not the contents. |
|---|
| items | | $ref | GoogleSecuritySafebrowsingV5HashList |
|---|
|
|---|
| type | array |
|---|
|
|---|
| nextPageToken | | description | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleSecuritySafebrowsingV5RiceDeltaEncoded128Bit | | description | Same as `RiceDeltaEncoded32Bit` except this encodes 128-bit numbers. |
|---|
| id | GoogleSecuritySafebrowsingV5RiceDeltaEncoded128Bit |
|---|
| properties | | encodedData | | description | The encoded deltas that are encoded using the Golomb-Rice coder. |
|---|
| format | byte |
|---|
| type | string |
|---|
|
|---|
| entriesCount | | description | The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| firstValueHi | | description | The upper 64 bits of the first entry in the encoded data (hashes). If the field is empty, the upper 64 bits are all zero. |
|---|
| format | uint64 |
|---|
| type | string |
|---|
|
|---|
| firstValueLo | | description | The lower 64 bits of the first entry in the encoded data (hashes). If the field is empty, the lower 64 bits are all zero. |
|---|
| format | uint64 |
|---|
| type | string |
|---|
|
|---|
| riceParameter | | description | The Golomb-Rice parameter. This parameter is guaranteed to be between 99 and 126, inclusive. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleSecuritySafebrowsingV5RiceDeltaEncoded256Bit | | description | Same as `RiceDeltaEncoded32Bit` except this encodes 256-bit numbers. |
|---|
| id | GoogleSecuritySafebrowsingV5RiceDeltaEncoded256Bit |
|---|
| properties | | encodedData | | description | The encoded deltas that are encoded using the Golomb-Rice coder. |
|---|
| format | byte |
|---|
| type | string |
|---|
|
|---|
| entriesCount | | description | The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| firstValueFirstPart | | description | The first 64 bits of the first entry in the encoded data (hashes). If the field is empty, the first 64 bits are all zero. |
|---|
| format | uint64 |
|---|
| type | string |
|---|
|
|---|
| firstValueFourthPart | | description | The last 64 bits of the first entry in the encoded data (hashes). If the field is empty, the last 64 bits are all zero. |
|---|
| format | uint64 |
|---|
| type | string |
|---|
|
|---|
| firstValueSecondPart | | description | The 65 through 128th bits of the first entry in the encoded data (hashes). If the field is empty, the 65 through 128th bits are all zero. |
|---|
| format | uint64 |
|---|
| type | string |
|---|
|
|---|
| firstValueThirdPart | | description | The 129 through 192th bits of the first entry in the encoded data (hashes). If the field is empty, the 129 through 192th bits are all zero. |
|---|
| format | uint64 |
|---|
| type | string |
|---|
|
|---|
| riceParameter | | description | The Golomb-Rice parameter. This parameter is guaranteed to be between 227 and 254, inclusive. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleSecuritySafebrowsingV5RiceDeltaEncoded32Bit | | description | The Rice-Golomb encoded data. Used for either hashes or removal indices. It is guaranteed that every hash or index here has the same length, and this length is exactly 32 bits. Generally speaking, if we sort all the entries lexicographically, we will find that the higher order bits tend not to change as frequently as lower order bits. This means that if we also take the adjacent difference between entries, the higher order bits have a high probability of being zero. This exploits this high probability of zero by essentially choosing a certain number of bits; all bits more significant than this are likely to be zero so we use unary encoding. See the `rice_parameter` field. Historical note: the Rice-delta encoding was first used in V4 of this API. In V5, two significant improvements were made: firstly, the Rice-delta encoding is now available with hash prefixes longer than 4 bytes; secondly, the encoded data are now treated as big-endian so as to avoid a costly sorting step. |
|---|
| id | GoogleSecuritySafebrowsingV5RiceDeltaEncoded32Bit |
|---|
| properties | | encodedData | | description | The encoded deltas that are encoded using the Golomb-Rice coder. |
|---|
| format | byte |
|---|
| type | string |
|---|
|
|---|
| entriesCount | | description | The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| firstValue | | description | The first entry in the encoded data (hashes or indices), or, if only a single hash prefix or index was encoded, that entry's value. If the field is empty, the entry is zero. |
|---|
| format | uint32 |
|---|
| type | integer |
|---|
|
|---|
| riceParameter | | description | The Golomb-Rice parameter. This parameter is guaranteed to be between 3 and 30, inclusive. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleSecuritySafebrowsingV5RiceDeltaEncoded64Bit | | description | Same as `RiceDeltaEncoded32Bit` except this encodes 64-bit numbers. |
|---|
| id | GoogleSecuritySafebrowsingV5RiceDeltaEncoded64Bit |
|---|
| properties | | encodedData | | description | The encoded deltas that are encoded using the Golomb-Rice coder. |
|---|
| format | byte |
|---|
| type | string |
|---|
|
|---|
| entriesCount | | description | The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
| firstValue | | description | The first entry in the encoded data (hashes), or, if only a single hash prefix was encoded, that entry's value. If the field is empty, the entry is zero. |
|---|
| format | uint64 |
|---|
| type | string |
|---|
|
|---|
| riceParameter | | description | The Golomb-Rice parameter. This parameter is guaranteed to be between 35 and 62, inclusive. |
|---|
| format | int32 |
|---|
| type | integer |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleSecuritySafebrowsingV5SearchHashesResponse | | description | The response returned after searching threat hashes. If nothing is found, the server will return an OK status (HTTP status code 200) with the `full_hashes` field empty, rather than returning a NOT_FOUND status (HTTP status code 404). **What's new in V5**: There is a separation between `FullHash` and `FullHashDetail`. In the case when a hash represents a site having multiple threats (e.g. both MALWARE and SOCIAL_ENGINEERING), the full hash does not need to be sent twice as in V4. Furthermore, the cache duration has been simplified into a single `cache_duration` field. |
|---|
| id | GoogleSecuritySafebrowsingV5SearchHashesResponse |
|---|
| properties | | cacheDuration | | description | The client-side cache duration. The client MUST add this duration to the current time to determine the expiration time. The expiration time then applies to every hash prefix queried by the client in the request, regardless of how many full hashes are returned in the response. Even if the server returns no full hashes for a particular hash prefix, this fact MUST also be cached by the client. If and only if the field `full_hashes` is empty, the client MAY increase the `cache_duration` to determine a new expiration that is later than that specified by the server. In any case, the increased cache duration must not be longer than 24 hours. Important: the client MUST NOT assume that the server will return the same cache duration for all responses. The server MAY choose different cache durations for different responses depending on the situation. |
|---|
| format | google-duration |
|---|
| type | string |
|---|
|
|---|
| fullHashes | | description | Unordered list. The unordered list of full hashes found. |
|---|
| items | | $ref | GoogleSecuritySafebrowsingV5FullHash |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
|
|---|
| old_value | | GoogleSecuritySafebrowsingV5FullHash | | description | The full hash identified with one or more matches. |
|---|
| id | GoogleSecuritySafebrowsingV5FullHash |
|---|
| properties | | fullHash | | description | The matching full hash. This is the SHA256 hash. The length will be exactly 32 bytes. |
|---|
| format | byte |
|---|
| type | string |
|---|
|
|---|
| fullHashDetails | | description | Unordered list. A repeated field identifying the details relevant to this full hash. |
|---|
| items | | $ref | GoogleSecuritySafebrowsingV5FullHashFullHashDetail |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleSecuritySafebrowsingV5FullHashFullHashDetail | | description | Details about a matching full hash. An important note about forward compatibility: new threat types and threat attributes may be added by the server at any time; those additions are considered minor version changes. It is Google's policy not to expose minor version numbers in APIs (see https://cloud.google.com/apis/design/versioning for the versioning policy), so clients MUST be prepared to receive `FullHashDetail` messages containing `ThreatType` enum values or `ThreatAttribute` enum values that are considered invalid by the client. Therefore, it is the client's responsibility to check for the validity of all `ThreatType` and `ThreatAttribute` enum values; if any value is considered invalid, the client MUST disregard the entire `FullHashDetail` message. |
|---|
| id | GoogleSecuritySafebrowsingV5FullHashFullHashDetail |
|---|
| properties | | attributes | | description | Unordered list. Additional attributes about those full hashes. This may be empty. |
|---|
| items | | enum | - THREAT_ATTRIBUTE_UNSPECIFIED
- CANARY
- FRAME_ONLY
|
|---|
| enumDescriptions | - Unknown attribute. If this is returned by the server, the client shall disregard the enclosing `FullHashDetail` altogether.
- Indicates that the threat_type should not be used for enforcement.
- Indicates that the threat_type should only be used for enforcement on frames.
|
|---|
| type | string |
|---|
|
|---|
| type | array |
|---|
|
|---|
| threatType | | description | The type of threat. This field will never be empty. |
|---|
| enum | - THREAT_TYPE_UNSPECIFIED
- MALWARE
- SOCIAL_ENGINEERING
- UNWANTED_SOFTWARE
- POTENTIALLY_HARMFUL_APPLICATION
|
|---|
| enumDescriptions | - Unknown threat type. If this is returned by the server, the client shall disregard the enclosing `FullHashDetail` altogether.
- Malware threat type. Malware is any software or mobile application specifically designed to harm a computer, a mobile device, the software it's running, or its users. Malware exhibits malicious behavior that can include installing software without user consent and installing harmful software such as viruses. More information can be found [here](https://developers.google.com/search/docs/monitor-debug/security/malware).
- Social engineering threat type. Social engineering pages falsely purport to act on behalf of a third party with the intention of confusing viewers into performing an action with which the viewer would only trust a true agent of that third party. Phishing is a type of social engineering that tricks the viewer into performing the specific action of providing information, such as login credentials. More information can be found [here](https://developers.google.com/search/docs/monitor-debug/security/social-engineering).
- Unwanted software threat type. Unwanted software is any software that does not adhere to [Google's Software Principles](https://www.google.com/about/software-principles.html) but isn't malware.
- Potentially harmful application threat type [as used by Google Play Protect for the Play Store](https://developers.google.com/android/play-protect/potentially-harmful-applications).
|
|---|
| type | string |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
| GoogleSecuritySafebrowsingV5SearchHashesResponse | | description | The response returned after searching threat hashes. If nothing is found, the server will return an OK status (HTTP status code 200) with the `full_hashes` field empty, rather than returning a NOT_FOUND status (HTTP status code 404). **What's new in V5**: There is a separation between `FullHash` and `FullHashDetail`. In the case when a hash represents a site having multiple threats (e.g. both MALWARE and SOCIAL_ENGINEERING), the full hash does not need to be sent twice as in V4. Furthermore, the cache duration has been simplified into a single `cache_duration` field. |
|---|
| id | GoogleSecuritySafebrowsingV5SearchHashesResponse |
|---|
| properties | | cacheDuration | | description | The client-side cache duration. The client MUST add this duration to the current time to determine the expiration time. The expiration time then applies to every hash prefix queried by the client in the request, regardless of how many full hashes are returned in the response. Even if the server returns no full hashes for a particular hash prefix, this fact MUST also be cached by the client. If and only if the field `full_hashes` is empty, the client MAY increase the `cache_duration` to determine a new expiration that is later than that specified by the server. In any case, the increased cache duration must not be longer than 24 hours. Important: the client MUST NOT assume that the server will return the same cache duration for all responses. The server MAY choose different cache durations for different responses depending on the situation. |
|---|
| format | google-duration |
|---|
| type | string |
|---|
|
|---|
| fullHashes | | description | Unordered list. The unordered list of full hashes found. |
|---|
| items | | $ref | GoogleSecuritySafebrowsingV5FullHash |
|---|
|
|---|
| type | array |
|---|
|
|---|
|
|---|
| type | object |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-safebrowsing-v5alpha1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-scone-pa- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['CustomerSupportContentFrdVrgSetContainer']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['CustomerSupportContentScFrdValues']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
|
|---|
|
|---|
| sandbox/test-scone-pa-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
| iterable_item_added | | root['schemas']['CustomerSupportContentFrdVrgSetContainer']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['CustomerSupportContentScFrdValues']['properties']['vrgUsage']['enum'][8] | VRG_USAGE_SUMMER_TAG |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorContext']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['EngageApiSharedCmsConfigurationFieldRelationshipDescriptorValue']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidGetTreeRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1CidSearchRequest']['properties']['frdId']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1GetAvailableValuesForGraphRequest']['properties']['resultFrdIdentifierMask']['items']['enumDescriptions'][1163] | b/411004915 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][880] | IDENTIFIER_PLAY_DEVELOPER_MERCHANT_PAYMENT_PROFILE_ID |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enum'][1163] | IDENTIFIER_TRUST_AND_SAFETY_REQUESTING_TEAM |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][880] | b/407786230 |
|---|
| root['schemas']['SconeV1UserSpecificFrdValuesGetRequest']['properties']['frdIdentifier']['enumDescriptions'][1163] | b/411004915 |
|---|
|
|---|
|
|---|
| sandbox/test-speech- | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-speech-v1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-speech-v1p1beta1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-speech-v2 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-speechtotext- | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-speechtotext-v1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-speechtotext-v1p1beta1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-speechtotext-v2 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-userlocation- | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-userlocation-v1 | | values_changed | | root['revision'] | | new_value | 20250514 |
|---|
| old_value | 20250512 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-vision- | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250510 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-vision-v1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250510 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-vision-v1p1beta1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250510 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-vision-v1p2beta1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250510 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-vision-v1p3beta1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250510 |
|---|
|
|---|
|
|---|
|
|---|
| sandbox/test-vision-v1p4beta1 | | values_changed | | root['revision'] | | new_value | 20250515 |
|---|
| old_value | 20250510 |
|---|
|
|---|
|
|---|
|
|---|