sandbox/alpha-scone-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/alpha-scone-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/autopush-accountsettingsmobile-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/autopush-accountsettingsmobile-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/autopush-afwprovisioning-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/autopush-afwprovisioning-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/autopush-auditrecording-pa-
values_changed
root['revision']
new_value20250518
old_value20250514
iterable_item_added
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodComponent']['properties']['componentId']['enum'][243]REUBEN_SERVER
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodComponent']['properties']['componentId']['enumDescriptions'][243]go/reuben-backend-design - Reuben
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][435]PAISA_MERCHANT_CREDIT_REPORT_FETCH_CONSENT_ACCEPTED
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][436]PAISA_MERCHANT_CREDIT_REPORT_PERSONALIZATION_CONSENT_ACCEPTED
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][517]REUBEN_TOS_CONSENT
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][435]Event specifying that the merchant has accepted the credit report fetch consent.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][436]Event specifying that the merchant has accepted the credit report personalization consent.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][517]The user has given consent to the Reuben app.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enum'][719]PAISA_MERCHANT_LOAN_APPLICATION_FLOW_CREDIT_REPORT_FETCH_SCREEN
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enum'][925]REUBEN_TOS_CONSENT_SCREEN
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enumDescriptions'][719]User going through the Credit Report Fetch screen in the loan application journey in Merchant Credit microapp. Ref: go/cibil-in-merchant-credit-application-flow
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enumDescriptions'][925]Reuben consent.
sandbox/autopush-auditrecording-pa-v1
values_changed
root['revision']
new_value20250518
old_value20250514
iterable_item_added
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodComponent']['properties']['componentId']['enum'][243]REUBEN_SERVER
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodComponent']['properties']['componentId']['enumDescriptions'][243]go/reuben-backend-design - Reuben
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][435]PAISA_MERCHANT_CREDIT_REPORT_FETCH_CONSENT_ACCEPTED
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][436]PAISA_MERCHANT_CREDIT_REPORT_PERSONALIZATION_CONSENT_ACCEPTED
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][517]REUBEN_TOS_CONSENT
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][435]Event specifying that the merchant has accepted the credit report fetch consent.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][436]Event specifying that the merchant has accepted the credit report personalization consent.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][517]The user has given consent to the Reuben app.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enum'][719]PAISA_MERCHANT_LOAN_APPLICATION_FLOW_CREDIT_REPORT_FETCH_SCREEN
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enum'][925]REUBEN_TOS_CONSENT_SCREEN
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enumDescriptions'][719]User going through the Credit Report Fetch screen in the loan application journey in Merchant Credit microapp. Ref: go/cibil-in-merchant-credit-application-flow
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enumDescriptions'][925]Reuben consent.
sandbox/autopush-familymanagement-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/autopush-googleonebackup-pa-
dictionary_item_added
  • root['resources']['backups']['methods']['commitTransaction']['parameters']['backupId']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['deleteBackupConfig']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['get']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['get']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['list']['parameters']['pageSize']['description']
  • root['resources']['backups']['methods']['list']['parameters']['pageToken']['description']
  • root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['list']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['startTransaction']['parameters']['backupId']['description']
  • root['resources']['backups']['methods']['updateConfig']['parameters']['androidId']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['fileId']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['transactionId']['description']
  • root['resources']['backups']['resources']['files']['methods']['deleteFiles']['parameters']['backupId']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['backupId']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['pageSize']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['pageToken']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['transactionId']['description']
  • root['resources']['media']['methods']['download']['parameters']['fileId']['description']
  • root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['media']['methods']['download']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['media']['methods']['download']['parameters']['transactionId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['backupId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['fileName']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.currentBytes']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.customData']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.diffObjectVersion']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.finalStatus']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.requestId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.requestReceivedParamsServingInfo']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.totalBytes']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.totalBytesIsEstimated']['description']
  • root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['media']['methods']['upload']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['media']['methods']['upload']['parameters']['transactionId']['description']
values_changed
root['baseUrl']
new_valuehttps://staging-mmsbackup.pa.googleapis.com/
old_valuehttps://autopush-googleonebackup-pa.sandbox.googleapis.com/
root['canonicalName']
new_valueMMS Backup Service
old_valueOne Backup
root['description']
new_valuemmsbackup.pa.googleapis.com API.
old_valueA boq-generated 1P API. For more information, see https://boq.corp.google.com/google3/java/com/google/subscriptions/backup/service
root['documentationLink']
new_valuehttps://support.google.com/android/answer/2819582
old_valuehttps://boq.corp.google.com/google3/java/com/google/subscriptions/backup/service
root['id']
new_valuepa_mmsbackup:v1
old_valueautopush_googleonebackup_pa_sandbox:v1
root['mtlsRootUrl']
new_valuehttps://staging-mmsbackup.pa.mtls.googleapis.com/
old_valuehttps://autopush-googleonebackup-pa.mtls.sandbox.googleapis.com/
root['name']
new_valuepa_mmsbackup
old_valueautopush_googleonebackup_pa_sandbox
root['resources']['backups']['methods']['commitTransaction']['description']
new_valueCommits the current active read-write transaction. All file changes are committed atomically. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if either backup or transaction doesn't exist. Already committed transactions are considered as non-existent. Returns a RESOURCE_EXHAUSTED canonical code if user doesn't have sufficient cloud storage capacity. Extract CommitTransactionResourceExhaustedFailureReason from RPC status to learn the exact reason. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['commitTransaction']['id']
new_valuepa_mmsbackup.backups.commitTransaction
old_valueautopush_googleonebackup_pa_sandbox.backups.commitTransaction
root['resources']['backups']['methods']['commitTransaction']['request']['$ref']
new_valueCommitTransactionRequest
old_valueGoogleSubscriptionsBackupV1CommitTransactionRequest
root['resources']['backups']['methods']['commitTransaction']['response']['$ref']
new_valueCommitTransactionResponse
old_valueGoogleSubscriptionsBackupV1CommitTransactionResponse
root['resources']['backups']['methods']['create']['description']
new_valueCreates a new backup. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns an ALREADY_EXISTS canonical code if a backup for the provided GServices Android ID already exists. Returns a FAILED_PRECONDITION canonical code if GoogleOne backup already exist but it's an orphan - it's not present in Android Backup storage but already exists in Moscato. This can happen if backup deletion partially succeeded - backup was removed from Android Backup storage but deletion from Moscato failed. FAILED_PRECONDITION is also thrown if device is not initialized in Android Backup Storage, which means that Android backup flow hasn't yet started. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['create']['id']
new_valuepa_mmsbackup.backups.create
old_valueautopush_googleonebackup_pa_sandbox.backups.create
root['resources']['backups']['methods']['create']['request']['$ref']
new_valueCreateBackupRequest
old_valueGoogleSubscriptionsBackupV1CreateBackupRequest
root['resources']['backups']['methods']['create']['response']['$ref']
new_valueBackup
old_valueGoogleSubscriptionsBackupV1Backup
root['resources']['backups']['methods']['delete']['description']
new_valueDeletes the backup and all of its files. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a NOT_FOUND canonical code if the backup doesn't exist. Returns a FAILED_PRECONDITION if device is not initialized in Android Backup Storage, which means that Android backup flow hasn't yet started. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['delete']['id']
new_valuepa_mmsbackup.backups.delete
old_valueautopush_googleonebackup_pa_sandbox.backups.delete
root['resources']['backups']['methods']['delete']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['methods']['deleteBackupConfig']['description']
new_valueDeletes the backup configuration. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a NOT_FOUND canonical code if the backup configuration doesn't exist. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['deleteBackupConfig']['id']
new_valuepa_mmsbackup.backups.deleteBackupConfig
old_valueautopush_googleonebackup_pa_sandbox.backups.deleteBackupConfig
root['resources']['backups']['methods']['deleteBackupConfig']['request']['$ref']
new_valueDeleteBackupConfigRequest
old_valueGoogleSubscriptionsBackupV1DeleteBackupConfigRequest
root['resources']['backups']['methods']['deleteBackupConfig']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['methods']['get']['description']
new_valueGets the backup for the provided GServices Android ID. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if the backups doesn't exist. Returns a FAILED_PRECONDITION canonical code if the requested backup is an orphan - it's not present in Android Backup storage but still exists in Moscato. This can happen if backup deletion partially succeeeded - backup was removed from Android Backup storage but deletion from Moscato failed. FAILED_PRECONDITION is also thrown if device is not initialized in Android Backup Storage, which means that Android backup flow hasn't yet started. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['get']['id']
new_valuepa_mmsbackup.backups.get
old_valueautopush_googleonebackup_pa_sandbox.backups.get
root['resources']['backups']['methods']['get']['response']['$ref']
new_valueBackup
old_valueGoogleSubscriptionsBackupV1Backup
root['resources']['backups']['methods']['getConfig']['description']
new_valueReturns backup configuration for the pair of Gaia ID (extracted from EUC) and GServices Android ID from the request. Returns the default configuration (see BackupConfiguration proto for details) if there is nothing in Spanner. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['getConfig']['id']
new_valuepa_mmsbackup.backups.getConfig
old_valueautopush_googleonebackup_pa_sandbox.backups.getConfig
root['resources']['backups']['methods']['getConfig']['response']['$ref']
new_valueBackupConfig
old_valueGoogleSubscriptionsBackupV1BackupConfig
root['resources']['backups']['methods']['list']['description']
new_valueGets a list of backups for the current user. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['list']['id']
new_valuepa_mmsbackup.backups.list
old_valueautopush_googleonebackup_pa_sandbox.backups.list
root['resources']['backups']['methods']['list']['response']['$ref']
new_valueListBackupsResponse
old_valueGoogleSubscriptionsBackupV1ListBackupsResponse
root['resources']['backups']['methods']['startTransaction']['description']
new_valueStarts a long-running transaction. The timeout for read-only transactions is 48 hours, for read-write transactions - 2 weeks. The client is allowed to have multiple read-only transactions at the same time. The client is not allowed to have multiple read-write transactions at the same time. An attempt to create a read-write transaction would abort existing read-write transaction if any. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if the backup doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['startTransaction']['id']
new_valuepa_mmsbackup.backups.startTransaction
old_valueautopush_googleonebackup_pa_sandbox.backups.startTransaction
root['resources']['backups']['methods']['startTransaction']['request']['$ref']
new_valueStartTransactionRequest
old_valueGoogleSubscriptionsBackupV1StartTransactionRequest
root['resources']['backups']['methods']['startTransaction']['response']['$ref']
new_valueTransaction
old_valueGoogleSubscriptionsBackupV1Transaction
root['resources']['backups']['methods']['updateConfig']['description']
new_valueCreates/updates backup configuration for the pair of Gaia ID (extracted from EUC) and GServices Android ID from the request. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['updateConfig']['id']
new_valuepa_mmsbackup.backups.updateConfig
old_valueautopush_googleonebackup_pa_sandbox.backups.updateConfig
root['resources']['backups']['methods']['updateConfig']['request']['$ref']
new_valueUpdateBackupConfigRequest
old_valueGoogleSubscriptionsBackupV1UpdateBackupConfigRequest
root['resources']['backups']['methods']['updateConfig']['response']['$ref']
new_valueBackupConfig
old_valueGoogleSubscriptionsBackupV1BackupConfig
root['resources']['backups']['resources']['files']['methods']['delete']['description']
new_valueStages the file to be deleted once the current transaction is committed. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a NOT_FOUND canonical code if the backup or the file doesn't exist. Returns a FAILED_PRECONDITION code if transaction doesn't exist. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['resources']['files']['methods']['delete']['id']
new_valuepa_mmsbackup.backups.files.delete
old_valueautopush_googleonebackup_pa_sandbox.backups.files.delete
root['resources']['backups']['resources']['files']['methods']['delete']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['description']
new_valueStages a group of files to be deleted once the current transaction is committed. Does nothing if file(s) are missing. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a FAILED_PRECONDITION canonical code if transaction doesn't exist or if read-only transaction was provided. Returns a NOT_FOUND canonical code if backup doesn't exist. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['id']
new_valuepa_mmsbackup.backups.files.deleteFiles
old_valueautopush_googleonebackup_pa_sandbox.backups.files.deleteFiles
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['request']['$ref']
new_valueDeleteFilesRequest
old_valueGoogleSubscriptionsBackupV1DeleteFilesRequest
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['resources']['files']['methods']['list']['description']
new_valueLists all the files in a given backup. Returns an empty list if the backup is empty. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if either the backup or the transaction doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['resources']['files']['methods']['list']['id']
new_valuepa_mmsbackup.backups.files.list
old_valueautopush_googleonebackup_pa_sandbox.backups.files.list
root['resources']['backups']['resources']['files']['methods']['list']['response']['$ref']
new_valueListFilesResponse
old_valueGoogleSubscriptionsBackupV1ListFilesResponse
root['resources']['media']['methods']['download']['description']
new_valueExports the file. This will send the actual file bytes to the client. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if the requested file doesn't exist. Returns a FAILED_PRECONDITION canonical code if the provided transaction or the backup doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['media']['methods']['download']['id']
new_valuepa_mmsbackup.media.download
old_valueautopush_googleonebackup_pa_sandbox.media.download
root['resources']['media']['methods']['download']['response']['$ref']
new_valueFile
old_valueGoogleSubscriptionsBackupV1File
root['resources']['media']['methods']['upload']['description']
new_valueUpdates the file and returns its updated metadata. If the file doesn't exist, then this will create a new file. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a FAILED_PRECONDITION canonical code if transaction doesn't exist. Returns a NOT_FOUND canonical code if the backup doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['media']['methods']['upload']['id']
new_valuepa_mmsbackup.media.upload
old_valueautopush_googleonebackup_pa_sandbox.media.upload
root['resources']['media']['methods']['upload']['request']['$ref']
new_valueFile
old_valueGoogleSubscriptionsBackupV1File
root['resources']['media']['methods']['upload']['response']['$ref']
new_valueFile
old_valueGoogleSubscriptionsBackupV1File
root['revision']
new_value20250517
old_value20250412
root['rootUrl']
new_valuehttps://staging-mmsbackup.pa.googleapis.com/
old_valuehttps://autopush-googleonebackup-pa.sandbox.googleapis.com/
root['schemas']
new_value
ApiRequestHeader
descriptionHeader for requests sent to Google One Backup API.
idApiRequestHeader
properties
clientInfo
$refClientInfo
descriptionOptional info about the client calling the API.
experimentOverrides
descriptionOptional experiment overrides. This is a comma-separate list of experiment names. A minus sign can be used to disable an experiment. Example usage: "ExperimentOne": Enables ExperimentOne. "ExperimentOne,-ExperimentTwo": Enables ExperimentOne and disables ExperimentTwo.
typestring
typeobject
Backup
descriptionA backup belonging to a client.
idBackup
properties
activeTransactionId
descriptionThe active read-write transaction for this backup if there is an uncommitted write transaction. Output only.
typestring
backupId
descriptionRequired. The relative resource name of the backup, e.g. "backups/1337". Output only.
typestring
sizeBytes
descriptionAggregate size of all files contained in this backup, in bytes. Output only.
formatint64
typestring
updateTime
descriptionThe time the backup was last updated. Output only.
formatgoogle-datetime
typestring
typeobject
BackupConfig
idBackupConfig
properties
androidSdkVersion
descriptionOptional. If set, specifies the value of the sdk version of android OS.
formatint32
typeinteger
gmsCoreApkVersion
descriptionOptional. If set, specifies the value of the apk version of gms core.
typestring
hasMmsBackupEnabledBefore
descriptionIs set as long as a user has mms backup turned on in the history.
typeboolean
hasRequiredPhotosPermission
descriptionOptional. If set, specifies whether a user has the required photos app permission to send photos_backup_onboarding notifications.
typeboolean
inMsaExperiment
descriptionOptional. If set, specifies whether the user's device is in the experiment group to roll out MMS B&R for everyone using the MSA.
typeboolean
isAndroidBackupEnabled
typeboolean
isAndroidBackupSupported
descriptionIs set if the device satisfies the pre-requisites for Android backup to be performed.
typeboolean
isDeviceEtu
descriptionOptional. If set, specifies the value of whether EBNR is targeted on this device.
typeboolean
isMmsBackupEnabled
descriptionIs always "false" by default or if user is either a Dasher/Unicorn/Griffin user.
typeboolean
isMmsBackupSupported
descriptionIs set if the device satisfies the pre-requisites for Mms backup to be performed.
typeboolean
isPhotosBackupEnabled
typeboolean
isPhotosBackupSupported
descriptionIs set if the device satisfies the pre-requisites for Photos backup to be performed.
typeboolean
isPhotosDefaultGallery
descriptionOptional. If set, specifies the value of whether Photos is the default gallery on this device.
typeboolean
lastAppBackupCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful App Backup action.
formatgoogle-datetime
typestring
photosApkVersion
descriptionOptional. If set, specifies the value of the apk version of photos app.
typestring
systemRestoreCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful System Restore action.
formatgoogle-datetime
typestring
wasMsaShown
descriptionOptional. If set, specifies whether the MSA for MMS enablement was shown previously on this device.
typeboolean
typeobject
Blobstore2Info
descriptionInformation to read/write to blobstore2.
idBlobstore2Info
properties
blobGeneration
descriptionThe blob generation id.
formatint64
typestring
blobId
descriptionThe blob id, e.g., /blobstore/prod/playground/scotty
typestring
downloadReadHandle
descriptionRead handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
formatbyte
typestring
readToken
descriptionThe blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
typestring
uploadMetadataContainer
descriptionMetadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
formatbyte
typestring
typeobject
ClientInfo
descriptionInformation about a particular client calling the API.
idClientInfo
properties
clientId
descriptionRequired client ID of the caller. Behavior of certain RPCs may differ slightly by client ID, according to the client's needs.
enum
  • CLIENT_ID_UNSPECIFIED
  • CLIENT_ID_G1_ANDROID_APP
  • CLIENT_ID_GMSCORE_BACKUP
  • CLIENT_ID_DRIVE_BACKUP
  • CLIENT_ID_MANUAL
  • CLIENT_ID_PROBER
  • CLIENT_ID_PIXELMIGRATE
enumDescriptions
  • Default ID used when no other particular ID applies, or the client has not yet configured a new client ID.
  • Client ID for the G1 Android app.
  • Client ID for the GmsCore backup modules.
  • Client ID for the Drive backup modules.
  • Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
  • Client ID used by service probers.
  • Client ID for the PixelMigrate/Restore Android app.
typestring
version
descriptionRequired. Version of the client. This field is optional for CLIENT_ID_MANUAL client ID.
typestring
typeobject
CommitTransactionRequest
descriptionA request to finish a read-write transaction, committing all file changes atomically.
idCommitTransactionRequest
properties
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
transactionId
descriptionRequired. The id of the transaction to commit.
typestring
typeobject
CommitTransactionResponse
descriptionA transaction commit response.
idCommitTransactionResponse
properties
typeobject
CompositeMedia
descriptionA sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
idCompositeMedia
properties
blobRef
deprecatedTrue
descriptionBlobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
formatbyte
typestring
blobstore2Info
$refBlobstore2Info
descriptionBlobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
cosmoBinaryReference
descriptionA binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
formatbyte
typestring
crc32cHash
descriptioncrc32.c hash for the payload.
formatuint32
typeinteger
inline
descriptionMedia data, set if reference_type is INLINE
formatbyte
typestring
length
descriptionSize of the data, in bytes
formatint64
typestring
md5Hash
descriptionMD5 hash for the payload.
formatbyte
typestring
objectId
$refObjectId
descriptionReference to a TI Blob, set if reference_type is BIGSTORE_REF.
path
descriptionPath to the data, set if reference_type is PATH
typestring
referenceType
descriptionDescribes what the field reference contains.
enum
  • PATH
  • BLOB_REF
  • INLINE
  • BIGSTORE_REF
  • COSMO_BINARY_REFERENCE
enumDescriptions
  • Reference contains a GFS path or a local path.
  • Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.
  • Data is included into this proto buffer
  • Reference points to a bigstore object
  • Indicates the data is stored in cosmo_binary_reference.
typestring
sha1Hash
descriptionSHA-1 hash for the payload.
formatbyte
typestring
typeobject
ContentTypeInfo
descriptionDetailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.
idContentTypeInfo
properties
bestGuess
descriptionScotty's best guess of what the content type of the file is.
typestring
fromBytes
descriptionThe content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
typestring
fromFileName
descriptionThe content type of the file derived from the file extension of the original file name used by the client.
typestring
fromHeader
descriptionThe content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
typestring
fromUrlPath
descriptionThe content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
typestring
typeobject
CreateBackupRequest
idCreateBackupRequest
properties
androidId
descriptionRequired. A value that uniquely identifies user's device to Google's servers.
formatint64
typestring
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
typeobject
DeleteBackupConfigRequest
descriptionA request to delete a backup config.
idDeleteBackupConfigRequest
properties
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
typeobject
DeleteFilesRequest
descriptionRequest to delete a group of files.
idDeleteFilesRequest
properties
fileIds
descriptionThe file ids relative to backup_id, e.g. "data/selfie.jpg" or "foo.txt"
items
typestring
typearray
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
transactionId
descriptionRequired. The transaction to execute the delete in.
typestring
typeobject
DiffChecksumsResponse
descriptionBackend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffChecksumsResponse
properties
checksumsLocation
$refCompositeMedia
descriptionExactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
chunkSizeBytes
descriptionThe chunk size of checksums. Must be a multiple of 256KB.
formatint64
typestring
objectLocation
$refCompositeMedia
descriptionIf set, calculate the checksums based on the contents and return them to the caller.
objectSizeBytes
descriptionThe total size of the server object.
formatint64
typestring
objectVersion
descriptionThe object version of the object the checksums are being returned for.
typestring
typeobject
DiffDownloadResponse
descriptionBackend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffDownloadResponse
properties
objectLocation
$refCompositeMedia
descriptionThe original object location.
typeobject
DiffUploadRequest
descriptionA Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffUploadRequest
properties
checksumsInfo
$refCompositeMedia
descriptionThe location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
objectInfo
$refCompositeMedia
descriptionThe location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
objectVersion
descriptionThe object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
typestring
typeobject
DiffUploadResponse
descriptionBackend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffUploadResponse
properties
objectVersion
descriptionThe object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
typestring
originalObject
$refCompositeMedia
descriptionThe location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
typeobject
DiffVersionResponse
descriptionBackend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffVersionResponse
properties
objectSizeBytes
descriptionThe total size of the server object.
formatint64
typestring
objectVersion
descriptionThe version of the object stored at the server.
typestring
typeobject
DownloadParameters
descriptionParameters specific to media downloads.
idDownloadParameters
properties
allowGzipCompression
descriptionA boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
typeboolean
ignoreRange
descriptionDetermining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
typeboolean
typeobject
Empty
descriptionA 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); }
idEmpty
properties
typeobject
File
descriptionA file belonging to a backup
idFile
properties
blob
$refMedia
descriptionThe blob supplied to/from Scotty.
fileId
descriptionThe relative resource name of the backup, e.g: "backups/31337/files/selfie.jpg"
typestring
mediaResponseInfo
$refMediaResponseInfo
descriptionOutput only. Media response details.
readOnlyTrue
mimeType
descriptionThe mime type of the file contents. May not be needed.
typestring
sizeBytes
descriptionThe size of the file in bytes.
formatint64
typestring
updateTime
descriptionThe time the backup was last updated.
formatgoogle-datetime
typestring
typeobject
ListBackupsResponse
descriptionResponse including a list of G1 backups
idListBackupsResponse
properties
backups
additionalProperties
$refBackup
descriptionA list of backups, mapping from androidId to backup entity.
typeobject
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
typeobject
ListFilesResponse
idListFilesResponse
properties
files
descriptionAll files associated with the backup.
items
$refFile
typearray
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
typeobject
Media
descriptionA reference to data stored on the filesystem, on GFS or in blobstore.
idMedia
properties
algorithm
deprecatedTrue
descriptionDeprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
typestring
bigstoreObjectRef
deprecatedTrue
descriptionUse object_id instead.
formatbyte
typestring
blobRef
deprecatedTrue
descriptionBlobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
formatbyte
typestring
blobstore2Info
$refBlobstore2Info
descriptionBlobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
compositeMedia
descriptionA composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.
items
$refCompositeMedia
typearray
contentType
descriptionMIME type of the data
typestring
contentTypeInfo
$refContentTypeInfo
descriptionExtended content type information provided for Scotty uploads.
cosmoBinaryReference
descriptionA binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
formatbyte
typestring
crc32cHash
descriptionFor Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
formatuint32
typeinteger
diffChecksumsResponse
$refDiffChecksumsResponse
descriptionSet if reference_type is DIFF_CHECKSUMS_RESPONSE.
diffDownloadResponse
$refDiffDownloadResponse
descriptionSet if reference_type is DIFF_DOWNLOAD_RESPONSE.
diffUploadRequest
$refDiffUploadRequest
descriptionSet if reference_type is DIFF_UPLOAD_REQUEST.
diffUploadResponse
$refDiffUploadResponse
descriptionSet if reference_type is DIFF_UPLOAD_RESPONSE.
diffVersionResponse
$refDiffVersionResponse
descriptionSet if reference_type is DIFF_VERSION_RESPONSE.
downloadParameters
$refDownloadParameters
descriptionParameters for a media download.
filename
descriptionOriginal file name
typestring
hash
deprecatedTrue
descriptionDeprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.
typestring
hashVerified
descriptionFor Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
typeboolean
inline
descriptionMedia data, set if reference_type is INLINE
formatbyte
typestring
isPotentialRetry
description|is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.
typeboolean
length
descriptionSize of the data, in bytes
formatint64
typestring
md5Hash
descriptionScotty-provided MD5 hash for an upload.
formatbyte
typestring
mediaId
descriptionMedia id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
formatbyte
typestring
objectId
$refObjectId
descriptionReference to a TI Blob, set if reference_type is BIGSTORE_REF.
path
descriptionPath to the data, set if reference_type is PATH
typestring
referenceType
descriptionDescribes what the field reference contains.
enum
  • PATH
  • BLOB_REF
  • INLINE
  • GET_MEDIA
  • COMPOSITE_MEDIA
  • BIGSTORE_REF
  • DIFF_VERSION_RESPONSE
  • DIFF_CHECKSUMS_RESPONSE
  • DIFF_DOWNLOAD_RESPONSE
  • DIFF_UPLOAD_REQUEST
  • DIFF_UPLOAD_RESPONSE
  • COSMO_BINARY_REFERENCE
  • ARBITRARY_BYTES
enumDescriptions
  • Reference contains a GFS path or a local path.
  • Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.
  • Data is included into this proto buffer
  • Data should be accessed from the current service using the operation GetMedia.
  • The content for this media object is stored across multiple partial media objects under the composite_media field.
  • Reference points to a bigstore object
  • Indicates the data is stored in diff_version_response.
  • Indicates the data is stored in diff_checksums_response.
  • Indicates the data is stored in diff_download_response.
  • Indicates the data is stored in diff_upload_request.
  • Indicates the data is stored in diff_upload_response.
  • Indicates the data is stored in cosmo_binary_reference.
  • Informs Scotty to generate a response payload with the size specified in the length field. The contents of the payload are generated by Scotty and are undefined. This is useful for testing download speeds between the user and Scotty without involving a real payload source. Note: range is not supported when using arbitrary_bytes.
typestring
sha1Hash
descriptionScotty-provided SHA1 hash for an upload.
formatbyte
typestring
sha256Hash
descriptionScotty-provided SHA256 hash for an upload.
formatbyte
typestring
timestamp
descriptionTime at which the media data was last updated, in milliseconds since UNIX epoch
formatuint64
typestring
token
descriptionA unique fingerprint/version id for the media data
typestring
typeobject
MediaResponseInfo
descriptionThis message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse { optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 }
idMediaResponseInfo
properties
customData
descriptionData to copy from backend response to the next backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.
typestring
dataStorageTransform
descriptionSpecifies any transformation to be applied to data before persisting it or retrieving from storage. E.g., encryption options for blobstore2. This should be of the form uploader_service.DataStorageTransform.
formatbyte
typestring
destinationBlobMintIndex
descriptionFor the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when writing the resulting blob. This field is optional. It's not required ever, even if `original_object_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.
formatint32
typeinteger
dynamicDropTarget
descriptionSpecifies the Scotty Drop Target to use for uploads. If present in a media response, Scotty does not upload to a standard drop zone. Instead, Scotty saves the upload directly to the location specified in this drop target. Unlike drop zones, the drop target is the final storage location for an upload. So, the agent does not need to clone the blob at the end of the upload. The agent is responsible for garbage collecting any orphaned blobs that may occur due to aborted uploads. For more information, see the drop target design doc here: http://goto/ScottyDropTarget This field will be preferred to dynamicDropzone. If provided, the identified field in the response must be of the type uploader.agent.DropTarget.
formatbyte
typestring
dynamicDropzone
descriptionSpecifies the Scotty dropzone to use for uploads.
typestring
mediaForDiff
$refMedia
descriptionDiff Updates must respond to a START notification with this Media proto to tell Scotty to decode the diff encoded payload and apply the diff against this field. If the request was diff encoded, but this field is not set, Scotty will treat the encoding as identity. This is corresponding to Apiary's DiffUploadResponse.original_object (//depot/google3/gdata/rosy/proto/data.proto?l=413). See go/esf-scotty-diff-upload for more information.
originalObjectBlobMintIndex
descriptionFor the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when reading the original blob. This field is optional. It's not required ever, even if `destination_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.
formatint32
typeinteger
requestClass
descriptionRequest class to use for all Blobstore operations for this request.
enum
  • UNKNOWN_REQUEST_CLASS
  • LATENCY_SENSITIVE
  • PRODUCTION_BATCH
  • BEST_EFFORT
enumDescriptions
  • Unpopulated request_class in log files will be taken as 0 in dremel query. GoogleSQL will try to cast it to enum by default. An unused 0 value is added to avoid GoogleSQL casting error. Please refer to b/69677280.
  • A latency-sensitive request.
  • A request generated by a batch process.
  • A best-effort request.
typestring
scottyAgentUserId
descriptionRequester ID passed along to be recorded in the Scotty logs
formatint64
typestring
scottyCustomerLog
descriptionCustomer-specific data to be recorded in the Scotty logs type is logs_proto_scotty.CustomerLog
formatbyte
typestring
trafficClassField
descriptionSpecifies the TrafficClass that Scotty should use for any RPCs to fetch the response bytes. Will override the traffic class GTOS of the incoming http request. This is a temporary field to facilitate whitelisting and experimentation by the bigstore agent only. For instance, this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.
enum
  • BE1
  • AF1
  • AF2
  • AF3
  • AF4
  • NC1
  • NC0
  • BE0
  • LLQ
  • LLQ1
  • LLQ2
  • LLQ3
enumDescriptions
  • Application-selectable traffic classes Best effort
  • Assured forwarding priority 1
  • Assured forwarding priority 2
  • Assured forwarding priority 3
  • Assured forwarding priority 4
  • Network control
  • Network control
  • Best effort at high packet loss
  • Low-latency queue (LLQ) best effort (go/llq)
  • LLQ assured forwarding priority 1 (go/llq2)
  • LLQ assured forwarding priority 2 (go/llq2)
  • LLQ assured forwarding priority 3 (go/llq3)
typestring
verifyHashFromHeader
descriptionTells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-Hash header.
typeboolean
typeobject
ObjectId
descriptionThis is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.
idObjectId
properties
bucketName
descriptionThe name of the bucket to which this object belongs.
typestring
generation
descriptionGeneration of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
formatint64
typestring
objectName
descriptionThe name of the object.
typestring
typeobject
StartTransactionRequest
descriptionA request to start a new transaction. Both read-write and read-only transactions are supported. Read-write transactions are used to group write requests along with the ability to read uncommitted changes. Read-only transactions present a consistent view of the backup across multiple read requests.
idStartTransactionRequest
properties
maxTransactionSize
descriptionRequired for READ_WRITE transaction. Works as a two-way contract between client and server to prevent cloud abuse. When starting a new read-write transaction server ensures the user has sufficient cloud quota and substracts file size from the remaining transaction's quota on each file upload. File deletions do not count against transaction's quota because the server doesn't know the size of a deleted file. Server starts blocking file upserts if client goes beyond the transaction's limit.
formatint64
typestring
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
transactionOptions
$refTransactionOptions
descriptionRequired. Instructs the backend how to create a transaction.
typeobject
Transaction
descriptionA read or write transaction created with a call to StartTransaction.
idTransaction
properties
id
descriptionThe unique identifier for the transaction.
typestring
transactionOptions
$refTransactionOptions
descriptionTransaction options.
typeobject
TransactionOptions
descriptionOptions that can be specified while creating a transaction.
idTransactionOptions
properties
mode
descriptionThe mode of the transaction to be created.
enum
  • TRANSACTION_MODE_UNSPECIFIED
  • READ_ONLY
  • READ_WRITE
enumDescriptions
  • For catching unset values.
  • A transaction that only works for list and get operations.
  • A transaction that also works for update and delete operations.
typestring
typeobject
UpdateBackupConfigRequest
idUpdateBackupConfigRequest
properties
androidSdkVersion
descriptionOptional. If set, specifies the value of the sdk version of android OS.
formatint32
typeinteger
gmsCoreApkVersion
descriptionOptional. If set, specifies the value of the apk version of gms core.
typestring
hasRequiredPhotosPermission
descriptionOptional. If set, specifies whether the user grant photos app with the required permission.
typeboolean
inMsaExperiment
descriptionOptional. If set, specifies whether the user's device is in the experiment group to roll out MMS B&R for everyone using the MSA.
typeboolean
isAndroidBackupEnabled
descriptionOptional. If set, specifies the value of whether Android backup is enabled that should be updated.
typeboolean
isAndroidBackupSupported
descriptionOptional. If set, specifies the value of whether Android backup is supported on this device.
typeboolean
isDeviceEtu
descriptionOptional. If set, specifies the value of whether EBNR is targeted on this device.
typeboolean
isMmsBackupEnabled
descriptionOptional. If set, specifies the value of whether MMS backup is enabled that should be updated.
typeboolean
isMmsBackupSupported
descriptionOptional. If set, specifies the value of whether MMS backup is supported on this device.
typeboolean
isPhotosBackupEnabled
descriptionOptional. If set, specifies the value of whether Photos backup is enabled that should be updated.
typeboolean
isPhotosBackupSupported
descriptionOptional. If set, specifies the value of whether Photos backup is supported on this device.
typeboolean
isPhotosDefaultGallery
descriptionOptional. If set, specifies the value of whether Photos is the default gallery on this device.
typeboolean
lastAppBackupCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful App Backup action.
formatgoogle-datetime
typestring
photosApkVersion
descriptionOptional. If set, specifies the value of the apk version of photos app.
typestring
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
systemRestoreCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful System Restore action.
formatgoogle-datetime
typestring
wasMsaShown
descriptionOptional. If set, specifies whether the MSA for MMS enablement was shown previously on this device.
typeboolean
typeobject
old_value
ApiservingMediaResponseInfo
idApiservingMediaResponseInfo
properties
customData
typestring
dataStorageTransform
formatbyte
typestring
destinationBlobMintIndex
formatint32
typeinteger
dynamicDropTarget
formatbyte
typestring
dynamicDropzone
typestring
mediaForDiff
$refGdataMedia
originalObjectBlobMintIndex
formatint32
typeinteger
requestClass
enum
  • UNKNOWN_REQUEST_CLASS
  • LATENCY_SENSITIVE
  • PRODUCTION_BATCH
  • BEST_EFFORT
enumDescriptions
typestring
scottyAgentUserId
formatint64
typestring
scottyCustomerLog
formatbyte
typestring
trafficClassField
enum
  • BE1
  • AF1
  • AF2
  • AF3
  • AF4
  • NC1
  • NC0
  • BE0
  • LLQ
  • LLQ1
  • LLQ2
  • LLQ3
enumDescriptions
typestring
verifyHashFromHeader
typeboolean
typeobject
GdataBlobstore2Info
idGdataBlobstore2Info
properties
blobGeneration
formatint64
typestring
blobId
typestring
downloadReadHandle
formatbyte
typestring
readToken
typestring
uploadMetadataContainer
formatbyte
typestring
typeobject
GdataCompositeMedia
idGdataCompositeMedia
properties
blobRef
deprecatedTrue
formatbyte
typestring
blobstore2Info
$refGdataBlobstore2Info
cosmoBinaryReference
formatbyte
typestring
crc32cHash
formatuint32
typeinteger
inline
formatbyte
typestring
length
formatint64
typestring
md5Hash
formatbyte
typestring
objectId
$refGdataObjectId
path
typestring
referenceType
enum
  • PATH
  • BLOB_REF
  • INLINE
  • BIGSTORE_REF
  • COSMO_BINARY_REFERENCE
enumDescriptions
typestring
sha1Hash
formatbyte
typestring
typeobject
GdataContentTypeInfo
idGdataContentTypeInfo
properties
bestGuess
typestring
fromBytes
typestring
fromFileName
typestring
fromHeader
typestring
fromUrlPath
typestring
typeobject
GdataDiffChecksumsResponse
idGdataDiffChecksumsResponse
properties
checksumsLocation
$refGdataCompositeMedia
chunkSizeBytes
formatint64
typestring
objectLocation
$refGdataCompositeMedia
objectSizeBytes
formatint64
typestring
objectVersion
typestring
typeobject
GdataDiffDownloadResponse
idGdataDiffDownloadResponse
properties
objectLocation
$refGdataCompositeMedia
typeobject
GdataDiffUploadRequest
idGdataDiffUploadRequest
properties
checksumsInfo
$refGdataCompositeMedia
objectInfo
$refGdataCompositeMedia
objectVersion
typestring
typeobject
GdataDiffUploadResponse
idGdataDiffUploadResponse
properties
objectVersion
typestring
originalObject
$refGdataCompositeMedia
typeobject
GdataDiffVersionResponse
idGdataDiffVersionResponse
properties
objectSizeBytes
formatint64
typestring
objectVersion
typestring
typeobject
GdataDownloadParameters
idGdataDownloadParameters
properties
allowGzipCompression
typeboolean
ignoreRange
typeboolean
typeobject
GdataMedia
idGdataMedia
properties
algorithm
deprecatedTrue
typestring
bigstoreObjectRef
deprecatedTrue
formatbyte
typestring
blobRef
deprecatedTrue
formatbyte
typestring
blobstore2Info
$refGdataBlobstore2Info
compositeMedia
items
$refGdataCompositeMedia
typearray
contentType
typestring
contentTypeInfo
$refGdataContentTypeInfo
cosmoBinaryReference
formatbyte
typestring
crc32cHash
formatuint32
typeinteger
diffChecksumsResponse
$refGdataDiffChecksumsResponse
diffDownloadResponse
$refGdataDiffDownloadResponse
diffUploadRequest
$refGdataDiffUploadRequest
diffUploadResponse
$refGdataDiffUploadResponse
diffVersionResponse
$refGdataDiffVersionResponse
downloadParameters
$refGdataDownloadParameters
filename
typestring
hash
deprecatedTrue
typestring
hashVerified
typeboolean
inline
formatbyte
typestring
isPotentialRetry
typeboolean
length
formatint64
typestring
md5Hash
formatbyte
typestring
mediaId
formatbyte
typestring
objectId
$refGdataObjectId
path
typestring
referenceType
enum
  • PATH
  • BLOB_REF
  • INLINE
  • GET_MEDIA
  • COMPOSITE_MEDIA
  • BIGSTORE_REF
  • DIFF_VERSION_RESPONSE
  • DIFF_CHECKSUMS_RESPONSE
  • DIFF_DOWNLOAD_RESPONSE
  • DIFF_UPLOAD_REQUEST
  • DIFF_UPLOAD_RESPONSE
  • COSMO_BINARY_REFERENCE
  • ARBITRARY_BYTES
enumDescriptions
typestring
sha1Hash
formatbyte
typestring
sha256Hash
formatbyte
typestring
timestamp
formatuint64
typestring
token
typestring
typeobject
GdataObjectId
idGdataObjectId
properties
bucketName
typestring
generation
formatint64
typestring
objectName
typestring
typeobject
GoogleProtobufEmpty
descriptionA 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); }
idGoogleProtobufEmpty
properties
typeobject
GoogleSubscriptionsBackupV1ApiRequestHeader
idGoogleSubscriptionsBackupV1ApiRequestHeader
properties
clientInfo
$refGoogleSubscriptionsBackupV1ClientInfo
experimentOverrides
typestring
typeobject
GoogleSubscriptionsBackupV1Backup
idGoogleSubscriptionsBackupV1Backup
properties
activeTransactionId
typestring
backupId
typestring
sizeBytes
formatint64
typestring
updateTime
formatgoogle-datetime
typestring
typeobject
GoogleSubscriptionsBackupV1BackupConfig
idGoogleSubscriptionsBackupV1BackupConfig
properties
androidSdkVersion
formatint32
typeinteger
gmsCoreApkVersion
typestring
hasMmsBackupEnabledBefore
typeboolean
hasRequiredPhotosPermission
typeboolean
inMsaExperiment
typeboolean
isAndroidBackupEnabled
typeboolean
isAndroidBackupSupported
typeboolean
isDeviceEtu
typeboolean
isMmsBackupEnabled
typeboolean
isMmsBackupSupported
typeboolean
isPhotosBackupEnabled
typeboolean
isPhotosBackupSupported
typeboolean
isPhotosDefaultGallery
typeboolean
lastAppBackupCompletionTimestamp
formatgoogle-datetime
typestring
photosApkVersion
typestring
systemRestoreCompletionTimestamp
formatgoogle-datetime
typestring
wasMsaShown
typeboolean
typeobject
GoogleSubscriptionsBackupV1ClientInfo
idGoogleSubscriptionsBackupV1ClientInfo
properties
clientId
enum
  • CLIENT_ID_UNSPECIFIED
  • CLIENT_ID_G1_ANDROID_APP
  • CLIENT_ID_GMSCORE_BACKUP
  • CLIENT_ID_DRIVE_BACKUP
  • CLIENT_ID_MANUAL
  • CLIENT_ID_PROBER
  • CLIENT_ID_PIXELMIGRATE
enumDescriptions
typestring
version
typestring
typeobject
GoogleSubscriptionsBackupV1CommitTransactionRequest
idGoogleSubscriptionsBackupV1CommitTransactionRequest
properties
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
transactionId
typestring
typeobject
GoogleSubscriptionsBackupV1CommitTransactionResponse
idGoogleSubscriptionsBackupV1CommitTransactionResponse
properties
typeobject
GoogleSubscriptionsBackupV1CreateBackupRequest
idGoogleSubscriptionsBackupV1CreateBackupRequest
properties
androidId
formatint64
typestring
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
typeobject
GoogleSubscriptionsBackupV1DeleteBackupConfigRequest
idGoogleSubscriptionsBackupV1DeleteBackupConfigRequest
properties
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
typeobject
GoogleSubscriptionsBackupV1DeleteFilesRequest
idGoogleSubscriptionsBackupV1DeleteFilesRequest
properties
fileIds
items
typestring
typearray
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
transactionId
typestring
typeobject
GoogleSubscriptionsBackupV1File
idGoogleSubscriptionsBackupV1File
properties
blob
$refGdataMedia
fileId
typestring
mediaResponseInfo
$refApiservingMediaResponseInfo
readOnlyTrue
mimeType
typestring
sizeBytes
formatint64
typestring
updateTime
formatgoogle-datetime
typestring
typeobject
GoogleSubscriptionsBackupV1ListBackupsResponse
idGoogleSubscriptionsBackupV1ListBackupsResponse
properties
backups
additionalProperties
$refGoogleSubscriptionsBackupV1Backup
typeobject
nextPageToken
typestring
typeobject
GoogleSubscriptionsBackupV1ListFilesResponse
idGoogleSubscriptionsBackupV1ListFilesResponse
properties
files
items
$refGoogleSubscriptionsBackupV1File
typearray
nextPageToken
typestring
typeobject
GoogleSubscriptionsBackupV1StartTransactionRequest
idGoogleSubscriptionsBackupV1StartTransactionRequest
properties
maxTransactionSize
formatint64
typestring
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
transactionOptions
$refGoogleSubscriptionsBackupV1TransactionOptions
typeobject
GoogleSubscriptionsBackupV1Transaction
idGoogleSubscriptionsBackupV1Transaction
properties
id
typestring
transactionOptions
$refGoogleSubscriptionsBackupV1TransactionOptions
typeobject
GoogleSubscriptionsBackupV1TransactionOptions
idGoogleSubscriptionsBackupV1TransactionOptions
properties
mode
enum
  • TRANSACTION_MODE_UNSPECIFIED
  • READ_ONLY
  • READ_WRITE
enumDescriptions
typestring
typeobject
GoogleSubscriptionsBackupV1UpdateBackupConfigRequest
idGoogleSubscriptionsBackupV1UpdateBackupConfigRequest
properties
androidSdkVersion
formatint32
typeinteger
gmsCoreApkVersion
typestring
hasRequiredPhotosPermission
typeboolean
inMsaExperiment
typeboolean
isAndroidBackupEnabled
typeboolean
isAndroidBackupSupported
typeboolean
isDeviceEtu
typeboolean
isMmsBackupEnabled
typeboolean
isMmsBackupSupported
typeboolean
isPhotosBackupEnabled
typeboolean
isPhotosBackupSupported
typeboolean
isPhotosDefaultGallery
typeboolean
lastAppBackupCompletionTimestamp
formatgoogle-datetime
typestring
photosApkVersion
typestring
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
systemRestoreCompletionTimestamp
formatgoogle-datetime
typestring
wasMsaShown
typeboolean
typeobject
root['title']
new_valueMMS Backup Private API (Staging)
old_valueGoogle One Backup Private API
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][0]
new_valueSuch requests signals the start of a request containing media upload. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.
old_value
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
iterable_item_added
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][1]Such requests signals that the upload has progressed and that the backend might want to access the media file specified in relevant fields in the resource. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][2]Such requests signals the end of a request containing media upload. END should be handled just like normal Insert/Upload requests, that is, they should process the request and return a complete resource in the response. Pointers to media data (a GFS path usually) appear in the relevant fields in the inserted/updated resource. See gdata.Media in data.proto.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][3]Such requests occur after an END and signal that the response has been sent back to the client. RESPONSE_SENT is only sent to the backend if it is configured to receive them. The response does not need to contain anything.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][4]Such requests indicate that an error occurred while processing the request. ERROR is only sent to the backend if it is configured to receive them. It is not guaranteed that all errors will result in this notification to the backend, even if the backend requests them. Since these requests are just for informational purposes, the response does not need to contain anything.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
sandbox/autopush-googleonebackup-pa-v1
dictionary_item_added
  • root['resources']['backups']['methods']['commitTransaction']['parameters']['backupId']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['deleteBackupConfig']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['get']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['get']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['list']['parameters']['pageSize']['description']
  • root['resources']['backups']['methods']['list']['parameters']['pageToken']['description']
  • root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['list']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['startTransaction']['parameters']['backupId']['description']
  • root['resources']['backups']['methods']['updateConfig']['parameters']['androidId']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['fileId']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['transactionId']['description']
  • root['resources']['backups']['resources']['files']['methods']['deleteFiles']['parameters']['backupId']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['backupId']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['pageSize']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['pageToken']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['transactionId']['description']
  • root['resources']['media']['methods']['download']['parameters']['fileId']['description']
  • root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['media']['methods']['download']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['media']['methods']['download']['parameters']['transactionId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['backupId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['fileName']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.currentBytes']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.customData']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.diffObjectVersion']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.finalStatus']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.requestId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.requestReceivedParamsServingInfo']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.totalBytes']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.totalBytesIsEstimated']['description']
  • root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['media']['methods']['upload']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['media']['methods']['upload']['parameters']['transactionId']['description']
values_changed
root['baseUrl']
new_valuehttps://staging-mmsbackup.pa.googleapis.com/
old_valuehttps://autopush-googleonebackup-pa.sandbox.googleapis.com/
root['canonicalName']
new_valueMMS Backup Service
old_valueOne Backup
root['description']
new_valuemmsbackup.pa.googleapis.com API.
old_valueA boq-generated 1P API. For more information, see https://boq.corp.google.com/google3/java/com/google/subscriptions/backup/service
root['documentationLink']
new_valuehttps://support.google.com/android/answer/2819582
old_valuehttps://boq.corp.google.com/google3/java/com/google/subscriptions/backup/service
root['id']
new_valuepa_mmsbackup:v1
old_valueautopush_googleonebackup_pa_sandbox:v1
root['mtlsRootUrl']
new_valuehttps://staging-mmsbackup.pa.mtls.googleapis.com/
old_valuehttps://autopush-googleonebackup-pa.mtls.sandbox.googleapis.com/
root['name']
new_valuepa_mmsbackup
old_valueautopush_googleonebackup_pa_sandbox
root['resources']['backups']['methods']['commitTransaction']['description']
new_valueCommits the current active read-write transaction. All file changes are committed atomically. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if either backup or transaction doesn't exist. Already committed transactions are considered as non-existent. Returns a RESOURCE_EXHAUSTED canonical code if user doesn't have sufficient cloud storage capacity. Extract CommitTransactionResourceExhaustedFailureReason from RPC status to learn the exact reason. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['commitTransaction']['id']
new_valuepa_mmsbackup.backups.commitTransaction
old_valueautopush_googleonebackup_pa_sandbox.backups.commitTransaction
root['resources']['backups']['methods']['commitTransaction']['request']['$ref']
new_valueCommitTransactionRequest
old_valueGoogleSubscriptionsBackupV1CommitTransactionRequest
root['resources']['backups']['methods']['commitTransaction']['response']['$ref']
new_valueCommitTransactionResponse
old_valueGoogleSubscriptionsBackupV1CommitTransactionResponse
root['resources']['backups']['methods']['create']['description']
new_valueCreates a new backup. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns an ALREADY_EXISTS canonical code if a backup for the provided GServices Android ID already exists. Returns a FAILED_PRECONDITION canonical code if GoogleOne backup already exist but it's an orphan - it's not present in Android Backup storage but already exists in Moscato. This can happen if backup deletion partially succeeded - backup was removed from Android Backup storage but deletion from Moscato failed. FAILED_PRECONDITION is also thrown if device is not initialized in Android Backup Storage, which means that Android backup flow hasn't yet started. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['create']['id']
new_valuepa_mmsbackup.backups.create
old_valueautopush_googleonebackup_pa_sandbox.backups.create
root['resources']['backups']['methods']['create']['request']['$ref']
new_valueCreateBackupRequest
old_valueGoogleSubscriptionsBackupV1CreateBackupRequest
root['resources']['backups']['methods']['create']['response']['$ref']
new_valueBackup
old_valueGoogleSubscriptionsBackupV1Backup
root['resources']['backups']['methods']['delete']['description']
new_valueDeletes the backup and all of its files. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a NOT_FOUND canonical code if the backup doesn't exist. Returns a FAILED_PRECONDITION if device is not initialized in Android Backup Storage, which means that Android backup flow hasn't yet started. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['delete']['id']
new_valuepa_mmsbackup.backups.delete
old_valueautopush_googleonebackup_pa_sandbox.backups.delete
root['resources']['backups']['methods']['delete']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['methods']['deleteBackupConfig']['description']
new_valueDeletes the backup configuration. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a NOT_FOUND canonical code if the backup configuration doesn't exist. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['deleteBackupConfig']['id']
new_valuepa_mmsbackup.backups.deleteBackupConfig
old_valueautopush_googleonebackup_pa_sandbox.backups.deleteBackupConfig
root['resources']['backups']['methods']['deleteBackupConfig']['request']['$ref']
new_valueDeleteBackupConfigRequest
old_valueGoogleSubscriptionsBackupV1DeleteBackupConfigRequest
root['resources']['backups']['methods']['deleteBackupConfig']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['methods']['get']['description']
new_valueGets the backup for the provided GServices Android ID. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if the backups doesn't exist. Returns a FAILED_PRECONDITION canonical code if the requested backup is an orphan - it's not present in Android Backup storage but still exists in Moscato. This can happen if backup deletion partially succeeeded - backup was removed from Android Backup storage but deletion from Moscato failed. FAILED_PRECONDITION is also thrown if device is not initialized in Android Backup Storage, which means that Android backup flow hasn't yet started. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['get']['id']
new_valuepa_mmsbackup.backups.get
old_valueautopush_googleonebackup_pa_sandbox.backups.get
root['resources']['backups']['methods']['get']['response']['$ref']
new_valueBackup
old_valueGoogleSubscriptionsBackupV1Backup
root['resources']['backups']['methods']['getConfig']['description']
new_valueReturns backup configuration for the pair of Gaia ID (extracted from EUC) and GServices Android ID from the request. Returns the default configuration (see BackupConfiguration proto for details) if there is nothing in Spanner. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['getConfig']['id']
new_valuepa_mmsbackup.backups.getConfig
old_valueautopush_googleonebackup_pa_sandbox.backups.getConfig
root['resources']['backups']['methods']['getConfig']['response']['$ref']
new_valueBackupConfig
old_valueGoogleSubscriptionsBackupV1BackupConfig
root['resources']['backups']['methods']['list']['description']
new_valueGets a list of backups for the current user. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['list']['id']
new_valuepa_mmsbackup.backups.list
old_valueautopush_googleonebackup_pa_sandbox.backups.list
root['resources']['backups']['methods']['list']['response']['$ref']
new_valueListBackupsResponse
old_valueGoogleSubscriptionsBackupV1ListBackupsResponse
root['resources']['backups']['methods']['startTransaction']['description']
new_valueStarts a long-running transaction. The timeout for read-only transactions is 48 hours, for read-write transactions - 2 weeks. The client is allowed to have multiple read-only transactions at the same time. The client is not allowed to have multiple read-write transactions at the same time. An attempt to create a read-write transaction would abort existing read-write transaction if any. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if the backup doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['startTransaction']['id']
new_valuepa_mmsbackup.backups.startTransaction
old_valueautopush_googleonebackup_pa_sandbox.backups.startTransaction
root['resources']['backups']['methods']['startTransaction']['request']['$ref']
new_valueStartTransactionRequest
old_valueGoogleSubscriptionsBackupV1StartTransactionRequest
root['resources']['backups']['methods']['startTransaction']['response']['$ref']
new_valueTransaction
old_valueGoogleSubscriptionsBackupV1Transaction
root['resources']['backups']['methods']['updateConfig']['description']
new_valueCreates/updates backup configuration for the pair of Gaia ID (extracted from EUC) and GServices Android ID from the request. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['updateConfig']['id']
new_valuepa_mmsbackup.backups.updateConfig
old_valueautopush_googleonebackup_pa_sandbox.backups.updateConfig
root['resources']['backups']['methods']['updateConfig']['request']['$ref']
new_valueUpdateBackupConfigRequest
old_valueGoogleSubscriptionsBackupV1UpdateBackupConfigRequest
root['resources']['backups']['methods']['updateConfig']['response']['$ref']
new_valueBackupConfig
old_valueGoogleSubscriptionsBackupV1BackupConfig
root['resources']['backups']['resources']['files']['methods']['delete']['description']
new_valueStages the file to be deleted once the current transaction is committed. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a NOT_FOUND canonical code if the backup or the file doesn't exist. Returns a FAILED_PRECONDITION code if transaction doesn't exist. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['resources']['files']['methods']['delete']['id']
new_valuepa_mmsbackup.backups.files.delete
old_valueautopush_googleonebackup_pa_sandbox.backups.files.delete
root['resources']['backups']['resources']['files']['methods']['delete']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['description']
new_valueStages a group of files to be deleted once the current transaction is committed. Does nothing if file(s) are missing. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a FAILED_PRECONDITION canonical code if transaction doesn't exist or if read-only transaction was provided. Returns a NOT_FOUND canonical code if backup doesn't exist. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['id']
new_valuepa_mmsbackup.backups.files.deleteFiles
old_valueautopush_googleonebackup_pa_sandbox.backups.files.deleteFiles
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['request']['$ref']
new_valueDeleteFilesRequest
old_valueGoogleSubscriptionsBackupV1DeleteFilesRequest
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['resources']['files']['methods']['list']['description']
new_valueLists all the files in a given backup. Returns an empty list if the backup is empty. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if either the backup or the transaction doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['resources']['files']['methods']['list']['id']
new_valuepa_mmsbackup.backups.files.list
old_valueautopush_googleonebackup_pa_sandbox.backups.files.list
root['resources']['backups']['resources']['files']['methods']['list']['response']['$ref']
new_valueListFilesResponse
old_valueGoogleSubscriptionsBackupV1ListFilesResponse
root['resources']['media']['methods']['download']['description']
new_valueExports the file. This will send the actual file bytes to the client. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if the requested file doesn't exist. Returns a FAILED_PRECONDITION canonical code if the provided transaction or the backup doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['media']['methods']['download']['id']
new_valuepa_mmsbackup.media.download
old_valueautopush_googleonebackup_pa_sandbox.media.download
root['resources']['media']['methods']['download']['response']['$ref']
new_valueFile
old_valueGoogleSubscriptionsBackupV1File
root['resources']['media']['methods']['upload']['description']
new_valueUpdates the file and returns its updated metadata. If the file doesn't exist, then this will create a new file. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a FAILED_PRECONDITION canonical code if transaction doesn't exist. Returns a NOT_FOUND canonical code if the backup doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['media']['methods']['upload']['id']
new_valuepa_mmsbackup.media.upload
old_valueautopush_googleonebackup_pa_sandbox.media.upload
root['resources']['media']['methods']['upload']['request']['$ref']
new_valueFile
old_valueGoogleSubscriptionsBackupV1File
root['resources']['media']['methods']['upload']['response']['$ref']
new_valueFile
old_valueGoogleSubscriptionsBackupV1File
root['revision']
new_value20250518
old_value20250412
root['rootUrl']
new_valuehttps://staging-mmsbackup.pa.googleapis.com/
old_valuehttps://autopush-googleonebackup-pa.sandbox.googleapis.com/
root['schemas']
new_value
ApiRequestHeader
descriptionHeader for requests sent to Google One Backup API.
idApiRequestHeader
properties
clientInfo
$refClientInfo
descriptionOptional info about the client calling the API.
experimentOverrides
descriptionOptional experiment overrides. This is a comma-separate list of experiment names. A minus sign can be used to disable an experiment. Example usage: "ExperimentOne": Enables ExperimentOne. "ExperimentOne,-ExperimentTwo": Enables ExperimentOne and disables ExperimentTwo.
typestring
typeobject
Backup
descriptionA backup belonging to a client.
idBackup
properties
activeTransactionId
descriptionThe active read-write transaction for this backup if there is an uncommitted write transaction. Output only.
typestring
backupId
descriptionRequired. The relative resource name of the backup, e.g. "backups/1337". Output only.
typestring
sizeBytes
descriptionAggregate size of all files contained in this backup, in bytes. Output only.
formatint64
typestring
updateTime
descriptionThe time the backup was last updated. Output only.
formatgoogle-datetime
typestring
typeobject
BackupConfig
idBackupConfig
properties
androidSdkVersion
descriptionOptional. If set, specifies the value of the sdk version of android OS.
formatint32
typeinteger
gmsCoreApkVersion
descriptionOptional. If set, specifies the value of the apk version of gms core.
typestring
hasMmsBackupEnabledBefore
descriptionIs set as long as a user has mms backup turned on in the history.
typeboolean
hasRequiredPhotosPermission
descriptionOptional. If set, specifies whether a user has the required photos app permission to send photos_backup_onboarding notifications.
typeboolean
inMsaExperiment
descriptionOptional. If set, specifies whether the user's device is in the experiment group to roll out MMS B&R for everyone using the MSA.
typeboolean
isAndroidBackupEnabled
typeboolean
isAndroidBackupSupported
descriptionIs set if the device satisfies the pre-requisites for Android backup to be performed.
typeboolean
isDeviceEtu
descriptionOptional. If set, specifies the value of whether EBNR is targeted on this device.
typeboolean
isMmsBackupEnabled
descriptionIs always "false" by default or if user is either a Dasher/Unicorn/Griffin user.
typeboolean
isMmsBackupSupported
descriptionIs set if the device satisfies the pre-requisites for Mms backup to be performed.
typeboolean
isPhotosBackupEnabled
typeboolean
isPhotosBackupSupported
descriptionIs set if the device satisfies the pre-requisites for Photos backup to be performed.
typeboolean
isPhotosDefaultGallery
descriptionOptional. If set, specifies the value of whether Photos is the default gallery on this device.
typeboolean
lastAppBackupCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful App Backup action.
formatgoogle-datetime
typestring
photosApkVersion
descriptionOptional. If set, specifies the value of the apk version of photos app.
typestring
systemRestoreCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful System Restore action.
formatgoogle-datetime
typestring
wasMsaShown
descriptionOptional. If set, specifies whether the MSA for MMS enablement was shown previously on this device.
typeboolean
typeobject
Blobstore2Info
descriptionInformation to read/write to blobstore2.
idBlobstore2Info
properties
blobGeneration
descriptionThe blob generation id.
formatint64
typestring
blobId
descriptionThe blob id, e.g., /blobstore/prod/playground/scotty
typestring
downloadReadHandle
descriptionRead handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
formatbyte
typestring
readToken
descriptionThe blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
typestring
uploadMetadataContainer
descriptionMetadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
formatbyte
typestring
typeobject
ClientInfo
descriptionInformation about a particular client calling the API.
idClientInfo
properties
clientId
descriptionRequired client ID of the caller. Behavior of certain RPCs may differ slightly by client ID, according to the client's needs.
enum
  • CLIENT_ID_UNSPECIFIED
  • CLIENT_ID_G1_ANDROID_APP
  • CLIENT_ID_GMSCORE_BACKUP
  • CLIENT_ID_DRIVE_BACKUP
  • CLIENT_ID_MANUAL
  • CLIENT_ID_PROBER
  • CLIENT_ID_PIXELMIGRATE
enumDescriptions
  • Default ID used when no other particular ID applies, or the client has not yet configured a new client ID.
  • Client ID for the G1 Android app.
  • Client ID for the GmsCore backup modules.
  • Client ID for the Drive backup modules.
  • Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
  • Client ID used by service probers.
  • Client ID for the PixelMigrate/Restore Android app.
typestring
version
descriptionRequired. Version of the client. This field is optional for CLIENT_ID_MANUAL client ID.
typestring
typeobject
CommitTransactionRequest
descriptionA request to finish a read-write transaction, committing all file changes atomically.
idCommitTransactionRequest
properties
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
transactionId
descriptionRequired. The id of the transaction to commit.
typestring
typeobject
CommitTransactionResponse
descriptionA transaction commit response.
idCommitTransactionResponse
properties
typeobject
CompositeMedia
descriptionA sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
idCompositeMedia
properties
blobRef
deprecatedTrue
descriptionBlobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
formatbyte
typestring
blobstore2Info
$refBlobstore2Info
descriptionBlobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
cosmoBinaryReference
descriptionA binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
formatbyte
typestring
crc32cHash
descriptioncrc32.c hash for the payload.
formatuint32
typeinteger
inline
descriptionMedia data, set if reference_type is INLINE
formatbyte
typestring
length
descriptionSize of the data, in bytes
formatint64
typestring
md5Hash
descriptionMD5 hash for the payload.
formatbyte
typestring
objectId
$refObjectId
descriptionReference to a TI Blob, set if reference_type is BIGSTORE_REF.
path
descriptionPath to the data, set if reference_type is PATH
typestring
referenceType
descriptionDescribes what the field reference contains.
enum
  • PATH
  • BLOB_REF
  • INLINE
  • BIGSTORE_REF
  • COSMO_BINARY_REFERENCE
enumDescriptions
  • Reference contains a GFS path or a local path.
  • Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.
  • Data is included into this proto buffer
  • Reference points to a bigstore object
  • Indicates the data is stored in cosmo_binary_reference.
typestring
sha1Hash
descriptionSHA-1 hash for the payload.
formatbyte
typestring
typeobject
ContentTypeInfo
descriptionDetailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.
idContentTypeInfo
properties
bestGuess
descriptionScotty's best guess of what the content type of the file is.
typestring
fromBytes
descriptionThe content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
typestring
fromFileName
descriptionThe content type of the file derived from the file extension of the original file name used by the client.
typestring
fromHeader
descriptionThe content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
typestring
fromUrlPath
descriptionThe content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
typestring
typeobject
CreateBackupRequest
idCreateBackupRequest
properties
androidId
descriptionRequired. A value that uniquely identifies user's device to Google's servers.
formatint64
typestring
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
typeobject
DeleteBackupConfigRequest
descriptionA request to delete a backup config.
idDeleteBackupConfigRequest
properties
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
typeobject
DeleteFilesRequest
descriptionRequest to delete a group of files.
idDeleteFilesRequest
properties
fileIds
descriptionThe file ids relative to backup_id, e.g. "data/selfie.jpg" or "foo.txt"
items
typestring
typearray
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
transactionId
descriptionRequired. The transaction to execute the delete in.
typestring
typeobject
DiffChecksumsResponse
descriptionBackend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffChecksumsResponse
properties
checksumsLocation
$refCompositeMedia
descriptionExactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
chunkSizeBytes
descriptionThe chunk size of checksums. Must be a multiple of 256KB.
formatint64
typestring
objectLocation
$refCompositeMedia
descriptionIf set, calculate the checksums based on the contents and return them to the caller.
objectSizeBytes
descriptionThe total size of the server object.
formatint64
typestring
objectVersion
descriptionThe object version of the object the checksums are being returned for.
typestring
typeobject
DiffDownloadResponse
descriptionBackend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffDownloadResponse
properties
objectLocation
$refCompositeMedia
descriptionThe original object location.
typeobject
DiffUploadRequest
descriptionA Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffUploadRequest
properties
checksumsInfo
$refCompositeMedia
descriptionThe location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
objectInfo
$refCompositeMedia
descriptionThe location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
objectVersion
descriptionThe object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
typestring
typeobject
DiffUploadResponse
descriptionBackend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffUploadResponse
properties
objectVersion
descriptionThe object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
typestring
originalObject
$refCompositeMedia
descriptionThe location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
typeobject
DiffVersionResponse
descriptionBackend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffVersionResponse
properties
objectSizeBytes
descriptionThe total size of the server object.
formatint64
typestring
objectVersion
descriptionThe version of the object stored at the server.
typestring
typeobject
DownloadParameters
descriptionParameters specific to media downloads.
idDownloadParameters
properties
allowGzipCompression
descriptionA boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
typeboolean
ignoreRange
descriptionDetermining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
typeboolean
typeobject
Empty
descriptionA 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); }
idEmpty
properties
typeobject
File
descriptionA file belonging to a backup
idFile
properties
blob
$refMedia
descriptionThe blob supplied to/from Scotty.
fileId
descriptionThe relative resource name of the backup, e.g: "backups/31337/files/selfie.jpg"
typestring
mediaResponseInfo
$refMediaResponseInfo
descriptionOutput only. Media response details.
readOnlyTrue
mimeType
descriptionThe mime type of the file contents. May not be needed.
typestring
sizeBytes
descriptionThe size of the file in bytes.
formatint64
typestring
updateTime
descriptionThe time the backup was last updated.
formatgoogle-datetime
typestring
typeobject
ListBackupsResponse
descriptionResponse including a list of G1 backups
idListBackupsResponse
properties
backups
additionalProperties
$refBackup
descriptionA list of backups, mapping from androidId to backup entity.
typeobject
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
typeobject
ListFilesResponse
idListFilesResponse
properties
files
descriptionAll files associated with the backup.
items
$refFile
typearray
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
typeobject
Media
descriptionA reference to data stored on the filesystem, on GFS or in blobstore.
idMedia
properties
algorithm
deprecatedTrue
descriptionDeprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
typestring
bigstoreObjectRef
deprecatedTrue
descriptionUse object_id instead.
formatbyte
typestring
blobRef
deprecatedTrue
descriptionBlobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
formatbyte
typestring
blobstore2Info
$refBlobstore2Info
descriptionBlobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
compositeMedia
descriptionA composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.
items
$refCompositeMedia
typearray
contentType
descriptionMIME type of the data
typestring
contentTypeInfo
$refContentTypeInfo
descriptionExtended content type information provided for Scotty uploads.
cosmoBinaryReference
descriptionA binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
formatbyte
typestring
crc32cHash
descriptionFor Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
formatuint32
typeinteger
diffChecksumsResponse
$refDiffChecksumsResponse
descriptionSet if reference_type is DIFF_CHECKSUMS_RESPONSE.
diffDownloadResponse
$refDiffDownloadResponse
descriptionSet if reference_type is DIFF_DOWNLOAD_RESPONSE.
diffUploadRequest
$refDiffUploadRequest
descriptionSet if reference_type is DIFF_UPLOAD_REQUEST.
diffUploadResponse
$refDiffUploadResponse
descriptionSet if reference_type is DIFF_UPLOAD_RESPONSE.
diffVersionResponse
$refDiffVersionResponse
descriptionSet if reference_type is DIFF_VERSION_RESPONSE.
downloadParameters
$refDownloadParameters
descriptionParameters for a media download.
filename
descriptionOriginal file name
typestring
hash
deprecatedTrue
descriptionDeprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.
typestring
hashVerified
descriptionFor Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
typeboolean
inline
descriptionMedia data, set if reference_type is INLINE
formatbyte
typestring
isPotentialRetry
description|is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.
typeboolean
length
descriptionSize of the data, in bytes
formatint64
typestring
md5Hash
descriptionScotty-provided MD5 hash for an upload.
formatbyte
typestring
mediaId
descriptionMedia id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
formatbyte
typestring
objectId
$refObjectId
descriptionReference to a TI Blob, set if reference_type is BIGSTORE_REF.
path
descriptionPath to the data, set if reference_type is PATH
typestring
referenceType
descriptionDescribes what the field reference contains.
enum
  • PATH
  • BLOB_REF
  • INLINE
  • GET_MEDIA
  • COMPOSITE_MEDIA
  • BIGSTORE_REF
  • DIFF_VERSION_RESPONSE
  • DIFF_CHECKSUMS_RESPONSE
  • DIFF_DOWNLOAD_RESPONSE
  • DIFF_UPLOAD_REQUEST
  • DIFF_UPLOAD_RESPONSE
  • COSMO_BINARY_REFERENCE
  • ARBITRARY_BYTES
enumDescriptions
  • Reference contains a GFS path or a local path.
  • Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.
  • Data is included into this proto buffer
  • Data should be accessed from the current service using the operation GetMedia.
  • The content for this media object is stored across multiple partial media objects under the composite_media field.
  • Reference points to a bigstore object
  • Indicates the data is stored in diff_version_response.
  • Indicates the data is stored in diff_checksums_response.
  • Indicates the data is stored in diff_download_response.
  • Indicates the data is stored in diff_upload_request.
  • Indicates the data is stored in diff_upload_response.
  • Indicates the data is stored in cosmo_binary_reference.
  • Informs Scotty to generate a response payload with the size specified in the length field. The contents of the payload are generated by Scotty and are undefined. This is useful for testing download speeds between the user and Scotty without involving a real payload source. Note: range is not supported when using arbitrary_bytes.
typestring
sha1Hash
descriptionScotty-provided SHA1 hash for an upload.
formatbyte
typestring
sha256Hash
descriptionScotty-provided SHA256 hash for an upload.
formatbyte
typestring
timestamp
descriptionTime at which the media data was last updated, in milliseconds since UNIX epoch
formatuint64
typestring
token
descriptionA unique fingerprint/version id for the media data
typestring
typeobject
MediaResponseInfo
descriptionThis message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse { optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 }
idMediaResponseInfo
properties
customData
descriptionData to copy from backend response to the next backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.
typestring
dataStorageTransform
descriptionSpecifies any transformation to be applied to data before persisting it or retrieving from storage. E.g., encryption options for blobstore2. This should be of the form uploader_service.DataStorageTransform.
formatbyte
typestring
destinationBlobMintIndex
descriptionFor the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when writing the resulting blob. This field is optional. It's not required ever, even if `original_object_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.
formatint32
typeinteger
dynamicDropTarget
descriptionSpecifies the Scotty Drop Target to use for uploads. If present in a media response, Scotty does not upload to a standard drop zone. Instead, Scotty saves the upload directly to the location specified in this drop target. Unlike drop zones, the drop target is the final storage location for an upload. So, the agent does not need to clone the blob at the end of the upload. The agent is responsible for garbage collecting any orphaned blobs that may occur due to aborted uploads. For more information, see the drop target design doc here: http://goto/ScottyDropTarget This field will be preferred to dynamicDropzone. If provided, the identified field in the response must be of the type uploader.agent.DropTarget.
formatbyte
typestring
dynamicDropzone
descriptionSpecifies the Scotty dropzone to use for uploads.
typestring
mediaForDiff
$refMedia
descriptionDiff Updates must respond to a START notification with this Media proto to tell Scotty to decode the diff encoded payload and apply the diff against this field. If the request was diff encoded, but this field is not set, Scotty will treat the encoding as identity. This is corresponding to Apiary's DiffUploadResponse.original_object (//depot/google3/gdata/rosy/proto/data.proto?l=413). See go/esf-scotty-diff-upload for more information.
originalObjectBlobMintIndex
descriptionFor the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when reading the original blob. This field is optional. It's not required ever, even if `destination_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.
formatint32
typeinteger
requestClass
descriptionRequest class to use for all Blobstore operations for this request.
enum
  • UNKNOWN_REQUEST_CLASS
  • LATENCY_SENSITIVE
  • PRODUCTION_BATCH
  • BEST_EFFORT
enumDescriptions
  • Unpopulated request_class in log files will be taken as 0 in dremel query. GoogleSQL will try to cast it to enum by default. An unused 0 value is added to avoid GoogleSQL casting error. Please refer to b/69677280.
  • A latency-sensitive request.
  • A request generated by a batch process.
  • A best-effort request.
typestring
scottyAgentUserId
descriptionRequester ID passed along to be recorded in the Scotty logs
formatint64
typestring
scottyCustomerLog
descriptionCustomer-specific data to be recorded in the Scotty logs type is logs_proto_scotty.CustomerLog
formatbyte
typestring
trafficClassField
descriptionSpecifies the TrafficClass that Scotty should use for any RPCs to fetch the response bytes. Will override the traffic class GTOS of the incoming http request. This is a temporary field to facilitate whitelisting and experimentation by the bigstore agent only. For instance, this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.
enum
  • BE1
  • AF1
  • AF2
  • AF3
  • AF4
  • NC1
  • NC0
  • BE0
  • LLQ
  • LLQ1
  • LLQ2
  • LLQ3
enumDescriptions
  • Application-selectable traffic classes Best effort
  • Assured forwarding priority 1
  • Assured forwarding priority 2
  • Assured forwarding priority 3
  • Assured forwarding priority 4
  • Network control
  • Network control
  • Best effort at high packet loss
  • Low-latency queue (LLQ) best effort (go/llq)
  • LLQ assured forwarding priority 1 (go/llq2)
  • LLQ assured forwarding priority 2 (go/llq2)
  • LLQ assured forwarding priority 3 (go/llq3)
typestring
verifyHashFromHeader
descriptionTells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-Hash header.
typeboolean
typeobject
ObjectId
descriptionThis is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.
idObjectId
properties
bucketName
descriptionThe name of the bucket to which this object belongs.
typestring
generation
descriptionGeneration of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
formatint64
typestring
objectName
descriptionThe name of the object.
typestring
typeobject
StartTransactionRequest
descriptionA request to start a new transaction. Both read-write and read-only transactions are supported. Read-write transactions are used to group write requests along with the ability to read uncommitted changes. Read-only transactions present a consistent view of the backup across multiple read requests.
idStartTransactionRequest
properties
maxTransactionSize
descriptionRequired for READ_WRITE transaction. Works as a two-way contract between client and server to prevent cloud abuse. When starting a new read-write transaction server ensures the user has sufficient cloud quota and substracts file size from the remaining transaction's quota on each file upload. File deletions do not count against transaction's quota because the server doesn't know the size of a deleted file. Server starts blocking file upserts if client goes beyond the transaction's limit.
formatint64
typestring
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
transactionOptions
$refTransactionOptions
descriptionRequired. Instructs the backend how to create a transaction.
typeobject
Transaction
descriptionA read or write transaction created with a call to StartTransaction.
idTransaction
properties
id
descriptionThe unique identifier for the transaction.
typestring
transactionOptions
$refTransactionOptions
descriptionTransaction options.
typeobject
TransactionOptions
descriptionOptions that can be specified while creating a transaction.
idTransactionOptions
properties
mode
descriptionThe mode of the transaction to be created.
enum
  • TRANSACTION_MODE_UNSPECIFIED
  • READ_ONLY
  • READ_WRITE
enumDescriptions
  • For catching unset values.
  • A transaction that only works for list and get operations.
  • A transaction that also works for update and delete operations.
typestring
typeobject
UpdateBackupConfigRequest
idUpdateBackupConfigRequest
properties
androidSdkVersion
descriptionOptional. If set, specifies the value of the sdk version of android OS.
formatint32
typeinteger
gmsCoreApkVersion
descriptionOptional. If set, specifies the value of the apk version of gms core.
typestring
hasRequiredPhotosPermission
descriptionOptional. If set, specifies whether the user grant photos app with the required permission.
typeboolean
inMsaExperiment
descriptionOptional. If set, specifies whether the user's device is in the experiment group to roll out MMS B&R for everyone using the MSA.
typeboolean
isAndroidBackupEnabled
descriptionOptional. If set, specifies the value of whether Android backup is enabled that should be updated.
typeboolean
isAndroidBackupSupported
descriptionOptional. If set, specifies the value of whether Android backup is supported on this device.
typeboolean
isDeviceEtu
descriptionOptional. If set, specifies the value of whether EBNR is targeted on this device.
typeboolean
isMmsBackupEnabled
descriptionOptional. If set, specifies the value of whether MMS backup is enabled that should be updated.
typeboolean
isMmsBackupSupported
descriptionOptional. If set, specifies the value of whether MMS backup is supported on this device.
typeboolean
isPhotosBackupEnabled
descriptionOptional. If set, specifies the value of whether Photos backup is enabled that should be updated.
typeboolean
isPhotosBackupSupported
descriptionOptional. If set, specifies the value of whether Photos backup is supported on this device.
typeboolean
isPhotosDefaultGallery
descriptionOptional. If set, specifies the value of whether Photos is the default gallery on this device.
typeboolean
lastAppBackupCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful App Backup action.
formatgoogle-datetime
typestring
photosApkVersion
descriptionOptional. If set, specifies the value of the apk version of photos app.
typestring
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
systemRestoreCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful System Restore action.
formatgoogle-datetime
typestring
wasMsaShown
descriptionOptional. If set, specifies whether the MSA for MMS enablement was shown previously on this device.
typeboolean
typeobject
old_value
ApiservingMediaResponseInfo
idApiservingMediaResponseInfo
properties
customData
typestring
dataStorageTransform
formatbyte
typestring
destinationBlobMintIndex
formatint32
typeinteger
dynamicDropTarget
formatbyte
typestring
dynamicDropzone
typestring
mediaForDiff
$refGdataMedia
originalObjectBlobMintIndex
formatint32
typeinteger
requestClass
enum
  • UNKNOWN_REQUEST_CLASS
  • LATENCY_SENSITIVE
  • PRODUCTION_BATCH
  • BEST_EFFORT
enumDescriptions
typestring
scottyAgentUserId
formatint64
typestring
scottyCustomerLog
formatbyte
typestring
trafficClassField
enum
  • BE1
  • AF1
  • AF2
  • AF3
  • AF4
  • NC1
  • NC0
  • BE0
  • LLQ
  • LLQ1
  • LLQ2
  • LLQ3
enumDescriptions
typestring
verifyHashFromHeader
typeboolean
typeobject
GdataBlobstore2Info
idGdataBlobstore2Info
properties
blobGeneration
formatint64
typestring
blobId
typestring
downloadReadHandle
formatbyte
typestring
readToken
typestring
uploadMetadataContainer
formatbyte
typestring
typeobject
GdataCompositeMedia
idGdataCompositeMedia
properties
blobRef
deprecatedTrue
formatbyte
typestring
blobstore2Info
$refGdataBlobstore2Info
cosmoBinaryReference
formatbyte
typestring
crc32cHash
formatuint32
typeinteger
inline
formatbyte
typestring
length
formatint64
typestring
md5Hash
formatbyte
typestring
objectId
$refGdataObjectId
path
typestring
referenceType
enum
  • PATH
  • BLOB_REF
  • INLINE
  • BIGSTORE_REF
  • COSMO_BINARY_REFERENCE
enumDescriptions
typestring
sha1Hash
formatbyte
typestring
typeobject
GdataContentTypeInfo
idGdataContentTypeInfo
properties
bestGuess
typestring
fromBytes
typestring
fromFileName
typestring
fromHeader
typestring
fromUrlPath
typestring
typeobject
GdataDiffChecksumsResponse
idGdataDiffChecksumsResponse
properties
checksumsLocation
$refGdataCompositeMedia
chunkSizeBytes
formatint64
typestring
objectLocation
$refGdataCompositeMedia
objectSizeBytes
formatint64
typestring
objectVersion
typestring
typeobject
GdataDiffDownloadResponse
idGdataDiffDownloadResponse
properties
objectLocation
$refGdataCompositeMedia
typeobject
GdataDiffUploadRequest
idGdataDiffUploadRequest
properties
checksumsInfo
$refGdataCompositeMedia
objectInfo
$refGdataCompositeMedia
objectVersion
typestring
typeobject
GdataDiffUploadResponse
idGdataDiffUploadResponse
properties
objectVersion
typestring
originalObject
$refGdataCompositeMedia
typeobject
GdataDiffVersionResponse
idGdataDiffVersionResponse
properties
objectSizeBytes
formatint64
typestring
objectVersion
typestring
typeobject
GdataDownloadParameters
idGdataDownloadParameters
properties
allowGzipCompression
typeboolean
ignoreRange
typeboolean
typeobject
GdataMedia
idGdataMedia
properties
algorithm
deprecatedTrue
typestring
bigstoreObjectRef
deprecatedTrue
formatbyte
typestring
blobRef
deprecatedTrue
formatbyte
typestring
blobstore2Info
$refGdataBlobstore2Info
compositeMedia
items
$refGdataCompositeMedia
typearray
contentType
typestring
contentTypeInfo
$refGdataContentTypeInfo
cosmoBinaryReference
formatbyte
typestring
crc32cHash
formatuint32
typeinteger
diffChecksumsResponse
$refGdataDiffChecksumsResponse
diffDownloadResponse
$refGdataDiffDownloadResponse
diffUploadRequest
$refGdataDiffUploadRequest
diffUploadResponse
$refGdataDiffUploadResponse
diffVersionResponse
$refGdataDiffVersionResponse
downloadParameters
$refGdataDownloadParameters
filename
typestring
hash
deprecatedTrue
typestring
hashVerified
typeboolean
inline
formatbyte
typestring
isPotentialRetry
typeboolean
length
formatint64
typestring
md5Hash
formatbyte
typestring
mediaId
formatbyte
typestring
objectId
$refGdataObjectId
path
typestring
referenceType
enum
  • PATH
  • BLOB_REF
  • INLINE
  • GET_MEDIA
  • COMPOSITE_MEDIA
  • BIGSTORE_REF
  • DIFF_VERSION_RESPONSE
  • DIFF_CHECKSUMS_RESPONSE
  • DIFF_DOWNLOAD_RESPONSE
  • DIFF_UPLOAD_REQUEST
  • DIFF_UPLOAD_RESPONSE
  • COSMO_BINARY_REFERENCE
  • ARBITRARY_BYTES
enumDescriptions
typestring
sha1Hash
formatbyte
typestring
sha256Hash
formatbyte
typestring
timestamp
formatuint64
typestring
token
typestring
typeobject
GdataObjectId
idGdataObjectId
properties
bucketName
typestring
generation
formatint64
typestring
objectName
typestring
typeobject
GoogleProtobufEmpty
descriptionA 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); }
idGoogleProtobufEmpty
properties
typeobject
GoogleSubscriptionsBackupV1ApiRequestHeader
idGoogleSubscriptionsBackupV1ApiRequestHeader
properties
clientInfo
$refGoogleSubscriptionsBackupV1ClientInfo
experimentOverrides
typestring
typeobject
GoogleSubscriptionsBackupV1Backup
idGoogleSubscriptionsBackupV1Backup
properties
activeTransactionId
typestring
backupId
typestring
sizeBytes
formatint64
typestring
updateTime
formatgoogle-datetime
typestring
typeobject
GoogleSubscriptionsBackupV1BackupConfig
idGoogleSubscriptionsBackupV1BackupConfig
properties
androidSdkVersion
formatint32
typeinteger
gmsCoreApkVersion
typestring
hasMmsBackupEnabledBefore
typeboolean
hasRequiredPhotosPermission
typeboolean
inMsaExperiment
typeboolean
isAndroidBackupEnabled
typeboolean
isAndroidBackupSupported
typeboolean
isDeviceEtu
typeboolean
isMmsBackupEnabled
typeboolean
isMmsBackupSupported
typeboolean
isPhotosBackupEnabled
typeboolean
isPhotosBackupSupported
typeboolean
isPhotosDefaultGallery
typeboolean
lastAppBackupCompletionTimestamp
formatgoogle-datetime
typestring
photosApkVersion
typestring
systemRestoreCompletionTimestamp
formatgoogle-datetime
typestring
wasMsaShown
typeboolean
typeobject
GoogleSubscriptionsBackupV1ClientInfo
idGoogleSubscriptionsBackupV1ClientInfo
properties
clientId
enum
  • CLIENT_ID_UNSPECIFIED
  • CLIENT_ID_G1_ANDROID_APP
  • CLIENT_ID_GMSCORE_BACKUP
  • CLIENT_ID_DRIVE_BACKUP
  • CLIENT_ID_MANUAL
  • CLIENT_ID_PROBER
  • CLIENT_ID_PIXELMIGRATE
enumDescriptions
typestring
version
typestring
typeobject
GoogleSubscriptionsBackupV1CommitTransactionRequest
idGoogleSubscriptionsBackupV1CommitTransactionRequest
properties
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
transactionId
typestring
typeobject
GoogleSubscriptionsBackupV1CommitTransactionResponse
idGoogleSubscriptionsBackupV1CommitTransactionResponse
properties
typeobject
GoogleSubscriptionsBackupV1CreateBackupRequest
idGoogleSubscriptionsBackupV1CreateBackupRequest
properties
androidId
formatint64
typestring
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
typeobject
GoogleSubscriptionsBackupV1DeleteBackupConfigRequest
idGoogleSubscriptionsBackupV1DeleteBackupConfigRequest
properties
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
typeobject
GoogleSubscriptionsBackupV1DeleteFilesRequest
idGoogleSubscriptionsBackupV1DeleteFilesRequest
properties
fileIds
items
typestring
typearray
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
transactionId
typestring
typeobject
GoogleSubscriptionsBackupV1File
idGoogleSubscriptionsBackupV1File
properties
blob
$refGdataMedia
fileId
typestring
mediaResponseInfo
$refApiservingMediaResponseInfo
readOnlyTrue
mimeType
typestring
sizeBytes
formatint64
typestring
updateTime
formatgoogle-datetime
typestring
typeobject
GoogleSubscriptionsBackupV1ListBackupsResponse
idGoogleSubscriptionsBackupV1ListBackupsResponse
properties
backups
additionalProperties
$refGoogleSubscriptionsBackupV1Backup
typeobject
nextPageToken
typestring
typeobject
GoogleSubscriptionsBackupV1ListFilesResponse
idGoogleSubscriptionsBackupV1ListFilesResponse
properties
files
items
$refGoogleSubscriptionsBackupV1File
typearray
nextPageToken
typestring
typeobject
GoogleSubscriptionsBackupV1StartTransactionRequest
idGoogleSubscriptionsBackupV1StartTransactionRequest
properties
maxTransactionSize
formatint64
typestring
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
transactionOptions
$refGoogleSubscriptionsBackupV1TransactionOptions
typeobject
GoogleSubscriptionsBackupV1Transaction
idGoogleSubscriptionsBackupV1Transaction
properties
id
typestring
transactionOptions
$refGoogleSubscriptionsBackupV1TransactionOptions
typeobject
GoogleSubscriptionsBackupV1TransactionOptions
idGoogleSubscriptionsBackupV1TransactionOptions
properties
mode
enum
  • TRANSACTION_MODE_UNSPECIFIED
  • READ_ONLY
  • READ_WRITE
enumDescriptions
typestring
typeobject
GoogleSubscriptionsBackupV1UpdateBackupConfigRequest
idGoogleSubscriptionsBackupV1UpdateBackupConfigRequest
properties
androidSdkVersion
formatint32
typeinteger
gmsCoreApkVersion
typestring
hasRequiredPhotosPermission
typeboolean
inMsaExperiment
typeboolean
isAndroidBackupEnabled
typeboolean
isAndroidBackupSupported
typeboolean
isDeviceEtu
typeboolean
isMmsBackupEnabled
typeboolean
isMmsBackupSupported
typeboolean
isPhotosBackupEnabled
typeboolean
isPhotosBackupSupported
typeboolean
isPhotosDefaultGallery
typeboolean
lastAppBackupCompletionTimestamp
formatgoogle-datetime
typestring
photosApkVersion
typestring
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
systemRestoreCompletionTimestamp
formatgoogle-datetime
typestring
wasMsaShown
typeboolean
typeobject
root['title']
new_valueMMS Backup Private API (Staging)
old_valueGoogle One Backup Private API
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][0]
new_valueSuch requests signals the start of a request containing media upload. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.
old_value
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
iterable_item_added
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][1]Such requests signals that the upload has progressed and that the backend might want to access the media file specified in relevant fields in the resource. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][2]Such requests signals the end of a request containing media upload. END should be handled just like normal Insert/Upload requests, that is, they should process the request and return a complete resource in the response. Pointers to media data (a GFS path usually) appear in the relevant fields in the inserted/updated resource. See gdata.Media in data.proto.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][3]Such requests occur after an END and signal that the response has been sent back to the client. RESPONSE_SENT is only sent to the backend if it is configured to receive them. The response does not need to contain anything.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][4]Such requests indicate that an error occurred while processing the request. ERROR is only sent to the backend if it is configured to receive them. It is not guaranteed that all errors will result in this notification to the backend, even if the backend requests them. Since these requests are just for informational purposes, the response does not need to contain anything.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
sandbox/autopush-myphonenumbers-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/autopush-myphonenumbers-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/autopush-notifications-pa-
dictionary_item_added
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__GeofenceNotificationsSettingsConstraint']
  • root['schemas']['AppsDynamite__ChimeNotificationPayload']['properties']['reactionId']
  • root['schemas']['GoogleInternalFitbitP11ManagementV1Notification__P11ChimeDevicePayload']['properties']['enableEsimUpdateNotifications']
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__UserSettingsConstraint']['properties']['geofenceNotificationsSettingsConstraint']
  • root['schemas']['NotificationsFrontendData_RenderContext_DeviceInfo']['properties']['appVersionCode']
values_changed
root['revision']
new_value20250518
old_value20250514
root['schemas']['GoogleInternalFitbitP11ManagementV1Notification__P11ChimeDevicePayload']['description']
new_valueIncluded in the chime registration payload and retrieved in the backend render context when the renderer is invoked on notifications. Next ID: 9
old_valueIncluded in the chime registration payload and retrieved in the backend render context when the renderer is invoked on notifications. Next ID: 8
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][605]
new_valueNeed bundle type for Real World Journeys (RWJ) short video card.
old_valueNeed bundle type for RWJ short video card.
iterable_item_added
root['schemas']['NotificationsFrontendDataCommon__SupportedFeatures']['properties']['supportedCustomUiTypes']['items']['enum'][5]CUSTOM_UI_TYPE_OG_CALLOUT
root['schemas']['NotificationsFrontendDataCommon__SupportedFeatures']['properties']['supportedCustomUiTypes']['items']['enumDescriptions'][5]IN_WEB pre-custom UI traffic.
root['schemas']['NotificationsPlatformCommonProto__CustomUi']['properties']['customUiType']['enum'][5]CUSTOM_UI_TYPE_OG_CALLOUT
root['schemas']['NotificationsPlatformCommonProto__CustomUi']['properties']['customUiType']['enumDescriptions'][5]IN_WEB pre-custom UI traffic.
root['schemas']['SearchNotificationsClientCommon__InboxChimeData']['properties']['category']['enum'][286]UPCOMING_HOLIDAYS_EVENTS_NOTIF
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][606]RWJ_WHATS_HAPPENING
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][619]TRENDING_FOR_YOU
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][620]SOCIAL_MEDIA_COMMENTS
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][606]Need bundle type for Real World Journeys (RWJ) What's Happening card.
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][618]Need bundle type for Neon Cluster in Discover. go/discover-story-neon-integration
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][619]Need bundle type for Trending for You in Discover. go/discover-story-rr-flow
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][620]Need bundle type for This feature will fetch social media comments related to a content. NextId: 4628
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1486]RWJ_WHATS_HAPPENING
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1499]TRENDING_FOR_YOU
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1500]SOCIAL_MEDIA_COMMENTS
root['schemas']['Sidekick__SemanticProperties']['properties']['notificationCategory']['enum'][286]UPCOMING_HOLIDAYS_EVENTS_NOTIF
iterable_item_removed
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][617]Need bundle type for Neon Cluster in Discover. go/discover-story-neon-integration NextId: 4625
sandbox/autopush-notifications-pa-v1
dictionary_item_added
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__GeofenceNotificationsSettingsConstraint']
  • root['schemas']['AppsDynamite__ChimeNotificationPayload']['properties']['reactionId']
  • root['schemas']['GoogleInternalFitbitP11ManagementV1Notification__P11ChimeDevicePayload']['properties']['enableEsimUpdateNotifications']
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__UserSettingsConstraint']['properties']['geofenceNotificationsSettingsConstraint']
  • root['schemas']['NotificationsFrontendData_RenderContext_DeviceInfo']['properties']['appVersionCode']
values_changed
root['revision']
new_value20250518
old_value20250514
root['schemas']['GoogleInternalFitbitP11ManagementV1Notification__P11ChimeDevicePayload']['description']
new_valueIncluded in the chime registration payload and retrieved in the backend render context when the renderer is invoked on notifications. Next ID: 9
old_valueIncluded in the chime registration payload and retrieved in the backend render context when the renderer is invoked on notifications. Next ID: 8
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][605]
new_valueNeed bundle type for Real World Journeys (RWJ) short video card.
old_valueNeed bundle type for RWJ short video card.
iterable_item_added
root['schemas']['NotificationsFrontendDataCommon__SupportedFeatures']['properties']['supportedCustomUiTypes']['items']['enum'][5]CUSTOM_UI_TYPE_OG_CALLOUT
root['schemas']['NotificationsFrontendDataCommon__SupportedFeatures']['properties']['supportedCustomUiTypes']['items']['enumDescriptions'][5]IN_WEB pre-custom UI traffic.
root['schemas']['NotificationsPlatformCommonProto__CustomUi']['properties']['customUiType']['enum'][5]CUSTOM_UI_TYPE_OG_CALLOUT
root['schemas']['NotificationsPlatformCommonProto__CustomUi']['properties']['customUiType']['enumDescriptions'][5]IN_WEB pre-custom UI traffic.
root['schemas']['SearchNotificationsClientCommon__InboxChimeData']['properties']['category']['enum'][286]UPCOMING_HOLIDAYS_EVENTS_NOTIF
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][606]RWJ_WHATS_HAPPENING
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][619]TRENDING_FOR_YOU
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][620]SOCIAL_MEDIA_COMMENTS
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][606]Need bundle type for Real World Journeys (RWJ) What's Happening card.
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][618]Need bundle type for Neon Cluster in Discover. go/discover-story-neon-integration
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][619]Need bundle type for Trending for You in Discover. go/discover-story-rr-flow
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][620]Need bundle type for This feature will fetch social media comments related to a content. NextId: 4628
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1486]RWJ_WHATS_HAPPENING
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1499]TRENDING_FOR_YOU
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1500]SOCIAL_MEDIA_COMMENTS
root['schemas']['Sidekick__SemanticProperties']['properties']['notificationCategory']['enum'][286]UPCOMING_HOLIDAYS_EVENTS_NOTIF
iterable_item_removed
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][617]Need bundle type for Neon Cluster in Discover. go/discover-story-neon-integration NextId: 4625
sandbox/autopush-ogads-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
iterable_item_added
root['resources']['v1']['methods']['getdata']['parameters']['hostProduct']['enum'][733]FINANCE_HUB
root['resources']['v1']['methods']['getdata']['parameters']['hostProduct']['enumDescriptions'][733]go/finhub-design
root['resources']['v1']['methods']['getdata']['parameters']['subproduct']['enum'][733]FINANCE_HUB
root['resources']['v1']['methods']['getdata']['parameters']['subproduct']['enumDescriptions'][733]go/finhub-design
sandbox/autopush-ogads-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
iterable_item_added
root['resources']['v1']['methods']['getdata']['parameters']['hostProduct']['enum'][733]FINANCE_HUB
root['resources']['v1']['methods']['getdata']['parameters']['hostProduct']['enumDescriptions'][733]go/finhub-design
root['resources']['v1']['methods']['getdata']['parameters']['subproduct']['enum'][733]FINANCE_HUB
root['resources']['v1']['methods']['getdata']['parameters']['subproduct']['enumDescriptions'][733]go/finhub-design
sandbox/autopush-people-pa-
dictionary_item_added
  • root['schemas']['GuestPassMetadata']
  • root['schemas']['ReadOnlyProfileInfo']['properties']['guestPassMetadata']
values_changed
root['revision']
new_value20250518
old_value20250514
iterable_item_added
root['resources']['people']['methods']['create']['parameters']['getPeopleRequest.mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['create']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['getPublic']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['sync']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['update']['parameters']['getPeopleRequest.mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['update']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['allPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['autocomplete']['methods']['list']['parameters']['client']['enum'][135]MSS_JUPITER
root['resources']['people']['resources']['autocomplete']['resources']['public']['methods']['list']['parameters']['client']['enum'][135]MSS_JUPITER
root['resources']['people']['resources']['blockedPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['circledPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['circles']['resources']['members']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['contactPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['search']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['sync']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['groups']['resources']['members']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['lookup']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['ranked']['methods']['list']['parameters']['affinityType']['enum'][308]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['ranked']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['rankedTargets']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['starredPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['trashedContactPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['v2']['methods']['getPeople']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['schemas']['Affinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['GoogleInternalPeopleV2MinimalRankedTarget']['properties']['affinityType']['items']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['InternalSourceSummaryProto']['properties']['provider']['enum'][205]PROVIDER_GOOGLE_POI_IDENTITY
root['schemas']['MergedPersonSourceOptions']['properties']['includeAffinity']['items']['enum'][313]MSS_JUPITER_AFFINITY
root['schemas']['RankedTarget']['properties']['affinityType']['items']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['SocialGraphWireProtoPeopleapiMinimalAffinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
sandbox/autopush-people-pa-v1
dictionary_item_added
  • root['schemas']['GuestPassMetadata']
  • root['schemas']['ReadOnlyProfileInfo']['properties']['guestPassMetadata']
values_changed
root['revision']
new_value20250518
old_value20250514
iterable_item_added
root['schemas']['Affinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['InternalSourceSummaryProto']['properties']['provider']['enum'][205]PROVIDER_GOOGLE_POI_IDENTITY
sandbox/autopush-people-pa-v2
dictionary_item_added
  • root['schemas']['GuestPassMetadata']
  • root['schemas']['ReadOnlyProfileInfo']['properties']['guestPassMetadata']
values_changed
root['revision']
new_value20250518
old_value20250514
iterable_item_added
root['resources']['people']['methods']['create']['parameters']['getPeopleRequest.mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['create']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['getPublic']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['sync']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['update']['parameters']['getPeopleRequest.mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['update']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['allPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['autocomplete']['methods']['list']['parameters']['client']['enum'][135]MSS_JUPITER
root['resources']['people']['resources']['autocomplete']['resources']['public']['methods']['list']['parameters']['client']['enum'][135]MSS_JUPITER
root['resources']['people']['resources']['blockedPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['circledPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['circles']['resources']['members']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['contactPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['search']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['sync']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['groups']['resources']['members']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['lookup']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['ranked']['methods']['list']['parameters']['affinityType']['enum'][308]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['ranked']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['rankedTargets']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['starredPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['trashedContactPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['v2']['methods']['getPeople']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['schemas']['Affinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['GoogleInternalPeopleV2MinimalRankedTarget']['properties']['affinityType']['items']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['InternalSourceSummaryProto']['properties']['provider']['enum'][205]PROVIDER_GOOGLE_POI_IDENTITY
root['schemas']['MergedPersonSourceOptions']['properties']['includeAffinity']['items']['enum'][313]MSS_JUPITER_AFFINITY
root['schemas']['RankedTarget']['properties']['affinityType']['items']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['SocialGraphWireProtoPeopleapiMinimalAffinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
sandbox/autopush-peoplestack-pa-
values_changed
root['revision']
new_value20250517
old_value20250515
iterable_item_added
root['resources']['autocomplete']['methods']['autocomplete']['parameters']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['resources']['autocomplete']['methods']['warmup']['parameters']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackAutocompleteRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackBlockPersonRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackCreateGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackDeleteGroupsRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackJoinGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackLeaveGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackLookupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackMutateConnectionLabelRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackReadAllGroupsRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackReadGroupsRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackSmartAddressRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackUpdateGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackWarmupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
sandbox/autopush-peoplestack-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250515
iterable_item_added
root['resources']['autocomplete']['methods']['autocomplete']['parameters']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['resources']['autocomplete']['methods']['warmup']['parameters']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackAutocompleteRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackBlockPersonRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackCreateGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackDeleteGroupsRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackJoinGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackLeaveGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackLookupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackMutateConnectionLabelRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackReadAllGroupsRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackReadGroupsRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackSmartAddressRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackUpdateGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackWarmupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
sandbox/autopush-phonedeviceverification-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/autopush-phonedeviceverification-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/autopush-reach-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/autopush-reach-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/content-autopush-notifications-pa-
dictionary_item_added
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__GeofenceNotificationsSettingsConstraint']
  • root['schemas']['AppsDynamite__ChimeNotificationPayload']['properties']['reactionId']
  • root['schemas']['GoogleInternalFitbitP11ManagementV1Notification__P11ChimeDevicePayload']['properties']['enableEsimUpdateNotifications']
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__UserSettingsConstraint']['properties']['geofenceNotificationsSettingsConstraint']
  • root['schemas']['NotificationsFrontendData_RenderContext_DeviceInfo']['properties']['appVersionCode']
values_changed
root['revision']
new_value20250518
old_value20250514
root['schemas']['GoogleInternalFitbitP11ManagementV1Notification__P11ChimeDevicePayload']['description']
new_valueIncluded in the chime registration payload and retrieved in the backend render context when the renderer is invoked on notifications. Next ID: 9
old_valueIncluded in the chime registration payload and retrieved in the backend render context when the renderer is invoked on notifications. Next ID: 8
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][605]
new_valueNeed bundle type for Real World Journeys (RWJ) short video card.
old_valueNeed bundle type for RWJ short video card.
iterable_item_added
root['schemas']['NotificationsFrontendDataCommon__SupportedFeatures']['properties']['supportedCustomUiTypes']['items']['enum'][5]CUSTOM_UI_TYPE_OG_CALLOUT
root['schemas']['NotificationsFrontendDataCommon__SupportedFeatures']['properties']['supportedCustomUiTypes']['items']['enumDescriptions'][5]IN_WEB pre-custom UI traffic.
root['schemas']['NotificationsPlatformCommonProto__CustomUi']['properties']['customUiType']['enum'][5]CUSTOM_UI_TYPE_OG_CALLOUT
root['schemas']['NotificationsPlatformCommonProto__CustomUi']['properties']['customUiType']['enumDescriptions'][5]IN_WEB pre-custom UI traffic.
root['schemas']['SearchNotificationsClientCommon__InboxChimeData']['properties']['category']['enum'][286]UPCOMING_HOLIDAYS_EVENTS_NOTIF
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][606]RWJ_WHATS_HAPPENING
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][619]TRENDING_FOR_YOU
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][620]SOCIAL_MEDIA_COMMENTS
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][606]Need bundle type for Real World Journeys (RWJ) What's Happening card.
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][618]Need bundle type for Neon Cluster in Discover. go/discover-story-neon-integration
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][619]Need bundle type for Trending for You in Discover. go/discover-story-rr-flow
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][620]Need bundle type for This feature will fetch social media comments related to a content. NextId: 4628
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1486]RWJ_WHATS_HAPPENING
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1499]TRENDING_FOR_YOU
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1500]SOCIAL_MEDIA_COMMENTS
root['schemas']['Sidekick__SemanticProperties']['properties']['notificationCategory']['enum'][286]UPCOMING_HOLIDAYS_EVENTS_NOTIF
iterable_item_removed
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][617]Need bundle type for Neon Cluster in Discover. go/discover-story-neon-integration NextId: 4625
sandbox/content-autopush-notifications-pa-v1
dictionary_item_added
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__GeofenceNotificationsSettingsConstraint']
  • root['schemas']['AppsDynamite__ChimeNotificationPayload']['properties']['reactionId']
  • root['schemas']['GoogleInternalFitbitP11ManagementV1Notification__P11ChimeDevicePayload']['properties']['enableEsimUpdateNotifications']
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__UserSettingsConstraint']['properties']['geofenceNotificationsSettingsConstraint']
  • root['schemas']['NotificationsFrontendData_RenderContext_DeviceInfo']['properties']['appVersionCode']
values_changed
root['revision']
new_value20250518
old_value20250514
root['schemas']['GoogleInternalFitbitP11ManagementV1Notification__P11ChimeDevicePayload']['description']
new_valueIncluded in the chime registration payload and retrieved in the backend render context when the renderer is invoked on notifications. Next ID: 9
old_valueIncluded in the chime registration payload and retrieved in the backend render context when the renderer is invoked on notifications. Next ID: 8
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][605]
new_valueNeed bundle type for Real World Journeys (RWJ) short video card.
old_valueNeed bundle type for RWJ short video card.
iterable_item_added
root['schemas']['NotificationsFrontendDataCommon__SupportedFeatures']['properties']['supportedCustomUiTypes']['items']['enum'][5]CUSTOM_UI_TYPE_OG_CALLOUT
root['schemas']['NotificationsFrontendDataCommon__SupportedFeatures']['properties']['supportedCustomUiTypes']['items']['enumDescriptions'][5]IN_WEB pre-custom UI traffic.
root['schemas']['NotificationsPlatformCommonProto__CustomUi']['properties']['customUiType']['enum'][5]CUSTOM_UI_TYPE_OG_CALLOUT
root['schemas']['NotificationsPlatformCommonProto__CustomUi']['properties']['customUiType']['enumDescriptions'][5]IN_WEB pre-custom UI traffic.
root['schemas']['SearchNotificationsClientCommon__InboxChimeData']['properties']['category']['enum'][286]UPCOMING_HOLIDAYS_EVENTS_NOTIF
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][606]RWJ_WHATS_HAPPENING
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][619]TRENDING_FOR_YOU
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][620]SOCIAL_MEDIA_COMMENTS
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][606]Need bundle type for Real World Journeys (RWJ) What's Happening card.
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][618]Need bundle type for Neon Cluster in Discover. go/discover-story-neon-integration
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][619]Need bundle type for Trending for You in Discover. go/discover-story-rr-flow
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][620]Need bundle type for This feature will fetch social media comments related to a content. NextId: 4628
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1486]RWJ_WHATS_HAPPENING
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1499]TRENDING_FOR_YOU
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1500]SOCIAL_MEDIA_COMMENTS
root['schemas']['Sidekick__SemanticProperties']['properties']['notificationCategory']['enum'][286]UPCOMING_HOLIDAYS_EVENTS_NOTIF
iterable_item_removed
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][617]Need bundle type for Neon Cluster in Discover. go/discover-story-neon-integration NextId: 4625
sandbox/content-autopush-people-pa-
dictionary_item_added
  • root['schemas']['GuestPassMetadata']
  • root['schemas']['ReadOnlyProfileInfo']['properties']['guestPassMetadata']
values_changed
root['revision']
new_value20250518
old_value20250514
iterable_item_added
root['resources']['people']['methods']['create']['parameters']['getPeopleRequest.mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['create']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['getPublic']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['sync']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['update']['parameters']['getPeopleRequest.mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['update']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['allPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['autocomplete']['methods']['list']['parameters']['client']['enum'][135]MSS_JUPITER
root['resources']['people']['resources']['autocomplete']['resources']['public']['methods']['list']['parameters']['client']['enum'][135]MSS_JUPITER
root['resources']['people']['resources']['blockedPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['circledPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['circles']['resources']['members']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['contactPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['search']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['sync']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['groups']['resources']['members']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['lookup']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['ranked']['methods']['list']['parameters']['affinityType']['enum'][308]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['ranked']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['rankedTargets']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['starredPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['trashedContactPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['v2']['methods']['getPeople']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['schemas']['Affinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['GoogleInternalPeopleV2MinimalRankedTarget']['properties']['affinityType']['items']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['InternalSourceSummaryProto']['properties']['provider']['enum'][205]PROVIDER_GOOGLE_POI_IDENTITY
root['schemas']['MergedPersonSourceOptions']['properties']['includeAffinity']['items']['enum'][313]MSS_JUPITER_AFFINITY
root['schemas']['RankedTarget']['properties']['affinityType']['items']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['SocialGraphWireProtoPeopleapiMinimalAffinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
sandbox/content-autopush-people-pa-v1
dictionary_item_added
  • root['schemas']['GuestPassMetadata']
  • root['schemas']['ReadOnlyProfileInfo']['properties']['guestPassMetadata']
values_changed
root['revision']
new_value20250518
old_value20250514
iterable_item_added
root['schemas']['Affinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['InternalSourceSummaryProto']['properties']['provider']['enum'][205]PROVIDER_GOOGLE_POI_IDENTITY
sandbox/content-autopush-people-pa-v2
dictionary_item_added
  • root['schemas']['GuestPassMetadata']
  • root['schemas']['ReadOnlyProfileInfo']['properties']['guestPassMetadata']
values_changed
root['revision']
new_value20250518
old_value20250514
iterable_item_added
root['resources']['people']['methods']['create']['parameters']['getPeopleRequest.mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['create']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['getPublic']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['sync']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['update']['parameters']['getPeopleRequest.mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['update']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['allPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['autocomplete']['methods']['list']['parameters']['client']['enum'][135]MSS_JUPITER
root['resources']['people']['resources']['autocomplete']['resources']['public']['methods']['list']['parameters']['client']['enum'][135]MSS_JUPITER
root['resources']['people']['resources']['blockedPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['circledPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['circles']['resources']['members']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['contactPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['search']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['sync']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['groups']['resources']['members']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['lookup']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['ranked']['methods']['list']['parameters']['affinityType']['enum'][308]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['ranked']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['rankedTargets']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['starredPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['trashedContactPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['v2']['methods']['getPeople']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['schemas']['Affinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['GoogleInternalPeopleV2MinimalRankedTarget']['properties']['affinityType']['items']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['InternalSourceSummaryProto']['properties']['provider']['enum'][205]PROVIDER_GOOGLE_POI_IDENTITY
root['schemas']['MergedPersonSourceOptions']['properties']['includeAffinity']['items']['enum'][313]MSS_JUPITER_AFFINITY
root['schemas']['RankedTarget']['properties']['affinityType']['items']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['SocialGraphWireProtoPeopleapiMinimalAffinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
sandbox/dev-scone-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/dev-scone-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/phonedeviceverification-pa-prod-
values_changed
root['revision']
new_value20250515
old_value20250514
sandbox/phonedeviceverification-pa-prod-v1
values_changed
root['revision']
new_value20250515
old_value20250514
sandbox/preprod-growth-pa-
values_changed
root['revision']
new_value20250514
old_value20250513
sandbox/preprod-growth-pa-v1
values_changed
root['revision']
new_value20250514
old_value20250513
sandbox/prod-phonedeviceverification-pa-
values_changed
root['revision']
new_value20250515
old_value20250514
sandbox/prod-phonedeviceverification-pa-v1
values_changed
root['revision']
new_value20250515
old_value20250514
sandbox/staging-accountsettingsmobile-pa-
dictionary_item_added
  • root['fullyEncodeReservedExpansion']
values_changed
root['baseUrl']
new_valuehttps://reach-pa.googleapis.com/
old_valuehttps://staging-accountsettingsmobile-pa.sandbox.googleapis.com/
root['canonicalName']
new_valueReach Presentation Service
old_valueAccount Settings Mobile
root['description']
new_valuereach-pa.googleapis.com API.
old_valueAn API which services Google account settings UIs on Android and iOS.
root['documentationLink']
new_valuehttp://go/safetyexp-entry-point-dd
old_valuehttp://go/asm
root['id']
new_valuereach_pa:v1
old_valueaccountsettingsmobile_pa:v1
root['mtlsRootUrl']
new_valuehttps://reach-pa.mtls.googleapis.com/
old_valuehttps://staging-accountsettingsmobile-pa.mtls.sandbox.googleapis.com/
root['name']
new_valuereach_pa
old_valueaccountsettingsmobile_pa
root['resources']['v1']['methods']
new_value
getAccountMessages
descriptionFetches user's current advice state, potentially updates respective badge dismissal
flatPathv1:getAccountMessages
httpMethodPOST
idreach_pa.getAccountMessages
parameterOrder
parameters
pathv1:getAccountMessages
request
$refAccountMessagesRequest
response
$refAccountMessagesResponse
updateAccountMessages
descriptionUpdates user's current advice state, like updating the advice dismissal status
flatPathv1:updateAccountMessages
httpMethodPOST
idreach_pa.updateAccountMessages
parameterOrder
parameters
pathv1:updateAccountMessages
request
$refUpdateAccountMessagesRequest
response
$refUpdateAccountMessagesResponse
old_value
getClientConfig
descriptionRequests config data for iOS clients.
flatPathv1:getClientConfig
httpMethodPOST
idaccountsettingsmobile_pa.getClientConfig
parameterOrder
parameters
pathv1:getClientConfig
request
$refGetClientConfigRequest
response
$refGetClientConfigResponse
getResource
descriptionRequests a resource.
flatPathv1:getResource
httpMethodPOST
idaccountsettingsmobile_pa.getResource
parameterOrder
parameters
pathv1:getResource
request
$refGetResourceRequest
response
$refGetResourceResponse
getScreen
descriptionRequests a screen.
flatPathv1:getScreen
httpMethodPOST
idaccountsettingsmobile_pa.getScreen
parameterOrder
parameters
pathv1:getScreen
request
$refGetScreenRequest
response
$refGetScreenResponse
getSignedOutResource
descriptionRequests a resource from a signed-out context.
flatPathv1:getSignedOutResource
httpMethodPOST
idaccountsettingsmobile_pa.getSignedOutResource
parameterOrder
parameters
pathv1:getSignedOutResource
request
$refGetSignedOutResourceRequest
response
$refGetSignedOutResourceResponse
prefetchRelatedScreens
descriptionRequests a list of screens which are related to a specified one, with the purpose of prefetching them in the client application.
flatPathv1:prefetchRelatedScreens
httpMethodPOST
idaccountsettingsmobile_pa.prefetchRelatedScreens
parameterOrder
parameters
pathv1:prefetchRelatedScreens
request
$refPrefetchRelatedScreensRequest
response
$refPrefetchRelatedScreensResponse
search
descriptionSearches through resources
flatPathv1:search
httpMethodPOST
idaccountsettingsmobile_pa.search
parameterOrder
parameters
pathv1:search
request
$refSearchRequest
response
$refSearchResponse
setResourceDismissalState
descriptionSets the resource state, e.g. resource is dismissed
flatPathv1:setResourceDismissalState
httpMethodPOST
idaccountsettingsmobile_pa.setResourceDismissalState
parameterOrder
parameters
pathv1:setResourceDismissalState
request
$refSetResourceDismissalStateRequest
response
$refSetResourceDismissalStateResponse
root['revision']
new_value20250517
old_value20250514
root['rootUrl']
new_valuehttps://reach-pa.googleapis.com/
old_valuehttps://staging-accountsettingsmobile-pa.sandbox.googleapis.com/
root['schemas']
new_value
AccountAdvice
descriptionData to render OneGoogle bento account advice
idAccountAdvice
properties
additionalInfo
$refAdditionalInfo
descriptionOptional additional information included with the advice. Currently only used for recovery factor advice.
adviceId
descriptionUnique identifier of the advice type.
formatint32
typeinteger
ctaText
descriptionText to display on the CTA button.
typestring
description
descriptionDescription of the advice.
typestring
destination
$refAdviceDestination
descriptionDestination to open once Bento account advice CTA is clicked
dismissalText
descriptionText to display on the dismissal button.
typestring
title
descriptionTitle of the advice.
typestring
uiTreatment
descriptionUI 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.
typestring
typeobject
AccountMenu
descriptionData to render OneGoogle account menu only for SafetyExp
idAccountMenu
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
typestring
destination
$refAlertDestination
typeobject
AccountMessagesRequest
descriptionRequest for the GetAccountMessages RPC
idAccountMessagesRequest
properties
accountParticleDiscVersion
$refVersion
descriptionVersion of the AccountParticleDisc that is currently present on the device, iff present.
adviceFlavours
descriptionThe 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.
typestring
typearray
context
$refContext
descriptionContext of the triggering call, e.g. version/CL, platform, etc
surfaces
descriptionList 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.
typestring
typearray
triggeringEvent
$refTriggeringEvent
descriptionThe 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
typeobject
AccountMessagesResponse
descriptionResponse for the GetAccountMessages RPC
idAccountMessagesResponse
properties
accountAdvices
descriptionList of active advices to show the user
items
$refAccountAdvice
typearray
accountMenu
$refAccountMenu
descriptionOnly used for SafetyExp
accountParticleDisc
$refAccountParticleDisc
isServerDarkLaunch
descriptionThe server is currently in a ‘dark launch’ state.
typeboolean
typeobject
AccountParticleDisc
descriptionData to render OneGoogle account particle disc
idAccountParticleDisc
properties
badgeDismissalEvents
items
enum
  • BADGE_DISMISSAL_EVENT_UNSPECIFIED
  • ACCOUNT_MENU_OPENED
enumDescriptions
  • Shouldn't be used
  • User has opened account menu
typestring
typearray
badgeStatus
enum
  • BADGE_STATUS_UNSPECIFIED
  • NONE
  • ATTENTION
enumDescriptions
  • No information about badge status
  • No badge
  • Attention badge (yellow)
typestring
version
$refVersion
typeobject
AdditionalInfo
descriptionAdditional miscellaneous information included with the advice.
idAdditionalInfo
properties
numExistingRecoveryFactors
descriptionNumber of existing recovery factors the user has.
formatint32
typeinteger
typeobject
AdviceDestination
descriptionDestination to open once Bento account advice CTA is clicked
idAdviceDestination
properties
resourceKey
$refResourceKey
descriptionResource to open in the Google Account
url
$refSafeUrlProto
descriptionURL to open in the browser
typeobject
AlertDestination
descriptionDestination to open once OneGoogle account menu entrypoint is clicked
idAlertDestination
properties
resourceKey
$refResourceKey
descriptionResource to open in the Google Account
url
$refSafeUrlProto
descriptionURL to open in the browser
typeobject
AndroidClientVersion
idAndroidClientVersion
properties
androidOsSdk
descriptionThe Android OS SDK version, e.g. 28 (Android 9 is SDK 28).
formatint32
typeinteger
androidOsVersion
descriptionThe Android OS version, e.g. "5.1.1"
typestring
callingAndroidApp
descriptionApplicationId (package name) or alias of the app that initiated the request
typestring
gmscoreVersionCode
descriptionGmsCore 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
formatint32
typeinteger
gmscoreVersionName
descriptionGmsCore 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)"
typestring
typeobject
Context
descriptionThe 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
idContext
properties
androidClientVersion
$refAndroidClientVersion
hideEntryPointIfViewed
descriptionIf true, don't show EP once Y days have passed since the user viewed it.
typeboolean
hideEntryPointIfVisited
descriptionIf true, don't show EP once X days have passed since the user clicked it.
typeboolean
iosClientVersion
$refIOSClientVersion
isClientDarkLaunch
descriptionThe client is currently in a ‘dark launch’ state.
typeboolean
webClientVersion
$refWebClientVersion
typeobject
IOSClientVersion
idIOSClientVersion
properties
iosAppBundleId
descriptionThe bundle ID (CFBundleIdentifier) of the hosting iOS app e.g. "com.google.ios.youtube"
typestring
iosAppVersion
descriptionThe version (CFBundleVersion) of the hosting iOS app, e.g. "10.30.11661"
typestring
iosBuildChangelist
descriptionChangelist that this client was built at. Obtained from google3/googlemac/Shared/Metrics/Phenotype/Classes/PHTPhenotypeBuildData.h
typestring
typeobject
OneGoogleTriggeringEvent
descriptionOneGoogle specific event that triggered client to fetch the data
idOneGoogleTriggeringEvent
properties
reason
descriptionEnum 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.
typestring
typeobject
ResourceKey
descriptionEach 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.
idResourceKey
properties
resourceId
descriptiona value from the ResourceId enum
formatint32
typeinteger
resourceParams
additionalProperties
typestring
descriptionkey-value map of request parameters
typeobject
typeobject
SafeUrlProto
descriptionMessage 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.
idSafeUrlProto
properties
privateDoNotAccessOrElseSafeUrlWrappedValue
descriptionIMPORTANT: 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.
typestring
typeobject
TriggeringEvent
descriptionEvent that triggered client to fetch the data
idTriggeringEvent
properties
onegoogleTriggeringEvent
$refOneGoogleTriggeringEvent
typeobject
UpdateAccountMessagesRequest
descriptionRequest for the UpdateAccountMessages RPC
idUpdateAccountMessagesRequest
properties
dismissedAdviceIds
descriptionList 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
formatint32
typeinteger
typearray
typeobject
UpdateAccountMessagesResponse
descriptionResponse for the UpdateAccountMessages RPC. Empty response means success
idUpdateAccountMessagesResponse
properties
typeobject
Version
descriptionA 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
idVersion
properties
typeobject
WebClientVersion
idWebClientVersion
properties
buildLabel
descriptionLabel associated with the build of this binary. See google3/java/com/google/apps/framework/blaze/ImmutableBuildData.kt
typestring
cachedAlertLevel
descriptionAlertLevel 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
typestring
typeobject
old_value
ATTSignalConfig
descriptionConfigures 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.
idATTSignalConfig
properties
paramName
descriptionThe name of the query parameter being appended to the URL.
typestring
urlPatterns
descriptionList of regular expressions for mathing URLs.
items
typestring
typearray
typeobject
AccountMenuInformation
descriptionInformation that can be provided to the OGL account menu Next Id: 2
idAccountMenuInformation
properties
accountAlertLevel
descriptionThe 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.
typestring
typeobject
ActionChip
descriptionAn action chip.
idActionChip
properties
icon
$refImage
descriptionIcon displayed on the left of the chip.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
stackItemImage
$refImage
descriptionWhen 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
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
text
descriptionText of the chip.
typestring
typeobject
ActionChipBlock
descriptionA block containing a scrollable horizontal list of action chips.
idActionChipBlock
properties
chips
descriptionList of action chips.
items
$refActionChip
typearray
listPreviewUnitTotal
descriptionTotal number of chips there would have been if not limited/truncated. This will be mapped to ListPreviewUnit.total.
formatint32
typeinteger
wrapChips
descriptionWhether to wrap chips when there isn't enough space. Currently available for web only.
typeboolean
typeobject
ActionChipsUnit
descriptionscreen/82c8fpyatXbybbe
idActionChipsUnit
properties
actionChips
descriptionActionChips
items
$refActionChip
typearray
wrapChips
descriptionWhether the chips should wrap when there's not enough horizontal space.
typeboolean
typeobject
ActionItem
descriptionThe action item that may be used to build all kind of menus.
idActionItem
properties
delegateLinkType
descriptionSpecifies 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
typestring
icon
$refImage
descriptionThe icon of the action item.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
target
$refResourceKey
deprecatedTrue
descriptionThe id of the target resource. DEPRECATED: Use link instead.
title
descriptionThe title of the action item.
typestring
typeobject
ActionLineBlock
descriptionA block containing a navigation link and an icon.
idActionLineBlock
properties
expansionUnitLabel
descriptionWhen 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.
typestring
forcedConversionToStackItem
descriptionForces 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.
typeboolean
icon
$refImage
descriptionicon shown on the right of the block, e.g. chevron icon.
stackItemImage
$refImage
descriptionWhen 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
descriptionVisible text of the link.
typestring
typeobject
ActivityListItemBlock
descriptionA block representing a List item to display activities. Next Id: 7
idActivityListItemBlock
properties
description
descriptionA description of the item, shown underneath the special description.
typestring
image
$refImage
descriptionAn illustration, if set, shown on the left side of the title&description.
imageLink
$refLink
descriptionLink 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
$refResourceKey
deprecatedTrue
descriptionAn optional link target for the image.
specialDescription
$refSpecialDescription
descriptionSpecial description shown underneath the title.
title
$refText
descriptionThe title of the item, as the most prominent text of the item.
typeobject
AdditionalDescription
descriptionThe additional description that might be displayed for some account types. Next id: 8
idAdditionalDescription
properties
image
$refImage
descriptionAn account type logo icon.
link
$refLink
descriptionLink 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
deprecatedTrue
descriptionAccessibility label for the link, used by screen readers instead of link_text. DEPRECATED: Use link.aria_label instead.
typestring
linkIcon
$refImage
descriptionIcon to append after the link text.
linkTarget
$refResourceKey
descriptionThe target resource of the link.
linkText
descriptionThe text in the link that shows up on managed account types (e.g. 'Learn More').
typestring
mainText
descriptionThe secondary description message that shows up on managed account types.
typestring
typeobject
AdditionalParagraph
descriptionEncapsulates one of additional sections of information displayed to the user below the sign in button. Next id: 7
idAdditionalParagraph
properties
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
linkAccessibilityLabel
deprecatedTrue
descriptionAccessibility label for the link, used by screen readers instead of link_text. DEPRECATED: Use link.aria_label instead.
typestring
linkIcon
$refImage
descriptionIcon to append after the link text.
linkTarget
$refResourceKey
deprecatedTrue
descriptionOptional link destination. DEPRECATED: Use link instead.
linkText
descriptionThe text of the link. The link will be displayed inline with the main text. Can be omited leaving just the text.
typestring
text
descriptionMain text in this paragraph. Can be omited leaving just the link.
typestring
typeobject
Alternative
descriptionAlternatives 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
idAlternative
properties
androidIntentAlternative
$refAndroidIntentAlternative
descriptionOpens a native app by launching an Android intent.
browserAlternative
$refBrowserAlternative
descriptionDisplays a screen by opening a page in the browser.
cardsAlternative
$refCardsAlternative
descriptionOpens a native app screen with tabs and card deck.
fauxbakeAlternative
$refFauxbakeAlternative
descriptionOpens a native fauxbake screen, allowing to change the profile picture.
menuAlternative
$refMenuAlternative
descriptionDisplays a screen as a native menu.
messageAlternative
$refMessageAlternative
descriptionDisplays a screen by showing a message to the user.
nativeAlternative
$refNativeAlternative
descriptionDisplays a screen as a native setting.
nativeNavigationAlternative
$refNativeNavigationAlternative
descriptionNavigates to a native screen from a web or webview page.
onboardingAlternative
$refOnboardingAlternative
deprecatedTrue
descriptionOpens an onboarding screen.
placeholderAlternative
$refPlaceholderAlternative
descriptionReserved for internal use by clients.
searchAlternative
$refSearchAlternative
descriptionOpens a native app screen with a search box and results.
supportAlternative
$refSupportAlternative
descriptionOpens a support panel if possible, otherwise opens the support screen.
webviewAlternative
$refWebviewAlternative
descriptionDisplays a screen by opening a page in a WebView.
typeobject
AnchorNavigationParams
descriptionConfiguration items used when scrolling to an item on the screen Next Id: 2
idAnchorNavigationParams
properties
anchor
descriptionThe identifier is used to find an item to which scrolling should happen. The corresponding item should have the same anchor.
typestring
typeobject
AndroidIntent
descriptionAndroid intent
idAndroidIntent
properties
action
descriptionThe intent action, such as ACTION_VIEW.
typestring
categories
descriptionA list of intent categories.
items
typestring
typearray
className
descriptionThe intent class. This should be the complete class with package name. Required.
typestring
extras
additionalProperties
$refExtra
descriptionA map of intent extras keyed by the names of the extras.
typeobject
flagActivityNewTask
descriptionWhether to set the Intent flag FLAG_ACTIVITY_NEW_TASK.
typeboolean
packageName
descriptionThe intent package name. Required.
typestring
thirdParty
deprecatedTrue
descriptionThe intent is for a third-party app. If false, the client will verify that the called app has a Google signature.
typeboolean
type
descriptionThe intent MIME data type.
typestring
uri
descriptionData uri.
typestring
typeobject
AndroidIntentAlternative
descriptionAn alternative with an intent and conditions to launch an Android activity
idAndroidIntentAlternative
properties
check
descriptionDefines 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.
typestring
intent
$refAndroidIntent
descriptionAndroid intent to launch
rules
descriptionIf present, only use the intent if one of these requirements is met (i.e. rules are ORed)
items
$refAndroidIntentRule
typearray
typeobject
AndroidIntentCapabilities
descriptionThe 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.
idAndroidIntentCapabilities
properties
accountNameBackPropagation
descriptionWhether the client supports propagating the account name back to the opening first- or zero party activity.
typeboolean
flagActivityNewTask
descriptionWhether the client supports setting the Intent flag FLAG_ACTIVITY_NEW_TASK.
typeboolean
supportedAndroidIntentCheck
descriptionWhether the client supports a specific intent check type.
items
$refSupportedAndroidIntentCheck
typearray
typeobject
AndroidIntentRule
descriptionAll conditions that are present must be met for this "rule" to be met (i.e. conditions are ANDed).
idAndroidIntentRule
properties
maxVersionCode
descriptionOnly use the intent alternative if the package has at most this version code, exclusive.
formatint32
typeinteger
maxVersionInfo
descriptionThe 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
formatint32
typeinteger
typearray
minVersionCode
descriptionOnly use the intent alternative if the package has at least this version code, inclusive
formatint32
typeinteger
minVersionInfo
descriptionThe 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
formatint32
typeinteger
typearray
packageName
descriptionOnly use the intent alternative if the package is installed. Required.
typestring
typeobject
AnimationSegment
deprecatedTrue
descriptionDescribes the features of the animation segment, which should be applied to the animation specified in OnboardingFlow. Next Id: 3
idAnimationSegment
properties
animationEndFrame
descriptionThe end frame number of the animation segment. Required.
formatint32
typeinteger
animationStartFrame
descriptionThe start frame number of the animation segment. Required.
formatint32
typeinteger
typeobject
AppBar
descriptionRenders the app bar. See go/mg-redesign-header-proto for more info.
idAppBar
properties
actionItems
descriptionAction items to show in the toolbar. Only used on Android and iOS.
items
$refActionItem
typearray
backButtonTarget
$refResourceKey
deprecatedTrue
descriptionThe destination of the back button only used on Web, ignored by other platforms. DEPRECATED: Use link instead.
backLink
$refLink
descriptionLink 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
descriptionWhether 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.
typeboolean
title
descriptionThe title text to be displayed.
typestring
typeobject
Attribute
descriptionAttribute
idAttribute
properties
attribute
descriptionText of the attribute
typestring
image
$refImage
descriptionAn optional image - screen/ivNErM2XjsmVbU7.
typeobject
AttributesUnit
descriptionscreen/8vM3aFoKwwLD7FN
idAttributesUnit
properties
attributes
descriptionList of attributes.
items
$refAttribute
typearray
typeobject
Block
descriptionBuilding block of a card Next id: 35
idBlock
properties
actionChipBlock
$refActionChipBlock
descriptionAction Chip Block
actionLineBlock
$refActionLineBlock
descriptionNavigation Link Block
carouselBlock
$refCarouselBlock
descriptionCarousel Block
descriptionBlock
$refDescriptionBlock
descriptionDescription block
dividerBlock
$refDividerBlock
descriptionDivider Block
imageBlock
$refImageBlock
descriptionImage block
legendBlock
$refLegendBlock
descriptionLegend Block
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
listItemBlock
$refListItemBlock
descriptionList Item Block
profilePictureBlock
$refProfilePictureBlock
descriptionProfile Picture Block
progressBarBlock
$refProgressBarBlock
descriptionProgress Bar Block
progressBarListItemBlock
$refProgressBarListItemBlock
descriptionList item-like block with progress bar
searchBlock
$refSearchBlock
descriptionA block that has a search bar.
signInBlock
$refSignInBlock
descriptionSign In Block
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
twoColumnTableBlock
$refTwoColumnTableBlock
descriptionTwo Column Table Block
typeobject
BoolArray
descriptionA boolean array
idBoolArray
properties
values
descriptionvalues of boolean array
items
typeboolean
typearray
typeobject
BottomButton
descriptionOne of the BottomNav buttons.
idBottomButton
properties
icon
$refImage
descriptionButton icon (default version) to be displayed above the title. Instead, only the image_id can be used
link
$refLink
descriptionLink referencing the screen that should be opened when the item is activated. Not supported on iOS and Android.
menu
$refBottomDrawerMenu
descriptionThe bottom menu.
selectedIcon
$refImage
descriptionButton icon (selected version) to be displayed above the title. Instead, only the image_id can be used
target
$refResourceKey
deprecatedTrue
descriptionThe target screen. DEPRECATED: Bottom Navigation is deprecated.
title
descriptionButton caption.
typestring
typeobject
BottomDrawerMenu
descriptionThe bottom navigation drawer menu.
idBottomDrawerMenu
properties
blocks
descriptionThe 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
$refBottomDrawerMenuBlock
typearray
typeobject
BottomDrawerMenuBlock
descriptionA building block of the bottom navigation menu drawer.
idBottomDrawerMenuBlock
properties
divider
$refBottomDrawerMenuDivider
descriptionA horizontal divider.
menuItem
$refBottomDrawerMenuItem
descriptionA menu item.
typeobject
BottomDrawerMenuDivider
descriptionA horizontal divider for the bottom navigation menu drawer.
idBottomDrawerMenuDivider
properties
typeobject
BottomDrawerMenuItem
descriptionA bottom navigation menu drawer item, pointing to targets across the app.
idBottomDrawerMenuItem
properties
icon
$refImage
descriptionA small icon to be displayed next to the item title. Truly optional.
link
$refLink
descriptionLink referencing the screen that should be opened when the item is activated. Not supported on iOS and Android.
target
$refResourceKey
deprecatedTrue
descriptionThe target of the menu item. DEPRECATED: Bottom Navigation is deprecated.
title
descriptionThe displayed title of the menu item.
typestring
typeobject
BottomNav
descriptionBottom navigation bar with buttons.
idBottomNav
properties
buttons
descriptionList of buttons.
items
$refBottomButton
typearray
typeobject
BrowserAlternative
descriptionDisplays a screen by opening an URL in the default browser. Next Id: 7
idBrowserAlternative
properties
auth
descriptionIf true, the user should be signed in first using AccountChooser.
typeboolean
browserType
descriptionWhat 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).
typestring
setContinueUrlParam
descriptionWhether the "continue" URL param should be set, if available, when linking to this page. Used only for Platform.WEB.
typeboolean
target
descriptionWhere to display the linked URL. Used only for Platform.WEB. See Target enum.
formatint32
typeinteger
themedUrl
$refThemedUrl
descriptionThe set of theme-dependent URLs to open. One of url or themed_url required.
url
descriptionThe URL to open. One of url or themed_url required.
typestring
typeobject
BrowserCapabilities
descriptionThe 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
idBrowserCapabilities
properties
typeSelection
descriptionWhether the client supports selecting the browser API type that is used.
typeboolean
typeobject
ByteArray
descriptionA byte array
idByteArray
properties
values
descriptionvalues of byte array int8 scale
items
formatint32
typeinteger
typearray
typeobject
Card
descriptionCards that can be stacked on a screen.
idCard
properties
anchor
descriptionAn identifier for scrolling into the view.
typestring
collectionCard
$refCollectionCard
descriptionCollection Card
loading
$refLoadingCard
descriptionCard with a loading spinner on it.
oneGoogle
$refOneGoogleCard
descriptionCard representing an entry in the OneGoogle Account Menu.
promptCarousel
$refPromptCarouselCard
descriptionPrompt Carousel
searchResultCard
$refSearchResultCard
descriptionCard presenting a result on Google Search.
securityHubPromptCarousel
$refSecurityHubPromptCarouselCard
descriptionSecurityHub Prompt Carousel (for Angel)
segmentHeaderCard
$refSegmentHeaderCard
descriptionSegment header card
summary
$refSummaryCard
descriptionSummary Card
typeobject
CardCapabilities
descriptionThe 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.
idCardCapabilities
properties
adviceFramework
descriptionSupport for the Advice Framework.
typeboolean
borderlessCards
descriptionSupport for borderless summary cards.
typeboolean
carouselViewAll
descriptionSupports for "view all" button in carousels
typeboolean
genericStyledTexts
descriptionSupport for generic styled texts.
typeboolean
headerActionItems
descriptionWhether the client supports action menu on WelcomeHeader.
typeboolean
helpItem
descriptionSupport for help item in CardsAlternative.
typeboolean
iconOnlyChip
deprecatedTrue
descriptionSupport for chips that have only icons (no text)
typeboolean
legendBlock
descriptionSupport for LegendBlock
typeboolean
linkNavigation
descriptionSupport for link navigation.
typeboolean
listItemSecondaryIcon
descriptionSupport for secondary icon in ListItemBlock
typeboolean
navigateToAnchor
descriptionSupport for navigation to anchors
typeboolean
progressBarSummaryCardBlock
deprecatedTrue
descriptionSupport for progress bar block in summary cards.
typeboolean
promptResource
descriptionWhether the client supports prompt as a separate resource outside of the prompt carousel.
typeboolean
screenIntroLink
descriptionSupport for link in ScreenIntro.
typeboolean
segmentHeaderCard
descriptionSupport for segment header cards
typeboolean
signInSummaryCardBlock
descriptionSupport for sign in block in summary cards.
typeboolean
summaryCardPaddingDividerReplacement
descriptionSupport for additional padding replacing dividers in summary cards.
typeboolean
summaryCardProgressBar
descriptionWhether the client supports progress bar in the summary card
typeboolean
untintedUrlChipIcons
descriptionSupport for untinted URL chip icons.
typeboolean
typeobject
CardDeck
descriptionA set of cards.
idCardDeck
properties
cardKeys
descriptionList of cards. The order is equal to the order they should appear in the UI.
items
$refResourceKey
typearray
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the card deck.
typeobject
CardsAlternative
descriptionA screen with tabs and cards. Used for Home, Personal info, etc. Next Id: 22
idCardsAlternative
properties
appBar
$refAppBar
descriptionRenders 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
$refResourceKey
descriptionId of the bottom buttons bar.
bottomNavSelection
$refResourceKey
descriptionIdentifies 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
$refResourceKey
descriptionId of the deck of cards displayed on the page.
footerKey
$refResourceKey
descriptionFooter displayed on this page.
hatsSurvey
$refHaTSSurvey
descriptionHaTS survey to be shown.
helpItemTarget
$refResourceKey
deprecatedTrue
descriptionId of the target of the help center item in the header. DEPRECATED: use support link instead.
leftNavKey
$refResourceKey
descriptionId of the left navigation.
leftNavSelection
$refResourceKey
descriptionIdentifies which left menu item should appear selected. If omitted or if there is no button with this key, nothing is selected.
onboardingFlowKey
$refResourceKey
deprecatedTrue
descriptionId of an OnboardingFlow resource.
screenIntro
$refScreenIntro
descriptionScreen intro displayed just before the cards.
simpleHeaderKey
$refResourceKey
descriptionId of the header bar where action items and a title are displayed. Currently only used on Android and iOS.
supportLink
$refLink
descriptionId of the link of the help center item in the header, successor of help_item_target.
supportPanelKey
$refResourceKey
descriptionSupport panel displayed on the page.
topNavKey
$refResourceKey
descriptionId of the top tabs bar.
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the summary page.
welcomeHeaderKey
$refResourceKey
descriptionId of the header bar where user name and avatar are displayed.
welcomeScreenIntroKey
$refResourceKey
descriptionPersonalized welcome screen intro displayed on the home page instead of the usual screen intro.
typeobject
CarouselBlock
descriptionA horizontal list (carousel) block.
idCarouselBlock
properties
accessibilityLabel
descriptionAccessibility label for the legend item, used by screen readers.
typestring
itemWidth
descriptionThe width of the carousel item, only applies to vertical carousels. If not provided, client defaults to 128dp.
formatint32
typeinteger
items
descriptionList of carousel items.
items
$refCarouselItem
typearray
itemsType
descriptionThe carousel items type. See CarouselItemsType for possible values.
formatint32
typeinteger
textHorizontalAlignment
descriptionHorizontal alignment of text. See HorizontalAlignment enum.
formatint32
typeinteger
viewAllLink
$refLink
descriptionIf present, a "view all" button will be shown at the end of the carousel. When tapped it will open this link.
viewAllTarget
$refResourceKey
deprecatedTrue
descriptionIf 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
descriptionText, which is shown beneath the "view all" button. If empty the button is shown without text.
typestring
typeobject
CarouselItem
descriptionItem of a carousel, can be an elevated or flat card.
idCarouselItem
properties
descriptionColor
$refColor
descriptionColor of the description text.
descriptions
descriptionList of carousel descriptions.
items
typestring
typearray
elevate
descriptionWhether or not to elevate the carousel card.
typeboolean
image
$refImage
descriptionImage displayed on the top or left of the carousel item.
label
descriptionLabel of the carousel item.
typestring
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
specialDescription
$refSpecialDescription
descriptionSpecial description.
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
textEntries
deprecatedTrue
descriptionText entries of the carousel item. Use label, titles, etc. instead.
items
$refStyledTextEntry
typearray
titles
descriptionList of carousel titles.
items
typestring
typearray
typeobject
CharArray
descriptionA char array
idCharArray
properties
values
descriptionvalues of char array char
items
formatint32
typeinteger
typearray
typeobject
ClientCapabilities
descriptionDescribes 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
idClientCapabilities
properties
androidIntentCapabilities
$refAndroidIntentCapabilities
descriptionThe supported intent capabilites of the client
bottomNavigation
descriptionWhether the client supports bottom navigation or not.
typeboolean
browserAuthentication
descriptionWhether the client supports signing users in before opening a browser alternative.
typeboolean
browserCapabilities
$refBrowserCapabilities
descriptionThe capabilities related to opening a URL in a browser.
cardCapabilities
$refCardCapabilities
descriptionThe capabilities of the cards framework
expressiveDesign
descriptionWhether the client implements the expressive design language.
typeboolean
footer
descriptionWhether the client supports footer or not.
typeboolean
hats
descriptionWhether the client supports HaTS. See go/hats for details.
typeboolean
leftNavigation
descriptionWhether the left navigation is supported or not.
typeboolean
nativeCapabilities
$refNativeCapabilities
descriptionThe capabilities of the native actions.
seamlessDarkMode
descriptionWhether the client supports theme-agnostic resources.
typeboolean
simpleHeader
descriptionWhether the client supports simple header or not.
typeboolean
supportLinkDelegation
descriptionWhether the client supports support_link and DelegateLinkType.DELEGATE_SUPPORT.
typeboolean
supportedAlternativeTypes
descriptionLists all supported alternative types. Only supported since gmscore_module_version=3 v2 and below supports MenuAlternative, MessageAlternative, NativeAlternative, BrowserAlternative.
items
$refSupportedAlternativeType
typearray
supportedIcons
descriptionLists all supported icons.
items
$refSupportedIcon
typearray
supportedItemTypes
descriptionLists all supported item types. Only supported since gmscore_module_version=3 v2 and below supports SimpleItem and PromoItem.
items
$refSupportedItemType
typearray
supportedNativeActions
descriptionLists all supported native actions.
items
$refSupportedNativeAction
typearray
supportedOfflineScreens
descriptionLists all supported offline screens.
items
$refSupportedOfflineScreen
typearray
topTabIcons
descriptionWhether the client supports top tab icons or not.
typeboolean
usesStandardChevron
descriptionWhether the client uses the default chevrons or a custom version with less padding
typeboolean
webviewCapabilities
$refWebviewCapabilities
descriptionThe capabilities of the webview client.
typeobject
ClientVersions
descriptionThe 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
idClientVersions
properties
androidLibraryVersion
descriptionThe version of the Android AccountSettings library that is used outside of GMSCore, to present ASMS content within other apps. e.g. "1.0"
typestring
androidOsVersion
descriptionThe Android OS version, e.g. "5.1.1".
typestring
androidSdkVersion
descriptionThe Android SDK version. e.g. "22"
typestring
androidSystemWebviewVersion
descriptionThe version of the Android system webview component e.g. "37.0.0.0"
typestring
gmscoreModuleApkVersionName
descriptionThe 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
typestring
gmscoreModuleVersion
descriptionThe 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
typestring
gmscoreVersion
descriptionThe GMSCore version code. e.g. "9033000"
typestring
gmscoreWebviewModuleVersion
descriptionThe 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
typestring
iosAppBundleId
descriptionThe bundle ID (CFBundleIdentifier) of the hosting iOS app. e.g. "com.google.ios.youtube"
typestring
iosAppVersion
descriptionThe version (CFBundleVersion) of the hosting iOS app. e.g. "10.30.11661"
typestring
iosLibrary
descriptionThe type of the iOS AccountSettings library, e.g. "main" or "policies"
typestring
iosLibraryVersion
descriptionThe version of the iOS AccountSettings library. e.g. "1.0"
typestring
iosVersion
descriptionThe iOS version. e.g. "9.2.1"
typestring
typeobject
CollapsableBlock
descriptionBlock that can be collapsed, containing a set of other blocks.
idCollapsableBlock
properties
collapsedActionLabel
descriptionThe label of the action block in its collapsed form.
typestring
content
descriptionThe content of the block in its extended form.
items
$refOneBoxBlock
typearray
expandedContentDescription
descriptionDescription below the title of the expanded section.
typestring
expandedContentTitle
descriptionTitle on top of the expanded section.
typestring
initiallyExpanded
descriptionIndicator whether the block should initially be collapsed or extended.
typeboolean
typeobject
CollectionCard
descriptionA collection card - screen/3R3xDXaRngvfQMS.
idCollectionCard
properties
description
descriptionDescription of the card.
typestring
hyperlink
$refLink
descriptionLink of the hyperlink_text.
hyperlinkText
descriptionHyperlink text/label of the card displayed after the description.
typestring
stacks
descriptionStacks of the card.
items
$refStack
typearray
title
descriptionTitle of the card.
typestring
typeobject
Color
descriptionRepresents 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(''); }; // ...
idColor
properties
alpha
descriptionThe 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).
formatfloat
typenumber
blue
descriptionThe amount of blue in the color as a value in the interval [0, 1].
formatfloat
typenumber
green
descriptionThe amount of green in the color as a value in the interval [0, 1].
formatfloat
typenumber
red
descriptionThe amount of red in the color as a value in the interval [0, 1].
formatfloat
typenumber
typeobject
DashboardNavigationMetadata
descriptionAdditional information about navigations from Google Dashboard.
idDashboardNavigationMetadata
properties
globalCta
descriptionType 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
typestring
typeobject
DashboardServiceCardOutboundNavigationMetadata
descriptionAdditional information about outbound navigations from service cards on Google Dashboard.
idDashboardServiceCardOutboundNavigationMetadata
properties
navigationType
descriptionType 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)
typestring
pageSection
descriptionThe 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
typestring
serviceId
descriptionID of the service e.g. MAPS, PHOTOS, DRIVE, YOUTUBE etc..
enum
  • UNKNOWN
  • ADSENSE
  • ADWORDS
  • ALERTS
  • ANALYTICS
  • ANDROID
  • ANDROIDMARKET
  • BLOGGER
  • BOOKS
  • CHROMIUMSYNC
  • CALENDAR
  • CLOUDPRINT
  • CONTACTS
  • CUSTOMSEARCH
  • DRIVE
  • FEEDBURNER
  • FIT
  • GMAIL
  • GMBLOCATIONS
  • GOOGLEVOICE
  • GROUPS
  • JOTSPOT
  • KEEP
  • MADISON
  • MANUFACTURERCENTER
  • MAPS
  • MERCHANTCENTER
  • MOBILESYNC
  • NEWS
  • PAYMENTS
  • PICASA
  • PLUS
  • TASKS
  • WEBMASTERTOOLS
  • YOUTUBE
  • ACCOUNT
  • ANDROIDMUSIC
  • AUDIOHISTORY
  • DEVICE_INFORMATION
  • FUSIONTABLES
  • GLASS
  • HIST
  • LATITUDE
  • SHOPPERASSIST
  • YOUTUBE_SEARCH_HISTORY
  • YOUTUBE_WATCH_HISTORY
  • YOUTUBE_HISTORY
enumDeprecated
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • True
enumDescriptions
  • The default value used when a new enum value is not yet known to the parser of the protocol buffer.
  • Adsense
  • Google Ads
  • Alerts
  • Analytics
  • Android
  • Play Store.
  • Blogger
  • Google books
  • Chrome sync
  • Calendar
  • Cloudprint
  • Contacts
  • Programmable Search Engine.
  • Google drive
  • Feedburner
  • Fit
  • Gmail
  • Google My Business Locations
  • Google Voice
  • Google Groups
  • Sites.
  • Keep
  • Brand accounts.
  • Manufacturer Center
  • Google maps
  • Merchant Center
  • Google Sync
  • Google news
  • Previously known as Checkout and Wallet.
  • Photos.
  • Currents aka G+ aka Oz aka GoogleMe aka EmeraldSea.
  • Tasks
  • Google Search Console
  • YouTube
  • DEPRECATED: This service will no longer be shown with the Dashboard revamp (go/dashboard-revamp-dd).
  • Play Music. DEPRECATED: Service no longer exists.
  • Voice and Audio Activity. DEPRECATED: This is no longer a top-level UDC setting and is no longer shown on Dashboard.
  • DEPRECATED: This UDC setting no longer exists.
  • DEPRECATED: Service no longer exists.
  • DEPRECATED: Service no longer exists on Dashboard.
  • Web History. DEPRECATED: This UDC setting will no longer be shown with the Dashboard revamp (go/dashboard-revamp-dd).
  • Location History. DEPRECATED: This UDC setting will no longer be shown with the Dashboard revamp (go/dashboard-revamp-dd).
  • Package Tracking. DEPRECATED: This UDC setting will no longer be shown with the Dashboard revamp (go/dashboard-revamp-dd).
  • DEPRECATED: Merged into YOUTUBE_HISTORY.
  • DEPRECATED: Merged into YOUTUBE_HISTORY.
  • DEPRECATED: This UDC setting will no longer be shown with the Dashboard revamp (go/dashboard-revamp-dd).
typestring
typeobject
DescriptionBlock
descriptionA description block, can contain a title with a link, a description and an image (position to the right of the block). Next id: 11
idDescriptionBlock
properties
descriptionText
descriptiondescription block description text.
typestring
image
$refImage
descriptionimage displayed to the right of the text.
largeImage
$refImage
descriptionthe large version of image to be displayed on larger screens.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the link click event. Eventually should completely replace the `target` field.
linkAccessibilityLabel
deprecatedTrue
descriptionAccessibility label for the link, used by screen readers instead of link_text. DEPRECATED: Use link.aria_label instead.
typestring
linkIcon
$refImage
descriptionIcon to append after the description block link.
linkTarget
$refResourceKey
deprecatedTrue
descriptionId of link destination resource. DEPRECATED: Use link instead.
linkText
descriptiondescription block link text.
typestring
stackItemImage
$refImage
descriptionWhen 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
descriptiondescription block title.
typestring
typeobject
DividerBlock
descriptionA block that acts as a divider between different kinds of blocks.
idDividerBlock
properties
typeobject
DoubleArray
descriptionA double array
idDoubleArray
properties
values
descriptionvalues of double array
items
formatdouble
typenumber
typearray
typeobject
ExpansionUnit
descriptionscreen/9fYD3c8gNSJH6Aj & screen/AfX5FY6knEvFoEj
idExpansionUnit
properties
backgroundColor
$refThemedColor
descriptionColor to tint the background and serve as container for Icon and Label
foregroundColor
$refThemedColor
descriptionColor to tint label and icon
icon
$refImage
descriptionIcon of the expansion button
label
descriptionLabel of the expansion button
typestring
typeobject
Extra
descriptionAn Android intent extra LINT.IfChange
idExtra
properties
booleanArrayValue
$refBoolArray
descriptionA boolean array extra value.
booleanValue
descriptionA boolean extra value.
typeboolean
byteArrayValue
$refByteArray
descriptionA byte array extra value.
byteValue
descriptionA byte extra value. int8 scale
formatint32
typeinteger
charArrayValue
$refCharArray
descriptionA char array extra value.
charValue
descriptionA char extra value. char
formatint32
typeinteger
doubleArrayValue
$refDoubleArray
descriptionA double array extra value.
doubleValue
descriptionA double extra value.
formatdouble
typenumber
floatArrayValue
$refFloatArray
descriptionA float array extra value.
floatValue
descriptionA float extra value.
formatfloat
typenumber
intArrayValue
$refIntArray
descriptionAn int array extra value.
intValue
descriptionAn int extra value.
formatint32
typeinteger
longArrayValue
$refLongArray
descriptionA long array extra value.
longValue
descriptionA long extra value.
formatint64
typestring
shortArrayValue
$refShortArray
descriptionA short array extra value.
shortValue
descriptionA short extra value. int16 scale
formatint32
typeinteger
stringArrayValue
$refStringArray
descriptionA string array extra value.
stringValue
descriptionA string extra value.
typestring
typeobject
FauxbakeAlternative
descriptionA screen with a profile picture and buttons to allow changing or removing it. Next Id: 11
idFauxbakeAlternative
properties
addPictureButton
$refFauxbakeButton
descriptionThe button that allows users to add a profile picture.
avatarInformation
$refFauxbakePictureInfo
descriptionThe accessibility information for the picture if the user has a profile picture set.
changePictureButton
$refFauxbakeButton
descriptionThe button that allows users to change their profile picture.
croppingOverlay
$refFauxbakeCroppingOverlay
descriptionFauxbake cropping and rotate screen.
description
descriptionThe description text that should be displayed below the title.
typestring
footer
$refFauxbakeFooter
descriptionThe footer that should be displayed at the bottom of the screen.
monogramInformation
$refFauxbakePictureInfo
descriptionThe accessibility information for the picture if the user has no profile picture set and a monogram is visible instead.
removePictureButton
$refFauxbakeButton
descriptionThe button that allows users to remove their profile picture.
title
descriptionThe title text that should be displayed at the top of the screen.
typestring
welcomeHeaderKey
$refResourceKey
descriptionAn 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.
typeobject
FauxbakeButton
descriptionA 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
idFauxbakeButton
properties
accessibilityLabel
descriptionAn accessibility label for the button. If not present, the button title should be used.
typestring
icon
$refImage
descriptionThe icon of the button
title
descriptionThe title of the button.
typestring
typeobject
FauxbakeCroppingExtraInformationAlert
descriptionAlert showing extra information. Next Id: 4
idFauxbakeCroppingExtraInformationAlert
properties
closeButtonTitle
descriptionTitle for the button that closes the information alert.
typestring
informationText
descriptionText for the extra information alert.
typestring
triggerButton
$refFauxbakeButton
descriptionButton for triggering the extra information alert.
typeobject
FauxbakeCroppingOverlay
descriptionOverlay screen for cropping and rotating the user profile picture. Next Id: 5
idFauxbakeCroppingOverlay
properties
navigationBar
$refFauxbakeCroppingOverlayNavigationBar
descriptionNavigation bar containing the back and extra information alert buttons.
rotateButton
$refFauxbakeButton
descriptionButton to rotate the image, placed on the footer.
saveButton
$refFauxbakeButton
descriptionButton that concludes the action of cropping & rotating the image.
typeobject
FauxbakeCroppingOverlayNavigationBar
descriptionNavigation bar for the cropping overlay containing the back button and extra information alert trigger with its data. Next Id: 4
idFauxbakeCroppingOverlayNavigationBar
properties
backButton
$refFauxbakeButton
descriptionNavigation bar back button.
extraInformationAlert
$refFauxbakeCroppingExtraInformationAlert
descriptionAlert showing extra information.
title
descriptionThe title shown in the navigation bar.
typestring
typeobject
FauxbakeFooter
descriptionThe footer text that should be displayed at the bottom of the screen. Next Id: 6
idFauxbakeFooter
properties
icon
$refImage
descriptionThe icon that is displayed next to the footer text.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
linkTarget
$refResourceKey
deprecatedTrue
descriptionThe target of the link at the end of the footer. DEPRECATED: Use link instead.
linkText
descriptionThe text of the link at the end of the footer.
typestring
text
descriptionThe text that should be in the footer.
typestring
typeobject
FauxbakePictureInfo
descriptionAdditional information for the big profile picture on the Fauxbake screen. Next Id: 3
idFauxbakePictureInfo
properties
accessibilityHint
descriptionThe 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).
typestring
accessibilityLabel
descriptionThe text that is going to be read when a screen reader focuses on the profile picture.
typestring
typeobject
FeedbackParams
descriptionConfiguration items used when launching the Feedback Client. Next Id: 3
idFeedbackParams
properties
captureScreenshot
descriptionIf true, include a screenshot in the feedback report.
typeboolean
category
descriptionThe Feedback entry point within My Google, used to sort into buckets.
typestring
typeobject
FloatArray
descriptionA float array
idFloatArray
properties
values
descriptionvalues of float array
items
formatfloat
typenumber
typearray
typeobject
Footer
descriptionFooter consists of link items.
idFooter
properties
items
descriptionList of items.
items
$refFooterItem
typearray
typeobject
FooterItem
descriptionOne of the Footer link text items. Next id: 5
idFooterItem
properties
label
descriptionThe a11y text label for this link.
typestring
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
target
$refResourceKey
deprecatedTrue
descriptionThe target screen. DEPRECATED: Use link instead.
text
descriptionThe text content of this link.
typestring
typeobject
GetClientConfigRequest
descriptionRequest message for GetClientConfig.
idGetClientConfigRequest
properties
context
$refRequestContext
descriptionInformation sent with every request.
typeobject
GetClientConfigResponse
descriptionResponse 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
idGetClientConfigResponse
properties
attSignalConfigs
descriptionConfiguration for appending ATT (Apple Tracking Transparency) consent state to URLs in Octarine webviews, for every app/URL combination.
items
$refATTSignalConfig
typearray
canUsePeopleApiForProfilePictureUploading
descriptionWhether it's safe to use People API for profile picture uploading. Used only by iOS client.
typeboolean
clearcutDenylistedScreenIds
descriptionList of screen IDs that should have clearcut logging disabled.
items
formatint32
typeinteger
typearray
heartbeatTimesS
descriptionThe 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
formatint32
typeinteger
typearray
prefetchingEnabled
descriptionWhether the client app should issue PrefetchRelatedScreens requests.
typeboolean
screenMaxLifetime
descriptionAfter 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.
formatgoogle-duration
typestring
stableScreenStaleTime
descriptionAfter 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.
formatgoogle-duration
typestring
unstableScreenStaleTime
descriptionAfter 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.
formatgoogle-duration
typestring
useSystemDefaultBrowserToOpenUrls
descriptionIndicates whether the client should use the default system browser to open links in Octarine.
typeboolean
webviewBlacklistedUrlPatterns
descriptionSee webview_whitelisted_url_patterns.
items
typestring
typearray
webviewBrowserAuthBlacklistedUrlPatterns
descriptionSee webview_browser_auth_whitelisted_url_patterns.
items
typestring
typearray
webviewBrowserAuthWhitelistedUrlPatterns
descriptionList 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
typestring
typearray
webviewDefaultJsBridgeBlacklistedUrlPatterns
descriptionSee webview_default_js_bridge_whitelisted_url_patterns.
items
typestring
typearray
webviewDefaultJsBridgeWhitelistedUrlPatterns
descriptionList 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
typestring
typearray
webviewUdcJsBridgeBlacklistedUrlPatterns
descriptionSee webview_udc_js_bridge_whitelisted_url_patterns.
items
typestring
typearray
webviewUdcJsBridgeWhitelistedUrlPatterns
descriptionList 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
typestring
typearray
webviewWhitelistedUrlPatterns
descriptionList 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
typestring
typearray
typeobject
GetResourceRequest
descriptionRequest message for GetResource.
idGetResourceRequest
properties
context
$refRequestContext
descriptionInformation sent with every request.
resourceKey
$refResourceKey
descriptionIdentifies the Resource being requested.
resourcesToOmit
descriptionSpecify the resources to omit from the response. The server is allowed to ignore this option.
items
$refResourceToOmit
typearray
typeobject
GetResourceResponse
descriptionResponse message for GetResource.
idGetResourceResponse
properties
additionalResources
descriptionAdditional resources that the client should cache.
items
$refResource
typearray
resource
$refResource
descriptionThe returned resource.
typeobject
GetScreenRequest
descriptionRequest message for GetScreen.
idGetScreenRequest
properties
context
$refRequestContext
descriptionInformation sent with every request.
screenId
descriptionIdentifies the screen being requested. See ScreenId enum for possible values.
formatint32
typeinteger
screensToOmit
descriptionSpecify the screens to omit from the response. The server is allowed to ignore this option.
items
$refScreenToOmit
typearray
typeobject
GetScreenResponse
descriptionResponse message for GetScreen.
idGetScreenResponse
properties
additionalScreens
descriptionAdditional screens that the client should cache.
items
$refScreen
typearray
screen
$refScreen
descriptionThe returned screen.
typeobject
GetSignedOutResourceRequest
descriptionRequest message for GetSignedOutResource.
idGetSignedOutResourceRequest
properties
context
$refRequestContext
descriptionInformation sent with every request.
resourceKey
$refResourceKey
descriptionIdentifies the Resource being requested.
resourcesToOmit
descriptionSpecify the resources to omit from the response. The server is allowed to ignore this option.
items
$refResourceToOmit
typearray
typeobject
GetSignedOutResourceResponse
descriptionResponse message for GetSignedOutResource.
idGetSignedOutResourceResponse
properties
additionalResources
descriptionAdditional resources that the client should cache.
items
$refResource
typearray
resource
$refResource
descriptionThe returned resource.
typeobject
GoogleAccountVisualElementConfig
descriptionConfig for Google Account visual elements. It should contain all information required for VE logging such as id and metadata.
idGoogleAccountVisualElementConfig
properties
metadata
$refGoogleAccountVisualElementMetadata
descriptionAdditional metadata for Google Account visual elements
veid
descriptionVisual Element Id from logs/gws/config/identity_metrics/google_account_configuration
formatint32
typeinteger
typeobject
GoogleAccountVisualElementMetadata
descriptionContainer 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.
idGoogleAccountVisualElementMetadata
properties
accountSettingsArea
enum
  • ACCOUNT_SETTINGS_AREA_UNSPECIFIED
  • ABOUT_GOOGLE
  • ABOUT_ME
  • ABOUT_THIS_AD
  • ACCESSIBILITY
  • ACCOUNT_ANNIVERSARY
  • ACCOUNT_DELETED
  • ACCOUNT_ENHANCED_SAFE_BROWSING
  • ACCOUNT_LINKING
  • ACCOUNT_MENU
  • ACTIVITY_CONTROLS
  • ACTIVITY_CONTROLS_DEVICE_INFORMATION
  • ACTIVITY_CONTROLS_LOCATION_HISTORY
  • ACTIVITY_CONTROLS_VOICE_AND_AUDIO_ACTIVITY
  • ACTIVITY_CONTROLS_WEB_AND_APP_ACTIVITY
  • ACTIVITY_CONTROLS_YOUTUBE_HISTORY
  • ACTIVITY_CONTROLS_YOUTUBE_SEARCH_HISTORY
  • ACTIVITY_CONTROLS_YOUTUBE_WATCH_HISTORY
  • ADDRESS
  • ADDRESSBOOK
  • ADDRESSBOOK_SCREEN
  • ADDRESS_ADD
  • ADDRESS_EDIT
  • ADD_ACCOUNT_TO_DEVICE
  • ADS_SETTINGS
  • ADS_SETTINGS_CARD_NOT_ELIGIBLE_LEARN_MORE
  • AGE_DISABLED
  • AGE_VERIFICATION_OPTIONS
  • ALBUM_ARCHIVE
  • ALERT
  • ALTERNATE_EMAIL
  • APP_PASSWORDS
  • AUTOCOMPLETE_SUGGESTIONS
  • BIRTHDAY
  • BIRTHDAY_AGE_STATUS
  • BIRTHDAY_EDIT
  • BLOCKED_USERS
  • BRAND_ACCOUNTS
  • BRAND_ACCOUNT_DELETED
  • BUSINESS_PERSONALIZATION
  • CLP_RECOMMENDED
  • CLP_RECOMMENDED_AUTOFILL
  • CLP_RECOMMENDED_BACKUP
  • CLP_RECOMMENDED_FINDMYDEVICE
  • CLP_RECOMMENDED_NEARBY
  • CLP_RECOMMENDED_PAY
  • CLP_SCREEN
  • COMBINED_RECOVERY_OPTIONS_PAGE
  • COMMUNICATION_PREFERENCES
  • COMMUNICATION_PREFERENCES_LANDING
  • CONNECTED_APPS
  • CONSENT_PRIMITIVE_DEMO_CONFIG
  • CONSTELLATION_CONSENT
  • CONTACTS
  • CONTACT_EMAIL
  • CREDENTIAL_DETAIL
  • CREDENTIAL_LIST
  • DARK_WEB_REPORT_SCAN
  • DARK_WEB_REPORT_SCAN_RECOMMENDED
  • DARK_WEB_REPORT_SCREEN
  • DARK_WEB_REPORT_SETUP_SCREEN
  • DASHBOARD_OUTBOUND_SCREEN
  • DATA_AND_PERSONALIZATION
  • DATA_AND_PRIVACY_DATA_IMPROVES_EXPERIENCE
  • DATA_AND_PRIVACY_DATA_VISIBILITY
  • DELETE_ACCOUNT
  • DELETE_GMAIL
  • DELETE_GOOGLE_ONE
  • DELETE_SERVICES
  • DELETE_SERVICES_OR_ACCOUNT
  • DELETE_YOUTUBE
  • DEPRECATED_PROFILE_DETAILS
  • DEVICE_ACTIVITY_INTRO
  • DEVICE_APPS
  • DEVICE_CONTACTS
  • DEVICE_SETTINGS_ABOUT_PHONE
  • DEVICE_SETTINGS_EMERGENCY_INFO
  • DEVICE_SETTINGS_PAYMENTS
  • DIGITAL_ID_MANAGEMENT_SCREEN
  • DOCUMENT_MANAGEMENT_SCREEN
  • EMAIL
  • FAMILY_CHILD_RESTORE_PAGE_SCREEN
  • FAMILY_CREATE_CONFIRMATION_OR_DETAILS
  • FAMILY_CREATE_CONFIRMATION_OR_DETAILS_DEPRECATED
  • FAMILY_CREATE_FAMILY_CONFIRMATION_SCREEN
  • FAMILY_CREATE_FAMILY_PAGE_SCREEN
  • FAMILY_CREATION
  • FAMILY_DELETE_FAMILY_PAGE_SCREEN
  • FAMILY_DETAILS
  • FAMILY_ENTERTAINMENT
  • FAMILY_HOME_STRUCTURE_SCREEN
  • FAMILY_INVITATION_COMPLETE_PAGE
  • FAMILY_INVITE_MEMBERS
  • FAMILY_INVITE_MEMBERS_PAGE
  • FAMILY_INVITE_SECOND_PARENT
  • FAMILY_LEAVE_FAMILY
  • FAMILY_LINK
  • FAMILY_LIST_PENDING_INVITATIONS_PAGE
  • FAMILY_MANAGEMENT
  • FAMILY_MEMBERS
  • FAMILY_MEMBERS_SUPERVISION_SCREEN
  • FAMILY_MEMBER_OR_INVITATION_DETAILS_PAGE_SCREEN
  • FAMILY_PARENTAL_CONTROLS
  • FAMILY_PARENTAL_CONTROLS_MANAGE_KID_SEARCH_SETTINGS
  • FAMILY_PAYMENT_METHOD
  • FAMILY_PRODUCT_FAMILY_CALENDAR
  • FAMILY_PRODUCT_FAMILY_LINK
  • FAMILY_PRODUCT_GOOGLE_ONE
  • FAMILY_PRODUCT_PHOTOS
  • FAMILY_PRODUCT_PLAY_LIBRARY
  • FAMILY_PRODUCT_YOUTUBE_MUSIC
  • FAMILY_PRODUCT_YOUTUBE_RED
  • FAMILY_PRODUCT_YOUTUBE_UNPLUGGED
  • FAMILY_REMOVE_MEMBER_PAGE
  • FAMILY_SELECT_SECOND_PARENT_CANDIDATELIST_SCREEN
  • FAMILY_SELECT_SECOND_PARENT_PAGE
  • FAMILY_SELECT_TANDEM_PARTNER_PAGE
  • FAMILY_SERVICES
  • FAMILY_SERVICES_CARD
  • FAMILY_TANDEM_PARTNER_SELECTED_PAGE
  • FAMILY_TANDEM_STATUS_PAGE
  • FAMILY_UPGRADE_FOP_PAGE_SCREEN
  • FAMILY_UPGRADE_TOS_PAGE_SCREEN
  • FAQ_CARD_ACCOUNT_DATA_ARTICLE
  • FAQ_CARD_MANAGE_GOOGLE_SETTINGS_ARTICLE
  • FAQ_CARD_RECOVERY_INFORMATION_ARTICLE
  • FAQ_CARD_SUBSCRIPTION_MANAGEMENT_ARTICLE
  • FAQ_CARD_SUSPICIOUS_ACTIVITY_ARTICLE
  • FAUXBAKE
  • FEEDBACK
  • FIND_YOUR_PHONE
  • FITBIT_PRIVACY_CENTER_CONNECTED_APPS
  • FITBIT_PRIVACY_CENTER_DELETION_CATEGORIES
  • FITBIT_PRIVACY_CENTER_DELETION_CONFIRMATION
  • FITBIT_PRIVACY_CENTER_DELETION_OPTIONS
  • FITBIT_PRIVACY_CENTER_FEATURE
  • FITBIT_PRIVACY_CENTER_FEATURES
  • FITBIT_PRIVACY_CENTER_PAIRED_DEVICES
  • FITBIT_PRIVACY_CENTER_RND_FEATURES
  • FITBIT_PRIVACY_CENTER_SETTINGS
  • FIT_PRIVACY_CENTER_ASSISTANT
  • FIT_PRIVACY_CENTER_CATEGORY_DELETION
  • FIT_PRIVACY_CENTER_DATA_TYPE_DELETION
  • FIT_PRIVACY_CENTER_DEVICES
  • FIT_PRIVACY_CENTER_MANAGE_CATEGORY_SCREEN
  • FIT_PRIVACY_CENTER_MANAGE_DATA
  • FIT_PRIVACY_CENTER_MOBILE_VITALS_SCREEN
  • FIT_PRIVACY_CENTER_PERSONALIZED_SUGGESTIONS
  • FIT_PRIVACY_CENTER_SETTINGS
  • GELLER_SUPERVISION_SCREEN
  • GENDER
  • GENERAL_LIGHT
  • GEO_HOME_ADDRESS
  • GEO_HOME_WORK_ADDRESS
  • GEO_WORK_ADDRESS
  • GESTURE_BASED_REAUTH
  • GMSCORE_SETTINGS_CLEAR_APP_STATE_SCREEN
  • GMSCORE_SETTINGS_HELP_SCREEN
  • GMSCORE_SETTINGS_ITEM_SCREEN
  • GMSCORE_SETTINGS_OPEN_SOURCE_LICENSES_SCREEN
  • GMSCORE_SETTINGS_SUBCATEGORY_SCREEN
  • GMSCORE_SETTINGS_SYSTEM_COMPONENT_UPDATE_SETTINGS_SCREEN
  • GMSCORE_SETTINGS_USAGE_REPORTING_SCREEN
  • GOOGLE_ACCOUNT_COMMUNITY_SCREEN
  • GOOGLE_ACCOUNT_HELP_CENTER
  • GOOGLE_ACCOUNT_MARKETING_PAGE
  • GOOGLE_ACCOUNT_PIN
  • GOOGLE_BUSINESS_PROFILES
  • GOOGLE_BUSINESS_PROFILES_SINGLE_LISTING
  • GOOGLE_DASHBOARD
  • GOOGLE_DASHBOARD_ANDROID
  • GOOGLE_GUIDE
  • GOOGLE_MY_BUSINESS_PORTAL
  • GOOGLE_MY_BUSINESS_SIGN_UP
  • GOOGLE_ONE_ALL_AVAILABLE_SUPPORT_OPTIONS_SCREEN
  • GOOGLE_ONE_CHAT_SUPPORT
  • GOOGLE_ONE_EMAIL_SUPPORT
  • GOOGLE_ONE_HOME
  • GOOGLE_ONE_PHONE_SUPPORT
  • GOOGLE_ONE_STORAGE
  • GOOGLE_ONE_STORAGE_MANAGEMENT
  • GOOGLE_ONE_SUPPORT
  • GOOGLE_PAY_ADD_PAYMENT_METHOD
  • GOOGLE_PAY_EXPERIENCE_SCREEN
  • GOOGLE_PAY_MANAGE_PAYMENT_METHODS
  • GOOGLE_PAY_PAYMENT_METHOD_DETAILS
  • GOOGLE_PLUS_SETTINGS
  • GOOGLE_PRODUCT_FORUM
  • GRADUATION
  • HELP
  • HELP_CENTER
  • HELP_CENTER_ARTICLE_SCREEN
  • HELP_CENTER_SEARCH_ITEM
  • HOME
  • HOME_ACCOUNT_TYPE_CARD_ADULT_GRADUATION
  • HOME_ACCOUNT_TYPE_CARD_GLA_LEARN_MORE
  • HOME_ACCOUNT_TYPE_CARD_TEEN_GRADUATION
  • HOME_INTENT
  • HOME_NATIVE_NAVIGATION
  • IDENTITY_DOCUMENT
  • IDENTITY_VAULT_CONSENT
  • INACTIVE_ACCOUNT_MANAGER
  • INPUT_TOOLS
  • KID_ONBOARDING
  • LANGUAGE
  • LEGAL_ADDRESS_DETAIL
  • LEGAL_ADDRESS_EDIT
  • LEGAL_NAME_DETAIL
  • LEGAL_NAME_EDIT
  • LESS_SECURE_APPS
  • LESS_SECURE_APPS_HELP_ARTICLE
  • LIMITED_DISABLES
  • LINKED_APPS
  • LINKED_SERVICES_PRIMITIVE_SCREEN
  • LOCATION_DATA_POLICY
  • LOCATION_SHARING
  • MAPS_TIMELINE
  • MERCHANT_CENTER
  • MINOR_MODE_EXIT
  • MINOR_MOMENT
  • MULTIPLE
  • MY_ACTIVITY
  • MY_ACTIVITY_MANAGE_GOOGLE_SEARCH_HISTORY_SCREEN
  • MY_ACTIVITY_MANAGE_WEP_AND_APP_ACTIVITY
  • MY_ACTIVITY_MANAGE_YT_HISTORY
  • MY_ACTIVITY_PRODUCT_SCREEN
  • MY_ACTIVITY_YOUTUBE_WATCH_AND_SEARCH_HISTORY
  • MY_AD_CENTER
  • MY_AD_CENTER_HOME
  • NAME
  • NICKNAME
  • OBAKE_PICTURE_PICKER_AI_SELFIES
  • OBAKE_PICTURE_PICKER_CROP
  • OBAKE_PICTURE_PICKER_GOOGLE_PHOTOS
  • OBAKE_PICTURE_PICKER_ILLUSTRATION
  • OBAKE_PICTURE_PICKER_PAST_PROFILE_PHOTOS
  • OBAKE_PICTURE_PICKER_REMOVE_PICTURE
  • OFFLINE_OTP
  • ONBOARDING_SCREEN
  • OPAQUE_ID
  • OTHER_CREDENTIAL_LIST
  • OUTREACH_LANDING_PAGE
  • PAASK_ACCOUNT_NOTIFIER
  • PARTNER_AD_SETTINGS
  • PASSWORD
  • PASSWORD_AWARENESS
  • PASSWORD_CHECKUP
  • PASSWORD_LIGHT
  • PASSWORD_MANAGER_MARKETING_PAGE
  • PAYMENTS_ADD_FOP_PROMPT_TARGET
  • PAYMENTS_AND_SUBSCRIPTIONS
  • PAYMENTS_BILLING_ACCOUNT_BANK_NEED_MANDATE_ACCEPTANCE_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_BANK_NOT_VERIFIED_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_BANK_PAYMENT_DECLINED_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_BANK_TERMS_AND_CONDITIONS_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_CARD_CLOSED_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_CARD_EXPIRED_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_CARD_EXPIRING_SOON_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_CARD_PAYMENT_DECLINED_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_GENERIC_PAYMENT_DECLINED_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_GENERIC_RISK_SUSPENDED_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_MISSING_PAYMENT_METHOD_PROMPT_TARGET
  • PAYMENTS_CENTER
  • PAYMENTS_CENTER_BILLING_ADDRESSES
  • PAYMENTS_CENTER_LEGAL_ADDRESS
  • PAYMENTS_CUSTOMER_OR_INSTRUMENT_RISK_VERIFICATION_PROMPT_TARGET
  • PAYMENTS_FUNDS_GUARANTEE_INSTRUMENT_DECLINED_PROMPT_TARGET
  • PAYMENTS_INSTRUMENT_BANK_NOT_VERIFIED_PROMPT_TARGET
  • PAYMENTS_INSTRUMENT_CARD_EXPIRED_PROMPT_TARGET
  • PAYMENTS_SANCTIONS_ADHOC_PROMPT_TARGET
  • PAYMENTS_SANCTIONS_CONFIRMED_PROMPT_TARGET
  • PAYMENTS_SANCTIONS_CRIMEA_PROMPT_TARGET
  • PAYMENTS_SANCTIONS_PARTIAL_SUSPENSION_FIXFLOW_PROMPT_TARGET
  • PAYMENTS_SANCTIONS_PARTIAL_SUSPENSION_HC_PROMPT_TARGET
  • PAYMENTS_SANCTIONS_SUSPENSION_FIXFLOW_PROMPT_TARGET
  • PAYMENTS_SANCTIONS_SUSPENSION_HC_PROMPT_TARGET
  • PAYMENT_METHODS
  • PAYMENT_METHOD_ADD
  • PAYMENT_METHOD_DETAIL
  • PAYMENT_METHOD_EDIT
  • PAYMENT_METHOD_LIST
  • PEOPLE_AND_SHARING
  • PERSONAL_INFO
  • PERSONAL_RESULTS_IN_SEARCH
  • PHONE
  • PHONE_SIGN_IN
  • POST_HIJACK_MITIGATION
  • PREFERENCES_LANDING
  • PRIMARY_EMAIL
  • PRIVACY_ADVISOR_ASSISTANT
  • PRIVACY_ADVISOR_MAPS
  • PRIVACY_ADVISOR_MESSAGES
  • PRIVACY_ADVISOR_SEARCH
  • PRIVACY_ADVISOR_YOUTUBE
  • PRIVACY_CHECKUP
  • PRIVACY_LANDING
  • PRIVACY_POLICY
  • PRIVACY_SAFE_SEARCH
  • PRODUCT_PROFILE_SCREEN
  • PROFILE
  • PROFILE_ADDRESS_ADD
  • PROFILE_ADDRESS_EDIT
  • PROFILE_ADD_ABOUT
  • PROFILE_ADD_CONTACT_INFO
  • PROFILE_ADD_WORK_AND_EDUCATION
  • PROFILE_CARD_LEARN_MORE
  • PROFILE_CHAT_EDIT
  • PROFILE_CUSTOM_URLS
  • PROFILE_DETAILS
  • PROFILE_DISCOVERABILITY
  • PROFILE_DISCOVERY
  • PROFILE_DISPLAY_NAME_EDIT
  • PROFILE_EDUCATION
  • PROFILE_EDUCATION_EDIT
  • PROFILE_EMAIL_EDIT
  • PROFILE_INTRODUCTION_EDIT
  • PROFILE_LIMITED_PROFILE
  • PROFILE_LIMITED_PROFILE_EDIT
  • PROFILE_LINKS
  • PROFILE_LINKS_EDIT
  • PROFILE_NAME
  • PROFILE_NAME_EDIT
  • PROFILE_NICKNAME_EDIT
  • PROFILE_OCCUPATION_EDIT
  • PROFILE_ORGANIZATION_INFO
  • PROFILE_PHONE_EDIT
  • PROFILE_PHOTO_EDIT
  • PROFILE_PICTURE
  • PROFILE_PICTURE_ADD_PICTURE_DIALOG
  • PROFILE_PICTURE_CHANGE_PICTURE_DIALOG
  • PROFILE_PICTURE_REMOVE_PICTURE_DIALOG
  • PROFILE_PLACES
  • PROFILE_PLACES_EDIT
  • PROFILE_PRONOUNS_EDIT
  • PROFILE_VANITY_URL_EDIT_SCREEN
  • PROFILE_WORKSPACE
  • PROFILE_WORK_HISTORY
  • PROFILE_WORK_HISTORY_EDIT
  • PURCHASES
  • PURCHASES_CARD_DESCRIPTION_LEARN_MORE_LINK
  • PURCHASES_DETAIL
  • RECENTLY_USED_DEVICES
  • RECENT_SECURITY_EVENTS
  • RECOVERY_CONTACTS
  • RECOVERY_CONTACTS_PAGE
  • RECOVERY_EMAIL
  • RECOVERY_PHONE
  • REMOVE_ACCOUNT_FROM_DEVICE
  • REPORT_PROBLEM
  • RESCUE_CODE_PAGE
  • RESERVATIONS
  • RESERVATIONS_CARD_DESCRIPTION_LEARN_MORE_LINK
  • SAFER
  • SAFER_INTERNET_DAY
  • SAFER_PASSWORD_MANAGER_SCREEN
  • SAFETY_ANDROID_SCREEN
  • SAFETY_CHROME_SCREEN
  • SAFETY_GENERAL_SCREEN
  • SAFETY_GMAIL_SCREEN
  • SAFETY_MEET_SCREEN
  • SAFETY_PAYMENT_SCREEN
  • SAFETY_PHOTO_SCREEN
  • SAFETY_PRIVACY_ADS_SCREEN
  • SAFETY_SEARCH_SCREEN
  • SAFE_SEARCH
  • SAFE_SEARCH_SCREEN
  • SANDBOX_ONBOARDING_FLOW
  • SAVED_PASSWORDS
  • SEARCH
  • SEARCH_CARD_OUTBOUND_SCREEN
  • SEARCH_SETTINGS
  • SECURITY
  • SECURITY_CHECKUP
  • SECURITY_CHECKUP_INTRO
  • SECURITY_CODE
  • SECURITY_COMBINED_RECOVERY_OPTIONS
  • SECURITY_FIND_PHONE
  • SECURITY_KEYS
  • SECURITY_LANDING
  • SECURITY_QUESTION
  • SECURITY_SIGN_IN_AUTHENTICATOR_SCREEN
  • SECURITY_SIGN_IN_BACKUP_CODES_SCREEN
  • SECURITY_SIGN_IN_BACKUP_PHONES_SCREEN
  • SECURITY_SIGN_IN_GOOGLE_PROMPT_SCREEN
  • SECURITY_SIGN_IN_PASSKEYS_SCREEN
  • SECURITY_SIGN_IN_PASSWORD_OPTIONAL
  • SECURITY_SIGN_IN_RESCUE_CODE
  • SECURITY_SIGN_IN_SECURITY_KEYS_SCREEN
  • SECURITY_SIGN_IN_TWO_STEP_VERIFICATION_PHONE_SCREEN
  • SECURITY_SIGN_IN_WITH_GOOGLE_APPS
  • SECURITY_THIRD_PARTY_APPS
  • SECURITY_THIRD_PARTY_MANAGEMENT_LIST
  • SECURITY_THIRD_PARTY_MANAGEMENT_OVERVIEW
  • SECURITY_TITANIUM_HELP
  • SHARED_ENDORSEMENTS
  • SHIELDED_EMAIL
  • SHIELDED_EMAIL_CREATE_CONFIRMATION
  • SHIELDED_EMAIL_CREATE_FOR_APP
  • SHIELDED_EMAIL_CREATE_FOR_SITE
  • SHIELDED_EMAIL_DETAILS
  • SHIELDED_EMAIL_FACET_LINK_TARGET
  • SHIELDED_EMAIL_INACTIVE_LIST
  • SHIELDED_EMAIL_SELECT_RESERVED_EMAIL
  • SHIELDED_EMAIL_SETTINGS
  • SID_PASSWORD_MANAGER_NATIVE_NAVIGATION_SCREEN
  • SIGNED_OUT_AD_SETTINGS
  • SIGNED_OUT_CREATE_NEW_ACCOUNT_LINK
  • SIGNED_OUT_GOOGLE_ANALYTICS
  • SIGNED_OUT_LEARN_MORE_ABOUT_COOKIES_LINK
  • SIGNED_OUT_SEARCH_PERSONALIZATION
  • SIGNED_OUT_YOUTUBE_HISTORY
  • SIGNING_IN_TO_GOOGLE_INTRO
  • SIGNIN_SELFIE_VIDEO
  • STORAGE
  • SUBSCRIPTIONS
  • SUGGEST_IDEA
  • SUPPORT
  • TAKEOUT
  • TAKEOUT_DOWNLOADS
  • TERMS_OF_SERVICE
  • THIRD_PARTY_CONNECTIONS_DETAILS
  • THIRD_PARTY_CONNECTIONS_LIST
  • THIRD_PARTY_CONNECTIONS_OVERVIEW
  • THIRD_PARTY_CONNECTIONS_SETTINGS
  • TITANIUM_ENROLL
  • TITANIUM_SETTINGS
  • TITANIUM_SOCIAL_RECOVERY
  • TITANIUM_UNAVAILABLE
  • TITANIUM_UNENROLL
  • TURN_OFF_PROFILE_DISCOVERY
  • TWITTER_SUPPORT
  • TWO_STEP_VERIFICATION
  • TWO_STEP_VERIFICATION_BACKUP_CODES
  • TWO_STEP_VERIFICATION_GOOGLE_AUTHENTICATOR
  • TWO_STEP_VERIFICATION_GOOGLE_PROMPT
  • TWO_STEP_VERIFICATION_PASSKEYS
  • TWO_STEP_VERIFICATION_PHONE_NUMBERS
  • TWO_STEP_VERIFICATION_SECURITY_KEYS
  • UNICORN_LITE_PROFILE_INPUT_TOOLS
  • UNICORN_LITE_PROFILE_LANGUAGE
  • UNICORN_LITE_PROFILE_WEB_PREFERENCES
  • UNIFIED_ONBOARDING
  • UNUSED_DEVICE_CONTACTS
  • USE_APP_WITHOUT_ACCOUNT
  • VIDEO_VERIFICATION
  • VIDEO_VERIFICATION_COLLECTION
  • WARM_WELCOME_FLOW
  • WEB_APPROVAL
  • YOUTUBE_FAMILY_CENTER
enumDeprecated
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • True
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • True
  • True
  • True
  • False
  • True
  • False
  • False
  • True
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
enumDescriptions
  • go/keep-sorted start newline_separated=yes ResourceId.ABOUT_GOOGLE_SCREEN
  • ScreenId.PRIVACY_ABOUT_ME ResourceId.PRIVACY_ABOUT_ME_SCREEN MyAccountArea.ABOUT_ME
  • ResourceId.PRIVACY_ABOUT_THIS_AD_SCREEN
  • ResourceId.PREFERENCES_ACCESSIBILITY_SCREEN MyAccountArea.ACCESSIBILITY
  • ResourceId.ACCOUNT_ANNIVERSARY_SCREEN
  • No ResourceId
  • ResourceId.SECURITY_ACCOUNT_ENHANCED_SAFE_BROWSING_SCREEN
  • No ResourceId
  • ResourceId.ACCOUNT_MENU_CARD_DECK
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS ResourceId.PRIVACY_ACTIVITY_CONTROLS_SCREEN MyAccountArea.ACTIVITY_CONTROLS
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS_DEVICE_INFO ResourceId.PRIVACY_ACTIVITY_CONTROLS_DEVICE_INFO_SCREEN
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS_LOCATION_HISTORY ResourceId.PRIVACY_ACTIVITY_CONTROLS_LOCATION_HISTORY_SCREEN
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS_VOICE_AND_AUDIO ResourceId.PRIVACY_ACTIVITY_CONTROLS_VOICE_AND_AUDIO_SCREEN
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS_WEB_AND_APP ResourceId.PRIVACY_ACTIVITY_CONTROLS_WEB_AND_APP_SCREEN
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS_YT_HISTORY ResourceId.PRIVACY_ACTIVITY_CONTROLS_YT_HISTORY_SCREEN
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS_YT_SEARCH_HISTORY ResourceId.PRIVACY_ACTIVITY_CONTROLS_YT_SEARCH_HISTORY_SCREEN
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS_YT_WATCH_HISTORY ResourceId.PRIVACY_ACTIVITY_CONTROLS_YT_WATCH_HISTORY_SCREEN
  • No ResourceId.
  • No ResourceId.
  • No ResourceId.
  • No ResourceId.
  • No ResourceId.
  • ResourceId.ADD_ACCOUNT_TO_DEVICE_SCREEN
  • ScreenId.PRIVACY_ADS_SETTINGS ResourceId.PRIVACY_ADS_SETTINGS_SCREEN MyAccountArea.ADS_SETTINGS
  • Previously ResourceId.ADS_SETTINGS_CARD_NOT_ELIGIBLE_LEARN_MORE_LINK_SCREEN
  • No ResourceId MyAccountArea.AGE_DISABLED
  • No ScreenId ResourceId.AGE_VERIFICATION_OPTIONS_SCREEN
  • ResourceId.ALBUM_ARCHIVE_SCREEN
  • No ResourceId
  • ResourceId.ALTERNATE_EMAIL_SCREEM MyAccountArea.ALTERNATE_EMAIL
  • ScreenId.SECURITY_APP_PASSWORDS ResourceId.SECURITY_APP_PASSWORDS_SCREEN MyAccountArea.MANAGE_APP_PASSWORDS
  • ScreenId.PRIVACY_CONTACT_SUGGESTIONS ResourceId.PRIVACY_CONTACT_SUGGESTIONS_SCREEN
  • ScreenId.PRIVACY_BIRTHDAY ResourceId.PRIVACY_BIRTHDAY_SCREEN MyAccountArea.BIRTHDAY
  • ResourceId.BIRTHDAY_AGE_STATUS_SCREEN
  • ResourceId.BIRTHDAY_EDIT_SCREEN
  • ScreenId.PRIVACY_BLOCKED_USERS ResourceId.PRIVACY_BLOCKED_USERS_SCREEN MyAccountArea.BLOCKED_USERS
  • No ResourceId
  • No ResourceId
  • ResourceId.BUSINESS_PERSONALIZATION_SCREEN
  • ResourceId.CLP_RECOMMENDED_SCREEN
  • ResourceId.CLP_RECOMMENDED_AUTOFILL_SCREEN
  • ResourceId.CLP_RECOMMENDED_BACKUP_SCREEN
  • ResourceId.CLP_RECOMMENDED_FINDMYDEVICE_SCREEN
  • ResourceId.CLP_RECOMMENDED_NEARBY_SCREEN
  • ResourceId.CLP_RECOMMENDED_PAY_SCREEN
  • ResourceId.CLP_SCREEN
  • No ResourceId Deprecated, please use SECURITY_COMBINED_RECOVERY_OPTIONS instead.
  • ResourceId.PRIVACY_COMMUNICATION_PREFERENCES_SCREEN
  • No ResourceId
  • ScreenId.SECURITY_CONNECTED_APPS ResourceId.SECURITY_CONNECTED_APPS_SCREEN MyAccountArea.CONNECTED_APPS
  • ResourceId.CONSENT_PRIMITIVE_DEMO_CONFIG_SCREEN
  • ScreenId.CONSTELLATION_CONSENT ResourceId.CONSTELLATION_CONSENT_SCREEN
  • ScreenId.PRIVACY_CONTACTS ResourceId.PRIVACY_CONTACTS_SCREEN
  • ScreenId.MISC_CONTACT_EMAIL ResourceId.MISC_CONTACT_EMAIL_SCREEN MyAccountArea.CONTACT_EMAIL
  • No ResourceId.
  • No ResourceId.
  • ResourceId.DARK_WEB_REPORT_SCAN
  • ResourceId.DARK_WEB_REPORT_SCAN_RECOMMENDED
  • ResourceId.DARK_WEB_REPORT_SCREEN
  • ResourceId.DARK_WEB_REPORT_SETUP_SCREEN
  • ScreenId.DASHBOARD_OUTBOUND ResourceId.DASHBOARD_OUTBOUND_SCREEN No MyAccountAreaz;
  • ResourceId.DATA_AND_PERSONALIZATION_SCREEN
  • ResourceId.DATA_AND_PRIVACY_DATA_IMPROVES_EXPERIENCE_SCREEN
  • ResourceId.DATA_AND_PRIVACY_DATA_VISIBILITY_SCREEN
  • ScreenId.PREFERENCES_DELETE_ACCOUNT ResourceId.PREFERENCES_DELETE_ACCOUNT_SCREEN MyAccountArea.DELETE_ACCOUNT
  • No ResourceId
  • No ResourceId
  • ScreenId.PREFERENCES_DELETE_SERVICES ResourceId.PREFERENCES_DELETE_SERVICES_SCREEN MyAccountArea.DELETE_PRODUCTS
  • ResourceId.DELETE_SERVICES_OR_ACCOUNT_SCREEN
  • No ResourceId MyAccountArea.DELETE_YOUTUBE
  • No ResourceId Do not use
  • ResourceId.DEVICE_ACTIVITY_INTRO_SCREEN
  • ResourceId.PRIVACY_DEVICE_APPS_SCREEN
  • ResourceId.PRIVACY_DEVICE_CONTACTS_SCREEN
  • ResourceId.DEVICE_SETTINGS_ABOUT_PHONE_SCREEN MyAccountArea.DEVICE_SETTINGS_ABOUT_PHONE
  • ResourceId.DEVICE_SETTINGS_EMERGENCY_INFO_SCREEN MyAccountArea.DEVICE_SETTINGS_EMERGENCY_INFO
  • ResourceId.DEVICE_SETTINGS_PAYMENTS_SCREEN MyAccountArea.DEVICE_SETTINGS_PAYMENTS
  • ResourceId.DIGITAL_ID_MANAGEMENT_SCREEN
  • ResourceId.DOCUMENT_MANAGEMENT_SCREEN
  • ScreenId.PRIVACY_EMAIL ResourceId.PRIVACY_EMAIL_SCREEN MyAccountArea.EMAIL
  • ResourceId.FAMILY_CHILD_RESTORE_PAGE_SCREEN
  • ResourceId.FAMILY_CREATE_CONFIRMATION_OR_DETAILS_SCREEN
  • Created by mistake, do not use
  • ResourceId.FAMILY_CREATE_FAMILY_CONFIRMATION_SCREEN
  • ResourceId.FAMILY_CREATE_FAMILY_PAGE_SCREEN
  • ResourceId.FAMILY_CREATION_SCREEN
  • ResourceId.FAMILY_DELETE_FAMILY_PAGE_SCREEN
  • ResourceId.FAMILY_DETAILS_SCREEN
  • ResourceId.FAMILY_ENTERTAINMENT_SCREEN
  • ResourceId.FAMILY_HOME_STRUCTURE_SCREEN
  • ResourceId.FAMILY_INVITATION_COMPLETE_PAGE_SCREEN
  • ResourceId.FAMILY_INVITE_MEMBERS_SCREEN
  • ResourceId.FAMILY_INVITE_MEMBERS_PAGE_SCREEN
  • ResourceId.FAMILY_INVITE_SECOND_PARENT_SCREEN
  • ResourceId.FAMILY_LEAVE_FAMILY_SCREEN
  • ResourceId.FAMILY_LINK_SCREEN
  • ResourceId.FAMILY_LIST_PENDING_INVITATIONS_PAGE_SCREEN
  • ScreenId.PREFERENCES_FAMILY_MANAGEMENT ResourceId.PREFERENCES_FAMILY_MANAGEMENT_SCREEN MyAccountArea.MANAGE_FAMILY_GROUP
  • ResourceId.FAMILY_MEMBERS_SCREEN
  • ResourceId.FAMILY_MEMBERS_SUPERVISION_SCREEN
  • ResourceId.FAMILY_MEMBER_OR_INVITATION_DETAILS_PAGE_SCREEN
  • ResourceId.FAMILY_PARENTAL_CONTROLS_SCREEN
  • ResourceId.FAMILY_PARENTAL_CONTROLS_MANAGE_KID_SEARCH_SETTINGS_SCREEN
  • ResourceId.FAMILY_PAYMENT_METHOD_SCREEN
  • No ScreenId ResourceId.FAMILY_PRODUCT_FAMILY_CALENDAR_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FAMILY_PRODUCT_FAMILY_LINK_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FAMILY_PRODUCT_GOOGLE_ONE_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FAMILY_PRODUCT_PHOTOS_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FAMILY_PRODUCT_PLAY_LIBRARY_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FAMILY_PRODUCT_YOUTUBE_MUSIC_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FAMILY_PRODUCT_YOUTUBE_RED_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FAMILY_PRODUCT_YOUTUBE_UNPLUGGED_SCREEN No MyAccountArea
  • ResourceId.FAMILY_REMOVE_MEMBER_PAGE_SCREEN
  • ResourceId.FAMILY_SELECT_SECOND_PARENT_CANDIDATELIST_SCREEN
  • ResourceId.FAMILY_SELECT_SECOND_PARENT_PAGE_SCREEN
  • ResourceId.FAMILY_SELECT_TANDEM_PARTNER_PAGE_SCREEN
  • ResourceId.FAMILY_SERVICES_SCREEN
  • ResourceId.FAMILY_SERVICES_CARD_SCREEN
  • ResourceId.FAMILY_TANDEM_PARTNER_SELECTED_PAGE_SCREEN
  • ResourceId.FAMILY_TANDEM_STATUS_PAGE_SCREEN
  • ResourceId.FAMILY_UPGRADE_FOP_PAGE_SCREEN
  • ResourceId.FAMILY_UPGRADE_TOS_PAGE_SCREEN
  • ResourceId.FAQ_CARD_ACCOUNT_DATA_ARTICLE_SCREEN
  • ResourceId.FAQ_CARD_MANAGE_GOOGLE_SETTINGS_ARTICLE_SCREEN
  • ResourceId.FAQ_CARD_RECOVERY_INFORMATION_ARTICLE_SCREEN
  • ResourceId.FAQ_CARD_SUBSCRIPTION_MANAGEMENT_ARTICLE_SCREEN
  • ResourceId.FAQ_CARD_SUSPICIOUS_ACTIVITY_ARTICLE_SCREEN
  • ResourceId.FAUXBAKE_SCREEN
  • ResourceId.FEEDBACK_SCREEN
  • ResourceId.FIND_YOUR_PHONE_SCREEN MyAccountArea.FIND_YOUR_PHONE
  • ResourceId.FITBIT_PRIVACY_CENTER_CONNECTED_APPS_SCREEN
  • ResourceId.FITBIT_PRIVACY_CENTER_DELETION_CATEGORIES_SCREEN
  • ResourceId.FITBIT_PRIVACY_CENTER_DELETION_CONFIRMATION_SCREEN
  • ResourceId.FITBIT_PRIVACY_CENTER_DELETION_OPTIONS_SCREEN
  • ScreenId.FITBIT_PRIVACY_CENTER_FEATURE ResourceId.FITBIT_PRIVACY_CENTER_FEATURE_SCREEN No MyAccountArea
  • ScreenId.FITBIT_PRIVACY_CENTER_FEATURES ResourceId.FITBIT_PRIVACY_CENTER_FEATURES_SCREEN No MyAccountArea
  • ResourceId.FITBIT_PRIVACY_CENTER_PAIRED_DEVICES_SCREEN
  • ResourceId.FITBIT_PRIVACY_CENTER_RND_FEATURES_SCREEN
  • ScreenId.FITBIT_PRIVACY_CENTER_SETTINGS ResourceId.FITBIT_PRIVACY_CENTER_SETTINGS_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_ASSISTANT_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_CATEGORY_DELETION_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_DATA_TYPE_DELETION_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_DEVICES_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_MANAGE_CATEGORY_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_MANAGE_DATA_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_MOBILE_VITALS_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_PERSONALIZED_SUGGESTIONS_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_SETTINGS_SCREEN No MyAccountArea
  • ResourceId.GELLER_SUPERVISION_SCREEN
  • ScreenId.PRIVACY_GENDER ResourceId.PRIVACY_GENDER_SCREEN MyAccountArea.GENDER
  • No ResourceId
  • ResourceId.GEO_HOME_ADDRESS_SCREEN
  • ResourceId.GEO_HOME_WORK_ADDRESS_SCREEN
  • ResourceId.GEO_WORK_ADDRESS_SCREEN
  • ScreenId.GESTURE_BASED_REAUTH ResourceId.GESTURE_BASED_REAUTH_SCREEN
  • ResourceId.GMSCORE_SETTINGS_CLEAR_APP_STATE_SCREEN
  • ResourceId.GMSCORE_SETTINGS_HELP_SCREEN
  • ResourceId.GMSCORE_SETTINGS_ITEM_SCREEN
  • ResourceId.GMSCORE_SETTINGS_OPEN_SOURCE_LICENSES_SCREEN
  • ResourceId.GMSCORE_SETTINGS_SUBCATEGORY_SCREEN
  • ResourceId.GMSCORE_SETTINGS_SYSTEM_COMPONENT_UPDATE_SETTINGS_SCREEN
  • ResourceId.GMSCORE_SETTINGS_USAGE_REPORTING_SCREEN
  • ResourceId.GOOGLE_ACCOUNT_COMMUNITY_SCREEN
  • ResourceId.GOOGLE_ACCOUNT_HELP_CENTER_SCREEN
  • ResourceId.GOOGLE_ACCOUNT_MARKETING_PAGE_SCREEN
  • ScreenId.SECURITY_PIN ResourceId.SECURITY_PIN_SCREEN MyAccountArea.SIGN_IN_PIN
  • ResourceId.GOOGLE_BUSINESS_PROFILES_SCREEN
  • ResourceId.GOOGLE_BUSINESS_PROFILES_SINGLE_LISTING_SCREEN
  • ScreenId.PRIVACY_GOOGLE_DASHBOARD ResourceId.PRIVACY_GOOGLE_DASHBOARD_SCREEN MyAccountArea.GOOGLE_DASHBOARD
  • No ResourceId.
  • ResourceId.GOOGLE_GUIDE_SCREEN
  • ResourceId.GOOGLE_MY_BUSINESS_PORTAL_SCREEN
  • ResourceId.GOOGLE_MY_BUSINESS_SIGN_UP_SCREEN
  • ResourceId.GOOGLE_ONE_ALL_AVAILABLE_SUPPORT_OPTIONS_SCREEN
  • ResourceId.GOOGLE_ONE_CHAT_SUPPORT_SCREEN
  • ResourceId.GOOGLE_ONE_EMAIL_SUPPORT_SCREEN
  • ResourceId.GOOGLE_ONE_HOME_SCREEN
  • ResourceId.GOOGLE_ONE_PHONE_SUPPORT_SCREEN
  • ResourceId.PREFERENCES_GOOGLE_ONE_STORAGE_SCREEN
  • ResourceId.GOOGLE_ONE_STORAGE_MANAGEMENT_SCREEN
  • ResourceId.GOOGLE_ONE_SUPPORT_SCREEN
  • ResourceId.GOOGLE_PAY_ADD_PAYMENT_METHOD_SCREEN
  • ResourceId.GOOGLE_PAY_EXPERIENCE_SCREEN
  • ResourceId.GOOGLE_PAY_MANAGE_PAYMENT_METHODS_SCREEN
  • ResourceId.GOOGLE_PAY_PAYMENT_METHOD_DETAILS_SCREEN
  • ScreenId.PRIVACY_GOOGLE_PLUS_SETTINGS ResourceId.PRIVACY_GOOGLE_PLUS_SETTINGS_SCREEN MyAccountArea.GOOGLE_PLUS_SETTINGS
  • ResourceId.GOOGLE_PRODUCT_FORUM_SCREEN
  • ScreenId.PRIVACY_TAKEOUT_MIGRATION ResourceId.PRIVACY_TAKEOUT_MIGRATION_SCREEN
  • ResourceId.HELP_SCREEN
  • ResourceId.MAIN_HELP_CENTER_SCREEN
  • ResourceId.HELP_CENTER_ARTICLE_SCREEN
  • ResourceId.HELP_CENTER_SEARCH_ITEM_SCREEN
  • ScreenId.MENU_MY_ACCOUNT ResourceId.HOME_SCREEN MyAccountArea.WELCOME
  • ResourceId.HOME_ACCOUNT_TYPE_CARD_ADULT_GRADUATION_LINK_SCREEN
  • ResourceId.HOME_ACCOUNT_TYPE_CARD_GLA_LEARN_MORE_LINK_SCREEN
  • ResourceId.HOME_ACCOUNT_TYPE_CARD_TEEN_GRADUATION_LINK_SCREEN
  • ResourceId.HOME_INTENT
  • ResourceId.HOME_NATIVE_NAVIGATION_SCREEN
  • ResourceId.IDENTITY_DOCUMENT_SCREEN
  • ResourceId.AGE_VERIFICATION_OPTIONS_SCREEN
  • ScreenId.PRIVACY_INACTIVE_ACCOUNT_MANAGER ResourceId.PRIVACY_INACTIVE_ACCOUNT_MANAGER_SCREEN MyAccountArea.INACTIVE
  • ResourceId.PREFERENCES_INPUT_TOOLS_SCREEN MyAccountArea.INPUT_TOOLS
  • ResourceId.KID_ONBOARDING_SCREEN
  • ScreenId.PREFERENCES_LANGUAGE ResourceId.PREFERENCES_LANGUAGE_SCREEN MyAccountArea.LANGUAGE
  • ScreenId.SECURITY_LESS_SECURE_APPS ResourceId.SECURITY_LESS_SECURE_APPS_SCREEN MyAccountArea.LESS_SECURE_APPS
  • ResourceId.LESS_SECURE_APPS_CARD_LEARN_MORE_LINK_SCREEN
  • ResourceId.PREFERENCES_LIMITED_DISABLES_SCREEN
  • ResourceId.LINKED_APPS_SCREEN
  • ResourceId.LINKED_SERVICES_PRIMITIVE_SCREEN
  • ResourceId.LOCATION_DATA_POLICY_SCREEN
  • ScreenId.PRIVACY_LOCATION_SHARING ResourceId.PRIVACY_LOCATION_SHARING_SCREEN MyAccountArea.LOCATION_SHARING
  • ScreenId.PRIVACY_GOOGLE_MAPS_TIMELINE ResourceId.PRIVACY_GOOGLE_MAPS_TIMELINE_SCREEN MyAccountArea.TIMELINE_IN_GOOGLE_MAPS
  • ResourceId.MERCHANT_CENTER_SCREEN
  • ResourceId.MINOR_MODE_EXIT_SCREEN
  • ResourceId.MINOR_MOMENT_SCREEN
  • Not logged, used in dashboards.
  • ScreenId.PRIVACY_MY_ACTIVITY ResourceId.PRIVACY_MY_ACTIVITY_SCREEN MyAccountArea.MY_ACTIVITY
  • ResourceId.PRIVACY_MY_ACTIVITY_MANAGE_GOOGLE_SEARCH_HISTORY_SCREEN
  • ResourceId.PRIVACY_MY_ACTIVITY_MANAGE_WEB_AND_APP_ACTIVITY_SCREEN
  • ResourceId.PRIVACY_MY_ACTIVITY_MANAGE_YT_HISTORY_SCREEN
  • ResourceId.MY_ACTIVITY_PRODUCT_SCREEN
  • ResourceId.MY_ACTIVITY_YOUTUBE_WATCH_AND_SEARCH_HISTORY_SCREEN
  • ResourceId.PRIVACY_MY_AD_CENTER_SCREEN
  • ResourceId.PRIVACY_MY_AD_CENTER_HOME_SCREEN
  • ScreenId.PRIVACY_NAME ResourceId.PRIVACY_NAME_SCREEN MyAccountArea.NAME
  • ScreenId.PRIVACY_NICKNAME ResourceId.PRIVACY_NICKNAME_SCREEN MyAccountArea.NICKNAME
  • ResourceId.OBAKE_PICTURE_PICKER_AI_SELFIES_SCREEN
  • ResourceId.OBAKE_PICTURE_PICKER_CROP_SCREEN
  • ResourceId.OBAKE_PICTURE_PICKER_GOOGLE_PHOTOS_SCREEN
  • ResourceId.OBAKE_PICTURE_PICKER_ILLUSTRATION_SCREEN
  • ResourceId.OBAKE_PICTURE_PICKER_PAST_PROFILE_PHOTOS_SCREEN
  • ResourceId.OBAKE_PICTURE_PICKER_REMOVE_PICTURE_SCREEN
  • ScreenId.SECURITY_OFFLINE_OTP ResourceId.SECURITY_OFFLINE_OTP_SCREEN MyAccountArea.OFFLINE_OTP
  • ResourceId.ONBOARDING_SCREEN
  • ResourceId.SECURITY_OPAQUE_ID_SCREEN
  • No ResourceId.
  • ResourceId.OUTREACH_LANDING_PAGE_SCREEN
  • No ResourceId
  • ResourceId.PRIVACY_PARTNER_AD_SETTINGS_SCREEN
  • ScreenId.SECURITY_PASSWORD ResourceId.SECURITY_PASSWORD_SCREEN MyAccountArea.PASSWORD
  • ScreenId.MISC_PASSWORD_AWARENESS ResourceId.MISC_PASSWORD_AWARENESS_SCREEN
  • ResourceId.PASSWORD_CHECKUP_SCREEN
  • No ResourceId
  • ResourceId.PASSWORD_MANAGER_MARKETING_PAGE_SCREEN
  • ResourceId.PAYMENTS_ADD_FOP_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_AND_SUBSCRIPTIONS_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_BANK_NEED_MANDATE_ACCEPTANCE_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_BANK_NOT_VERIFIED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_BANK_PAYMENT_DECLINED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_BANK_TERMS_AND_CONDITIONS_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_CARD_CLOSED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_CARD_EXPIRED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_CARD_EXPIRING_SOON_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_CARD_PAYMENT_DECLINED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_GENERIC_PAYMENT_DECLINED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_GENERIC_RISK_SUSPENDED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_MISSING_PAYMENT_METHOD_PROMPT_TARGET_SCREEN
  • ScreenId.PREFERENCES_PAYMENTS_CENTER ResourceId.PREFERENCES_PAYMENTS_CENTER_SCREEN MyAccountArea.PAYMENTS_CENTER
  • No ResourceId
  • No ResourceId
  • ResourceId.PAYMENTS_CUSTOMER_OR_INSTRUMENT_RISK_VERIFICATION_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_FUNDS_GUARANTEE_INSTRUMENT_DECLINED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_INSTRUMENT_BANK_NOT_VERIFIED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_INSTRUMENT_CARD_EXPIRED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_SANCTIONS_ADHOC_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_SANCTIONS_CONFIRMED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_SANCTIONS_CRIMEA_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_SANCTIONS_PARTIAL_SUSPENSION_FIXFLOW_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_SANCTIONS_PARTIAL_SUSPENSION_HC_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_SANCTIONS_SUSPENSION_FIXFLOW_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_SANCTIONS_SUSPENSION_HC_PROMPT_TARGET_SCREEN
  • ScreenId.PREFERENCES_PAYMENTS_CENTER_METHODS ResourceId.PREFERENCES_PAYMENTS_CENTER_METHODS_SCREEN MyAccountArea.PAYMENT_METHODS
  • No ResourceId
  • No ResourceId
  • No ResourceId
  • ResourceId.PLATFORM_PAYMENT_METHOD_LIST_SCREEN
  • ResourceId.PEOPLE_AND_SHARING_SCREEN
  • ResourceId.PERSONAL_INFO_SCREEN
  • ResourceId.PRIVACY_PERSONAL_RESULTS_IN_SEARCH_SCREEN
  • ScreenId.PRIVACY_PHONE ResourceId.PRIVACY_PHONE_SCREEN MyAccountArea.PHONE
  • ScreenId.SECURITY_PHONE_SIGN_IN ResourceId.SECURITY_PHONE_SIGN_IN_SCREEN MyAccountArea.PHONE_SIGN_IN
  • No ScreenId ResourceId.SECURITY_POST_HIJACK_MITIGATION_SCREEN
  • No ResourceId MyAccountArea.ACCOUNT_PREFERENCES_LANDING
  • ResourceId.PRIMARY_EMAIL_SCREEN MyAccountArea.PRIMARY_EMAIL_VERIFY
  • ScreenId.PRIVACY_ADVISOR_ASSISTANT ResourceId.PRIVACY_ADVISOR_ASSISTANT
  • ScreenId.PRIVACY_ADVISOR_MAPS ResourceId.PRIVACY_ADVISOR_MAPS
  • No ScreenId ResourceId.PRIVACY_ADVISOR_MESSAGES
  • ScreenId.PRIVACY_ADVISOR_SEARCH ResourceId.PRIVACY_ADVISOR_SEARCH
  • No ScreenId ResourceId.PRIVACY_ADVISOR_YOUTUBE
  • ScreenId.PRIVACY_CHECKUP ResourceId.PRIVACY_CHECKUP_SCREEN MyAccountArea.PRIVACY_CHECKUP
  • ScreenId.MENU_PRIVACY ResourceId.MENU_PRIVACY_SCREEN (unused) MyAccountArea.PRIVACY_LANDING
  • ScreenId.MISC_PRIVACY_POLICY ResourceId.MISC_PRIVACY_POLICY_SCREEN
  • ResourceId.PRIVACY_SAFE_SEARCH_SCREEN
  • ResourceId.PRODUCT_PROFILE_SCREEN
  • ResourceId.PROFILE_SCREEN
  • ResourceId.PROFILE_ADDRESS_ADD_SCREEN
  • ResourceId.PROFILE_ADDRESS_EDIT_SCREEN
  • ResourceId.PROFILE_ADD_ABOUT
  • ResourceId.PROFILE_ADD_CONTACT_INFO
  • ResourceId.PROFILE_ADD_WORK_AND_EDUCATION
  • ResourceId.PROFILE_CARD_LEARN_MORE_LINK
  • ResourceId.PROFILE_CHAT_EDIT_SCREEN
  • ResourceId.PROFILE_CUSTOM_URLS_SCREEN
  • ResourceId.PROFILE_DETAILS_SCREEN
  • ResourceId.PROFILE_DISCOVERABILITY_SCREEN
  • ResourceId.PROFILE_DISCOVERY_SCREEN
  • ResourceId.PROFILE_DISPLAY_NAME_EDIT_SCREEN
  • ResourceId.PROFILE_EDUCATION_SCREEN
  • ResourceId.PROFILE_EDUCATION_EDIT_SCREEN
  • ResourceId.PROFILE_EMAIL_EDIT_SCREEN
  • ResourceId.PROFILE_INTRODUCTION_EDIT_SCREEN
  • ResourceId.PROFILE_LIMITED_PROFILE_SCREEN
  • ResourceId.PROFILE_LIMITED_PROFILE_EDIT_SCREEN
  • ResourceId.PROFILE_LINKS_SCREEN
  • ResourceId.PROFILE_LINKS_EDIT_SCREEN
  • ResourceId.PROFILE_NAME_SCREEN
  • ResourceId.PROFILE_NAME_EDIT_SCREEN
  • ResourceId.PROFILE_NICKNAME_EDIT_SCREEN
  • ResourceId.PROFILE_OCCUPATION_EDIT_SCREEN
  • ResourceId.PROFILE_ORGANIZATION_INFO_SCREEN
  • ResourceId.PROFILE_PHONE_EDIT_SCREEN
  • ResourceId.PROFILE_PHOTO_EDIT_SCREEN
  • ScreenId.PRIVACY_PROFILE_PICTURE ResourceId.PRIVACY_PROFILE_PICTURE_SCREEN MyAccountArea.PROFILE_PHOTO
  • ResourceId.PROFILE_PICTURE_ADD_PICTURE_DIALOG
  • ResourceId.PROFILE_PICTURE_CHANGE_PICTURE_DIALOG
  • ResourceId.PROFILE_PICTURE_REMOVE_PICTURE_DIALOG
  • ResourceId.PROFILE_PLACES_SCREEN
  • ResourceId.PROFILE_PLACES_EDIT_SCREEN
  • ResourceId.PROFILE_PRONOUNS_EDIT_SCREEN
  • ResourceId.PROFILE_VANITY_URL_EDIT_SCREEN
  • ResourceId.PROFILE_WORKSPACE_SCREEN
  • ResourceId.PROFILE_WORK_HISTORY_SCREEN
  • ResourceId.PROFILE_WORK_HISTORY_EDIT_SCREEN
  • ScreenId.PREFERENCES_MY_PURCHASES ResourceId.PREFERENCES_MY_PURCHASES_SCREEN
  • ResourceId.PURCHASES_CARD_DESCRIPTION_LEARN_MORE_LINK_SCREEN
  • ScreenId.PREFERENCES_MY_PURCHASES_DETAIL ResourceId.PREFERENCES_MY_PURCHASES_DETAIL_SCREEN
  • ScreenId.SECURITY_RECENTLY_USED_DEVICES ResourceId.SECURITY_RECENTLY_USED_DEVICES_SCREEN MyAccountArea.RECENT_DEVICES
  • ScreenId.SECURITY_RECENT_SECURITY_EVENTS ResourceId.SECURITY_RECENT_SECURITY_EVENTS_SCREEN MyAccountArea.RECENT_SECURITY_EVENTS
  • ResourceId.RECOVERY_CONTACTS_SCREEN
  • No ResourceId Deprecated, please use RECOVERY_CONTACTS instead.
  • ScreenId.SECURITY_RECOVERY_EMAIL ResourceId.SECURITY_RECOVERY_EMAIL_SCREEN MyAccountArea.RECOVERY_EMAIL
  • ScreenId.SECURITY_RECOVERY_PHONE ResourceId.SECURITY_RECOVERY_PHONE_SCREEN MyAccountArea.RECOVERY_PHONE
  • ResourceId.REMOVE_ACCOUNT_FROM_DEVICE_SCREEN
  • ResourceId.REPORT_PROBLEM_SCREEN
  • No ResourceId Deprecated, please use SECURITY_SIGN_IN_RESCUE_CODE_SCREEN instead.
  • ScreenId.PREFERENCES_MY_RESERVATIONS ResourceId.PREFERENCES_MY_RESERVATIONS_SCREEN
  • ResourceId.PURCHASES_CARD_DESCRIPTION_LEARN_MORE_LINK_SCREEN
  • ResourceId.SAFER_SCREEN
  • ResourceId.SAFER_INTERNET_DAY_SCREEN
  • ResourceId.SAFER_PASSWORD_MANAGER_SCREEN
  • ResourceId.SAFETY_ANDROID_SCREEN
  • ResourceId.SAFETY_CHROME_SCREEN
  • ResourceId.SAFETY_GENERAL_SCREEN
  • ResourceId.SAFETY_GMAIL_SCREEN
  • ResourceId.SAFETY_MEET_SCREEN
  • ResourceId.SAFETY_PAYMENT_SCREEN
  • ResourceId.SAFETY_PHOTO_SCREEN
  • ResourceId.SAFETY_PRIVACY_ADS_SCREEN
  • ResourceId.SAFETY_SEARCH_SCREEN
  • Doesn't map to a ResourceId, and is deprecated as a result.
  • ResourceId.SAFE_SEARCH_SCREEN
  • ResourceId.SANDBOX_ONBOARDING_FLOW
  • ScreenId.SECURITY_SAVED_PASSWORDS ResourceId.SECURITY_SAVED_PASSWORDS_SCREEN
  • ResourceId.SEARCH_SCREEN
  • ResourceId.SEARCH_CARD_OUTBOUND_SCREEN
  • ScreenId.PRIVACY_SEARCH_SETTINGS ResourceId.PRIVACY_SEARCH_SETTINGS_SCREEN MyAccountArea.SEARCH_SETTINGS
  • ResourceId.SECURITY_SCREEN
  • ScreenId.SECURITY_CHECKUP ResourceId.SECURITY_CHECKUP_SCREEN MyAccountArea.SECURITY_CHECKUP MyAccountArea.SECURITY_ADVISOR
  • ScreenId.SECURITY_CHECKUP ResourceId.SECURITY_CHECKUP_SCREEN MyAccountArea.SECURITY_CHECKUP MyAccountArea.SECURITY_ADVISOR
  • No ResourceId
  • ResourceId.SECURITY_COMBINED_RECOVERY_OPTIONS_SCREEN
  • ResourceId.SECURITY_FIND_PHONE_SCREEN
  • ScreenId.SECURITY_SECURITY_KEYS ResourceId.SECURITY_SECURITY_KEYS_SCREEN
  • ScreenId.MENU_SECURITY ResourceId.MENU_SECURITY_SCREEN (unused) MyAccountArea.SECURITY_LANDING
  • ScreenId.SECURITY_SECURITY_QUESTION ResourceId.SECURITY_SECURITY_QUESTION_SCREEN MyAccountArea.SECURITY_QUESTION
  • ResourceId.SECURITY_SIGN_IN_AUTHENTICATOR_SCREEN
  • ResourceId.SECURITY_SIGN_IN_BACKUP_CODES_SCREEN
  • ResourceId.SECURITY_SIGN_IN_BACKUP_PHONES_SCREEN
  • ResourceId.SECURITY_SIGN_IN_GOOGLE_PROMPT_SCREEN
  • ResourceId.SECURITY_SIGN_IN_PASSKEYS_SCREEN
  • No ResourceId
  • ResourceId.SECURITY_SIGN_IN_RESCUE_CODE_SCREEN
  • ResourceId.SECURITY_SIGN_IN_SECURITY_KEYS_SCREEN
  • ResourceId.SECURITY_SIGN_IN_TWO_STEP_VERIFICATION_PHONE_SCREEN
  • ResourceId.SECURITY_SIGN_IN_WITH_GOOGLE_APPS_SCREEN
  • ResourceId.SECURITY_THIRD_PARTY_APPS_SCREEN
  • ResourceId.SECURITY_THIRD_PARTY_MANAGEMENT_LIST_SCREEN
  • ResourceId.SECURITY_THIRD_PARTY_MANAGEMENT_OVERVIEW_SCREEN
  • ResourceId.SECURITY_TITANIUM_HELP_SCREEN
  • ScreenId.PRIVACY_SHARED_ENDORSEMENTS ResourceId.PRIVACY_SHARED_ENDORSEMENTS_SCREEN MyAccountArea.SHARED_ENDORSEMENTS
  • ResourceId.SHIELDED_EMAIL_SCREEN
  • ResourceId.SHIELDED_EMAIL_CREATE_CONFIRMATION_SCREEN
  • ResourceId.SHIELDED_EMAIL_CREATE_FOR_APP_SCREEN
  • ResourceId.SHIELDED_EMAIL_CREATE_FOR_SITE_SCREEN
  • ResourceId.SHIELDED_EMAIL_DETAILS_SCREEN
  • ResourceId.SHIELDED_EMAIL_FACET_LINK_TARGET
  • ResourceId.SHIELDED_EMAIL_INACTIVE_LIST_SCREEN
  • ResourceId.SHIELDED_EMAIL_SELECT_RESERVED_EMAIL_SCREEN
  • ResourceId.SHIELDED_EMAIL_SETTINGS_SCREEN
  • ResourceId.SID_PASSWORD_MANAGER_NATIVE_NAVIGATION_SCREEN
  • ResourceId.SIGNED_OUT_AD_SETTINGS_SCREEN
  • ResourceId.SIGNED_OUT_CREATE_NEW_ACCOUNT_LINK_SCREEN
  • ResourceId.SIGNED_OUT_GOOGLE_ANALYTICS_SCREEN
  • ResourceId.SIGNED_OUT_LEARN_MORE_ABOUT_COOKIES_LINK_SCREEN
  • ResourceId.SIGNED_OUT_SEARCH_PERSONALIZATION_SCREEN
  • ResourceId.SIGNED_OUT_YOUTUBE_HISTORY_SCREEN
  • ResourceId.SIGNING_IN_TO_GOOGLE_INTRO_SCREEN
  • ResourceId.SECURITY_SIGNIN_SELFIE_VIDEO_SCREEN
  • ScreenId.PREFERENCES_STORAGE ResourceId.PREFERENCES_STORAGE_SCREEN MyAccountArea.STORAGE
  • ScreenId.PREFERENCES_MY_SUBSCRIPTIONS ResourceId.PREFERENCES_MY_SUBSCRIPTIONS_SCREEN MyAccountArea.SUBSCRIPTIONS
  • ResourceId.SUGGEST_IDEA_SCREEN
  • ResourceId.SUPPORT_SCREEN
  • ScreenId.PRIVACY_DOWNLOAD_YOUR_DATA ResourceId.PRIVACY_DOWNLOAD_YOUR_DATA_SCREEN MyAccountArea.TAKEOUT
  • No ScreenId ResourceId.TAKEOUT_DOWNLOADS
  • ScreenId.MISC_TERMS_OF_SERVICE ResourceId.TERMS_OF_SERVICE_SCREEN
  • ResourceId.SECURITY_THIRD_PARTY_MANAGEMENT_DETAILS_SCREEN
  • ResourceId.THIRD_PARTY_MANAGEMENT_LIST_SCREEN
  • ResourceId.SECURITY_THIRD_PARTY_MANAGEMENT_OVERVIEW_SCREEN
  • ResourceId.SECURITY_THIRD_PARTY_MANAGEMENT_SETTINGS_SCREEN
  • No ResourceId MyAccountArea.TITANIUM
  • No ResourceId MyAccountArea.TITANIUM
  • No ResourceId MyAccountArea.TITANIUM
  • No ResourceId MyAccountArea.TITANIUM
  • ResourceId.SECURITY_TITANIUM_UNENROLL_SCREEN MyAccountArea.TITANIUM
  • ResourceId.TWITTER_SUPPORT_SCREEN
  • ScreenId.SECURITY_TWO_STEP_VERIFICATION ResourceId.SECURITY_TWO_STEP_VERIFICATION_SCREEN MyAccountArea.TWO_FACTOR_AUTH
  • No ResourceId MyAccountArea.TWO_FACTOR_AUTH
  • No ResourceId MyAccountArea.TWO_FACTOR_AUTH
  • No ResourceId MyAccountArea.TWO_FACTOR_AUTH
  • No ResourceId MyAccountArea.TWO_FACTOR_AUTH
  • No ResourceId MyAccountArea.TWO_FACTOR_AUTH
  • No ResourceId MyAccountArea.TWO_FACTOR_AUTH
  • ResourceId.PREFERENCES_UNICORN_LITE_PROFILE_INPUT_TOOLS_SCREEN
  • ResourceId.PREFERENCES_UNICORN_LITE_PROFILE_LANGUAGE_SCREEN
  • ResourceId.UNICORN_LITE_PROFILE_WEB_PREFERENCES_SCREEN
  • ResourceId.UNIFIED_ONBOARDING_SCREEN
  • This value was added to the enum by mistake in cl/266426798. Removing this dummy enum constant will cause queries to the tables referencing this enum to fail. See b/143863448 for details.
  • ResourceId.USE_APP_WITHOUT_ACCOUNT_SCREEN
  • ResourceId.VIDEO_VERIFICATION_SCREEN
  • ResourceId.VIDEO_VERIFICATION_COLLECTION_SCREEN
  • ResourceId.WARM_WELCOME
  • No ResourceId
  • ResourceId.YOUTUBE_FAMILY_CENTER_SCREEN
typestring
linkMetadata
$refLinkMetadata
descriptionMetadata containing information about the link attached to ASMS resources.
productProfileMetadata
$refProductProfileMetadata
descriptionMetadata containing information about Product Profile resources.
resourceMetadata
$refResourceMetadata
descriptionMetadata containing information about ASMS resources
searchOneboxMetadata
$refSearchOneboxMetadata
descriptionAdditional VE logging metadata for the Onebox.
typeobject
HaTSSurvey
descriptionHaTS survey details.
idHaTSSurvey
properties
siteId
descriptionSite id of the survey
typestring
typeobject
Header
descriptionThe header shown in the SearchResult card.
idHeader
properties
displayEmail
descriptionThe users' display name, displayed underneath the display_name.
typestring
displayName
descriptionThe users' display name, displayed underneath the profile picture.
typestring
image
$refImage
descriptionOptional illustration to be shown instead of a personal header.
profilePictureImage
$refImage
descriptionThe users' profile picture.
visibilityInfoText
descriptionA informational text (containing also a link) explaining the limited visibiliy of the SearcResultCard.
typestring
typeobject
HelpCenterNavigationMetadata
descriptionAdditional information about navigation to the Help Center to distinguish between different articles
idHelpCenterNavigationMetadata
properties
articleId
descriptionIdentifier of the answer, e.g. https://support.google.com/accounts/answer/6304920
typestring
category
descriptionHelp center, e.g. "accounts" or "googlepay". For example https://support.google.com/accounts/answer/6304920
typestring
plink
descriptionShortcut for the article, e.g. https://support.google.com/families?p=noteligible_kid
typestring
topicId
descriptionTopic, e.g. https://support.google.com/families#topic=7327571
typestring
typeobject
HelpCenterSearchItem
descriptionSpecial search item shown below all results that links to a help center article for the entered query. Next id: 5
idHelpCenterSearchItem
properties
icon
$refImage
descriptionIcon shown on the right of the item, e.g. chevron icon.
image
$refImage
descriptionImage displayed on the left of the item.
target
$refTarget
descriptionItem target.
title
$refTitle
descriptionItem title.
typeobject
HelpInfo
deprecatedTrue
descriptionDEPRECATED Holds the data to open help for a specific screen. See go/mobilehelpguide Next Id: 3
idHelpInfo
properties
fallbackSupportUri
descriptionUrl to help center articles, which is used when contextual help is not available (e.g. Android pre-ICS).
typestring
helpCenterContext
descriptionThe helpcenterContext used for contextual help, can be empty on Android.
typestring
typeobject
HelpParams
descriptionused. Next Id: 5
idHelpParams
properties
androidFeedbackCategoryTag
descriptionThis field is used to map a specific category tag for Android feedback. Defaults to "com.google.android.gms.accountsettings.feedback"
typestring
androidPackageOverrideName
descriptionAllows overriding the default Android package name for IPH requests, enabling 1Ps to customize IPH flows. Defaults to "com.google.android.gms.accountsettings".
typestring
context
descriptionThis 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.
typestring
fallbackUrl
descriptionFallbackUrl 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"
typestring
iosFeedbackCategoryTag
descriptionThis field is used to map a specific category tag for iOS feedback. Defaults to "com.google.account.USER_INITIATED_FEEDBACK_REPORT"
typestring
iosPackageOverrideName
descriptionAllows overriding the default iOS package name for IPH requests, enabling 1Ps to customize IPH flows. Defaults to "com.google.accountsettings.ios".
typestring
themedUrl
$refThemedUrl
url
descriptionHelp Center article URL which can be opened with IPH (In Product Help)
typestring
typeobject
Icon
descriptionSpecifies an icon and its description to be rendered in screen element like a menu. Next Id: 3
idIcon
properties
contentDescription
descriptionOptional content description of the icon for better accessibility.
typestring
iconId
descriptionIcon 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.
formatint32
typeinteger
typeobject
Image
descriptionImage 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
idImage
properties
accessibilityLabel
descriptionLocalized accessibility label.
typestring
animatedThemedUrl
$refThemedUrl
descriptionA 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
$refImageUrls
descriptionURLs to images for all screen density buckets in dark theme. Optional, light_urls is used, when absent.
height
descriptionHeight of the image bounding box.
formatint32
typeinteger
imageId
descriptionClient-side placeholder image to use until URL has loaded.
formatint32
typeinteger
imageUrls
$refImageUrls
deprecatedTrue
descriptionURLs to images for all screen density buckets. Deprecated, use light_urls and dark_urls instead.
lightUrls
$refImageUrls
descriptionURLs to images for all screen density buckets in light theme.
themedUrl
$refThemedUrl
descriptionA 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
deprecatedTrue
descriptionThe 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.
typestring
width
descriptionWidth of the image bounding box.
formatint32
typeinteger
typeobject
ImageBlock
descriptionA block containing an image.
idImageBlock
properties
image
$refImage
descriptionImage.
typeobject
ImageUnit
descriptionImage unit
idImageUnit
properties
image
$refImage
descriptionImage
typeobject
ImageUrls
descriptionThis 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.
idImageUrls
properties
urlX1
descriptionThe URL of a PNG, GIF, JPEG, or BMP image.
typestring
urlX2
descriptionThe URL of the X2 version of the image.
typestring
urlX3
descriptionThe URL of the X3 version of the image.
typestring
urlX4
descriptionThe URL of the X4 version of the image.
typestring
typeobject
InitialSearchScreenComponents
descriptionData required to render the initial search screen. Next id: 5
idInitialSearchScreenComponents
properties
allowedPrecheckedResources
descriptionList of allowed (searchable) Screen ResourceKeys. By default this is a list of SearchItem targets (though it can contain different list of ResourceKeys)
items
$refResourceKey
typearray
searchItemsSections
descriptionList of items shown when no search terms are entered. The items are sorted by title.
items
$refSearchItemSection
typearray
typeobject
IntArray
descriptionAn int array
idIntArray
properties
values
descriptionvalues of int array
items
formatint32
typeinteger
typearray
typeobject
Item
descriptionA 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
idItem
properties
itemId
descriptionThe item's ID, unique within the scope of its section.
formatint32
typeinteger
mainScreenItem
$refMainScreenItem
descriptionSet if it is a main screen item having a title, subtitle, and an icon.
profilePictureItem
$refProfilePictureItem
descriptionSet if the item is a profile-picture menu item, having a title and subtitle and locally rendered profile picture.
profilePicturePromoItem
$refProfilePicturePromoItem
descriptionSet 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
$refPromoItem
descriptionSet if the item is a promo item, having a button in addition to the title and subtitle.
simpleItem
$refSimpleItem
descriptionSet if the item is a simple item, having a title and subtitle.
typeobject
JamMetadata
descriptionMetadata containing information about JAM associated with VE data
idJamMetadata
properties
jamPage
descriptionThe 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
typestring
typeobject
LeftNav
descriptionLeft navigation bar with buttons.
idLeftNav
properties
blocks
descriptionList of blocks.
items
$refLeftNavBlock
typearray
typeobject
LeftNavBlock
descriptionA building block of the left navigation.
idLeftNavBlock
properties
divider
$refLeftNavDivider
descriptionA horizontal divider.
item
$refLeftNavItem
descriptionA menu item.
typeobject
LeftNavDivider
descriptionA horizontal divider for the left navigation.
idLeftNavDivider
properties
typeobject
LeftNavItem
descriptionOne of the LeftNav buttons. Next id: 7
idLeftNavItem
properties
accessibilityLabel
descriptionA11y label attached to current item.
typestring
icon
$refImage
descriptionButton icon.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
selectedIcon
$refImage
descriptionButton icon to be displayed when the item is selected.
target
$refResourceKey
deprecatedTrue
descriptionThe target screen. DEPRECATED: Use link instead.
title
descriptionButton caption.
typestring
typeobject
LegendBlock
descriptionBlock to provide text definitions for image icons.
idLegendBlock
properties
legendItems
descriptionItems to be define within the legend.
items
$refLegendItem
typearray
typeobject
LegendItem
descriptionAn individual item within a legend block.
idLegendItem
properties
accessibilityLabel
descriptionAccessibility label for the legend item, used by screen readers instead of label.
typestring
delineator
descriptionSymbol between the icon and the label.
typestring
icon
$refImage
descriptionIcon to be defined.
label
descriptionLabel containing the definition of the icon.
typestring
stackFooterImage
$refImage
descriptionWhen 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.
typeobject
Link
descriptionEach 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.
idLink
properties
anchorParams
$refAnchorNavigationParams
descriptionParameters of the anchor navigation. Occurs on the target resource, if present, otherwise, on the current one.
ariaLabel
descriptionAria label for the link.
typestring
target
$refResourceKey
descriptionResourceKey of the target resource. If nil, navigation occurs on the same screen.
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the link.
typeobject
LinkMetadata
descriptionMetadata containing information about the link inside a visual element
idLinkMetadata
properties
targetResourceId
descriptionResourceId in ASMS: google/internal/identity/accountsettings/mobile/v1/resource_id.proto
formatint32
typeinteger
typeobject
ListItemBlock
descriptionA vertical list item block. Next id: 16
idListItemBlock
properties
descriptions
descriptionList of item descriptions.
items
typestring
typearray
icon
$refImage
descriptionicon shown on the right of the list item, e.g. chevron icon.
iconVerticalAlignment
deprecatedTrue
descriptionVertical alignment of chevron. See VerticalAlignment enum.
formatint32
typeinteger
image
$refImage
descriptionImage displayed on the left of the list item.
label
descriptionLabel of the list item.
typestring
preferredLayout
descriptionPreferred block layout. See BlockLayout enum.
formatint32
typeinteger
secondaryIcon
$refImage
descriptionSecondary icon shown on the right of the list item and to the left of the main icon, e.g. ACL icons.
specialDescription
$refSpecialDescription
descriptionSpecial description.
stackItemImage
$refImage
descriptionWhen 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
deprecatedTrue
descriptionText entries of the list item. Use label, titles, etc. instead.
items
$refStyledTextEntry
typearray
titles
descriptionList of item titles.
items
typestring
typearray
trailingImage
$refImage
descriptionWhen 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.
typeobject
ListPreviewUnit
descriptionscreen/BDheWvg6VHnWYmA
idListPreviewUnit
properties
items
descriptionList of images. Should respect the max number of visible items on the unit. This number is currently limited to 5.
items
$refImage
typearray
total
descriptionThe total number of items in the list.
formatint32
typeinteger
typeobject
LoadingCard
descriptionCard with a loading spinner on it.
idLoadingCard
properties
typeobject
Local
descriptionResource type used when the resource should be produced locally.
idLocal
properties
typeobject
LongArray
descriptionA long array
idLongArray
properties
values
descriptionvalues of long array
items
formatint64
typestring
typearray
typeobject
MainScreenItem
descriptionA menu item with title, subtitle, and icon. Android-only Next Id: 5
idMainScreenItem
properties
icon
$refIcon
descriptionOptional icon.
screenId
descriptionThe screen ID that should be requested when this menu item is tapped.
formatint32
typeinteger
subtitleText
descriptionOptional additional text, displayed in a smaller size and/or lighter color. Subtitles may contain explanatory text, or the current value of a setting.
typestring
titleText
descriptionThe main item text. Can be the name of a setting or group of settings.
typestring
typeobject
MenuAlternative
descriptionDisplays a screen as a native menu. Next Id: 6
idMenuAlternative
properties
hatsSurvey
$refHaTSSurvey
descriptionHaTS survey to be shown.
helpInfo
$refHelpInfo
descriptionThe data to open GoogleHelp
sections
descriptionThe sections that make up the menu's contents.
items
$refSection
typearray
showLogo
descriptionWhether or not to show the Google logo
typeboolean
titleText
descriptionThe title to display in the menu's app bar.
typestring
typeobject
MessageAlternative
descriptionDisplays 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
idMessageAlternative
properties
helpInfo
$refHelpInfo
deprecatedTrue
descriptionDEPRECATED The data to open GoogleHelp.
messageText
descriptionThe message to display. Required.
typestring
titleText
deprecatedTrue
descriptionDEPRECATED The title to display in the menu's app bar.
typestring
typeobject
NativeAlternative
descriptionDisplays a screen as a native setting. Next Id: 8
idNativeAlternative
properties
anchorNavigationParams
$refAnchorNavigationParams
descriptionContains the necessary information to scroll to particular place on the screen.
feedbackParams
$refFeedbackParams
descriptionContains the necessary information to launch the Feedback Client with the proper configuration.
helpParams
$refHelpParams
descriptionContains fields used for opening IPH (In Product Help)
nativeActionId
descriptionAn ID identifying the native setting. See NativeActionId for possible values. Required.
formatint32
typeinteger
profilePicturePickerParams
$refProfilePicturePickerParams
descriptionContains the necessary information to launch the profile picture picker.
typeobject
NativeCapabilities
descriptionThe 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.
idNativeCapabilities
properties
fauxbakeImageCropping
descriptionWhether the client supports the custom Fauxbake image cropping UI.
typeboolean
postGplusApiSunsetProfilePictureFlow
descriptionWhether the client supports a native profile picture flow that will continue to work after the go/gplus-1p-sunset.
typeboolean
typeobject
NativeNavigationAlternative
descriptionNavigates to a native screen from a web or webview screen. Will fallback to open an url in browser when not possible.
idNativeNavigationAlternative
properties
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
navigateBack
typeboolean
target
$refResourceKey
deprecatedTrue
descriptionTarget native screen. DEPRECATED: Use link instead.
url
descriptionFallback url for the native screen, will be opened when a native experience is not available.
typestring
typeobject
NavigationMetadata
descriptionAdditional information about the navigation
idNavigationMetadata
properties
dashboardMetadata
$refDashboardNavigationMetadata
descriptionAdditional information about navigations from Google Dashboard.
dashboardServiceMetadata
$refDashboardServiceCardOutboundNavigationMetadata
descriptionAdditional information about outbound navigations from service cards on Google Dashboard.
helpCenterMetadata
$refHelpCenterNavigationMetadata
descriptionAdditional information about navigation to the Help Center to distinguish between different articles
typeobject
OnboardingAlternative
deprecatedTrue
descriptionA screen with onboarding flow
idOnboardingAlternative
properties
onboardingFlow
$refOnboardingFlow
descriptionThe onboarding flow data.
onboardingFlowKey
$refResourceKey
deprecatedTrue
descriptionThe representation of the onboarding flow. DEPRECATED: use onboarding flow directly.
typeobject
OnboardingFlow
deprecatedTrue
descriptionA resource encapsulating multiple onboarding steps, an animation, and a button. Next Id: 8
idOnboardingFlow
properties
animationThemedUrl
$refThemedUrl
descriptionThe decorative Lottie animation urls for both themes. Required.
animationUrl
deprecatedTrue
descriptionThe decorative Lottie animation url. Deprecated, use animation_themed_url instead.
typestring
buttonTarget
$refResourceKey
deprecatedTrue
descriptionThe 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
descriptionThe text to be shown on the button that skips onboarding. e.g.: "Get started". Required.
typestring
dismissalId
descriptionAn identifier used to record which OnboardingFlows have been dismissed. Required.
formatint64
typestring
link
$refLink
descriptionThe 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
descriptionThe steps containing onboarding content. At least one is required.
items
$refOnboardingStep
typearray
typeobject
OnboardingStep
deprecatedTrue
descriptionDescribes the contents of an onboarding step. An OnboardingStep must contain at least a title or a message. Next Id: 6
idOnboardingStep
properties
exitAnimation
$refAnimationSegment
descriptionA segment of animation played once the skip button is clicked.
message
descriptionThe onboarding step message text.
typestring
stepId
descriptionA unique StepId used for logging. Required.
formatint32
typeinteger
title
descriptionThe onboarding step title text.
typestring
transitionAnimation
$refAnimationSegment
descriptionA 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.
typeobject
OneBoxBlock
descriptionBuilding block of a card Next id: 35
idOneBoxBlock
properties
actionChipBlock
$refActionChipBlock
descriptionAction Chip Block
actionLineBlock
$refActionLineBlock
descriptionNavigation Link Block
activityListItemBlock
$refActivityListItemBlock
descriptionList Item Block used for showing user activities.
collapsableBlock
$refCollapsableBlock
descriptionA block that can be collapsed
descriptionBlock
$refDescriptionBlock
descriptionDescription block
dividerBlock
$refDividerBlock
descriptionDivider Block
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
listItemBlock
$refListItemBlock
descriptionList Item Block
oneBoxSignedOutButtonsBlock
$refOneBoxSignedOutButtonsBlock
descriptionA block that consists of Sign in and Sign up buttons
oneboxCustomGwsBlock
$refOneboxCustomGwsBlock
descriptionA block that can be rendered using GWS.
oneboxDisclaimerBlock
$refOneboxDisclaimerBlock
descriptionDisclaimer block currently used in the Oneboxes.
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
typeobject
OneBoxSignedOutButtonsBlock
descriptionA block consisting of Sign in and Sign up buttons, used when Signed out.
idOneBoxSignedOutButtonsBlock
properties
signInLink
$refSignedOutBlockLink
descriptionLink that leads to the sing in page. Required.
signUpLink
$refSignedOutBlockLink
descriptionLink that leads to the sing up page. Required.
typeobject
OneGoogleCard
descriptionCard representing an entry in the OneGoogle Account Menu.
idOneGoogleCard
properties
actionChip
$refActionChip
descriptionA chip that allows users to take action on the card.
leadingImage
$refImage
descriptionAn image that may be shown at the leading edge of the card.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
priority
descriptionThe priority of the card. Can influence ordering and styling of the cards.
formatint32
typeinteger
progressBar
$refOneGoogleProgressBar
descriptionAn optional progress bar
subtitle
descriptionThe subtitle of the card.
typestring
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
title
descriptionThe main title of the card.
typestring
trailingImage
$refImage
descriptionAn image that may be shown at the trailing edge of the card.
typeobject
OneGoogleProgressBar
descriptionA 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).
idOneGoogleProgressBar
properties
color
$refColor
descriptionThe color of the progress bar.
description
descriptionAn optional description for the progress bar.
typestring
progress
descriptionThe progress of the progress bar. Should be between 0 and 1.
formatfloat
typenumber
typeobject
OneboxCustomGwsBlock
descriptionA block that can be rendered using GWS.
idOneboxCustomGwsBlock
properties
type
descriptionThe type of the custom block.
enum
  • UNKNOWN
  • SAFESEARCH
enumDescriptions
  • Unknown block type.
  • Safesearch block type.
typestring
typeobject
OneboxDisclaimerBlock
descriptionA block containing a disclaimer of some sort. Next id: 4
idOneboxDisclaimerBlock
properties
disclaimerContent
$refText
descriptionThe content of the disclaimer. Use this in favor of disclaimer_text.
disclaimerText
deprecatedTrue
descriptionThe text content of the disclaimer.
typestring
image
$refImage
descriptionOptional illustration shown near the disclaimer text.
typeobject
Placeholder
descriptionPlaceholder used when a resource hasn't loaded yet.
idPlaceholder
properties
typeobject
PlaceholderAlternative
descriptionPlaceholder for when a resource hasn't loaded yet.
idPlaceholderAlternative
properties
typeobject
PrefetchRelatedScreensRequest
descriptionRequest message for PrefetchRelatedScreens.
idPrefetchRelatedScreensRequest
properties
context
$refRequestContext
descriptionInformation sent with every request.
screenId
descriptionIdentifies the target screen. See ScreenId enum for possible values.
formatint32
typeinteger
screensToOmit
descriptionSpecify the screens to omit from the response. The server is allowed to ignore this option.
items
$refScreenToOmit
typearray
typeobject
PrefetchRelatedScreensResponse
descriptionResponse message for PrefetchRelatedScreens.
idPrefetchRelatedScreensResponse
properties
screens
descriptionThe returned screens.
items
$refScreen
typearray
typeobject
ProductProfileMetadata
descriptionMetadata containing information about Product Profile resources associated with the VE
idProductProfileMetadata
properties
productProfile
descriptionProduct 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
typestring
typeobject
ProfilePictureBlock
descriptionA special block containing a label, title, description, and a tappable profile picture to the right.
idProfilePictureBlock
properties
avatarAccessibilityTapText
descriptionTap action text read by a screen reader before the phrase "double-tap to activate" when focus moves to the profile picture image.
typestring
descriptionText
descriptionDescription text of the profile picture block.
typestring
label
descriptionLabel of the profile picture block.
typestring
link
$refLink
descriptionLink 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
descriptionPreferred block layout. See BlockLayout enum.
formatint32
typeinteger
profilePictureImage
$refImage
descriptionProfile picture image.
stackItemImage
$refImage
descriptionWhen 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
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource of the profile picture. DEPRECATED: Use link instead.
textEntries
deprecatedTrue
descriptionText entries of the profile picture block. Use label, title, etc. instead.
items
$refStyledTextEntry
typearray
title
descriptionTitle of the profile picture block.
typestring
typeobject
ProfilePictureItem
descriptionA menu item, with title and subtitle, renders profile picture locally. Next Id: 4
idProfilePictureItem
properties
screenId
descriptionThe screen ID that should be requested when this menu item is tapped.
formatint32
typeinteger
subtitleText
descriptionOptional additional text, displayed in a smaller size and/or lighter color. Subtitles may contain explanatory text, or the current value of a setting.
typestring
titleText
descriptionThe main item text. Can be the name of a setting or group of settings.
typestring
typeobject
ProfilePicturePickerParams
descriptionParams used when launching the profile picture picker. Next Id: 2
idProfilePicturePickerParams
properties
usePeopleApi
descriptionIf true, iOS client will use the People API to upload the photo.
typeboolean
typeobject
ProfilePicturePromoItem
descriptionA 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
idProfilePicturePromoItem
properties
buttonText
descriptionThe button text.
typestring
screenId
descriptionThe screen ID that should be requested when this menu item is tapped.
formatint32
typeinteger
subtitleText
descriptionOptional additional text, displayed in a smaller size and/or lighter color. Contains the user's primary email address.
typestring
titleText
descriptionThe main item text. Contains the user's display name.
typestring
typeobject
ProfilePictureUnit
descriptionscreen/8UcDB3nx9wRtoPg
idProfilePictureUnit
properties
accessibilityTapText
descriptionAccessibility label for the profile picture, used by screen readers.
typestring
typeobject
ProgressBar
descriptionProgress bar. Supports settings colors for progress and background and labeling these parts.
idProgressBar
properties
backgroundColor
$refColor
deprecatedTrue
descriptionColor of the not completed part of the progress bar. Deprecated. Use background_themed_color instead.
backgroundThemedColor
$refThemedColor
descriptionColor of the not completed part of the progress bar.
endLabelText
deprecatedTrue
descriptionText of the label on the ending (high) end of the progress bar
typestring
labelColor
$refColor
deprecatedTrue
descriptionColor of the text. Deprecated. Use label_themed_color instead.
labelIcon
$refImage
deprecatedTrue
descriptionIcon, 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
descriptionText shown below the progress bar
typestring
labelThemedColor
$refThemedColor
descriptionColor of the text.
progress
descriptionPercentage of the progressbar to be filled in a range of 0 - 1.
formatfloat
typenumber
progressColor
$refColor
deprecatedTrue
descriptionColor of the progressbar. Deprecated. Use progress_themed_color instead.
progressThemedColor
$refThemedColor
descriptionColor of the progress bar.
stackItemImage
$refImage
descriptionWhen 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
deprecatedTrue
descriptionText of the label on the starting (low) end of the progress bar
typestring
typeobject
ProgressBarBlock
descriptionA block containing styled text entries and a progress bar.
idProgressBarBlock
properties
progressBar
$refProgressBar
descriptionProgress bar.
textEntries
deprecatedTrue
descriptionText entries for the progress bar block. Shown above the progress bar.
items
$refStyledTextEntry
typearray
typeobject
ProgressBarListItemBlock
descriptionList item-like block that contains a progress bar
idProgressBarListItemBlock
properties
icon
$refImage
descriptionicon shown on the right of the list item, e.g. chevron icon.
image
$refImage
descriptionImage displayed on the left of the list item.
progressBar
$refProgressBar
descriptionProgress bar
title
descriptionItem title.
typestring
trailingImage
$refImage
descriptionWhen 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.
typeobject
ProgressBarUnit
descriptionscreen/9LsrL7URSifxp3G
idProgressBarUnit
properties
barBackgroundColor
$refThemedColor
descriptionThe color of the background.
barForegroundColor
$refThemedColor
descriptionThe color of the progress
labelText
descriptionLabel “1.5GB of 15GB used”
typestring
progress
descriptionProgress of the Bar
formatfloat
typenumber
typeobject
PromoItem
descriptionA promo with text, subtitle, icon and button. Only the button is a tappable. May be styled differently from a SimpleItem. Next Id: 7
idPromoItem
properties
buttonText
descriptionThe button text.
typestring
icon
$refIcon
descriptionOptional icon.
screenId
descriptionThe screen ID that should be requested when this menu item is tapped.
formatint32
typeinteger
statusText
descriptionOptional text, to display an additional status message (e.g. 'Last checked at...') in the promo.
typestring
subtitleText
descriptionOptional additional text, displayed in a smaller size and/or lighter color. Subtitles may contain explanatory text, or the current value of a setting.
typestring
titleText
descriptionThe main item text. Can be the name of a setting or group of settings.
typestring
typeobject
PromptBlock
descriptionBuilding block of a prompt card
idPromptBlock
properties
descriptionBlock
$refPromptDescriptionBlock
descriptionDescription Block
progressBlock
$refPromptProgressBarBlock
descriptionProgress Bar Block
typeobject
PromptCarouselCard
descriptionA horizontally scrolling carousel of prompt items.
idPromptCarouselCard
properties
items
deprecatedTrue
descriptionThe order of the items is the order they should appear in the UI. Deprecated, clients should expect prompt_item_keys instead.
items
$refPromptItem
typearray
maxVisibleItems
descriptionThe maximum number of items to show. If the number of items is greater than this number, the overflow item will be shown.
formatint32
typeinteger
overflowCollapseAccessibilityTapText
descriptionTap 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.
typestring
overflowCollapseTitle
descriptionThe title of the overflow item when the prompt items are expanded.
typestring
overflowExpandAccessibilityTapText
descriptionTap 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.
typestring
overflowExpandTitle
descriptionThe title of the overflow item when the prompt items are collapsed.
typestring
promptItemKeys
descriptionThe order of the prompt items is the order they should appear in the UI.
items
$refResourceKey
typearray
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the prompt carousel card.
typeobject
PromptDescriptionBlock
descriptionA block containing a title and descriptive text, with an image displayed on the left side optionally.
idPromptDescriptionBlock
properties
image
$refImage
deprecatedTrue
descriptionOptional 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
descriptionDescriptive text of the block.
typestring
title
descriptionTitle of the block.
typestring
typeobject
PromptItem
descriptionPrompt items for the user to be taken care of in a timely manner, e.g., updating their credit card. Next id: 17
idPromptItem
properties
adviceSeverity
descriptionSeverity of the prompt from the AdviceSeverity enum
formatint32
typeinteger
callToActionText
descriptionCall 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.
typestring
dismissible
descriptionDismisses the card on all user devices and surfaces.
typeboolean
equallyWeightedActionButtons
descriptionIf 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).
typeboolean
expandCardAccessibilityTapText
descriptionTap action text read by a screen reader instead of the default "double-tap to activate" when focus moves to the collapsed card.
typestring
hintText
descriptionText 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.
typestring
icon
$refImage
descriptionIcon to be shown on the advice card.
id
deprecatedTrue
descriptionPrompt 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.
formatint64
typestring
link
$refLink
descriptionLink 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
$refPromptBlock
descriptionMain content of the prompt card
secondaryButtonLink
$refLink
descriptionLink 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
descriptionSecondary call to action block If not specified, no secondary call to action button is shown.
typestring
severity
deprecatedTrue
descriptionSeverity 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.
formatint32
typeinteger
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource DEPRECATED: Use link instead.
title
descriptionPrompt card title
typestring
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the prompt card.
typeobject
PromptProgressBarBlock
descriptionA block containing a progress bar with a label underneath each end
idPromptProgressBarBlock
properties
endLabelText
deprecatedTrue
descriptionText of the label on the ending (high) end of the progress bar Deprecated, clients should use progress_bar instead.
typestring
progress
deprecatedTrue
descriptionPercentage of the progressbar to be filled in a range of 0 - 1. Deprecated, clients should use progress_bar instead.
formatfloat
typenumber
progressBar
$refProgressBar
descriptionProgress bar
progressColor
$refColor
deprecatedTrue
descriptionColor of the progressbar. Deprecated, clients should use progress_bar instead.
startLabelText
deprecatedTrue
descriptionText of the label on the starting (low) end of the progress bar Deprecated, clients should use progress_bar instead.
typestring
typeobject
RequestContext
descriptionInformation 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
idRequestContext
properties
callingAndroidApp
descriptionApplicationId (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
typestring
clientCapabilities
$refClientCapabilities
descriptionTells the server which features this version of the client supports.
clientVersions
$refClientVersions
descriptionVersion numbers for the client software.
googleAccountReferrer
descriptionSerialized GoogleAccountReferrer that provided by caller of Google Account as query param.
typestring
isAuto
descriptionWhether the device the request came from is an Auto device.
typeboolean
isDarkModeEnabled
deprecatedTrue
descriptionWhether 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.
typeboolean
isPayModuleAvailable
descriptionWhether the client has the pay gmscore module available (only relevant for Android clients).
typeboolean
isRtl
descriptionTells whether the client is currently displaying in RTL mode.
typeboolean
logicalScreenDensity
descriptionThe 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
formatint32
typeinteger
platform
descriptionThe 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.
typestring
timeZone
descriptionThe time zone of the user's device, as a Unix time zone ID. e.g. "Europe/Berlin".
typestring
usesAllImageUrls
descriptionWhen set to true ASMS will return image urls for all screen density buckets instead of one already optimized url.
typeboolean
typeobject
Resource
descriptionResources 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.
idResource
properties
accountMenuInformation
$refAccountMenuInformation
descriptionInformation provided to the OGL account menu.
bottomNav
$refBottomNav
descriptionBottom buttons navigation.
card
$refCard
descriptionCard.
cardDeck
$refCardDeck
descriptionSet of cards.
footer
$refFooter
descriptionFooter.
initialSearchScreenComponents
$refInitialSearchScreenComponents
descriptionComponents for initial search screen on mobile.
isDismissed
descriptionResource 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).
typeboolean
isStable
descriptionAffects 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.
typeboolean
leftNav
$refLeftNav
descriptionLeft navigation.
local
$refLocal
descriptionA resource that should be produced locally (i.e., on the target device).
onboardingFlow
$refOnboardingFlow
deprecatedTrue
descriptionOnboarding flow.
placeholder
$refPlaceholder
descriptionReserved for internal use by clients.
promptItem
$refPromptItem
descriptionPrompt Card.
resourceKey
$refResourceKey
descriptionIdentifies a resource.
screen
$refScreenResource
descriptionDescription of the screen structure.
searchCorpus
$refSearchCorpus
descriptionSearch data for all searchable items.
securityHubPromptItem
$refSecurityHubPromptItem
descriptionSecurity Hub Prompt Card.
simpleHeader
$refSimpleHeader
descriptionSimple header.
supportPanel
$refSupportPanel
descriptionSupport panel
topNav
$refTopNav
descriptionTop tabs bar.
welcomeHeader
$refWelcomeHeader
descriptionMain header.
welcomeScreenIntro
$refWelcomeScreenIntro
descriptionThe welcome screen intro shown on home page on web.
typeobject
ResourceKey
descriptionEach 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.
idResourceKey
properties
resourceId
descriptiona value from the ResourceId enum
formatint32
typeinteger
resourceParams
additionalProperties
typestring
descriptionkey-value map of request parameters
typeobject
typeobject
ResourceMetadata
descriptionMetadata containing information about ASMS resources associated with the VE go/my-google/asms#resources
idResourceMetadata
properties
jamMetadata
$refJamMetadata
descriptionMetadata for JAM specific pages
resourceId
descriptionResourceId in ASMS: google/internal/identity/accountsettings/mobile/v1/resource_id.proto
formatint32
typeinteger
typeobject
ResourceToOmit
descriptionA resource to omit from the results
idResourceToOmit
properties
resourceKey
$refResourceKey
descriptionIdentifies the Resource.
typeobject
Screen
descriptionScreens 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
idScreen
properties
alternatives
descriptionA list of alternatives, in order of preference.
items
$refAlternative
typearray
isStable
descriptionAffects 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.
typeboolean
screenId
descriptionThe screen's ID. See ScreenId for possible values.
formatint32
typeinteger
typeobject
ScreenIntro
descriptionFraming for the screen content. May contain an image, a title and a description.
idScreenIntro
properties
description
descriptionDescription text for the screen intro. May be omitted.
typestring
image
$refImage
descriptionImage for the screen intro. May be omitted.
link
$refLink
descriptionLink 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
deprecatedTrue
descriptionAccessibility label for the link, used by screen readers instead of link_text. DEPRECATED: Use link.aria_label instead.
typestring
linkIcon
$refImage
descriptionIcon to append after the link text.
linkTarget
$refResourceKey
deprecatedTrue
descriptionId of link destination resource. DEPRECATED: Use link instead.
linkText
descriptionDescription block link text.
typestring
title
descriptionTitle text for the screen intro. May be omitted.
typestring
typeobject
ScreenResource
descriptionA type of a resource. Similar to a Screen, a ScreenResource can represent a menu, a native setting, a message etc. Next Id: 3
idScreenResource
properties
alternatives
descriptionA list of alternatives, in order of preference.
items
$refAlternative
typearray
navigationMetadata
$refNavigationMetadata
descriptionAdditional information about the navigation
typeobject
ScreenToOmit
descriptionA screen to omit from the results
idScreenToOmit
properties
screenId
descriptionIdentifies the screen. See ScreenId enum for possible values.
formatint32
typeinteger
typeobject
SearchAlternative
descriptionA screen with a search box, search results, and bottom nav.
idSearchAlternative
properties
bottomNavKey
$refResourceKey
descriptionId of the bottom buttons bar.
bottomNavSelection
$refResourceKey
descriptionIdentifies 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
$refResourceKey
descriptionId of the initial search screen components.
searchBox
$refSearchBox
descriptionSearch box data.
searchCorpusKey
$refResourceKey
descriptionId of the search corpus.
typeobject
SearchBlock
descriptionAn in-page search bar. Next id: 0
idSearchBlock
properties
typeobject
SearchBox
descriptionSearch box data. Next id: 2
idSearchBox
properties
placeholderText
descriptionPlaceholder text if there is no query yet.
typestring
typeobject
SearchCorpus
descriptionData for all searchable items. Next id: 5
idSearchCorpus
properties
allowedPrecheckedResources
descriptionList of allowed (searchable) Screen ResourceKeys. By default this is a list of SearchItem targets (though it can contain different list of ResourceKeys)
items
$refResourceKey
typearray
helpCenterSearchItem
$refHelpCenterSearchItem
descriptionSpecial search item shown below all results that links to a help center article for the entered query.
noResultsImage
$refImage
descriptionImage to show if there are no results for the entered query.
searchItems
descriptionList of available items for search. The items are sorted by title.
items
$refSearchItem
typearray
typeobject
SearchItem
descriptionA searchable item. Next id: 8
idSearchItem
properties
description
descriptionItem description.
typestring
icon
$refImage
descriptionIcon shown on the right of the item, e.g. chevron icon.
image
$refImage
descriptionImage displayed on the left of the item.
keywords
descriptionList of keywords that can be used for matching, beside title and description. Each keyword can be a single word or a phrase.
items
typestring
typearray
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the tap event. Eventually should completely replace the `target` field.
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
title
descriptionItem title.
typestring
typeobject
SearchItemSection
descriptionMessage to represent a section of search items. Next id: 4
idSearchItemSection
properties
fallbackSearchItem
$refSearchItem
descriptionFallback 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
descriptionList of items shown when no search terms are entered. The items are sorted by title.
items
$refSearchItem
typearray
title
descriptionTitle of the section.
typestring
typeobject
SearchOneboxMetadata
descriptionMetadata containing information about Search Onebox resources associated with the VE.
idSearchOneboxMetadata
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.
typestring
typeobject
SearchQuery
descriptionUser defined query.
idSearchQuery
properties
query
descriptionRaw user defined query.
typestring
typeobject
SearchRequest
descriptionRequest message for Search
idSearchRequest
properties
allowedPrecheckedResources
descriptionList of allowed (searchable) Screen ResourceKeys.
items
$refResourceKey
typearray
context
$refRequestContext
descriptionInformation sent with every request.
resourcesToOmit
descriptionSpecify the screen resources to omit from the response. The server uses this field for optimization by not including omitted resources in additional_resources.
items
$refResourceToOmit
typearray
searchQuery
$refSearchQuery
descriptionUser defined query.
typeobject
SearchResponse
descriptionResponse message for Search.
idSearchResponse
properties
additionalResources
descriptionAdditional resources that the client should cache.
items
$refResource
typearray
helpCenterSearchItem
$refHelpCenterSearchItem
deprecatedTrue
descriptionSpecial search item shown below all results that links to a help center search result page for the entered query.
searchItemSections
descriptionSearch item sections for Help Center results.
items
$refSearchItemSection
typearray
searchItems
deprecatedTrue
descriptionSearch items.
items
$refSearchItem
typearray
typeobject
SearchResultCard
descriptionCard presenting the result to query on Google Search. Next id: 8
idSearchResultCard
properties
answerBlock
$refOneBoxBlock
descriptionAn answer block
contentBlocks
descriptionThe content blocks following the general answer.
items
$refOneBoxBlock
typearray
header
$refHeader
descriptionThe header shown in the SearchResult card.
showInMainColumnOnDesktop
descriptionWhether 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.
typeboolean
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the Onebox.
typeobject
Section
descriptionA 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
idSection
properties
items
descriptionThe menu items in this section.
items
$refItem
typearray
sectionId
descriptionThe section's ID, unique within the scope of its menu.
formatint32
typeinteger
titleText
descriptionOptional section title.
typestring
typeobject
SecurityHubButton
descriptionButton to be shown in a warning card.
idSecurityHubButton
properties
label
descriptionThe text label for the button.
typestring
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
typeobject
SecurityHubPromptCarouselCard
descriptionA horizontally scrolling carousel of prompt items for the SecurityHub.
idSecurityHubPromptCarouselCard
properties
promptItemKeys
descriptionThe order of the prompt items is the order they should appear in the UI.
items
$refResourceKey
typearray
typeobject
SecurityHubPromptItem
descriptionPrompt items on the Security Hub for the user to be taken care of in a timely manner.
idSecurityHubPromptItem
properties
adviceTypes
descriptionThe types of Security Advisor advices that contributed to the overall severity.
items
enum
  • UNKNOWN
  • DEVICES_INACTIVE_DEVICE
  • DEVICES_WITHOUT_SCREEN_LOCK
  • DEVICES_PLAY_PROTECT_DISABLED
  • DEVICES_HARMFUL_APPS_DETECTED
  • DEVICES_NO_HARMFUL_APPS_DETECTED
  • APPS_HIGH_RISK_APP
  • APPS_DISABLE_LESS_SECURE_APPS
  • APPS_REMOVE_SPECIFIC_PASSWORD
  • TSV_ADD_BACKUP_PHONE
  • TSV_ADD_PAASK
  • RECOVERY_OPTIONS_ADD_PHONE_OR_EMAIL
  • RECOVERY_OPTIONS_ADD_RESCUE_CODE
  • RECOVERY_OPTIONS_ADD_EMAIL
  • RECOVERY_OPTIONS_FIX_EMAIL
  • RECOVERY_OPTIONS_VERIFY_PHONE
  • RECOVERY_OPTIONS_VERIFY_EMAIL
  • RECOVERY_OPTIONS_CONFIRM_PHONE
  • RECOVERY_OPTIONS_CONFIRM_EMAIL
  • RECOVERY_OPTIONS_ENROLL_IN_2SV
  • RECENT_ACTIVITY_CRITICAL_EVENT
  • GMAIL_SETTINGS_REMOVE_DELEGATE_ADDRESSES
  • GMAIL_SETTINGS_REMOVE_FORWARDING_ADDRESSES
  • ENROLL_IN_TITANIUM
  • TITANIUM_HIGH_PERSONAL_RISK
  • SAVED_PASSWORDS_BREACHED_PASSWORDS_DETECTED
  • SAVED_PASSWORDS_SAVED_PASSWORDS_SUMMARY
  • SAFE_BROWSING_ENROLL_IN_ENHANCED_SAFE_BROWSING
  • EMAIL_ADDRESS_ON_DARK_WEB_DETECTED
  • REVIEW_EMAIL_ADDRESS_ON_DARK_WEB
  • ACTIVATE_DARK_WEB_MONITORING
  • REVIEW_DARK_WEB_REPORT
  • SET_UP_INACTIVE_ACCOUNT_PLAN
  • REVIEW_LOCATION_SHARING
  • REVIEW_FACE_GROUPING
  • SET_RETENTION_WAA
  • SET_RETENTION_LH
  • SET_RETENTION_YTH
  • REVIEW_ADS_SETTINGS
  • LOCATION_HISTORY
  • WEB_AND_APP_ACTIVITY
  • YOUTUBE_HISTORY
  • YOUTUBE_SHARING
  • PHONE_SETTINGS
  • THIRD_PARTY_APPS_ACCESS
  • ABOUT_ME
  • LINKED_SERVICES
  • PASSWORD_MANAGER_PROMPT
  • SECURITY_ADVISOR_PROMPT
  • SAFER_INTERNET_DAY_HOME_PROMPT
  • STORAGE_EXHAUSTED_CRITICAL_PROMPT
  • STORAGE_EXHAUSTED_SEVERE_PROMPT
  • STORAGE_EXHAUSTED_WARNING_PROMPT
  • TEST_PROMPT
  • SAFER_WITH_GOOGLE_PROMPT
  • CAM_GOOGLE_PROMPT
  • TWO_STEP_VERIFICATION_PROMPT
  • MINOR_MODE_EXIT_PROMPT
  • CLP_TEST_PROMPT
  • CLP_SECURITY_ADVISOR_PROMPT
  • CLP_ADD_RECOVERY_PHONE_PROMPT
  • CLP_ADD_RECOVERY_PHONE_BENTO_VARIANT_PROMPT
  • CLP_ADD_SECONDARY_RECOVERY_OPTION_PROMPT
  • CLP_ADD_HOME_ADDRESS_PROMPT
  • ADD_RECOVERY_PHONE_PROMPT
  • ADD_SECONDARY_RECOVERY_OPTION_PROMPT
  • MANAGE_RECOVERY_OPTION_PROMPT
  • ADD_HOME_ADDRESS_PROMPT
  • PAYMENTS_PROMPT
  • PAYMENTS_ADD_FOP_PROMPT
  • PAYMENTS_SANCTIONS_PARTIAL_SUSPENSION_FIXFLOW_PROMPT
  • PAYMENTS_SANCTIONS_PARTIAL_SUSPENSION_HC_PROMPT
  • PAYMENTS_SANCTIONS_SUSPENSION_FIXFLOW_PROMPT
  • PAYMENTS_SANCTIONS_SUSPENSION_HC_PROMPT
  • PAYMENTS_SANCTIONS_CONFIRMED_PROMPT
  • PAYMENTS_SANCTIONS_ADHOC_PROMPT
  • PAYMENTS_SANCTIONS_CRIMEA_PROMPT
  • PAYMENTS_SANCTIONS_VERIFICATION_INPROGRESS_PROMPT
  • PAYMENTS_CUSTOMER_OR_INSTRUMENT_RISK_VERIFICATION_PROMPT
  • PAYMENTS_FUNDS_GUARANTEE_INSTRUMENT_DECLINED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_MISSING_PAYMENT_METHOD_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_CARD_CLOSED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_CARD_EXPIRED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_CARD_PAYMENT_DECLINED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_GENERIC_RISK_SUSPENDED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_BANK_NOT_VERIFIED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_BANK_PAYMENT_DECLINED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_GENERIC_PAYMENT_DECLINED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_BANK_NEED_MANDATE_ACCEPTANCE_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_BANK_TERMS_AND_CONDITIONS_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_CARD_EXPIRING_SOON_PROMPT
  • PAYMENTS_INSTRUMENT_BANK_NOT_VERIFIED_PROMPT
  • PAYMENTS_INSTRUMENT_CARD_EXPIRED_PROMPT
  • VERIFY_AGE_PROMPT
enumDeprecated
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • True
  • True
  • True
  • True
  • True
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
enumDescriptions
  • Unmapped or unspecified advice type.
  • Inactive device advice.
  • Add screen lock advice.
  • Play Protect disabled.
  • Harmul apps found by Play Protect.
  • No harmul apps found by Play Protect.
  • High-risk app advice.
  • Disable less secure apps advice.
  • Remove app-specific password advice.
  • Add backup phone advice.
  • Advice for adding Phone-as-a-security-key.
  • Add recovery phone or recovery email advice.
  • Add rescue code advice.
  • Add recovery email advice.
  • Fix recovery email advice.
  • Verify recovery phone advice.
  • Verify recovery email advice.
  • Recovery phone freshness advice.
  • Recovery email freshness advice.
  • Enroll in 2SV for SbD users. go/sbd-site
  • Review critical event.
  • Remove account delegates advice.
  • Remove forwarding addresses advice.
  • --------------------------------------------------------------------------- Titanium/AdvancedProtection step types (6001 - 6999) Next Titanium id: 6003 Enroll in Titanium
  • Advice for high personal risk users to enroll in Titanium.
  • --------------------------------------------------------------------------- Saved passwords step types (9001 - 9999) Next Saved passwords id: 9003 Breached passwords detected advice.
  • Saved passwords summary advice.
  • Enroll in Enhanced Safe Browsing advice.
  • Non-member primary email address is found the dark web.
  • Non-member email breach scan summary.
  • Recommends activating G1 Dark Web Report.
  • Recommends reviewing G1 Dark Web Report.
  • Suggestion to set up inactive account plan.
  • Suggestion to review Location Sharing.
  • Suggestion to review the Google Photos Face grouping setting.
  • Suggestion to set retention for Web & App Activity.
  • Suggestion to set retention for Location History.
  • Suggestion to set retention for Youtube History.
  • Suggestion to review Ads settings.
  • Suggestion to review location history setting.
  • Suggestion to review WAA setting.
  • Suggestion to review youtube history setting.
  • Suggestion to review youtube sharing setting.
  • Suggestion to review phone settings.
  • Suggestion to review third party apps access.
  • Suggestion to review About Me view and shared endorsements.
  • Suggestion to review whether a user's DMA services are linked or not.
  • Prompt card that advertises password manager.
  • Prompt card that is shown on red state of the security advisor.
  • Prompt card that advertises Google Account Safer Internetday page.
  • Prompt card that is shown if 100% of storage capacity is used.
  • Prompt card that is shown if 90-99.99% of storage capacity is used.
  • Prompt card that is shown if 85-89.99% of storage capacity is used.
  • Test card that is enabled only for prompt-cards-test-group & prompt-cards-test-group-external
  • Prompt card that advertises Safer with Google page.
  • Prompt card that advertises Cybersecurity Awareness month page.
  • Prompt card leading to g.co/2SV.
  • Prompt card used as entry point for the Minor Mode Exit flow.
  • Test prompt card for the Google Settings screen.
  • CLP variant of SECURITY_ADVISOR_PROMPT (red state).
  • CLP variant of ADD_RECOVERY_PHONE_PROMPT.
  • CLP variant of ADD_RECOVERY_PHONE_PROMPT with Bento content.
  • CLP variant of ADD_SECONDARY_RECOVERY_OPTION_PROMPT.
  • CLP variant of ADD_HOME_ADDRESS_PROMPT.
  • Add recovery phone prompt for Google Account recovery options prompts
  • Add secondary recovery option prompt for Google Account recovery options prompts
  • Manage recovery option prompt for Google Account recovery options prompts
  • Add home address prompt card.
  • Prompt cards for alerts from payments API.
  • Prompt card for the Add Fop alert from payments API.
  • Prompt card for the Sanctions partial suspension alert from payments API with fixflow.
  • Prompt card for the Sanctions partial suspension alert from payments API with HC article.
  • Prompt card for the Sanctions suspension alert from payments API with fixflow.
  • Prompt card for the Sanctions suspension alert from payments API with HC article.
  • Prompt card for the Sanctions confirmed alert from payments API with ToS HC article.
  • Prompt card for the Sanctions adhoc alert from payments API.
  • Prompt card for the Sanctions Crimea alert from payments API with ToS HC article.
  • Prompt card for the Sanctions verification in progress alert from payments API.
  • Prompt card for the customer or instrument risk verification alert from payments API.
  • Prompt card for the funds guarantee instrument declined alert from payments API.
  • Prompt card for the billing account missing payment method alert from payments API.
  • Prompt card for the billing account card closed alert from payments API.
  • Prompt card for the billing account card expired alert from payments API.
  • Prompt card for the billing account card payment declined alert from payments API.
  • Prompt card for the billing account generic instrument risk suspended alert from payments API.
  • Prompt card for the billing account bank not verified alert from payments API.
  • Prompt card for the billing account bank payment declined alert from payments API.
  • Prompt card for the billing account payment has generic paymentdeclined alert from payments API.
  • Prompt card for the billing account bank need mandate acceptance alert from payments API.
  • Prompt card for the billing account terms and conditions alert from payments API.
  • Prompt card for the billing account card expiring soon alert from payments API.
  • Prompt card for the instrument account bank not verified alert from payments API.
  • Prompt card for the instrument card expired alert from payments API.
  • Add age verification prompt card.
typestring
typearray
body
descriptionThe body shown in the warning card.
typestring
primaryButton
$refSecurityHubButton
descriptionThe 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
descriptionThe 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.
typestring
title
descriptionThe title shown in the warning card. Required
typestring
typeobject
SegmentHeaderCard
descriptionA segment header
idSegmentHeaderCard
properties
descriptionText
descriptionLocalized description text.
typestring
image
$refImage
descriptionThe image is displayed to the right of the text for one-column layout
largeImage
$refImage
descriptionThe image is displayed to the right of the text for two-column layout
linkAccessibilityLabel
deprecatedTrue
descriptionAccessibility label for the link, used by screen readers instead of link_text. DEPRECATED: Use link_target_link.aria_label instead.
typestring
linkIcon
$refImage
descriptionIcon to append after the link text.
linkTargetLink
$refLink
descriptionLink 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
descriptionLocalized text of optional link shown at the end of the description (e.g. "learn more").
typestring
title
descriptionTitle for the section.
typestring
typeobject
SetResourceDismissalStateRequest
descriptionRequest message for SetResourceDismissalState.
idSetResourceDismissalStateRequest
properties
context
$refRequestContext
descriptionInformation sent with every request.
resourceDismissalState
descriptionNew 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
typestring
resourceKey
$refResourceKey
descriptionResource key which needs to be updated.
typeobject
SetResourceDismissalStateResponse
descriptionResponse message for SetResourceDismissalState.
idSetResourceDismissalStateResponse
properties
additionalResources
descriptionAdditional resources that are related to the modified resource the client should cache.
items
$refResource
typearray
resource
$refResource
descriptionResource for which dismissal state was modified.
typeobject
ShortArray
descriptionA short array
idShortArray
properties
values
descriptionvalues of short array int16 scale
items
formatint32
typeinteger
typearray
typeobject
SignInBlock
descriptionA block containing a CTA to sign in, including optional illustration and description. Next id: 10
idSignInBlock
properties
additionalParagraphs
descriptionThe additional paragraphs shown below the CTA button.
items
$refAdditionalParagraph
typearray
buttonTarget
$refResourceKey
deprecatedTrue
descriptionOptional target for the CTA button. DEPRECATED: Use link instead.
description
descriptionDescription of the sign in block. Shown above the CTA button.
typestring
descriptionParagraphs
descriptionThe additional paragraphs describing the page shown above the CTA button.
items
$refAdditionalParagraph
typearray
image
$refImage
descriptionOptional image to be displayed in the sign in block on small screens.
largeImage
$refImage
descriptionOptional image to be displayed in the sign in block on large screens instead of the small image.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `button_target` field.
signInCtaText
descriptionText on the sign in CTA button.
typestring
title
descriptionThe title of the sign in block. Shown under the image.
typestring
typeobject
SignedOutBlockLink
descriptionMessage for a link in the SignedOutButtonsBlock.
idSignedOutBlockLink
properties
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
target
$refResourceKey
deprecatedTrue
descriptionLink target for the CTA. Required. DEPRECATED: Use link instead.
text
descriptionText on the link CTA. Required.
typestring
typeobject
SimpleHeader
descriptionMy Google simple header with action items.
idSimpleHeader
properties
actionItems
descriptionAction items to show on the top of the header area.
items
$refActionItem
typearray
title
descriptionThe title text to be displayed.
typestring
typeobject
SimpleItem
descriptionA simple menu item, with title and subtitle. Next Id: 4
idSimpleItem
properties
screenId
descriptionThe screen ID that should be requested when this menu item is tapped.
formatint32
typeinteger
subtitleText
descriptionOptional additional text, displayed in a smaller size and/or lighter color. Subtitles may contain explanatory text, or the current value of a setting.
typestring
titleText
descriptionThe main item text. Can be the name of a setting or group of settings.
typestring
typeobject
SpecialDescription
descriptionA special description block containing an icon, and text of a custom color.
idSpecialDescription
properties
color
$refColor
deprecatedTrue
descriptionDescription color. Deprecated. Use themed_color instead.
icon
$refImage
descriptionDescription icon.
stateChipUnit
$refStateChipUnit
descriptionThe 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
descriptionDescription text.
typestring
themedColor
$refThemedColor
descriptionDescription color.
typeobject
Stack
descriptionA stack of zero or more StackItems & StackFooters. screen/7i7pzGTANcvyDn8
idStack
properties
footers
descriptionZero or more StackFooter at the bottom of the stack. screen/5psKAHrTqdCMTts
items
$refStackFooter
typearray
infoOnly
descriptionIndicates whether the stack is info only. An info only stack is not tappable, the items do not have a link and is rendered differently.
typeboolean
items
descriptionZero or more StackItem at the top of the stack. screen/oRyFdxeMdxCWDWs.
items
$refStackItem
typearray
typeobject
StackFooter
descriptionFooter of the stack - screen/5psKAHrTqdCMTts
idStackFooter
properties
contentUnits
descriptionContent units of the footer.
items
$refStackFooterContentUnit
typearray
description
descriptionDescription of the footer.
typestring
hyperlink
$refLink
descriptionLink of the hyperlink_text.
hyperlinkText
descriptionHyperlink text/label of the footer displayed after the description.
typestring
image
$refImage
descriptionImage placed on the left side of the footer.
trailingUnits
descriptionTrailing units of the footer.
items
$refStackFooterTrailingUnit
typearray
typeobject
StackFooterContentUnit
descriptionContent unit of the footer
idStackFooterContentUnit
properties
actionChipsUnit
$refActionChipsUnit
descriptionscreen/82c8fpyatXbybbe
typeobject
StackFooterTrailingUnit
descriptionTrailing unit of the footer
idStackFooterTrailingUnit
properties
imageUnit
$refImageUnit
descriptionscreen/6Bi4EhgcFY2drWP
typeobject
StackItem
descriptionStack item - screen/3RAFcZbV7vh3U6c.
idStackItem
properties
contentUnits
descriptionContent units of the item.
items
$refStackItemContentUnit
typearray
description
descriptionDescription of the item.
typestring
image
$refImage
descriptionImage placed on the left side of the item.
link
$refLink
descriptionLink of the item.
title
descriptionTitle of the item.
typestring
trailingUnits
descriptionTrailing units of the item.
items
$refStackItemTrailingUnit
typearray
typeobject
StackItemContentUnit
descriptionContent unit of the stack item screen/5GZv5iNqquGsPSU
idStackItemContentUnit
properties
attributesUnit
$refAttributesUnit
descriptionscreen/8vM3aFoKwwLD7FN
listPreviewUnit
$refListPreviewUnit
descriptionscreen/BDheWvg6VHnWYmA
progressBarUnit
$refProgressBarUnit
descriptionscreen/9LsrL7URSifxp3G
stateChipUnit
$refStateChipUnit
descriptionscreen/7pKYihngrugyLqg
typeobject
StackItemTrailingUnit
descriptionTrailing unit of the stack item screen/6skuPGfowwQkurH
idStackItemTrailingUnit
properties
expansionUnit
$refExpansionUnit
descriptionscreen/9fYD3c8gNSJH6Aj
imageUnit
$refImageUnit
descriptionscreen/A333or6Vw6tZcxf
profilePictureUnit
$refProfilePictureUnit
descriptionscreen/8UcDB3nx9wRtoPg
stateChipUnit
$refStateChipUnit
descriptionscreen/7EBeXzYEArApyVZ
typeobject
StateChipUnit
descriptionscreen/7pKYihngrugyLqg & screen/7EBeXzYEArApyVZ
idStateChipUnit
properties
backgroundColor
$refThemedColor
descriptionColor to tint the background and serve as container for Icon and Label. TODO(b/397607598)
icon
$refImage
descriptionIcon of the chip
label
descriptionLabel of the chip
typestring
labelColor
$refThemedColor
descriptionColor to tint label
typeobject
StringArray
descriptionA string array
idStringArray
properties
values
descriptionvalues of string array
items
typestring
typearray
typeobject
StyledTextEntry
descriptionStyled text entry. Supports colored text, drawing one icon to the left and different styles, defined by client.
idStyledTextEntry
properties
color
$refColor
deprecatedTrue
descriptionColor of the text. Deprecated. Use themed_color instead.
icon
$refImage
descriptionIcon, shown to the left of the text. Center-aligned vertically.
style
descriptionStyle 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.
typestring
text
descriptionText.
typestring
themedColor
$refThemedColor
descriptionColor of the text.
truncation
$refTextTruncation
descriptionTruncation logic used for the text.
typeobject
SummaryCard
descriptionCard presenting one or more settings. Next id: 10
idSummaryCard
properties
blocks
descriptionAt least one block must be present. Clients will ignore blocks that they don't understand.
items
$refBlock
typearray
borderless
descriptionWhether to disable drawing border for the card
typeboolean
disableHorizontalPadding
descriptionWarning: this is not implemented on native is likely temporary.
typeboolean
infoOnly
descriptionIndicates 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.
typeboolean
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
preferredSize
descriptionThe preferred size of the card. See CardPreferredSize enum.
formatint32
typeinteger
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the summary card.
typeobject
SupportAlternative
descriptionSupport related alternative, like support panel and support screen.
idSupportAlternative
properties
typeobject
SupportPanel
descriptionA panel with cards and intro. Next Id: 4
idSupportPanel
properties
deckKey
$refResourceKey
descriptionId of the deck of cards displayed in support panel.
screenIntro
$refScreenIntro
descriptionIntro displayed just before the cards.
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the support panel.
typeobject
SupportedAlternativeType
descriptionA supported alternative.
idSupportedAlternativeType
properties
alternativeType
descriptionThe alternative type. See AlternativeType for possible values.
formatint32
typeinteger
typeobject
SupportedAndroidIntentCheck
descriptionAndroid intent checks supported by the client
idSupportedAndroidIntentCheck
properties
androidIntentCheck
descriptionList 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.
typestring
typeobject
SupportedIcon
descriptionA supported icon.
idSupportedIcon
properties
iconId
descriptionThe icon ID. See IconId for possible values.
formatint32
typeinteger
typeobject
SupportedItemType
descriptionA supported item type.
idSupportedItemType
properties
itemType
descriptionThe item type. See ItemType for possible values.
formatint32
typeinteger
typeobject
SupportedNativeAction
descriptionA supported native action.
idSupportedNativeAction
properties
nativeActionId
descriptionThe native action's ID. See NativeActionId for possible values.
formatint32
typeinteger
typeobject
SupportedOfflineScreen
descriptionA supported offline screen.
idSupportedOfflineScreen
properties
screenId
descriptionRequired
formatint32
typeinteger
version
descriptionOptional. If omitted, version 1 is assumed.
formatint32
typeinteger
typeobject
Target
descriptionItem link target. Next id: 5
idTarget
properties
queryPlaceholder
descriptionThe placeholder text in url_with_query_placeholder which should be replaced by the search query.
typestring
resourceId
descriptionTarget resource_id. Used for logging.
formatint32
typeinteger
themedUrlWithQueryPlaceholder
$refThemedUrl
descriptionDestination help center URLs for both light and dark themes. Contain a placeholder string which should be replaced by the URL-encoded search query.
urlWithQueryPlaceholder
descriptionDestination help center URL. Contains a placeholder string which should be replaced by the URL-encoded search query.
typestring
typeobject
Text
descriptionThis message represents the a text that consists of multiple items. Items can be either plain text or links.
idText
properties
textItems
descriptionList or text items.
items
$refTextItem
typearray
typeobject
TextItem
descriptionThis message represents one text item in the entire text. It should be rendered like this: $text if target is present, otherwise — as text.
idTextItem
properties
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
target
$refResourceKey
deprecatedTrue
descriptionThe id of the target resource. DEPRECATED: Use link instead.
text
descriptionText to display. required
typestring
typeobject
TextTruncation
descriptionText truncation.
idTextTruncation
properties
numberOfLines
descriptionNumber of lines after which truncation happens. 0 means no truncation.
formatint32
typeinteger
typeobject
ThemedColor
descriptionWrapper around Colors for specific themes / user interface styles. Next id: 3
idThemedColor
properties
dark
$refColor
descriptionThe color for dark theme. Required.
light
$refColor
descriptionThe color for light theme. Required.
typeobject
ThemedUrl
descriptionWrapper around URLs for specific themes / user interface styles. Next id: 3
idThemedUrl
properties
dark
descriptionThe URL for a dark theme / user interface style.
typestring
light
descriptionThe 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.
typestring
typeobject
Title
descriptionItem title. Next id: 3
idTitle
properties
queryPlaceholder
descriptionThe placeholder text in title_with_placeholder which should be replaced by the search query.
typestring
textWithQueryPlaceholder
descriptionItem title. Contains a placeholder string which should be replaced by the search query.
typestring
typeobject
TopNav
descriptionTop navigation bar with tabs.
idTopNav
properties
tabs
descriptionList of tabs.
items
$refTopTab
typearray
typeobject
TopTab
descriptionOne of the TopNav tabs.
idTopTab
properties
icon
$refImage
descriptionIcon (default version) to be displayed next to the tab title in the dropdown version of the menu.
link
$refLink
descriptionLink to the screen that should be displayed when the tab becomes active. Only supports the link target and no other link parameters.
selectedIcon
$refImage
descriptionIcon (hovered/selected version) to be displayed next to the tab title in the dropdown version of the menu.
target
$refResourceKey
deprecatedTrue
descriptionTarget screen of the tab. DEPRECATED: Use link instead.
title
descriptionTab title.
typestring
typeobject
TwoColumnTableBlock
descriptionA block to show a list of image - description pairs in tabular form where images and descriptions are aligned in separate columns.
idTwoColumnTableBlock
properties
rows
descriptionList of rows to populate the TwoColumnTableBlock.
items
$refTwoColumnTableRow
typearray
typeobject
TwoColumnTableRow
descriptionData row to populate the TwoColumnTableBlock.
idTwoColumnTableRow
properties
descriptions
descriptionList of descriptions, each of which is printed on a new line.
items
typestring
typearray
image
$refImage
descriptionOptional image for the table row.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
typeobject
WebviewAlternative
descriptionDisplays a screen by opening an URL in a WebView. Next Id: 3
idWebviewAlternative
properties
themedUrl
$refThemedUrl
descriptionThe set of theme-dependent URLs to open. One of url or themed_url required.
url
descriptionThe URL to open. One of url or themed_url required.
typestring
typeobject
WebviewCapabilities
descriptionThe 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
idWebviewCapabilities
properties
obakeWeb
descriptionWhether the client supports all changes necessary to work with Obake web.
typeboolean
passkey
descriptionWhether the client supports passkey-based auth in Octarine. iOS only.
typeboolean
securityKey
descriptionWhether the client supports security key authentication.
typeboolean
telephony
descriptionWhether the client supports the telephony JS bridge.
typeboolean
termsAndPolicyPages
descriptionWhether the client supports opening the PP and ToS pages in Octarine.
typeboolean
trustAgent
descriptionWhether the client supports the trust agent JS bridge.
typeboolean
typeobject
WelcomeHeader
descriptionMy Google header with user name and avatar.
idWelcomeHeader
properties
actionItems
descriptionAction items to show on the top of the header area.
items
$refActionItem
typearray
avatarAccessibilityTapText
descriptionTap action text read by a screen reader after the phrase "double-tap to .." when focus moves to the avatar.
typestring
chip
$refActionChip
deprecatedTrue
descriptionUsed for displaying link to launch Google Account from contextual landing page. DEPRECATED: chip is no longer supported in the welcome header.
link
$refLink
descriptionLink 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
descriptionUser's name as displayed in the header.
typestring
showProductLockup
descriptionControls showing the product view in the header area.
typeboolean
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource of the avatar. DEPRECATED: Use link instead.
title
descriptionTitle text to show in the header area.
typestring
welcomeText
descriptionHeader welcome text (e.g. 'Welcome, Janelle').
typestring
typeobject
WelcomeScreenIntro
descriptionMy Google header with user name, profile picture, and welcome message. Next id: 17
idWelcomeScreenIntro
properties
additionalDescription
$refAdditionalDescription
descriptionThe additional description for some account types.
description
descriptionThe welcome message to the user (e.g. 'You're in control...').
typestring
displayName
descriptionThe user's name to display. Currently only in use for Android, taking precedence over the `title` field.
typestring
isGoogleOneMember
descriptionWhether the user is a Google One member.
typeboolean
link
$refLink
descriptionLink 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
deprecatedTrue
descriptionAccessibility label for the link that appears after the description, used by screen readers instead of link_text. DEPRECATED: Use link.aria_label instead.
typestring
linkIcon
$refImage
descriptionIcon to append after the link text.
linkTarget
$refResourceKey
deprecatedTrue
descriptionTarget resource for the link. DEPRECATED: Use link instead.
linkText
descriptionText for the link that appears after the 'description'.
typestring
primaryEmail
descriptionThe user's email id to display to the user.
typestring
profilePictureAccessibilityLabel
descriptionTap action text read by a screen reader after the phrase "double-tap to .." when focus moves to the profile picture.
typestring
profilePictureImage
$refImage
descriptionProfile picture image.
profilePictureLink
$refLink
descriptionLink 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
$refResourceKey
descriptionProfile picture target.
title
descriptionHeader welcome title (e.g. 'Welcome, Janelle').
typestring
typeobject
root['title']
new_valueReach Private API
old_valueAccount Settings Mobile Private API (Staging)
sandbox/staging-accountsettingsmobile-pa-v1
dictionary_item_added
  • root['fullyEncodeReservedExpansion']
values_changed
root['baseUrl']
new_valuehttps://reach-pa.googleapis.com/
old_valuehttps://staging-accountsettingsmobile-pa.sandbox.googleapis.com/
root['canonicalName']
new_valueReach Presentation Service
old_valueAccount Settings Mobile
root['description']
new_valuereach-pa.googleapis.com API.
old_valueAn API which services Google account settings UIs on Android and iOS.
root['documentationLink']
new_valuehttp://go/safetyexp-entry-point-dd
old_valuehttp://go/asm
root['id']
new_valuereach_pa:v1
old_valueaccountsettingsmobile_pa:v1
root['mtlsRootUrl']
new_valuehttps://reach-pa.mtls.googleapis.com/
old_valuehttps://staging-accountsettingsmobile-pa.mtls.sandbox.googleapis.com/
root['name']
new_valuereach_pa
old_valueaccountsettingsmobile_pa
root['resources']['v1']['methods']
new_value
getAccountMessages
descriptionFetches user's current advice state, potentially updates respective badge dismissal
flatPathv1:getAccountMessages
httpMethodPOST
idreach_pa.getAccountMessages
parameterOrder
parameters
pathv1:getAccountMessages
request
$refAccountMessagesRequest
response
$refAccountMessagesResponse
updateAccountMessages
descriptionUpdates user's current advice state, like updating the advice dismissal status
flatPathv1:updateAccountMessages
httpMethodPOST
idreach_pa.updateAccountMessages
parameterOrder
parameters
pathv1:updateAccountMessages
request
$refUpdateAccountMessagesRequest
response
$refUpdateAccountMessagesResponse
old_value
getClientConfig
descriptionRequests config data for iOS clients.
flatPathv1:getClientConfig
httpMethodPOST
idaccountsettingsmobile_pa.getClientConfig
parameterOrder
parameters
pathv1:getClientConfig
request
$refGetClientConfigRequest
response
$refGetClientConfigResponse
getResource
descriptionRequests a resource.
flatPathv1:getResource
httpMethodPOST
idaccountsettingsmobile_pa.getResource
parameterOrder
parameters
pathv1:getResource
request
$refGetResourceRequest
response
$refGetResourceResponse
getScreen
descriptionRequests a screen.
flatPathv1:getScreen
httpMethodPOST
idaccountsettingsmobile_pa.getScreen
parameterOrder
parameters
pathv1:getScreen
request
$refGetScreenRequest
response
$refGetScreenResponse
getSignedOutResource
descriptionRequests a resource from a signed-out context.
flatPathv1:getSignedOutResource
httpMethodPOST
idaccountsettingsmobile_pa.getSignedOutResource
parameterOrder
parameters
pathv1:getSignedOutResource
request
$refGetSignedOutResourceRequest
response
$refGetSignedOutResourceResponse
prefetchRelatedScreens
descriptionRequests a list of screens which are related to a specified one, with the purpose of prefetching them in the client application.
flatPathv1:prefetchRelatedScreens
httpMethodPOST
idaccountsettingsmobile_pa.prefetchRelatedScreens
parameterOrder
parameters
pathv1:prefetchRelatedScreens
request
$refPrefetchRelatedScreensRequest
response
$refPrefetchRelatedScreensResponse
search
descriptionSearches through resources
flatPathv1:search
httpMethodPOST
idaccountsettingsmobile_pa.search
parameterOrder
parameters
pathv1:search
request
$refSearchRequest
response
$refSearchResponse
setResourceDismissalState
descriptionSets the resource state, e.g. resource is dismissed
flatPathv1:setResourceDismissalState
httpMethodPOST
idaccountsettingsmobile_pa.setResourceDismissalState
parameterOrder
parameters
pathv1:setResourceDismissalState
request
$refSetResourceDismissalStateRequest
response
$refSetResourceDismissalStateResponse
root['revision']
new_value20250517
old_value20250514
root['rootUrl']
new_valuehttps://reach-pa.googleapis.com/
old_valuehttps://staging-accountsettingsmobile-pa.sandbox.googleapis.com/
root['schemas']
new_value
AccountAdvice
descriptionData to render OneGoogle bento account advice
idAccountAdvice
properties
additionalInfo
$refAdditionalInfo
descriptionOptional additional information included with the advice. Currently only used for recovery factor advice.
adviceId
descriptionUnique identifier of the advice type.
formatint32
typeinteger
ctaText
descriptionText to display on the CTA button.
typestring
description
descriptionDescription of the advice.
typestring
destination
$refAdviceDestination
descriptionDestination to open once Bento account advice CTA is clicked
dismissalText
descriptionText to display on the dismissal button.
typestring
title
descriptionTitle of the advice.
typestring
uiTreatment
descriptionUI 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.
typestring
typeobject
AccountMenu
descriptionData to render OneGoogle account menu only for SafetyExp
idAccountMenu
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
typestring
destination
$refAlertDestination
typeobject
AccountMessagesRequest
descriptionRequest for the GetAccountMessages RPC
idAccountMessagesRequest
properties
accountParticleDiscVersion
$refVersion
descriptionVersion of the AccountParticleDisc that is currently present on the device, iff present.
adviceFlavours
descriptionThe 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.
typestring
typearray
context
$refContext
descriptionContext of the triggering call, e.g. version/CL, platform, etc
surfaces
descriptionList 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.
typestring
typearray
triggeringEvent
$refTriggeringEvent
descriptionThe 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
typeobject
AccountMessagesResponse
descriptionResponse for the GetAccountMessages RPC
idAccountMessagesResponse
properties
accountAdvices
descriptionList of active advices to show the user
items
$refAccountAdvice
typearray
accountMenu
$refAccountMenu
descriptionOnly used for SafetyExp
accountParticleDisc
$refAccountParticleDisc
isServerDarkLaunch
descriptionThe server is currently in a ‘dark launch’ state.
typeboolean
typeobject
AccountParticleDisc
descriptionData to render OneGoogle account particle disc
idAccountParticleDisc
properties
badgeDismissalEvents
items
enum
  • BADGE_DISMISSAL_EVENT_UNSPECIFIED
  • ACCOUNT_MENU_OPENED
enumDescriptions
  • Shouldn't be used
  • User has opened account menu
typestring
typearray
badgeStatus
enum
  • BADGE_STATUS_UNSPECIFIED
  • NONE
  • ATTENTION
enumDescriptions
  • No information about badge status
  • No badge
  • Attention badge (yellow)
typestring
version
$refVersion
typeobject
AdditionalInfo
descriptionAdditional miscellaneous information included with the advice.
idAdditionalInfo
properties
numExistingRecoveryFactors
descriptionNumber of existing recovery factors the user has.
formatint32
typeinteger
typeobject
AdviceDestination
descriptionDestination to open once Bento account advice CTA is clicked
idAdviceDestination
properties
resourceKey
$refResourceKey
descriptionResource to open in the Google Account
url
$refSafeUrlProto
descriptionURL to open in the browser
typeobject
AlertDestination
descriptionDestination to open once OneGoogle account menu entrypoint is clicked
idAlertDestination
properties
resourceKey
$refResourceKey
descriptionResource to open in the Google Account
url
$refSafeUrlProto
descriptionURL to open in the browser
typeobject
AndroidClientVersion
idAndroidClientVersion
properties
androidOsSdk
descriptionThe Android OS SDK version, e.g. 28 (Android 9 is SDK 28).
formatint32
typeinteger
androidOsVersion
descriptionThe Android OS version, e.g. "5.1.1"
typestring
callingAndroidApp
descriptionApplicationId (package name) or alias of the app that initiated the request
typestring
gmscoreVersionCode
descriptionGmsCore 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
formatint32
typeinteger
gmscoreVersionName
descriptionGmsCore 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)"
typestring
typeobject
Context
descriptionThe 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
idContext
properties
androidClientVersion
$refAndroidClientVersion
hideEntryPointIfViewed
descriptionIf true, don't show EP once Y days have passed since the user viewed it.
typeboolean
hideEntryPointIfVisited
descriptionIf true, don't show EP once X days have passed since the user clicked it.
typeboolean
iosClientVersion
$refIOSClientVersion
isClientDarkLaunch
descriptionThe client is currently in a ‘dark launch’ state.
typeboolean
webClientVersion
$refWebClientVersion
typeobject
IOSClientVersion
idIOSClientVersion
properties
iosAppBundleId
descriptionThe bundle ID (CFBundleIdentifier) of the hosting iOS app e.g. "com.google.ios.youtube"
typestring
iosAppVersion
descriptionThe version (CFBundleVersion) of the hosting iOS app, e.g. "10.30.11661"
typestring
iosBuildChangelist
descriptionChangelist that this client was built at. Obtained from google3/googlemac/Shared/Metrics/Phenotype/Classes/PHTPhenotypeBuildData.h
typestring
typeobject
OneGoogleTriggeringEvent
descriptionOneGoogle specific event that triggered client to fetch the data
idOneGoogleTriggeringEvent
properties
reason
descriptionEnum 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.
typestring
typeobject
ResourceKey
descriptionEach 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.
idResourceKey
properties
resourceId
descriptiona value from the ResourceId enum
formatint32
typeinteger
resourceParams
additionalProperties
typestring
descriptionkey-value map of request parameters
typeobject
typeobject
SafeUrlProto
descriptionMessage 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.
idSafeUrlProto
properties
privateDoNotAccessOrElseSafeUrlWrappedValue
descriptionIMPORTANT: 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.
typestring
typeobject
TriggeringEvent
descriptionEvent that triggered client to fetch the data
idTriggeringEvent
properties
onegoogleTriggeringEvent
$refOneGoogleTriggeringEvent
typeobject
UpdateAccountMessagesRequest
descriptionRequest for the UpdateAccountMessages RPC
idUpdateAccountMessagesRequest
properties
dismissedAdviceIds
descriptionList 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
formatint32
typeinteger
typearray
typeobject
UpdateAccountMessagesResponse
descriptionResponse for the UpdateAccountMessages RPC. Empty response means success
idUpdateAccountMessagesResponse
properties
typeobject
Version
descriptionA 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
idVersion
properties
typeobject
WebClientVersion
idWebClientVersion
properties
buildLabel
descriptionLabel associated with the build of this binary. See google3/java/com/google/apps/framework/blaze/ImmutableBuildData.kt
typestring
cachedAlertLevel
descriptionAlertLevel 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
typestring
typeobject
old_value
ATTSignalConfig
descriptionConfigures 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.
idATTSignalConfig
properties
paramName
descriptionThe name of the query parameter being appended to the URL.
typestring
urlPatterns
descriptionList of regular expressions for mathing URLs.
items
typestring
typearray
typeobject
AccountMenuInformation
descriptionInformation that can be provided to the OGL account menu Next Id: 2
idAccountMenuInformation
properties
accountAlertLevel
descriptionThe 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.
typestring
typeobject
ActionChip
descriptionAn action chip.
idActionChip
properties
icon
$refImage
descriptionIcon displayed on the left of the chip.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
stackItemImage
$refImage
descriptionWhen 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
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
text
descriptionText of the chip.
typestring
typeobject
ActionChipBlock
descriptionA block containing a scrollable horizontal list of action chips.
idActionChipBlock
properties
chips
descriptionList of action chips.
items
$refActionChip
typearray
listPreviewUnitTotal
descriptionTotal number of chips there would have been if not limited/truncated. This will be mapped to ListPreviewUnit.total.
formatint32
typeinteger
wrapChips
descriptionWhether to wrap chips when there isn't enough space. Currently available for web only.
typeboolean
typeobject
ActionChipsUnit
descriptionscreen/82c8fpyatXbybbe
idActionChipsUnit
properties
actionChips
descriptionActionChips
items
$refActionChip
typearray
wrapChips
descriptionWhether the chips should wrap when there's not enough horizontal space.
typeboolean
typeobject
ActionItem
descriptionThe action item that may be used to build all kind of menus.
idActionItem
properties
delegateLinkType
descriptionSpecifies 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
typestring
icon
$refImage
descriptionThe icon of the action item.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
target
$refResourceKey
deprecatedTrue
descriptionThe id of the target resource. DEPRECATED: Use link instead.
title
descriptionThe title of the action item.
typestring
typeobject
ActionLineBlock
descriptionA block containing a navigation link and an icon.
idActionLineBlock
properties
expansionUnitLabel
descriptionWhen 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.
typestring
forcedConversionToStackItem
descriptionForces 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.
typeboolean
icon
$refImage
descriptionicon shown on the right of the block, e.g. chevron icon.
stackItemImage
$refImage
descriptionWhen 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
descriptionVisible text of the link.
typestring
typeobject
ActivityListItemBlock
descriptionA block representing a List item to display activities. Next Id: 7
idActivityListItemBlock
properties
description
descriptionA description of the item, shown underneath the special description.
typestring
image
$refImage
descriptionAn illustration, if set, shown on the left side of the title&description.
imageLink
$refLink
descriptionLink 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
$refResourceKey
deprecatedTrue
descriptionAn optional link target for the image.
specialDescription
$refSpecialDescription
descriptionSpecial description shown underneath the title.
title
$refText
descriptionThe title of the item, as the most prominent text of the item.
typeobject
AdditionalDescription
descriptionThe additional description that might be displayed for some account types. Next id: 8
idAdditionalDescription
properties
image
$refImage
descriptionAn account type logo icon.
link
$refLink
descriptionLink 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
deprecatedTrue
descriptionAccessibility label for the link, used by screen readers instead of link_text. DEPRECATED: Use link.aria_label instead.
typestring
linkIcon
$refImage
descriptionIcon to append after the link text.
linkTarget
$refResourceKey
descriptionThe target resource of the link.
linkText
descriptionThe text in the link that shows up on managed account types (e.g. 'Learn More').
typestring
mainText
descriptionThe secondary description message that shows up on managed account types.
typestring
typeobject
AdditionalParagraph
descriptionEncapsulates one of additional sections of information displayed to the user below the sign in button. Next id: 7
idAdditionalParagraph
properties
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
linkAccessibilityLabel
deprecatedTrue
descriptionAccessibility label for the link, used by screen readers instead of link_text. DEPRECATED: Use link.aria_label instead.
typestring
linkIcon
$refImage
descriptionIcon to append after the link text.
linkTarget
$refResourceKey
deprecatedTrue
descriptionOptional link destination. DEPRECATED: Use link instead.
linkText
descriptionThe text of the link. The link will be displayed inline with the main text. Can be omited leaving just the text.
typestring
text
descriptionMain text in this paragraph. Can be omited leaving just the link.
typestring
typeobject
Alternative
descriptionAlternatives 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
idAlternative
properties
androidIntentAlternative
$refAndroidIntentAlternative
descriptionOpens a native app by launching an Android intent.
browserAlternative
$refBrowserAlternative
descriptionDisplays a screen by opening a page in the browser.
cardsAlternative
$refCardsAlternative
descriptionOpens a native app screen with tabs and card deck.
fauxbakeAlternative
$refFauxbakeAlternative
descriptionOpens a native fauxbake screen, allowing to change the profile picture.
menuAlternative
$refMenuAlternative
descriptionDisplays a screen as a native menu.
messageAlternative
$refMessageAlternative
descriptionDisplays a screen by showing a message to the user.
nativeAlternative
$refNativeAlternative
descriptionDisplays a screen as a native setting.
nativeNavigationAlternative
$refNativeNavigationAlternative
descriptionNavigates to a native screen from a web or webview page.
onboardingAlternative
$refOnboardingAlternative
deprecatedTrue
descriptionOpens an onboarding screen.
placeholderAlternative
$refPlaceholderAlternative
descriptionReserved for internal use by clients.
searchAlternative
$refSearchAlternative
descriptionOpens a native app screen with a search box and results.
supportAlternative
$refSupportAlternative
descriptionOpens a support panel if possible, otherwise opens the support screen.
webviewAlternative
$refWebviewAlternative
descriptionDisplays a screen by opening a page in a WebView.
typeobject
AnchorNavigationParams
descriptionConfiguration items used when scrolling to an item on the screen Next Id: 2
idAnchorNavigationParams
properties
anchor
descriptionThe identifier is used to find an item to which scrolling should happen. The corresponding item should have the same anchor.
typestring
typeobject
AndroidIntent
descriptionAndroid intent
idAndroidIntent
properties
action
descriptionThe intent action, such as ACTION_VIEW.
typestring
categories
descriptionA list of intent categories.
items
typestring
typearray
className
descriptionThe intent class. This should be the complete class with package name. Required.
typestring
extras
additionalProperties
$refExtra
descriptionA map of intent extras keyed by the names of the extras.
typeobject
flagActivityNewTask
descriptionWhether to set the Intent flag FLAG_ACTIVITY_NEW_TASK.
typeboolean
packageName
descriptionThe intent package name. Required.
typestring
thirdParty
deprecatedTrue
descriptionThe intent is for a third-party app. If false, the client will verify that the called app has a Google signature.
typeboolean
type
descriptionThe intent MIME data type.
typestring
uri
descriptionData uri.
typestring
typeobject
AndroidIntentAlternative
descriptionAn alternative with an intent and conditions to launch an Android activity
idAndroidIntentAlternative
properties
check
descriptionDefines 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.
typestring
intent
$refAndroidIntent
descriptionAndroid intent to launch
rules
descriptionIf present, only use the intent if one of these requirements is met (i.e. rules are ORed)
items
$refAndroidIntentRule
typearray
typeobject
AndroidIntentCapabilities
descriptionThe 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.
idAndroidIntentCapabilities
properties
accountNameBackPropagation
descriptionWhether the client supports propagating the account name back to the opening first- or zero party activity.
typeboolean
flagActivityNewTask
descriptionWhether the client supports setting the Intent flag FLAG_ACTIVITY_NEW_TASK.
typeboolean
supportedAndroidIntentCheck
descriptionWhether the client supports a specific intent check type.
items
$refSupportedAndroidIntentCheck
typearray
typeobject
AndroidIntentRule
descriptionAll conditions that are present must be met for this "rule" to be met (i.e. conditions are ANDed).
idAndroidIntentRule
properties
maxVersionCode
descriptionOnly use the intent alternative if the package has at most this version code, exclusive.
formatint32
typeinteger
maxVersionInfo
descriptionThe 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
formatint32
typeinteger
typearray
minVersionCode
descriptionOnly use the intent alternative if the package has at least this version code, inclusive
formatint32
typeinteger
minVersionInfo
descriptionThe 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
formatint32
typeinteger
typearray
packageName
descriptionOnly use the intent alternative if the package is installed. Required.
typestring
typeobject
AnimationSegment
deprecatedTrue
descriptionDescribes the features of the animation segment, which should be applied to the animation specified in OnboardingFlow. Next Id: 3
idAnimationSegment
properties
animationEndFrame
descriptionThe end frame number of the animation segment. Required.
formatint32
typeinteger
animationStartFrame
descriptionThe start frame number of the animation segment. Required.
formatint32
typeinteger
typeobject
AppBar
descriptionRenders the app bar. See go/mg-redesign-header-proto for more info.
idAppBar
properties
actionItems
descriptionAction items to show in the toolbar. Only used on Android and iOS.
items
$refActionItem
typearray
backButtonTarget
$refResourceKey
deprecatedTrue
descriptionThe destination of the back button only used on Web, ignored by other platforms. DEPRECATED: Use link instead.
backLink
$refLink
descriptionLink 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
descriptionWhether 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.
typeboolean
title
descriptionThe title text to be displayed.
typestring
typeobject
Attribute
descriptionAttribute
idAttribute
properties
attribute
descriptionText of the attribute
typestring
image
$refImage
descriptionAn optional image - screen/ivNErM2XjsmVbU7.
typeobject
AttributesUnit
descriptionscreen/8vM3aFoKwwLD7FN
idAttributesUnit
properties
attributes
descriptionList of attributes.
items
$refAttribute
typearray
typeobject
Block
descriptionBuilding block of a card Next id: 35
idBlock
properties
actionChipBlock
$refActionChipBlock
descriptionAction Chip Block
actionLineBlock
$refActionLineBlock
descriptionNavigation Link Block
carouselBlock
$refCarouselBlock
descriptionCarousel Block
descriptionBlock
$refDescriptionBlock
descriptionDescription block
dividerBlock
$refDividerBlock
descriptionDivider Block
imageBlock
$refImageBlock
descriptionImage block
legendBlock
$refLegendBlock
descriptionLegend Block
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
listItemBlock
$refListItemBlock
descriptionList Item Block
profilePictureBlock
$refProfilePictureBlock
descriptionProfile Picture Block
progressBarBlock
$refProgressBarBlock
descriptionProgress Bar Block
progressBarListItemBlock
$refProgressBarListItemBlock
descriptionList item-like block with progress bar
searchBlock
$refSearchBlock
descriptionA block that has a search bar.
signInBlock
$refSignInBlock
descriptionSign In Block
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
twoColumnTableBlock
$refTwoColumnTableBlock
descriptionTwo Column Table Block
typeobject
BoolArray
descriptionA boolean array
idBoolArray
properties
values
descriptionvalues of boolean array
items
typeboolean
typearray
typeobject
BottomButton
descriptionOne of the BottomNav buttons.
idBottomButton
properties
icon
$refImage
descriptionButton icon (default version) to be displayed above the title. Instead, only the image_id can be used
link
$refLink
descriptionLink referencing the screen that should be opened when the item is activated. Not supported on iOS and Android.
menu
$refBottomDrawerMenu
descriptionThe bottom menu.
selectedIcon
$refImage
descriptionButton icon (selected version) to be displayed above the title. Instead, only the image_id can be used
target
$refResourceKey
deprecatedTrue
descriptionThe target screen. DEPRECATED: Bottom Navigation is deprecated.
title
descriptionButton caption.
typestring
typeobject
BottomDrawerMenu
descriptionThe bottom navigation drawer menu.
idBottomDrawerMenu
properties
blocks
descriptionThe 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
$refBottomDrawerMenuBlock
typearray
typeobject
BottomDrawerMenuBlock
descriptionA building block of the bottom navigation menu drawer.
idBottomDrawerMenuBlock
properties
divider
$refBottomDrawerMenuDivider
descriptionA horizontal divider.
menuItem
$refBottomDrawerMenuItem
descriptionA menu item.
typeobject
BottomDrawerMenuDivider
descriptionA horizontal divider for the bottom navigation menu drawer.
idBottomDrawerMenuDivider
properties
typeobject
BottomDrawerMenuItem
descriptionA bottom navigation menu drawer item, pointing to targets across the app.
idBottomDrawerMenuItem
properties
icon
$refImage
descriptionA small icon to be displayed next to the item title. Truly optional.
link
$refLink
descriptionLink referencing the screen that should be opened when the item is activated. Not supported on iOS and Android.
target
$refResourceKey
deprecatedTrue
descriptionThe target of the menu item. DEPRECATED: Bottom Navigation is deprecated.
title
descriptionThe displayed title of the menu item.
typestring
typeobject
BottomNav
descriptionBottom navigation bar with buttons.
idBottomNav
properties
buttons
descriptionList of buttons.
items
$refBottomButton
typearray
typeobject
BrowserAlternative
descriptionDisplays a screen by opening an URL in the default browser. Next Id: 7
idBrowserAlternative
properties
auth
descriptionIf true, the user should be signed in first using AccountChooser.
typeboolean
browserType
descriptionWhat 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).
typestring
setContinueUrlParam
descriptionWhether the "continue" URL param should be set, if available, when linking to this page. Used only for Platform.WEB.
typeboolean
target
descriptionWhere to display the linked URL. Used only for Platform.WEB. See Target enum.
formatint32
typeinteger
themedUrl
$refThemedUrl
descriptionThe set of theme-dependent URLs to open. One of url or themed_url required.
url
descriptionThe URL to open. One of url or themed_url required.
typestring
typeobject
BrowserCapabilities
descriptionThe 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
idBrowserCapabilities
properties
typeSelection
descriptionWhether the client supports selecting the browser API type that is used.
typeboolean
typeobject
ByteArray
descriptionA byte array
idByteArray
properties
values
descriptionvalues of byte array int8 scale
items
formatint32
typeinteger
typearray
typeobject
Card
descriptionCards that can be stacked on a screen.
idCard
properties
anchor
descriptionAn identifier for scrolling into the view.
typestring
collectionCard
$refCollectionCard
descriptionCollection Card
loading
$refLoadingCard
descriptionCard with a loading spinner on it.
oneGoogle
$refOneGoogleCard
descriptionCard representing an entry in the OneGoogle Account Menu.
promptCarousel
$refPromptCarouselCard
descriptionPrompt Carousel
searchResultCard
$refSearchResultCard
descriptionCard presenting a result on Google Search.
securityHubPromptCarousel
$refSecurityHubPromptCarouselCard
descriptionSecurityHub Prompt Carousel (for Angel)
segmentHeaderCard
$refSegmentHeaderCard
descriptionSegment header card
summary
$refSummaryCard
descriptionSummary Card
typeobject
CardCapabilities
descriptionThe 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.
idCardCapabilities
properties
adviceFramework
descriptionSupport for the Advice Framework.
typeboolean
borderlessCards
descriptionSupport for borderless summary cards.
typeboolean
carouselViewAll
descriptionSupports for "view all" button in carousels
typeboolean
genericStyledTexts
descriptionSupport for generic styled texts.
typeboolean
headerActionItems
descriptionWhether the client supports action menu on WelcomeHeader.
typeboolean
helpItem
descriptionSupport for help item in CardsAlternative.
typeboolean
iconOnlyChip
deprecatedTrue
descriptionSupport for chips that have only icons (no text)
typeboolean
legendBlock
descriptionSupport for LegendBlock
typeboolean
linkNavigation
descriptionSupport for link navigation.
typeboolean
listItemSecondaryIcon
descriptionSupport for secondary icon in ListItemBlock
typeboolean
navigateToAnchor
descriptionSupport for navigation to anchors
typeboolean
progressBarSummaryCardBlock
deprecatedTrue
descriptionSupport for progress bar block in summary cards.
typeboolean
promptResource
descriptionWhether the client supports prompt as a separate resource outside of the prompt carousel.
typeboolean
screenIntroLink
descriptionSupport for link in ScreenIntro.
typeboolean
segmentHeaderCard
descriptionSupport for segment header cards
typeboolean
signInSummaryCardBlock
descriptionSupport for sign in block in summary cards.
typeboolean
summaryCardPaddingDividerReplacement
descriptionSupport for additional padding replacing dividers in summary cards.
typeboolean
summaryCardProgressBar
descriptionWhether the client supports progress bar in the summary card
typeboolean
untintedUrlChipIcons
descriptionSupport for untinted URL chip icons.
typeboolean
typeobject
CardDeck
descriptionA set of cards.
idCardDeck
properties
cardKeys
descriptionList of cards. The order is equal to the order they should appear in the UI.
items
$refResourceKey
typearray
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the card deck.
typeobject
CardsAlternative
descriptionA screen with tabs and cards. Used for Home, Personal info, etc. Next Id: 22
idCardsAlternative
properties
appBar
$refAppBar
descriptionRenders 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
$refResourceKey
descriptionId of the bottom buttons bar.
bottomNavSelection
$refResourceKey
descriptionIdentifies 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
$refResourceKey
descriptionId of the deck of cards displayed on the page.
footerKey
$refResourceKey
descriptionFooter displayed on this page.
hatsSurvey
$refHaTSSurvey
descriptionHaTS survey to be shown.
helpItemTarget
$refResourceKey
deprecatedTrue
descriptionId of the target of the help center item in the header. DEPRECATED: use support link instead.
leftNavKey
$refResourceKey
descriptionId of the left navigation.
leftNavSelection
$refResourceKey
descriptionIdentifies which left menu item should appear selected. If omitted or if there is no button with this key, nothing is selected.
onboardingFlowKey
$refResourceKey
deprecatedTrue
descriptionId of an OnboardingFlow resource.
screenIntro
$refScreenIntro
descriptionScreen intro displayed just before the cards.
simpleHeaderKey
$refResourceKey
descriptionId of the header bar where action items and a title are displayed. Currently only used on Android and iOS.
supportLink
$refLink
descriptionId of the link of the help center item in the header, successor of help_item_target.
supportPanelKey
$refResourceKey
descriptionSupport panel displayed on the page.
topNavKey
$refResourceKey
descriptionId of the top tabs bar.
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the summary page.
welcomeHeaderKey
$refResourceKey
descriptionId of the header bar where user name and avatar are displayed.
welcomeScreenIntroKey
$refResourceKey
descriptionPersonalized welcome screen intro displayed on the home page instead of the usual screen intro.
typeobject
CarouselBlock
descriptionA horizontal list (carousel) block.
idCarouselBlock
properties
accessibilityLabel
descriptionAccessibility label for the legend item, used by screen readers.
typestring
itemWidth
descriptionThe width of the carousel item, only applies to vertical carousels. If not provided, client defaults to 128dp.
formatint32
typeinteger
items
descriptionList of carousel items.
items
$refCarouselItem
typearray
itemsType
descriptionThe carousel items type. See CarouselItemsType for possible values.
formatint32
typeinteger
textHorizontalAlignment
descriptionHorizontal alignment of text. See HorizontalAlignment enum.
formatint32
typeinteger
viewAllLink
$refLink
descriptionIf present, a "view all" button will be shown at the end of the carousel. When tapped it will open this link.
viewAllTarget
$refResourceKey
deprecatedTrue
descriptionIf 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
descriptionText, which is shown beneath the "view all" button. If empty the button is shown without text.
typestring
typeobject
CarouselItem
descriptionItem of a carousel, can be an elevated or flat card.
idCarouselItem
properties
descriptionColor
$refColor
descriptionColor of the description text.
descriptions
descriptionList of carousel descriptions.
items
typestring
typearray
elevate
descriptionWhether or not to elevate the carousel card.
typeboolean
image
$refImage
descriptionImage displayed on the top or left of the carousel item.
label
descriptionLabel of the carousel item.
typestring
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
specialDescription
$refSpecialDescription
descriptionSpecial description.
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
textEntries
deprecatedTrue
descriptionText entries of the carousel item. Use label, titles, etc. instead.
items
$refStyledTextEntry
typearray
titles
descriptionList of carousel titles.
items
typestring
typearray
typeobject
CharArray
descriptionA char array
idCharArray
properties
values
descriptionvalues of char array char
items
formatint32
typeinteger
typearray
typeobject
ClientCapabilities
descriptionDescribes 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
idClientCapabilities
properties
androidIntentCapabilities
$refAndroidIntentCapabilities
descriptionThe supported intent capabilites of the client
bottomNavigation
descriptionWhether the client supports bottom navigation or not.
typeboolean
browserAuthentication
descriptionWhether the client supports signing users in before opening a browser alternative.
typeboolean
browserCapabilities
$refBrowserCapabilities
descriptionThe capabilities related to opening a URL in a browser.
cardCapabilities
$refCardCapabilities
descriptionThe capabilities of the cards framework
expressiveDesign
descriptionWhether the client implements the expressive design language.
typeboolean
footer
descriptionWhether the client supports footer or not.
typeboolean
hats
descriptionWhether the client supports HaTS. See go/hats for details.
typeboolean
leftNavigation
descriptionWhether the left navigation is supported or not.
typeboolean
nativeCapabilities
$refNativeCapabilities
descriptionThe capabilities of the native actions.
seamlessDarkMode
descriptionWhether the client supports theme-agnostic resources.
typeboolean
simpleHeader
descriptionWhether the client supports simple header or not.
typeboolean
supportLinkDelegation
descriptionWhether the client supports support_link and DelegateLinkType.DELEGATE_SUPPORT.
typeboolean
supportedAlternativeTypes
descriptionLists all supported alternative types. Only supported since gmscore_module_version=3 v2 and below supports MenuAlternative, MessageAlternative, NativeAlternative, BrowserAlternative.
items
$refSupportedAlternativeType
typearray
supportedIcons
descriptionLists all supported icons.
items
$refSupportedIcon
typearray
supportedItemTypes
descriptionLists all supported item types. Only supported since gmscore_module_version=3 v2 and below supports SimpleItem and PromoItem.
items
$refSupportedItemType
typearray
supportedNativeActions
descriptionLists all supported native actions.
items
$refSupportedNativeAction
typearray
supportedOfflineScreens
descriptionLists all supported offline screens.
items
$refSupportedOfflineScreen
typearray
topTabIcons
descriptionWhether the client supports top tab icons or not.
typeboolean
usesStandardChevron
descriptionWhether the client uses the default chevrons or a custom version with less padding
typeboolean
webviewCapabilities
$refWebviewCapabilities
descriptionThe capabilities of the webview client.
typeobject
ClientVersions
descriptionThe 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
idClientVersions
properties
androidLibraryVersion
descriptionThe version of the Android AccountSettings library that is used outside of GMSCore, to present ASMS content within other apps. e.g. "1.0"
typestring
androidOsVersion
descriptionThe Android OS version, e.g. "5.1.1".
typestring
androidSdkVersion
descriptionThe Android SDK version. e.g. "22"
typestring
androidSystemWebviewVersion
descriptionThe version of the Android system webview component e.g. "37.0.0.0"
typestring
gmscoreModuleApkVersionName
descriptionThe 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
typestring
gmscoreModuleVersion
descriptionThe 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
typestring
gmscoreVersion
descriptionThe GMSCore version code. e.g. "9033000"
typestring
gmscoreWebviewModuleVersion
descriptionThe 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
typestring
iosAppBundleId
descriptionThe bundle ID (CFBundleIdentifier) of the hosting iOS app. e.g. "com.google.ios.youtube"
typestring
iosAppVersion
descriptionThe version (CFBundleVersion) of the hosting iOS app. e.g. "10.30.11661"
typestring
iosLibrary
descriptionThe type of the iOS AccountSettings library, e.g. "main" or "policies"
typestring
iosLibraryVersion
descriptionThe version of the iOS AccountSettings library. e.g. "1.0"
typestring
iosVersion
descriptionThe iOS version. e.g. "9.2.1"
typestring
typeobject
CollapsableBlock
descriptionBlock that can be collapsed, containing a set of other blocks.
idCollapsableBlock
properties
collapsedActionLabel
descriptionThe label of the action block in its collapsed form.
typestring
content
descriptionThe content of the block in its extended form.
items
$refOneBoxBlock
typearray
expandedContentDescription
descriptionDescription below the title of the expanded section.
typestring
expandedContentTitle
descriptionTitle on top of the expanded section.
typestring
initiallyExpanded
descriptionIndicator whether the block should initially be collapsed or extended.
typeboolean
typeobject
CollectionCard
descriptionA collection card - screen/3R3xDXaRngvfQMS.
idCollectionCard
properties
description
descriptionDescription of the card.
typestring
hyperlink
$refLink
descriptionLink of the hyperlink_text.
hyperlinkText
descriptionHyperlink text/label of the card displayed after the description.
typestring
stacks
descriptionStacks of the card.
items
$refStack
typearray
title
descriptionTitle of the card.
typestring
typeobject
Color
descriptionRepresents 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(''); }; // ...
idColor
properties
alpha
descriptionThe 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).
formatfloat
typenumber
blue
descriptionThe amount of blue in the color as a value in the interval [0, 1].
formatfloat
typenumber
green
descriptionThe amount of green in the color as a value in the interval [0, 1].
formatfloat
typenumber
red
descriptionThe amount of red in the color as a value in the interval [0, 1].
formatfloat
typenumber
typeobject
DashboardNavigationMetadata
descriptionAdditional information about navigations from Google Dashboard.
idDashboardNavigationMetadata
properties
globalCta
descriptionType 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
typestring
typeobject
DashboardServiceCardOutboundNavigationMetadata
descriptionAdditional information about outbound navigations from service cards on Google Dashboard.
idDashboardServiceCardOutboundNavigationMetadata
properties
navigationType
descriptionType 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)
typestring
pageSection
descriptionThe 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
typestring
serviceId
descriptionID of the service e.g. MAPS, PHOTOS, DRIVE, YOUTUBE etc..
enum
  • UNKNOWN
  • ADSENSE
  • ADWORDS
  • ALERTS
  • ANALYTICS
  • ANDROID
  • ANDROIDMARKET
  • BLOGGER
  • BOOKS
  • CHROMIUMSYNC
  • CALENDAR
  • CLOUDPRINT
  • CONTACTS
  • CUSTOMSEARCH
  • DRIVE
  • FEEDBURNER
  • FIT
  • GMAIL
  • GMBLOCATIONS
  • GOOGLEVOICE
  • GROUPS
  • JOTSPOT
  • KEEP
  • MADISON
  • MANUFACTURERCENTER
  • MAPS
  • MERCHANTCENTER
  • MOBILESYNC
  • NEWS
  • PAYMENTS
  • PICASA
  • PLUS
  • TASKS
  • WEBMASTERTOOLS
  • YOUTUBE
  • ACCOUNT
  • ANDROIDMUSIC
  • AUDIOHISTORY
  • DEVICE_INFORMATION
  • FUSIONTABLES
  • GLASS
  • HIST
  • LATITUDE
  • SHOPPERASSIST
  • YOUTUBE_SEARCH_HISTORY
  • YOUTUBE_WATCH_HISTORY
  • YOUTUBE_HISTORY
enumDeprecated
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • True
enumDescriptions
  • The default value used when a new enum value is not yet known to the parser of the protocol buffer.
  • Adsense
  • Google Ads
  • Alerts
  • Analytics
  • Android
  • Play Store.
  • Blogger
  • Google books
  • Chrome sync
  • Calendar
  • Cloudprint
  • Contacts
  • Programmable Search Engine.
  • Google drive
  • Feedburner
  • Fit
  • Gmail
  • Google My Business Locations
  • Google Voice
  • Google Groups
  • Sites.
  • Keep
  • Brand accounts.
  • Manufacturer Center
  • Google maps
  • Merchant Center
  • Google Sync
  • Google news
  • Previously known as Checkout and Wallet.
  • Photos.
  • Currents aka G+ aka Oz aka GoogleMe aka EmeraldSea.
  • Tasks
  • Google Search Console
  • YouTube
  • DEPRECATED: This service will no longer be shown with the Dashboard revamp (go/dashboard-revamp-dd).
  • Play Music. DEPRECATED: Service no longer exists.
  • Voice and Audio Activity. DEPRECATED: This is no longer a top-level UDC setting and is no longer shown on Dashboard.
  • DEPRECATED: This UDC setting no longer exists.
  • DEPRECATED: Service no longer exists.
  • DEPRECATED: Service no longer exists on Dashboard.
  • Web History. DEPRECATED: This UDC setting will no longer be shown with the Dashboard revamp (go/dashboard-revamp-dd).
  • Location History. DEPRECATED: This UDC setting will no longer be shown with the Dashboard revamp (go/dashboard-revamp-dd).
  • Package Tracking. DEPRECATED: This UDC setting will no longer be shown with the Dashboard revamp (go/dashboard-revamp-dd).
  • DEPRECATED: Merged into YOUTUBE_HISTORY.
  • DEPRECATED: Merged into YOUTUBE_HISTORY.
  • DEPRECATED: This UDC setting will no longer be shown with the Dashboard revamp (go/dashboard-revamp-dd).
typestring
typeobject
DescriptionBlock
descriptionA description block, can contain a title with a link, a description and an image (position to the right of the block). Next id: 11
idDescriptionBlock
properties
descriptionText
descriptiondescription block description text.
typestring
image
$refImage
descriptionimage displayed to the right of the text.
largeImage
$refImage
descriptionthe large version of image to be displayed on larger screens.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the link click event. Eventually should completely replace the `target` field.
linkAccessibilityLabel
deprecatedTrue
descriptionAccessibility label for the link, used by screen readers instead of link_text. DEPRECATED: Use link.aria_label instead.
typestring
linkIcon
$refImage
descriptionIcon to append after the description block link.
linkTarget
$refResourceKey
deprecatedTrue
descriptionId of link destination resource. DEPRECATED: Use link instead.
linkText
descriptiondescription block link text.
typestring
stackItemImage
$refImage
descriptionWhen 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
descriptiondescription block title.
typestring
typeobject
DividerBlock
descriptionA block that acts as a divider between different kinds of blocks.
idDividerBlock
properties
typeobject
DoubleArray
descriptionA double array
idDoubleArray
properties
values
descriptionvalues of double array
items
formatdouble
typenumber
typearray
typeobject
ExpansionUnit
descriptionscreen/9fYD3c8gNSJH6Aj & screen/AfX5FY6knEvFoEj
idExpansionUnit
properties
backgroundColor
$refThemedColor
descriptionColor to tint the background and serve as container for Icon and Label
foregroundColor
$refThemedColor
descriptionColor to tint label and icon
icon
$refImage
descriptionIcon of the expansion button
label
descriptionLabel of the expansion button
typestring
typeobject
Extra
descriptionAn Android intent extra LINT.IfChange
idExtra
properties
booleanArrayValue
$refBoolArray
descriptionA boolean array extra value.
booleanValue
descriptionA boolean extra value.
typeboolean
byteArrayValue
$refByteArray
descriptionA byte array extra value.
byteValue
descriptionA byte extra value. int8 scale
formatint32
typeinteger
charArrayValue
$refCharArray
descriptionA char array extra value.
charValue
descriptionA char extra value. char
formatint32
typeinteger
doubleArrayValue
$refDoubleArray
descriptionA double array extra value.
doubleValue
descriptionA double extra value.
formatdouble
typenumber
floatArrayValue
$refFloatArray
descriptionA float array extra value.
floatValue
descriptionA float extra value.
formatfloat
typenumber
intArrayValue
$refIntArray
descriptionAn int array extra value.
intValue
descriptionAn int extra value.
formatint32
typeinteger
longArrayValue
$refLongArray
descriptionA long array extra value.
longValue
descriptionA long extra value.
formatint64
typestring
shortArrayValue
$refShortArray
descriptionA short array extra value.
shortValue
descriptionA short extra value. int16 scale
formatint32
typeinteger
stringArrayValue
$refStringArray
descriptionA string array extra value.
stringValue
descriptionA string extra value.
typestring
typeobject
FauxbakeAlternative
descriptionA screen with a profile picture and buttons to allow changing or removing it. Next Id: 11
idFauxbakeAlternative
properties
addPictureButton
$refFauxbakeButton
descriptionThe button that allows users to add a profile picture.
avatarInformation
$refFauxbakePictureInfo
descriptionThe accessibility information for the picture if the user has a profile picture set.
changePictureButton
$refFauxbakeButton
descriptionThe button that allows users to change their profile picture.
croppingOverlay
$refFauxbakeCroppingOverlay
descriptionFauxbake cropping and rotate screen.
description
descriptionThe description text that should be displayed below the title.
typestring
footer
$refFauxbakeFooter
descriptionThe footer that should be displayed at the bottom of the screen.
monogramInformation
$refFauxbakePictureInfo
descriptionThe accessibility information for the picture if the user has no profile picture set and a monogram is visible instead.
removePictureButton
$refFauxbakeButton
descriptionThe button that allows users to remove their profile picture.
title
descriptionThe title text that should be displayed at the top of the screen.
typestring
welcomeHeaderKey
$refResourceKey
descriptionAn 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.
typeobject
FauxbakeButton
descriptionA 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
idFauxbakeButton
properties
accessibilityLabel
descriptionAn accessibility label for the button. If not present, the button title should be used.
typestring
icon
$refImage
descriptionThe icon of the button
title
descriptionThe title of the button.
typestring
typeobject
FauxbakeCroppingExtraInformationAlert
descriptionAlert showing extra information. Next Id: 4
idFauxbakeCroppingExtraInformationAlert
properties
closeButtonTitle
descriptionTitle for the button that closes the information alert.
typestring
informationText
descriptionText for the extra information alert.
typestring
triggerButton
$refFauxbakeButton
descriptionButton for triggering the extra information alert.
typeobject
FauxbakeCroppingOverlay
descriptionOverlay screen for cropping and rotating the user profile picture. Next Id: 5
idFauxbakeCroppingOverlay
properties
navigationBar
$refFauxbakeCroppingOverlayNavigationBar
descriptionNavigation bar containing the back and extra information alert buttons.
rotateButton
$refFauxbakeButton
descriptionButton to rotate the image, placed on the footer.
saveButton
$refFauxbakeButton
descriptionButton that concludes the action of cropping & rotating the image.
typeobject
FauxbakeCroppingOverlayNavigationBar
descriptionNavigation bar for the cropping overlay containing the back button and extra information alert trigger with its data. Next Id: 4
idFauxbakeCroppingOverlayNavigationBar
properties
backButton
$refFauxbakeButton
descriptionNavigation bar back button.
extraInformationAlert
$refFauxbakeCroppingExtraInformationAlert
descriptionAlert showing extra information.
title
descriptionThe title shown in the navigation bar.
typestring
typeobject
FauxbakeFooter
descriptionThe footer text that should be displayed at the bottom of the screen. Next Id: 6
idFauxbakeFooter
properties
icon
$refImage
descriptionThe icon that is displayed next to the footer text.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
linkTarget
$refResourceKey
deprecatedTrue
descriptionThe target of the link at the end of the footer. DEPRECATED: Use link instead.
linkText
descriptionThe text of the link at the end of the footer.
typestring
text
descriptionThe text that should be in the footer.
typestring
typeobject
FauxbakePictureInfo
descriptionAdditional information for the big profile picture on the Fauxbake screen. Next Id: 3
idFauxbakePictureInfo
properties
accessibilityHint
descriptionThe 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).
typestring
accessibilityLabel
descriptionThe text that is going to be read when a screen reader focuses on the profile picture.
typestring
typeobject
FeedbackParams
descriptionConfiguration items used when launching the Feedback Client. Next Id: 3
idFeedbackParams
properties
captureScreenshot
descriptionIf true, include a screenshot in the feedback report.
typeboolean
category
descriptionThe Feedback entry point within My Google, used to sort into buckets.
typestring
typeobject
FloatArray
descriptionA float array
idFloatArray
properties
values
descriptionvalues of float array
items
formatfloat
typenumber
typearray
typeobject
Footer
descriptionFooter consists of link items.
idFooter
properties
items
descriptionList of items.
items
$refFooterItem
typearray
typeobject
FooterItem
descriptionOne of the Footer link text items. Next id: 5
idFooterItem
properties
label
descriptionThe a11y text label for this link.
typestring
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
target
$refResourceKey
deprecatedTrue
descriptionThe target screen. DEPRECATED: Use link instead.
text
descriptionThe text content of this link.
typestring
typeobject
GetClientConfigRequest
descriptionRequest message for GetClientConfig.
idGetClientConfigRequest
properties
context
$refRequestContext
descriptionInformation sent with every request.
typeobject
GetClientConfigResponse
descriptionResponse 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
idGetClientConfigResponse
properties
attSignalConfigs
descriptionConfiguration for appending ATT (Apple Tracking Transparency) consent state to URLs in Octarine webviews, for every app/URL combination.
items
$refATTSignalConfig
typearray
canUsePeopleApiForProfilePictureUploading
descriptionWhether it's safe to use People API for profile picture uploading. Used only by iOS client.
typeboolean
clearcutDenylistedScreenIds
descriptionList of screen IDs that should have clearcut logging disabled.
items
formatint32
typeinteger
typearray
heartbeatTimesS
descriptionThe 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
formatint32
typeinteger
typearray
prefetchingEnabled
descriptionWhether the client app should issue PrefetchRelatedScreens requests.
typeboolean
screenMaxLifetime
descriptionAfter 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.
formatgoogle-duration
typestring
stableScreenStaleTime
descriptionAfter 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.
formatgoogle-duration
typestring
unstableScreenStaleTime
descriptionAfter 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.
formatgoogle-duration
typestring
useSystemDefaultBrowserToOpenUrls
descriptionIndicates whether the client should use the default system browser to open links in Octarine.
typeboolean
webviewBlacklistedUrlPatterns
descriptionSee webview_whitelisted_url_patterns.
items
typestring
typearray
webviewBrowserAuthBlacklistedUrlPatterns
descriptionSee webview_browser_auth_whitelisted_url_patterns.
items
typestring
typearray
webviewBrowserAuthWhitelistedUrlPatterns
descriptionList 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
typestring
typearray
webviewDefaultJsBridgeBlacklistedUrlPatterns
descriptionSee webview_default_js_bridge_whitelisted_url_patterns.
items
typestring
typearray
webviewDefaultJsBridgeWhitelistedUrlPatterns
descriptionList 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
typestring
typearray
webviewUdcJsBridgeBlacklistedUrlPatterns
descriptionSee webview_udc_js_bridge_whitelisted_url_patterns.
items
typestring
typearray
webviewUdcJsBridgeWhitelistedUrlPatterns
descriptionList 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
typestring
typearray
webviewWhitelistedUrlPatterns
descriptionList 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
typestring
typearray
typeobject
GetResourceRequest
descriptionRequest message for GetResource.
idGetResourceRequest
properties
context
$refRequestContext
descriptionInformation sent with every request.
resourceKey
$refResourceKey
descriptionIdentifies the Resource being requested.
resourcesToOmit
descriptionSpecify the resources to omit from the response. The server is allowed to ignore this option.
items
$refResourceToOmit
typearray
typeobject
GetResourceResponse
descriptionResponse message for GetResource.
idGetResourceResponse
properties
additionalResources
descriptionAdditional resources that the client should cache.
items
$refResource
typearray
resource
$refResource
descriptionThe returned resource.
typeobject
GetScreenRequest
descriptionRequest message for GetScreen.
idGetScreenRequest
properties
context
$refRequestContext
descriptionInformation sent with every request.
screenId
descriptionIdentifies the screen being requested. See ScreenId enum for possible values.
formatint32
typeinteger
screensToOmit
descriptionSpecify the screens to omit from the response. The server is allowed to ignore this option.
items
$refScreenToOmit
typearray
typeobject
GetScreenResponse
descriptionResponse message for GetScreen.
idGetScreenResponse
properties
additionalScreens
descriptionAdditional screens that the client should cache.
items
$refScreen
typearray
screen
$refScreen
descriptionThe returned screen.
typeobject
GetSignedOutResourceRequest
descriptionRequest message for GetSignedOutResource.
idGetSignedOutResourceRequest
properties
context
$refRequestContext
descriptionInformation sent with every request.
resourceKey
$refResourceKey
descriptionIdentifies the Resource being requested.
resourcesToOmit
descriptionSpecify the resources to omit from the response. The server is allowed to ignore this option.
items
$refResourceToOmit
typearray
typeobject
GetSignedOutResourceResponse
descriptionResponse message for GetSignedOutResource.
idGetSignedOutResourceResponse
properties
additionalResources
descriptionAdditional resources that the client should cache.
items
$refResource
typearray
resource
$refResource
descriptionThe returned resource.
typeobject
GoogleAccountVisualElementConfig
descriptionConfig for Google Account visual elements. It should contain all information required for VE logging such as id and metadata.
idGoogleAccountVisualElementConfig
properties
metadata
$refGoogleAccountVisualElementMetadata
descriptionAdditional metadata for Google Account visual elements
veid
descriptionVisual Element Id from logs/gws/config/identity_metrics/google_account_configuration
formatint32
typeinteger
typeobject
GoogleAccountVisualElementMetadata
descriptionContainer 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.
idGoogleAccountVisualElementMetadata
properties
accountSettingsArea
enum
  • ACCOUNT_SETTINGS_AREA_UNSPECIFIED
  • ABOUT_GOOGLE
  • ABOUT_ME
  • ABOUT_THIS_AD
  • ACCESSIBILITY
  • ACCOUNT_ANNIVERSARY
  • ACCOUNT_DELETED
  • ACCOUNT_ENHANCED_SAFE_BROWSING
  • ACCOUNT_LINKING
  • ACCOUNT_MENU
  • ACTIVITY_CONTROLS
  • ACTIVITY_CONTROLS_DEVICE_INFORMATION
  • ACTIVITY_CONTROLS_LOCATION_HISTORY
  • ACTIVITY_CONTROLS_VOICE_AND_AUDIO_ACTIVITY
  • ACTIVITY_CONTROLS_WEB_AND_APP_ACTIVITY
  • ACTIVITY_CONTROLS_YOUTUBE_HISTORY
  • ACTIVITY_CONTROLS_YOUTUBE_SEARCH_HISTORY
  • ACTIVITY_CONTROLS_YOUTUBE_WATCH_HISTORY
  • ADDRESS
  • ADDRESSBOOK
  • ADDRESSBOOK_SCREEN
  • ADDRESS_ADD
  • ADDRESS_EDIT
  • ADD_ACCOUNT_TO_DEVICE
  • ADS_SETTINGS
  • ADS_SETTINGS_CARD_NOT_ELIGIBLE_LEARN_MORE
  • AGE_DISABLED
  • AGE_VERIFICATION_OPTIONS
  • ALBUM_ARCHIVE
  • ALERT
  • ALTERNATE_EMAIL
  • APP_PASSWORDS
  • AUTOCOMPLETE_SUGGESTIONS
  • BIRTHDAY
  • BIRTHDAY_AGE_STATUS
  • BIRTHDAY_EDIT
  • BLOCKED_USERS
  • BRAND_ACCOUNTS
  • BRAND_ACCOUNT_DELETED
  • BUSINESS_PERSONALIZATION
  • CLP_RECOMMENDED
  • CLP_RECOMMENDED_AUTOFILL
  • CLP_RECOMMENDED_BACKUP
  • CLP_RECOMMENDED_FINDMYDEVICE
  • CLP_RECOMMENDED_NEARBY
  • CLP_RECOMMENDED_PAY
  • CLP_SCREEN
  • COMBINED_RECOVERY_OPTIONS_PAGE
  • COMMUNICATION_PREFERENCES
  • COMMUNICATION_PREFERENCES_LANDING
  • CONNECTED_APPS
  • CONSENT_PRIMITIVE_DEMO_CONFIG
  • CONSTELLATION_CONSENT
  • CONTACTS
  • CONTACT_EMAIL
  • CREDENTIAL_DETAIL
  • CREDENTIAL_LIST
  • DARK_WEB_REPORT_SCAN
  • DARK_WEB_REPORT_SCAN_RECOMMENDED
  • DARK_WEB_REPORT_SCREEN
  • DARK_WEB_REPORT_SETUP_SCREEN
  • DASHBOARD_OUTBOUND_SCREEN
  • DATA_AND_PERSONALIZATION
  • DATA_AND_PRIVACY_DATA_IMPROVES_EXPERIENCE
  • DATA_AND_PRIVACY_DATA_VISIBILITY
  • DELETE_ACCOUNT
  • DELETE_GMAIL
  • DELETE_GOOGLE_ONE
  • DELETE_SERVICES
  • DELETE_SERVICES_OR_ACCOUNT
  • DELETE_YOUTUBE
  • DEPRECATED_PROFILE_DETAILS
  • DEVICE_ACTIVITY_INTRO
  • DEVICE_APPS
  • DEVICE_CONTACTS
  • DEVICE_SETTINGS_ABOUT_PHONE
  • DEVICE_SETTINGS_EMERGENCY_INFO
  • DEVICE_SETTINGS_PAYMENTS
  • DIGITAL_ID_MANAGEMENT_SCREEN
  • DOCUMENT_MANAGEMENT_SCREEN
  • EMAIL
  • FAMILY_CHILD_RESTORE_PAGE_SCREEN
  • FAMILY_CREATE_CONFIRMATION_OR_DETAILS
  • FAMILY_CREATE_CONFIRMATION_OR_DETAILS_DEPRECATED
  • FAMILY_CREATE_FAMILY_CONFIRMATION_SCREEN
  • FAMILY_CREATE_FAMILY_PAGE_SCREEN
  • FAMILY_CREATION
  • FAMILY_DELETE_FAMILY_PAGE_SCREEN
  • FAMILY_DETAILS
  • FAMILY_ENTERTAINMENT
  • FAMILY_HOME_STRUCTURE_SCREEN
  • FAMILY_INVITATION_COMPLETE_PAGE
  • FAMILY_INVITE_MEMBERS
  • FAMILY_INVITE_MEMBERS_PAGE
  • FAMILY_INVITE_SECOND_PARENT
  • FAMILY_LEAVE_FAMILY
  • FAMILY_LINK
  • FAMILY_LIST_PENDING_INVITATIONS_PAGE
  • FAMILY_MANAGEMENT
  • FAMILY_MEMBERS
  • FAMILY_MEMBERS_SUPERVISION_SCREEN
  • FAMILY_MEMBER_OR_INVITATION_DETAILS_PAGE_SCREEN
  • FAMILY_PARENTAL_CONTROLS
  • FAMILY_PARENTAL_CONTROLS_MANAGE_KID_SEARCH_SETTINGS
  • FAMILY_PAYMENT_METHOD
  • FAMILY_PRODUCT_FAMILY_CALENDAR
  • FAMILY_PRODUCT_FAMILY_LINK
  • FAMILY_PRODUCT_GOOGLE_ONE
  • FAMILY_PRODUCT_PHOTOS
  • FAMILY_PRODUCT_PLAY_LIBRARY
  • FAMILY_PRODUCT_YOUTUBE_MUSIC
  • FAMILY_PRODUCT_YOUTUBE_RED
  • FAMILY_PRODUCT_YOUTUBE_UNPLUGGED
  • FAMILY_REMOVE_MEMBER_PAGE
  • FAMILY_SELECT_SECOND_PARENT_CANDIDATELIST_SCREEN
  • FAMILY_SELECT_SECOND_PARENT_PAGE
  • FAMILY_SELECT_TANDEM_PARTNER_PAGE
  • FAMILY_SERVICES
  • FAMILY_SERVICES_CARD
  • FAMILY_TANDEM_PARTNER_SELECTED_PAGE
  • FAMILY_TANDEM_STATUS_PAGE
  • FAMILY_UPGRADE_FOP_PAGE_SCREEN
  • FAMILY_UPGRADE_TOS_PAGE_SCREEN
  • FAQ_CARD_ACCOUNT_DATA_ARTICLE
  • FAQ_CARD_MANAGE_GOOGLE_SETTINGS_ARTICLE
  • FAQ_CARD_RECOVERY_INFORMATION_ARTICLE
  • FAQ_CARD_SUBSCRIPTION_MANAGEMENT_ARTICLE
  • FAQ_CARD_SUSPICIOUS_ACTIVITY_ARTICLE
  • FAUXBAKE
  • FEEDBACK
  • FIND_YOUR_PHONE
  • FITBIT_PRIVACY_CENTER_CONNECTED_APPS
  • FITBIT_PRIVACY_CENTER_DELETION_CATEGORIES
  • FITBIT_PRIVACY_CENTER_DELETION_CONFIRMATION
  • FITBIT_PRIVACY_CENTER_DELETION_OPTIONS
  • FITBIT_PRIVACY_CENTER_FEATURE
  • FITBIT_PRIVACY_CENTER_FEATURES
  • FITBIT_PRIVACY_CENTER_PAIRED_DEVICES
  • FITBIT_PRIVACY_CENTER_RND_FEATURES
  • FITBIT_PRIVACY_CENTER_SETTINGS
  • FIT_PRIVACY_CENTER_ASSISTANT
  • FIT_PRIVACY_CENTER_CATEGORY_DELETION
  • FIT_PRIVACY_CENTER_DATA_TYPE_DELETION
  • FIT_PRIVACY_CENTER_DEVICES
  • FIT_PRIVACY_CENTER_MANAGE_CATEGORY_SCREEN
  • FIT_PRIVACY_CENTER_MANAGE_DATA
  • FIT_PRIVACY_CENTER_MOBILE_VITALS_SCREEN
  • FIT_PRIVACY_CENTER_PERSONALIZED_SUGGESTIONS
  • FIT_PRIVACY_CENTER_SETTINGS
  • GELLER_SUPERVISION_SCREEN
  • GENDER
  • GENERAL_LIGHT
  • GEO_HOME_ADDRESS
  • GEO_HOME_WORK_ADDRESS
  • GEO_WORK_ADDRESS
  • GESTURE_BASED_REAUTH
  • GMSCORE_SETTINGS_CLEAR_APP_STATE_SCREEN
  • GMSCORE_SETTINGS_HELP_SCREEN
  • GMSCORE_SETTINGS_ITEM_SCREEN
  • GMSCORE_SETTINGS_OPEN_SOURCE_LICENSES_SCREEN
  • GMSCORE_SETTINGS_SUBCATEGORY_SCREEN
  • GMSCORE_SETTINGS_SYSTEM_COMPONENT_UPDATE_SETTINGS_SCREEN
  • GMSCORE_SETTINGS_USAGE_REPORTING_SCREEN
  • GOOGLE_ACCOUNT_COMMUNITY_SCREEN
  • GOOGLE_ACCOUNT_HELP_CENTER
  • GOOGLE_ACCOUNT_MARKETING_PAGE
  • GOOGLE_ACCOUNT_PIN
  • GOOGLE_BUSINESS_PROFILES
  • GOOGLE_BUSINESS_PROFILES_SINGLE_LISTING
  • GOOGLE_DASHBOARD
  • GOOGLE_DASHBOARD_ANDROID
  • GOOGLE_GUIDE
  • GOOGLE_MY_BUSINESS_PORTAL
  • GOOGLE_MY_BUSINESS_SIGN_UP
  • GOOGLE_ONE_ALL_AVAILABLE_SUPPORT_OPTIONS_SCREEN
  • GOOGLE_ONE_CHAT_SUPPORT
  • GOOGLE_ONE_EMAIL_SUPPORT
  • GOOGLE_ONE_HOME
  • GOOGLE_ONE_PHONE_SUPPORT
  • GOOGLE_ONE_STORAGE
  • GOOGLE_ONE_STORAGE_MANAGEMENT
  • GOOGLE_ONE_SUPPORT
  • GOOGLE_PAY_ADD_PAYMENT_METHOD
  • GOOGLE_PAY_EXPERIENCE_SCREEN
  • GOOGLE_PAY_MANAGE_PAYMENT_METHODS
  • GOOGLE_PAY_PAYMENT_METHOD_DETAILS
  • GOOGLE_PLUS_SETTINGS
  • GOOGLE_PRODUCT_FORUM
  • GRADUATION
  • HELP
  • HELP_CENTER
  • HELP_CENTER_ARTICLE_SCREEN
  • HELP_CENTER_SEARCH_ITEM
  • HOME
  • HOME_ACCOUNT_TYPE_CARD_ADULT_GRADUATION
  • HOME_ACCOUNT_TYPE_CARD_GLA_LEARN_MORE
  • HOME_ACCOUNT_TYPE_CARD_TEEN_GRADUATION
  • HOME_INTENT
  • HOME_NATIVE_NAVIGATION
  • IDENTITY_DOCUMENT
  • IDENTITY_VAULT_CONSENT
  • INACTIVE_ACCOUNT_MANAGER
  • INPUT_TOOLS
  • KID_ONBOARDING
  • LANGUAGE
  • LEGAL_ADDRESS_DETAIL
  • LEGAL_ADDRESS_EDIT
  • LEGAL_NAME_DETAIL
  • LEGAL_NAME_EDIT
  • LESS_SECURE_APPS
  • LESS_SECURE_APPS_HELP_ARTICLE
  • LIMITED_DISABLES
  • LINKED_APPS
  • LINKED_SERVICES_PRIMITIVE_SCREEN
  • LOCATION_DATA_POLICY
  • LOCATION_SHARING
  • MAPS_TIMELINE
  • MERCHANT_CENTER
  • MINOR_MODE_EXIT
  • MINOR_MOMENT
  • MULTIPLE
  • MY_ACTIVITY
  • MY_ACTIVITY_MANAGE_GOOGLE_SEARCH_HISTORY_SCREEN
  • MY_ACTIVITY_MANAGE_WEP_AND_APP_ACTIVITY
  • MY_ACTIVITY_MANAGE_YT_HISTORY
  • MY_ACTIVITY_PRODUCT_SCREEN
  • MY_ACTIVITY_YOUTUBE_WATCH_AND_SEARCH_HISTORY
  • MY_AD_CENTER
  • MY_AD_CENTER_HOME
  • NAME
  • NICKNAME
  • OBAKE_PICTURE_PICKER_AI_SELFIES
  • OBAKE_PICTURE_PICKER_CROP
  • OBAKE_PICTURE_PICKER_GOOGLE_PHOTOS
  • OBAKE_PICTURE_PICKER_ILLUSTRATION
  • OBAKE_PICTURE_PICKER_PAST_PROFILE_PHOTOS
  • OBAKE_PICTURE_PICKER_REMOVE_PICTURE
  • OFFLINE_OTP
  • ONBOARDING_SCREEN
  • OPAQUE_ID
  • OTHER_CREDENTIAL_LIST
  • OUTREACH_LANDING_PAGE
  • PAASK_ACCOUNT_NOTIFIER
  • PARTNER_AD_SETTINGS
  • PASSWORD
  • PASSWORD_AWARENESS
  • PASSWORD_CHECKUP
  • PASSWORD_LIGHT
  • PASSWORD_MANAGER_MARKETING_PAGE
  • PAYMENTS_ADD_FOP_PROMPT_TARGET
  • PAYMENTS_AND_SUBSCRIPTIONS
  • PAYMENTS_BILLING_ACCOUNT_BANK_NEED_MANDATE_ACCEPTANCE_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_BANK_NOT_VERIFIED_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_BANK_PAYMENT_DECLINED_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_BANK_TERMS_AND_CONDITIONS_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_CARD_CLOSED_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_CARD_EXPIRED_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_CARD_EXPIRING_SOON_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_CARD_PAYMENT_DECLINED_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_GENERIC_PAYMENT_DECLINED_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_GENERIC_RISK_SUSPENDED_PROMPT_TARGET
  • PAYMENTS_BILLING_ACCOUNT_MISSING_PAYMENT_METHOD_PROMPT_TARGET
  • PAYMENTS_CENTER
  • PAYMENTS_CENTER_BILLING_ADDRESSES
  • PAYMENTS_CENTER_LEGAL_ADDRESS
  • PAYMENTS_CUSTOMER_OR_INSTRUMENT_RISK_VERIFICATION_PROMPT_TARGET
  • PAYMENTS_FUNDS_GUARANTEE_INSTRUMENT_DECLINED_PROMPT_TARGET
  • PAYMENTS_INSTRUMENT_BANK_NOT_VERIFIED_PROMPT_TARGET
  • PAYMENTS_INSTRUMENT_CARD_EXPIRED_PROMPT_TARGET
  • PAYMENTS_SANCTIONS_ADHOC_PROMPT_TARGET
  • PAYMENTS_SANCTIONS_CONFIRMED_PROMPT_TARGET
  • PAYMENTS_SANCTIONS_CRIMEA_PROMPT_TARGET
  • PAYMENTS_SANCTIONS_PARTIAL_SUSPENSION_FIXFLOW_PROMPT_TARGET
  • PAYMENTS_SANCTIONS_PARTIAL_SUSPENSION_HC_PROMPT_TARGET
  • PAYMENTS_SANCTIONS_SUSPENSION_FIXFLOW_PROMPT_TARGET
  • PAYMENTS_SANCTIONS_SUSPENSION_HC_PROMPT_TARGET
  • PAYMENT_METHODS
  • PAYMENT_METHOD_ADD
  • PAYMENT_METHOD_DETAIL
  • PAYMENT_METHOD_EDIT
  • PAYMENT_METHOD_LIST
  • PEOPLE_AND_SHARING
  • PERSONAL_INFO
  • PERSONAL_RESULTS_IN_SEARCH
  • PHONE
  • PHONE_SIGN_IN
  • POST_HIJACK_MITIGATION
  • PREFERENCES_LANDING
  • PRIMARY_EMAIL
  • PRIVACY_ADVISOR_ASSISTANT
  • PRIVACY_ADVISOR_MAPS
  • PRIVACY_ADVISOR_MESSAGES
  • PRIVACY_ADVISOR_SEARCH
  • PRIVACY_ADVISOR_YOUTUBE
  • PRIVACY_CHECKUP
  • PRIVACY_LANDING
  • PRIVACY_POLICY
  • PRIVACY_SAFE_SEARCH
  • PRODUCT_PROFILE_SCREEN
  • PROFILE
  • PROFILE_ADDRESS_ADD
  • PROFILE_ADDRESS_EDIT
  • PROFILE_ADD_ABOUT
  • PROFILE_ADD_CONTACT_INFO
  • PROFILE_ADD_WORK_AND_EDUCATION
  • PROFILE_CARD_LEARN_MORE
  • PROFILE_CHAT_EDIT
  • PROFILE_CUSTOM_URLS
  • PROFILE_DETAILS
  • PROFILE_DISCOVERABILITY
  • PROFILE_DISCOVERY
  • PROFILE_DISPLAY_NAME_EDIT
  • PROFILE_EDUCATION
  • PROFILE_EDUCATION_EDIT
  • PROFILE_EMAIL_EDIT
  • PROFILE_INTRODUCTION_EDIT
  • PROFILE_LIMITED_PROFILE
  • PROFILE_LIMITED_PROFILE_EDIT
  • PROFILE_LINKS
  • PROFILE_LINKS_EDIT
  • PROFILE_NAME
  • PROFILE_NAME_EDIT
  • PROFILE_NICKNAME_EDIT
  • PROFILE_OCCUPATION_EDIT
  • PROFILE_ORGANIZATION_INFO
  • PROFILE_PHONE_EDIT
  • PROFILE_PHOTO_EDIT
  • PROFILE_PICTURE
  • PROFILE_PICTURE_ADD_PICTURE_DIALOG
  • PROFILE_PICTURE_CHANGE_PICTURE_DIALOG
  • PROFILE_PICTURE_REMOVE_PICTURE_DIALOG
  • PROFILE_PLACES
  • PROFILE_PLACES_EDIT
  • PROFILE_PRONOUNS_EDIT
  • PROFILE_VANITY_URL_EDIT_SCREEN
  • PROFILE_WORKSPACE
  • PROFILE_WORK_HISTORY
  • PROFILE_WORK_HISTORY_EDIT
  • PURCHASES
  • PURCHASES_CARD_DESCRIPTION_LEARN_MORE_LINK
  • PURCHASES_DETAIL
  • RECENTLY_USED_DEVICES
  • RECENT_SECURITY_EVENTS
  • RECOVERY_CONTACTS
  • RECOVERY_CONTACTS_PAGE
  • RECOVERY_EMAIL
  • RECOVERY_PHONE
  • REMOVE_ACCOUNT_FROM_DEVICE
  • REPORT_PROBLEM
  • RESCUE_CODE_PAGE
  • RESERVATIONS
  • RESERVATIONS_CARD_DESCRIPTION_LEARN_MORE_LINK
  • SAFER
  • SAFER_INTERNET_DAY
  • SAFER_PASSWORD_MANAGER_SCREEN
  • SAFETY_ANDROID_SCREEN
  • SAFETY_CHROME_SCREEN
  • SAFETY_GENERAL_SCREEN
  • SAFETY_GMAIL_SCREEN
  • SAFETY_MEET_SCREEN
  • SAFETY_PAYMENT_SCREEN
  • SAFETY_PHOTO_SCREEN
  • SAFETY_PRIVACY_ADS_SCREEN
  • SAFETY_SEARCH_SCREEN
  • SAFE_SEARCH
  • SAFE_SEARCH_SCREEN
  • SANDBOX_ONBOARDING_FLOW
  • SAVED_PASSWORDS
  • SEARCH
  • SEARCH_CARD_OUTBOUND_SCREEN
  • SEARCH_SETTINGS
  • SECURITY
  • SECURITY_CHECKUP
  • SECURITY_CHECKUP_INTRO
  • SECURITY_CODE
  • SECURITY_COMBINED_RECOVERY_OPTIONS
  • SECURITY_FIND_PHONE
  • SECURITY_KEYS
  • SECURITY_LANDING
  • SECURITY_QUESTION
  • SECURITY_SIGN_IN_AUTHENTICATOR_SCREEN
  • SECURITY_SIGN_IN_BACKUP_CODES_SCREEN
  • SECURITY_SIGN_IN_BACKUP_PHONES_SCREEN
  • SECURITY_SIGN_IN_GOOGLE_PROMPT_SCREEN
  • SECURITY_SIGN_IN_PASSKEYS_SCREEN
  • SECURITY_SIGN_IN_PASSWORD_OPTIONAL
  • SECURITY_SIGN_IN_RESCUE_CODE
  • SECURITY_SIGN_IN_SECURITY_KEYS_SCREEN
  • SECURITY_SIGN_IN_TWO_STEP_VERIFICATION_PHONE_SCREEN
  • SECURITY_SIGN_IN_WITH_GOOGLE_APPS
  • SECURITY_THIRD_PARTY_APPS
  • SECURITY_THIRD_PARTY_MANAGEMENT_LIST
  • SECURITY_THIRD_PARTY_MANAGEMENT_OVERVIEW
  • SECURITY_TITANIUM_HELP
  • SHARED_ENDORSEMENTS
  • SHIELDED_EMAIL
  • SHIELDED_EMAIL_CREATE_CONFIRMATION
  • SHIELDED_EMAIL_CREATE_FOR_APP
  • SHIELDED_EMAIL_CREATE_FOR_SITE
  • SHIELDED_EMAIL_DETAILS
  • SHIELDED_EMAIL_FACET_LINK_TARGET
  • SHIELDED_EMAIL_INACTIVE_LIST
  • SHIELDED_EMAIL_SELECT_RESERVED_EMAIL
  • SHIELDED_EMAIL_SETTINGS
  • SID_PASSWORD_MANAGER_NATIVE_NAVIGATION_SCREEN
  • SIGNED_OUT_AD_SETTINGS
  • SIGNED_OUT_CREATE_NEW_ACCOUNT_LINK
  • SIGNED_OUT_GOOGLE_ANALYTICS
  • SIGNED_OUT_LEARN_MORE_ABOUT_COOKIES_LINK
  • SIGNED_OUT_SEARCH_PERSONALIZATION
  • SIGNED_OUT_YOUTUBE_HISTORY
  • SIGNING_IN_TO_GOOGLE_INTRO
  • SIGNIN_SELFIE_VIDEO
  • STORAGE
  • SUBSCRIPTIONS
  • SUGGEST_IDEA
  • SUPPORT
  • TAKEOUT
  • TAKEOUT_DOWNLOADS
  • TERMS_OF_SERVICE
  • THIRD_PARTY_CONNECTIONS_DETAILS
  • THIRD_PARTY_CONNECTIONS_LIST
  • THIRD_PARTY_CONNECTIONS_OVERVIEW
  • THIRD_PARTY_CONNECTIONS_SETTINGS
  • TITANIUM_ENROLL
  • TITANIUM_SETTINGS
  • TITANIUM_SOCIAL_RECOVERY
  • TITANIUM_UNAVAILABLE
  • TITANIUM_UNENROLL
  • TURN_OFF_PROFILE_DISCOVERY
  • TWITTER_SUPPORT
  • TWO_STEP_VERIFICATION
  • TWO_STEP_VERIFICATION_BACKUP_CODES
  • TWO_STEP_VERIFICATION_GOOGLE_AUTHENTICATOR
  • TWO_STEP_VERIFICATION_GOOGLE_PROMPT
  • TWO_STEP_VERIFICATION_PASSKEYS
  • TWO_STEP_VERIFICATION_PHONE_NUMBERS
  • TWO_STEP_VERIFICATION_SECURITY_KEYS
  • UNICORN_LITE_PROFILE_INPUT_TOOLS
  • UNICORN_LITE_PROFILE_LANGUAGE
  • UNICORN_LITE_PROFILE_WEB_PREFERENCES
  • UNIFIED_ONBOARDING
  • UNUSED_DEVICE_CONTACTS
  • USE_APP_WITHOUT_ACCOUNT
  • VIDEO_VERIFICATION
  • VIDEO_VERIFICATION_COLLECTION
  • WARM_WELCOME_FLOW
  • WEB_APPROVAL
  • YOUTUBE_FAMILY_CENTER
enumDeprecated
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • True
  • True
  • True
  • True
  • True
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • True
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • True
  • True
  • True
  • False
  • True
  • False
  • False
  • True
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
enumDescriptions
  • go/keep-sorted start newline_separated=yes ResourceId.ABOUT_GOOGLE_SCREEN
  • ScreenId.PRIVACY_ABOUT_ME ResourceId.PRIVACY_ABOUT_ME_SCREEN MyAccountArea.ABOUT_ME
  • ResourceId.PRIVACY_ABOUT_THIS_AD_SCREEN
  • ResourceId.PREFERENCES_ACCESSIBILITY_SCREEN MyAccountArea.ACCESSIBILITY
  • ResourceId.ACCOUNT_ANNIVERSARY_SCREEN
  • No ResourceId
  • ResourceId.SECURITY_ACCOUNT_ENHANCED_SAFE_BROWSING_SCREEN
  • No ResourceId
  • ResourceId.ACCOUNT_MENU_CARD_DECK
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS ResourceId.PRIVACY_ACTIVITY_CONTROLS_SCREEN MyAccountArea.ACTIVITY_CONTROLS
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS_DEVICE_INFO ResourceId.PRIVACY_ACTIVITY_CONTROLS_DEVICE_INFO_SCREEN
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS_LOCATION_HISTORY ResourceId.PRIVACY_ACTIVITY_CONTROLS_LOCATION_HISTORY_SCREEN
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS_VOICE_AND_AUDIO ResourceId.PRIVACY_ACTIVITY_CONTROLS_VOICE_AND_AUDIO_SCREEN
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS_WEB_AND_APP ResourceId.PRIVACY_ACTIVITY_CONTROLS_WEB_AND_APP_SCREEN
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS_YT_HISTORY ResourceId.PRIVACY_ACTIVITY_CONTROLS_YT_HISTORY_SCREEN
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS_YT_SEARCH_HISTORY ResourceId.PRIVACY_ACTIVITY_CONTROLS_YT_SEARCH_HISTORY_SCREEN
  • ScreenId.PRIVACY_ACTIVITY_CONTROLS_YT_WATCH_HISTORY ResourceId.PRIVACY_ACTIVITY_CONTROLS_YT_WATCH_HISTORY_SCREEN
  • No ResourceId.
  • No ResourceId.
  • No ResourceId.
  • No ResourceId.
  • No ResourceId.
  • ResourceId.ADD_ACCOUNT_TO_DEVICE_SCREEN
  • ScreenId.PRIVACY_ADS_SETTINGS ResourceId.PRIVACY_ADS_SETTINGS_SCREEN MyAccountArea.ADS_SETTINGS
  • Previously ResourceId.ADS_SETTINGS_CARD_NOT_ELIGIBLE_LEARN_MORE_LINK_SCREEN
  • No ResourceId MyAccountArea.AGE_DISABLED
  • No ScreenId ResourceId.AGE_VERIFICATION_OPTIONS_SCREEN
  • ResourceId.ALBUM_ARCHIVE_SCREEN
  • No ResourceId
  • ResourceId.ALTERNATE_EMAIL_SCREEM MyAccountArea.ALTERNATE_EMAIL
  • ScreenId.SECURITY_APP_PASSWORDS ResourceId.SECURITY_APP_PASSWORDS_SCREEN MyAccountArea.MANAGE_APP_PASSWORDS
  • ScreenId.PRIVACY_CONTACT_SUGGESTIONS ResourceId.PRIVACY_CONTACT_SUGGESTIONS_SCREEN
  • ScreenId.PRIVACY_BIRTHDAY ResourceId.PRIVACY_BIRTHDAY_SCREEN MyAccountArea.BIRTHDAY
  • ResourceId.BIRTHDAY_AGE_STATUS_SCREEN
  • ResourceId.BIRTHDAY_EDIT_SCREEN
  • ScreenId.PRIVACY_BLOCKED_USERS ResourceId.PRIVACY_BLOCKED_USERS_SCREEN MyAccountArea.BLOCKED_USERS
  • No ResourceId
  • No ResourceId
  • ResourceId.BUSINESS_PERSONALIZATION_SCREEN
  • ResourceId.CLP_RECOMMENDED_SCREEN
  • ResourceId.CLP_RECOMMENDED_AUTOFILL_SCREEN
  • ResourceId.CLP_RECOMMENDED_BACKUP_SCREEN
  • ResourceId.CLP_RECOMMENDED_FINDMYDEVICE_SCREEN
  • ResourceId.CLP_RECOMMENDED_NEARBY_SCREEN
  • ResourceId.CLP_RECOMMENDED_PAY_SCREEN
  • ResourceId.CLP_SCREEN
  • No ResourceId Deprecated, please use SECURITY_COMBINED_RECOVERY_OPTIONS instead.
  • ResourceId.PRIVACY_COMMUNICATION_PREFERENCES_SCREEN
  • No ResourceId
  • ScreenId.SECURITY_CONNECTED_APPS ResourceId.SECURITY_CONNECTED_APPS_SCREEN MyAccountArea.CONNECTED_APPS
  • ResourceId.CONSENT_PRIMITIVE_DEMO_CONFIG_SCREEN
  • ScreenId.CONSTELLATION_CONSENT ResourceId.CONSTELLATION_CONSENT_SCREEN
  • ScreenId.PRIVACY_CONTACTS ResourceId.PRIVACY_CONTACTS_SCREEN
  • ScreenId.MISC_CONTACT_EMAIL ResourceId.MISC_CONTACT_EMAIL_SCREEN MyAccountArea.CONTACT_EMAIL
  • No ResourceId.
  • No ResourceId.
  • ResourceId.DARK_WEB_REPORT_SCAN
  • ResourceId.DARK_WEB_REPORT_SCAN_RECOMMENDED
  • ResourceId.DARK_WEB_REPORT_SCREEN
  • ResourceId.DARK_WEB_REPORT_SETUP_SCREEN
  • ScreenId.DASHBOARD_OUTBOUND ResourceId.DASHBOARD_OUTBOUND_SCREEN No MyAccountAreaz;
  • ResourceId.DATA_AND_PERSONALIZATION_SCREEN
  • ResourceId.DATA_AND_PRIVACY_DATA_IMPROVES_EXPERIENCE_SCREEN
  • ResourceId.DATA_AND_PRIVACY_DATA_VISIBILITY_SCREEN
  • ScreenId.PREFERENCES_DELETE_ACCOUNT ResourceId.PREFERENCES_DELETE_ACCOUNT_SCREEN MyAccountArea.DELETE_ACCOUNT
  • No ResourceId
  • No ResourceId
  • ScreenId.PREFERENCES_DELETE_SERVICES ResourceId.PREFERENCES_DELETE_SERVICES_SCREEN MyAccountArea.DELETE_PRODUCTS
  • ResourceId.DELETE_SERVICES_OR_ACCOUNT_SCREEN
  • No ResourceId MyAccountArea.DELETE_YOUTUBE
  • No ResourceId Do not use
  • ResourceId.DEVICE_ACTIVITY_INTRO_SCREEN
  • ResourceId.PRIVACY_DEVICE_APPS_SCREEN
  • ResourceId.PRIVACY_DEVICE_CONTACTS_SCREEN
  • ResourceId.DEVICE_SETTINGS_ABOUT_PHONE_SCREEN MyAccountArea.DEVICE_SETTINGS_ABOUT_PHONE
  • ResourceId.DEVICE_SETTINGS_EMERGENCY_INFO_SCREEN MyAccountArea.DEVICE_SETTINGS_EMERGENCY_INFO
  • ResourceId.DEVICE_SETTINGS_PAYMENTS_SCREEN MyAccountArea.DEVICE_SETTINGS_PAYMENTS
  • ResourceId.DIGITAL_ID_MANAGEMENT_SCREEN
  • ResourceId.DOCUMENT_MANAGEMENT_SCREEN
  • ScreenId.PRIVACY_EMAIL ResourceId.PRIVACY_EMAIL_SCREEN MyAccountArea.EMAIL
  • ResourceId.FAMILY_CHILD_RESTORE_PAGE_SCREEN
  • ResourceId.FAMILY_CREATE_CONFIRMATION_OR_DETAILS_SCREEN
  • Created by mistake, do not use
  • ResourceId.FAMILY_CREATE_FAMILY_CONFIRMATION_SCREEN
  • ResourceId.FAMILY_CREATE_FAMILY_PAGE_SCREEN
  • ResourceId.FAMILY_CREATION_SCREEN
  • ResourceId.FAMILY_DELETE_FAMILY_PAGE_SCREEN
  • ResourceId.FAMILY_DETAILS_SCREEN
  • ResourceId.FAMILY_ENTERTAINMENT_SCREEN
  • ResourceId.FAMILY_HOME_STRUCTURE_SCREEN
  • ResourceId.FAMILY_INVITATION_COMPLETE_PAGE_SCREEN
  • ResourceId.FAMILY_INVITE_MEMBERS_SCREEN
  • ResourceId.FAMILY_INVITE_MEMBERS_PAGE_SCREEN
  • ResourceId.FAMILY_INVITE_SECOND_PARENT_SCREEN
  • ResourceId.FAMILY_LEAVE_FAMILY_SCREEN
  • ResourceId.FAMILY_LINK_SCREEN
  • ResourceId.FAMILY_LIST_PENDING_INVITATIONS_PAGE_SCREEN
  • ScreenId.PREFERENCES_FAMILY_MANAGEMENT ResourceId.PREFERENCES_FAMILY_MANAGEMENT_SCREEN MyAccountArea.MANAGE_FAMILY_GROUP
  • ResourceId.FAMILY_MEMBERS_SCREEN
  • ResourceId.FAMILY_MEMBERS_SUPERVISION_SCREEN
  • ResourceId.FAMILY_MEMBER_OR_INVITATION_DETAILS_PAGE_SCREEN
  • ResourceId.FAMILY_PARENTAL_CONTROLS_SCREEN
  • ResourceId.FAMILY_PARENTAL_CONTROLS_MANAGE_KID_SEARCH_SETTINGS_SCREEN
  • ResourceId.FAMILY_PAYMENT_METHOD_SCREEN
  • No ScreenId ResourceId.FAMILY_PRODUCT_FAMILY_CALENDAR_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FAMILY_PRODUCT_FAMILY_LINK_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FAMILY_PRODUCT_GOOGLE_ONE_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FAMILY_PRODUCT_PHOTOS_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FAMILY_PRODUCT_PLAY_LIBRARY_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FAMILY_PRODUCT_YOUTUBE_MUSIC_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FAMILY_PRODUCT_YOUTUBE_RED_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FAMILY_PRODUCT_YOUTUBE_UNPLUGGED_SCREEN No MyAccountArea
  • ResourceId.FAMILY_REMOVE_MEMBER_PAGE_SCREEN
  • ResourceId.FAMILY_SELECT_SECOND_PARENT_CANDIDATELIST_SCREEN
  • ResourceId.FAMILY_SELECT_SECOND_PARENT_PAGE_SCREEN
  • ResourceId.FAMILY_SELECT_TANDEM_PARTNER_PAGE_SCREEN
  • ResourceId.FAMILY_SERVICES_SCREEN
  • ResourceId.FAMILY_SERVICES_CARD_SCREEN
  • ResourceId.FAMILY_TANDEM_PARTNER_SELECTED_PAGE_SCREEN
  • ResourceId.FAMILY_TANDEM_STATUS_PAGE_SCREEN
  • ResourceId.FAMILY_UPGRADE_FOP_PAGE_SCREEN
  • ResourceId.FAMILY_UPGRADE_TOS_PAGE_SCREEN
  • ResourceId.FAQ_CARD_ACCOUNT_DATA_ARTICLE_SCREEN
  • ResourceId.FAQ_CARD_MANAGE_GOOGLE_SETTINGS_ARTICLE_SCREEN
  • ResourceId.FAQ_CARD_RECOVERY_INFORMATION_ARTICLE_SCREEN
  • ResourceId.FAQ_CARD_SUBSCRIPTION_MANAGEMENT_ARTICLE_SCREEN
  • ResourceId.FAQ_CARD_SUSPICIOUS_ACTIVITY_ARTICLE_SCREEN
  • ResourceId.FAUXBAKE_SCREEN
  • ResourceId.FEEDBACK_SCREEN
  • ResourceId.FIND_YOUR_PHONE_SCREEN MyAccountArea.FIND_YOUR_PHONE
  • ResourceId.FITBIT_PRIVACY_CENTER_CONNECTED_APPS_SCREEN
  • ResourceId.FITBIT_PRIVACY_CENTER_DELETION_CATEGORIES_SCREEN
  • ResourceId.FITBIT_PRIVACY_CENTER_DELETION_CONFIRMATION_SCREEN
  • ResourceId.FITBIT_PRIVACY_CENTER_DELETION_OPTIONS_SCREEN
  • ScreenId.FITBIT_PRIVACY_CENTER_FEATURE ResourceId.FITBIT_PRIVACY_CENTER_FEATURE_SCREEN No MyAccountArea
  • ScreenId.FITBIT_PRIVACY_CENTER_FEATURES ResourceId.FITBIT_PRIVACY_CENTER_FEATURES_SCREEN No MyAccountArea
  • ResourceId.FITBIT_PRIVACY_CENTER_PAIRED_DEVICES_SCREEN
  • ResourceId.FITBIT_PRIVACY_CENTER_RND_FEATURES_SCREEN
  • ScreenId.FITBIT_PRIVACY_CENTER_SETTINGS ResourceId.FITBIT_PRIVACY_CENTER_SETTINGS_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_ASSISTANT_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_CATEGORY_DELETION_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_DATA_TYPE_DELETION_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_DEVICES_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_MANAGE_CATEGORY_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_MANAGE_DATA_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_MOBILE_VITALS_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_PERSONALIZED_SUGGESTIONS_SCREEN No MyAccountArea
  • No ScreenId ResourceId.FIT_PRIVACY_CENTER_SETTINGS_SCREEN No MyAccountArea
  • ResourceId.GELLER_SUPERVISION_SCREEN
  • ScreenId.PRIVACY_GENDER ResourceId.PRIVACY_GENDER_SCREEN MyAccountArea.GENDER
  • No ResourceId
  • ResourceId.GEO_HOME_ADDRESS_SCREEN
  • ResourceId.GEO_HOME_WORK_ADDRESS_SCREEN
  • ResourceId.GEO_WORK_ADDRESS_SCREEN
  • ScreenId.GESTURE_BASED_REAUTH ResourceId.GESTURE_BASED_REAUTH_SCREEN
  • ResourceId.GMSCORE_SETTINGS_CLEAR_APP_STATE_SCREEN
  • ResourceId.GMSCORE_SETTINGS_HELP_SCREEN
  • ResourceId.GMSCORE_SETTINGS_ITEM_SCREEN
  • ResourceId.GMSCORE_SETTINGS_OPEN_SOURCE_LICENSES_SCREEN
  • ResourceId.GMSCORE_SETTINGS_SUBCATEGORY_SCREEN
  • ResourceId.GMSCORE_SETTINGS_SYSTEM_COMPONENT_UPDATE_SETTINGS_SCREEN
  • ResourceId.GMSCORE_SETTINGS_USAGE_REPORTING_SCREEN
  • ResourceId.GOOGLE_ACCOUNT_COMMUNITY_SCREEN
  • ResourceId.GOOGLE_ACCOUNT_HELP_CENTER_SCREEN
  • ResourceId.GOOGLE_ACCOUNT_MARKETING_PAGE_SCREEN
  • ScreenId.SECURITY_PIN ResourceId.SECURITY_PIN_SCREEN MyAccountArea.SIGN_IN_PIN
  • ResourceId.GOOGLE_BUSINESS_PROFILES_SCREEN
  • ResourceId.GOOGLE_BUSINESS_PROFILES_SINGLE_LISTING_SCREEN
  • ScreenId.PRIVACY_GOOGLE_DASHBOARD ResourceId.PRIVACY_GOOGLE_DASHBOARD_SCREEN MyAccountArea.GOOGLE_DASHBOARD
  • No ResourceId.
  • ResourceId.GOOGLE_GUIDE_SCREEN
  • ResourceId.GOOGLE_MY_BUSINESS_PORTAL_SCREEN
  • ResourceId.GOOGLE_MY_BUSINESS_SIGN_UP_SCREEN
  • ResourceId.GOOGLE_ONE_ALL_AVAILABLE_SUPPORT_OPTIONS_SCREEN
  • ResourceId.GOOGLE_ONE_CHAT_SUPPORT_SCREEN
  • ResourceId.GOOGLE_ONE_EMAIL_SUPPORT_SCREEN
  • ResourceId.GOOGLE_ONE_HOME_SCREEN
  • ResourceId.GOOGLE_ONE_PHONE_SUPPORT_SCREEN
  • ResourceId.PREFERENCES_GOOGLE_ONE_STORAGE_SCREEN
  • ResourceId.GOOGLE_ONE_STORAGE_MANAGEMENT_SCREEN
  • ResourceId.GOOGLE_ONE_SUPPORT_SCREEN
  • ResourceId.GOOGLE_PAY_ADD_PAYMENT_METHOD_SCREEN
  • ResourceId.GOOGLE_PAY_EXPERIENCE_SCREEN
  • ResourceId.GOOGLE_PAY_MANAGE_PAYMENT_METHODS_SCREEN
  • ResourceId.GOOGLE_PAY_PAYMENT_METHOD_DETAILS_SCREEN
  • ScreenId.PRIVACY_GOOGLE_PLUS_SETTINGS ResourceId.PRIVACY_GOOGLE_PLUS_SETTINGS_SCREEN MyAccountArea.GOOGLE_PLUS_SETTINGS
  • ResourceId.GOOGLE_PRODUCT_FORUM_SCREEN
  • ScreenId.PRIVACY_TAKEOUT_MIGRATION ResourceId.PRIVACY_TAKEOUT_MIGRATION_SCREEN
  • ResourceId.HELP_SCREEN
  • ResourceId.MAIN_HELP_CENTER_SCREEN
  • ResourceId.HELP_CENTER_ARTICLE_SCREEN
  • ResourceId.HELP_CENTER_SEARCH_ITEM_SCREEN
  • ScreenId.MENU_MY_ACCOUNT ResourceId.HOME_SCREEN MyAccountArea.WELCOME
  • ResourceId.HOME_ACCOUNT_TYPE_CARD_ADULT_GRADUATION_LINK_SCREEN
  • ResourceId.HOME_ACCOUNT_TYPE_CARD_GLA_LEARN_MORE_LINK_SCREEN
  • ResourceId.HOME_ACCOUNT_TYPE_CARD_TEEN_GRADUATION_LINK_SCREEN
  • ResourceId.HOME_INTENT
  • ResourceId.HOME_NATIVE_NAVIGATION_SCREEN
  • ResourceId.IDENTITY_DOCUMENT_SCREEN
  • ResourceId.AGE_VERIFICATION_OPTIONS_SCREEN
  • ScreenId.PRIVACY_INACTIVE_ACCOUNT_MANAGER ResourceId.PRIVACY_INACTIVE_ACCOUNT_MANAGER_SCREEN MyAccountArea.INACTIVE
  • ResourceId.PREFERENCES_INPUT_TOOLS_SCREEN MyAccountArea.INPUT_TOOLS
  • ResourceId.KID_ONBOARDING_SCREEN
  • ScreenId.PREFERENCES_LANGUAGE ResourceId.PREFERENCES_LANGUAGE_SCREEN MyAccountArea.LANGUAGE
  • ScreenId.SECURITY_LESS_SECURE_APPS ResourceId.SECURITY_LESS_SECURE_APPS_SCREEN MyAccountArea.LESS_SECURE_APPS
  • ResourceId.LESS_SECURE_APPS_CARD_LEARN_MORE_LINK_SCREEN
  • ResourceId.PREFERENCES_LIMITED_DISABLES_SCREEN
  • ResourceId.LINKED_APPS_SCREEN
  • ResourceId.LINKED_SERVICES_PRIMITIVE_SCREEN
  • ResourceId.LOCATION_DATA_POLICY_SCREEN
  • ScreenId.PRIVACY_LOCATION_SHARING ResourceId.PRIVACY_LOCATION_SHARING_SCREEN MyAccountArea.LOCATION_SHARING
  • ScreenId.PRIVACY_GOOGLE_MAPS_TIMELINE ResourceId.PRIVACY_GOOGLE_MAPS_TIMELINE_SCREEN MyAccountArea.TIMELINE_IN_GOOGLE_MAPS
  • ResourceId.MERCHANT_CENTER_SCREEN
  • ResourceId.MINOR_MODE_EXIT_SCREEN
  • ResourceId.MINOR_MOMENT_SCREEN
  • Not logged, used in dashboards.
  • ScreenId.PRIVACY_MY_ACTIVITY ResourceId.PRIVACY_MY_ACTIVITY_SCREEN MyAccountArea.MY_ACTIVITY
  • ResourceId.PRIVACY_MY_ACTIVITY_MANAGE_GOOGLE_SEARCH_HISTORY_SCREEN
  • ResourceId.PRIVACY_MY_ACTIVITY_MANAGE_WEB_AND_APP_ACTIVITY_SCREEN
  • ResourceId.PRIVACY_MY_ACTIVITY_MANAGE_YT_HISTORY_SCREEN
  • ResourceId.MY_ACTIVITY_PRODUCT_SCREEN
  • ResourceId.MY_ACTIVITY_YOUTUBE_WATCH_AND_SEARCH_HISTORY_SCREEN
  • ResourceId.PRIVACY_MY_AD_CENTER_SCREEN
  • ResourceId.PRIVACY_MY_AD_CENTER_HOME_SCREEN
  • ScreenId.PRIVACY_NAME ResourceId.PRIVACY_NAME_SCREEN MyAccountArea.NAME
  • ScreenId.PRIVACY_NICKNAME ResourceId.PRIVACY_NICKNAME_SCREEN MyAccountArea.NICKNAME
  • ResourceId.OBAKE_PICTURE_PICKER_AI_SELFIES_SCREEN
  • ResourceId.OBAKE_PICTURE_PICKER_CROP_SCREEN
  • ResourceId.OBAKE_PICTURE_PICKER_GOOGLE_PHOTOS_SCREEN
  • ResourceId.OBAKE_PICTURE_PICKER_ILLUSTRATION_SCREEN
  • ResourceId.OBAKE_PICTURE_PICKER_PAST_PROFILE_PHOTOS_SCREEN
  • ResourceId.OBAKE_PICTURE_PICKER_REMOVE_PICTURE_SCREEN
  • ScreenId.SECURITY_OFFLINE_OTP ResourceId.SECURITY_OFFLINE_OTP_SCREEN MyAccountArea.OFFLINE_OTP
  • ResourceId.ONBOARDING_SCREEN
  • ResourceId.SECURITY_OPAQUE_ID_SCREEN
  • No ResourceId.
  • ResourceId.OUTREACH_LANDING_PAGE_SCREEN
  • No ResourceId
  • ResourceId.PRIVACY_PARTNER_AD_SETTINGS_SCREEN
  • ScreenId.SECURITY_PASSWORD ResourceId.SECURITY_PASSWORD_SCREEN MyAccountArea.PASSWORD
  • ScreenId.MISC_PASSWORD_AWARENESS ResourceId.MISC_PASSWORD_AWARENESS_SCREEN
  • ResourceId.PASSWORD_CHECKUP_SCREEN
  • No ResourceId
  • ResourceId.PASSWORD_MANAGER_MARKETING_PAGE_SCREEN
  • ResourceId.PAYMENTS_ADD_FOP_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_AND_SUBSCRIPTIONS_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_BANK_NEED_MANDATE_ACCEPTANCE_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_BANK_NOT_VERIFIED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_BANK_PAYMENT_DECLINED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_BANK_TERMS_AND_CONDITIONS_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_CARD_CLOSED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_CARD_EXPIRED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_CARD_EXPIRING_SOON_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_CARD_PAYMENT_DECLINED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_GENERIC_PAYMENT_DECLINED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_GENERIC_RISK_SUSPENDED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_BILLING_ACCOUNT_MISSING_PAYMENT_METHOD_PROMPT_TARGET_SCREEN
  • ScreenId.PREFERENCES_PAYMENTS_CENTER ResourceId.PREFERENCES_PAYMENTS_CENTER_SCREEN MyAccountArea.PAYMENTS_CENTER
  • No ResourceId
  • No ResourceId
  • ResourceId.PAYMENTS_CUSTOMER_OR_INSTRUMENT_RISK_VERIFICATION_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_FUNDS_GUARANTEE_INSTRUMENT_DECLINED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_INSTRUMENT_BANK_NOT_VERIFIED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_INSTRUMENT_CARD_EXPIRED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_SANCTIONS_ADHOC_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_SANCTIONS_CONFIRMED_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_SANCTIONS_CRIMEA_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_SANCTIONS_PARTIAL_SUSPENSION_FIXFLOW_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_SANCTIONS_PARTIAL_SUSPENSION_HC_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_SANCTIONS_SUSPENSION_FIXFLOW_PROMPT_TARGET_SCREEN
  • ResourceId.PAYMENTS_SANCTIONS_SUSPENSION_HC_PROMPT_TARGET_SCREEN
  • ScreenId.PREFERENCES_PAYMENTS_CENTER_METHODS ResourceId.PREFERENCES_PAYMENTS_CENTER_METHODS_SCREEN MyAccountArea.PAYMENT_METHODS
  • No ResourceId
  • No ResourceId
  • No ResourceId
  • ResourceId.PLATFORM_PAYMENT_METHOD_LIST_SCREEN
  • ResourceId.PEOPLE_AND_SHARING_SCREEN
  • ResourceId.PERSONAL_INFO_SCREEN
  • ResourceId.PRIVACY_PERSONAL_RESULTS_IN_SEARCH_SCREEN
  • ScreenId.PRIVACY_PHONE ResourceId.PRIVACY_PHONE_SCREEN MyAccountArea.PHONE
  • ScreenId.SECURITY_PHONE_SIGN_IN ResourceId.SECURITY_PHONE_SIGN_IN_SCREEN MyAccountArea.PHONE_SIGN_IN
  • No ScreenId ResourceId.SECURITY_POST_HIJACK_MITIGATION_SCREEN
  • No ResourceId MyAccountArea.ACCOUNT_PREFERENCES_LANDING
  • ResourceId.PRIMARY_EMAIL_SCREEN MyAccountArea.PRIMARY_EMAIL_VERIFY
  • ScreenId.PRIVACY_ADVISOR_ASSISTANT ResourceId.PRIVACY_ADVISOR_ASSISTANT
  • ScreenId.PRIVACY_ADVISOR_MAPS ResourceId.PRIVACY_ADVISOR_MAPS
  • No ScreenId ResourceId.PRIVACY_ADVISOR_MESSAGES
  • ScreenId.PRIVACY_ADVISOR_SEARCH ResourceId.PRIVACY_ADVISOR_SEARCH
  • No ScreenId ResourceId.PRIVACY_ADVISOR_YOUTUBE
  • ScreenId.PRIVACY_CHECKUP ResourceId.PRIVACY_CHECKUP_SCREEN MyAccountArea.PRIVACY_CHECKUP
  • ScreenId.MENU_PRIVACY ResourceId.MENU_PRIVACY_SCREEN (unused) MyAccountArea.PRIVACY_LANDING
  • ScreenId.MISC_PRIVACY_POLICY ResourceId.MISC_PRIVACY_POLICY_SCREEN
  • ResourceId.PRIVACY_SAFE_SEARCH_SCREEN
  • ResourceId.PRODUCT_PROFILE_SCREEN
  • ResourceId.PROFILE_SCREEN
  • ResourceId.PROFILE_ADDRESS_ADD_SCREEN
  • ResourceId.PROFILE_ADDRESS_EDIT_SCREEN
  • ResourceId.PROFILE_ADD_ABOUT
  • ResourceId.PROFILE_ADD_CONTACT_INFO
  • ResourceId.PROFILE_ADD_WORK_AND_EDUCATION
  • ResourceId.PROFILE_CARD_LEARN_MORE_LINK
  • ResourceId.PROFILE_CHAT_EDIT_SCREEN
  • ResourceId.PROFILE_CUSTOM_URLS_SCREEN
  • ResourceId.PROFILE_DETAILS_SCREEN
  • ResourceId.PROFILE_DISCOVERABILITY_SCREEN
  • ResourceId.PROFILE_DISCOVERY_SCREEN
  • ResourceId.PROFILE_DISPLAY_NAME_EDIT_SCREEN
  • ResourceId.PROFILE_EDUCATION_SCREEN
  • ResourceId.PROFILE_EDUCATION_EDIT_SCREEN
  • ResourceId.PROFILE_EMAIL_EDIT_SCREEN
  • ResourceId.PROFILE_INTRODUCTION_EDIT_SCREEN
  • ResourceId.PROFILE_LIMITED_PROFILE_SCREEN
  • ResourceId.PROFILE_LIMITED_PROFILE_EDIT_SCREEN
  • ResourceId.PROFILE_LINKS_SCREEN
  • ResourceId.PROFILE_LINKS_EDIT_SCREEN
  • ResourceId.PROFILE_NAME_SCREEN
  • ResourceId.PROFILE_NAME_EDIT_SCREEN
  • ResourceId.PROFILE_NICKNAME_EDIT_SCREEN
  • ResourceId.PROFILE_OCCUPATION_EDIT_SCREEN
  • ResourceId.PROFILE_ORGANIZATION_INFO_SCREEN
  • ResourceId.PROFILE_PHONE_EDIT_SCREEN
  • ResourceId.PROFILE_PHOTO_EDIT_SCREEN
  • ScreenId.PRIVACY_PROFILE_PICTURE ResourceId.PRIVACY_PROFILE_PICTURE_SCREEN MyAccountArea.PROFILE_PHOTO
  • ResourceId.PROFILE_PICTURE_ADD_PICTURE_DIALOG
  • ResourceId.PROFILE_PICTURE_CHANGE_PICTURE_DIALOG
  • ResourceId.PROFILE_PICTURE_REMOVE_PICTURE_DIALOG
  • ResourceId.PROFILE_PLACES_SCREEN
  • ResourceId.PROFILE_PLACES_EDIT_SCREEN
  • ResourceId.PROFILE_PRONOUNS_EDIT_SCREEN
  • ResourceId.PROFILE_VANITY_URL_EDIT_SCREEN
  • ResourceId.PROFILE_WORKSPACE_SCREEN
  • ResourceId.PROFILE_WORK_HISTORY_SCREEN
  • ResourceId.PROFILE_WORK_HISTORY_EDIT_SCREEN
  • ScreenId.PREFERENCES_MY_PURCHASES ResourceId.PREFERENCES_MY_PURCHASES_SCREEN
  • ResourceId.PURCHASES_CARD_DESCRIPTION_LEARN_MORE_LINK_SCREEN
  • ScreenId.PREFERENCES_MY_PURCHASES_DETAIL ResourceId.PREFERENCES_MY_PURCHASES_DETAIL_SCREEN
  • ScreenId.SECURITY_RECENTLY_USED_DEVICES ResourceId.SECURITY_RECENTLY_USED_DEVICES_SCREEN MyAccountArea.RECENT_DEVICES
  • ScreenId.SECURITY_RECENT_SECURITY_EVENTS ResourceId.SECURITY_RECENT_SECURITY_EVENTS_SCREEN MyAccountArea.RECENT_SECURITY_EVENTS
  • ResourceId.RECOVERY_CONTACTS_SCREEN
  • No ResourceId Deprecated, please use RECOVERY_CONTACTS instead.
  • ScreenId.SECURITY_RECOVERY_EMAIL ResourceId.SECURITY_RECOVERY_EMAIL_SCREEN MyAccountArea.RECOVERY_EMAIL
  • ScreenId.SECURITY_RECOVERY_PHONE ResourceId.SECURITY_RECOVERY_PHONE_SCREEN MyAccountArea.RECOVERY_PHONE
  • ResourceId.REMOVE_ACCOUNT_FROM_DEVICE_SCREEN
  • ResourceId.REPORT_PROBLEM_SCREEN
  • No ResourceId Deprecated, please use SECURITY_SIGN_IN_RESCUE_CODE_SCREEN instead.
  • ScreenId.PREFERENCES_MY_RESERVATIONS ResourceId.PREFERENCES_MY_RESERVATIONS_SCREEN
  • ResourceId.PURCHASES_CARD_DESCRIPTION_LEARN_MORE_LINK_SCREEN
  • ResourceId.SAFER_SCREEN
  • ResourceId.SAFER_INTERNET_DAY_SCREEN
  • ResourceId.SAFER_PASSWORD_MANAGER_SCREEN
  • ResourceId.SAFETY_ANDROID_SCREEN
  • ResourceId.SAFETY_CHROME_SCREEN
  • ResourceId.SAFETY_GENERAL_SCREEN
  • ResourceId.SAFETY_GMAIL_SCREEN
  • ResourceId.SAFETY_MEET_SCREEN
  • ResourceId.SAFETY_PAYMENT_SCREEN
  • ResourceId.SAFETY_PHOTO_SCREEN
  • ResourceId.SAFETY_PRIVACY_ADS_SCREEN
  • ResourceId.SAFETY_SEARCH_SCREEN
  • Doesn't map to a ResourceId, and is deprecated as a result.
  • ResourceId.SAFE_SEARCH_SCREEN
  • ResourceId.SANDBOX_ONBOARDING_FLOW
  • ScreenId.SECURITY_SAVED_PASSWORDS ResourceId.SECURITY_SAVED_PASSWORDS_SCREEN
  • ResourceId.SEARCH_SCREEN
  • ResourceId.SEARCH_CARD_OUTBOUND_SCREEN
  • ScreenId.PRIVACY_SEARCH_SETTINGS ResourceId.PRIVACY_SEARCH_SETTINGS_SCREEN MyAccountArea.SEARCH_SETTINGS
  • ResourceId.SECURITY_SCREEN
  • ScreenId.SECURITY_CHECKUP ResourceId.SECURITY_CHECKUP_SCREEN MyAccountArea.SECURITY_CHECKUP MyAccountArea.SECURITY_ADVISOR
  • ScreenId.SECURITY_CHECKUP ResourceId.SECURITY_CHECKUP_SCREEN MyAccountArea.SECURITY_CHECKUP MyAccountArea.SECURITY_ADVISOR
  • No ResourceId
  • ResourceId.SECURITY_COMBINED_RECOVERY_OPTIONS_SCREEN
  • ResourceId.SECURITY_FIND_PHONE_SCREEN
  • ScreenId.SECURITY_SECURITY_KEYS ResourceId.SECURITY_SECURITY_KEYS_SCREEN
  • ScreenId.MENU_SECURITY ResourceId.MENU_SECURITY_SCREEN (unused) MyAccountArea.SECURITY_LANDING
  • ScreenId.SECURITY_SECURITY_QUESTION ResourceId.SECURITY_SECURITY_QUESTION_SCREEN MyAccountArea.SECURITY_QUESTION
  • ResourceId.SECURITY_SIGN_IN_AUTHENTICATOR_SCREEN
  • ResourceId.SECURITY_SIGN_IN_BACKUP_CODES_SCREEN
  • ResourceId.SECURITY_SIGN_IN_BACKUP_PHONES_SCREEN
  • ResourceId.SECURITY_SIGN_IN_GOOGLE_PROMPT_SCREEN
  • ResourceId.SECURITY_SIGN_IN_PASSKEYS_SCREEN
  • No ResourceId
  • ResourceId.SECURITY_SIGN_IN_RESCUE_CODE_SCREEN
  • ResourceId.SECURITY_SIGN_IN_SECURITY_KEYS_SCREEN
  • ResourceId.SECURITY_SIGN_IN_TWO_STEP_VERIFICATION_PHONE_SCREEN
  • ResourceId.SECURITY_SIGN_IN_WITH_GOOGLE_APPS_SCREEN
  • ResourceId.SECURITY_THIRD_PARTY_APPS_SCREEN
  • ResourceId.SECURITY_THIRD_PARTY_MANAGEMENT_LIST_SCREEN
  • ResourceId.SECURITY_THIRD_PARTY_MANAGEMENT_OVERVIEW_SCREEN
  • ResourceId.SECURITY_TITANIUM_HELP_SCREEN
  • ScreenId.PRIVACY_SHARED_ENDORSEMENTS ResourceId.PRIVACY_SHARED_ENDORSEMENTS_SCREEN MyAccountArea.SHARED_ENDORSEMENTS
  • ResourceId.SHIELDED_EMAIL_SCREEN
  • ResourceId.SHIELDED_EMAIL_CREATE_CONFIRMATION_SCREEN
  • ResourceId.SHIELDED_EMAIL_CREATE_FOR_APP_SCREEN
  • ResourceId.SHIELDED_EMAIL_CREATE_FOR_SITE_SCREEN
  • ResourceId.SHIELDED_EMAIL_DETAILS_SCREEN
  • ResourceId.SHIELDED_EMAIL_FACET_LINK_TARGET
  • ResourceId.SHIELDED_EMAIL_INACTIVE_LIST_SCREEN
  • ResourceId.SHIELDED_EMAIL_SELECT_RESERVED_EMAIL_SCREEN
  • ResourceId.SHIELDED_EMAIL_SETTINGS_SCREEN
  • ResourceId.SID_PASSWORD_MANAGER_NATIVE_NAVIGATION_SCREEN
  • ResourceId.SIGNED_OUT_AD_SETTINGS_SCREEN
  • ResourceId.SIGNED_OUT_CREATE_NEW_ACCOUNT_LINK_SCREEN
  • ResourceId.SIGNED_OUT_GOOGLE_ANALYTICS_SCREEN
  • ResourceId.SIGNED_OUT_LEARN_MORE_ABOUT_COOKIES_LINK_SCREEN
  • ResourceId.SIGNED_OUT_SEARCH_PERSONALIZATION_SCREEN
  • ResourceId.SIGNED_OUT_YOUTUBE_HISTORY_SCREEN
  • ResourceId.SIGNING_IN_TO_GOOGLE_INTRO_SCREEN
  • ResourceId.SECURITY_SIGNIN_SELFIE_VIDEO_SCREEN
  • ScreenId.PREFERENCES_STORAGE ResourceId.PREFERENCES_STORAGE_SCREEN MyAccountArea.STORAGE
  • ScreenId.PREFERENCES_MY_SUBSCRIPTIONS ResourceId.PREFERENCES_MY_SUBSCRIPTIONS_SCREEN MyAccountArea.SUBSCRIPTIONS
  • ResourceId.SUGGEST_IDEA_SCREEN
  • ResourceId.SUPPORT_SCREEN
  • ScreenId.PRIVACY_DOWNLOAD_YOUR_DATA ResourceId.PRIVACY_DOWNLOAD_YOUR_DATA_SCREEN MyAccountArea.TAKEOUT
  • No ScreenId ResourceId.TAKEOUT_DOWNLOADS
  • ScreenId.MISC_TERMS_OF_SERVICE ResourceId.TERMS_OF_SERVICE_SCREEN
  • ResourceId.SECURITY_THIRD_PARTY_MANAGEMENT_DETAILS_SCREEN
  • ResourceId.THIRD_PARTY_MANAGEMENT_LIST_SCREEN
  • ResourceId.SECURITY_THIRD_PARTY_MANAGEMENT_OVERVIEW_SCREEN
  • ResourceId.SECURITY_THIRD_PARTY_MANAGEMENT_SETTINGS_SCREEN
  • No ResourceId MyAccountArea.TITANIUM
  • No ResourceId MyAccountArea.TITANIUM
  • No ResourceId MyAccountArea.TITANIUM
  • No ResourceId MyAccountArea.TITANIUM
  • ResourceId.SECURITY_TITANIUM_UNENROLL_SCREEN MyAccountArea.TITANIUM
  • ResourceId.TWITTER_SUPPORT_SCREEN
  • ScreenId.SECURITY_TWO_STEP_VERIFICATION ResourceId.SECURITY_TWO_STEP_VERIFICATION_SCREEN MyAccountArea.TWO_FACTOR_AUTH
  • No ResourceId MyAccountArea.TWO_FACTOR_AUTH
  • No ResourceId MyAccountArea.TWO_FACTOR_AUTH
  • No ResourceId MyAccountArea.TWO_FACTOR_AUTH
  • No ResourceId MyAccountArea.TWO_FACTOR_AUTH
  • No ResourceId MyAccountArea.TWO_FACTOR_AUTH
  • No ResourceId MyAccountArea.TWO_FACTOR_AUTH
  • ResourceId.PREFERENCES_UNICORN_LITE_PROFILE_INPUT_TOOLS_SCREEN
  • ResourceId.PREFERENCES_UNICORN_LITE_PROFILE_LANGUAGE_SCREEN
  • ResourceId.UNICORN_LITE_PROFILE_WEB_PREFERENCES_SCREEN
  • ResourceId.UNIFIED_ONBOARDING_SCREEN
  • This value was added to the enum by mistake in cl/266426798. Removing this dummy enum constant will cause queries to the tables referencing this enum to fail. See b/143863448 for details.
  • ResourceId.USE_APP_WITHOUT_ACCOUNT_SCREEN
  • ResourceId.VIDEO_VERIFICATION_SCREEN
  • ResourceId.VIDEO_VERIFICATION_COLLECTION_SCREEN
  • ResourceId.WARM_WELCOME
  • No ResourceId
  • ResourceId.YOUTUBE_FAMILY_CENTER_SCREEN
typestring
linkMetadata
$refLinkMetadata
descriptionMetadata containing information about the link attached to ASMS resources.
productProfileMetadata
$refProductProfileMetadata
descriptionMetadata containing information about Product Profile resources.
resourceMetadata
$refResourceMetadata
descriptionMetadata containing information about ASMS resources
searchOneboxMetadata
$refSearchOneboxMetadata
descriptionAdditional VE logging metadata for the Onebox.
typeobject
HaTSSurvey
descriptionHaTS survey details.
idHaTSSurvey
properties
siteId
descriptionSite id of the survey
typestring
typeobject
Header
descriptionThe header shown in the SearchResult card.
idHeader
properties
displayEmail
descriptionThe users' display name, displayed underneath the display_name.
typestring
displayName
descriptionThe users' display name, displayed underneath the profile picture.
typestring
image
$refImage
descriptionOptional illustration to be shown instead of a personal header.
profilePictureImage
$refImage
descriptionThe users' profile picture.
visibilityInfoText
descriptionA informational text (containing also a link) explaining the limited visibiliy of the SearcResultCard.
typestring
typeobject
HelpCenterNavigationMetadata
descriptionAdditional information about navigation to the Help Center to distinguish between different articles
idHelpCenterNavigationMetadata
properties
articleId
descriptionIdentifier of the answer, e.g. https://support.google.com/accounts/answer/6304920
typestring
category
descriptionHelp center, e.g. "accounts" or "googlepay". For example https://support.google.com/accounts/answer/6304920
typestring
plink
descriptionShortcut for the article, e.g. https://support.google.com/families?p=noteligible_kid
typestring
topicId
descriptionTopic, e.g. https://support.google.com/families#topic=7327571
typestring
typeobject
HelpCenterSearchItem
descriptionSpecial search item shown below all results that links to a help center article for the entered query. Next id: 5
idHelpCenterSearchItem
properties
icon
$refImage
descriptionIcon shown on the right of the item, e.g. chevron icon.
image
$refImage
descriptionImage displayed on the left of the item.
target
$refTarget
descriptionItem target.
title
$refTitle
descriptionItem title.
typeobject
HelpInfo
deprecatedTrue
descriptionDEPRECATED Holds the data to open help for a specific screen. See go/mobilehelpguide Next Id: 3
idHelpInfo
properties
fallbackSupportUri
descriptionUrl to help center articles, which is used when contextual help is not available (e.g. Android pre-ICS).
typestring
helpCenterContext
descriptionThe helpcenterContext used for contextual help, can be empty on Android.
typestring
typeobject
HelpParams
descriptionused. Next Id: 5
idHelpParams
properties
androidFeedbackCategoryTag
descriptionThis field is used to map a specific category tag for Android feedback. Defaults to "com.google.android.gms.accountsettings.feedback"
typestring
androidPackageOverrideName
descriptionAllows overriding the default Android package name for IPH requests, enabling 1Ps to customize IPH flows. Defaults to "com.google.android.gms.accountsettings".
typestring
context
descriptionThis 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.
typestring
fallbackUrl
descriptionFallbackUrl 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"
typestring
iosFeedbackCategoryTag
descriptionThis field is used to map a specific category tag for iOS feedback. Defaults to "com.google.account.USER_INITIATED_FEEDBACK_REPORT"
typestring
iosPackageOverrideName
descriptionAllows overriding the default iOS package name for IPH requests, enabling 1Ps to customize IPH flows. Defaults to "com.google.accountsettings.ios".
typestring
themedUrl
$refThemedUrl
url
descriptionHelp Center article URL which can be opened with IPH (In Product Help)
typestring
typeobject
Icon
descriptionSpecifies an icon and its description to be rendered in screen element like a menu. Next Id: 3
idIcon
properties
contentDescription
descriptionOptional content description of the icon for better accessibility.
typestring
iconId
descriptionIcon 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.
formatint32
typeinteger
typeobject
Image
descriptionImage 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
idImage
properties
accessibilityLabel
descriptionLocalized accessibility label.
typestring
animatedThemedUrl
$refThemedUrl
descriptionA 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
$refImageUrls
descriptionURLs to images for all screen density buckets in dark theme. Optional, light_urls is used, when absent.
height
descriptionHeight of the image bounding box.
formatint32
typeinteger
imageId
descriptionClient-side placeholder image to use until URL has loaded.
formatint32
typeinteger
imageUrls
$refImageUrls
deprecatedTrue
descriptionURLs to images for all screen density buckets. Deprecated, use light_urls and dark_urls instead.
lightUrls
$refImageUrls
descriptionURLs to images for all screen density buckets in light theme.
themedUrl
$refThemedUrl
descriptionA 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
deprecatedTrue
descriptionThe 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.
typestring
width
descriptionWidth of the image bounding box.
formatint32
typeinteger
typeobject
ImageBlock
descriptionA block containing an image.
idImageBlock
properties
image
$refImage
descriptionImage.
typeobject
ImageUnit
descriptionImage unit
idImageUnit
properties
image
$refImage
descriptionImage
typeobject
ImageUrls
descriptionThis 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.
idImageUrls
properties
urlX1
descriptionThe URL of a PNG, GIF, JPEG, or BMP image.
typestring
urlX2
descriptionThe URL of the X2 version of the image.
typestring
urlX3
descriptionThe URL of the X3 version of the image.
typestring
urlX4
descriptionThe URL of the X4 version of the image.
typestring
typeobject
InitialSearchScreenComponents
descriptionData required to render the initial search screen. Next id: 5
idInitialSearchScreenComponents
properties
allowedPrecheckedResources
descriptionList of allowed (searchable) Screen ResourceKeys. By default this is a list of SearchItem targets (though it can contain different list of ResourceKeys)
items
$refResourceKey
typearray
searchItemsSections
descriptionList of items shown when no search terms are entered. The items are sorted by title.
items
$refSearchItemSection
typearray
typeobject
IntArray
descriptionAn int array
idIntArray
properties
values
descriptionvalues of int array
items
formatint32
typeinteger
typearray
typeobject
Item
descriptionA 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
idItem
properties
itemId
descriptionThe item's ID, unique within the scope of its section.
formatint32
typeinteger
mainScreenItem
$refMainScreenItem
descriptionSet if it is a main screen item having a title, subtitle, and an icon.
profilePictureItem
$refProfilePictureItem
descriptionSet if the item is a profile-picture menu item, having a title and subtitle and locally rendered profile picture.
profilePicturePromoItem
$refProfilePicturePromoItem
descriptionSet 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
$refPromoItem
descriptionSet if the item is a promo item, having a button in addition to the title and subtitle.
simpleItem
$refSimpleItem
descriptionSet if the item is a simple item, having a title and subtitle.
typeobject
JamMetadata
descriptionMetadata containing information about JAM associated with VE data
idJamMetadata
properties
jamPage
descriptionThe 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
typestring
typeobject
LeftNav
descriptionLeft navigation bar with buttons.
idLeftNav
properties
blocks
descriptionList of blocks.
items
$refLeftNavBlock
typearray
typeobject
LeftNavBlock
descriptionA building block of the left navigation.
idLeftNavBlock
properties
divider
$refLeftNavDivider
descriptionA horizontal divider.
item
$refLeftNavItem
descriptionA menu item.
typeobject
LeftNavDivider
descriptionA horizontal divider for the left navigation.
idLeftNavDivider
properties
typeobject
LeftNavItem
descriptionOne of the LeftNav buttons. Next id: 7
idLeftNavItem
properties
accessibilityLabel
descriptionA11y label attached to current item.
typestring
icon
$refImage
descriptionButton icon.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
selectedIcon
$refImage
descriptionButton icon to be displayed when the item is selected.
target
$refResourceKey
deprecatedTrue
descriptionThe target screen. DEPRECATED: Use link instead.
title
descriptionButton caption.
typestring
typeobject
LegendBlock
descriptionBlock to provide text definitions for image icons.
idLegendBlock
properties
legendItems
descriptionItems to be define within the legend.
items
$refLegendItem
typearray
typeobject
LegendItem
descriptionAn individual item within a legend block.
idLegendItem
properties
accessibilityLabel
descriptionAccessibility label for the legend item, used by screen readers instead of label.
typestring
delineator
descriptionSymbol between the icon and the label.
typestring
icon
$refImage
descriptionIcon to be defined.
label
descriptionLabel containing the definition of the icon.
typestring
stackFooterImage
$refImage
descriptionWhen 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.
typeobject
Link
descriptionEach 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.
idLink
properties
anchorParams
$refAnchorNavigationParams
descriptionParameters of the anchor navigation. Occurs on the target resource, if present, otherwise, on the current one.
ariaLabel
descriptionAria label for the link.
typestring
target
$refResourceKey
descriptionResourceKey of the target resource. If nil, navigation occurs on the same screen.
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the link.
typeobject
LinkMetadata
descriptionMetadata containing information about the link inside a visual element
idLinkMetadata
properties
targetResourceId
descriptionResourceId in ASMS: google/internal/identity/accountsettings/mobile/v1/resource_id.proto
formatint32
typeinteger
typeobject
ListItemBlock
descriptionA vertical list item block. Next id: 16
idListItemBlock
properties
descriptions
descriptionList of item descriptions.
items
typestring
typearray
icon
$refImage
descriptionicon shown on the right of the list item, e.g. chevron icon.
iconVerticalAlignment
deprecatedTrue
descriptionVertical alignment of chevron. See VerticalAlignment enum.
formatint32
typeinteger
image
$refImage
descriptionImage displayed on the left of the list item.
label
descriptionLabel of the list item.
typestring
preferredLayout
descriptionPreferred block layout. See BlockLayout enum.
formatint32
typeinteger
secondaryIcon
$refImage
descriptionSecondary icon shown on the right of the list item and to the left of the main icon, e.g. ACL icons.
specialDescription
$refSpecialDescription
descriptionSpecial description.
stackItemImage
$refImage
descriptionWhen 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
deprecatedTrue
descriptionText entries of the list item. Use label, titles, etc. instead.
items
$refStyledTextEntry
typearray
titles
descriptionList of item titles.
items
typestring
typearray
trailingImage
$refImage
descriptionWhen 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.
typeobject
ListPreviewUnit
descriptionscreen/BDheWvg6VHnWYmA
idListPreviewUnit
properties
items
descriptionList of images. Should respect the max number of visible items on the unit. This number is currently limited to 5.
items
$refImage
typearray
total
descriptionThe total number of items in the list.
formatint32
typeinteger
typeobject
LoadingCard
descriptionCard with a loading spinner on it.
idLoadingCard
properties
typeobject
Local
descriptionResource type used when the resource should be produced locally.
idLocal
properties
typeobject
LongArray
descriptionA long array
idLongArray
properties
values
descriptionvalues of long array
items
formatint64
typestring
typearray
typeobject
MainScreenItem
descriptionA menu item with title, subtitle, and icon. Android-only Next Id: 5
idMainScreenItem
properties
icon
$refIcon
descriptionOptional icon.
screenId
descriptionThe screen ID that should be requested when this menu item is tapped.
formatint32
typeinteger
subtitleText
descriptionOptional additional text, displayed in a smaller size and/or lighter color. Subtitles may contain explanatory text, or the current value of a setting.
typestring
titleText
descriptionThe main item text. Can be the name of a setting or group of settings.
typestring
typeobject
MenuAlternative
descriptionDisplays a screen as a native menu. Next Id: 6
idMenuAlternative
properties
hatsSurvey
$refHaTSSurvey
descriptionHaTS survey to be shown.
helpInfo
$refHelpInfo
descriptionThe data to open GoogleHelp
sections
descriptionThe sections that make up the menu's contents.
items
$refSection
typearray
showLogo
descriptionWhether or not to show the Google logo
typeboolean
titleText
descriptionThe title to display in the menu's app bar.
typestring
typeobject
MessageAlternative
descriptionDisplays 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
idMessageAlternative
properties
helpInfo
$refHelpInfo
deprecatedTrue
descriptionDEPRECATED The data to open GoogleHelp.
messageText
descriptionThe message to display. Required.
typestring
titleText
deprecatedTrue
descriptionDEPRECATED The title to display in the menu's app bar.
typestring
typeobject
NativeAlternative
descriptionDisplays a screen as a native setting. Next Id: 8
idNativeAlternative
properties
anchorNavigationParams
$refAnchorNavigationParams
descriptionContains the necessary information to scroll to particular place on the screen.
feedbackParams
$refFeedbackParams
descriptionContains the necessary information to launch the Feedback Client with the proper configuration.
helpParams
$refHelpParams
descriptionContains fields used for opening IPH (In Product Help)
nativeActionId
descriptionAn ID identifying the native setting. See NativeActionId for possible values. Required.
formatint32
typeinteger
profilePicturePickerParams
$refProfilePicturePickerParams
descriptionContains the necessary information to launch the profile picture picker.
typeobject
NativeCapabilities
descriptionThe 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.
idNativeCapabilities
properties
fauxbakeImageCropping
descriptionWhether the client supports the custom Fauxbake image cropping UI.
typeboolean
postGplusApiSunsetProfilePictureFlow
descriptionWhether the client supports a native profile picture flow that will continue to work after the go/gplus-1p-sunset.
typeboolean
typeobject
NativeNavigationAlternative
descriptionNavigates to a native screen from a web or webview screen. Will fallback to open an url in browser when not possible.
idNativeNavigationAlternative
properties
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
navigateBack
typeboolean
target
$refResourceKey
deprecatedTrue
descriptionTarget native screen. DEPRECATED: Use link instead.
url
descriptionFallback url for the native screen, will be opened when a native experience is not available.
typestring
typeobject
NavigationMetadata
descriptionAdditional information about the navigation
idNavigationMetadata
properties
dashboardMetadata
$refDashboardNavigationMetadata
descriptionAdditional information about navigations from Google Dashboard.
dashboardServiceMetadata
$refDashboardServiceCardOutboundNavigationMetadata
descriptionAdditional information about outbound navigations from service cards on Google Dashboard.
helpCenterMetadata
$refHelpCenterNavigationMetadata
descriptionAdditional information about navigation to the Help Center to distinguish between different articles
typeobject
OnboardingAlternative
deprecatedTrue
descriptionA screen with onboarding flow
idOnboardingAlternative
properties
onboardingFlow
$refOnboardingFlow
descriptionThe onboarding flow data.
onboardingFlowKey
$refResourceKey
deprecatedTrue
descriptionThe representation of the onboarding flow. DEPRECATED: use onboarding flow directly.
typeobject
OnboardingFlow
deprecatedTrue
descriptionA resource encapsulating multiple onboarding steps, an animation, and a button. Next Id: 8
idOnboardingFlow
properties
animationThemedUrl
$refThemedUrl
descriptionThe decorative Lottie animation urls for both themes. Required.
animationUrl
deprecatedTrue
descriptionThe decorative Lottie animation url. Deprecated, use animation_themed_url instead.
typestring
buttonTarget
$refResourceKey
deprecatedTrue
descriptionThe 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
descriptionThe text to be shown on the button that skips onboarding. e.g.: "Get started". Required.
typestring
dismissalId
descriptionAn identifier used to record which OnboardingFlows have been dismissed. Required.
formatint64
typestring
link
$refLink
descriptionThe 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
descriptionThe steps containing onboarding content. At least one is required.
items
$refOnboardingStep
typearray
typeobject
OnboardingStep
deprecatedTrue
descriptionDescribes the contents of an onboarding step. An OnboardingStep must contain at least a title or a message. Next Id: 6
idOnboardingStep
properties
exitAnimation
$refAnimationSegment
descriptionA segment of animation played once the skip button is clicked.
message
descriptionThe onboarding step message text.
typestring
stepId
descriptionA unique StepId used for logging. Required.
formatint32
typeinteger
title
descriptionThe onboarding step title text.
typestring
transitionAnimation
$refAnimationSegment
descriptionA 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.
typeobject
OneBoxBlock
descriptionBuilding block of a card Next id: 35
idOneBoxBlock
properties
actionChipBlock
$refActionChipBlock
descriptionAction Chip Block
actionLineBlock
$refActionLineBlock
descriptionNavigation Link Block
activityListItemBlock
$refActivityListItemBlock
descriptionList Item Block used for showing user activities.
collapsableBlock
$refCollapsableBlock
descriptionA block that can be collapsed
descriptionBlock
$refDescriptionBlock
descriptionDescription block
dividerBlock
$refDividerBlock
descriptionDivider Block
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
listItemBlock
$refListItemBlock
descriptionList Item Block
oneBoxSignedOutButtonsBlock
$refOneBoxSignedOutButtonsBlock
descriptionA block that consists of Sign in and Sign up buttons
oneboxCustomGwsBlock
$refOneboxCustomGwsBlock
descriptionA block that can be rendered using GWS.
oneboxDisclaimerBlock
$refOneboxDisclaimerBlock
descriptionDisclaimer block currently used in the Oneboxes.
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
typeobject
OneBoxSignedOutButtonsBlock
descriptionA block consisting of Sign in and Sign up buttons, used when Signed out.
idOneBoxSignedOutButtonsBlock
properties
signInLink
$refSignedOutBlockLink
descriptionLink that leads to the sing in page. Required.
signUpLink
$refSignedOutBlockLink
descriptionLink that leads to the sing up page. Required.
typeobject
OneGoogleCard
descriptionCard representing an entry in the OneGoogle Account Menu.
idOneGoogleCard
properties
actionChip
$refActionChip
descriptionA chip that allows users to take action on the card.
leadingImage
$refImage
descriptionAn image that may be shown at the leading edge of the card.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
priority
descriptionThe priority of the card. Can influence ordering and styling of the cards.
formatint32
typeinteger
progressBar
$refOneGoogleProgressBar
descriptionAn optional progress bar
subtitle
descriptionThe subtitle of the card.
typestring
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
title
descriptionThe main title of the card.
typestring
trailingImage
$refImage
descriptionAn image that may be shown at the trailing edge of the card.
typeobject
OneGoogleProgressBar
descriptionA 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).
idOneGoogleProgressBar
properties
color
$refColor
descriptionThe color of the progress bar.
description
descriptionAn optional description for the progress bar.
typestring
progress
descriptionThe progress of the progress bar. Should be between 0 and 1.
formatfloat
typenumber
typeobject
OneboxCustomGwsBlock
descriptionA block that can be rendered using GWS.
idOneboxCustomGwsBlock
properties
type
descriptionThe type of the custom block.
enum
  • UNKNOWN
  • SAFESEARCH
enumDescriptions
  • Unknown block type.
  • Safesearch block type.
typestring
typeobject
OneboxDisclaimerBlock
descriptionA block containing a disclaimer of some sort. Next id: 4
idOneboxDisclaimerBlock
properties
disclaimerContent
$refText
descriptionThe content of the disclaimer. Use this in favor of disclaimer_text.
disclaimerText
deprecatedTrue
descriptionThe text content of the disclaimer.
typestring
image
$refImage
descriptionOptional illustration shown near the disclaimer text.
typeobject
Placeholder
descriptionPlaceholder used when a resource hasn't loaded yet.
idPlaceholder
properties
typeobject
PlaceholderAlternative
descriptionPlaceholder for when a resource hasn't loaded yet.
idPlaceholderAlternative
properties
typeobject
PrefetchRelatedScreensRequest
descriptionRequest message for PrefetchRelatedScreens.
idPrefetchRelatedScreensRequest
properties
context
$refRequestContext
descriptionInformation sent with every request.
screenId
descriptionIdentifies the target screen. See ScreenId enum for possible values.
formatint32
typeinteger
screensToOmit
descriptionSpecify the screens to omit from the response. The server is allowed to ignore this option.
items
$refScreenToOmit
typearray
typeobject
PrefetchRelatedScreensResponse
descriptionResponse message for PrefetchRelatedScreens.
idPrefetchRelatedScreensResponse
properties
screens
descriptionThe returned screens.
items
$refScreen
typearray
typeobject
ProductProfileMetadata
descriptionMetadata containing information about Product Profile resources associated with the VE
idProductProfileMetadata
properties
productProfile
descriptionProduct 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
typestring
typeobject
ProfilePictureBlock
descriptionA special block containing a label, title, description, and a tappable profile picture to the right.
idProfilePictureBlock
properties
avatarAccessibilityTapText
descriptionTap action text read by a screen reader before the phrase "double-tap to activate" when focus moves to the profile picture image.
typestring
descriptionText
descriptionDescription text of the profile picture block.
typestring
label
descriptionLabel of the profile picture block.
typestring
link
$refLink
descriptionLink 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
descriptionPreferred block layout. See BlockLayout enum.
formatint32
typeinteger
profilePictureImage
$refImage
descriptionProfile picture image.
stackItemImage
$refImage
descriptionWhen 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
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource of the profile picture. DEPRECATED: Use link instead.
textEntries
deprecatedTrue
descriptionText entries of the profile picture block. Use label, title, etc. instead.
items
$refStyledTextEntry
typearray
title
descriptionTitle of the profile picture block.
typestring
typeobject
ProfilePictureItem
descriptionA menu item, with title and subtitle, renders profile picture locally. Next Id: 4
idProfilePictureItem
properties
screenId
descriptionThe screen ID that should be requested when this menu item is tapped.
formatint32
typeinteger
subtitleText
descriptionOptional additional text, displayed in a smaller size and/or lighter color. Subtitles may contain explanatory text, or the current value of a setting.
typestring
titleText
descriptionThe main item text. Can be the name of a setting or group of settings.
typestring
typeobject
ProfilePicturePickerParams
descriptionParams used when launching the profile picture picker. Next Id: 2
idProfilePicturePickerParams
properties
usePeopleApi
descriptionIf true, iOS client will use the People API to upload the photo.
typeboolean
typeobject
ProfilePicturePromoItem
descriptionA 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
idProfilePicturePromoItem
properties
buttonText
descriptionThe button text.
typestring
screenId
descriptionThe screen ID that should be requested when this menu item is tapped.
formatint32
typeinteger
subtitleText
descriptionOptional additional text, displayed in a smaller size and/or lighter color. Contains the user's primary email address.
typestring
titleText
descriptionThe main item text. Contains the user's display name.
typestring
typeobject
ProfilePictureUnit
descriptionscreen/8UcDB3nx9wRtoPg
idProfilePictureUnit
properties
accessibilityTapText
descriptionAccessibility label for the profile picture, used by screen readers.
typestring
typeobject
ProgressBar
descriptionProgress bar. Supports settings colors for progress and background and labeling these parts.
idProgressBar
properties
backgroundColor
$refColor
deprecatedTrue
descriptionColor of the not completed part of the progress bar. Deprecated. Use background_themed_color instead.
backgroundThemedColor
$refThemedColor
descriptionColor of the not completed part of the progress bar.
endLabelText
deprecatedTrue
descriptionText of the label on the ending (high) end of the progress bar
typestring
labelColor
$refColor
deprecatedTrue
descriptionColor of the text. Deprecated. Use label_themed_color instead.
labelIcon
$refImage
deprecatedTrue
descriptionIcon, 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
descriptionText shown below the progress bar
typestring
labelThemedColor
$refThemedColor
descriptionColor of the text.
progress
descriptionPercentage of the progressbar to be filled in a range of 0 - 1.
formatfloat
typenumber
progressColor
$refColor
deprecatedTrue
descriptionColor of the progressbar. Deprecated. Use progress_themed_color instead.
progressThemedColor
$refThemedColor
descriptionColor of the progress bar.
stackItemImage
$refImage
descriptionWhen 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
deprecatedTrue
descriptionText of the label on the starting (low) end of the progress bar
typestring
typeobject
ProgressBarBlock
descriptionA block containing styled text entries and a progress bar.
idProgressBarBlock
properties
progressBar
$refProgressBar
descriptionProgress bar.
textEntries
deprecatedTrue
descriptionText entries for the progress bar block. Shown above the progress bar.
items
$refStyledTextEntry
typearray
typeobject
ProgressBarListItemBlock
descriptionList item-like block that contains a progress bar
idProgressBarListItemBlock
properties
icon
$refImage
descriptionicon shown on the right of the list item, e.g. chevron icon.
image
$refImage
descriptionImage displayed on the left of the list item.
progressBar
$refProgressBar
descriptionProgress bar
title
descriptionItem title.
typestring
trailingImage
$refImage
descriptionWhen 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.
typeobject
ProgressBarUnit
descriptionscreen/9LsrL7URSifxp3G
idProgressBarUnit
properties
barBackgroundColor
$refThemedColor
descriptionThe color of the background.
barForegroundColor
$refThemedColor
descriptionThe color of the progress
labelText
descriptionLabel “1.5GB of 15GB used”
typestring
progress
descriptionProgress of the Bar
formatfloat
typenumber
typeobject
PromoItem
descriptionA promo with text, subtitle, icon and button. Only the button is a tappable. May be styled differently from a SimpleItem. Next Id: 7
idPromoItem
properties
buttonText
descriptionThe button text.
typestring
icon
$refIcon
descriptionOptional icon.
screenId
descriptionThe screen ID that should be requested when this menu item is tapped.
formatint32
typeinteger
statusText
descriptionOptional text, to display an additional status message (e.g. 'Last checked at...') in the promo.
typestring
subtitleText
descriptionOptional additional text, displayed in a smaller size and/or lighter color. Subtitles may contain explanatory text, or the current value of a setting.
typestring
titleText
descriptionThe main item text. Can be the name of a setting or group of settings.
typestring
typeobject
PromptBlock
descriptionBuilding block of a prompt card
idPromptBlock
properties
descriptionBlock
$refPromptDescriptionBlock
descriptionDescription Block
progressBlock
$refPromptProgressBarBlock
descriptionProgress Bar Block
typeobject
PromptCarouselCard
descriptionA horizontally scrolling carousel of prompt items.
idPromptCarouselCard
properties
items
deprecatedTrue
descriptionThe order of the items is the order they should appear in the UI. Deprecated, clients should expect prompt_item_keys instead.
items
$refPromptItem
typearray
maxVisibleItems
descriptionThe maximum number of items to show. If the number of items is greater than this number, the overflow item will be shown.
formatint32
typeinteger
overflowCollapseAccessibilityTapText
descriptionTap 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.
typestring
overflowCollapseTitle
descriptionThe title of the overflow item when the prompt items are expanded.
typestring
overflowExpandAccessibilityTapText
descriptionTap 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.
typestring
overflowExpandTitle
descriptionThe title of the overflow item when the prompt items are collapsed.
typestring
promptItemKeys
descriptionThe order of the prompt items is the order they should appear in the UI.
items
$refResourceKey
typearray
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the prompt carousel card.
typeobject
PromptDescriptionBlock
descriptionA block containing a title and descriptive text, with an image displayed on the left side optionally.
idPromptDescriptionBlock
properties
image
$refImage
deprecatedTrue
descriptionOptional 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
descriptionDescriptive text of the block.
typestring
title
descriptionTitle of the block.
typestring
typeobject
PromptItem
descriptionPrompt items for the user to be taken care of in a timely manner, e.g., updating their credit card. Next id: 17
idPromptItem
properties
adviceSeverity
descriptionSeverity of the prompt from the AdviceSeverity enum
formatint32
typeinteger
callToActionText
descriptionCall 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.
typestring
dismissible
descriptionDismisses the card on all user devices and surfaces.
typeboolean
equallyWeightedActionButtons
descriptionIf 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).
typeboolean
expandCardAccessibilityTapText
descriptionTap action text read by a screen reader instead of the default "double-tap to activate" when focus moves to the collapsed card.
typestring
hintText
descriptionText 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.
typestring
icon
$refImage
descriptionIcon to be shown on the advice card.
id
deprecatedTrue
descriptionPrompt 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.
formatint64
typestring
link
$refLink
descriptionLink 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
$refPromptBlock
descriptionMain content of the prompt card
secondaryButtonLink
$refLink
descriptionLink 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
descriptionSecondary call to action block If not specified, no secondary call to action button is shown.
typestring
severity
deprecatedTrue
descriptionSeverity 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.
formatint32
typeinteger
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource DEPRECATED: Use link instead.
title
descriptionPrompt card title
typestring
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the prompt card.
typeobject
PromptProgressBarBlock
descriptionA block containing a progress bar with a label underneath each end
idPromptProgressBarBlock
properties
endLabelText
deprecatedTrue
descriptionText of the label on the ending (high) end of the progress bar Deprecated, clients should use progress_bar instead.
typestring
progress
deprecatedTrue
descriptionPercentage of the progressbar to be filled in a range of 0 - 1. Deprecated, clients should use progress_bar instead.
formatfloat
typenumber
progressBar
$refProgressBar
descriptionProgress bar
progressColor
$refColor
deprecatedTrue
descriptionColor of the progressbar. Deprecated, clients should use progress_bar instead.
startLabelText
deprecatedTrue
descriptionText of the label on the starting (low) end of the progress bar Deprecated, clients should use progress_bar instead.
typestring
typeobject
RequestContext
descriptionInformation 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
idRequestContext
properties
callingAndroidApp
descriptionApplicationId (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
typestring
clientCapabilities
$refClientCapabilities
descriptionTells the server which features this version of the client supports.
clientVersions
$refClientVersions
descriptionVersion numbers for the client software.
googleAccountReferrer
descriptionSerialized GoogleAccountReferrer that provided by caller of Google Account as query param.
typestring
isAuto
descriptionWhether the device the request came from is an Auto device.
typeboolean
isDarkModeEnabled
deprecatedTrue
descriptionWhether 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.
typeboolean
isPayModuleAvailable
descriptionWhether the client has the pay gmscore module available (only relevant for Android clients).
typeboolean
isRtl
descriptionTells whether the client is currently displaying in RTL mode.
typeboolean
logicalScreenDensity
descriptionThe 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
formatint32
typeinteger
platform
descriptionThe 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.
typestring
timeZone
descriptionThe time zone of the user's device, as a Unix time zone ID. e.g. "Europe/Berlin".
typestring
usesAllImageUrls
descriptionWhen set to true ASMS will return image urls for all screen density buckets instead of one already optimized url.
typeboolean
typeobject
Resource
descriptionResources 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.
idResource
properties
accountMenuInformation
$refAccountMenuInformation
descriptionInformation provided to the OGL account menu.
bottomNav
$refBottomNav
descriptionBottom buttons navigation.
card
$refCard
descriptionCard.
cardDeck
$refCardDeck
descriptionSet of cards.
footer
$refFooter
descriptionFooter.
initialSearchScreenComponents
$refInitialSearchScreenComponents
descriptionComponents for initial search screen on mobile.
isDismissed
descriptionResource 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).
typeboolean
isStable
descriptionAffects 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.
typeboolean
leftNav
$refLeftNav
descriptionLeft navigation.
local
$refLocal
descriptionA resource that should be produced locally (i.e., on the target device).
onboardingFlow
$refOnboardingFlow
deprecatedTrue
descriptionOnboarding flow.
placeholder
$refPlaceholder
descriptionReserved for internal use by clients.
promptItem
$refPromptItem
descriptionPrompt Card.
resourceKey
$refResourceKey
descriptionIdentifies a resource.
screen
$refScreenResource
descriptionDescription of the screen structure.
searchCorpus
$refSearchCorpus
descriptionSearch data for all searchable items.
securityHubPromptItem
$refSecurityHubPromptItem
descriptionSecurity Hub Prompt Card.
simpleHeader
$refSimpleHeader
descriptionSimple header.
supportPanel
$refSupportPanel
descriptionSupport panel
topNav
$refTopNav
descriptionTop tabs bar.
welcomeHeader
$refWelcomeHeader
descriptionMain header.
welcomeScreenIntro
$refWelcomeScreenIntro
descriptionThe welcome screen intro shown on home page on web.
typeobject
ResourceKey
descriptionEach 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.
idResourceKey
properties
resourceId
descriptiona value from the ResourceId enum
formatint32
typeinteger
resourceParams
additionalProperties
typestring
descriptionkey-value map of request parameters
typeobject
typeobject
ResourceMetadata
descriptionMetadata containing information about ASMS resources associated with the VE go/my-google/asms#resources
idResourceMetadata
properties
jamMetadata
$refJamMetadata
descriptionMetadata for JAM specific pages
resourceId
descriptionResourceId in ASMS: google/internal/identity/accountsettings/mobile/v1/resource_id.proto
formatint32
typeinteger
typeobject
ResourceToOmit
descriptionA resource to omit from the results
idResourceToOmit
properties
resourceKey
$refResourceKey
descriptionIdentifies the Resource.
typeobject
Screen
descriptionScreens 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
idScreen
properties
alternatives
descriptionA list of alternatives, in order of preference.
items
$refAlternative
typearray
isStable
descriptionAffects 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.
typeboolean
screenId
descriptionThe screen's ID. See ScreenId for possible values.
formatint32
typeinteger
typeobject
ScreenIntro
descriptionFraming for the screen content. May contain an image, a title and a description.
idScreenIntro
properties
description
descriptionDescription text for the screen intro. May be omitted.
typestring
image
$refImage
descriptionImage for the screen intro. May be omitted.
link
$refLink
descriptionLink 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
deprecatedTrue
descriptionAccessibility label for the link, used by screen readers instead of link_text. DEPRECATED: Use link.aria_label instead.
typestring
linkIcon
$refImage
descriptionIcon to append after the link text.
linkTarget
$refResourceKey
deprecatedTrue
descriptionId of link destination resource. DEPRECATED: Use link instead.
linkText
descriptionDescription block link text.
typestring
title
descriptionTitle text for the screen intro. May be omitted.
typestring
typeobject
ScreenResource
descriptionA type of a resource. Similar to a Screen, a ScreenResource can represent a menu, a native setting, a message etc. Next Id: 3
idScreenResource
properties
alternatives
descriptionA list of alternatives, in order of preference.
items
$refAlternative
typearray
navigationMetadata
$refNavigationMetadata
descriptionAdditional information about the navigation
typeobject
ScreenToOmit
descriptionA screen to omit from the results
idScreenToOmit
properties
screenId
descriptionIdentifies the screen. See ScreenId enum for possible values.
formatint32
typeinteger
typeobject
SearchAlternative
descriptionA screen with a search box, search results, and bottom nav.
idSearchAlternative
properties
bottomNavKey
$refResourceKey
descriptionId of the bottom buttons bar.
bottomNavSelection
$refResourceKey
descriptionIdentifies 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
$refResourceKey
descriptionId of the initial search screen components.
searchBox
$refSearchBox
descriptionSearch box data.
searchCorpusKey
$refResourceKey
descriptionId of the search corpus.
typeobject
SearchBlock
descriptionAn in-page search bar. Next id: 0
idSearchBlock
properties
typeobject
SearchBox
descriptionSearch box data. Next id: 2
idSearchBox
properties
placeholderText
descriptionPlaceholder text if there is no query yet.
typestring
typeobject
SearchCorpus
descriptionData for all searchable items. Next id: 5
idSearchCorpus
properties
allowedPrecheckedResources
descriptionList of allowed (searchable) Screen ResourceKeys. By default this is a list of SearchItem targets (though it can contain different list of ResourceKeys)
items
$refResourceKey
typearray
helpCenterSearchItem
$refHelpCenterSearchItem
descriptionSpecial search item shown below all results that links to a help center article for the entered query.
noResultsImage
$refImage
descriptionImage to show if there are no results for the entered query.
searchItems
descriptionList of available items for search. The items are sorted by title.
items
$refSearchItem
typearray
typeobject
SearchItem
descriptionA searchable item. Next id: 8
idSearchItem
properties
description
descriptionItem description.
typestring
icon
$refImage
descriptionIcon shown on the right of the item, e.g. chevron icon.
image
$refImage
descriptionImage displayed on the left of the item.
keywords
descriptionList of keywords that can be used for matching, beside title and description. Each keyword can be a single word or a phrase.
items
typestring
typearray
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the tap event. Eventually should completely replace the `target` field.
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
title
descriptionItem title.
typestring
typeobject
SearchItemSection
descriptionMessage to represent a section of search items. Next id: 4
idSearchItemSection
properties
fallbackSearchItem
$refSearchItem
descriptionFallback 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
descriptionList of items shown when no search terms are entered. The items are sorted by title.
items
$refSearchItem
typearray
title
descriptionTitle of the section.
typestring
typeobject
SearchOneboxMetadata
descriptionMetadata containing information about Search Onebox resources associated with the VE.
idSearchOneboxMetadata
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.
typestring
typeobject
SearchQuery
descriptionUser defined query.
idSearchQuery
properties
query
descriptionRaw user defined query.
typestring
typeobject
SearchRequest
descriptionRequest message for Search
idSearchRequest
properties
allowedPrecheckedResources
descriptionList of allowed (searchable) Screen ResourceKeys.
items
$refResourceKey
typearray
context
$refRequestContext
descriptionInformation sent with every request.
resourcesToOmit
descriptionSpecify the screen resources to omit from the response. The server uses this field for optimization by not including omitted resources in additional_resources.
items
$refResourceToOmit
typearray
searchQuery
$refSearchQuery
descriptionUser defined query.
typeobject
SearchResponse
descriptionResponse message for Search.
idSearchResponse
properties
additionalResources
descriptionAdditional resources that the client should cache.
items
$refResource
typearray
helpCenterSearchItem
$refHelpCenterSearchItem
deprecatedTrue
descriptionSpecial search item shown below all results that links to a help center search result page for the entered query.
searchItemSections
descriptionSearch item sections for Help Center results.
items
$refSearchItemSection
typearray
searchItems
deprecatedTrue
descriptionSearch items.
items
$refSearchItem
typearray
typeobject
SearchResultCard
descriptionCard presenting the result to query on Google Search. Next id: 8
idSearchResultCard
properties
answerBlock
$refOneBoxBlock
descriptionAn answer block
contentBlocks
descriptionThe content blocks following the general answer.
items
$refOneBoxBlock
typearray
header
$refHeader
descriptionThe header shown in the SearchResult card.
showInMainColumnOnDesktop
descriptionWhether 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.
typeboolean
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the Onebox.
typeobject
Section
descriptionA 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
idSection
properties
items
descriptionThe menu items in this section.
items
$refItem
typearray
sectionId
descriptionThe section's ID, unique within the scope of its menu.
formatint32
typeinteger
titleText
descriptionOptional section title.
typestring
typeobject
SecurityHubButton
descriptionButton to be shown in a warning card.
idSecurityHubButton
properties
label
descriptionThe text label for the button.
typestring
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
typeobject
SecurityHubPromptCarouselCard
descriptionA horizontally scrolling carousel of prompt items for the SecurityHub.
idSecurityHubPromptCarouselCard
properties
promptItemKeys
descriptionThe order of the prompt items is the order they should appear in the UI.
items
$refResourceKey
typearray
typeobject
SecurityHubPromptItem
descriptionPrompt items on the Security Hub for the user to be taken care of in a timely manner.
idSecurityHubPromptItem
properties
adviceTypes
descriptionThe types of Security Advisor advices that contributed to the overall severity.
items
enum
  • UNKNOWN
  • DEVICES_INACTIVE_DEVICE
  • DEVICES_WITHOUT_SCREEN_LOCK
  • DEVICES_PLAY_PROTECT_DISABLED
  • DEVICES_HARMFUL_APPS_DETECTED
  • DEVICES_NO_HARMFUL_APPS_DETECTED
  • APPS_HIGH_RISK_APP
  • APPS_DISABLE_LESS_SECURE_APPS
  • APPS_REMOVE_SPECIFIC_PASSWORD
  • TSV_ADD_BACKUP_PHONE
  • TSV_ADD_PAASK
  • RECOVERY_OPTIONS_ADD_PHONE_OR_EMAIL
  • RECOVERY_OPTIONS_ADD_RESCUE_CODE
  • RECOVERY_OPTIONS_ADD_EMAIL
  • RECOVERY_OPTIONS_FIX_EMAIL
  • RECOVERY_OPTIONS_VERIFY_PHONE
  • RECOVERY_OPTIONS_VERIFY_EMAIL
  • RECOVERY_OPTIONS_CONFIRM_PHONE
  • RECOVERY_OPTIONS_CONFIRM_EMAIL
  • RECOVERY_OPTIONS_ENROLL_IN_2SV
  • RECENT_ACTIVITY_CRITICAL_EVENT
  • GMAIL_SETTINGS_REMOVE_DELEGATE_ADDRESSES
  • GMAIL_SETTINGS_REMOVE_FORWARDING_ADDRESSES
  • ENROLL_IN_TITANIUM
  • TITANIUM_HIGH_PERSONAL_RISK
  • SAVED_PASSWORDS_BREACHED_PASSWORDS_DETECTED
  • SAVED_PASSWORDS_SAVED_PASSWORDS_SUMMARY
  • SAFE_BROWSING_ENROLL_IN_ENHANCED_SAFE_BROWSING
  • EMAIL_ADDRESS_ON_DARK_WEB_DETECTED
  • REVIEW_EMAIL_ADDRESS_ON_DARK_WEB
  • ACTIVATE_DARK_WEB_MONITORING
  • REVIEW_DARK_WEB_REPORT
  • SET_UP_INACTIVE_ACCOUNT_PLAN
  • REVIEW_LOCATION_SHARING
  • REVIEW_FACE_GROUPING
  • SET_RETENTION_WAA
  • SET_RETENTION_LH
  • SET_RETENTION_YTH
  • REVIEW_ADS_SETTINGS
  • LOCATION_HISTORY
  • WEB_AND_APP_ACTIVITY
  • YOUTUBE_HISTORY
  • YOUTUBE_SHARING
  • PHONE_SETTINGS
  • THIRD_PARTY_APPS_ACCESS
  • ABOUT_ME
  • LINKED_SERVICES
  • PASSWORD_MANAGER_PROMPT
  • SECURITY_ADVISOR_PROMPT
  • SAFER_INTERNET_DAY_HOME_PROMPT
  • STORAGE_EXHAUSTED_CRITICAL_PROMPT
  • STORAGE_EXHAUSTED_SEVERE_PROMPT
  • STORAGE_EXHAUSTED_WARNING_PROMPT
  • TEST_PROMPT
  • SAFER_WITH_GOOGLE_PROMPT
  • CAM_GOOGLE_PROMPT
  • TWO_STEP_VERIFICATION_PROMPT
  • MINOR_MODE_EXIT_PROMPT
  • CLP_TEST_PROMPT
  • CLP_SECURITY_ADVISOR_PROMPT
  • CLP_ADD_RECOVERY_PHONE_PROMPT
  • CLP_ADD_RECOVERY_PHONE_BENTO_VARIANT_PROMPT
  • CLP_ADD_SECONDARY_RECOVERY_OPTION_PROMPT
  • CLP_ADD_HOME_ADDRESS_PROMPT
  • ADD_RECOVERY_PHONE_PROMPT
  • ADD_SECONDARY_RECOVERY_OPTION_PROMPT
  • MANAGE_RECOVERY_OPTION_PROMPT
  • ADD_HOME_ADDRESS_PROMPT
  • PAYMENTS_PROMPT
  • PAYMENTS_ADD_FOP_PROMPT
  • PAYMENTS_SANCTIONS_PARTIAL_SUSPENSION_FIXFLOW_PROMPT
  • PAYMENTS_SANCTIONS_PARTIAL_SUSPENSION_HC_PROMPT
  • PAYMENTS_SANCTIONS_SUSPENSION_FIXFLOW_PROMPT
  • PAYMENTS_SANCTIONS_SUSPENSION_HC_PROMPT
  • PAYMENTS_SANCTIONS_CONFIRMED_PROMPT
  • PAYMENTS_SANCTIONS_ADHOC_PROMPT
  • PAYMENTS_SANCTIONS_CRIMEA_PROMPT
  • PAYMENTS_SANCTIONS_VERIFICATION_INPROGRESS_PROMPT
  • PAYMENTS_CUSTOMER_OR_INSTRUMENT_RISK_VERIFICATION_PROMPT
  • PAYMENTS_FUNDS_GUARANTEE_INSTRUMENT_DECLINED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_MISSING_PAYMENT_METHOD_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_CARD_CLOSED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_CARD_EXPIRED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_CARD_PAYMENT_DECLINED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_GENERIC_RISK_SUSPENDED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_BANK_NOT_VERIFIED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_BANK_PAYMENT_DECLINED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_GENERIC_PAYMENT_DECLINED_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_BANK_NEED_MANDATE_ACCEPTANCE_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_BANK_TERMS_AND_CONDITIONS_PROMPT
  • PAYMENTS_BILLING_ACCOUNT_CARD_EXPIRING_SOON_PROMPT
  • PAYMENTS_INSTRUMENT_BANK_NOT_VERIFIED_PROMPT
  • PAYMENTS_INSTRUMENT_CARD_EXPIRED_PROMPT
  • VERIFY_AGE_PROMPT
enumDeprecated
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • True
  • True
  • True
  • True
  • True
  • False
  • False
  • False
  • False
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
enumDescriptions
  • Unmapped or unspecified advice type.
  • Inactive device advice.
  • Add screen lock advice.
  • Play Protect disabled.
  • Harmul apps found by Play Protect.
  • No harmul apps found by Play Protect.
  • High-risk app advice.
  • Disable less secure apps advice.
  • Remove app-specific password advice.
  • Add backup phone advice.
  • Advice for adding Phone-as-a-security-key.
  • Add recovery phone or recovery email advice.
  • Add rescue code advice.
  • Add recovery email advice.
  • Fix recovery email advice.
  • Verify recovery phone advice.
  • Verify recovery email advice.
  • Recovery phone freshness advice.
  • Recovery email freshness advice.
  • Enroll in 2SV for SbD users. go/sbd-site
  • Review critical event.
  • Remove account delegates advice.
  • Remove forwarding addresses advice.
  • --------------------------------------------------------------------------- Titanium/AdvancedProtection step types (6001 - 6999) Next Titanium id: 6003 Enroll in Titanium
  • Advice for high personal risk users to enroll in Titanium.
  • --------------------------------------------------------------------------- Saved passwords step types (9001 - 9999) Next Saved passwords id: 9003 Breached passwords detected advice.
  • Saved passwords summary advice.
  • Enroll in Enhanced Safe Browsing advice.
  • Non-member primary email address is found the dark web.
  • Non-member email breach scan summary.
  • Recommends activating G1 Dark Web Report.
  • Recommends reviewing G1 Dark Web Report.
  • Suggestion to set up inactive account plan.
  • Suggestion to review Location Sharing.
  • Suggestion to review the Google Photos Face grouping setting.
  • Suggestion to set retention for Web & App Activity.
  • Suggestion to set retention for Location History.
  • Suggestion to set retention for Youtube History.
  • Suggestion to review Ads settings.
  • Suggestion to review location history setting.
  • Suggestion to review WAA setting.
  • Suggestion to review youtube history setting.
  • Suggestion to review youtube sharing setting.
  • Suggestion to review phone settings.
  • Suggestion to review third party apps access.
  • Suggestion to review About Me view and shared endorsements.
  • Suggestion to review whether a user's DMA services are linked or not.
  • Prompt card that advertises password manager.
  • Prompt card that is shown on red state of the security advisor.
  • Prompt card that advertises Google Account Safer Internetday page.
  • Prompt card that is shown if 100% of storage capacity is used.
  • Prompt card that is shown if 90-99.99% of storage capacity is used.
  • Prompt card that is shown if 85-89.99% of storage capacity is used.
  • Test card that is enabled only for prompt-cards-test-group & prompt-cards-test-group-external
  • Prompt card that advertises Safer with Google page.
  • Prompt card that advertises Cybersecurity Awareness month page.
  • Prompt card leading to g.co/2SV.
  • Prompt card used as entry point for the Minor Mode Exit flow.
  • Test prompt card for the Google Settings screen.
  • CLP variant of SECURITY_ADVISOR_PROMPT (red state).
  • CLP variant of ADD_RECOVERY_PHONE_PROMPT.
  • CLP variant of ADD_RECOVERY_PHONE_PROMPT with Bento content.
  • CLP variant of ADD_SECONDARY_RECOVERY_OPTION_PROMPT.
  • CLP variant of ADD_HOME_ADDRESS_PROMPT.
  • Add recovery phone prompt for Google Account recovery options prompts
  • Add secondary recovery option prompt for Google Account recovery options prompts
  • Manage recovery option prompt for Google Account recovery options prompts
  • Add home address prompt card.
  • Prompt cards for alerts from payments API.
  • Prompt card for the Add Fop alert from payments API.
  • Prompt card for the Sanctions partial suspension alert from payments API with fixflow.
  • Prompt card for the Sanctions partial suspension alert from payments API with HC article.
  • Prompt card for the Sanctions suspension alert from payments API with fixflow.
  • Prompt card for the Sanctions suspension alert from payments API with HC article.
  • Prompt card for the Sanctions confirmed alert from payments API with ToS HC article.
  • Prompt card for the Sanctions adhoc alert from payments API.
  • Prompt card for the Sanctions Crimea alert from payments API with ToS HC article.
  • Prompt card for the Sanctions verification in progress alert from payments API.
  • Prompt card for the customer or instrument risk verification alert from payments API.
  • Prompt card for the funds guarantee instrument declined alert from payments API.
  • Prompt card for the billing account missing payment method alert from payments API.
  • Prompt card for the billing account card closed alert from payments API.
  • Prompt card for the billing account card expired alert from payments API.
  • Prompt card for the billing account card payment declined alert from payments API.
  • Prompt card for the billing account generic instrument risk suspended alert from payments API.
  • Prompt card for the billing account bank not verified alert from payments API.
  • Prompt card for the billing account bank payment declined alert from payments API.
  • Prompt card for the billing account payment has generic paymentdeclined alert from payments API.
  • Prompt card for the billing account bank need mandate acceptance alert from payments API.
  • Prompt card for the billing account terms and conditions alert from payments API.
  • Prompt card for the billing account card expiring soon alert from payments API.
  • Prompt card for the instrument account bank not verified alert from payments API.
  • Prompt card for the instrument card expired alert from payments API.
  • Add age verification prompt card.
typestring
typearray
body
descriptionThe body shown in the warning card.
typestring
primaryButton
$refSecurityHubButton
descriptionThe 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
descriptionThe 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.
typestring
title
descriptionThe title shown in the warning card. Required
typestring
typeobject
SegmentHeaderCard
descriptionA segment header
idSegmentHeaderCard
properties
descriptionText
descriptionLocalized description text.
typestring
image
$refImage
descriptionThe image is displayed to the right of the text for one-column layout
largeImage
$refImage
descriptionThe image is displayed to the right of the text for two-column layout
linkAccessibilityLabel
deprecatedTrue
descriptionAccessibility label for the link, used by screen readers instead of link_text. DEPRECATED: Use link_target_link.aria_label instead.
typestring
linkIcon
$refImage
descriptionIcon to append after the link text.
linkTargetLink
$refLink
descriptionLink 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
descriptionLocalized text of optional link shown at the end of the description (e.g. "learn more").
typestring
title
descriptionTitle for the section.
typestring
typeobject
SetResourceDismissalStateRequest
descriptionRequest message for SetResourceDismissalState.
idSetResourceDismissalStateRequest
properties
context
$refRequestContext
descriptionInformation sent with every request.
resourceDismissalState
descriptionNew 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
typestring
resourceKey
$refResourceKey
descriptionResource key which needs to be updated.
typeobject
SetResourceDismissalStateResponse
descriptionResponse message for SetResourceDismissalState.
idSetResourceDismissalStateResponse
properties
additionalResources
descriptionAdditional resources that are related to the modified resource the client should cache.
items
$refResource
typearray
resource
$refResource
descriptionResource for which dismissal state was modified.
typeobject
ShortArray
descriptionA short array
idShortArray
properties
values
descriptionvalues of short array int16 scale
items
formatint32
typeinteger
typearray
typeobject
SignInBlock
descriptionA block containing a CTA to sign in, including optional illustration and description. Next id: 10
idSignInBlock
properties
additionalParagraphs
descriptionThe additional paragraphs shown below the CTA button.
items
$refAdditionalParagraph
typearray
buttonTarget
$refResourceKey
deprecatedTrue
descriptionOptional target for the CTA button. DEPRECATED: Use link instead.
description
descriptionDescription of the sign in block. Shown above the CTA button.
typestring
descriptionParagraphs
descriptionThe additional paragraphs describing the page shown above the CTA button.
items
$refAdditionalParagraph
typearray
image
$refImage
descriptionOptional image to be displayed in the sign in block on small screens.
largeImage
$refImage
descriptionOptional image to be displayed in the sign in block on large screens instead of the small image.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `button_target` field.
signInCtaText
descriptionText on the sign in CTA button.
typestring
title
descriptionThe title of the sign in block. Shown under the image.
typestring
typeobject
SignedOutBlockLink
descriptionMessage for a link in the SignedOutButtonsBlock.
idSignedOutBlockLink
properties
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
target
$refResourceKey
deprecatedTrue
descriptionLink target for the CTA. Required. DEPRECATED: Use link instead.
text
descriptionText on the link CTA. Required.
typestring
typeobject
SimpleHeader
descriptionMy Google simple header with action items.
idSimpleHeader
properties
actionItems
descriptionAction items to show on the top of the header area.
items
$refActionItem
typearray
title
descriptionThe title text to be displayed.
typestring
typeobject
SimpleItem
descriptionA simple menu item, with title and subtitle. Next Id: 4
idSimpleItem
properties
screenId
descriptionThe screen ID that should be requested when this menu item is tapped.
formatint32
typeinteger
subtitleText
descriptionOptional additional text, displayed in a smaller size and/or lighter color. Subtitles may contain explanatory text, or the current value of a setting.
typestring
titleText
descriptionThe main item text. Can be the name of a setting or group of settings.
typestring
typeobject
SpecialDescription
descriptionA special description block containing an icon, and text of a custom color.
idSpecialDescription
properties
color
$refColor
deprecatedTrue
descriptionDescription color. Deprecated. Use themed_color instead.
icon
$refImage
descriptionDescription icon.
stateChipUnit
$refStateChipUnit
descriptionThe 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
descriptionDescription text.
typestring
themedColor
$refThemedColor
descriptionDescription color.
typeobject
Stack
descriptionA stack of zero or more StackItems & StackFooters. screen/7i7pzGTANcvyDn8
idStack
properties
footers
descriptionZero or more StackFooter at the bottom of the stack. screen/5psKAHrTqdCMTts
items
$refStackFooter
typearray
infoOnly
descriptionIndicates whether the stack is info only. An info only stack is not tappable, the items do not have a link and is rendered differently.
typeboolean
items
descriptionZero or more StackItem at the top of the stack. screen/oRyFdxeMdxCWDWs.
items
$refStackItem
typearray
typeobject
StackFooter
descriptionFooter of the stack - screen/5psKAHrTqdCMTts
idStackFooter
properties
contentUnits
descriptionContent units of the footer.
items
$refStackFooterContentUnit
typearray
description
descriptionDescription of the footer.
typestring
hyperlink
$refLink
descriptionLink of the hyperlink_text.
hyperlinkText
descriptionHyperlink text/label of the footer displayed after the description.
typestring
image
$refImage
descriptionImage placed on the left side of the footer.
trailingUnits
descriptionTrailing units of the footer.
items
$refStackFooterTrailingUnit
typearray
typeobject
StackFooterContentUnit
descriptionContent unit of the footer
idStackFooterContentUnit
properties
actionChipsUnit
$refActionChipsUnit
descriptionscreen/82c8fpyatXbybbe
typeobject
StackFooterTrailingUnit
descriptionTrailing unit of the footer
idStackFooterTrailingUnit
properties
imageUnit
$refImageUnit
descriptionscreen/6Bi4EhgcFY2drWP
typeobject
StackItem
descriptionStack item - screen/3RAFcZbV7vh3U6c.
idStackItem
properties
contentUnits
descriptionContent units of the item.
items
$refStackItemContentUnit
typearray
description
descriptionDescription of the item.
typestring
image
$refImage
descriptionImage placed on the left side of the item.
link
$refLink
descriptionLink of the item.
title
descriptionTitle of the item.
typestring
trailingUnits
descriptionTrailing units of the item.
items
$refStackItemTrailingUnit
typearray
typeobject
StackItemContentUnit
descriptionContent unit of the stack item screen/5GZv5iNqquGsPSU
idStackItemContentUnit
properties
attributesUnit
$refAttributesUnit
descriptionscreen/8vM3aFoKwwLD7FN
listPreviewUnit
$refListPreviewUnit
descriptionscreen/BDheWvg6VHnWYmA
progressBarUnit
$refProgressBarUnit
descriptionscreen/9LsrL7URSifxp3G
stateChipUnit
$refStateChipUnit
descriptionscreen/7pKYihngrugyLqg
typeobject
StackItemTrailingUnit
descriptionTrailing unit of the stack item screen/6skuPGfowwQkurH
idStackItemTrailingUnit
properties
expansionUnit
$refExpansionUnit
descriptionscreen/9fYD3c8gNSJH6Aj
imageUnit
$refImageUnit
descriptionscreen/A333or6Vw6tZcxf
profilePictureUnit
$refProfilePictureUnit
descriptionscreen/8UcDB3nx9wRtoPg
stateChipUnit
$refStateChipUnit
descriptionscreen/7EBeXzYEArApyVZ
typeobject
StateChipUnit
descriptionscreen/7pKYihngrugyLqg & screen/7EBeXzYEArApyVZ
idStateChipUnit
properties
backgroundColor
$refThemedColor
descriptionColor to tint the background and serve as container for Icon and Label. TODO(b/397607598)
icon
$refImage
descriptionIcon of the chip
label
descriptionLabel of the chip
typestring
labelColor
$refThemedColor
descriptionColor to tint label
typeobject
StringArray
descriptionA string array
idStringArray
properties
values
descriptionvalues of string array
items
typestring
typearray
typeobject
StyledTextEntry
descriptionStyled text entry. Supports colored text, drawing one icon to the left and different styles, defined by client.
idStyledTextEntry
properties
color
$refColor
deprecatedTrue
descriptionColor of the text. Deprecated. Use themed_color instead.
icon
$refImage
descriptionIcon, shown to the left of the text. Center-aligned vertically.
style
descriptionStyle 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.
typestring
text
descriptionText.
typestring
themedColor
$refThemedColor
descriptionColor of the text.
truncation
$refTextTruncation
descriptionTruncation logic used for the text.
typeobject
SummaryCard
descriptionCard presenting one or more settings. Next id: 10
idSummaryCard
properties
blocks
descriptionAt least one block must be present. Clients will ignore blocks that they don't understand.
items
$refBlock
typearray
borderless
descriptionWhether to disable drawing border for the card
typeboolean
disableHorizontalPadding
descriptionWarning: this is not implemented on native is likely temporary.
typeboolean
infoOnly
descriptionIndicates 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.
typeboolean
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
preferredSize
descriptionThe preferred size of the card. See CardPreferredSize enum.
formatint32
typeinteger
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the summary card.
typeobject
SupportAlternative
descriptionSupport related alternative, like support panel and support screen.
idSupportAlternative
properties
typeobject
SupportPanel
descriptionA panel with cards and intro. Next Id: 4
idSupportPanel
properties
deckKey
$refResourceKey
descriptionId of the deck of cards displayed in support panel.
screenIntro
$refScreenIntro
descriptionIntro displayed just before the cards.
visualElementConfig
$refGoogleAccountVisualElementConfig
descriptionVisual element configuration for the support panel.
typeobject
SupportedAlternativeType
descriptionA supported alternative.
idSupportedAlternativeType
properties
alternativeType
descriptionThe alternative type. See AlternativeType for possible values.
formatint32
typeinteger
typeobject
SupportedAndroidIntentCheck
descriptionAndroid intent checks supported by the client
idSupportedAndroidIntentCheck
properties
androidIntentCheck
descriptionList 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.
typestring
typeobject
SupportedIcon
descriptionA supported icon.
idSupportedIcon
properties
iconId
descriptionThe icon ID. See IconId for possible values.
formatint32
typeinteger
typeobject
SupportedItemType
descriptionA supported item type.
idSupportedItemType
properties
itemType
descriptionThe item type. See ItemType for possible values.
formatint32
typeinteger
typeobject
SupportedNativeAction
descriptionA supported native action.
idSupportedNativeAction
properties
nativeActionId
descriptionThe native action's ID. See NativeActionId for possible values.
formatint32
typeinteger
typeobject
SupportedOfflineScreen
descriptionA supported offline screen.
idSupportedOfflineScreen
properties
screenId
descriptionRequired
formatint32
typeinteger
version
descriptionOptional. If omitted, version 1 is assumed.
formatint32
typeinteger
typeobject
Target
descriptionItem link target. Next id: 5
idTarget
properties
queryPlaceholder
descriptionThe placeholder text in url_with_query_placeholder which should be replaced by the search query.
typestring
resourceId
descriptionTarget resource_id. Used for logging.
formatint32
typeinteger
themedUrlWithQueryPlaceholder
$refThemedUrl
descriptionDestination help center URLs for both light and dark themes. Contain a placeholder string which should be replaced by the URL-encoded search query.
urlWithQueryPlaceholder
descriptionDestination help center URL. Contains a placeholder string which should be replaced by the URL-encoded search query.
typestring
typeobject
Text
descriptionThis message represents the a text that consists of multiple items. Items can be either plain text or links.
idText
properties
textItems
descriptionList or text items.
items
$refTextItem
typearray
typeobject
TextItem
descriptionThis message represents one text item in the entire text. It should be rendered like this: $text if target is present, otherwise — as text.
idTextItem
properties
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
target
$refResourceKey
deprecatedTrue
descriptionThe id of the target resource. DEPRECATED: Use link instead.
text
descriptionText to display. required
typestring
typeobject
TextTruncation
descriptionText truncation.
idTextTruncation
properties
numberOfLines
descriptionNumber of lines after which truncation happens. 0 means no truncation.
formatint32
typeinteger
typeobject
ThemedColor
descriptionWrapper around Colors for specific themes / user interface styles. Next id: 3
idThemedColor
properties
dark
$refColor
descriptionThe color for dark theme. Required.
light
$refColor
descriptionThe color for light theme. Required.
typeobject
ThemedUrl
descriptionWrapper around URLs for specific themes / user interface styles. Next id: 3
idThemedUrl
properties
dark
descriptionThe URL for a dark theme / user interface style.
typestring
light
descriptionThe 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.
typestring
typeobject
Title
descriptionItem title. Next id: 3
idTitle
properties
queryPlaceholder
descriptionThe placeholder text in title_with_placeholder which should be replaced by the search query.
typestring
textWithQueryPlaceholder
descriptionItem title. Contains a placeholder string which should be replaced by the search query.
typestring
typeobject
TopNav
descriptionTop navigation bar with tabs.
idTopNav
properties
tabs
descriptionList of tabs.
items
$refTopTab
typearray
typeobject
TopTab
descriptionOne of the TopNav tabs.
idTopTab
properties
icon
$refImage
descriptionIcon (default version) to be displayed next to the tab title in the dropdown version of the menu.
link
$refLink
descriptionLink to the screen that should be displayed when the tab becomes active. Only supports the link target and no other link parameters.
selectedIcon
$refImage
descriptionIcon (hovered/selected version) to be displayed next to the tab title in the dropdown version of the menu.
target
$refResourceKey
deprecatedTrue
descriptionTarget screen of the tab. DEPRECATED: Use link instead.
title
descriptionTab title.
typestring
typeobject
TwoColumnTableBlock
descriptionA block to show a list of image - description pairs in tabular form where images and descriptions are aligned in separate columns.
idTwoColumnTableBlock
properties
rows
descriptionList of rows to populate the TwoColumnTableBlock.
items
$refTwoColumnTableRow
typearray
typeobject
TwoColumnTableRow
descriptionData row to populate the TwoColumnTableBlock.
idTwoColumnTableRow
properties
descriptions
descriptionList of descriptions, each of which is printed on a new line.
items
typestring
typearray
image
$refImage
descriptionOptional image for the table row.
link
$refLink
descriptionLink which consists of the target ResourceKey and additional params to follow on the click event. Eventually should completely replace the `target` field.
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource. DEPRECATED: Use link instead.
typeobject
WebviewAlternative
descriptionDisplays a screen by opening an URL in a WebView. Next Id: 3
idWebviewAlternative
properties
themedUrl
$refThemedUrl
descriptionThe set of theme-dependent URLs to open. One of url or themed_url required.
url
descriptionThe URL to open. One of url or themed_url required.
typestring
typeobject
WebviewCapabilities
descriptionThe 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
idWebviewCapabilities
properties
obakeWeb
descriptionWhether the client supports all changes necessary to work with Obake web.
typeboolean
passkey
descriptionWhether the client supports passkey-based auth in Octarine. iOS only.
typeboolean
securityKey
descriptionWhether the client supports security key authentication.
typeboolean
telephony
descriptionWhether the client supports the telephony JS bridge.
typeboolean
termsAndPolicyPages
descriptionWhether the client supports opening the PP and ToS pages in Octarine.
typeboolean
trustAgent
descriptionWhether the client supports the trust agent JS bridge.
typeboolean
typeobject
WelcomeHeader
descriptionMy Google header with user name and avatar.
idWelcomeHeader
properties
actionItems
descriptionAction items to show on the top of the header area.
items
$refActionItem
typearray
avatarAccessibilityTapText
descriptionTap action text read by a screen reader after the phrase "double-tap to .." when focus moves to the avatar.
typestring
chip
$refActionChip
deprecatedTrue
descriptionUsed for displaying link to launch Google Account from contextual landing page. DEPRECATED: chip is no longer supported in the welcome header.
link
$refLink
descriptionLink 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
descriptionUser's name as displayed in the header.
typestring
showProductLockup
descriptionControls showing the product view in the header area.
typeboolean
target
$refResourceKey
deprecatedTrue
descriptionId of tap destination resource of the avatar. DEPRECATED: Use link instead.
title
descriptionTitle text to show in the header area.
typestring
welcomeText
descriptionHeader welcome text (e.g. 'Welcome, Janelle').
typestring
typeobject
WelcomeScreenIntro
descriptionMy Google header with user name, profile picture, and welcome message. Next id: 17
idWelcomeScreenIntro
properties
additionalDescription
$refAdditionalDescription
descriptionThe additional description for some account types.
description
descriptionThe welcome message to the user (e.g. 'You're in control...').
typestring
displayName
descriptionThe user's name to display. Currently only in use for Android, taking precedence over the `title` field.
typestring
isGoogleOneMember
descriptionWhether the user is a Google One member.
typeboolean
link
$refLink
descriptionLink 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
deprecatedTrue
descriptionAccessibility label for the link that appears after the description, used by screen readers instead of link_text. DEPRECATED: Use link.aria_label instead.
typestring
linkIcon
$refImage
descriptionIcon to append after the link text.
linkTarget
$refResourceKey
deprecatedTrue
descriptionTarget resource for the link. DEPRECATED: Use link instead.
linkText
descriptionText for the link that appears after the 'description'.
typestring
primaryEmail
descriptionThe user's email id to display to the user.
typestring
profilePictureAccessibilityLabel
descriptionTap action text read by a screen reader after the phrase "double-tap to .." when focus moves to the profile picture.
typestring
profilePictureImage
$refImage
descriptionProfile picture image.
profilePictureLink
$refLink
descriptionLink 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
$refResourceKey
descriptionProfile picture target.
title
descriptionHeader welcome title (e.g. 'Welcome, Janelle').
typestring
typeobject
root['title']
new_valueReach Private API
old_valueAccount Settings Mobile Private API (Staging)
sandbox/staging-afwprovisioning-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-afwprovisioning-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-alioth-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-alioth-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-androidauthnimblegateway-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-androidauthnimblegateway-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-auditrecording-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
iterable_item_added
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodComponent']['properties']['componentId']['enum'][243]REUBEN_SERVER
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodComponent']['properties']['componentId']['enumDescriptions'][243]go/reuben-backend-design - Reuben
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][435]PAISA_MERCHANT_CREDIT_REPORT_FETCH_CONSENT_ACCEPTED
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][436]PAISA_MERCHANT_CREDIT_REPORT_PERSONALIZATION_CONSENT_ACCEPTED
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][517]REUBEN_TOS_CONSENT
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][435]Event specifying that the merchant has accepted the credit report fetch consent.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][436]Event specifying that the merchant has accepted the credit report personalization consent.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][517]The user has given consent to the Reuben app.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enum'][719]PAISA_MERCHANT_LOAN_APPLICATION_FLOW_CREDIT_REPORT_FETCH_SCREEN
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enum'][925]REUBEN_TOS_CONSENT_SCREEN
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enumDescriptions'][719]User going through the Credit Report Fetch screen in the loan application journey in Merchant Credit microapp. Ref: go/cibil-in-merchant-credit-application-flow
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enumDescriptions'][925]Reuben consent.
sandbox/staging-auditrecording-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
iterable_item_added
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodComponent']['properties']['componentId']['enum'][243]REUBEN_SERVER
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodComponent']['properties']['componentId']['enumDescriptions'][243]go/reuben-backend-design - Reuben
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][435]PAISA_MERCHANT_CREDIT_REPORT_FETCH_CONSENT_ACCEPTED
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][436]PAISA_MERCHANT_CREDIT_REPORT_PERSONALIZATION_CONSENT_ACCEPTED
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][517]REUBEN_TOS_CONSENT
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][435]Event specifying that the merchant has accepted the credit report fetch consent.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][436]Event specifying that the merchant has accepted the credit report personalization consent.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][517]The user has given consent to the Reuben app.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enum'][719]PAISA_MERCHANT_LOAN_APPLICATION_FLOW_CREDIT_REPORT_FETCH_SCREEN
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enum'][925]REUBEN_TOS_CONSENT_SCREEN
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enumDescriptions'][719]User going through the Credit Report Fetch screen in the loan application journey in Merchant Credit microapp. Ref: go/cibil-in-merchant-credit-application-flow
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enumDescriptions'][925]Reuben consent.
sandbox/staging-enterprisedeviceauth-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-enterprisedeviceauth-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-familymanagement-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-familymanagement-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-fcm-
values_changed
root['revision']
new_value20250516
old_value20250514
sandbox/staging-fcm-v1
values_changed
root['revision']
new_value20250516
old_value20250514
sandbox/staging-firebaseremoteconfigrealtime-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-firebaseremoteconfigrealtime-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-fit-
dictionary_item_removed
  • root['auth']
  • root['canonicalName']
  • root['version_module']
values_changed
root['basePath']
new_value/fitness/v1/users/
old_value
root['baseUrl']
new_valuehttps://fishfood-fitness.sandbox.googleapis.com/fitness/v1/users/
old_valuehttps://staging-fit.sandbox.googleapis.com/
root['description']
new_valueThe Fitness API for managing users' fitness tracking data.
old_valueThe Google Fit API provides access to the Google Fit ecosystem where developers can upload fitness data to a central repository and users can access their data from different devices and apps in one location.
root['documentationLink']
new_valuehttps://developers.google.com/fit/rest/v1/get-started
old_valuehttps://developers.google.com/fit/
root['id']
new_valuefitness:v1
old_valuefit:v2beta1
root['mtlsRootUrl']
new_valuehttps://fishfood-fitness.mtls.sandbox.googleapis.com/
old_valuehttps://staging-fit.mtls.sandbox.googleapis.com/
root['name']
new_valuefitness
old_valuefit
root['resources']
new_value
old_value
dataTypes
methods
list
deprecatedTrue
descriptionLists all the data types a user has. The response will contain all the available Google Fit platform data types and shared data types. Pagination is supported.
flatPathv2beta1/dataTypes
httpMethodGET
idfit.dataTypes.list
parameterOrder
parameters
pageSize
descriptionThe maximum number of items to return. If unset, it defaults to a sensible number.
formatint32
locationquery
typeinteger
pageToken
descriptionToken for obtaining the next page of results in pagination. If this is the first request, leave this field empty. Otherwise, use the value of `next_page_token` returned from the previous List request. Note that the values of all the other fields in the subsequent requests to retrieve paginated results must be the same as those in the first request.
locationquery
typestring
pathv2beta1/dataTypes
response
$refListDataTypesResponse
scopes
  • https://www.googleapis.com/auth/fitness.activity.read
  • https://www.googleapis.com/auth/fitness.activity.write
  • https://www.googleapis.com/auth/fitness.blood_glucose.read
  • https://www.googleapis.com/auth/fitness.blood_glucose.write
  • https://www.googleapis.com/auth/fitness.blood_pressure.read
  • https://www.googleapis.com/auth/fitness.blood_pressure.write
  • https://www.googleapis.com/auth/fitness.body.read
  • https://www.googleapis.com/auth/fitness.body.write
  • https://www.googleapis.com/auth/fitness.body_temperature.read
  • https://www.googleapis.com/auth/fitness.body_temperature.write
  • https://www.googleapis.com/auth/fitness.location.read
  • https://www.googleapis.com/auth/fitness.location.write
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.read
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.write
  • https://www.googleapis.com/auth/fitness.reproductive_health.read
  • https://www.googleapis.com/auth/fitness.reproductive_health.write
resources
dataSources
methods
create
deprecatedTrue
descriptionCreates a data source of a certain data type. If the data source already exists, the request will fail with the code ALREADY_EXISTS. The data source resource name need not be set in the request, and it will be ignored if it is set. The created data source with a resource name assigned by the server is returned as the response.
flatPathv2beta1/dataTypes/{dataTypesId}/dataSources
httpMethodPOST
idfit.dataTypes.dataSources.create
parameterOrder
  • parent
parameters
parent
descriptionThe parent resource name of the data source to create, in the form `dataTypes/{data_type_id}`.
locationpath
pattern^dataTypes/[^/]+$
requiredTrue
typestring
pathv2beta1/{+parent}/dataSources
request
$refDataSource
response
$refDataSource
scopes
  • https://www.googleapis.com/auth/fitness.activity.read
  • https://www.googleapis.com/auth/fitness.activity.write
  • https://www.googleapis.com/auth/fitness.blood_glucose.read
  • https://www.googleapis.com/auth/fitness.blood_glucose.write
  • https://www.googleapis.com/auth/fitness.blood_pressure.read
  • https://www.googleapis.com/auth/fitness.blood_pressure.write
  • https://www.googleapis.com/auth/fitness.body.read
  • https://www.googleapis.com/auth/fitness.body.write
  • https://www.googleapis.com/auth/fitness.body_temperature.read
  • https://www.googleapis.com/auth/fitness.body_temperature.write
  • https://www.googleapis.com/auth/fitness.location.read
  • https://www.googleapis.com/auth/fitness.location.write
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.read
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.write
  • https://www.googleapis.com/auth/fitness.reproductive_health.read
  • https://www.googleapis.com/auth/fitness.reproductive_health.write
delete
deprecatedTrue
descriptionDeletes a data source. If the data source does not exist, the request will fail with the code NOT_FOUND.
flatPathv2beta1/dataTypes/{dataTypesId}/dataSources/{dataSourcesId}
httpMethodDELETE
idfit.dataTypes.dataSources.delete
parameterOrder
  • name
parameters
forceDelete
descriptionIf this field is set to false, the data source can only be deleted if it doesn't contain any data points. If it is set to true, the data source together with its data points will be deleted. If it is unset, it defaults to false.
locationquery
typeboolean
name
descriptionThe resource name of the data source to delete, in the form `dataTypes/{data_type_id}/dataSources/{data_source_id}`.
locationpath
pattern^dataTypes/[^/]+/dataSources/[^/]+$
requiredTrue
typestring
pathv2beta1/{+name}
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/fitness.activity.read
  • https://www.googleapis.com/auth/fitness.activity.write
  • https://www.googleapis.com/auth/fitness.blood_glucose.read
  • https://www.googleapis.com/auth/fitness.blood_glucose.write
  • https://www.googleapis.com/auth/fitness.blood_pressure.read
  • https://www.googleapis.com/auth/fitness.blood_pressure.write
  • https://www.googleapis.com/auth/fitness.body.read
  • https://www.googleapis.com/auth/fitness.body.write
  • https://www.googleapis.com/auth/fitness.body_temperature.read
  • https://www.googleapis.com/auth/fitness.body_temperature.write
  • https://www.googleapis.com/auth/fitness.location.read
  • https://www.googleapis.com/auth/fitness.location.write
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.read
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.write
  • https://www.googleapis.com/auth/fitness.reproductive_health.read
  • https://www.googleapis.com/auth/fitness.reproductive_health.write
list
deprecatedTrue
descriptionLists all the data sources of a certain data type belonging to a user. Pagination and syncing are supported. Pagination: If this is a client's first request, leave the request fields `page_token` and `sync_token` empty. In the response, the client will get a `next_page_token` if pagination is required to return all the results. Client should use this `next_page_token` as the request `page_token` in their second request. Client should always use the value of `next_page_token` from the previous response as their request `page_token` in the next request until they receive an empty `next_page_token` which signifies that this response contains the last page of results. In this last response, they will also receive a `next_sync_token` which they can use for a future incremental syncing. Note that `next_sync_token` will only be set in the response for the last page. Syncing: Client should set the value of the request `sync_token` to the value of `next_sync_token` they obtained from the last response they received last time. If pagination is required to return all the changes since last sync, the response will contain a `next_page_token` that the client can use in their second request (refer to the paragraph above regarding the behavior of pagination). The field `sync_token` does not need to be set in subsequent requests following the same request, however, if it is set, it has to be the same value as that in your first request. If pagination is not required to return all the results, the response will contain all the changes since last sync and also a `next_sync_token` which the client can use in a future incremental syncing.
flatPathv2beta1/dataTypes/{dataTypesId}/dataSources
httpMethodGET
idfit.dataTypes.dataSources.list
parameterOrder
  • parent
parameters
pageSize
descriptionThe maximum number of items to return. If unset, it defaults to a sensible number.
formatint32
locationquery
typeinteger
pageToken
descriptionToken for obtaining the next page of results in pagination. If this is the first request, leave this field empty. Otherwise, use the value of `next_page_token` returned from the previous List request. Note that the values of all the other fields in the subsequent requests to retrieve paginated results must be the same as those in the first request.
locationquery
typestring
parent
descriptionThe parent resource name of the data sources to list, in the form `dataTypes/{data_type_id}`.
locationpath
pattern^dataTypes/[^/]+$
requiredTrue
typestring
syncToken
descriptionToken for syncing any changes which have occurred since the last syncing request. See `next_sync_token` field in the response for more context. If this is the first ever request from a client, leave this field empty. Otherwise, use the value of `next_sync_token` returned in the last response (i.e. last page) of the previous series of List RPCs. Requests with a sync token that is too old are rejected by the server with HTTP 400 and error code FAILED_PRECONDITION.
locationquery
typestring
pathv2beta1/{+parent}/dataSources
response
$refListDataSourcesResponse
scopes
  • https://www.googleapis.com/auth/fitness.activity.read
  • https://www.googleapis.com/auth/fitness.activity.write
  • https://www.googleapis.com/auth/fitness.blood_glucose.read
  • https://www.googleapis.com/auth/fitness.blood_glucose.write
  • https://www.googleapis.com/auth/fitness.blood_pressure.read
  • https://www.googleapis.com/auth/fitness.blood_pressure.write
  • https://www.googleapis.com/auth/fitness.body.read
  • https://www.googleapis.com/auth/fitness.body.write
  • https://www.googleapis.com/auth/fitness.body_temperature.read
  • https://www.googleapis.com/auth/fitness.body_temperature.write
  • https://www.googleapis.com/auth/fitness.location.read
  • https://www.googleapis.com/auth/fitness.location.write
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.read
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.write
  • https://www.googleapis.com/auth/fitness.reproductive_health.read
  • https://www.googleapis.com/auth/fitness.reproductive_health.write
resources
dataPoints
deprecatedTrue
methods
batchCreate
deprecatedTrue
descriptionCreates one or more data points associated with a single data source. Data points are uniquely identified by their end time. A request to create a new data point with the same end time as an existing data point will update the existing data point.
flatPathv2beta1/dataTypes/{dataTypesId}/dataSources/{dataSourcesId}/dataPoints:batchCreate
httpMethodPOST
idfit.dataTypes.dataSources.dataPoints.batchCreate
parameterOrder
  • parent
parameters
parent
descriptionThe parent resource name, i.e. the resource name of the data source that these new data points are in. The parent resource name is in the form `dataTypes/{data_type_id}/dataSources/{data_source_id}`. This field is required.
locationpath
pattern^dataTypes/[^/]+/dataSources/[^/]+$
requiredTrue
typestring
pathv2beta1/{+parent}/dataPoints:batchCreate
request
$refBatchCreateDataPointsRequest
response
$refBatchCreateDataPointsResponse
scopes
  • https://www.googleapis.com/auth/fitness.activity.read
  • https://www.googleapis.com/auth/fitness.activity.write
  • https://www.googleapis.com/auth/fitness.blood_glucose.read
  • https://www.googleapis.com/auth/fitness.blood_glucose.write
  • https://www.googleapis.com/auth/fitness.blood_pressure.read
  • https://www.googleapis.com/auth/fitness.blood_pressure.write
  • https://www.googleapis.com/auth/fitness.body.read
  • https://www.googleapis.com/auth/fitness.body.write
  • https://www.googleapis.com/auth/fitness.body_temperature.read
  • https://www.googleapis.com/auth/fitness.body_temperature.write
  • https://www.googleapis.com/auth/fitness.location.read
  • https://www.googleapis.com/auth/fitness.location.write
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.read
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.write
  • https://www.googleapis.com/auth/fitness.reproductive_health.read
  • https://www.googleapis.com/auth/fitness.reproductive_health.write
batchDelete
deprecatedTrue
descriptionDeletes one or many data points specified. Data points need to belong to the same data source.
flatPathv2beta1/dataTypes/{dataTypesId}/dataSources/{dataSourcesId}/dataPoints:batchDelete
httpMethodPOST
idfit.dataTypes.dataSources.dataPoints.batchDelete
parameterOrder
  • parent
parameters
parent
descriptionThe parent resource name, i.e. the resource name of the data source that the data points to be deleted are in. The parent resource name is in the form `dataTypes/{data_type_id}/dataSources/{data_source_id}`. This field is required.
locationpath
pattern^dataTypes/[^/]+/dataSources/[^/]+$
requiredTrue
typestring
pathv2beta1/{+parent}/dataPoints:batchDelete
request
$refBatchDeleteDataPointsRequest
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/fitness.activity.read
  • https://www.googleapis.com/auth/fitness.activity.write
  • https://www.googleapis.com/auth/fitness.blood_glucose.read
  • https://www.googleapis.com/auth/fitness.blood_glucose.write
  • https://www.googleapis.com/auth/fitness.blood_pressure.read
  • https://www.googleapis.com/auth/fitness.blood_pressure.write
  • https://www.googleapis.com/auth/fitness.body.read
  • https://www.googleapis.com/auth/fitness.body.write
  • https://www.googleapis.com/auth/fitness.body_temperature.read
  • https://www.googleapis.com/auth/fitness.body_temperature.write
  • https://www.googleapis.com/auth/fitness.location.read
  • https://www.googleapis.com/auth/fitness.location.write
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.read
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.write
  • https://www.googleapis.com/auth/fitness.reproductive_health.read
  • https://www.googleapis.com/auth/fitness.reproductive_health.write
list
deprecatedTrue
descriptionLists all the data points of a user from a particular data source. Pagination and syncing are supported. Refer to the documentation on ListDataSources method for the behavior of pagination and syncing.
flatPathv2beta1/dataTypes/{dataTypesId}/dataSources/{dataSourcesId}/dataPoints
httpMethodGET
idfit.dataTypes.dataSources.dataPoints.list
parameterOrder
  • parent
parameters
pageSize
descriptionThe maximum number of items to return. If unset, a sensible default value will be used.
formatint32
locationquery
typeinteger
pageToken
descriptionToken for obtaining the next page of results in pagination. If this is the first request, leave this field empty. Otherwise, use the value of `next_page_token` returned from the previous List request.
locationquery
typestring
parent
descriptionThe parent resource name, i.e. the resource name of the data source whose data points this list request is for. The parent resource name is in the form `dataTypes/{data_type_id}/dataSources/{data_source_id}`. This field is required.
locationpath
pattern^dataTypes/[^/]+/dataSources/[^/]+$
requiredTrue
typestring
syncToken
descriptionToken for syncing any changes which have occurred since the last syncing request. See `next_sync_token` field in the response for more context. If this is the first ever request from a client, leave this field empty. Otherwise, use the value of `next_sync_token` returned in the last response (i.e. last page) of the previous series of List RPCs. Requests with a sync token that is too old are rejected by the server with HTTP 400 and error code FAILED_PRECONDITION.
locationquery
typestring
timeFilter.maxEndTime
descriptionThe largest end time of the set of resources to be retrieved. If this field is not set, it defaults to the maximum possible value of a timestamp, which is 9999-12-31T23:59:59Z. Refer to the comment on `min_end_time` for more clarification on how to use this field.
formatgoogle-datetime
locationquery
typestring
timeFilter.minEndTime
descriptionThe smallest end time of the set of resources to be retrieved. If this field is not set, it defaults to the minimum possible value of a timestamp, which is 0001-01-01T00:00:00Z. This field `min_end_time` and the next field `max_end_time`. decide the range of resources to retrieve. If there are three resources with their start times and end times being - [T1, T2), [T2, T3), [T4, T5) where T1 < T2 < T3 < T4 < T5, by setting `min_end_time` to T1 and `max_end_time` to T5, all three of these resources will be returned. If `min_end_time` is set to T2+1 and `max_end_time` is set to T4, only the resource [T2, T3) will be returned.
formatgoogle-datetime
locationquery
typestring
pathv2beta1/{+parent}/dataPoints
response
$refListDataPointsResponse
scopes
  • https://www.googleapis.com/auth/fitness.activity.read
  • https://www.googleapis.com/auth/fitness.activity.write
  • https://www.googleapis.com/auth/fitness.blood_glucose.read
  • https://www.googleapis.com/auth/fitness.blood_glucose.write
  • https://www.googleapis.com/auth/fitness.blood_pressure.read
  • https://www.googleapis.com/auth/fitness.blood_pressure.write
  • https://www.googleapis.com/auth/fitness.body.read
  • https://www.googleapis.com/auth/fitness.body.write
  • https://www.googleapis.com/auth/fitness.body_temperature.read
  • https://www.googleapis.com/auth/fitness.body_temperature.write
  • https://www.googleapis.com/auth/fitness.location.read
  • https://www.googleapis.com/auth/fitness.location.write
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.read
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.write
  • https://www.googleapis.com/auth/fitness.reproductive_health.read
  • https://www.googleapis.com/auth/fitness.reproductive_health.write
sessions
deprecatedTrue
methods
create
deprecatedTrue
descriptionCreates a session. If the session already exists, the request will fail with the code ALREADY_EXISTS. Client can specify the session resource name by setting the Session.name field, if it is not set, a server generated resource name will be used. The created session is returned as the response.
flatPathv2beta1/sessions
httpMethodPOST
idfit.sessions.create
parameterOrder
parameters
pathv2beta1/sessions
request
$refSession
response
$refSession
scopes
  • https://www.googleapis.com/auth/fitness.activity.read
  • https://www.googleapis.com/auth/fitness.activity.write
  • https://www.googleapis.com/auth/fitness.blood_glucose.read
  • https://www.googleapis.com/auth/fitness.blood_glucose.write
  • https://www.googleapis.com/auth/fitness.blood_pressure.read
  • https://www.googleapis.com/auth/fitness.blood_pressure.write
  • https://www.googleapis.com/auth/fitness.body.read
  • https://www.googleapis.com/auth/fitness.body.write
  • https://www.googleapis.com/auth/fitness.body_temperature.read
  • https://www.googleapis.com/auth/fitness.body_temperature.write
  • https://www.googleapis.com/auth/fitness.location.read
  • https://www.googleapis.com/auth/fitness.location.write
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.read
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.write
  • https://www.googleapis.com/auth/fitness.reproductive_health.read
  • https://www.googleapis.com/auth/fitness.reproductive_health.write
delete
deprecatedTrue
descriptionDeletes a session. If the session does not exist, the request will fail with the code NOT_FOUND.
flatPathv2beta1/sessions/{sessionsId}
httpMethodDELETE
idfit.sessions.delete
parameterOrder
  • name
parameters
name
descriptionThe resource name of the session to delete, in the form `sessions/{session_id}`.
locationpath
pattern^sessions/[^/]+$
requiredTrue
typestring
pathv2beta1/{+name}
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/fitness.activity.read
  • https://www.googleapis.com/auth/fitness.activity.write
  • https://www.googleapis.com/auth/fitness.blood_glucose.read
  • https://www.googleapis.com/auth/fitness.blood_glucose.write
  • https://www.googleapis.com/auth/fitness.blood_pressure.read
  • https://www.googleapis.com/auth/fitness.blood_pressure.write
  • https://www.googleapis.com/auth/fitness.body.read
  • https://www.googleapis.com/auth/fitness.body.write
  • https://www.googleapis.com/auth/fitness.body_temperature.read
  • https://www.googleapis.com/auth/fitness.body_temperature.write
  • https://www.googleapis.com/auth/fitness.location.read
  • https://www.googleapis.com/auth/fitness.location.write
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.read
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.write
  • https://www.googleapis.com/auth/fitness.reproductive_health.read
  • https://www.googleapis.com/auth/fitness.reproductive_health.write
list
deprecatedTrue
descriptionLists all the sessions of a user. Pagination and syncing are supported. Refer to the documentation on ListDataSources method for the behavior of pagination and syncing.
flatPathv2beta1/sessions
httpMethodGET
idfit.sessions.list
parameterOrder
parameters
pageSize
descriptionThe maximum number of items to return. If unset, a sensible default value will be used.
formatint32
locationquery
typeinteger
pageToken
descriptionToken for obtaining the next page of results in pagination. If this is the first request, leave this field empty. Otherwise, use the value of `next_page_token` returned from the previous List request.
locationquery
typestring
syncToken
descriptionToken for syncing any changes which have occurred since the last syncing request. See `next_sync_token` field in the response for more context. If this is the first ever request from a client, leave this field empty. Otherwise, use the value of `next_sync_token` returned in the last response (i.e. last page) of the previous series of List RPCs. Requests with a sync token that is too old are rejected by the server with HTTP 400 and error code FAILED_PRECONDITION.
locationquery
typestring
timeFilter.maxEndTime
descriptionThe largest end time of the set of resources to be retrieved. If this field is not set, it defaults to the maximum possible value of a timestamp, which is 9999-12-31T23:59:59Z. Refer to the comment on `min_end_time` for more clarification on how to use this field.
formatgoogle-datetime
locationquery
typestring
timeFilter.minEndTime
descriptionThe smallest end time of the set of resources to be retrieved. If this field is not set, it defaults to the minimum possible value of a timestamp, which is 0001-01-01T00:00:00Z. This field `min_end_time` and the next field `max_end_time`. decide the range of resources to retrieve. If there are three resources with their start times and end times being - [T1, T2), [T2, T3), [T4, T5) where T1 < T2 < T3 < T4 < T5, by setting `min_end_time` to T1 and `max_end_time` to T5, all three of these resources will be returned. If `min_end_time` is set to T2+1 and `max_end_time` is set to T4, only the resource [T2, T3) will be returned.
formatgoogle-datetime
locationquery
typestring
pathv2beta1/sessions
response
$refListSessionsResponse
scopes
  • https://www.googleapis.com/auth/fitness.activity.read
  • https://www.googleapis.com/auth/fitness.activity.write
  • https://www.googleapis.com/auth/fitness.blood_glucose.read
  • https://www.googleapis.com/auth/fitness.blood_glucose.write
  • https://www.googleapis.com/auth/fitness.blood_pressure.read
  • https://www.googleapis.com/auth/fitness.blood_pressure.write
  • https://www.googleapis.com/auth/fitness.body.read
  • https://www.googleapis.com/auth/fitness.body.write
  • https://www.googleapis.com/auth/fitness.body_temperature.read
  • https://www.googleapis.com/auth/fitness.body_temperature.write
  • https://www.googleapis.com/auth/fitness.location.read
  • https://www.googleapis.com/auth/fitness.location.write
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.read
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.write
  • https://www.googleapis.com/auth/fitness.reproductive_health.read
  • https://www.googleapis.com/auth/fitness.reproductive_health.write
patch
deprecatedTrue
descriptionUpdates a session. The session must already exist, otherwise the request will fail with the code NOT_FOUND. Partial resource update through a field mask is supported.
flatPathv2beta1/sessions/{sessionsId}
httpMethodPATCH
idfit.sessions.patch
parameterOrder
  • name
parameters
name
descriptionThe resource name of the session, in the form `sessions/{session_id}`. Session ID is a unique identifier for a session. This field is optional in a create request, otherwise it is required and always present. If there is already a Session with the session_id the same as the client specified session_id in a create request, the request will be rejected with the error ALREADY_EXISTS.
locationpath
pattern^sessions/[^/]+$
requiredTrue
typestring
updateMask
descriptionThe update mask that applies to the resource update. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask for how to use it.
formatgoogle-fieldmask
locationquery
typestring
pathv2beta1/{+name}
request
$refSession
response
$refSession
scopes
  • https://www.googleapis.com/auth/fitness.activity.read
  • https://www.googleapis.com/auth/fitness.activity.write
  • https://www.googleapis.com/auth/fitness.blood_glucose.read
  • https://www.googleapis.com/auth/fitness.blood_glucose.write
  • https://www.googleapis.com/auth/fitness.blood_pressure.read
  • https://www.googleapis.com/auth/fitness.blood_pressure.write
  • https://www.googleapis.com/auth/fitness.body.read
  • https://www.googleapis.com/auth/fitness.body.write
  • https://www.googleapis.com/auth/fitness.body_temperature.read
  • https://www.googleapis.com/auth/fitness.body_temperature.write
  • https://www.googleapis.com/auth/fitness.location.read
  • https://www.googleapis.com/auth/fitness.location.write
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.read
  • https://www.googleapis.com/auth/fitness.oxygen_saturation.write
  • https://www.googleapis.com/auth/fitness.reproductive_health.read
  • https://www.googleapis.com/auth/fitness.reproductive_health.write
root['revision']
new_value20250517
old_value20250113
root['rootUrl']
new_valuehttps://fishfood-fitness.sandbox.googleapis.com/
old_valuehttps://staging-fit.sandbox.googleapis.com/
root['schemas']
new_value
old_value
Application
idApplication
properties
detailsUrl
descriptionAn optional URI that can be used to link back to the application.
typestring
packageName
descriptionPackage name of the Android application.
typestring
version
descriptionVersion of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
typestring
typeobject
BatchCreateDataPointsRequest
descriptionRequest message for BatchCreateDataPoints RPC.
idBatchCreateDataPointsRequest
properties
dataPoints
descriptionData points to create.
items
$refDataPoint
typearray
typeobject
BatchCreateDataPointsResponse
descriptionResponse message for BatchCreateDataPoints RPC.
idBatchCreateDataPointsResponse
properties
results
descriptionBatch create results. If a data point creation succeeded, the newly created data point and a success code are returned; if it failed, the data point that failed to be created and the error code are returned. The order of the results is not necessarily in the same order as that of the request `data_points` field.
items
$refCreateDataPointResult
typearray
typeobject
BatchDeleteDataPointsRequest
descriptionRequest message for BatchDeleteDataPoints RPC.
idBatchDeleteDataPointsRequest
properties
timeFilter
$refTimeFilter
descriptionA filter that can be used to delete data points within a specified range. Please refer to the documentation on TimeFilter for how to use this field. Note that deleting data points based on data point start time is not supported.
typeobject
CreateDataPointResult
descriptionThe result of creating a single data point.
idCreateDataPointResult
properties
dataPoint
$refDataPoint
descriptionThe data point to create, as specified in the request.
status
$refStatus
descriptionThe status of this creation, i.e. whether it was successful or it failed.
typeobject
DataPoint
descriptionDATA ======================================================================== Represents a single data point, generated by a particular data source. A data point holds a value for each field, an end timestamp and a start time. The exact semantics of each of these attributes are specified in the documentation for the particular data type. A data point can represent an instantaneous measurement, reading or input observation, as well as averages or aggregates over a time interval. Check the data type documentation to determine which is the case for a particular data type. If the data point represents an instantaneous value, the start time must equal the end time. Data points always contain one value for each field of the data type. A data point is uniquely identified by its end time within the same data source of a user.
idDataPoint
properties
endTime
descriptionThe end time (exclusive) of the interval represented by this data point. This field is required and should always be present.
formatgoogle-datetime
typestring
startTime
descriptionThe start time (inclusive) of the interval represented by this data point. This field is required and should always be present.
formatgoogle-datetime
typestring
values
descriptionValues of each data type field for the data point. It is expected that each value corresponding to a data type field will occur in the same order that the field is listed within the data type specified in a data source. If a data type field is defined as optional and if the value for this data type field in this data point doesn't have a value, use the default instance of Value as a placeholder.
items
$refValue
typearray
typeobject
DataSource
descriptionDATA SOURCE ================================================================= Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Data sources of the same data type collect the same kind of data. Every data point inserted into or read from the Google Fit platform has an associated data source which has an associated data type. The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type. Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.
idDataSource
properties
application
$refApplication
descriptionInformation about an application which feeds sensor data into the platform.
dataStreamName
descriptionThe stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
typestring
device
$refDeviceInfo
descriptionRepresentation of an integrated device (such as a phone or a wearable) that can hold sensors.
name
descriptionThe resource name of the data source, in the form `dataTypes/{data_type_id}/dataSources/{data_source_id}`. Data source ID is a unique identifier within a single data type for the data stream produced by this data source. The identifier includes: * The physical device's manufacturer, model, and serial number (UID). * The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client. * The data source's type * The data source's stream name. Note that not all attributes of the data source are used as part of the data source ID. In particular, the version of the hardware or the application isn't used. This allows us to preserve the same data source ID through version updates. The exact format of the data source ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName The exact format of the data source ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName When any of the optional fields that make up the data source ID are absent, they will be omitted from the data source ID. The minimum viable data source ID would be: type:dataType.name:developer project number If device.uid is present, it is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
typestring
type
descriptionA constant describing the type of this data source. Indicates whether this data source produces raw or derived data.
enum
  • DATA_SOURCE_TYPE_UNSPECIFIED
  • RAW
  • DERIVED
enumDescriptions
  • This data source type is unspecified.
  • This data source produces raw data.
  • This data source produces derived data.
typestring
typeobject
DataType
descriptionDATA TYPE =================================================================== A data type defines the format of the values inside data points collected by data sources that are associated with this data type. Google Fit provides a set of platform fitness data types. Any developer can use such platform data types. Google Fit also enables developers to define new data types in apps that use the Google Fit API. Such are custom data types that are only accessible to developers who defined them. There are also a set of shared data types which are custom data types that have been approved by Google to be shared on the Google Fit platform. Any application could read data sources of such data types, but only applications approved by the developers who own such data types could write to data sources of these data types. Refer to the Data Types page at https://developers.google.com/fit for details on available public platform and shared data types, and how to create or share a custom data type.
idDataType
properties
customDataTypeName
descriptionCustom data type defined by individual developers. Custom data types are not accessible from applications other than the application that defined them. This field is set if this data type is a custom data type. A sensible data type name should be chosen to accurately represent the underlying data. Only ASCII characters are allowed in the name and the maximum length of the data type name is 128 characters.
typestring
fields
descriptionThe schema of this data type. A data type field represents one dimension of a data type. Required for Create requests that create custom data types. This field is read-only for platform data types and shared data types.
items
$refDataTypeField
typearray
name
descriptionThe resource name of the data type, in the form `dataTypes/{data_type_id}`.
typestring
platformDataTypeName
descriptionThe name of the platform data type provided by Google Fit. This field is set if this data type is a platform data type. See https://developers.google.com/fit/rest/v1/data-types for details, such as data type names, descriptions, permissions needed from the user, and data type fields for all the available data types. Note that, to store data points into your data source that belongs to this data type, your data points need to follow the schema of this data type. The formats of data type fields define the schema of a data type. For example, a data point for a data source associated with ACTIVITY_SAMPLE need to have its zeroth value being an integer and its first value being a float.
enum
  • PLATFORM_DATA_TYPE_UNSPECIFIED
  • ACTIVITY_SAMPLES
  • ACTIVITY_SEGMENT
  • ACTIVITY_SUMMARY
  • CALORIES_EXPENDED
  • CYCLING_PEDALING_CADENCE
  • CYCLING_WHEEL_REVOLUTION_RPM
  • DISTANCE_DELTA
  • HEART_RATE_BPM
  • HEART_RATE_SUMMARY
  • HEIGHT
  • LOCATION_SAMPLE
  • LOCATION_BOUNDING_BOX
  • NUTRITION
  • NUTRITION_SUMMARY
  • POWER_SAMPLE
  • POWER_SUMMARY
  • SPEED
  • SPEED_SUMMARY
  • STEP_COUNT_CADENCE
  • STEP_COUNT_DELTA
  • WEIGHT
  • WEIGHT_SUMMARY
  • ACTIVITY_EXERCISE
  • BLOOD_PRESSURE
  • BLOOD_PRESSURE_SUMMARY
  • BLOOD_GLUCOSE
  • BLOOD_GLUCOSE_SUMMARY
  • OXYGEN_SATURATION
  • OXYGEN_SATURATION_SUMMARY
  • BODY_TEMPERATURE
  • BODY_TEMPERATURE_SUMMARY
  • BASAL_BODY_TEMPERATURE
  • BASAL_BODY_TEMPERATURE_SUMMARY
  • CERVICAL_MUCUS
  • CERVICAL_POSITION
  • MENSTRUATION
  • OVULATION_TEST
  • VAGINAL_SPOTTING
  • MOVE_MINUTES
  • HEART_POINTS
  • SLEEP_SEGMENT
  • RESPIRATORY_RATE
  • TIME_ZONE_CHANGE
enumDeprecated
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • True
  • True
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
  • False
enumDescriptions
  • This platform data type is unspecified.
  • Instantaneous sample of the current activity.
  • Continuous time interval of a single activity.
  • Total time and number of segments in a particular activity for a time interval.
  • Total calories expended over a time interval.
  • Instantaneous pedaling rate in crank revolutions per minute.
  • Instantaneous wheel speed.
  • Distance covered since the last reading.
  • Heart rate in beats per minute.
  • Average, maximum, and minimum beats per minute for a time interval.
  • The user's height, in meters.
  • The user's current location.
  • A bounding box for the user's location over a time interval.
  • Food item information.
  • User's nutrition intake during a time interval.
  • Instantaneous power generated while performing an activity.
  • Average, maximum, and minimum power generated while performing an activity.
  • Instantaneous speed over ground.
  • Average, maximum, and minimum speed over ground over a time interval.
  • Instantaneous cadence in steps per minute.
  • Number of new steps since the last reading.
  • The user's weight.
  • Average, maximum, and minimum weight over a time interval.
  • A user's continuous workout routine.
  • Blood pressure.
  • Blood pressure summary.
  • Blood glucose.
  • Blood glucose summary.
  • Oxygen saturation.
  • Oxygen saturation summary.
  • Body temperature.
  • Body temperature summary.
  • Basal body temperature.
  • Basal body temprature basal summary.
  • Cervical mucus.
  • Cervical position.
  • Menstruation.
  • Ovulation test.
  • Vaginal spotting.
  • Active minutes.
  • Heart minutes.
  • Sleep Segment.
  • Respiratory Rate.
  • Time zone change.
typestring
sharedDataTypeName
descriptionThe name of the shared data type defined by a developer other than Google Fit but has been approved by Google Fit to share such type publicly. This field is set if this data type is a shared data type. Data sources of this type are readable by any developers but could only be written by developers that are allowed by the owner of this shared data type.
enum
  • SHARED_DATA_TYPE_UNDEFINED
  • NIKE_FUEL
  • ADIDAS_JUMP_HEIGHT
  • ADIDAS_HUSTLE
  • ADIDAS_QUICKNESS
enumDescriptions
  • This shared data type is undefined.
  • NikeFuel is a universal metric for movement that allows athletes to measure and compare all day activity and training intensity, and get real time feedback for any sport, at any skill level.
  • Adidas Jump Height measures the height in inches for each jump recorded over a given period of time.
  • Adidas Hustle measures how much force (effort) one generates through events (sprints, cuts and jumps) over a given period of time.
  • Adidas Quickness is determined by how quick (on average) one changes their upper body linear speed or direction.
typestring
typeobject
DataTypeField
descriptionThe schema of one dimension of a data type. In case of multi-dimensional data (such as an accelerometer with x, y, and z axes), each dimension is represented as one data type field. Platform data types and shared data types have data type field names in English that accurately represent the kind of data stored in a certain dimension, for example "latitude", "longitude". Data type field names for custom data types should be chosen sensibly to describe the underlying data. The data type field also defines the format of the data (int, float, etc.) stored in the underlying dimension.
idDataTypeField
properties
fieldName
descriptionDefines the name of the data type field. Data type field names need to be unique within the data type.
typestring
format
descriptionThe different supported formats for each field in a data type.
enum
  • FORMAT_UNSPECIFIED
  • INTEGER
  • FLOAT
  • STRING
  • MAP
enumDescriptions
  • This data type field format is unspecified.
  • This data type field contains an integer value.
  • This data type field contains a float value.
  • This data type field contains a string value.
  • This data type field contains a map value.
typestring
isOptional
descriptionWhether this data type field is optional. Default is false. If this data type field is optional, data points collected by data sources belonging to this data type don't need to set the value of this dimension.
typeboolean
typeobject
DeviceInfo
descriptionRepresentation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including: * Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance). * Display the source of data to the user (by using the device make or model). * Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone). * Build different analysis models for each device/version.
idDeviceInfo
properties
manufacturer
descriptionManufacturer of the product/hardware.
typestring
model
descriptionEnd-user visible model name for the device.
typestring
type
descriptionA constant representing the type of the device.
enum
  • TYPE_UNSPECIFIED
  • PHONE
  • TABLET
  • WATCH
  • CHEST_STRAP
  • SCALE
  • HEAD_MOUNTED
  • SMART_DISPLAY
enumDescriptions
  • The device type is unspecified.
  • An Android phone.
  • An Android tablet.
  • A watch or other wrist-mounted band.
  • A chest strap.
  • A scale.
  • Glass or other head-mounted device.
  • A smart display e.g. Nest device.
typestring
uid
descriptionThe serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form.
typestring
version
descriptionVersion string for the device hardware/software.
typestring
typeobject
Empty
descriptionA 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); }
idEmpty
properties
typeobject
ListDataPointsResponse
descriptionResponse message for ListDataPoints RPC.
idListDataPointsResponse
properties
dataDeletedSinceLastSync
descriptionWhether the user has requested their Google Fit data history to be deleted between the time of the client's last sync and the time of this current sync request. This field will be only be set to true in a sync response, and if pagination is required to return all the sync results, this field is only set to true in the first response. When this field is set to true, the client should delete all data points in the client's local storage before applying session changes, in order to get a correct sync.
typeboolean
dataPoints
descriptionData points from the requested data source in the requested time range. Data points are sorted by data point end time, in reverse chronological order. If there is pagination, these constitute one page of results and pages are also returned in the descending order of data point end time, i.e. the smallest data point end time in page X is equal to or larger than the largest data point end time in page X+1. If this is a response to a List request attempting to sync data points because the sync token is specified in the request, this field contains updated or new data points since last sync; if pagination is required, this field and the next field `deleted_data_point_end_times` together contain one page of results where the number of results is equal to the page size. Changes (both upsertions and deletions) are sorted by the time that the server received them, in ascending order. Changes in page X+1 occur strictly after changes in page X. Changes in one single page are deduped based on data point id and only the most recent change to a data point is returned. However, it is possible that page X and page X+1 both include a data point change to Data Point A. In this case, it is the client's responsibility to only use the change in page X+1, since it occurred more recently than the one in page X. Note that it is a valid request if the request has `time_filter.min_end_time` being T2 and `time_filter.max_end_time` being T3, however with a `sync_token` being one that the client obtained at T1, where T1 < T2 < T3. This is treated as syncing. The response will sync back all the data point changes happened after T1 with data point end time being in the range of T2 to T3, in the ascending order of data point change timestamp. However, clients are recommended to send a request with an empty `sync_token` in this case, as the results are exactly the same as the sync request, but in the descending order of data point end time.
items
$refDataPoint
typearray
deletedDataPointEndTimes
descriptionThe end times of the data points that have been deleted. This field is only non-empty in a syncing response where there are any deleted data points since last sync. If pagination is required to sync data points, this field and the previous `data_points` field together contain one page of results where the number of results is equal to the page size.
items
formatgoogle-datetime
typestring
typearray
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there is no more result.
typestring
nextSyncToken
descriptionToken to be used in the next syncing attempt. This token is only set in the response containing the last page of results. In other words, this token is only set when response `next_page_token` is empty.
typestring
typeobject
ListDataSourcesResponse
descriptionResponse message for ListDataSources RPC.
idListDataSourcesResponse
properties
dataDeletedSinceLastSync
descriptionWhether the user has requested their Google Fit data history to be deleted between the time of the client's last sync and the time of this current sync request. This field will be only be set to true in a sync response, and if pagination is required to return all the sync results, this field is only set to true in the first response. When this field is set to true, the client should delete all data sources in the client's local storage before applying session changes, in order to get a correct sync.
typeboolean
dataSources
descriptionThe user's data sources belonging to the requested data type. If there is pagination, this is one page of results. If this is a response to a List request attempting to sync data sources because the sync token is specified in the request, this field contains updated or new data sources since last sync; if pagination is required, this field and the next field `deleted_data_source_ids` together contain one page of results where the number of results is equal to the page size. Changes (both upsertions and deletions) are sorted by the time that the server received them, in ascending order. Changes in page X occur strictly before changes in page X+1. Changes in one single page are deduped based on data source id and only the most recent change of a data source is returned. However, it is possible that page X and page X+1 both include a data source change of Data Source A. In this case, it is the client's responsibility to only use the change in page X+1 as it occurred more recently than the one in page X.
items
$refDataSource
typearray
deletedDataSourceNames
descriptionData source resource names of the data sources that have been deleted, resource name is in the form `dataTypes/{data_type_id}/dataSources/{data_source_id}`. This field is only non-empty in a syncing response where there are any deleted data sources since last sync. If pagination is required to sync data sources, this field and the previous `data_sources` field together contain one page of results where the number of results is equal to the page size.
items
typestring
typearray
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results.
typestring
nextSyncToken
descriptionToken to be used in the next syncing attempt. This token is only set in the response containing the last page of results. In other words, this token is only set when response `next_page_token` is empty.
typestring
typeobject
ListDataTypesResponse
descriptionResponse message for ListDataTypes RPC.
idListDataTypesResponse
properties
dataTypes
descriptionData types that a user has. If there is pagination, this is one page of results.
items
$refDataType
typearray
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results.
typestring
typeobject
ListSessionsResponse
descriptionResponse message for ListSessions RPC.
idListSessionsResponse
properties
dataDeletedSinceLastSync
descriptionWhether the user has requested their Google Fit data history to be deleted between the time of the client's last sync and the time of this current sync request. This field will be only be set to true in a sync response, and if pagination is required to return all the sync results, this field is only set to true in the first response. When this field is set to true, the client should delete all sessions in the client's local storage before applying session changes, in order to get a correct sync.
typeboolean
deletedSessionNames
descriptionThe resource names of the sessions that have been deleted. This field is only non-empty in a syncing response where there are any deleted sessions since last sync. If pagination is required to sync sessions, this field and the previous sessions field together contain one page of results where the number of results is equal to the page size.
items
typestring
typearray
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there is no more result.
typestring
nextSyncToken
descriptionToken to be used in the next syncing attempt. This token is only set in the response containing the last page of results. In other words, this token is only set when response `next_page_token` is empty.
typestring
sessions
descriptionSessions in the requested time range. Sessions are sorted by session end time, in reverse chronological order. If there is pagination, these constitute one page of results and pages are also returned in the reverse chronological order of session end time, i.e. the smallest session end time in page X is equal to or larger than the largest session end time in Page X+1. If this is a response to a List request attempting to sync sessions because the sync token is specified in the request, this field contains updated or new sessions since last sync; if pagination is required, this field and the next field `deleted_session_names` together contain one page of results where the number of results is equal to the page size. Changes (both upsertions and deletions) are sorted by the time that the server received them, in ascending order. Changes in page X+1 occurred after changes in page X. Changes in one single page are deduped based on session ID and only the most recent change to a session is returned. However, it is possible that page X and page X+1 both include a session change to Session A. In this case, it is the client's responsibility to only use the change in page X+1, since it occurred more recently than the one in page X. Note that it is a valid request if the request has `time_filter.min_end_time` being T2 and `time_filter.max_end_time` being T3, however with a `sync_token` being one that the client obtained at T1, where T1 < T2 < T3. This is treated as syncing. The response will sync back all the session changes happened after T1 with session end time being in the range of T2 to T3. However, clients are recommended to send a request with an empty syncToken in this case, to simply list all the sessions in the range of T2 to T3.
items
$refSession
typearray
typeobject
Map
descriptionA map with string keys and MapValue values.
idMap
properties
map
additionalProperties
$refMapValue
descriptionA map with string keys and MapValue values.
typeobject
typeobject
MapValue
descriptionValue of an entry in Map.
idMapValue
properties
floatValue
descriptionFloating point value.
formatfloat
typenumber
typeobject
Session
descriptionSESSIONS ==================================================================== Sessions represent a time interval during which users perform a fitness activity such as a run, a bike ride, or a game. Sessions help organize data and perform detailed or aggregate queries for a fitness activity.
idSession
properties
activeDuration
descriptionThe duration of the total active time of this session. Active duration can be different from the duration of the entire session, as user can pause a session and restart some time later. Active duration must not be larger than the entire session duration which is equal to endTimeExclusive minus startTimeInclusive.
formatgoogle-duration
typestring
activityType
descriptionThe type of activity this session represents.
enum
  • ACTIVITY_TYPE_UNSPECIFIED
  • AEROBICS
  • ARCHERY
  • BADMINTON
  • BASEBALL
  • BASKETBALL
  • BIATHLON
  • BIKING
  • BIKING_HAND
  • BIKING_MOUNTAIN
  • BIKING_ROAD
  • BIKING_SPINNING
  • BIKING_STATIONARY
  • BIKING_UTILITY
  • BOXING
  • CALISTHENICS
  • CIRCUIT_TRAINING
  • CRICKET
  • CROSSFIT
  • CURLING
  • DANCING
  • DIVING
  • ELEVATOR
  • ELLIPTICAL
  • ERGOMETER
  • ESCALATOR
  • EXITING_VEHICLE
  • FENCING
  • FLOSSING
  • FOOTBALL_AMERICAN
  • FOOTBALL_AUSTRALIAN
  • FOOTBALL_SOCCER
  • FRISBEE_DISC
  • GARDENING
  • GOLF
  • GYMNASTICS
  • GUIDED_BREATHING
  • HANDBALL
  • HIGH_INTENSITY_INTERVAL_TRAINING
  • HIKING
  • HOCKEY
  • HORSEBACK_RIDING
  • HOUSEWORK
  • ICE_SKATING
  • INTERVAL_TRAINING
  • IN_VEHICLE
  • JUMP_ROPE
  • KAYAKING
  • KETTLEBELL_TRAINING
  • KICKBOXING
  • KICK_SCOOTER
  • KITESURFING
  • MARTIAL_ARTS
  • MEDITATION
  • MIXED_MARTIAL_ARTS
  • ON_FOOT
  • OTHER
  • P90X
  • PARAGLIDING
  • PILATES
  • POLO
  • RACQUETBALL
  • ROCK_CLIMBING
  • ROWING
  • ROWING_MACHINE
  • RUGBY
  • RUNNING
  • RUNNING_JOGGING
  • RUNNING_SAND
  • RUNNING_TREADMILL
  • SAILING
  • SCUBA_DIVING
  • SKATEBOARDING
  • SKATING
  • SKATING_CROSS
  • SKATING_INDOOR
  • SKATING_INLINE
  • SKIING
  • SKIING_BACK_COUNTRY
  • SKIING_CROSS_COUNTRY
  • SKIING_DOWNHILL
  • SKIING_KITE
  • SKIING_ROLLER
  • SLEDDING
  • SLEEP
  • SLEEP_LIGHT
  • SLEEP_DEEP
  • SLEEP_REM
  • SLEEP_AWAKE
  • SNOWBOARDING
  • SNOWMOBILE
  • SNOWSHOEING
  • SOFTBALL
  • SQUASH
  • STAIR_CLIMBING
  • STAIR_CLIMBING_MACHINE
  • STANDUP_PADDLEBOARDING
  • STILL
  • STRENGTH_TRAINING
  • SURFING
  • SWIMMING
  • SWIMMING_POOL
  • SWIMMING_OPEN_WATER
  • TABLE_TENNIS
  • TEAM_SPORTS
  • TENNIS
  • TILTING
  • TREADMILL
  • VOLLEYBALL
  • VOLLEYBALL_BEACH
  • VOLLEYBALL_INDOOR
  • WAKEBOARDING
  • WALKING
  • WALKING_FITNESS
  • WALKING_NORDIC
  • WALKING_PACED
  • WALKING_STROLLER
  • WALKING_TREADMILL
  • WATER_POLO
  • WEIGHTLIFTING
  • WHEELCHAIR
  • WINDSURFING
  • YOGA
  • ZUMBA
enumDescriptions
  • This activity type is unspecified.
  • Aerobis.
  • Archery.
  • Badminton.
  • Baseball.
  • Basketball.
  • Biathlon.
  • Biking. This activity is recorded passively on an Android device.
  • Hand biking.
  • Mountain biking.
  • Road biking.
  • Spinning.
  • Stationary biking.
  • Utility biking.
  • Boxing.
  • Calisthenics.
  • Circuit training.
  • Cricket.
  • Crossfit.
  • Curling.
  • Dancing.
  • Diving.
  • Elevator.
  • Elliptical.
  • Ergometer.
  • Escalator.
  • Exiting a vehicle.
  • Fencing.
  • Flossing.
  • American football.
  • Australian football.
  • Soccer.
  • Frisbee.
  • Gardening.
  • Golf.
  • Gymnastics.
  • Guided breathing.
  • Handball.
  • High intensity interval training.
  • Hiking.
  • Hockey.
  • Horseback riding.
  • Housework.
  • Ice skating.
  • Interval training.
  • In vehicle. This activity is recorded passively on an Android device.
  • Jump rope.
  • Kayaking.
  • Kettlebell training.
  • Kickboxing.
  • Kick scooter.
  • Kitesurfing.
  • Martial arts.
  • Meditation.
  • Mixed martial arts.
  • On foot. This activity is recorded passively on an Android device.
  • Other (unclassified fitness activity).
  • P90X exercises.
  • Paragliding.
  • Pilates.
  • Polo.
  • Racquetball.
  • Rock climbing.
  • Rowing.
  • Rowing machine.
  • Rugby.
  • Running. This activity is recorded passively on an Android device.
  • Jogging.
  • Running on sand.
  • Running on treadmill.
  • Sailing.
  • Scuba diving.
  • Skateboarding.
  • Skating.
  • Cross skating.
  • Skating (indoor).
  • Inline skating.
  • Skiing.
  • Back-country skiing.
  • Cross-country skiing.
  • Downhill skiing.
  • Kite skiing.
  • Roller skiing.
  • Sledding.
  • Sleeping.
  • Light sleep.
  • Deep sleep.
  • REM sleep.
  • Awake (during sleep cycle).
  • Snowboarding.
  • Snowmobile.
  • Snowshoeing.
  • Softball.
  • Squash.
  • Stair climbing.
  • Stair-climing machine.
  • Stand-up paddleboarding.
  • Still (not moving). This activity is recorded passively on an Android device.
  • Strenth training.
  • Surfing.
  • Swimming.
  • Swimming (swimming pool).
  • Swimming (open water).
  • Table tennis (ping pong).
  • Team sports.
  • Tennis.
  • Tilting (sudden device gravity change). This activity is recorded passively on an Android device.
  • Treadmill (walking or running).
  • Volleyball.
  • Volleyball (beach).
  • Volleyball (indoor).
  • Wakeboarding.
  • Walking. This activity is recorded passively on an Android device.
  • Walking (fitness).
  • Nordic walking.
  • Paced walking.
  • Walking (stroller).
  • Walking (treadmill).
  • Water polo.
  • Weightlifting.
  • Wheelchair.
  • Windsurfing.
  • Yoga.
  • Zumba.
typestring
application
$refApplication
descriptionThe application that created the session. This field is required in a create request.
description
descriptionA user defined description for this session. This field is optional.
typestring
endTime
descriptionThe end time (exclusive) of this session. This field is required.
formatgoogle-datetime
typestring
name
descriptionThe resource name of the session, in the form `sessions/{session_id}`. Session ID is a unique identifier for a session. This field is optional in a create request, otherwise it is required and always present. If there is already a Session with the session_id the same as the client specified session_id in a create request, the request will be rejected with the error ALREADY_EXISTS.
typestring
startTime
descriptionThe start time (inclusive) of this session. This field is required.
formatgoogle-datetime
typestring
title
descriptionA user defined title of this session. This field is optional.
typestring
typeobject
Status
descriptionThe `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
idStatus
properties
code
descriptionThe status code, which should be an enum value of google.rpc.Code.
formatint32
typeinteger
details
descriptionA list of messages that carry the error details. There is a common set of message types for APIs to use.
items
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
typeobject
typearray
message
descriptionA developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
typestring
typeobject
TimeFilter
descriptionA filter that can be used to filter resources that have a start time field and an end time field. For example, it can be used to filter data points with end times being in the specified range.
idTimeFilter
properties
maxEndTime
descriptionThe largest end time of the set of resources to be retrieved. If this field is not set, it defaults to the maximum possible value of a timestamp, which is 9999-12-31T23:59:59Z. Refer to the comment on `min_end_time` for more clarification on how to use this field.
formatgoogle-datetime
typestring
minEndTime
descriptionThe smallest end time of the set of resources to be retrieved. If this field is not set, it defaults to the minimum possible value of a timestamp, which is 0001-01-01T00:00:00Z. This field `min_end_time` and the next field `max_end_time`. decide the range of resources to retrieve. If there are three resources with their start times and end times being - [T1, T2), [T2, T3), [T4, T5) where T1 < T2 < T3 < T4 < T5, by setting `min_end_time` to T1 and `max_end_time` to T5, all three of these resources will be returned. If `min_end_time` is set to T2+1 and `max_end_time` is set to T4, only the resource [T2, T3) will be returned.
formatgoogle-datetime
typestring
typeobject
Value
descriptionHolder object for the value of a single field in a data point.
idValue
properties
floatValue
descriptionFloating point value.
formatfloat
typenumber
intValue
descriptionInteger value.
formatint32
typeinteger
mapValue
$refMap
descriptionMap value. The valid key space and units for the corresponding value of each entry should be documented as part of the data type definition. Keys should be kept small whenever possible. Data streams with large keys and high data frequency may be down sampled.
stringValue
descriptionString value. Strings should be kept small whenever possible. Data streams with large string values and high data frequency may be down sampled.
typestring
typeobject
root['servicePath']
new_valuefitness/v1/users/
old_value
root['title']
new_valueFitness API - Fishfood
old_valueStaging Google Fit API
root['version']
new_valuev1
old_valuev2beta1
sandbox/staging-googleonebackup-pa-
dictionary_item_added
  • root['resources']['backups']['methods']['commitTransaction']['parameters']['backupId']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['deleteBackupConfig']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['get']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['get']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['list']['parameters']['pageSize']['description']
  • root['resources']['backups']['methods']['list']['parameters']['pageToken']['description']
  • root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['list']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['startTransaction']['parameters']['backupId']['description']
  • root['resources']['backups']['methods']['updateConfig']['parameters']['androidId']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['fileId']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['transactionId']['description']
  • root['resources']['backups']['resources']['files']['methods']['deleteFiles']['parameters']['backupId']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['backupId']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['pageSize']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['pageToken']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['transactionId']['description']
  • root['resources']['media']['methods']['download']['parameters']['fileId']['description']
  • root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['media']['methods']['download']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['media']['methods']['download']['parameters']['transactionId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['backupId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['fileName']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.currentBytes']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.customData']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.diffObjectVersion']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.finalStatus']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.requestId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.requestReceivedParamsServingInfo']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.totalBytes']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.totalBytesIsEstimated']['description']
  • root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['media']['methods']['upload']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['media']['methods']['upload']['parameters']['transactionId']['description']
values_changed
root['baseUrl']
new_valuehttps://mmsbackup.pa.googleapis.com/
old_valuehttps://staging-googleonebackup-pa.sandbox.googleapis.com/
root['canonicalName']
new_valueMMS Backup Service
old_valueOne Backup
root['description']
new_valuemmsbackup.pa.googleapis.com API.
old_valueA boq-generated 1P API. For more information, see https://boq.corp.google.com/google3/java/com/google/subscriptions/backup/service
root['documentationLink']
new_valuehttps://support.google.com/android/answer/2819582
old_valuehttps://boq.corp.google.com/google3/java/com/google/subscriptions/backup/service
root['id']
new_valuepa_mmsbackup:v1
old_valuegoogleonebackup_pa:v1
root['mtlsRootUrl']
new_valuehttps://mmsbackup.pa.mtls.googleapis.com/
old_valuehttps://staging-googleonebackup-pa.mtls.sandbox.googleapis.com/
root['name']
new_valuepa_mmsbackup
old_valuegoogleonebackup_pa
root['resources']['backups']['methods']['commitTransaction']['description']
new_valueCommits the current active read-write transaction. All file changes are committed atomically. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if either backup or transaction doesn't exist. Already committed transactions are considered as non-existent. Returns a RESOURCE_EXHAUSTED canonical code if user doesn't have sufficient cloud storage capacity. Extract CommitTransactionResourceExhaustedFailureReason from RPC status to learn the exact reason. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['commitTransaction']['id']
new_valuepa_mmsbackup.backups.commitTransaction
old_valuegoogleonebackup_pa.backups.commitTransaction
root['resources']['backups']['methods']['commitTransaction']['request']['$ref']
new_valueCommitTransactionRequest
old_valueGoogleSubscriptionsBackupV1CommitTransactionRequest
root['resources']['backups']['methods']['commitTransaction']['response']['$ref']
new_valueCommitTransactionResponse
old_valueGoogleSubscriptionsBackupV1CommitTransactionResponse
root['resources']['backups']['methods']['create']['description']
new_valueCreates a new backup. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns an ALREADY_EXISTS canonical code if a backup for the provided GServices Android ID already exists. Returns a FAILED_PRECONDITION canonical code if GoogleOne backup already exist but it's an orphan - it's not present in Android Backup storage but already exists in Moscato. This can happen if backup deletion partially succeeded - backup was removed from Android Backup storage but deletion from Moscato failed. FAILED_PRECONDITION is also thrown if device is not initialized in Android Backup Storage, which means that Android backup flow hasn't yet started. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['create']['id']
new_valuepa_mmsbackup.backups.create
old_valuegoogleonebackup_pa.backups.create
root['resources']['backups']['methods']['create']['request']['$ref']
new_valueCreateBackupRequest
old_valueGoogleSubscriptionsBackupV1CreateBackupRequest
root['resources']['backups']['methods']['create']['response']['$ref']
new_valueBackup
old_valueGoogleSubscriptionsBackupV1Backup
root['resources']['backups']['methods']['delete']['description']
new_valueDeletes the backup and all of its files. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a NOT_FOUND canonical code if the backup doesn't exist. Returns a FAILED_PRECONDITION if device is not initialized in Android Backup Storage, which means that Android backup flow hasn't yet started. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['delete']['id']
new_valuepa_mmsbackup.backups.delete
old_valuegoogleonebackup_pa.backups.delete
root['resources']['backups']['methods']['delete']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['methods']['deleteBackupConfig']['description']
new_valueDeletes the backup configuration. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a NOT_FOUND canonical code if the backup configuration doesn't exist. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['deleteBackupConfig']['id']
new_valuepa_mmsbackup.backups.deleteBackupConfig
old_valuegoogleonebackup_pa.backups.deleteBackupConfig
root['resources']['backups']['methods']['deleteBackupConfig']['request']['$ref']
new_valueDeleteBackupConfigRequest
old_valueGoogleSubscriptionsBackupV1DeleteBackupConfigRequest
root['resources']['backups']['methods']['deleteBackupConfig']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['methods']['get']['description']
new_valueGets the backup for the provided GServices Android ID. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if the backups doesn't exist. Returns a FAILED_PRECONDITION canonical code if the requested backup is an orphan - it's not present in Android Backup storage but still exists in Moscato. This can happen if backup deletion partially succeeeded - backup was removed from Android Backup storage but deletion from Moscato failed. FAILED_PRECONDITION is also thrown if device is not initialized in Android Backup Storage, which means that Android backup flow hasn't yet started. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['get']['id']
new_valuepa_mmsbackup.backups.get
old_valuegoogleonebackup_pa.backups.get
root['resources']['backups']['methods']['get']['response']['$ref']
new_valueBackup
old_valueGoogleSubscriptionsBackupV1Backup
root['resources']['backups']['methods']['getConfig']['description']
new_valueReturns backup configuration for the pair of Gaia ID (extracted from EUC) and GServices Android ID from the request. Returns the default configuration (see BackupConfiguration proto for details) if there is nothing in Spanner. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['getConfig']['id']
new_valuepa_mmsbackup.backups.getConfig
old_valuegoogleonebackup_pa.backups.getConfig
root['resources']['backups']['methods']['getConfig']['response']['$ref']
new_valueBackupConfig
old_valueGoogleSubscriptionsBackupV1BackupConfig
root['resources']['backups']['methods']['list']['description']
new_valueGets a list of backups for the current user. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['list']['id']
new_valuepa_mmsbackup.backups.list
old_valuegoogleonebackup_pa.backups.list
root['resources']['backups']['methods']['list']['response']['$ref']
new_valueListBackupsResponse
old_valueGoogleSubscriptionsBackupV1ListBackupsResponse
root['resources']['backups']['methods']['startTransaction']['description']
new_valueStarts a long-running transaction. The timeout for read-only transactions is 48 hours, for read-write transactions - 2 weeks. The client is allowed to have multiple read-only transactions at the same time. The client is not allowed to have multiple read-write transactions at the same time. An attempt to create a read-write transaction would abort existing read-write transaction if any. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if the backup doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['startTransaction']['id']
new_valuepa_mmsbackup.backups.startTransaction
old_valuegoogleonebackup_pa.backups.startTransaction
root['resources']['backups']['methods']['startTransaction']['request']['$ref']
new_valueStartTransactionRequest
old_valueGoogleSubscriptionsBackupV1StartTransactionRequest
root['resources']['backups']['methods']['startTransaction']['response']['$ref']
new_valueTransaction
old_valueGoogleSubscriptionsBackupV1Transaction
root['resources']['backups']['methods']['updateConfig']['description']
new_valueCreates/updates backup configuration for the pair of Gaia ID (extracted from EUC) and GServices Android ID from the request. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['updateConfig']['id']
new_valuepa_mmsbackup.backups.updateConfig
old_valuegoogleonebackup_pa.backups.updateConfig
root['resources']['backups']['methods']['updateConfig']['request']['$ref']
new_valueUpdateBackupConfigRequest
old_valueGoogleSubscriptionsBackupV1UpdateBackupConfigRequest
root['resources']['backups']['methods']['updateConfig']['response']['$ref']
new_valueBackupConfig
old_valueGoogleSubscriptionsBackupV1BackupConfig
root['resources']['backups']['resources']['files']['methods']['delete']['description']
new_valueStages the file to be deleted once the current transaction is committed. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a NOT_FOUND canonical code if the backup or the file doesn't exist. Returns a FAILED_PRECONDITION code if transaction doesn't exist. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['resources']['files']['methods']['delete']['id']
new_valuepa_mmsbackup.backups.files.delete
old_valuegoogleonebackup_pa.backups.files.delete
root['resources']['backups']['resources']['files']['methods']['delete']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['description']
new_valueStages a group of files to be deleted once the current transaction is committed. Does nothing if file(s) are missing. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a FAILED_PRECONDITION canonical code if transaction doesn't exist or if read-only transaction was provided. Returns a NOT_FOUND canonical code if backup doesn't exist. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['id']
new_valuepa_mmsbackup.backups.files.deleteFiles
old_valuegoogleonebackup_pa.backups.files.deleteFiles
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['request']['$ref']
new_valueDeleteFilesRequest
old_valueGoogleSubscriptionsBackupV1DeleteFilesRequest
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['resources']['files']['methods']['list']['description']
new_valueLists all the files in a given backup. Returns an empty list if the backup is empty. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if either the backup or the transaction doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['resources']['files']['methods']['list']['id']
new_valuepa_mmsbackup.backups.files.list
old_valuegoogleonebackup_pa.backups.files.list
root['resources']['backups']['resources']['files']['methods']['list']['response']['$ref']
new_valueListFilesResponse
old_valueGoogleSubscriptionsBackupV1ListFilesResponse
root['resources']['media']['methods']['download']['description']
new_valueExports the file. This will send the actual file bytes to the client. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if the requested file doesn't exist. Returns a FAILED_PRECONDITION canonical code if the provided transaction or the backup doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['media']['methods']['download']['id']
new_valuepa_mmsbackup.media.download
old_valuegoogleonebackup_pa.media.download
root['resources']['media']['methods']['download']['response']['$ref']
new_valueFile
old_valueGoogleSubscriptionsBackupV1File
root['resources']['media']['methods']['upload']['description']
new_valueUpdates the file and returns its updated metadata. If the file doesn't exist, then this will create a new file. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a FAILED_PRECONDITION canonical code if transaction doesn't exist. Returns a NOT_FOUND canonical code if the backup doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['media']['methods']['upload']['id']
new_valuepa_mmsbackup.media.upload
old_valuegoogleonebackup_pa.media.upload
root['resources']['media']['methods']['upload']['request']['$ref']
new_valueFile
old_valueGoogleSubscriptionsBackupV1File
root['resources']['media']['methods']['upload']['response']['$ref']
new_valueFile
old_valueGoogleSubscriptionsBackupV1File
root['revision']
new_value20250517
old_value20250412
root['rootUrl']
new_valuehttps://mmsbackup.pa.googleapis.com/
old_valuehttps://staging-googleonebackup-pa.sandbox.googleapis.com/
root['schemas']
new_value
ApiRequestHeader
descriptionHeader for requests sent to Google One Backup API.
idApiRequestHeader
properties
clientInfo
$refClientInfo
descriptionOptional info about the client calling the API.
experimentOverrides
descriptionOptional experiment overrides. This is a comma-separate list of experiment names. A minus sign can be used to disable an experiment. Example usage: "ExperimentOne": Enables ExperimentOne. "ExperimentOne,-ExperimentTwo": Enables ExperimentOne and disables ExperimentTwo.
typestring
typeobject
Backup
descriptionA backup belonging to a client.
idBackup
properties
activeTransactionId
descriptionThe active read-write transaction for this backup if there is an uncommitted write transaction. Output only.
typestring
backupId
descriptionRequired. The relative resource name of the backup, e.g. "backups/1337". Output only.
typestring
sizeBytes
descriptionAggregate size of all files contained in this backup, in bytes. Output only.
formatint64
typestring
updateTime
descriptionThe time the backup was last updated. Output only.
formatgoogle-datetime
typestring
typeobject
BackupConfig
idBackupConfig
properties
androidSdkVersion
descriptionOptional. If set, specifies the value of the sdk version of android OS.
formatint32
typeinteger
gmsCoreApkVersion
descriptionOptional. If set, specifies the value of the apk version of gms core.
typestring
hasMmsBackupEnabledBefore
descriptionIs set as long as a user has mms backup turned on in the history.
typeboolean
hasRequiredPhotosPermission
descriptionOptional. If set, specifies whether a user has the required photos app permission to send photos_backup_onboarding notifications.
typeboolean
inMsaExperiment
descriptionOptional. If set, specifies whether the user's device is in the experiment group to roll out MMS B&R for everyone using the MSA.
typeboolean
isAndroidBackupEnabled
typeboolean
isAndroidBackupSupported
descriptionIs set if the device satisfies the pre-requisites for Android backup to be performed.
typeboolean
isDeviceEtu
descriptionOptional. If set, specifies the value of whether EBNR is targeted on this device.
typeboolean
isMmsBackupEnabled
descriptionIs always "false" by default or if user is either a Dasher/Unicorn/Griffin user.
typeboolean
isMmsBackupSupported
descriptionIs set if the device satisfies the pre-requisites for Mms backup to be performed.
typeboolean
isPhotosBackupEnabled
typeboolean
isPhotosBackupSupported
descriptionIs set if the device satisfies the pre-requisites for Photos backup to be performed.
typeboolean
isPhotosDefaultGallery
descriptionOptional. If set, specifies the value of whether Photos is the default gallery on this device.
typeboolean
lastAppBackupCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful App Backup action.
formatgoogle-datetime
typestring
photosApkVersion
descriptionOptional. If set, specifies the value of the apk version of photos app.
typestring
systemRestoreCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful System Restore action.
formatgoogle-datetime
typestring
wasMsaShown
descriptionOptional. If set, specifies whether the MSA for MMS enablement was shown previously on this device.
typeboolean
typeobject
Blobstore2Info
descriptionInformation to read/write to blobstore2.
idBlobstore2Info
properties
blobGeneration
descriptionThe blob generation id.
formatint64
typestring
blobId
descriptionThe blob id, e.g., /blobstore/prod/playground/scotty
typestring
downloadReadHandle
descriptionRead handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
formatbyte
typestring
readToken
descriptionThe blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
typestring
uploadMetadataContainer
descriptionMetadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
formatbyte
typestring
typeobject
ClientInfo
descriptionInformation about a particular client calling the API.
idClientInfo
properties
clientId
descriptionRequired client ID of the caller. Behavior of certain RPCs may differ slightly by client ID, according to the client's needs.
enum
  • CLIENT_ID_UNSPECIFIED
  • CLIENT_ID_G1_ANDROID_APP
  • CLIENT_ID_GMSCORE_BACKUP
  • CLIENT_ID_DRIVE_BACKUP
  • CLIENT_ID_MANUAL
  • CLIENT_ID_PROBER
  • CLIENT_ID_PIXELMIGRATE
enumDescriptions
  • Default ID used when no other particular ID applies, or the client has not yet configured a new client ID.
  • Client ID for the G1 Android app.
  • Client ID for the GmsCore backup modules.
  • Client ID for the Drive backup modules.
  • Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
  • Client ID used by service probers.
  • Client ID for the PixelMigrate/Restore Android app.
typestring
version
descriptionRequired. Version of the client. This field is optional for CLIENT_ID_MANUAL client ID.
typestring
typeobject
CommitTransactionRequest
descriptionA request to finish a read-write transaction, committing all file changes atomically.
idCommitTransactionRequest
properties
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
transactionId
descriptionRequired. The id of the transaction to commit.
typestring
typeobject
CommitTransactionResponse
descriptionA transaction commit response.
idCommitTransactionResponse
properties
typeobject
CompositeMedia
descriptionA sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
idCompositeMedia
properties
blobRef
deprecatedTrue
descriptionBlobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
formatbyte
typestring
blobstore2Info
$refBlobstore2Info
descriptionBlobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
cosmoBinaryReference
descriptionA binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
formatbyte
typestring
crc32cHash
descriptioncrc32.c hash for the payload.
formatuint32
typeinteger
inline
descriptionMedia data, set if reference_type is INLINE
formatbyte
typestring
length
descriptionSize of the data, in bytes
formatint64
typestring
md5Hash
descriptionMD5 hash for the payload.
formatbyte
typestring
objectId
$refObjectId
descriptionReference to a TI Blob, set if reference_type is BIGSTORE_REF.
path
descriptionPath to the data, set if reference_type is PATH
typestring
referenceType
descriptionDescribes what the field reference contains.
enum
  • PATH
  • BLOB_REF
  • INLINE
  • BIGSTORE_REF
  • COSMO_BINARY_REFERENCE
enumDescriptions
  • Reference contains a GFS path or a local path.
  • Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.
  • Data is included into this proto buffer
  • Reference points to a bigstore object
  • Indicates the data is stored in cosmo_binary_reference.
typestring
sha1Hash
descriptionSHA-1 hash for the payload.
formatbyte
typestring
typeobject
ContentTypeInfo
descriptionDetailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.
idContentTypeInfo
properties
bestGuess
descriptionScotty's best guess of what the content type of the file is.
typestring
fromBytes
descriptionThe content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
typestring
fromFileName
descriptionThe content type of the file derived from the file extension of the original file name used by the client.
typestring
fromHeader
descriptionThe content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
typestring
fromUrlPath
descriptionThe content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
typestring
typeobject
CreateBackupRequest
idCreateBackupRequest
properties
androidId
descriptionRequired. A value that uniquely identifies user's device to Google's servers.
formatint64
typestring
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
typeobject
DeleteBackupConfigRequest
descriptionA request to delete a backup config.
idDeleteBackupConfigRequest
properties
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
typeobject
DeleteFilesRequest
descriptionRequest to delete a group of files.
idDeleteFilesRequest
properties
fileIds
descriptionThe file ids relative to backup_id, e.g. "data/selfie.jpg" or "foo.txt"
items
typestring
typearray
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
transactionId
descriptionRequired. The transaction to execute the delete in.
typestring
typeobject
DiffChecksumsResponse
descriptionBackend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffChecksumsResponse
properties
checksumsLocation
$refCompositeMedia
descriptionExactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
chunkSizeBytes
descriptionThe chunk size of checksums. Must be a multiple of 256KB.
formatint64
typestring
objectLocation
$refCompositeMedia
descriptionIf set, calculate the checksums based on the contents and return them to the caller.
objectSizeBytes
descriptionThe total size of the server object.
formatint64
typestring
objectVersion
descriptionThe object version of the object the checksums are being returned for.
typestring
typeobject
DiffDownloadResponse
descriptionBackend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffDownloadResponse
properties
objectLocation
$refCompositeMedia
descriptionThe original object location.
typeobject
DiffUploadRequest
descriptionA Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffUploadRequest
properties
checksumsInfo
$refCompositeMedia
descriptionThe location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
objectInfo
$refCompositeMedia
descriptionThe location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
objectVersion
descriptionThe object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
typestring
typeobject
DiffUploadResponse
descriptionBackend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffUploadResponse
properties
objectVersion
descriptionThe object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
typestring
originalObject
$refCompositeMedia
descriptionThe location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
typeobject
DiffVersionResponse
descriptionBackend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffVersionResponse
properties
objectSizeBytes
descriptionThe total size of the server object.
formatint64
typestring
objectVersion
descriptionThe version of the object stored at the server.
typestring
typeobject
DownloadParameters
descriptionParameters specific to media downloads.
idDownloadParameters
properties
allowGzipCompression
descriptionA boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
typeboolean
ignoreRange
descriptionDetermining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
typeboolean
typeobject
Empty
descriptionA 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); }
idEmpty
properties
typeobject
File
descriptionA file belonging to a backup
idFile
properties
blob
$refMedia
descriptionThe blob supplied to/from Scotty.
fileId
descriptionThe relative resource name of the backup, e.g: "backups/31337/files/selfie.jpg"
typestring
mediaResponseInfo
$refMediaResponseInfo
descriptionOutput only. Media response details.
readOnlyTrue
mimeType
descriptionThe mime type of the file contents. May not be needed.
typestring
sizeBytes
descriptionThe size of the file in bytes.
formatint64
typestring
updateTime
descriptionThe time the backup was last updated.
formatgoogle-datetime
typestring
typeobject
ListBackupsResponse
descriptionResponse including a list of G1 backups
idListBackupsResponse
properties
backups
additionalProperties
$refBackup
descriptionA list of backups, mapping from androidId to backup entity.
typeobject
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
typeobject
ListFilesResponse
idListFilesResponse
properties
files
descriptionAll files associated with the backup.
items
$refFile
typearray
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
typeobject
Media
descriptionA reference to data stored on the filesystem, on GFS or in blobstore.
idMedia
properties
algorithm
deprecatedTrue
descriptionDeprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
typestring
bigstoreObjectRef
deprecatedTrue
descriptionUse object_id instead.
formatbyte
typestring
blobRef
deprecatedTrue
descriptionBlobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
formatbyte
typestring
blobstore2Info
$refBlobstore2Info
descriptionBlobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
compositeMedia
descriptionA composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.
items
$refCompositeMedia
typearray
contentType
descriptionMIME type of the data
typestring
contentTypeInfo
$refContentTypeInfo
descriptionExtended content type information provided for Scotty uploads.
cosmoBinaryReference
descriptionA binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
formatbyte
typestring
crc32cHash
descriptionFor Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
formatuint32
typeinteger
diffChecksumsResponse
$refDiffChecksumsResponse
descriptionSet if reference_type is DIFF_CHECKSUMS_RESPONSE.
diffDownloadResponse
$refDiffDownloadResponse
descriptionSet if reference_type is DIFF_DOWNLOAD_RESPONSE.
diffUploadRequest
$refDiffUploadRequest
descriptionSet if reference_type is DIFF_UPLOAD_REQUEST.
diffUploadResponse
$refDiffUploadResponse
descriptionSet if reference_type is DIFF_UPLOAD_RESPONSE.
diffVersionResponse
$refDiffVersionResponse
descriptionSet if reference_type is DIFF_VERSION_RESPONSE.
downloadParameters
$refDownloadParameters
descriptionParameters for a media download.
filename
descriptionOriginal file name
typestring
hash
deprecatedTrue
descriptionDeprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.
typestring
hashVerified
descriptionFor Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
typeboolean
inline
descriptionMedia data, set if reference_type is INLINE
formatbyte
typestring
isPotentialRetry
description|is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.
typeboolean
length
descriptionSize of the data, in bytes
formatint64
typestring
md5Hash
descriptionScotty-provided MD5 hash for an upload.
formatbyte
typestring
mediaId
descriptionMedia id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
formatbyte
typestring
objectId
$refObjectId
descriptionReference to a TI Blob, set if reference_type is BIGSTORE_REF.
path
descriptionPath to the data, set if reference_type is PATH
typestring
referenceType
descriptionDescribes what the field reference contains.
enum
  • PATH
  • BLOB_REF
  • INLINE
  • GET_MEDIA
  • COMPOSITE_MEDIA
  • BIGSTORE_REF
  • DIFF_VERSION_RESPONSE
  • DIFF_CHECKSUMS_RESPONSE
  • DIFF_DOWNLOAD_RESPONSE
  • DIFF_UPLOAD_REQUEST
  • DIFF_UPLOAD_RESPONSE
  • COSMO_BINARY_REFERENCE
  • ARBITRARY_BYTES
enumDescriptions
  • Reference contains a GFS path or a local path.
  • Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.
  • Data is included into this proto buffer
  • Data should be accessed from the current service using the operation GetMedia.
  • The content for this media object is stored across multiple partial media objects under the composite_media field.
  • Reference points to a bigstore object
  • Indicates the data is stored in diff_version_response.
  • Indicates the data is stored in diff_checksums_response.
  • Indicates the data is stored in diff_download_response.
  • Indicates the data is stored in diff_upload_request.
  • Indicates the data is stored in diff_upload_response.
  • Indicates the data is stored in cosmo_binary_reference.
  • Informs Scotty to generate a response payload with the size specified in the length field. The contents of the payload are generated by Scotty and are undefined. This is useful for testing download speeds between the user and Scotty without involving a real payload source. Note: range is not supported when using arbitrary_bytes.
typestring
sha1Hash
descriptionScotty-provided SHA1 hash for an upload.
formatbyte
typestring
sha256Hash
descriptionScotty-provided SHA256 hash for an upload.
formatbyte
typestring
timestamp
descriptionTime at which the media data was last updated, in milliseconds since UNIX epoch
formatuint64
typestring
token
descriptionA unique fingerprint/version id for the media data
typestring
typeobject
MediaResponseInfo
descriptionThis message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse { optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 }
idMediaResponseInfo
properties
customData
descriptionData to copy from backend response to the next backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.
typestring
dataStorageTransform
descriptionSpecifies any transformation to be applied to data before persisting it or retrieving from storage. E.g., encryption options for blobstore2. This should be of the form uploader_service.DataStorageTransform.
formatbyte
typestring
destinationBlobMintIndex
descriptionFor the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when writing the resulting blob. This field is optional. It's not required ever, even if `original_object_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.
formatint32
typeinteger
dynamicDropTarget
descriptionSpecifies the Scotty Drop Target to use for uploads. If present in a media response, Scotty does not upload to a standard drop zone. Instead, Scotty saves the upload directly to the location specified in this drop target. Unlike drop zones, the drop target is the final storage location for an upload. So, the agent does not need to clone the blob at the end of the upload. The agent is responsible for garbage collecting any orphaned blobs that may occur due to aborted uploads. For more information, see the drop target design doc here: http://goto/ScottyDropTarget This field will be preferred to dynamicDropzone. If provided, the identified field in the response must be of the type uploader.agent.DropTarget.
formatbyte
typestring
dynamicDropzone
descriptionSpecifies the Scotty dropzone to use for uploads.
typestring
mediaForDiff
$refMedia
descriptionDiff Updates must respond to a START notification with this Media proto to tell Scotty to decode the diff encoded payload and apply the diff against this field. If the request was diff encoded, but this field is not set, Scotty will treat the encoding as identity. This is corresponding to Apiary's DiffUploadResponse.original_object (//depot/google3/gdata/rosy/proto/data.proto?l=413). See go/esf-scotty-diff-upload for more information.
originalObjectBlobMintIndex
descriptionFor the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when reading the original blob. This field is optional. It's not required ever, even if `destination_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.
formatint32
typeinteger
requestClass
descriptionRequest class to use for all Blobstore operations for this request.
enum
  • UNKNOWN_REQUEST_CLASS
  • LATENCY_SENSITIVE
  • PRODUCTION_BATCH
  • BEST_EFFORT
enumDescriptions
  • Unpopulated request_class in log files will be taken as 0 in dremel query. GoogleSQL will try to cast it to enum by default. An unused 0 value is added to avoid GoogleSQL casting error. Please refer to b/69677280.
  • A latency-sensitive request.
  • A request generated by a batch process.
  • A best-effort request.
typestring
scottyAgentUserId
descriptionRequester ID passed along to be recorded in the Scotty logs
formatint64
typestring
scottyCustomerLog
descriptionCustomer-specific data to be recorded in the Scotty logs type is logs_proto_scotty.CustomerLog
formatbyte
typestring
trafficClassField
descriptionSpecifies the TrafficClass that Scotty should use for any RPCs to fetch the response bytes. Will override the traffic class GTOS of the incoming http request. This is a temporary field to facilitate whitelisting and experimentation by the bigstore agent only. For instance, this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.
enum
  • BE1
  • AF1
  • AF2
  • AF3
  • AF4
  • NC1
  • NC0
  • BE0
  • LLQ
  • LLQ1
  • LLQ2
  • LLQ3
enumDescriptions
  • Application-selectable traffic classes Best effort
  • Assured forwarding priority 1
  • Assured forwarding priority 2
  • Assured forwarding priority 3
  • Assured forwarding priority 4
  • Network control
  • Network control
  • Best effort at high packet loss
  • Low-latency queue (LLQ) best effort (go/llq)
  • LLQ assured forwarding priority 1 (go/llq2)
  • LLQ assured forwarding priority 2 (go/llq2)
  • LLQ assured forwarding priority 3 (go/llq3)
typestring
verifyHashFromHeader
descriptionTells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-Hash header.
typeboolean
typeobject
ObjectId
descriptionThis is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.
idObjectId
properties
bucketName
descriptionThe name of the bucket to which this object belongs.
typestring
generation
descriptionGeneration of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
formatint64
typestring
objectName
descriptionThe name of the object.
typestring
typeobject
StartTransactionRequest
descriptionA request to start a new transaction. Both read-write and read-only transactions are supported. Read-write transactions are used to group write requests along with the ability to read uncommitted changes. Read-only transactions present a consistent view of the backup across multiple read requests.
idStartTransactionRequest
properties
maxTransactionSize
descriptionRequired for READ_WRITE transaction. Works as a two-way contract between client and server to prevent cloud abuse. When starting a new read-write transaction server ensures the user has sufficient cloud quota and substracts file size from the remaining transaction's quota on each file upload. File deletions do not count against transaction's quota because the server doesn't know the size of a deleted file. Server starts blocking file upserts if client goes beyond the transaction's limit.
formatint64
typestring
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
transactionOptions
$refTransactionOptions
descriptionRequired. Instructs the backend how to create a transaction.
typeobject
Transaction
descriptionA read or write transaction created with a call to StartTransaction.
idTransaction
properties
id
descriptionThe unique identifier for the transaction.
typestring
transactionOptions
$refTransactionOptions
descriptionTransaction options.
typeobject
TransactionOptions
descriptionOptions that can be specified while creating a transaction.
idTransactionOptions
properties
mode
descriptionThe mode of the transaction to be created.
enum
  • TRANSACTION_MODE_UNSPECIFIED
  • READ_ONLY
  • READ_WRITE
enumDescriptions
  • For catching unset values.
  • A transaction that only works for list and get operations.
  • A transaction that also works for update and delete operations.
typestring
typeobject
UpdateBackupConfigRequest
idUpdateBackupConfigRequest
properties
androidSdkVersion
descriptionOptional. If set, specifies the value of the sdk version of android OS.
formatint32
typeinteger
gmsCoreApkVersion
descriptionOptional. If set, specifies the value of the apk version of gms core.
typestring
hasRequiredPhotosPermission
descriptionOptional. If set, specifies whether the user grant photos app with the required permission.
typeboolean
inMsaExperiment
descriptionOptional. If set, specifies whether the user's device is in the experiment group to roll out MMS B&R for everyone using the MSA.
typeboolean
isAndroidBackupEnabled
descriptionOptional. If set, specifies the value of whether Android backup is enabled that should be updated.
typeboolean
isAndroidBackupSupported
descriptionOptional. If set, specifies the value of whether Android backup is supported on this device.
typeboolean
isDeviceEtu
descriptionOptional. If set, specifies the value of whether EBNR is targeted on this device.
typeboolean
isMmsBackupEnabled
descriptionOptional. If set, specifies the value of whether MMS backup is enabled that should be updated.
typeboolean
isMmsBackupSupported
descriptionOptional. If set, specifies the value of whether MMS backup is supported on this device.
typeboolean
isPhotosBackupEnabled
descriptionOptional. If set, specifies the value of whether Photos backup is enabled that should be updated.
typeboolean
isPhotosBackupSupported
descriptionOptional. If set, specifies the value of whether Photos backup is supported on this device.
typeboolean
isPhotosDefaultGallery
descriptionOptional. If set, specifies the value of whether Photos is the default gallery on this device.
typeboolean
lastAppBackupCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful App Backup action.
formatgoogle-datetime
typestring
photosApkVersion
descriptionOptional. If set, specifies the value of the apk version of photos app.
typestring
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
systemRestoreCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful System Restore action.
formatgoogle-datetime
typestring
wasMsaShown
descriptionOptional. If set, specifies whether the MSA for MMS enablement was shown previously on this device.
typeboolean
typeobject
old_value
ApiservingMediaResponseInfo
idApiservingMediaResponseInfo
properties
customData
typestring
dataStorageTransform
formatbyte
typestring
destinationBlobMintIndex
formatint32
typeinteger
dynamicDropTarget
formatbyte
typestring
dynamicDropzone
typestring
mediaForDiff
$refGdataMedia
originalObjectBlobMintIndex
formatint32
typeinteger
requestClass
enum
  • UNKNOWN_REQUEST_CLASS
  • LATENCY_SENSITIVE
  • PRODUCTION_BATCH
  • BEST_EFFORT
enumDescriptions
typestring
scottyAgentUserId
formatint64
typestring
scottyCustomerLog
formatbyte
typestring
trafficClassField
enum
  • BE1
  • AF1
  • AF2
  • AF3
  • AF4
  • NC1
  • NC0
  • BE0
  • LLQ
  • LLQ1
  • LLQ2
  • LLQ3
enumDescriptions
typestring
verifyHashFromHeader
typeboolean
typeobject
GdataBlobstore2Info
idGdataBlobstore2Info
properties
blobGeneration
formatint64
typestring
blobId
typestring
downloadReadHandle
formatbyte
typestring
readToken
typestring
uploadMetadataContainer
formatbyte
typestring
typeobject
GdataCompositeMedia
idGdataCompositeMedia
properties
blobRef
deprecatedTrue
formatbyte
typestring
blobstore2Info
$refGdataBlobstore2Info
cosmoBinaryReference
formatbyte
typestring
crc32cHash
formatuint32
typeinteger
inline
formatbyte
typestring
length
formatint64
typestring
md5Hash
formatbyte
typestring
objectId
$refGdataObjectId
path
typestring
referenceType
enum
  • PATH
  • BLOB_REF
  • INLINE
  • BIGSTORE_REF
  • COSMO_BINARY_REFERENCE
enumDescriptions
typestring
sha1Hash
formatbyte
typestring
typeobject
GdataContentTypeInfo
idGdataContentTypeInfo
properties
bestGuess
typestring
fromBytes
typestring
fromFileName
typestring
fromHeader
typestring
fromUrlPath
typestring
typeobject
GdataDiffChecksumsResponse
idGdataDiffChecksumsResponse
properties
checksumsLocation
$refGdataCompositeMedia
chunkSizeBytes
formatint64
typestring
objectLocation
$refGdataCompositeMedia
objectSizeBytes
formatint64
typestring
objectVersion
typestring
typeobject
GdataDiffDownloadResponse
idGdataDiffDownloadResponse
properties
objectLocation
$refGdataCompositeMedia
typeobject
GdataDiffUploadRequest
idGdataDiffUploadRequest
properties
checksumsInfo
$refGdataCompositeMedia
objectInfo
$refGdataCompositeMedia
objectVersion
typestring
typeobject
GdataDiffUploadResponse
idGdataDiffUploadResponse
properties
objectVersion
typestring
originalObject
$refGdataCompositeMedia
typeobject
GdataDiffVersionResponse
idGdataDiffVersionResponse
properties
objectSizeBytes
formatint64
typestring
objectVersion
typestring
typeobject
GdataDownloadParameters
idGdataDownloadParameters
properties
allowGzipCompression
typeboolean
ignoreRange
typeboolean
typeobject
GdataMedia
idGdataMedia
properties
algorithm
deprecatedTrue
typestring
bigstoreObjectRef
deprecatedTrue
formatbyte
typestring
blobRef
deprecatedTrue
formatbyte
typestring
blobstore2Info
$refGdataBlobstore2Info
compositeMedia
items
$refGdataCompositeMedia
typearray
contentType
typestring
contentTypeInfo
$refGdataContentTypeInfo
cosmoBinaryReference
formatbyte
typestring
crc32cHash
formatuint32
typeinteger
diffChecksumsResponse
$refGdataDiffChecksumsResponse
diffDownloadResponse
$refGdataDiffDownloadResponse
diffUploadRequest
$refGdataDiffUploadRequest
diffUploadResponse
$refGdataDiffUploadResponse
diffVersionResponse
$refGdataDiffVersionResponse
downloadParameters
$refGdataDownloadParameters
filename
typestring
hash
deprecatedTrue
typestring
hashVerified
typeboolean
inline
formatbyte
typestring
isPotentialRetry
typeboolean
length
formatint64
typestring
md5Hash
formatbyte
typestring
mediaId
formatbyte
typestring
objectId
$refGdataObjectId
path
typestring
referenceType
enum
  • PATH
  • BLOB_REF
  • INLINE
  • GET_MEDIA
  • COMPOSITE_MEDIA
  • BIGSTORE_REF
  • DIFF_VERSION_RESPONSE
  • DIFF_CHECKSUMS_RESPONSE
  • DIFF_DOWNLOAD_RESPONSE
  • DIFF_UPLOAD_REQUEST
  • DIFF_UPLOAD_RESPONSE
  • COSMO_BINARY_REFERENCE
  • ARBITRARY_BYTES
enumDescriptions
typestring
sha1Hash
formatbyte
typestring
sha256Hash
formatbyte
typestring
timestamp
formatuint64
typestring
token
typestring
typeobject
GdataObjectId
idGdataObjectId
properties
bucketName
typestring
generation
formatint64
typestring
objectName
typestring
typeobject
GoogleProtobufEmpty
descriptionA 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); }
idGoogleProtobufEmpty
properties
typeobject
GoogleSubscriptionsBackupV1ApiRequestHeader
idGoogleSubscriptionsBackupV1ApiRequestHeader
properties
clientInfo
$refGoogleSubscriptionsBackupV1ClientInfo
experimentOverrides
typestring
typeobject
GoogleSubscriptionsBackupV1Backup
idGoogleSubscriptionsBackupV1Backup
properties
activeTransactionId
typestring
backupId
typestring
sizeBytes
formatint64
typestring
updateTime
formatgoogle-datetime
typestring
typeobject
GoogleSubscriptionsBackupV1BackupConfig
idGoogleSubscriptionsBackupV1BackupConfig
properties
androidSdkVersion
formatint32
typeinteger
gmsCoreApkVersion
typestring
hasMmsBackupEnabledBefore
typeboolean
hasRequiredPhotosPermission
typeboolean
inMsaExperiment
typeboolean
isAndroidBackupEnabled
typeboolean
isAndroidBackupSupported
typeboolean
isDeviceEtu
typeboolean
isMmsBackupEnabled
typeboolean
isMmsBackupSupported
typeboolean
isPhotosBackupEnabled
typeboolean
isPhotosBackupSupported
typeboolean
isPhotosDefaultGallery
typeboolean
lastAppBackupCompletionTimestamp
formatgoogle-datetime
typestring
photosApkVersion
typestring
systemRestoreCompletionTimestamp
formatgoogle-datetime
typestring
wasMsaShown
typeboolean
typeobject
GoogleSubscriptionsBackupV1ClientInfo
idGoogleSubscriptionsBackupV1ClientInfo
properties
clientId
enum
  • CLIENT_ID_UNSPECIFIED
  • CLIENT_ID_G1_ANDROID_APP
  • CLIENT_ID_GMSCORE_BACKUP
  • CLIENT_ID_DRIVE_BACKUP
  • CLIENT_ID_MANUAL
  • CLIENT_ID_PROBER
  • CLIENT_ID_PIXELMIGRATE
enumDescriptions
typestring
version
typestring
typeobject
GoogleSubscriptionsBackupV1CommitTransactionRequest
idGoogleSubscriptionsBackupV1CommitTransactionRequest
properties
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
transactionId
typestring
typeobject
GoogleSubscriptionsBackupV1CommitTransactionResponse
idGoogleSubscriptionsBackupV1CommitTransactionResponse
properties
typeobject
GoogleSubscriptionsBackupV1CreateBackupRequest
idGoogleSubscriptionsBackupV1CreateBackupRequest
properties
androidId
formatint64
typestring
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
typeobject
GoogleSubscriptionsBackupV1DeleteBackupConfigRequest
idGoogleSubscriptionsBackupV1DeleteBackupConfigRequest
properties
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
typeobject
GoogleSubscriptionsBackupV1DeleteFilesRequest
idGoogleSubscriptionsBackupV1DeleteFilesRequest
properties
fileIds
items
typestring
typearray
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
transactionId
typestring
typeobject
GoogleSubscriptionsBackupV1File
idGoogleSubscriptionsBackupV1File
properties
blob
$refGdataMedia
fileId
typestring
mediaResponseInfo
$refApiservingMediaResponseInfo
readOnlyTrue
mimeType
typestring
sizeBytes
formatint64
typestring
updateTime
formatgoogle-datetime
typestring
typeobject
GoogleSubscriptionsBackupV1ListBackupsResponse
idGoogleSubscriptionsBackupV1ListBackupsResponse
properties
backups
additionalProperties
$refGoogleSubscriptionsBackupV1Backup
typeobject
nextPageToken
typestring
typeobject
GoogleSubscriptionsBackupV1ListFilesResponse
idGoogleSubscriptionsBackupV1ListFilesResponse
properties
files
items
$refGoogleSubscriptionsBackupV1File
typearray
nextPageToken
typestring
typeobject
GoogleSubscriptionsBackupV1StartTransactionRequest
idGoogleSubscriptionsBackupV1StartTransactionRequest
properties
maxTransactionSize
formatint64
typestring
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
transactionOptions
$refGoogleSubscriptionsBackupV1TransactionOptions
typeobject
GoogleSubscriptionsBackupV1Transaction
idGoogleSubscriptionsBackupV1Transaction
properties
id
typestring
transactionOptions
$refGoogleSubscriptionsBackupV1TransactionOptions
typeobject
GoogleSubscriptionsBackupV1TransactionOptions
idGoogleSubscriptionsBackupV1TransactionOptions
properties
mode
enum
  • TRANSACTION_MODE_UNSPECIFIED
  • READ_ONLY
  • READ_WRITE
enumDescriptions
typestring
typeobject
GoogleSubscriptionsBackupV1UpdateBackupConfigRequest
idGoogleSubscriptionsBackupV1UpdateBackupConfigRequest
properties
androidSdkVersion
formatint32
typeinteger
gmsCoreApkVersion
typestring
hasRequiredPhotosPermission
typeboolean
inMsaExperiment
typeboolean
isAndroidBackupEnabled
typeboolean
isAndroidBackupSupported
typeboolean
isDeviceEtu
typeboolean
isMmsBackupEnabled
typeboolean
isMmsBackupSupported
typeboolean
isPhotosBackupEnabled
typeboolean
isPhotosBackupSupported
typeboolean
isPhotosDefaultGallery
typeboolean
lastAppBackupCompletionTimestamp
formatgoogle-datetime
typestring
photosApkVersion
typestring
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
systemRestoreCompletionTimestamp
formatgoogle-datetime
typestring
wasMsaShown
typeboolean
typeobject
root['title']
new_valueMMS Backup Private API
old_valueGoogle One Backup Private API
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][0]
new_valueSuch requests signals the start of a request containing media upload. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.
old_value
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
iterable_item_added
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][1]Such requests signals that the upload has progressed and that the backend might want to access the media file specified in relevant fields in the resource. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][2]Such requests signals the end of a request containing media upload. END should be handled just like normal Insert/Upload requests, that is, they should process the request and return a complete resource in the response. Pointers to media data (a GFS path usually) appear in the relevant fields in the inserted/updated resource. See gdata.Media in data.proto.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][3]Such requests occur after an END and signal that the response has been sent back to the client. RESPONSE_SENT is only sent to the backend if it is configured to receive them. The response does not need to contain anything.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][4]Such requests indicate that an error occurred while processing the request. ERROR is only sent to the backend if it is configured to receive them. It is not guaranteed that all errors will result in this notification to the backend, even if the backend requests them. Since these requests are just for informational purposes, the response does not need to contain anything.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
sandbox/staging-googleonebackup-pa-v1
dictionary_item_added
  • root['resources']['backups']['methods']['commitTransaction']['parameters']['backupId']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['delete']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['deleteBackupConfig']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['get']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['get']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['androidId']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['list']['parameters']['pageSize']['description']
  • root['resources']['backups']['methods']['list']['parameters']['pageToken']['description']
  • root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['methods']['list']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['methods']['startTransaction']['parameters']['backupId']['description']
  • root['resources']['backups']['methods']['updateConfig']['parameters']['androidId']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['fileId']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['transactionId']['description']
  • root['resources']['backups']['resources']['files']['methods']['deleteFiles']['parameters']['backupId']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['backupId']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['pageSize']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['pageToken']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['backups']['resources']['files']['methods']['list']['parameters']['transactionId']['description']
  • root['resources']['media']['methods']['download']['parameters']['fileId']['description']
  • root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['media']['methods']['download']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['media']['methods']['download']['parameters']['transactionId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['backupId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['fileName']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.currentBytes']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.customData']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.diffObjectVersion']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.finalStatus']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.requestId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.requestReceivedParamsServingInfo']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.totalBytes']['description']
  • root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.totalBytesIsEstimated']['description']
  • root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['description']
  • root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.version']['description']
  • root['resources']['media']['methods']['upload']['parameters']['requestHeader.experimentOverrides']['description']
  • root['resources']['media']['methods']['upload']['parameters']['transactionId']['description']
values_changed
root['baseUrl']
new_valuehttps://mmsbackup.pa.googleapis.com/
old_valuehttps://staging-googleonebackup-pa.sandbox.googleapis.com/
root['canonicalName']
new_valueMMS Backup Service
old_valueOne Backup
root['description']
new_valuemmsbackup.pa.googleapis.com API.
old_valueA boq-generated 1P API. For more information, see https://boq.corp.google.com/google3/java/com/google/subscriptions/backup/service
root['documentationLink']
new_valuehttps://support.google.com/android/answer/2819582
old_valuehttps://boq.corp.google.com/google3/java/com/google/subscriptions/backup/service
root['id']
new_valuepa_mmsbackup:v1
old_valuegoogleonebackup_pa:v1
root['mtlsRootUrl']
new_valuehttps://mmsbackup.pa.mtls.googleapis.com/
old_valuehttps://staging-googleonebackup-pa.mtls.sandbox.googleapis.com/
root['name']
new_valuepa_mmsbackup
old_valuegoogleonebackup_pa
root['resources']['backups']['methods']['commitTransaction']['description']
new_valueCommits the current active read-write transaction. All file changes are committed atomically. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if either backup or transaction doesn't exist. Already committed transactions are considered as non-existent. Returns a RESOURCE_EXHAUSTED canonical code if user doesn't have sufficient cloud storage capacity. Extract CommitTransactionResourceExhaustedFailureReason from RPC status to learn the exact reason. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['commitTransaction']['id']
new_valuepa_mmsbackup.backups.commitTransaction
old_valuegoogleonebackup_pa.backups.commitTransaction
root['resources']['backups']['methods']['commitTransaction']['request']['$ref']
new_valueCommitTransactionRequest
old_valueGoogleSubscriptionsBackupV1CommitTransactionRequest
root['resources']['backups']['methods']['commitTransaction']['response']['$ref']
new_valueCommitTransactionResponse
old_valueGoogleSubscriptionsBackupV1CommitTransactionResponse
root['resources']['backups']['methods']['create']['description']
new_valueCreates a new backup. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns an ALREADY_EXISTS canonical code if a backup for the provided GServices Android ID already exists. Returns a FAILED_PRECONDITION canonical code if GoogleOne backup already exist but it's an orphan - it's not present in Android Backup storage but already exists in Moscato. This can happen if backup deletion partially succeeded - backup was removed from Android Backup storage but deletion from Moscato failed. FAILED_PRECONDITION is also thrown if device is not initialized in Android Backup Storage, which means that Android backup flow hasn't yet started. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['create']['id']
new_valuepa_mmsbackup.backups.create
old_valuegoogleonebackup_pa.backups.create
root['resources']['backups']['methods']['create']['request']['$ref']
new_valueCreateBackupRequest
old_valueGoogleSubscriptionsBackupV1CreateBackupRequest
root['resources']['backups']['methods']['create']['response']['$ref']
new_valueBackup
old_valueGoogleSubscriptionsBackupV1Backup
root['resources']['backups']['methods']['delete']['description']
new_valueDeletes the backup and all of its files. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a NOT_FOUND canonical code if the backup doesn't exist. Returns a FAILED_PRECONDITION if device is not initialized in Android Backup Storage, which means that Android backup flow hasn't yet started. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['delete']['id']
new_valuepa_mmsbackup.backups.delete
old_valuegoogleonebackup_pa.backups.delete
root['resources']['backups']['methods']['delete']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['methods']['deleteBackupConfig']['description']
new_valueDeletes the backup configuration. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a NOT_FOUND canonical code if the backup configuration doesn't exist. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['deleteBackupConfig']['id']
new_valuepa_mmsbackup.backups.deleteBackupConfig
old_valuegoogleonebackup_pa.backups.deleteBackupConfig
root['resources']['backups']['methods']['deleteBackupConfig']['request']['$ref']
new_valueDeleteBackupConfigRequest
old_valueGoogleSubscriptionsBackupV1DeleteBackupConfigRequest
root['resources']['backups']['methods']['deleteBackupConfig']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['methods']['get']['description']
new_valueGets the backup for the provided GServices Android ID. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if the backups doesn't exist. Returns a FAILED_PRECONDITION canonical code if the requested backup is an orphan - it's not present in Android Backup storage but still exists in Moscato. This can happen if backup deletion partially succeeeded - backup was removed from Android Backup storage but deletion from Moscato failed. FAILED_PRECONDITION is also thrown if device is not initialized in Android Backup Storage, which means that Android backup flow hasn't yet started. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['get']['id']
new_valuepa_mmsbackup.backups.get
old_valuegoogleonebackup_pa.backups.get
root['resources']['backups']['methods']['get']['response']['$ref']
new_valueBackup
old_valueGoogleSubscriptionsBackupV1Backup
root['resources']['backups']['methods']['getConfig']['description']
new_valueReturns backup configuration for the pair of Gaia ID (extracted from EUC) and GServices Android ID from the request. Returns the default configuration (see BackupConfiguration proto for details) if there is nothing in Spanner. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['getConfig']['id']
new_valuepa_mmsbackup.backups.getConfig
old_valuegoogleonebackup_pa.backups.getConfig
root['resources']['backups']['methods']['getConfig']['response']['$ref']
new_valueBackupConfig
old_valueGoogleSubscriptionsBackupV1BackupConfig
root['resources']['backups']['methods']['list']['description']
new_valueGets a list of backups for the current user. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['list']['id']
new_valuepa_mmsbackup.backups.list
old_valuegoogleonebackup_pa.backups.list
root['resources']['backups']['methods']['list']['response']['$ref']
new_valueListBackupsResponse
old_valueGoogleSubscriptionsBackupV1ListBackupsResponse
root['resources']['backups']['methods']['startTransaction']['description']
new_valueStarts a long-running transaction. The timeout for read-only transactions is 48 hours, for read-write transactions - 2 weeks. The client is allowed to have multiple read-only transactions at the same time. The client is not allowed to have multiple read-write transactions at the same time. An attempt to create a read-write transaction would abort existing read-write transaction if any. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if the backup doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['startTransaction']['id']
new_valuepa_mmsbackup.backups.startTransaction
old_valuegoogleonebackup_pa.backups.startTransaction
root['resources']['backups']['methods']['startTransaction']['request']['$ref']
new_valueStartTransactionRequest
old_valueGoogleSubscriptionsBackupV1StartTransactionRequest
root['resources']['backups']['methods']['startTransaction']['response']['$ref']
new_valueTransaction
old_valueGoogleSubscriptionsBackupV1Transaction
root['resources']['backups']['methods']['updateConfig']['description']
new_valueCreates/updates backup configuration for the pair of Gaia ID (extracted from EUC) and GServices Android ID from the request. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['methods']['updateConfig']['id']
new_valuepa_mmsbackup.backups.updateConfig
old_valuegoogleonebackup_pa.backups.updateConfig
root['resources']['backups']['methods']['updateConfig']['request']['$ref']
new_valueUpdateBackupConfigRequest
old_valueGoogleSubscriptionsBackupV1UpdateBackupConfigRequest
root['resources']['backups']['methods']['updateConfig']['response']['$ref']
new_valueBackupConfig
old_valueGoogleSubscriptionsBackupV1BackupConfig
root['resources']['backups']['resources']['files']['methods']['delete']['description']
new_valueStages the file to be deleted once the current transaction is committed. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a NOT_FOUND canonical code if the backup or the file doesn't exist. Returns a FAILED_PRECONDITION code if transaction doesn't exist. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['resources']['files']['methods']['delete']['id']
new_valuepa_mmsbackup.backups.files.delete
old_valuegoogleonebackup_pa.backups.files.delete
root['resources']['backups']['resources']['files']['methods']['delete']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['description']
new_valueStages a group of files to be deleted once the current transaction is committed. Does nothing if file(s) are missing. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a FAILED_PRECONDITION canonical code if transaction doesn't exist or if read-only transaction was provided. Returns a NOT_FOUND canonical code if backup doesn't exist. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['id']
new_valuepa_mmsbackup.backups.files.deleteFiles
old_valuegoogleonebackup_pa.backups.files.deleteFiles
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['request']['$ref']
new_valueDeleteFilesRequest
old_valueGoogleSubscriptionsBackupV1DeleteFilesRequest
root['resources']['backups']['resources']['files']['methods']['deleteFiles']['response']['$ref']
new_valueEmpty
old_valueGoogleProtobufEmpty
root['resources']['backups']['resources']['files']['methods']['list']['description']
new_valueLists all the files in a given backup. Returns an empty list if the backup is empty. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if either the backup or the transaction doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['backups']['resources']['files']['methods']['list']['id']
new_valuepa_mmsbackup.backups.files.list
old_valuegoogleonebackup_pa.backups.files.list
root['resources']['backups']['resources']['files']['methods']['list']['response']['$ref']
new_valueListFilesResponse
old_valueGoogleSubscriptionsBackupV1ListFilesResponse
root['resources']['media']['methods']['download']['description']
new_valueExports the file. This will send the actual file bytes to the client. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a NOT_FOUND canonical code if the requested file doesn't exist. Returns a FAILED_PRECONDITION canonical code if the provided transaction or the backup doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['media']['methods']['download']['id']
new_valuepa_mmsbackup.media.download
old_valuegoogleonebackup_pa.media.download
root['resources']['media']['methods']['download']['response']['$ref']
new_valueFile
old_valueGoogleSubscriptionsBackupV1File
root['resources']['media']['methods']['upload']['description']
new_valueUpdates the file and returns its updated metadata. If the file doesn't exist, then this will create a new file. Returns a INVALID_ARGUMENT canonical code if the request is malformed. Returns a FAILED_PRECONDITION canonical code if transaction doesn't exist. Returns a NOT_FOUND canonical code if the backup doesn't exist. Returns a PERMISSION_DENIED canonical error code if the user is ineligible to call this API, e.g. is a Dasher, Unicorn, Griffin account, or if the end user credentials are absent. Returns a RESOURCE_EXHAUSTED canonical code if user device(s) has reached the max allowed QPS per user or if all devices have reached the max allowed QPS per project.
old_value
root['resources']['media']['methods']['upload']['id']
new_valuepa_mmsbackup.media.upload
old_valuegoogleonebackup_pa.media.upload
root['resources']['media']['methods']['upload']['request']['$ref']
new_valueFile
old_valueGoogleSubscriptionsBackupV1File
root['resources']['media']['methods']['upload']['response']['$ref']
new_valueFile
old_valueGoogleSubscriptionsBackupV1File
root['revision']
new_value20250517
old_value20250412
root['rootUrl']
new_valuehttps://mmsbackup.pa.googleapis.com/
old_valuehttps://staging-googleonebackup-pa.sandbox.googleapis.com/
root['schemas']
new_value
ApiRequestHeader
descriptionHeader for requests sent to Google One Backup API.
idApiRequestHeader
properties
clientInfo
$refClientInfo
descriptionOptional info about the client calling the API.
experimentOverrides
descriptionOptional experiment overrides. This is a comma-separate list of experiment names. A minus sign can be used to disable an experiment. Example usage: "ExperimentOne": Enables ExperimentOne. "ExperimentOne,-ExperimentTwo": Enables ExperimentOne and disables ExperimentTwo.
typestring
typeobject
Backup
descriptionA backup belonging to a client.
idBackup
properties
activeTransactionId
descriptionThe active read-write transaction for this backup if there is an uncommitted write transaction. Output only.
typestring
backupId
descriptionRequired. The relative resource name of the backup, e.g. "backups/1337". Output only.
typestring
sizeBytes
descriptionAggregate size of all files contained in this backup, in bytes. Output only.
formatint64
typestring
updateTime
descriptionThe time the backup was last updated. Output only.
formatgoogle-datetime
typestring
typeobject
BackupConfig
idBackupConfig
properties
androidSdkVersion
descriptionOptional. If set, specifies the value of the sdk version of android OS.
formatint32
typeinteger
gmsCoreApkVersion
descriptionOptional. If set, specifies the value of the apk version of gms core.
typestring
hasMmsBackupEnabledBefore
descriptionIs set as long as a user has mms backup turned on in the history.
typeboolean
hasRequiredPhotosPermission
descriptionOptional. If set, specifies whether a user has the required photos app permission to send photos_backup_onboarding notifications.
typeboolean
inMsaExperiment
descriptionOptional. If set, specifies whether the user's device is in the experiment group to roll out MMS B&R for everyone using the MSA.
typeboolean
isAndroidBackupEnabled
typeboolean
isAndroidBackupSupported
descriptionIs set if the device satisfies the pre-requisites for Android backup to be performed.
typeboolean
isDeviceEtu
descriptionOptional. If set, specifies the value of whether EBNR is targeted on this device.
typeboolean
isMmsBackupEnabled
descriptionIs always "false" by default or if user is either a Dasher/Unicorn/Griffin user.
typeboolean
isMmsBackupSupported
descriptionIs set if the device satisfies the pre-requisites for Mms backup to be performed.
typeboolean
isPhotosBackupEnabled
typeboolean
isPhotosBackupSupported
descriptionIs set if the device satisfies the pre-requisites for Photos backup to be performed.
typeboolean
isPhotosDefaultGallery
descriptionOptional. If set, specifies the value of whether Photos is the default gallery on this device.
typeboolean
lastAppBackupCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful App Backup action.
formatgoogle-datetime
typestring
photosApkVersion
descriptionOptional. If set, specifies the value of the apk version of photos app.
typestring
systemRestoreCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful System Restore action.
formatgoogle-datetime
typestring
wasMsaShown
descriptionOptional. If set, specifies whether the MSA for MMS enablement was shown previously on this device.
typeboolean
typeobject
Blobstore2Info
descriptionInformation to read/write to blobstore2.
idBlobstore2Info
properties
blobGeneration
descriptionThe blob generation id.
formatint64
typestring
blobId
descriptionThe blob id, e.g., /blobstore/prod/playground/scotty
typestring
downloadReadHandle
descriptionRead handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
formatbyte
typestring
readToken
descriptionThe blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
typestring
uploadMetadataContainer
descriptionMetadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
formatbyte
typestring
typeobject
ClientInfo
descriptionInformation about a particular client calling the API.
idClientInfo
properties
clientId
descriptionRequired client ID of the caller. Behavior of certain RPCs may differ slightly by client ID, according to the client's needs.
enum
  • CLIENT_ID_UNSPECIFIED
  • CLIENT_ID_G1_ANDROID_APP
  • CLIENT_ID_GMSCORE_BACKUP
  • CLIENT_ID_DRIVE_BACKUP
  • CLIENT_ID_MANUAL
  • CLIENT_ID_PROBER
  • CLIENT_ID_PIXELMIGRATE
enumDescriptions
  • Default ID used when no other particular ID applies, or the client has not yet configured a new client ID.
  • Client ID for the G1 Android app.
  • Client ID for the GmsCore backup modules.
  • Client ID for the Drive backup modules.
  • Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
  • Client ID used by service probers.
  • Client ID for the PixelMigrate/Restore Android app.
typestring
version
descriptionRequired. Version of the client. This field is optional for CLIENT_ID_MANUAL client ID.
typestring
typeobject
CommitTransactionRequest
descriptionA request to finish a read-write transaction, committing all file changes atomically.
idCommitTransactionRequest
properties
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
transactionId
descriptionRequired. The id of the transaction to commit.
typestring
typeobject
CommitTransactionResponse
descriptionA transaction commit response.
idCommitTransactionResponse
properties
typeobject
CompositeMedia
descriptionA sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
idCompositeMedia
properties
blobRef
deprecatedTrue
descriptionBlobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
formatbyte
typestring
blobstore2Info
$refBlobstore2Info
descriptionBlobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
cosmoBinaryReference
descriptionA binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
formatbyte
typestring
crc32cHash
descriptioncrc32.c hash for the payload.
formatuint32
typeinteger
inline
descriptionMedia data, set if reference_type is INLINE
formatbyte
typestring
length
descriptionSize of the data, in bytes
formatint64
typestring
md5Hash
descriptionMD5 hash for the payload.
formatbyte
typestring
objectId
$refObjectId
descriptionReference to a TI Blob, set if reference_type is BIGSTORE_REF.
path
descriptionPath to the data, set if reference_type is PATH
typestring
referenceType
descriptionDescribes what the field reference contains.
enum
  • PATH
  • BLOB_REF
  • INLINE
  • BIGSTORE_REF
  • COSMO_BINARY_REFERENCE
enumDescriptions
  • Reference contains a GFS path or a local path.
  • Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.
  • Data is included into this proto buffer
  • Reference points to a bigstore object
  • Indicates the data is stored in cosmo_binary_reference.
typestring
sha1Hash
descriptionSHA-1 hash for the payload.
formatbyte
typestring
typeobject
ContentTypeInfo
descriptionDetailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.
idContentTypeInfo
properties
bestGuess
descriptionScotty's best guess of what the content type of the file is.
typestring
fromBytes
descriptionThe content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
typestring
fromFileName
descriptionThe content type of the file derived from the file extension of the original file name used by the client.
typestring
fromHeader
descriptionThe content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
typestring
fromUrlPath
descriptionThe content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
typestring
typeobject
CreateBackupRequest
idCreateBackupRequest
properties
androidId
descriptionRequired. A value that uniquely identifies user's device to Google's servers.
formatint64
typestring
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
typeobject
DeleteBackupConfigRequest
descriptionA request to delete a backup config.
idDeleteBackupConfigRequest
properties
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
typeobject
DeleteFilesRequest
descriptionRequest to delete a group of files.
idDeleteFilesRequest
properties
fileIds
descriptionThe file ids relative to backup_id, e.g. "data/selfie.jpg" or "foo.txt"
items
typestring
typearray
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
transactionId
descriptionRequired. The transaction to execute the delete in.
typestring
typeobject
DiffChecksumsResponse
descriptionBackend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffChecksumsResponse
properties
checksumsLocation
$refCompositeMedia
descriptionExactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
chunkSizeBytes
descriptionThe chunk size of checksums. Must be a multiple of 256KB.
formatint64
typestring
objectLocation
$refCompositeMedia
descriptionIf set, calculate the checksums based on the contents and return them to the caller.
objectSizeBytes
descriptionThe total size of the server object.
formatint64
typestring
objectVersion
descriptionThe object version of the object the checksums are being returned for.
typestring
typeobject
DiffDownloadResponse
descriptionBackend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffDownloadResponse
properties
objectLocation
$refCompositeMedia
descriptionThe original object location.
typeobject
DiffUploadRequest
descriptionA Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffUploadRequest
properties
checksumsInfo
$refCompositeMedia
descriptionThe location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
objectInfo
$refCompositeMedia
descriptionThe location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
objectVersion
descriptionThe object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
typestring
typeobject
DiffUploadResponse
descriptionBackend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffUploadResponse
properties
objectVersion
descriptionThe object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
typestring
originalObject
$refCompositeMedia
descriptionThe location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
typeobject
DiffVersionResponse
descriptionBackend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
idDiffVersionResponse
properties
objectSizeBytes
descriptionThe total size of the server object.
formatint64
typestring
objectVersion
descriptionThe version of the object stored at the server.
typestring
typeobject
DownloadParameters
descriptionParameters specific to media downloads.
idDownloadParameters
properties
allowGzipCompression
descriptionA boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
typeboolean
ignoreRange
descriptionDetermining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
typeboolean
typeobject
Empty
descriptionA 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); }
idEmpty
properties
typeobject
File
descriptionA file belonging to a backup
idFile
properties
blob
$refMedia
descriptionThe blob supplied to/from Scotty.
fileId
descriptionThe relative resource name of the backup, e.g: "backups/31337/files/selfie.jpg"
typestring
mediaResponseInfo
$refMediaResponseInfo
descriptionOutput only. Media response details.
readOnlyTrue
mimeType
descriptionThe mime type of the file contents. May not be needed.
typestring
sizeBytes
descriptionThe size of the file in bytes.
formatint64
typestring
updateTime
descriptionThe time the backup was last updated.
formatgoogle-datetime
typestring
typeobject
ListBackupsResponse
descriptionResponse including a list of G1 backups
idListBackupsResponse
properties
backups
additionalProperties
$refBackup
descriptionA list of backups, mapping from androidId to backup entity.
typeobject
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
typeobject
ListFilesResponse
idListFilesResponse
properties
files
descriptionAll files associated with the backup.
items
$refFile
typearray
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
typeobject
Media
descriptionA reference to data stored on the filesystem, on GFS or in blobstore.
idMedia
properties
algorithm
deprecatedTrue
descriptionDeprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
typestring
bigstoreObjectRef
deprecatedTrue
descriptionUse object_id instead.
formatbyte
typestring
blobRef
deprecatedTrue
descriptionBlobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
formatbyte
typestring
blobstore2Info
$refBlobstore2Info
descriptionBlobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
compositeMedia
descriptionA composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.
items
$refCompositeMedia
typearray
contentType
descriptionMIME type of the data
typestring
contentTypeInfo
$refContentTypeInfo
descriptionExtended content type information provided for Scotty uploads.
cosmoBinaryReference
descriptionA binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
formatbyte
typestring
crc32cHash
descriptionFor Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
formatuint32
typeinteger
diffChecksumsResponse
$refDiffChecksumsResponse
descriptionSet if reference_type is DIFF_CHECKSUMS_RESPONSE.
diffDownloadResponse
$refDiffDownloadResponse
descriptionSet if reference_type is DIFF_DOWNLOAD_RESPONSE.
diffUploadRequest
$refDiffUploadRequest
descriptionSet if reference_type is DIFF_UPLOAD_REQUEST.
diffUploadResponse
$refDiffUploadResponse
descriptionSet if reference_type is DIFF_UPLOAD_RESPONSE.
diffVersionResponse
$refDiffVersionResponse
descriptionSet if reference_type is DIFF_VERSION_RESPONSE.
downloadParameters
$refDownloadParameters
descriptionParameters for a media download.
filename
descriptionOriginal file name
typestring
hash
deprecatedTrue
descriptionDeprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.
typestring
hashVerified
descriptionFor Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
typeboolean
inline
descriptionMedia data, set if reference_type is INLINE
formatbyte
typestring
isPotentialRetry
description|is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.
typeboolean
length
descriptionSize of the data, in bytes
formatint64
typestring
md5Hash
descriptionScotty-provided MD5 hash for an upload.
formatbyte
typestring
mediaId
descriptionMedia id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
formatbyte
typestring
objectId
$refObjectId
descriptionReference to a TI Blob, set if reference_type is BIGSTORE_REF.
path
descriptionPath to the data, set if reference_type is PATH
typestring
referenceType
descriptionDescribes what the field reference contains.
enum
  • PATH
  • BLOB_REF
  • INLINE
  • GET_MEDIA
  • COMPOSITE_MEDIA
  • BIGSTORE_REF
  • DIFF_VERSION_RESPONSE
  • DIFF_CHECKSUMS_RESPONSE
  • DIFF_DOWNLOAD_RESPONSE
  • DIFF_UPLOAD_REQUEST
  • DIFF_UPLOAD_RESPONSE
  • COSMO_BINARY_REFERENCE
  • ARBITRARY_BYTES
enumDescriptions
  • Reference contains a GFS path or a local path.
  • Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.
  • Data is included into this proto buffer
  • Data should be accessed from the current service using the operation GetMedia.
  • The content for this media object is stored across multiple partial media objects under the composite_media field.
  • Reference points to a bigstore object
  • Indicates the data is stored in diff_version_response.
  • Indicates the data is stored in diff_checksums_response.
  • Indicates the data is stored in diff_download_response.
  • Indicates the data is stored in diff_upload_request.
  • Indicates the data is stored in diff_upload_response.
  • Indicates the data is stored in cosmo_binary_reference.
  • Informs Scotty to generate a response payload with the size specified in the length field. The contents of the payload are generated by Scotty and are undefined. This is useful for testing download speeds between the user and Scotty without involving a real payload source. Note: range is not supported when using arbitrary_bytes.
typestring
sha1Hash
descriptionScotty-provided SHA1 hash for an upload.
formatbyte
typestring
sha256Hash
descriptionScotty-provided SHA256 hash for an upload.
formatbyte
typestring
timestamp
descriptionTime at which the media data was last updated, in milliseconds since UNIX epoch
formatuint64
typestring
token
descriptionA unique fingerprint/version id for the media data
typestring
typeobject
MediaResponseInfo
descriptionThis message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse { optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 }
idMediaResponseInfo
properties
customData
descriptionData to copy from backend response to the next backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.
typestring
dataStorageTransform
descriptionSpecifies any transformation to be applied to data before persisting it or retrieving from storage. E.g., encryption options for blobstore2. This should be of the form uploader_service.DataStorageTransform.
formatbyte
typestring
destinationBlobMintIndex
descriptionFor the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when writing the resulting blob. This field is optional. It's not required ever, even if `original_object_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.
formatint32
typeinteger
dynamicDropTarget
descriptionSpecifies the Scotty Drop Target to use for uploads. If present in a media response, Scotty does not upload to a standard drop zone. Instead, Scotty saves the upload directly to the location specified in this drop target. Unlike drop zones, the drop target is the final storage location for an upload. So, the agent does not need to clone the blob at the end of the upload. The agent is responsible for garbage collecting any orphaned blobs that may occur due to aborted uploads. For more information, see the drop target design doc here: http://goto/ScottyDropTarget This field will be preferred to dynamicDropzone. If provided, the identified field in the response must be of the type uploader.agent.DropTarget.
formatbyte
typestring
dynamicDropzone
descriptionSpecifies the Scotty dropzone to use for uploads.
typestring
mediaForDiff
$refMedia
descriptionDiff Updates must respond to a START notification with this Media proto to tell Scotty to decode the diff encoded payload and apply the diff against this field. If the request was diff encoded, but this field is not set, Scotty will treat the encoding as identity. This is corresponding to Apiary's DiffUploadResponse.original_object (//depot/google3/gdata/rosy/proto/data.proto?l=413). See go/esf-scotty-diff-upload for more information.
originalObjectBlobMintIndex
descriptionFor the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when reading the original blob. This field is optional. It's not required ever, even if `destination_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.
formatint32
typeinteger
requestClass
descriptionRequest class to use for all Blobstore operations for this request.
enum
  • UNKNOWN_REQUEST_CLASS
  • LATENCY_SENSITIVE
  • PRODUCTION_BATCH
  • BEST_EFFORT
enumDescriptions
  • Unpopulated request_class in log files will be taken as 0 in dremel query. GoogleSQL will try to cast it to enum by default. An unused 0 value is added to avoid GoogleSQL casting error. Please refer to b/69677280.
  • A latency-sensitive request.
  • A request generated by a batch process.
  • A best-effort request.
typestring
scottyAgentUserId
descriptionRequester ID passed along to be recorded in the Scotty logs
formatint64
typestring
scottyCustomerLog
descriptionCustomer-specific data to be recorded in the Scotty logs type is logs_proto_scotty.CustomerLog
formatbyte
typestring
trafficClassField
descriptionSpecifies the TrafficClass that Scotty should use for any RPCs to fetch the response bytes. Will override the traffic class GTOS of the incoming http request. This is a temporary field to facilitate whitelisting and experimentation by the bigstore agent only. For instance, this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.
enum
  • BE1
  • AF1
  • AF2
  • AF3
  • AF4
  • NC1
  • NC0
  • BE0
  • LLQ
  • LLQ1
  • LLQ2
  • LLQ3
enumDescriptions
  • Application-selectable traffic classes Best effort
  • Assured forwarding priority 1
  • Assured forwarding priority 2
  • Assured forwarding priority 3
  • Assured forwarding priority 4
  • Network control
  • Network control
  • Best effort at high packet loss
  • Low-latency queue (LLQ) best effort (go/llq)
  • LLQ assured forwarding priority 1 (go/llq2)
  • LLQ assured forwarding priority 2 (go/llq2)
  • LLQ assured forwarding priority 3 (go/llq3)
typestring
verifyHashFromHeader
descriptionTells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-Hash header.
typeboolean
typeobject
ObjectId
descriptionThis is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.
idObjectId
properties
bucketName
descriptionThe name of the bucket to which this object belongs.
typestring
generation
descriptionGeneration of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
formatint64
typestring
objectName
descriptionThe name of the object.
typestring
typeobject
StartTransactionRequest
descriptionA request to start a new transaction. Both read-write and read-only transactions are supported. Read-write transactions are used to group write requests along with the ability to read uncommitted changes. Read-only transactions present a consistent view of the backup across multiple read requests.
idStartTransactionRequest
properties
maxTransactionSize
descriptionRequired for READ_WRITE transaction. Works as a two-way contract between client and server to prevent cloud abuse. When starting a new read-write transaction server ensures the user has sufficient cloud quota and substracts file size from the remaining transaction's quota on each file upload. File deletions do not count against transaction's quota because the server doesn't know the size of a deleted file. Server starts blocking file upserts if client goes beyond the transaction's limit.
formatint64
typestring
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
transactionOptions
$refTransactionOptions
descriptionRequired. Instructs the backend how to create a transaction.
typeobject
Transaction
descriptionA read or write transaction created with a call to StartTransaction.
idTransaction
properties
id
descriptionThe unique identifier for the transaction.
typestring
transactionOptions
$refTransactionOptions
descriptionTransaction options.
typeobject
TransactionOptions
descriptionOptions that can be specified while creating a transaction.
idTransactionOptions
properties
mode
descriptionThe mode of the transaction to be created.
enum
  • TRANSACTION_MODE_UNSPECIFIED
  • READ_ONLY
  • READ_WRITE
enumDescriptions
  • For catching unset values.
  • A transaction that only works for list and get operations.
  • A transaction that also works for update and delete operations.
typestring
typeobject
UpdateBackupConfigRequest
idUpdateBackupConfigRequest
properties
androidSdkVersion
descriptionOptional. If set, specifies the value of the sdk version of android OS.
formatint32
typeinteger
gmsCoreApkVersion
descriptionOptional. If set, specifies the value of the apk version of gms core.
typestring
hasRequiredPhotosPermission
descriptionOptional. If set, specifies whether the user grant photos app with the required permission.
typeboolean
inMsaExperiment
descriptionOptional. If set, specifies whether the user's device is in the experiment group to roll out MMS B&R for everyone using the MSA.
typeboolean
isAndroidBackupEnabled
descriptionOptional. If set, specifies the value of whether Android backup is enabled that should be updated.
typeboolean
isAndroidBackupSupported
descriptionOptional. If set, specifies the value of whether Android backup is supported on this device.
typeboolean
isDeviceEtu
descriptionOptional. If set, specifies the value of whether EBNR is targeted on this device.
typeboolean
isMmsBackupEnabled
descriptionOptional. If set, specifies the value of whether MMS backup is enabled that should be updated.
typeboolean
isMmsBackupSupported
descriptionOptional. If set, specifies the value of whether MMS backup is supported on this device.
typeboolean
isPhotosBackupEnabled
descriptionOptional. If set, specifies the value of whether Photos backup is enabled that should be updated.
typeboolean
isPhotosBackupSupported
descriptionOptional. If set, specifies the value of whether Photos backup is supported on this device.
typeboolean
isPhotosDefaultGallery
descriptionOptional. If set, specifies the value of whether Photos is the default gallery on this device.
typeboolean
lastAppBackupCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful App Backup action.
formatgoogle-datetime
typestring
photosApkVersion
descriptionOptional. If set, specifies the value of the apk version of photos app.
typestring
requestHeader
$refApiRequestHeader
descriptionRequired. Request header.
systemRestoreCompletionTimestamp
descriptionOptional. If set, specifies the timestamp of last successful System Restore action.
formatgoogle-datetime
typestring
wasMsaShown
descriptionOptional. If set, specifies whether the MSA for MMS enablement was shown previously on this device.
typeboolean
typeobject
old_value
ApiservingMediaResponseInfo
idApiservingMediaResponseInfo
properties
customData
typestring
dataStorageTransform
formatbyte
typestring
destinationBlobMintIndex
formatint32
typeinteger
dynamicDropTarget
formatbyte
typestring
dynamicDropzone
typestring
mediaForDiff
$refGdataMedia
originalObjectBlobMintIndex
formatint32
typeinteger
requestClass
enum
  • UNKNOWN_REQUEST_CLASS
  • LATENCY_SENSITIVE
  • PRODUCTION_BATCH
  • BEST_EFFORT
enumDescriptions
typestring
scottyAgentUserId
formatint64
typestring
scottyCustomerLog
formatbyte
typestring
trafficClassField
enum
  • BE1
  • AF1
  • AF2
  • AF3
  • AF4
  • NC1
  • NC0
  • BE0
  • LLQ
  • LLQ1
  • LLQ2
  • LLQ3
enumDescriptions
typestring
verifyHashFromHeader
typeboolean
typeobject
GdataBlobstore2Info
idGdataBlobstore2Info
properties
blobGeneration
formatint64
typestring
blobId
typestring
downloadReadHandle
formatbyte
typestring
readToken
typestring
uploadMetadataContainer
formatbyte
typestring
typeobject
GdataCompositeMedia
idGdataCompositeMedia
properties
blobRef
deprecatedTrue
formatbyte
typestring
blobstore2Info
$refGdataBlobstore2Info
cosmoBinaryReference
formatbyte
typestring
crc32cHash
formatuint32
typeinteger
inline
formatbyte
typestring
length
formatint64
typestring
md5Hash
formatbyte
typestring
objectId
$refGdataObjectId
path
typestring
referenceType
enum
  • PATH
  • BLOB_REF
  • INLINE
  • BIGSTORE_REF
  • COSMO_BINARY_REFERENCE
enumDescriptions
typestring
sha1Hash
formatbyte
typestring
typeobject
GdataContentTypeInfo
idGdataContentTypeInfo
properties
bestGuess
typestring
fromBytes
typestring
fromFileName
typestring
fromHeader
typestring
fromUrlPath
typestring
typeobject
GdataDiffChecksumsResponse
idGdataDiffChecksumsResponse
properties
checksumsLocation
$refGdataCompositeMedia
chunkSizeBytes
formatint64
typestring
objectLocation
$refGdataCompositeMedia
objectSizeBytes
formatint64
typestring
objectVersion
typestring
typeobject
GdataDiffDownloadResponse
idGdataDiffDownloadResponse
properties
objectLocation
$refGdataCompositeMedia
typeobject
GdataDiffUploadRequest
idGdataDiffUploadRequest
properties
checksumsInfo
$refGdataCompositeMedia
objectInfo
$refGdataCompositeMedia
objectVersion
typestring
typeobject
GdataDiffUploadResponse
idGdataDiffUploadResponse
properties
objectVersion
typestring
originalObject
$refGdataCompositeMedia
typeobject
GdataDiffVersionResponse
idGdataDiffVersionResponse
properties
objectSizeBytes
formatint64
typestring
objectVersion
typestring
typeobject
GdataDownloadParameters
idGdataDownloadParameters
properties
allowGzipCompression
typeboolean
ignoreRange
typeboolean
typeobject
GdataMedia
idGdataMedia
properties
algorithm
deprecatedTrue
typestring
bigstoreObjectRef
deprecatedTrue
formatbyte
typestring
blobRef
deprecatedTrue
formatbyte
typestring
blobstore2Info
$refGdataBlobstore2Info
compositeMedia
items
$refGdataCompositeMedia
typearray
contentType
typestring
contentTypeInfo
$refGdataContentTypeInfo
cosmoBinaryReference
formatbyte
typestring
crc32cHash
formatuint32
typeinteger
diffChecksumsResponse
$refGdataDiffChecksumsResponse
diffDownloadResponse
$refGdataDiffDownloadResponse
diffUploadRequest
$refGdataDiffUploadRequest
diffUploadResponse
$refGdataDiffUploadResponse
diffVersionResponse
$refGdataDiffVersionResponse
downloadParameters
$refGdataDownloadParameters
filename
typestring
hash
deprecatedTrue
typestring
hashVerified
typeboolean
inline
formatbyte
typestring
isPotentialRetry
typeboolean
length
formatint64
typestring
md5Hash
formatbyte
typestring
mediaId
formatbyte
typestring
objectId
$refGdataObjectId
path
typestring
referenceType
enum
  • PATH
  • BLOB_REF
  • INLINE
  • GET_MEDIA
  • COMPOSITE_MEDIA
  • BIGSTORE_REF
  • DIFF_VERSION_RESPONSE
  • DIFF_CHECKSUMS_RESPONSE
  • DIFF_DOWNLOAD_RESPONSE
  • DIFF_UPLOAD_REQUEST
  • DIFF_UPLOAD_RESPONSE
  • COSMO_BINARY_REFERENCE
  • ARBITRARY_BYTES
enumDescriptions
typestring
sha1Hash
formatbyte
typestring
sha256Hash
formatbyte
typestring
timestamp
formatuint64
typestring
token
typestring
typeobject
GdataObjectId
idGdataObjectId
properties
bucketName
typestring
generation
formatint64
typestring
objectName
typestring
typeobject
GoogleProtobufEmpty
descriptionA 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); }
idGoogleProtobufEmpty
properties
typeobject
GoogleSubscriptionsBackupV1ApiRequestHeader
idGoogleSubscriptionsBackupV1ApiRequestHeader
properties
clientInfo
$refGoogleSubscriptionsBackupV1ClientInfo
experimentOverrides
typestring
typeobject
GoogleSubscriptionsBackupV1Backup
idGoogleSubscriptionsBackupV1Backup
properties
activeTransactionId
typestring
backupId
typestring
sizeBytes
formatint64
typestring
updateTime
formatgoogle-datetime
typestring
typeobject
GoogleSubscriptionsBackupV1BackupConfig
idGoogleSubscriptionsBackupV1BackupConfig
properties
androidSdkVersion
formatint32
typeinteger
gmsCoreApkVersion
typestring
hasMmsBackupEnabledBefore
typeboolean
hasRequiredPhotosPermission
typeboolean
inMsaExperiment
typeboolean
isAndroidBackupEnabled
typeboolean
isAndroidBackupSupported
typeboolean
isDeviceEtu
typeboolean
isMmsBackupEnabled
typeboolean
isMmsBackupSupported
typeboolean
isPhotosBackupEnabled
typeboolean
isPhotosBackupSupported
typeboolean
isPhotosDefaultGallery
typeboolean
lastAppBackupCompletionTimestamp
formatgoogle-datetime
typestring
photosApkVersion
typestring
systemRestoreCompletionTimestamp
formatgoogle-datetime
typestring
wasMsaShown
typeboolean
typeobject
GoogleSubscriptionsBackupV1ClientInfo
idGoogleSubscriptionsBackupV1ClientInfo
properties
clientId
enum
  • CLIENT_ID_UNSPECIFIED
  • CLIENT_ID_G1_ANDROID_APP
  • CLIENT_ID_GMSCORE_BACKUP
  • CLIENT_ID_DRIVE_BACKUP
  • CLIENT_ID_MANUAL
  • CLIENT_ID_PROBER
  • CLIENT_ID_PIXELMIGRATE
enumDescriptions
typestring
version
typestring
typeobject
GoogleSubscriptionsBackupV1CommitTransactionRequest
idGoogleSubscriptionsBackupV1CommitTransactionRequest
properties
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
transactionId
typestring
typeobject
GoogleSubscriptionsBackupV1CommitTransactionResponse
idGoogleSubscriptionsBackupV1CommitTransactionResponse
properties
typeobject
GoogleSubscriptionsBackupV1CreateBackupRequest
idGoogleSubscriptionsBackupV1CreateBackupRequest
properties
androidId
formatint64
typestring
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
typeobject
GoogleSubscriptionsBackupV1DeleteBackupConfigRequest
idGoogleSubscriptionsBackupV1DeleteBackupConfigRequest
properties
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
typeobject
GoogleSubscriptionsBackupV1DeleteFilesRequest
idGoogleSubscriptionsBackupV1DeleteFilesRequest
properties
fileIds
items
typestring
typearray
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
transactionId
typestring
typeobject
GoogleSubscriptionsBackupV1File
idGoogleSubscriptionsBackupV1File
properties
blob
$refGdataMedia
fileId
typestring
mediaResponseInfo
$refApiservingMediaResponseInfo
readOnlyTrue
mimeType
typestring
sizeBytes
formatint64
typestring
updateTime
formatgoogle-datetime
typestring
typeobject
GoogleSubscriptionsBackupV1ListBackupsResponse
idGoogleSubscriptionsBackupV1ListBackupsResponse
properties
backups
additionalProperties
$refGoogleSubscriptionsBackupV1Backup
typeobject
nextPageToken
typestring
typeobject
GoogleSubscriptionsBackupV1ListFilesResponse
idGoogleSubscriptionsBackupV1ListFilesResponse
properties
files
items
$refGoogleSubscriptionsBackupV1File
typearray
nextPageToken
typestring
typeobject
GoogleSubscriptionsBackupV1StartTransactionRequest
idGoogleSubscriptionsBackupV1StartTransactionRequest
properties
maxTransactionSize
formatint64
typestring
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
transactionOptions
$refGoogleSubscriptionsBackupV1TransactionOptions
typeobject
GoogleSubscriptionsBackupV1Transaction
idGoogleSubscriptionsBackupV1Transaction
properties
id
typestring
transactionOptions
$refGoogleSubscriptionsBackupV1TransactionOptions
typeobject
GoogleSubscriptionsBackupV1TransactionOptions
idGoogleSubscriptionsBackupV1TransactionOptions
properties
mode
enum
  • TRANSACTION_MODE_UNSPECIFIED
  • READ_ONLY
  • READ_WRITE
enumDescriptions
typestring
typeobject
GoogleSubscriptionsBackupV1UpdateBackupConfigRequest
idGoogleSubscriptionsBackupV1UpdateBackupConfigRequest
properties
androidSdkVersion
formatint32
typeinteger
gmsCoreApkVersion
typestring
hasRequiredPhotosPermission
typeboolean
inMsaExperiment
typeboolean
isAndroidBackupEnabled
typeboolean
isAndroidBackupSupported
typeboolean
isDeviceEtu
typeboolean
isMmsBackupEnabled
typeboolean
isMmsBackupSupported
typeboolean
isPhotosBackupEnabled
typeboolean
isPhotosBackupSupported
typeboolean
isPhotosDefaultGallery
typeboolean
lastAppBackupCompletionTimestamp
formatgoogle-datetime
typestring
photosApkVersion
typestring
requestHeader
$refGoogleSubscriptionsBackupV1ApiRequestHeader
systemRestoreCompletionTimestamp
formatgoogle-datetime
typestring
wasMsaShown
typeboolean
typeobject
root['title']
new_valueMMS Backup Private API
old_valueGoogle One Backup Private API
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][0]
new_valueSuch requests signals the start of a request containing media upload. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.
old_value
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][0]
new_valueDefault ID used when no other particular ID applies, or the client has not yet configured a new client ID.
old_value
iterable_item_added
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['get']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['getConfig']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['resources']['files']['methods']['delete']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['backups']['resources']['files']['methods']['list']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['media']['methods']['download']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][1]Such requests signals that the upload has progressed and that the backend might want to access the media file specified in relevant fields in the resource. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][2]Such requests signals the end of a request containing media upload. END should be handled just like normal Insert/Upload requests, that is, they should process the request and return a complete resource in the response. Pointers to media data (a GFS path usually) appear in the relevant fields in the inserted/updated resource. See gdata.Media in data.proto.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][3]Such requests occur after an END and signal that the response has been sent back to the client. RESPONSE_SENT is only sent to the backend if it is configured to receive them. The response does not need to contain anything.
root['resources']['media']['methods']['upload']['parameters']['mediaRequestInfo.notificationType']['enumDescriptions'][4]Such requests indicate that an error occurred while processing the request. ERROR is only sent to the backend if it is configured to receive them. It is not guaranteed that all errors will result in this notification to the backend, even if the backend requests them. Since these requests are just for informational purposes, the response does not need to contain anything.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][1]Client ID for the G1 Android app.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][2]Client ID for the GmsCore backup modules.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][3]Client ID for the Drive backup modules.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][4]Client ID for the manual testing. It enables special server behaviors, e.g. enables extensive logging or excludes requests from custom streamzs.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][5]Client ID used by service probers.
root['resources']['media']['methods']['upload']['parameters']['requestHeader.clientInfo.clientId']['enumDescriptions'][6]Client ID for the PixelMigrate/Restore Android app.
sandbox/staging-growth-pa-
values_changed
root['revision']
new_value20250516
old_value20250514
sandbox/staging-growth-pa-v1
values_changed
root['revision']
new_value20250516
old_value20250514
sandbox/staging-identitydevicegateway-pa-
dictionary_item_added
  • root['schemas']['AssertionInfo']['properties']['allowedAssertionAudiences']
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-identitydevicegateway-pa-v1
dictionary_item_added
  • root['schemas']['AssertionInfo']['properties']['allowedAssertionAudiences']
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-instantmessaging-pa-
dictionary_item_added
  • root['schemas']['InstantmessagingStagingPaSandboxSocialGraphApiProtoGuestPassMetadata']
  • root['schemas']['InstantmessagingStagingPaSandboxAppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo']['properties']['guestPassMetadata']
  • root['schemas']['InstantmessagingStagingPaSandboxGoogleInternalCommunicationsInstantmessagingV1GetFuzzyMatchingTemplatesRequest']['properties']['normMappingVersion']
  • root['schemas']['InstantmessagingStagingPaSandboxGoogleInternalCommunicationsInstantmessagingV1InboxSendResponse']['properties']['receiverStatus']
values_changed
root['revision']
new_value20250517
old_value20250514
root['schemas']['InstantmessagingStagingPaSandboxGoogleInternalCommunicationsInstantmessagingV1GetMlsGroupInfoRequest']['properties']['currentClientEpochIdentifier']['description']
new_valueIdentifying information for the Epoch that the client is currently in. Clients should provide their latest Epoch in order for the server to return the list of accepted control messages since that Epoch. This field is only used by Bugle clients for the enhanced self-healing flow (see go/enhanced-mls-self-heal-flow / go/mls-commit-history).
old_valueIdentifying information for the Epoch that the client is currently in. Clients should provide their latest Epoch in order for the server to return the list of accepted control messages since that Epoch.
root['schemas']['InstantmessagingStagingPaSandboxGeostoreInternalSourceSummaryProto']['properties']['provider']['enumDescriptions'][14]
new_valueAll new "Google" provider entries must be full ints. The next available ID is: 0x111730CB
old_valueAll new "Google" provider entries must be full ints. The next available ID is: 0x111730CA
iterable_item_added
root['schemas']['InstantmessagingStagingPaSandboxAppsPeopleOzExternalMergedpeopleapiAffinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['InstantmessagingStagingPaSandboxGeostoreInternalSourceSummaryProto']['properties']['provider']['enum'][205]PROVIDER_GOOGLE_POI_IDENTITY
root['schemas']['InstantmessagingStagingPaSandboxGoogleInternalPeopleV2MergedPersonSourceOptions']['properties']['includeAffinity']['items']['enum'][313]MSS_JUPITER_AFFINITY
sandbox/staging-instantmessaging-pa-v1
dictionary_item_added
  • root['schemas']['InstantmessagingStagingPaSandboxSocialGraphApiProtoGuestPassMetadata']
  • root['schemas']['InstantmessagingStagingPaSandboxAppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo']['properties']['guestPassMetadata']
  • root['schemas']['InstantmessagingStagingPaSandboxGoogleInternalCommunicationsInstantmessagingV1GetFuzzyMatchingTemplatesRequest']['properties']['normMappingVersion']
  • root['schemas']['InstantmessagingStagingPaSandboxGoogleInternalCommunicationsInstantmessagingV1InboxSendResponse']['properties']['receiverStatus']
values_changed
root['revision']
new_value20250517
old_value20250514
root['schemas']['InstantmessagingStagingPaSandboxGoogleInternalCommunicationsInstantmessagingV1GetMlsGroupInfoRequest']['properties']['currentClientEpochIdentifier']['description']
new_valueIdentifying information for the Epoch that the client is currently in. Clients should provide their latest Epoch in order for the server to return the list of accepted control messages since that Epoch. This field is only used by Bugle clients for the enhanced self-healing flow (see go/enhanced-mls-self-heal-flow / go/mls-commit-history).
old_valueIdentifying information for the Epoch that the client is currently in. Clients should provide their latest Epoch in order for the server to return the list of accepted control messages since that Epoch.
root['schemas']['InstantmessagingStagingPaSandboxGeostoreInternalSourceSummaryProto']['properties']['provider']['enumDescriptions'][14]
new_valueAll new "Google" provider entries must be full ints. The next available ID is: 0x111730CB
old_valueAll new "Google" provider entries must be full ints. The next available ID is: 0x111730CA
iterable_item_added
root['schemas']['InstantmessagingStagingPaSandboxAppsPeopleOzExternalMergedpeopleapiAffinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['InstantmessagingStagingPaSandboxGeostoreInternalSourceSummaryProto']['properties']['provider']['enum'][205]PROVIDER_GOOGLE_POI_IDENTITY
root['schemas']['InstantmessagingStagingPaSandboxGoogleInternalPeopleV2MergedPersonSourceOptions']['properties']['includeAffinity']['items']['enum'][313]MSS_JUPITER_AFFINITY
sandbox/staging-kidsmanagement-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-kidsmanagement-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-kidsnotification-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-kidsnotification-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-locationhistory-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-locationhistory-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-locationhistoryplacedetails-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-locationhistoryplacedetails-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-myphonenumbers-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-myphonenumbers-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-nearbypresence-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-nearbypresence-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-notifications-pa-
dictionary_item_added
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__GeofenceNotificationsSettingsConstraint']
  • root['schemas']['AppsDynamite__ChimeNotificationPayload']['properties']['reactionId']
  • root['schemas']['GoogleInternalFitbitP11ManagementV1Notification__P11ChimeDevicePayload']['properties']['enableEsimUpdateNotifications']
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__UserSettingsConstraint']['properties']['geofenceNotificationsSettingsConstraint']
  • root['schemas']['NotificationsFrontendData_RenderContext_DeviceInfo']['properties']['appVersionCode']
values_changed
root['revision']
new_value20250517
old_value20250514
root['schemas']['GoogleInternalFitbitP11ManagementV1Notification__P11ChimeDevicePayload']['description']
new_valueIncluded in the chime registration payload and retrieved in the backend render context when the renderer is invoked on notifications. Next ID: 9
old_valueIncluded in the chime registration payload and retrieved in the backend render context when the renderer is invoked on notifications. Next ID: 8
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][605]
new_valueNeed bundle type for Real World Journeys (RWJ) short video card.
old_valueNeed bundle type for RWJ short video card.
iterable_item_added
root['schemas']['NotificationsFrontendDataCommon__SupportedFeatures']['properties']['supportedCustomUiTypes']['items']['enum'][5]CUSTOM_UI_TYPE_OG_CALLOUT
root['schemas']['NotificationsFrontendDataCommon__SupportedFeatures']['properties']['supportedCustomUiTypes']['items']['enumDescriptions'][5]IN_WEB pre-custom UI traffic.
root['schemas']['NotificationsPlatformCommonProto__CustomUi']['properties']['customUiType']['enum'][5]CUSTOM_UI_TYPE_OG_CALLOUT
root['schemas']['NotificationsPlatformCommonProto__CustomUi']['properties']['customUiType']['enumDescriptions'][5]IN_WEB pre-custom UI traffic.
root['schemas']['SearchNotificationsClientCommon__InboxChimeData']['properties']['category']['enum'][286]UPCOMING_HOLIDAYS_EVENTS_NOTIF
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][606]RWJ_WHATS_HAPPENING
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][619]TRENDING_FOR_YOU
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][620]SOCIAL_MEDIA_COMMENTS
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][606]Need bundle type for Real World Journeys (RWJ) What's Happening card.
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][618]Need bundle type for Neon Cluster in Discover. go/discover-story-neon-integration
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][619]Need bundle type for Trending for You in Discover. go/discover-story-rr-flow
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][620]Need bundle type for This feature will fetch social media comments related to a content. NextId: 4628
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1486]RWJ_WHATS_HAPPENING
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1499]TRENDING_FOR_YOU
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1500]SOCIAL_MEDIA_COMMENTS
root['schemas']['Sidekick__SemanticProperties']['properties']['notificationCategory']['enum'][286]UPCOMING_HOLIDAYS_EVENTS_NOTIF
iterable_item_removed
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][617]Need bundle type for Neon Cluster in Discover. go/discover-story-neon-integration NextId: 4625
sandbox/staging-notifications-pa-v1
dictionary_item_added
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__GeofenceNotificationsSettingsConstraint']
  • root['schemas']['AppsDynamite__ChimeNotificationPayload']['properties']['reactionId']
  • root['schemas']['GoogleInternalFitbitP11ManagementV1Notification__P11ChimeDevicePayload']['properties']['enableEsimUpdateNotifications']
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__UserSettingsConstraint']['properties']['geofenceNotificationsSettingsConstraint']
  • root['schemas']['NotificationsFrontendData_RenderContext_DeviceInfo']['properties']['appVersionCode']
values_changed
root['revision']
new_value20250517
old_value20250514
root['schemas']['GoogleInternalFitbitP11ManagementV1Notification__P11ChimeDevicePayload']['description']
new_valueIncluded in the chime registration payload and retrieved in the backend render context when the renderer is invoked on notifications. Next ID: 9
old_valueIncluded in the chime registration payload and retrieved in the backend render context when the renderer is invoked on notifications. Next ID: 8
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][605]
new_valueNeed bundle type for Real World Journeys (RWJ) short video card.
old_valueNeed bundle type for RWJ short video card.
iterable_item_added
root['schemas']['NotificationsFrontendDataCommon__SupportedFeatures']['properties']['supportedCustomUiTypes']['items']['enum'][5]CUSTOM_UI_TYPE_OG_CALLOUT
root['schemas']['NotificationsFrontendDataCommon__SupportedFeatures']['properties']['supportedCustomUiTypes']['items']['enumDescriptions'][5]IN_WEB pre-custom UI traffic.
root['schemas']['NotificationsPlatformCommonProto__CustomUi']['properties']['customUiType']['enum'][5]CUSTOM_UI_TYPE_OG_CALLOUT
root['schemas']['NotificationsPlatformCommonProto__CustomUi']['properties']['customUiType']['enumDescriptions'][5]IN_WEB pre-custom UI traffic.
root['schemas']['SearchNotificationsClientCommon__InboxChimeData']['properties']['category']['enum'][286]UPCOMING_HOLIDAYS_EVENTS_NOTIF
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][606]RWJ_WHATS_HAPPENING
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][619]TRENDING_FOR_YOU
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enum'][620]SOCIAL_MEDIA_COMMENTS
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][606]Need bundle type for Real World Journeys (RWJ) What's Happening card.
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][618]Need bundle type for Neon Cluster in Discover. go/discover-story-neon-integration
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][619]Need bundle type for Trending for You in Discover. go/discover-story-rr-flow
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][620]Need bundle type for This feature will fetch social media comments related to a content. NextId: 4628
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1486]RWJ_WHATS_HAPPENING
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1499]TRENDING_FOR_YOU
root['schemas']['Sidekick__SemanticProperties']['properties']['cardCategory']['enum'][1500]SOCIAL_MEDIA_COMMENTS
root['schemas']['Sidekick__SemanticProperties']['properties']['notificationCategory']['enum'][286]UPCOMING_HOLIDAYS_EVENTS_NOTIF
iterable_item_removed
root['schemas']['Sidekick__ClusterMetadata']['properties']['needBundleType']['enumDescriptions'][617]Need bundle type for Neon Cluster in Discover. go/discover-story-neon-integration NextId: 4625
sandbox/staging-ogads-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
iterable_item_added
root['resources']['v1']['methods']['getdata']['parameters']['hostProduct']['enum'][733]FINANCE_HUB
root['resources']['v1']['methods']['getdata']['parameters']['hostProduct']['enumDescriptions'][733]go/finhub-design
root['resources']['v1']['methods']['getdata']['parameters']['subproduct']['enum'][733]FINANCE_HUB
root['resources']['v1']['methods']['getdata']['parameters']['subproduct']['enumDescriptions'][733]go/finhub-design
sandbox/staging-ogads-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
iterable_item_added
root['resources']['v1']['methods']['getdata']['parameters']['hostProduct']['enum'][733]FINANCE_HUB
root['resources']['v1']['methods']['getdata']['parameters']['hostProduct']['enumDescriptions'][733]go/finhub-design
root['resources']['v1']['methods']['getdata']['parameters']['subproduct']['enum'][733]FINANCE_HUB
root['resources']['v1']['methods']['getdata']['parameters']['subproduct']['enumDescriptions'][733]go/finhub-design
sandbox/staging-people-pa-
dictionary_item_added
  • root['schemas']['GuestPassMetadata']
  • root['schemas']['ReadOnlyProfileInfo']['properties']['guestPassMetadata']
values_changed
root['revision']
new_value20250517
old_value20250514
iterable_item_added
root['resources']['people']['methods']['create']['parameters']['getPeopleRequest.mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['create']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['getPublic']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['sync']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['update']['parameters']['getPeopleRequest.mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['update']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['allPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['autocomplete']['methods']['list']['parameters']['client']['enum'][135]MSS_JUPITER
root['resources']['people']['resources']['autocomplete']['resources']['public']['methods']['list']['parameters']['client']['enum'][135]MSS_JUPITER
root['resources']['people']['resources']['blockedPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['circledPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['circles']['resources']['members']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['contactPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['search']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['sync']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['groups']['resources']['members']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['lookup']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['ranked']['methods']['list']['parameters']['affinityType']['enum'][308]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['ranked']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['rankedTargets']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['starredPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['trashedContactPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['v2']['methods']['getPeople']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['schemas']['Affinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['GoogleInternalPeopleV2MinimalRankedTarget']['properties']['affinityType']['items']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['InternalExternal']['properties']['application']['enum'][460]MSS_JUPITER
root['schemas']['InternalSourceSummaryProto']['properties']['provider']['enum'][205]PROVIDER_GOOGLE_POI_IDENTITY
root['schemas']['MergedPersonSourceOptions']['properties']['includeAffinity']['items']['enum'][313]MSS_JUPITER_AFFINITY
root['schemas']['RankedTarget']['properties']['affinityType']['items']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['SocialGraphWireProtoPeopleapiMinimalAffinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
sandbox/staging-people-pa-v1
dictionary_item_added
  • root['schemas']['GuestPassMetadata']
  • root['schemas']['ReadOnlyProfileInfo']['properties']['guestPassMetadata']
values_changed
root['revision']
new_value20250517
old_value20250514
iterable_item_added
root['schemas']['Affinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['InternalExternal']['properties']['application']['enum'][460]MSS_JUPITER
root['schemas']['InternalSourceSummaryProto']['properties']['provider']['enum'][205]PROVIDER_GOOGLE_POI_IDENTITY
sandbox/staging-people-pa-v2
dictionary_item_added
  • root['schemas']['GuestPassMetadata']
  • root['schemas']['ReadOnlyProfileInfo']['properties']['guestPassMetadata']
values_changed
root['revision']
new_value20250517
old_value20250514
iterable_item_added
root['resources']['people']['methods']['create']['parameters']['getPeopleRequest.mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['create']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['getPublic']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['sync']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['update']['parameters']['getPeopleRequest.mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['methods']['update']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['allPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['autocomplete']['methods']['list']['parameters']['client']['enum'][135]MSS_JUPITER
root['resources']['people']['resources']['autocomplete']['resources']['public']['methods']['list']['parameters']['client']['enum'][135]MSS_JUPITER
root['resources']['people']['resources']['blockedPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['circledPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['circles']['resources']['members']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['contactPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['search']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['directory']['methods']['sync']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['groups']['resources']['members']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['lookup']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['ranked']['methods']['list']['parameters']['affinityType']['enum'][308]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['ranked']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['rankedTargets']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['starredPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['people']['resources']['trashedContactPeople']['methods']['list']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['resources']['v2']['methods']['getPeople']['parameters']['mergedPersonSourceOptions.includeAffinity']['enum'][313]MSS_JUPITER_AFFINITY
root['schemas']['Affinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['GoogleInternalPeopleV2MinimalRankedTarget']['properties']['affinityType']['items']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['InternalExternal']['properties']['application']['enum'][460]MSS_JUPITER
root['schemas']['InternalSourceSummaryProto']['properties']['provider']['enum'][205]PROVIDER_GOOGLE_POI_IDENTITY
root['schemas']['MergedPersonSourceOptions']['properties']['includeAffinity']['items']['enum'][313]MSS_JUPITER_AFFINITY
root['schemas']['RankedTarget']['properties']['affinityType']['items']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['SocialGraphWireProtoPeopleapiMinimalAffinity']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
sandbox/staging-peoplestack-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
iterable_item_added
root['resources']['autocomplete']['methods']['autocomplete']['parameters']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['resources']['autocomplete']['methods']['warmup']['parameters']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackAutocompleteRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackBlockPersonRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackCreateGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackDeleteGroupsRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
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']['PeoplestackJoinGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackLeaveGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackLookupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackMutateConnectionLabelRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackReadAllGroupsRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackReadGroupsRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackSmartAddressRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackUpdateGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackWarmupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['SocialClientsApplicationProto3Wrapper']['properties']['application']['enum'][460]MSS_JUPITER
root['schemas']['SocialClientsApplicationProto3Wrapper']['properties']['application']['enumDescriptions'][460]Mss Jupiter Team contact: jupiter-eng@google.com
sandbox/staging-peoplestack-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
iterable_item_added
root['resources']['autocomplete']['methods']['autocomplete']['parameters']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['resources']['autocomplete']['methods']['warmup']['parameters']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackAutocompleteRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackBlockPersonRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackCreateGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackDeleteGroupsRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
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']['PeoplestackJoinGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackLeaveGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackLookupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackMutateConnectionLabelRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackReadAllGroupsRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackReadGroupsRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackSmartAddressRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackUpdateGroupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['PeoplestackWarmupRequest']['properties']['affinityType']['enum'][315]MSS_JUPITER_AFFINITY
root['schemas']['SocialClientsApplicationProto3Wrapper']['properties']['application']['enum'][460]MSS_JUPITER
root['schemas']['SocialClientsApplicationProto3Wrapper']['properties']['application']['enumDescriptions'][460]Mss Jupiter Team contact: jupiter-eng@google.com
sandbox/staging-phonedeviceverification-pa-
values_changed
root['revision']
new_value20250516
old_value20250514
sandbox/staging-phonedeviceverification-pa-v1
values_changed
root['revision']
new_value20250516
old_value20250514
sandbox/staging-phosphor-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-phosphor-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-reach-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-reach-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-restrictedapps-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-restrictedapps-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-threadcredentialsdistribution-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-threadcredentialsdistribution-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-userlocation-
values_changed
root['revision']
new_value20250513
old_value20250506
sandbox/staging-userlocation-v1
values_changed
root['revision']
new_value20250513
old_value20250506
sandbox/staging-verifiablecredentials-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/staging-verifiablecredentials-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/test-scone-pa-
values_changed
root['revision']
new_value20250517
old_value20250514
sandbox/test-scone-pa-v1
values_changed
root['revision']
new_value20250517
old_value20250514