Class: Google::Apis::TranslateV2::TranslateService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/translate_v2/service.rb

Overview

Google Cloud Translation API

The Google Cloud Translation API lets websites and programs integrate with Google Translate programmatically.

Examples:

require 'google/apis/translate_v2'

Translate = Google::Apis::TranslateV2 # Alias the module
service = Translate::TranslateService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://translation.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ TranslateService

Returns a new instance of TranslateService.



49
50
51
52
53
54
 
# File 'lib/google/apis/translate_v2/service.rb', line 49

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, 'language/translate/',
        client_name: 'google-apis-translate_v2',
        client_version: Google::Apis::TranslateV2::GEM_VERSION)
  @batch_path = 'batch/translate'
end

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



41
42
43
 
# File 'lib/google/apis/translate_v2/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



47
48
49
 
# File 'lib/google/apis/translate_v2/service.rb', line 47

def quota_user
  @quota_user
end

Instance Method Details

#detect_detection_language(detect_language_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV2::ListDetectionsResponse

Detects the language of text within a request.

Parameters:

  • detect_language_request_object (Google::Apis::TranslateV2::DetectLanguageRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/apis/translate_v2/service.rb', line 76

def detect_detection_language(detect_language_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/detect', options)
  command.request_representation = Google::Apis::TranslateV2::DetectLanguageRequest::Representation
  command.request_object = detect_language_request_object
  command.response_representation = Google::Apis::TranslateV2::ListDetectionsResponse::Representation
  command.response_class = Google::Apis::TranslateV2::ListDetectionsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_detections(q, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV2::ListDetectionsResponse

Detects the language of text within a request.

Parameters:

  • q (Array<String>, String) —

    The input text upon which to perform language detection. Repeat this parameter to perform language detection on multiple text inputs.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



109
110
111
112
113
114
115
116
117
 
# File 'lib/google/apis/translate_v2/service.rb', line 109

def list_detections(q, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/detect', options)
  command.response_representation = Google::Apis::TranslateV2::ListDetectionsResponse::Representation
  command.response_class = Google::Apis::TranslateV2::ListDetectionsResponse
  command.query['q'] = q unless q.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_languages(model: nil, target: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV2::ListLanguagesResponse

Returns a list of supported languages for translation.

Parameters:

  • model (String) (defaults to: nil) —

    The model type for which supported languages should be returned.

  • target (String) (defaults to: nil) —

    The language to use to return localized, human readable names of supported languages.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



143
144
145
146
147
148
149
150
151
152
 
# File 'lib/google/apis/translate_v2/service.rb', line 143

def list_languages(model: nil, target: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/languages', options)
  command.response_representation = Google::Apis::TranslateV2::ListLanguagesResponse::Representation
  command.response_class = Google::Apis::TranslateV2::ListLanguagesResponse
  command.query['model'] = model unless model.nil?
  command.query['target'] = target unless target.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_translations(q, target, cid: nil, format: nil, model: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV2::ListTranslationsResponse

Translates input text, returning translated text.

Parameters:

  • q (Array<String>, String) —

    The input text to translate. Repeat this parameter to perform translation operations on multiple text inputs.

  • target (String) —

    The language to use for translation of the input text, set to one of the language codes listed in Language Support.

  • cid (Array<String>, String) (defaults to: nil) —

    The customization id for translate

  • format (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    The model type requested for this translation. Valid values are listed in public documentation.

  • source (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/google/apis/translate_v2/service.rb', line 192

def list_translations(q, target, cid: nil, format: nil, model: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2', options)
  command.response_representation = Google::Apis::TranslateV2::ListTranslationsResponse::Representation
  command.response_class = Google::Apis::TranslateV2::ListTranslationsResponse
  command.query['cid'] = cid unless cid.nil?
  command.query['format'] = format unless format.nil?
  command.query['model'] = model unless model.nil?
  command.query['q'] = q unless q.nil?
  command.query['source'] = source unless source.nil?
  command.query['target'] = target unless target.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#translate_translation_text(translate_text_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TranslateV2::ListTranslationsResponse

Translates input text, returning translated text.

Parameters:

  • translate_text_request_object (Google::Apis::TranslateV2::TranslateTextRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



227
228
229
230
231
232
233
234
235
236
 
# File 'lib/google/apis/translate_v2/service.rb', line 227

def translate_translation_text(translate_text_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2', options)
  command.request_representation = Google::Apis::TranslateV2::TranslateTextRequest::Representation
  command.request_object = translate_text_request_object
  command.response_representation = Google::Apis::TranslateV2::ListTranslationsResponse::Representation
  command.response_class = Google::Apis::TranslateV2::ListTranslationsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end