2023-03-29
▼ ▲ firebaseappdistribution.media.upload
Supportsmediaupload: Yes
Parameter Order: app
Parameters:
app
Required: Yes
Pattern: ^projects/[^/]+/apps/[^/]+$
Description: The name of the app resource. Format: `projects/{project_number}/apps/{app_id}`
Location: path
Type: string
Path: v1/{+app}/releases:upload
Mediaupload:
Accept: */*
Protocols:
Simple:
Path: /upload/v1/{+app}/releases:upload
Multipart: Yes
HTTP Method: POST
Description: Uploads a binary. Uploading a binary can result in a new release being created, an update to an existing release, or a no-op if a release with the same binary already exists.
Flat Path: v1/projects/{projectsId}/apps/{appsId}/releases:upload
▼ ▲ firebaseappdistribution.projects.testers.patch
HTTP Method: PATCH
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/testers/{testersId}
Parameters:
updateMask
Format: google-fieldmask
Type: string
Location: query
Description: The list of fields to update.
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/testers/[^/]+$
Description: The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}`
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Update a tester. If the testers joins a group they gain access to all releases that the group has access to.
▼ ▲ firebaseappdistribution.projects.testers.batchAdd
Description: Batch adds testers. This call adds testers for the specified emails if they don't already exist. Returns all testers specified in the request, including newly created and previously existing testers. This action is idempotent.
Path: v1/{+project}/testers:batchAdd
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
project
Type: string
Location: path
Pattern: ^projects/[^/]+$
Required: Yes
Description: Required. The name of the project resource. Format: `projects/{project_number}`
Parameter Order: project
Flat Path: v1/projects/{projectsId}/testers:batchAdd
HTTP Method: POST
▼ ▲ firebaseappdistribution.projects.testers.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: parent
Description: Lists testers and their resource ids.
Parameters:
parent
Type: string
Description: Required. The name of the project resource, which is the parent of the tester resources. Format: `projects/{project_number}`
Pattern: ^projects/[^/]+$
Location: path
Required: Yes
pageToken
Description: Optional. A page token, received from a previous `ListTesters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTesters` must match the call that provided the page token.
Type: string
Location: query
pageSize
Location: query
Description: Optional. The maximum number of testers to return. The service may return fewer than this value. The valid range is [1-1000]; If unspecified (0), at most 10 testers are returned. Values above 1000 are coerced to 1000.
Type: integer
Format: int32
filter
Type: string
Description: Optional. The expression to filter testers listed in the response. To learn more about filtering, refer to [Google's AIP-160 standard](http://aip.dev/160). Supported fields: - `name` - `displayName` - `groups` Example: - `name = "projects/-/testers/*@example.com"` - `displayName = "Joe Sixpack"` - `groups = "projects/*/groups/qa-team"`
Location: query
Flat Path: v1/projects/{projectsId}/testers
Path: v1/{+parent}/testers
▼ ▲ firebaseappdistribution.projects.testers.batchRemove
Description: Batch removes testers. If found, this call deletes testers for the specified emails. Returns all deleted testers.
Parameter Order: project
Parameters:
project
Type: string
Pattern: ^projects/[^/]+$
Location: path
Required: Yes
Description: Required. The name of the project resource. Format: `projects/{project_number}`
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/testers:batchRemove
Path: v1/{+project}/testers:batchRemove
▼ ▲ firebaseappdistribution.projects.apps.getAabInfo
HTTP Method: GET
Parameter Order: name
Description: Gets Android App Bundle (AAB) information for a Firebase app.
Parameters:
name
Description: Required. The name of the `AabInfo` resource to retrieve. Format: `projects/{project_number}/apps/{app_id}/aabInfo`
Required: Yes
Pattern: ^projects/[^/]+/apps/[^/]+/aabInfo$
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/apps/{appsId}/aabInfo
Path: v1/{+name}
▼ ▲ firebaseappdistribution.projects.apps.releases.get
Flat Path: v1/projects/{projectsId}/apps/{appsId}/releases/{releasesId}
HTTP Method: GET
Parameters:
name
Type: string
Description: Required. The name of the release resource to retrieve. Format: projects/{project_number}/apps/{app_id}/releases/{release_id}
Location: path
Required: Yes
Pattern: ^projects/[^/]+/apps/[^/]+/releases/[^/]+$
Parameter Order: name
Description: Gets a release.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
▼ ▲ firebaseappdistribution.projects.apps.releases.list
Path: v1/{+parent}/releases
Flat Path: v1/projects/{projectsId}/apps/{appsId}/releases
Parameter Order: parent
Description: Lists releases. By default, sorts by `createTime` in descending order.
HTTP Method: GET
Parameters:
parent
Pattern: ^projects/[^/]+/apps/[^/]+$
Required: Yes
Location: path
Description: Required. The name of the app resource, which is the parent of the release resources. Format: `projects/{project_number}/apps/{app_id}`
Type: string
pageToken
Type: string
Location: query
Description: A page token, received from a previous `ListReleases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleases` must match the call that provided the page token.
orderBy
Type: string
Location: query
Description: The fields used to order releases. Supported fields: - `createTime` To specify descending order for a field, append a "desc" suffix, for example, `createTime desc`. If this parameter is not set, releases are ordered by `createTime` in descending order.
filter
Description: The expression to filter releases listed in the response. To learn more about filtering, refer to [Google's AIP-160 standard](http://aip.dev/160). Supported fields: - `releaseNotes.text` supports `=` (can contain a wildcard character (`*`) at the beginning or end of the string) - `createTime` supports `<`, `<=`, `>` and `>=`, and expects an RFC-3339 formatted string Examples: - `createTime <= "2021-09-08T00:00:00+04:00"` - `releaseNotes.text="fixes" AND createTime >= "2021-09-08T00:00:00.0Z"` - `releaseNotes.text="*v1.0.0-rc*"`
Location: query
Type: string
pageSize
Format: int32
Description: The maximum number of releases to return. The service may return fewer than this value. The valid range is [1-100]; If unspecified (0), at most 25 releases are returned. Values above 100 are coerced to 100.
Location: query
Type: integer
▼ ▲ firebaseappdistribution.projects.apps.releases.batchDelete
Flat Path: v1/projects/{projectsId}/apps/{appsId}/releases:batchDelete
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Deletes releases. A maximum of 100 releases can be deleted per request.
Parameter Order: parent
Path: v1/{+parent}/releases:batchDelete
Parameters:
parent
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/apps/[^/]+$
Description: Required. The name of the app resource, which is the parent of the release resources. Format: `projects/{project_number}/apps/{app_id}`
▼ ▲ firebaseappdistribution.projects.apps.releases.patch
Flat Path: v1/projects/{projectsId}/apps/{appsId}/releases/{releasesId}
Path: v1/{+name}
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Required: Yes
Description: The name of the release resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}`
Type: string
Pattern: ^projects/[^/]+/apps/[^/]+/releases/[^/]+$
Location: path
updateMask
Type: string
Description: The list of fields to update.
Location: query
Format: google-fieldmask
Description: Updates a release.
▼ ▲ firebaseappdistribution.projects.apps.releases.distribute
Parameter Order: name
Path: v1/{+name}:distribute
HTTP Method: POST
Parameters:
name
Required: Yes
Description: Required. The name of the release resource to distribute. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}`
Type: string
Location: path
Pattern: ^projects/[^/]+/apps/[^/]+/releases/[^/]+$
Flat Path: v1/projects/{projectsId}/apps/{appsId}/releases/{releasesId}:distribute
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Distributes a release to testers. This call does the following: 1. Creates testers for the specified emails, if none exist. 2. Adds the testers and groups to the release. 3. Sends new testers an invitation email. 4. Sends existing testers a new release email. The request will fail with a `INVALID_ARGUMENT` if it contains a group that doesn't exist.
▼ ▲ firebaseappdistribution.projects.apps.releases.operations.wait
HTTP Method: POST
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/apps/[^/]+/releases/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource to wait on.
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1/{+name}:wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Flat Path: v1/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/operations/{operationsId}:wait
▼ ▲ firebaseappdistribution.projects.apps.releases.operations.list
Parameter Order: name
HTTP Method: GET
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}/operations
Parameters:
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Format: int32
Location: query
Description: The standard list page size.
Type: integer
name
Type: string
Description: The name of the operation's parent resource.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/apps/[^/]+/releases/[^/]+$
pageToken
Location: query
Type: string
Description: The standard list page token.
Flat Path: v1/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/operations
▼ ▲ firebaseappdistribution.projects.apps.releases.operations.get
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters:
name
Required: Yes
Description: The name of the operation resource.
Type: string
Pattern: ^projects/[^/]+/apps/[^/]+/releases/[^/]+/operations/[^/]+$
Location: path
Flat Path: v1/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/operations/{operationsId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
HTTP Method: GET
▼ ▲ firebaseappdistribution.projects.apps.releases.operations.cancel
Path: v1/{+name}:cancel
HTTP Method: POST
Parameter Order: name
Flat Path: v1/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/operations/{operationsId}:cancel
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Parameters:
name
Type: string
Description: The name of the operation resource to be cancelled.
Location: path
Pattern: ^projects/[^/]+/apps/[^/]+/releases/[^/]+/operations/[^/]+$
Required: Yes
▼ ▲ firebaseappdistribution.projects.apps.releases.operations.delete
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Flat Path: v1/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/operations/{operationsId}
Parameter Order: name
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/apps/[^/]+/releases/[^/]+/operations/[^/]+$
Required: Yes
Description: The name of the operation resource to be deleted.
▼ ▲ firebaseappdistribution.projects.apps.releases.feedbackReports.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/feedbackReports/{feedbackReportsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/apps/[^/]+/releases/[^/]+/feedbackReports/[^/]+$
Location: path
Required: Yes
Description: Required. The name of the feedback report to retrieve. Format: projects/{project_number}/apps/{app}/releases/{release}/feedbackReports/{feedback_report}
Type: string
HTTP Method: GET
Description: Gets a feedback report.
▼ ▲ firebaseappdistribution.projects.apps.releases.feedbackReports.delete
HTTP Method: DELETE
Parameter Order: name
Description: Deletes a feedback report.
Flat Path: v1/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/feedbackReports/{feedbackReportsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameters:
name
Type: string
Description: Required. The name of the feedback report to delete. Format: projects/{project_number}/apps/{app}/releases/{release}/feedbackReports/{feedback_report}
Location: path
Required: Yes
Pattern: ^projects/[^/]+/apps/[^/]+/releases/[^/]+/feedbackReports/[^/]+$
▼ ▲ firebaseappdistribution.projects.apps.releases.feedbackReports.list
Flat Path: v1/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/feedbackReports
HTTP Method: GET
Parameters:
pageSize
Format: int32
Type: integer
Location: query
Description: The maximum number of feedback reports to return. The service may return fewer than this value. The valid range is [1-100]; If unspecified (0), at most 25 feedback reports are returned. Values above 100 are coerced to 100.
parent
Type: string
Required: Yes
Location: path
Description: Required. The name of the release resource, which is the parent of the feedback report resources. Format: `projects/{project_number}/apps/{app}/releases/{release}`
Pattern: ^projects/[^/]+/apps/[^/]+/releases/[^/]+$
orderBy
Type: string
Location: query
Description: The fields used to order releases. Supported fields: - `createTime` - `tester` To specify descending order for a field, append a "desc" suffix, for example, `createTime desc`. If this parameter is not set, releases are ordered by `createTime` in descending order.
pageToken
Location: query
Type: string
Description: A page token, received from a previous `ListFeedbackReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFeedbackReports` must match the call that provided the page token.
filter
Location: query
Description: The expression to filter feedback reports listed in the response. To learn more about filtering, refer to [Google's AIP-160 standard](http://aip.dev/160). Supported fields: - `tester` - `createTime` supports `<`, `<=`, `>` and `>=`, and expects an RFC-3339 formatted string Example: - `createTime <= "2023-03-10T00:00:00+04:00"` - `tester = "projects/-/testers/*@example.com"`
Type: string
Parameter Order: parent
Description: Lists feedback reports. By default, sorts by `createTime` in descending order.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/feedbackReports
▼ ▲ firebaseappdistribution.projects.groups.patch
Parameters:
name
Description: The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
Pattern: ^projects/[^/]+/groups/[^/]+$
Location: path
Type: string
Required: Yes
updateMask
Description: The list of fields to update.
Type: string
Format: google-fieldmask
Location: query
Parameter Order: name
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/groups/{groupsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Update a group.
HTTP Method: PATCH
▼ ▲ firebaseappdistribution.projects.groups.batchLeave
Path: v1/{+group}:batchLeave
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
group
Required: Yes
Pattern: ^projects/[^/]+/groups/[^/]+$
Location: path
Description: Required. The name of the group resource from which testers are removed. Format: `projects/{project_number}/groups/{group_alias}`
Type: string
Parameter Order: group
HTTP Method: POST
Description: Batch removed members from a group. The testers will lose access to all releases that the groups have access to.
Flat Path: v1/projects/{projectsId}/groups/{groupsId}:batchLeave
▼ ▲ firebaseappdistribution.projects.groups.delete
Description: Delete a group.
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/groups/[^/]+$
Type: string
Location: path
Description: Required. The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/projects/{projectsId}/groups/{groupsId}
Path: v1/{+name}
▼ ▲ firebaseappdistribution.projects.groups.batchJoin
Path: v1/{+group}:batchJoin
Parameters:
group
Pattern: ^projects/[^/]+/groups/[^/]+$
Required: Yes
Location: path
Description: Required. The name of the group resource to which testers are added. Format: `projects/{project_number}/groups/{group_alias}`
Type: string
Description: Batch adds members to a group. The testers will gain access to all releases that the groups have access to.
Parameter Order: group
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/groups/{groupsId}:batchJoin
HTTP Method: POST
▼ ▲ firebaseappdistribution.projects.groups.get
Parameters:
name
Pattern: ^projects/[^/]+/groups/[^/]+$
Description: Required. The name of the group resource to retrieve. Format: `projects/{project_number}/groups/{group_alias}`
Location: path
Type: string
Required: Yes
Parameter Order: name
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/groups/{groupsId}
Description: Get a group.
▼ ▲ firebaseappdistribution.projects.groups.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
groupId
Description: Optional. The "alias" to use for the group, which will become the final component of the group's resource name. This value must be unique per project. The field is named `groupId` to comply with AIP guidance for user-specified IDs. This value should be 4-63 characters, and valid characters are `/a-z-/`. If not set, it will be generated based on the display name.
Type: string
Location: query
parent
Type: string
Description: Required. The name of the project resource, which is the parent of the group resource. Format: `projects/{project_number}`
Pattern: ^projects/[^/]+$
Location: path
Required: Yes
Description: Create a group.
Parameter Order: parent
Path: v1/{+parent}/groups
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/groups
▼ ▲ firebaseappdistribution.projects.groups.list
Description: List groups.
Parameters:
parent
Required: Yes
Location: path
Description: Required. The name of the project resource, which is the parent of the group resources. Format: `projects/{project_number}`
Type: string
Pattern: ^projects/[^/]+$
pageToken
Location: query
Type: string
Description: Optional. A page token, received from a previous `ListGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGroups` must match the call that provided the page token.
pageSize
Type: integer
Location: query
Format: int32
Description: Optional. The maximum number of groups to return. The service may return fewer than this value. The valid range is [1-100]; If unspecified (0), at most 25 groups are returned. Values above 100 are coerced to 100.
Path: v1/{+parent}/groups
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/groups
Parameter Order: parent