google_api_url_shortener v0.6.0 GoogleApi.UrlShortener.V1.Api.Url View Source

API calls for all endpoints tagged Url.

Link to this section Summary

Functions

urlshortener_url_get(connection, short_url, optional_params \\ [], opts \\ [])

Expands a short URL or gets creation time and analytics.

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

Creates a new short URL.

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

Retrieves a list of URLs shortened by a user.

Link to this section Functions

urlshortener_url_get(connection, short_url, optional_params \\ [], opts \\ [])

urlshortener_url_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.UrlShortener.V1.Model.Url.t()} | {:error, Tesla.Env.t()}

Expands a short URL or gets creation time and analytics.

Parameters

connection (type: GoogleApi.UrlShortener.V1.Connection.t) - Connection to server
short_url (type: String.t) - The short URL, including the protocol.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :projection (type: String.t) - Additional information to return.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.UrlShortener.V1.Model.Url{}} on success
{:error, info} on failure

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

urlshortener_url_insert(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.UrlShortener.V1.Model.Url.t()} | {:error, Tesla.Env.t()}

Creates a new short URL.

Parameters

connection (type: GoogleApi.UrlShortener.V1.Connection.t) - Connection to server
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :body (type: GoogleApi.UrlShortener.V1.Model.Url.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.UrlShortener.V1.Model.Url{}} on success
{:error, info} on failure

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

urlshortener_url_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.UrlShortener.V1.Model.UrlHistory.t()}
  | {:error, Tesla.Env.t()}

Retrieves a list of URLs shortened by a user.

Parameters

connection (type: GoogleApi.UrlShortener.V1.Connection.t) - Connection to server
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :projection (type: String.t) - Additional information to return.
- :"start-token" (type: String.t) - Token for requesting successive pages of results.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.UrlShortener.V1.Model.UrlHistory{}} on success
{:error, info} on failure