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

API calls for all endpoints tagged Url.

Link to this section Summary

Functions

Expands a short URL or gets creation time and analytics

Retrieves a list of URLs shortened by a user

Link to this section Functions

Link to this function urlshortener_url_get(connection, short_url, opts \\ []) View Source
urlshortener_url_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.UrlShortener.V1.Model.Url.t()} | {:error, Tesla.Env.t()}

Expands a short URL or gets creation time and analytics.

Parameters

  • connection (GoogleApi.UrlShortener.V1.Connection): Connection to server
  • short_url (String.t): The short URL, including the protocol.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :projection (String.t): Additional information to return.

Returns

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

Link to this function urlshortener_url_insert(connection, opts \\ []) View Source
urlshortener_url_insert(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.UrlShortener.V1.Model.Url.t()} | {:error, Tesla.Env.t()}

Creates a new short URL.

Parameters

  • connection (GoogleApi.UrlShortener.V1.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (Url):

Returns

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

Link to this function urlshortener_url_list(connection, opts \\ []) View Source
urlshortener_url_list(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.UrlShortener.V1.Model.UrlHistory.t()}
  | {:error, Tesla.Env.t()}

Retrieves a list of URLs shortened by a user.

Parameters

  • connection (GoogleApi.UrlShortener.V1.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :projection (String.t): Additional information to return.
    • :start-token (String.t): Token for requesting successive pages of results.

Returns

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