REST Resource: accounts.repos.scans

Resource: RepoScan

Repo scan.

JSON representation 
{
  "name": string,
  "resultsUri": string,
  "localScanPath": string,
  "cliVersion": string,
  "sources": [
    {
      object (Source)
    }
  ],
  "scmMetadata": {
    object (ScmMetadata)
  }
}
Fields
name

string

Identifier. Resource name of the scan.
resultsUri

string

A URL to view results.
localScanPath

string

Local scan path.
cliVersion

string

CLI version.
sources[]

object (Source)

Data sources detected.
scmMetadata

object (ScmMetadata)

SCM metadata.

Source

Represents a data source finding.

JSON representation 
{
  "dataType": enum (DataType),
  "codeAttribution": {
    object (CodeAttribution)
  }
}
Fields
dataType

enum (DataType)

Required. Data type.
codeAttribution

object (CodeAttribution)

Optional. Source code attribution for the finding.

DataType

Types of data used by your app.

Enums
DATA_TYPE_UNSPECIFIED Not specified.
DATA_TYPE_APPROXIMATE_LOCATION User or device physical location to an area greater than or equal to 3 square kilometers, such as the city a user is in, or location provided by Android's ACCESS_COARSE_LOCATION permission.
DATA_TYPE_PRECISE_LOCATION User or device physical location within an area less than 3 square kilometers, such as location provided by Android's ACCESS_FINE_LOCATION permission.
DATA_TYPE_PERSONAL_NAME How a user refers to themselves, such as their first or last name, or nickname.
DATA_TYPE_EMAIL_ADDRESS A user's email address.
DATA_TYPE_USER_IDS Identifiers that relate to an identifiable person. For example, an account ID, account number, or account name.
DATA_TYPE_PHYSICAL_ADDRESS A user's address, such as a mailing or home address.
DATA_TYPE_PHONE_NUMBER A user's phone number.
DATA_TYPE_RACE_AND_ETHNICITY Information about a user's race or ethnicity.
DATA_TYPE_POLITICAL_OR_RELIGIOUS_BELIEFS Information about a user's political or religious beliefs.
DATA_TYPE_SEXUAL_ORIENTATION Information about a user's sexual orientation.
DATA_TYPE_OTHER_PERSONAL_INFO Any other personal information such as date of birth, gender identity, veteran status, etc.
DATA_TYPE_PAYMENT_INFO Information about a user's financial accounts such as credit card number.
DATA_TYPE_PURCHASE_HISTORY Information about purchases or transactions a user has made.
DATA_TYPE_CREDIT_SCORE Information about a user's credit score.
DATA_TYPE_OTHER_FINANCIAL_INFO Any other financial information such as user salary or debts.
DATA_TYPE_HEALTH_INFO Information about a user's health, such as medical records or symptoms.
DATA_TYPE_FITNESS_INFO Information about a user's fitness, such as exercise or other physical activity.
DATA_TYPE_EMAILS A user's emails including the email subject line, sender, recipients, and the content of the email.
DATA_TYPE_TEXT_MESSAGES A user's text messages including the sender, recipients, and the content of the message.
DATA_TYPE_OTHER_IN_APP_MESSAGES Any other types of messages. For example, instant messages or chat content.
DATA_TYPE_PHOTOS A user's photos.
DATA_TYPE_VIDEOS A user's videos.
DATA_TYPE_VOICE_OR_SOUND_RECORDINGS A user's voice such as a voicemail or a sound recording.
DATA_TYPE_MUSIC_FILES A user's music files.
DATA_TYPE_OTHER_AUDIO_FILES Any other user-created or user-provided audio files.
DATA_TYPE_FILES_AND_DOCS A user's files or documents, or information about their files or documents such as file names.
DATA_TYPE_CALENDAR_EVENTS Information from a user's calendar such as events, event notes, and attendees.
DATA_TYPE_CONTACTS Information about the user’s contacts such as contact names, message history, and social graph information like usernames, contact recency, contact frequency, interaction duration and call history.
DATA_TYPE_APP_INTERACTIONS Information about how a user interacts with your app, such as the number of page views or taps.
DATA_TYPE_IN_APP_SEARCH_HISTORY Information about what a user has searched for in your app.
DATA_TYPE_INSTALLED_APPS Inventory of apps or packages installed on the user’s device.
DATA_TYPE_OTHER_USER_GENERATED_CONTENT Any other user-generated content not listed here, or in any other section. For example, user bios, notes, or open-ended responses.
DATA_TYPE_OTHER_ACTIONS Any other user activity or actions in-app not listed here such as gameplay, likes, and dialog options.
DATA_TYPE_WEB_BROWSING_HISTORY Information about the websites a user has visited.
DATA_TYPE_CRASH_LOGS Crash log data from your app. For example, the number of times your app has crashed, stack traces, or other information directly related to a crash.
DATA_TYPE_PERFORMANCE_DIAGNOSTICS Information about the performance of your app. For example battery life, loading time, latency, framerate, or any technical diagnostics.
DATA_TYPE_OTHER_APP_PERFORMANCE_DATA Any other app performance data not listed here.
DATA_TYPE_DEVICE_OR_OTHER_IDS Identifiers that relate to an individual device, browser or app. For example, an IMEI number, MAC address, Widevine Device ID, Firebase installation ID, or advertising identifier.

CodeAttribution

Source code attribution.

JSON representation 
{
  "path": string,
  "lineNumber": integer,
  "codeExcerpt": string,
  "startLineNumber": integer
}
Fields
path

string

Required. Path of the file.
lineNumber

integer

Required. Line number (1-based).
codeExcerpt

string

Optional. Code excerpt where the source was detected along with surrounding code.
startLineNumber

integer

Optional. Start line number of the code excerpt (1-based).

ScmMetadata

SCM metadata.

JSON representation 
{
  "revisionId": string,
  "branch": string,
  "remoteUri": string,
  "pullRequest": {
    object (PullRequest)
  }
}
Fields
revisionId

string

Required. Revision ID, e.g. Git commit hash.
branch

string

Required. Branch name.
remoteUri

string

Required. Git remote URL.
pullRequest

object (PullRequest)

Optional. Contains info about the associated pull request. This is only populated for pull request scans.

PullRequest

Pull request info.

JSON representation 
{
  "prNumber": string,
  "baseBranch": string
}
Fields
prNumber

string

Required. This can be supplied by the user or parsed automatically from predefined CI environment variables.
baseBranch

string

Required. For PR analysis, we compare against the most recent scan of the base branch to highlight new issues.

Methods

generate

 Uploads the results of local Code Compliance analysis and generates a scan of privacy issues.

get

 Gets a repo scan.

list

 Lists repo scans for the specified repo.