GoogleApi.APIKeys.V2.Api.Keys (google_api_api_keys v0.2.1) View Source

API calls for all endpoints tagged Keys.

Link to this section Summary

Functions

Find the parent project and resource name of the API key that matches the key string in the request. If the API key has been purged, resource name will not be set. The service account must have the apikeys.keys.lookup permission on the parent project.

Link to this section Functions

Link to this function

apikeys_keys_lookup_key(connection, optional_params \\ [], opts \\ [])

View Source

Specs

apikeys_keys_lookup_key(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.APIKeys.V2.Model.V2LookupKeyResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Find the parent project and resource name of the API key that matches the key string in the request. If the API key has been purged, resource name will not be set. The service account must have the apikeys.keys.lookup permission on the parent project.

Parameters

  • connection (type: GoogleApi.APIKeys.V2.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :keyString (type: String.t) - Required. Finds the project that owns the key string value.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.APIKeys.V2.Model.V2LookupKeyResponse{}} on success
  • {:error, info} on failure