View Source GoogleApi.Translate.V2.Api.Translations (google_api_translate v0.21.0)

API calls for all endpoints tagged Translations.

Summary

Functions

Link to this function

language_translations_list(connection, q, target, optional_params \\ [], opts \\ [])

View Source
@spec language_translations_list(
  Tesla.Env.client(),
  [String.t()],
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Translate.V2.Model.TranslationsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Translates input text, returning translated text.

Parameters

  • connection (type: GoogleApi.Translate.V2.Connection.t) - Connection to server
  • q (type: list(String.t)) - The input text to translate. Repeat this parameter to perform translation operations on multiple text inputs.
  • target (type: String.t) - The language to use for translation of the input text, set to one of the language codes listed in Language Support.
  • 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.
    • :bearer_token (type: String.t) - OAuth bearer token.
    • :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.
    • :pp (type: boolean()) - Pretty-print response.
    • :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. Overrides userIp if both are provided.
    • :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").
    • :cid (type: list(String.t)) - The customization id for translate
    • :format (type: String.t) - The format of the source text, in either HTML (default) or plain-text. A value of "html" indicates HTML and a value of "text" indicates plain-text.
    • :model (type: String.t) - The model type requested for this translation. Valid values are listed in public documentation.
    • :source (type: String.t) - The language of the source text, set to one of the language codes listed in Language Support. If the source language is not specified, the API will attempt to identify the source language automatically and return it within the response.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Translate.V2.Model.TranslationsListResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec language_translations_translate(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Translate.V2.Model.TranslationsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Translates input text, returning translated text.

Parameters

  • connection (type: GoogleApi.Translate.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.
    • :bearer_token (type: String.t) - OAuth bearer token.
    • :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.
    • :pp (type: boolean()) - Pretty-print response.
    • :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. Overrides userIp if both are provided.
    • :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").
    • :body (type: GoogleApi.Translate.V2.Model.TranslateTextRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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