2024-10-29
▼ ▲ translate.projects.translateText
Path : v3beta1/{+parent}:translateText
Flat Path : v3beta1/projects/{projectsId}:translateText
HTTP Method : POST
Parameters :
parent
Description : Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Translates input text and returns translated text.
▼ ▲ translate.projects.detectLanguage
Path : v3beta1/{+parent}:detectLanguage
Flat Path : v3beta1/projects/{projectsId}:detectLanguage
HTTP Method : POST
Parameters :
parent
Description : Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}/locations/{location-id}` or `projects/{project-number-or-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Detects the language of text within a request.
▼ ▲ translate.projects.getSupportedLanguages
Path : v3beta1/{+parent}/supportedLanguages
Flat Path : v3beta1/projects/{projectsId}/supportedLanguages
HTTP Method : GET
Parameters :
parent
Description : Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for AutoML models. Only models within the same region (have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
displayLanguageCode
Description : Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response.
Location : query
Type : string
model
Description : Optional. Get supported languages of this model. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, Returns languages supported by the specified model. If missing, we get supported languages of Google general NMT model.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Returns a list of supported languages for translation.
▼ ▲ translate.projects.locations.list
Path : v3beta1/{+name}/locations
Flat Path : v3beta1/projects/{projectsId}/locations
HTTP Method : GET
Parameters :
name
Description : The resource that owns the locations collection, if applicable.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
pageSize
Description : The maximum number of results to return. If not set, the service selects a default.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location : query
Type : string
Parameter Order : name
Scopes :
Description : Lists information about the supported locations for this service.
▼ ▲ translate.projects.locations.get
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}
HTTP Method : GET
Parameters :
name
Description : Resource name for the location.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Gets information about a location.
▼ ▲ translate.projects.locations.translateText
Path : v3beta1/{+parent}:translateText
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}:translateText
HTTP Method : POST
Parameters :
parent
Description : Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Translates input text and returns translated text.
▼ ▲ translate.projects.locations.detectLanguage
Path : v3beta1/{+parent}:detectLanguage
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}:detectLanguage
HTTP Method : POST
Parameters :
parent
Description : Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}/locations/{location-id}` or `projects/{project-number-or-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Detects the language of text within a request.
▼ ▲ translate.projects.locations.getSupportedLanguages
Path : v3beta1/{+parent}/supportedLanguages
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/supportedLanguages
HTTP Method : GET
Parameters :
parent
Description : Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for AutoML models. Only models within the same region (have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
displayLanguageCode
Description : Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response.
Location : query
Type : string
model
Description : Optional. Get supported languages of this model. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, Returns languages supported by the specified model. If missing, we get supported languages of Google general NMT model.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Returns a list of supported languages for translation.
▼ ▲ translate.projects.locations.translateDocument
Path : v3beta1/{+parent}:translateDocument
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}:translateDocument
HTTP Method : POST
Parameters :
parent
Description : Required. Location to make a regional call. Format: `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global`. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have the same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Translates documents in synchronous mode.
▼ ▲ translate.projects.locations.batchTranslateText
Path : v3beta1/{+parent}:batchTranslateText
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}:batchTranslateText
HTTP Method : POST
Parameters :
parent
Description : Required. Location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}/locations/{location-id}`. The `global` location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Translates a large volume of text in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location. This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.
▼ ▲ translate.projects.locations.batchTranslateDocument
Path : v3beta1/{+parent}:batchTranslateDocument
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}:batchTranslateDocument
HTTP Method : POST
Parameters :
parent
Description : Required. Location to make a regional call. Format: `projects/{project-number-or-id}/locations/{location-id}`. The `global` location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Translates a large volume of document in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location. This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.
▼ ▲ translate.projects.locations.operations.list
Path : v3beta1/{+name}/operations
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes :
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ translate.projects.locations.operations.get
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ translate.projects.locations.operations.delete
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
▼ ▲ translate.projects.locations.operations.cancel
Path : v3beta1/{+name}:cancel
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
▼ ▲ translate.projects.locations.operations.wait
Path : v3beta1/{+name}:wait
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
▼ ▲ translate.projects.locations.glossaries.create
Path : v3beta1/{+parent}/glossaries
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/glossaries
HTTP Method : POST
Parameters :
parent
Description : Required. The project name.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist.
▼ ▲ translate.projects.locations.glossaries.list
Path : v3beta1/{+parent}/glossaries
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/glossaries
HTTP Method : GET
Parameters :
parent
Description : Required. The name of the project from which to list all of the glossaries.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossariesResponse.next_page_token] returned from the previous call to `ListGlossaries` method. The first page is returned if `page_token`is empty or missing.
Location : query
Type : string
filter
Description : Optional. Filter specifying constraints of a list operation. Specify the constraint by the format of "key=value", where key must be "src" or "tgt", and the value must be a valid language code. For multiple restrictions, concatenate them by "AND" (uppercase only), such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used here, which means using 'en-US' and 'en' can lead to different results, which depends on the language code you used when you create the glossary. For the unidirectional glossaries, the "src" and "tgt" add restrictions on the source and target language code separately. For the equivalent term set glossaries, the "src" and/or "tgt" add restrictions on the term set. For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional glossaries which exactly match the source language code as "en-US" and the target language code "zh-CN", but all equivalent term set glossaries which contain "en-US" and "zh-CN" in their language set will be picked. If missing, no filtering is performed.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist.
▼ ▲ translate.projects.locations.glossaries.get
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the glossary to retrieve.
Pattern : ^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist.
▼ ▲ translate.projects.locations.glossaries.delete
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the glossary to delete.
Pattern : ^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist.
▼ ▲ translate.projects.translateText
Path : v3beta1/{+parent}:translateText
Flat Path : v3beta1/projects/{projectsId}:translateText
HTTP Method : POST
Parameters :
parent
Description : Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Translates input text and returns translated text.
▼ ▲ translate.projects.detectLanguage
Path : v3beta1/{+parent}:detectLanguage
Flat Path : v3beta1/projects/{projectsId}:detectLanguage
HTTP Method : POST
Parameters :
parent
Description : Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}/locations/{location-id}` or `projects/{project-number-or-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Detects the language of text within a request.
▼ ▲ translate.projects.getSupportedLanguages
Path : v3beta1/{+parent}/supportedLanguages
Flat Path : v3beta1/projects/{projectsId}/supportedLanguages
HTTP Method : GET
Parameters :
parent
Description : Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for AutoML models. Only models within the same region (have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
displayLanguageCode
Description : Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response.
Location : query
Type : string
model
Description : Optional. Get supported languages of this model. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, Returns languages supported by the specified model. If missing, we get supported languages of Google general NMT model.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Returns a list of supported languages for translation.
▼ ▲ translate.projects.locations.list
Path : v3beta1/{+name}/locations
Flat Path : v3beta1/projects/{projectsId}/locations
HTTP Method : GET
Parameters :
name
Description : The resource that owns the locations collection, if applicable.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
pageSize
Description : The maximum number of results to return. If not set, the service selects a default.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location : query
Type : string
Parameter Order : name
Scopes :
Description : Lists information about the supported locations for this service.
▼ ▲ translate.projects.locations.get
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}
HTTP Method : GET
Parameters :
name
Description : Resource name for the location.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Gets information about a location.
▼ ▲ translate.projects.locations.translateText
Path : v3beta1/{+parent}:translateText
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}:translateText
HTTP Method : POST
Parameters :
parent
Description : Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Translates input text and returns translated text.
▼ ▲ translate.projects.locations.detectLanguage
Path : v3beta1/{+parent}:detectLanguage
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}:detectLanguage
HTTP Method : POST
Parameters :
parent
Description : Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}/locations/{location-id}` or `projects/{project-number-or-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Detects the language of text within a request.
▼ ▲ translate.projects.locations.getSupportedLanguages
Path : v3beta1/{+parent}/supportedLanguages
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/supportedLanguages
HTTP Method : GET
Parameters :
parent
Description : Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for AutoML models. Only models within the same region (have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
displayLanguageCode
Description : Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response.
Location : query
Type : string
model
Description : Optional. Get supported languages of this model. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, Returns languages supported by the specified model. If missing, we get supported languages of Google general NMT model.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Returns a list of supported languages for translation.
▼ ▲ translate.projects.locations.translateDocument
Path : v3beta1/{+parent}:translateDocument
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}:translateDocument
HTTP Method : POST
Parameters :
parent
Description : Required. Location to make a regional call. Format: `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global`. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have the same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Translates documents in synchronous mode.
▼ ▲ translate.projects.locations.batchTranslateText
Path : v3beta1/{+parent}:batchTranslateText
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}:batchTranslateText
HTTP Method : POST
Parameters :
parent
Description : Required. Location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}/locations/{location-id}`. The `global` location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Translates a large volume of text in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location. This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.
▼ ▲ translate.projects.locations.batchTranslateDocument
Path : v3beta1/{+parent}:batchTranslateDocument
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}:batchTranslateDocument
HTTP Method : POST
Parameters :
parent
Description : Required. Location to make a regional call. Format: `projects/{project-number-or-id}/locations/{location-id}`. The `global` location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Translates a large volume of document in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location. This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.
▼ ▲ translate.projects.locations.operations.list
Path : v3beta1/{+name}/operations
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes :
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ translate.projects.locations.operations.get
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ translate.projects.locations.operations.delete
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
▼ ▲ translate.projects.locations.operations.cancel
Path : v3beta1/{+name}:cancel
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
▼ ▲ translate.projects.locations.operations.wait
Path : v3beta1/{+name}:wait
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
▼ ▲ translate.projects.locations.glossaries.create
Path : v3beta1/{+parent}/glossaries
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/glossaries
HTTP Method : POST
Parameters :
parent
Description : Required. The project name.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist.
▼ ▲ translate.projects.locations.glossaries.list
Path : v3beta1/{+parent}/glossaries
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/glossaries
HTTP Method : GET
Parameters :
parent
Description : Required. The name of the project from which to list all of the glossaries.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossariesResponse.next_page_token] returned from the previous call to `ListGlossaries` method. The first page is returned if `page_token`is empty or missing.
Location : query
Type : string
filter
Description : Optional. Filter specifying constraints of a list operation. Specify the constraint by the format of "key=value", where key must be "src" or "tgt", and the value must be a valid language code. For multiple restrictions, concatenate them by "AND" (uppercase only), such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used here, which means using 'en-US' and 'en' can lead to different results, which depends on the language code you used when you create the glossary. For the unidirectional glossaries, the "src" and "tgt" add restrictions on the source and target language code separately. For the equivalent term set glossaries, the "src" and/or "tgt" add restrictions on the term set. For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional glossaries which exactly match the source language code as "en-US" and the target language code "zh-CN", but all equivalent term set glossaries which contain "en-US" and "zh-CN" in their language set will be picked. If missing, no filtering is performed.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist.
▼ ▲ translate.projects.locations.glossaries.get
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the glossary to retrieve.
Pattern : ^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist.
▼ ▲ translate.projects.locations.glossaries.delete
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the glossary to delete.
Pattern : ^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist.