Firebase App Distribution API . projects . testers

Instance Methods

batchAdd(project, body=None, x__xgafv=None)

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.

batchRemove(project, body=None, x__xgafv=None)

Batch removes testers. If found, this call deletes testers for the specified emails. Returns all deleted testers.

close()

Close httplib2 connections.

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists testers and their resource ids.

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

Update a tester. If the testers joins a group they gain access to all releases that the group has access to.

Method Details

batchAdd(project, body=None, x__xgafv=None)
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.

Args:
  project: string, Required. The name of the project resource. Format: `projects/{project_number}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The Request message for batch adding testers
  "emails": [ # Required. The email addresses of the tester resources to create. A maximum of 999 and a minimum of 1 tester can be created in a batch.
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The Response message for `BatchAddTesters`.
  "testers": [ # The testers which are created and/or already exist
    { # A person that can be invited to test apps in a Firebase project.
      "displayName": "A String", # The name of the tester associated with the Google account used to accept the tester invitation.
      "groups": [ # The resource names of the groups this tester belongs to.
        "A String",
      ],
      "lastActivityTime": "A String", # Output only. The time the tester was last active. This is the most recent time the tester installed one of the apps. If they've never installed one or if the release no longer exists, this is the time the tester was added to the project.
      "name": "A String", # The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}`
    },
  ],
}
batchRemove(project, body=None, x__xgafv=None)
Batch removes testers. If found, this call deletes testers for the specified emails. Returns all deleted testers.

Args:
  project: string, Required. The name of the project resource. Format: `projects/{project_number}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The request message for `BatchRemoveTesters`.
  "emails": [ # Required. The email addresses of the tester resources to removed. A maximum of 999 and a minimum of 1 testers can be deleted in a batch.
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for `BatchRemoveTesters`
  "emails": [ # List of deleted tester emails
    "A String",
  ],
}
close()
Close httplib2 connections.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists testers and their resource ids.

Args:
  parent: string, Required. The name of the project resource, which is the parent of the tester resources. Format: `projects/{project_number}` (required)
  filter: string, 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"`
  pageSize: integer, 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.
  pageToken: string, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for `ListTesters`.
  "nextPageToken": "A String", # A short-lived token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "testers": [ # The testers listed.
    { # A person that can be invited to test apps in a Firebase project.
      "displayName": "A String", # The name of the tester associated with the Google account used to accept the tester invitation.
      "groups": [ # The resource names of the groups this tester belongs to.
        "A String",
      ],
      "lastActivityTime": "A String", # Output only. The time the tester was last active. This is the most recent time the tester installed one of the apps. If they've never installed one or if the release no longer exists, this is the time the tester was added to the project.
      "name": "A String", # The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}`
    },
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        
patch(name, body=None, updateMask=None, x__xgafv=None)
Update a tester. If the testers joins a group they gain access to all releases that the group has access to.

Args:
  name: string, The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A person that can be invited to test apps in a Firebase project.
  "displayName": "A String", # The name of the tester associated with the Google account used to accept the tester invitation.
  "groups": [ # The resource names of the groups this tester belongs to.
    "A String",
  ],
  "lastActivityTime": "A String", # Output only. The time the tester was last active. This is the most recent time the tester installed one of the apps. If they've never installed one or if the release no longer exists, this is the time the tester was added to the project.
  "name": "A String", # The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}`
}

  updateMask: string, The list of fields to update.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A person that can be invited to test apps in a Firebase project.
  "displayName": "A String", # The name of the tester associated with the Google account used to accept the tester invitation.
  "groups": [ # The resource names of the groups this tester belongs to.
    "A String",
  ],
  "lastActivityTime": "A String", # Output only. The time the tester was last active. This is the most recent time the tester installed one of the apps. If they've never installed one or if the release no longer exists, this is the time the tester was added to the project.
  "name": "A String", # The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}`
}