Translate with glossary

This code sample can be used to translate glossary texts for an already configured glossary ID.

Make sure a glossary ID is created for the resource locations. For more information about preparing a glossary file, see Creating and using glossaries (Advanced).

For a comprehensive collection of code samples for the SAP BTP edition of ABAP SDK for Google Cloud, see the code sample repository on GitHub.

For a comprehensive collection of code samples for the on-premises or any cloud edition of ABAP SDK for Google Cloud, see the code samples repository on GitHub.

Code sample

SAP BTP edition

" --------------------------------------------------------------------
"  Copyright 2024 Google LLC                                         -
"                                                                    -
"  Licensed under the Apache License, Version 2.0 (the "License");   -
"  you may not use this file except in compliance with the License.  -
"  You may obtain a copy of the License at                           -
"      https://www.apache.org/licenses/LICENSE-2.0                   -
"  Unless required by applicable law or agreed to in writing,        -
"  software distributed under the License is distributed on an       -
"  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,      -
"  either express or implied.                                        -
"  See the License for the specific language governing permissions   -
"  and limitations under the License.                                -
" --------------------------------------------------------------------
CLASS zcl_cs_translate_with_glossary DEFINITION
  PUBLIC FINAL
  CREATE PUBLIC.

  PUBLIC SECTION.
    INTERFACES if_oo_adt_classrun.
ENDCLASS.



CLASS ZCL_CS_TRANSLATE_WITH_GLOSSARY IMPLEMENTATION.


  METHOD if_oo_adt_classrun~main.
    " Data Declarations
    DATA lv_p_projects_id  TYPE string.
    DATA lv_p_locations_id TYPE string.
    DATA ls_input          TYPE /goog/cl_translation_v3=>ty_050.
    DATA lo_exception      TYPE REF TO /goog/cx_sdk.

    TRY.

        " Open HTTP Connection
        " Pass the configured client key, TRANSLATE_DEMO is used as example, replace it with actual value
        DATA(lo_translate) = NEW /goog/cl_translation_v3( iv_key_name = 'TRANSLATE_DEMO' ).

        " Derive project id
        lv_p_projects_id   = lo_translate->gv_project_id.

        " Provide a location id, here 'us-central1' is uses as example, replace it with actual value
        lv_p_locations_id  = 'us-central1'.

        " Provide MIME type. The value used below is an example, replace it with actual value.
        ls_input-mime_type = 'text/plain'.

        " Target language code in BCP-47 format. The value used below is an example, replace it with actual value.
        ls_input-target_language_code = 'esES'.

        " Provide glossary id. The value used below is an example, replace it with actual value.
        ls_input-glossary_config-glossary = 'fi_glossary_en_to_es'.

        " Pass the text to be translated. The value used below is an example, replace it with actual value.
        ls_input-contents = VALUE #( ( |Debit amount carry forwarded for fiscal year| ) ).

        " Call the API
        lo_translate->translate_text_locations( EXPORTING iv_p_projects_id  = lv_p_projects_id
                                                          iv_p_locations_id = lv_p_locations_id
                                                          is_input          = ls_input
                                                IMPORTING es_output         = DATA(ls_output)
                                                          ev_ret_code       = DATA(lv_ret_code)
                                                          ev_err_text       = DATA(lv_err_text)
                                                          es_err_resp       = DATA(ls_err_resp) ).
        IF /goog/cl_http_client=>is_success( lv_ret_code ).
          " On successful call - print glossary translated text along with regular translation
          READ TABLE ls_output-glossary_translations INTO DATA(ls_glss_translation) INDEX 1.
          IF sy-subrc = 0.
            out->write( | Glossary Translated Text is: {  ls_glss_translation-translated_text }| ).
          ENDIF.

          READ TABLE ls_output-translations INTO DATA(ls_translation) INDEX 1.
          IF sy-subrc = 0.
            out->write( | Translated Text is: { ls_translation-translated_text } | ).
          ENDIF.
        ELSE.
          out->write( | Error occurred: { lv_err_text }| ).
        ENDIF.

        " Close HTTP Connection
        lo_translate->close( ).

      " Handle exception
      CATCH /goog/cx_sdk INTO DATA(lo_sdk_excp).
        lv_err_text = lo_sdk_excp->get_text( ).
        out->write( |Exception occurred: { lv_err_text } | ).
    ENDTRY.
  ENDMETHOD.
ENDCLASS.

On-premises or any cloud edition

**********************************************************************
*  Copyright 2023 Google LLC                                         *
*                                                                    *
*  Licensed under the Apache License, Version 2.0 (the "License");   *
*  you may not use this file except in compliance with the License.  *
*  You may obtain a copy of the License at                           *
*      https://www.apache.org/licenses/LICENSE-2.0                   *
*  Unless required by applicable law or agreed to in writing,        *
*  software distributed under the License is distributed on an       *
*  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,      *
*  either express or implied.                                        *
*  See the License for the specific language governing permissions   *
*  and limitations under the License.                                *
**********************************************************************

REPORT zr_translate_wth_glossary.

"Data Declarations
DATA: lv_p_projects_id  TYPE string,
      lv_p_locations_id TYPE string,
      ls_input          TYPE /goog/cl_translation_v3=>ty_050,
      lo_exception      TYPE REF TO /goog/cx_sdk.

TRY.

    "Open HTTP Connection
    "Pass the configured client key - TRANSLATE_DEMO is used an example, replace it with actual value.
    DATA(lo_translate) = NEW /goog/cl_translation_v3( iv_key_name = 'TRANSLATE_DEMO' ).

    "Populate relevant entries
    "Derive project id
    lv_p_projects_id   = lo_translate->gv_project_id.

    "Set a location id, 'us-central1' is used as example, replace it with actual value.
    lv_p_locations_id  = 'us-central1'.

    "Provide MIME type. The value passed below is an example, replace it with actual value
    ls_input-mime_type = 'text/plain'.

    "Target language code in BCP-47 format. The value passed below is an example, replace it with actual value
    ls_input-target_language_code = 'esES'.

    "Provide glossary id. The value passed below is an example, replace it with actual value
    ls_input-glossary_config-glossary = 'fi_glossary_en_to_es'.

    "Provide text to be translated. The value passed below is an example, replace it with actual value
    ls_input-contents = VALUE #( ( |Debit amount carry forwarded for fiscal year| ) ).

    "Call the API
    CALL METHOD lo_translate->translate_text_locations
      EXPORTING
        iv_p_projects_id  = lv_p_projects_id
        iv_p_locations_id = lv_p_locations_id
        is_input          = ls_input
      IMPORTING
        es_output         = DATA(ls_output)
        ev_ret_code       = DATA(lv_ret_code)
        ev_err_text       = DATA(lv_err_text)
        es_err_resp       = DATA(ls_err_resp).
    IF /goog/cl_http_client=>is_success( lv_ret_code ).
      "On successfull call - print glossary translated text along with regular traslation
      READ TABLE ls_output-glossary_translations INTO DATA(ls_glss_translation) INDEX 1.
      IF sy-subrc EQ 0.
        WRITE: / 'Glossary Translated Text is: ', ls_glss_translation-translated_text.
      ENDIF.

      READ TABLE ls_output-translations INTO DATA(ls_translation) INDEX 1.
      IF sy-subrc EQ 0.
        WRITE: / 'Translated Text is: ', ls_translation-translated_text.
      ENDIF.
    ELSE.
      MESSAGE lv_err_text TYPE 'E'.
    ENDIF.

    "Close HTTP Connection
    lo_translate->close( ).

  "Handle exception
  CATCH /goog/cx_sdk INTO lo_exception.
    MESSAGE lo_exception->get_text( ) TYPE 'E'.
ENDTRY.