Method: projects.locations.glossaries.list

Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist.

HTTP request

GET https://translation.googleapis.com/v3/{parent=projects/*/locations/*}/glossaries

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the project from which to list all of the glossaries.

Authorization requires the following IAM permission on the specified resource parent:

  • cloudtranslate.glossaries.list

Query parameters

Parameters
pageSize

integer

Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default.

pageToken

string

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 glossaries.list method. The first page is returned if pageTokenis empty or missing.

filter

string

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.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for glossaries.list.

JSON representation
{
  "glossaries": [
    {
      object (Glossary)
    }
  ],
  "nextPageToken": string
}
Fields
glossaries[]

object (Glossary)

The list of glossaries for a project.

nextPageToken

string

A token to retrieve a page of results. Pass this value in the [ListGlossariesRequest.page_token] field in the subsequent call to glossaries.list method to retrieve the next page of results.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-translation
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.