Firebase Management API . availableProjects

Instance Methods

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

Returns a list of [Google Cloud Platform (GCP) `Projects`]

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(pageToken=None, pageSize=None, x__xgafv=None)
Returns a list of [Google Cloud Platform (GCP) `Projects`]
(https://cloud.google.com/resource-manager/reference/rest/v1/projects)
that are available to have Firebase resources added to them.
<br>
<br>A GCP `Project` will only be returned if:
<ol>
  <li><p>The caller has sufficient
         [Google IAM](https://cloud.google.com/iam) permissions to call
         AddFirebase.</p></li>
  <li><p>The GCP `Project` is not already a FirebaseProject.</p></li>
  <li><p>The GCP `Project` is not in an Organization which has policies
         that prevent Firebase resources from being added.</p></li>
</ol>

Args:
  pageToken: string, Token returned from a previous call to `ListAvailableProjects`
indicating where in the set of GCP `Projects` to resume listing.
  pageSize: integer, The maximum number of GCP `Projects` to return in the response.
<br>
<br>The server may return fewer than this value at its discretion.
If no value is specified (or too large a value is specified), the server
will impose its own limit.
<br>
<br>This value cannot be negative.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token
        # is returned. If the string is empty, then this response is the last page of
        # results.
        # <br>
        # <br>This token can be used in a subsequent calls to `ListAvailableProjects`
        # to find the next group of GCP `Projects`.
        # <br>
        # <br>Page tokens are short-lived and should not be persisted.
    "projectInfo": [ # The list of GCP `Projects` which can have Firebase resources added to them.
      { # A reference to a Google Cloud Platform (GCP) `Project`.
        "displayName": "A String", # The user-assigned display name of the GCP `Project`, for example:
            # <code>My App</code>
        "locationId": "A String", # The ID of the project's default GCP resource location. The location is one
            # of the available
            # [GCP resource
            # locations](https://firebase.google.com/docs/projects/locations). <br> <br>
            # Not all projects will have this field populated. If it is not populated, it
            # means that the project does not yet have a default GCP resource location.
            # To set your project's default GCP resource location, call
            # [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you
            # add Firebase resources to your project.
        "project": "A String", # The resource name of the GCP `Project` to which Firebase resources can be
            # added, in the format:
            # <br><code>projects/<var>projectId</var></code>
      },
    ],
  }
list_next(previous_request, previous_response)
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.