Firebase App Distribution API (firebaseappdistribution:v1alpha)

2023-12-09

13 new methods | New API

Additions

    Methods
  • firebaseappdistribution.apps.provisionApp

      HTTP Method : POST

      Path : v1alpha/apps/{mobilesdkAppId}

      Description : Provision app distribution for an existing Firebase app, enabling it to subsequently be used by appdistro.

      Parameter Order : mobilesdkAppId

      Parameters :

        mobilesdkAppId

          Required : Yes

          Type : string

          Location : path

          Description : Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289

      Flat Path : v1alpha/apps/{mobilesdkAppId}

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • firebaseappdistribution.apps.get

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        appView

          Location : query

          Enum Descriptions :

        • The default / unset value. The API will default to the BASIC view.
        • Include everything except aab_state.
        • Include everything.
        • Enum :

        • APP_VIEW_UNSPECIFIED
        • BASIC
        • FULL
        • Description : App view. When unset or set to BASIC, returns an App with everything set except for aab_state. When set to FULL, returns an App with aab_state set.

          Type : string

        mobilesdkAppId

          Required : Yes

          Description : Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289

          Location : path

          Type : string

      Path : v1alpha/apps/{mobilesdkAppId}

      Flat Path : v1alpha/apps/{mobilesdkAppId}

      Parameter Order : mobilesdkAppId

      HTTP Method : GET

      Description : Get the app, if it exists

  • firebaseappdistribution.apps.getJwt

      Parameter Order : mobilesdkAppId

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : GET

      Flat Path : v1alpha/apps/{mobilesdkAppId}/jwt

      Parameters :

        mobilesdkAppId

          Location : path

          Required : Yes

          Type : string

          Description : Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289

      Description : Get a JWT token

      Path : v1alpha/apps/{mobilesdkAppId}/jwt

  • firebaseappdistribution.apps.releases.notes.create

      Path : v1alpha/apps/{mobilesdkAppId}/releases/{releaseId}/notes

      Flat Path : v1alpha/apps/{mobilesdkAppId}/releases/{releaseId}/notes

      Parameters :

        releaseId

          Location : path

          Type : string

          Description : Release identifier

          Required : Yes

        mobilesdkAppId

          Description : Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • mobilesdkAppId
    • releaseId
    • Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Create release notes on a release.

      HTTP Method : POST

  • firebaseappdistribution.apps.releases.enable_access

      Path : v1alpha/apps/{mobilesdkAppId}/releases/{releaseId}/enable_access

      Parameter Order :

    • mobilesdkAppId
    • releaseId
    • Parameters :

        releaseId

          Type : string

          Description : Release identifier

          Location : path

          Required : Yes

        mobilesdkAppId

          Type : string

          Location : path

          Description : Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289

          Required : Yes

      Description : Enable access on a release for testers.

      HTTP Method : POST

      Flat Path : v1alpha/apps/{mobilesdkAppId}/releases/{releaseId}/enable_access

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • firebaseappdistribution.apps.testers.getTesterUdids

      Flat Path : v1alpha/apps/{mobilesdkAppId}/testers:getTesterUdids

      Parameter Order : mobilesdkAppId

      Description : Get UDIDs of tester iOS devices in a project

      Parameters :

        mobilesdkAppId

          Type : string

          Description : Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289

          Required : Yes

          Location : path

      HTTP Method : GET

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1alpha/apps/{mobilesdkAppId}/testers:getTesterUdids

  • firebaseappdistribution.apps.upload_status.get

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : GET

      Flat Path : v1alpha/apps/{mobilesdkAppId}/upload_status/{uploadToken}

      Parameter Order :

    • mobilesdkAppId
    • uploadToken
    • Path : v1alpha/apps/{mobilesdkAppId}/upload_status/{uploadToken}

      Parameters :

        mobilesdkAppId

          Required : Yes

          Location : path

          Type : string

          Description : Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289

        uploadToken

          Description : The token for the upload

          Type : string

          Required : Yes

          Location : path

      Description : GET Binary upload status by token

  • firebaseappdistribution.apps.release_by_hash.get

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        uploadHash

          Required : Yes

          Location : path

          Type : string

          Description : The hash for the upload

        mobilesdkAppId

          Description : Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289

          Location : path

          Required : Yes

          Type : string

      Path : v1alpha/apps/{mobilesdkAppId}/release_by_hash/{uploadHash}

      HTTP Method : GET

      Flat Path : v1alpha/apps/{mobilesdkAppId}/release_by_hash/{uploadHash}

      Description : GET Release by binary upload hash

      Parameter Order :

    • mobilesdkAppId
    • uploadHash
  • firebaseappdistribution.projects.apps.getTestConfig

      Description : Gets configuration for automated tests.

      Flat Path : v1alpha/projects/{projectsId}/apps/{appsId}/testConfig

      Path : v1alpha/{+name}

      Parameters :

        name

          Required : Yes

          Type : string

          Pattern : ^projects/[^/]+/apps/[^/]+/testConfig$

          Description : Required. The name of the `TestConfig` resource to retrieve. Format: `projects/{project_number}/apps/{app_id}/testConfig`

          Location : path

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : GET

      Parameter Order : name

  • firebaseappdistribution.projects.apps.updateTestConfig

      Parameters :

        name

          Location : path

          Pattern : ^projects/[^/]+/apps/[^/]+/testConfig$

          Description : Identifier. The name of the test configuration resource. Format: `projects/{project_number}/apps/{app_id}/testConfig`

          Required : Yes

          Type : string

        updateMask

          Location : query

          Type : string

          Description : Optional. The list of fields to update.

          Format : google-fieldmask

      Description : Updates a release.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : PATCH

      Flat Path : v1alpha/projects/{projectsId}/apps/{appsId}/testConfig

      Path : v1alpha/{+name}

      Parameter Order : name

  • firebaseappdistribution.projects.apps.releases.tests.get

      Path : v1alpha/{+name}

      Parameters :

        name

          Required : Yes

          Description : Required. The name of the release test resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}/tests/{test_id}`

          Location : path

          Type : string

          Pattern : ^projects/[^/]+/apps/[^/]+/releases/[^/]+/tests/[^/]+$

      Flat Path : v1alpha/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/tests/{testsId}

      Parameter Order : name

      HTTP Method : GET

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Get results for automated test run on release.

  • firebaseappdistribution.projects.apps.releases.tests.create

      Parameters :

        parent

          Pattern : ^projects/[^/]+/apps/[^/]+/releases/[^/]+$

          Description : Required. The name of the release resource, which is the parent of the test Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}`

          Type : string

          Location : path

          Required : Yes

        releaseTestId

          Description : Optional. The ID to use for the test, which will become the final component of the tests's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. If it is not provided one will be automatically generated.

          Location : query

          Type : string

      Flat Path : v1alpha/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/tests

      HTTP Method : POST

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1alpha/{+parent}/tests

      Description : Run automated test(s) on release.

  • firebaseappdistribution.projects.apps.releases.tests.list

      Flat Path : v1alpha/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/tests

      Path : v1alpha/{+parent}/tests

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        pageToken

          Location : query

          Description : Optional. A page token, received from a previous `ListReleaseTests` call. Provide this to retrieve the subsequent page.

          Type : string

        parent

          Description : Required. The name of the release resource, which is the parent of the tests Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}`

          Required : Yes

          Pattern : ^projects/[^/]+/apps/[^/]+/releases/[^/]+$

          Location : path

          Type : string

        pageSize

          Location : query

          Format : int32

          Description : Optional. The maximum number of tests to return. The service may return fewer than this value.

          Type : integer

      HTTP Method : GET

      Parameter Order : parent

      Description : List results for automated tests run on release.