Firebase Management API . projects . androidApps

Instance Methods

sha()

Returns the sha Resource.

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

Requests that a new AndroidApp be created.

get(name, x__xgafv=None)

Gets the AndroidApp identified by the specified resource name.

getConfig(name, x__xgafv=None)

Gets the configuration artifact associated with the specified

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

Lists each AndroidApp associated with the specified parent Project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

Updates the attributes of the AndroidApp identified by the specified

Method Details

create(parent, body=None, x__xgafv=None)
Requests that a new AndroidApp be created.
<br>
<br>The result of this call is an `Operation` which can be used to track
the provisioning process. The `Operation` is automatically deleted after
completion, so there is no need to call `DeleteOperation`.

Args:
  parent: string, The parent Project in which to create an App, in the format:
<br><code>projects/<var>projectId</var></code> (required)
  body: object, The request body.
    The object takes the form of:

{ # Details of a Firebase App for Android.
  "name": "A String", # The fully qualified resource name of the App, in the format:
      # <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code>
  "packageName": "A String", # The canonical package name of the Android App as would appear in the
      # Google Play Developer Console.
  "displayName": "A String", # The user-assigned display name of the App.
  "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App.
      # <br>
      # <br>This identifier should be treated as an opaque token, as the data
      # format is not specified.
  "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App.
}

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

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If `true`, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    },
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
get(name, x__xgafv=None)
Gets the AndroidApp identified by the specified resource name.

Args:
  name: string, The fully qualified resource name of the App, in the format:
<br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code>
<br>As an <var>appId</var> is a unique identifier, the Unique Resource
from Sub-Collection access pattern may be used here, in the format:
<br><code>projects/-/androidApps/<var>appId</var></code> (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Details of a Firebase App for Android.
    "name": "A String", # The fully qualified resource name of the App, in the format:
        # <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code>
    "packageName": "A String", # The canonical package name of the Android App as would appear in the
        # Google Play Developer Console.
    "displayName": "A String", # The user-assigned display name of the App.
    "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App.
        # <br>
        # <br>This identifier should be treated as an opaque token, as the data
        # format is not specified.
    "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App.
  }
getConfig(name, x__xgafv=None)
Gets the configuration artifact associated with the specified
AndroidApp.

Args:
  name: string, The resource name of the App configuration to download, in the format:
<br><code>projects/<var>projectId</var>/androidApps/<var>appId</var>/config</code>
<br>As an <var>appId</var> is a unique identifier, the Unique Resource
from Sub-Collection access pattern may be used here, in the format:
<br><code>projects/-/androidApps/<var>appId</var></code> (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration metadata of a single Firebase App for Android.
    "configFileContents": "A String", # The contents of the JSON configuration file.
    "configFilename": "A String", # The filename that the configuration artifact is typically saved as.
        # <br>For example: `google-services.json`
  }
list(parent, pageToken=None, pageSize=None, x__xgafv=None)
Lists each AndroidApp associated with the specified parent Project.
<br>
<br>The elements are returned in no particular order, but will be a
consistent view of the Apps when additional requests are made with a
`pageToken`.

Args:
  parent: string, The parent Project for which to list Apps, in the format:
<br><code>projects/<var>projectId</var></code> (required)
  pageToken: string, Token returned from a previous call to `ListAndroidApps` indicating where
in the set of Apps to resume listing.
  pageSize: integer, The maximum number of Apps to return in the response.
<br>
<br>The server may return fewer than this at its discretion.
If no value is specified (or too large a value is specified), then the
server will impose its own limit.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "apps": [ # List of each AndroidApp that is in the parent Firebase Project.
      { # Details of a Firebase App for Android.
        "name": "A String", # The fully qualified resource name of the App, in the format:
            # <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code>
        "packageName": "A String", # The canonical package name of the Android App as would appear in the
            # Google Play Developer Console.
        "displayName": "A String", # The user-assigned display name of the App.
        "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App.
            # <br>
            # <br>This identifier should be treated as an opaque token, as the data
            # format is not specified.
        "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App.
      },
    ],
    "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 call to `ListAndroidApps` to
        # find the next group of Apps.
        # <br>
        # <br>Page tokens are short-lived and should not be persisted.
  }
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.
    
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the attributes of the AndroidApp identified by the specified
resource name.

Args:
  name: string, The fully qualified resource name of the App, in the format:
<br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code> (required)
  body: object, The request body.
    The object takes the form of:

{ # Details of a Firebase App for Android.
  "name": "A String", # The fully qualified resource name of the App, in the format:
      # <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code>
  "packageName": "A String", # The canonical package name of the Android App as would appear in the
      # Google Play Developer Console.
  "displayName": "A String", # The user-assigned display name of the App.
  "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App.
      # <br>
      # <br>This identifier should be treated as an opaque token, as the data
      # format is not specified.
  "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App.
}

  updateMask: string, Specifies which fields to update.
<br>Note that the fields `name`, `appId`, `projectId`, and `packageName`
are all immutable.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Details of a Firebase App for Android.
    "name": "A String", # The fully qualified resource name of the App, in the format:
        # <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code>
    "packageName": "A String", # The canonical package name of the Android App as would appear in the
        # Google Play Developer Console.
    "displayName": "A String", # The user-assigned display name of the App.
    "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App.
        # <br>
        # <br>This identifier should be treated as an opaque token, as the data
        # format is not specified.
    "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App.
  }