Firebase App Distribution API . projects . groups

batchJoin(group, body=None, x__xgafv=None)

Batch adds members to a group. The testers will gain access to all releases that the groups have access to.

Args:
  group: string, Required. The name of the group resource to which testers are added. Format: `projects/{project_number}/groups/{group_alias}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The request message for `BatchJoinGroup`
  "createMissingTesters": True or False, # Indicates whether to create tester resources based on `emails` if they don't exist yet.
  "emails": [ # Required. The emails of the testers to be added to the group. 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:

    { # A 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); }
}

batchLeave(group, body=None, x__xgafv=None)

Batch removed members from a group. The testers will lose access to all releases that the groups have access to.

Args:
  group: string, Required. The name of the group resource from which testers are removed. Format: `projects/{project_number}/groups/{group_alias}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for `BatchLeaveGroup`
  "emails": [ # Required. The email addresses of the testers to be removed from the group. A maximum of 999 and a minimum of 1 testers can be removed 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:

    { # A 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); }
}

close()

Close httplib2 connections.

create(parent, body=None, groupId=None, x__xgafv=None)

Create a group.

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

{ # A group which can contain testers. A group can be invited to test apps in a Firebase project.
  "displayName": "A String", # Required. The display name of the group.
  "inviteLinkCount": 42, # Output only. The number of invite links for this group.
  "name": "A String", # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
  "releaseCount": 42, # Output only. The number of releases this group is permitted to access.
  "testerCount": 42, # Output only. The number of testers who are members of this group.
}

  groupId: string, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A group which can contain testers. A group can be invited to test apps in a Firebase project.
  "displayName": "A String", # Required. The display name of the group.
  "inviteLinkCount": 42, # Output only. The number of invite links for this group.
  "name": "A String", # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
  "releaseCount": 42, # Output only. The number of releases this group is permitted to access.
  "testerCount": 42, # Output only. The number of testers who are members of this group.
}

delete(name, x__xgafv=None)

Delete a group.

Args:
  name: string, Required. The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A 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); }
}

get(name, x__xgafv=None)

Get a group.

Args:
  name: string, Required. The name of the group resource to retrieve. Format: `projects/{project_number}/groups/{group_alias}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A group which can contain testers. A group can be invited to test apps in a Firebase project.
  "displayName": "A String", # Required. The display name of the group.
  "inviteLinkCount": 42, # Output only. The number of invite links for this group.
  "name": "A String", # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
  "releaseCount": 42, # Output only. The number of releases this group is permitted to access.
  "testerCount": 42, # Output only. The number of testers who are members of this group.
}

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

List groups.

Args:
  parent: string, Required. The name of the project resource, which is the parent of the group resources. Format: `projects/{project_number}` (required)
  pageSize: integer, Optional. The maximum number of groups to return. The service may return fewer than this value. The valid range is [1-1000]; If unspecified (0), at most 25 groups are returned. Values above 1000 are coerced to 1000.
  pageToken: string, 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.
  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 `ListGroups`.
  "groups": [ # The groups listed.
    { # A group which can contain testers. A group can be invited to test apps in a Firebase project.
      "displayName": "A String", # Required. The display name of the group.
      "inviteLinkCount": 42, # Output only. The number of invite links for this group.
      "name": "A String", # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
      "releaseCount": 42, # Output only. The number of releases this group is permitted to access.
      "testerCount": 42, # Output only. The number of testers who are members of this group.
    },
  ],
  "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.
}

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 group.

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

{ # A group which can contain testers. A group can be invited to test apps in a Firebase project.
  "displayName": "A String", # Required. The display name of the group.
  "inviteLinkCount": 42, # Output only. The number of invite links for this group.
  "name": "A String", # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
  "releaseCount": 42, # Output only. The number of releases this group is permitted to access.
  "testerCount": 42, # Output only. The number of testers who are members of this group.
}

  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 group which can contain testers. A group can be invited to test apps in a Firebase project.
  "displayName": "A String", # Required. The display name of the group.
  "inviteLinkCount": 42, # Output only. The number of invite links for this group.
  "name": "A String", # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
  "releaseCount": 42, # Output only. The number of releases this group is permitted to access.
  "testerCount": 42, # Output only. The number of testers who are members of this group.
}