Sviluppo di applicazioni con la versione SAP BTP di ABAP SDK for Google Cloud

Questo documento fornisce informazioni e risorse utili per aiutarti a sviluppare applicazioni SAP utilizzando la versione SAP BTP dell'SDK ABAP per Google Cloud.

Questo documento è rivolto agli sviluppatori SAP ABAP.

Per un elenco completo delle librerie client fornite dall'edizione SAP BTP di ABAP SDK for Google Cloud, consulta Librerie client di ABAP SDK for Google Cloud.

Interazione con una sola finestra

Ogni API Google Cloud abilitata nell'ABAP SDK per Google Cloud è rappresentata da una classe ABAP contenuta nel pacchetto /GOOG/CLIENT. Una classe ABAP è composta da più metodi pubblici e ciascuno di questi metodi pubblici corrisponde a un metodo dell'API Google Cloud. Ogni metodo pubblico è inoltre costituito da parametri IMPORTING e parametri EXPORTING. Una classe ABAP contiene anche tipi di dati personalizzati, che possono essere utilizzati per creare e mappare i parametri IMPORTING e EXPORTING. Questi tipi di dati personalizzati vengono mappati alle definizioni dello schema dell'API.

Per ogni interazione con un'API Google Cloud di destinazione, la corrispondente classe ABAP funge da unico punto di interazione. Chiamiamo questo concetto Interazione singola finestra, che protegge da tutte le complessità sottostanti dell'interazione con un' API Google Cloud e presenta un'interfaccia semplificata. Questa interfaccia semplificata consente di concentrarsi sulle soluzioni aziendali in fase di sviluppo utilizzando l'SDK, senza preoccuparsi delle funzionalità dell'SDK sottostante.

Interazione con una sola finestra

Flusso di interazione

Per chiamare un metodo dell'API, hai il seguente flusso di interazione:

  1. Connettiti a un'API.
  2. Crea una richiesta di input utilizzando i tipi ABAP.
  3. Chiama un metodo dell'API.
  4. Analizza gli errori e le eccezioni.
  5. Leggi la risposta utilizzando i tipi ABAP.

Interazione con gli sviluppatori

Stub del client API

Una tipica classe stub client dell'API è costituita dalle seguenti sezioni:

  • I tipi ABAP che mappano agli schemi dell'API. Utilizzi i tipi ABAP per creare una richiesta di input e analizzare la risposta.
  • Le costanti e gli attributi per l'utilizzo interno o esterno.
  • I metodi dell'API per interagire con le risorse dell'API.

Struttura del corso

Funzionalità

L'SDK ABAP per Google Cloud include le seguenti funzionalità:

  • Comunicazione HTTP: l'SDK stabilisce la connessione HTTP con gli endpoint API.
  • Marshaling delle richieste: l'SDK converte i dati nei tipi ABAP in un payload JSON che viene inviato come corpo della richiesta.
  • Gestione di errori ed eccezioni: l'SDK gestisce i codici di ritorno e i messaggi di errore retitrati dall'API e genera eventuali eccezioni.
  • Unmarshalling della risposta: l'SDK reconverte il payload JSON nel corpo della risposta nei tipi ABAP corrispondenti.
  • Registrazione degli errori locali: l'SDK registra i messaggi di errore utilizzando il framework di logging.

Progettazione di API ed Explorer API di Google

Le API pubblicate da Google seguono un design orientato alle risorse. Per saperne di più sul design delle API di Google, consulta la guida alla progettazione delle API.

L'ABAP SDK per Google Cloud consente l'integrazione con le API basate su REST pubblicate da Google.

Explorer API di Google è uno strumento che consente di provare i metodi dell'API Google Cloud senza scrivere codice. Puoi utilizzare questo strumento per studiare le API e i parametri di input obbligatori che vuoi passare ai metodi ABAP corrispondenti.

Costruzioni di codice

Spiega i costrutti di codice che utilizzi per creare i programmi ABAP utilizzando l'ABAP SDK per Google Cloud.

Costruttore

Per prima cosa, devi creare un'istanza della classe API che vuoi utilizzare. Il costruttore di ogni classe API avrà uno schema simile a quello mostrato nell'esempio seguente:

    METHODS constructor
      IMPORTING
        !iv_key_name   TYPE /goog/keyname OPTIONAL "Google Cloud Key Name
        !iv_log_obj    TYPE balobj_d OPTIONAL      "Application log: Object name
        !iv_log_subobj TYPE balsubobj OPTIONAL.    "Application log: Subobject
      RAISING
        /goog/cx_sdk .                 "Exception Classes

Parametri di importazione

La tabella seguente illustra i parametri di importazione di un costruttore di metodi:

Nome parametro Tipo Obbligatorio/Facoltativo Descrizione
iv_key_name /GOOG/KEYNAME Obbligatorio Specifica la chiave client dalla configurazione che utilizzi per creare una connessione a Google Cloud. Per informazioni sulla configurazione della chiave client, vedi Autenticazione.
iv_log_object balobj_d Facoltativo Specifica l'oggetto log dell'applicazione, che utilizzi per memorizzare gli errori generati dall'SDK. Per informazioni sulla configurazione del logging, vedi Logging delle applicazioni.
iv_log_subobject balsubobj Facoltativo Specifica il sottooggetto del log dell'applicazione, che utilizzi per memorizzare gli errori generati dall'SDK. Per informazioni sulla configurazione del logging, vedi Logging delle applicazioni.

Metodo API

Con la progettazione delle API Google Cloud orientata alle risorse, un metodo dell'API è un'azione che può essere eseguita su una risorsa pubblicata dall'API.

Ad esempio, se Topics è una risorsa pubblicata dall'API Pub/Sub, topics.get è un metodo API che rappresenta un'azione sulla risorsa Topics per recuperare la configurazione di un argomento.

Per mappare un metodo di classe ABAP a un metodo dell'API, puoi fare riferimento alla descrizione del metodo che segue il pattern:<resource>.<method_verb>.

Ad esempio, la descrizione del metodo per un metodo Pub/Sub è pubsub.projects.topics.get.

  • projects.topics: il nome della risorsa.
  • get: l'azione del metodo.

Descrizione del metodo dell&#39;interfaccia utente SAP

Il nome di un metodo ABAP mappato a un'azione API segue il pattern:<method_verb>_<resource>.

Ad esempio, un nome di metodo ABAP per Pub/Sub è: GET_TOPICS

  • GET: l'azione del metodo.
  • TOPICS: il nome della risorsa.

Un metodo ABAP è costituito dalle seguenti sezioni che mappano ai metodi dell'API REST:

Nome metodo

Parametri di importazione

Un metodo API può avere i seguenti parametri di importazione. Questi parametri sono facoltativi e puoi passarli in base ai requisiti di un metodo dell'API che devi utilizzare.

Nome parametro Tipo Categoria Descrizione

iv_q_NAME

(0 a n)

 Stringa Parametri di query

I parametri di ricerca vengono aggiunti all'endpoint API dopo (?).

Vengono utilizzati per definire l'ordinamento, la paginazione o il filtro.

Potrebbero essere presenti da 0 a n parametri di ricerca.

iv_p_NAME

(0 a n)

 Stringa Parametri del percorso

I parametri del percorso fanno parte dell'endpoint.

Vengono utilizzati per indirizzare a risorse API REST specifiche.

Potrebbero essere presenti da 0 a n parametri di percorso.

is_input

(0 a 1)

TY_CODE (Tipo di corso)

 Parametri della struttura di input

I dati passati come corpo della richiesta possono essere mappati utilizzando la struttura di input.

L'API REST accetta il payload JSON come corpo della richiesta. Il parametro è un parametro completamente tipizzato che viene convertito in payload JSON per la classe dell'API e lo sviluppatore non è tenuto a lavorare con JSON.

Puoi fare riferimento ai tipi di classi disponibili per comprendere i tipi ABAP per la mappatura dei dati. Ad esempio, il tipo /GOOG/CL_PUBSUB_V1=>TY_041 corrisponde alla risorsa REST: Topic, che viene passata come payload JSON al metodo CREATE_TOPICS.

Un metodo può avere al massimo un parametro del corpo della richiesta. Alcuni metodi non hanno un corpo della richiesta.

Parametri di esportazione

Un metodo API supporta i seguenti parametri di esportazione:

Nome parametro Tipo Categoria Descrizione
es_raw dati Output non elaborato

Questo parametro contiene la risposta JSON (Error o Success) restituita dal metodo dell'API. Mappa questo parametro a una variabile di tipo String per ricevere la stringa di risposta JSON.

Se la risposta è di qualsiasi altro tipo, ad esempio xstring per l'output del file in /goog/cl_storage_v1->get_objects( ), il parametro restituisce un valore appropriato.

Utilizza questo parametro per scenari di risoluzione dei problemi avanzati o per scenari di API avanzati.
es_output TY_CODE (Tipo di corso) Struttura di output

La risposta JSON viene deserializzata nella struttura ABAP e restituita utilizzando questo parametro di esportazione con tipi.

Puoi utilizzarlo come metodo principale per leggere le risposte dell'API utilizzando i costrutti ABAP.
ev_ret_code I (numero intero) Codice di ritorno

Il codice di ritorno che puoi utilizzare per verificare se l'esecuzione del metodo API è riuscita a svolgere correttamente la sua funzionalità.

Per ulteriori informazioni, consulta Codici, errori ed eccezioni di ritorno dell'API.
ev_err_text Stringa Testo dell'errore

Se la chiamata al metodo non è andata a buon fine, questo parametro contiene il messaggio di errore che utilizzi per conoscere il motivo dell'errore.

Per ulteriori informazioni, consulta Codici di ritorno, errori ed eccezioni dell'API.
ev_err_resp
  • Tipo di errore = CHAR 60
  • Descrizione errore = STRINGA
 Risposta di errore

Il parametro fornisce informazioni aggiuntive sull'errore.

Per ulteriori informazioni, consulta Codici, errori ed eccezioni di ritorno dell'API.

Tipo di corso

Le API Google Cloud utilizzano JSON come formato principale per lo scambio di dati. L'ABAP SDK per Google Cloud fornisce tipi ABAP che mappano allo schema JSON previsto dalle API Google Cloud.

Questi tipi ABAP e i tipi di tabelle correlati sono disponibili come tipi di classe in ogni classe API fornita dall'SDK.

L'esempio seguente mostra il tipo di classe per la classe /GOOG/CL_PUBSUB_V1 dell'API Pub/Sub.

Tipo di corso

La descrizione del tipo di classe TY_041 in /GOOG/CL_PUBSUB_V1 si mappa alla risorsa REST Topic, che viene passata come payload JSON al metodo CREATE_TOPICS.

I commenti ABAP Doc vengono aggiunti a tutti i classi dell'API client. Quando utilizzi ABAP Development Tools per SAP NetWeaver (ADT) per lo sviluppo, questi commenti forniscono descrizioni dei tipi di classi.

Codici di ritorno, errori ed eccezioni dell'API

Se si verifica un errore durante la chiamata del metodo API della classe ABAP, l'SDK ABAP per Google Cloud trasmette le informazioni sull'errore al programma chiamante utilizzando i parametri di esportazione dell'SDK o sollevando eccezioni.

Nome della risposta restituita

Codice di ritorno e errori dell'API

Le API Google Cloud utilizzano un modello di errore che offre un'esperienza uniforme tra le diverse API. Quando un metodo dell'API Google Cloud viene chiamato dall'SDK, i seguenti parametri contengono il codice di ritorno e i messaggi dell'API:

Per controllare lo stato di una chiamata all'API, utilizza il metodo IS_SUCCESS. Puoi utilizzare il valore di ev_ret_code per determinare se una chiamata API è andata a buon fine o meno. In genere, quando ev_ret_code = 2XX, la chiamata al metodo è considerata riuscita. Per tutti gli altri valori, la chiamata al metodo viene considerata non riuscita.

IF lo_client->is_success( ev_ret_code ).
   "Success: Implement custom code
   ELSE
   "Handle the HTTP error status code
ENDIF.

Per alcune API di Google Maps Platform, se chiami un'API con input non validi, l'API restituisce un codice di stato di esito positivo HTTP 2XX con un messaggio di errore e uno stato di errore, anziché un codice di stato di errore HTTP (4XX o 5XX). Questo messaggio di errore e questo stato di errore nella risposta dell'API possono aiutarti a risolvere il problema e correggere gli input non validi.

Per queste API di Google Maps Platform, oltre al codice di ritorno ev_ret_code, controlla il messaggio di errore e lo stato di errore restituito nella risposta dell'API chiamando il metodo IS_STATUS_OK dopo la chiamata dell'API. Lo snippet seguente mostra un esempio di come utilizzare il metodo IS_STATUS_OK:

IF lo_client->is_status_ok( ).
  "Success: Implement custom code
  ELSE
  "Handle the HTTP error status code
ENDIF.

Il parametro es_err_resp fornisce ulteriori informazioni sull'errore. La tabella seguente illustra i campi del parametro es_err_resp.

Campo Valore
es_err_resp-error_description Messaggio di errore ricevuto dall'API. Questo valore corrisponde al parametro ev_error_text.
es_err_resp-error Descrizione dello stato HTTP restituito dal client HTTP SAP.

Gestire gli errori restituiti dalle API Google Cloud

Segui le indicazioni riportate di seguito per gestire gli errori restituiti dalle API Google Cloud:

  • Codici di errore comuni:per informazioni sugli errori comuni restituiti dalle API Google Cloud e sulla relativa causa, consulta i codici di errore.

  • Acquisisci un errore dettagliato: per acquisire informazioni dettagliate sugli errori con l'SDK ABAP per Google Cloud, utilizza il parametro di esportazione es_raw dai metodi della classe SDK e mappa questo parametro a una variabile di tipo String. Questa variabile contiene una risposta JSON contenente messaggi di errore dettagliati e violazioni specifiche riscontrate dalle API.

  • Visualizza l'errore dettagliato:per visualizzare informazioni dettagliate sull'errore, utilizza uno dei seguenti metodi:

    • Debug: visualizza i contenuti della variabile che contiene la risposta JSON nello strumento di debug ABAP per un'ulteriore analisi.

    • Interfaccia utente SAP: utilizza la classe ABAP cl_demo_output=>display( lv_response ) per la rappresentazione visiva dell'errore all'interno di un programma di report. Se utilizzi i metodi dell'API in un programma di report e l'esecuzione del programma è in modalità primo piano, utilizza la classe ABAP cl_demo_output=>display_json( lv_response ).

      Il seguente snippet di codice mostra come visualizzare la risposta dell'API in caso di errore: 

      DATA lv_response  TYPE string,
  TRY.
      lo_translate = NEW #( iv_key_name = 'DEMO_TRANSLATE' ).
      lo_translate->translate_translations
        EXPORTING
          is_input    = ls_input
        IMPORTING
          es_raw      = lv_response
          es_output   = ls_output
          ev_ret_code = lv_ret_code
          ev_err_text = lv_err_text
          es_err_resp = ls_err_resp.
      IF lo_translate->is_error( lv_ret_code ) = abap_true.
        " Display API response in case of an error
        cl_demo_output=>display_json( lv_response ).
      ENDIF.
    CATCH /goog/cx_sdk INTO lo_exception.
      lv_err_text = lo_exception->get_text( ).
  ENDTRY.

  • Documentazione specifica dell'API:alcune API Google Cloud forniscono informazioni dettagliate sugli errori e indicazioni per la risoluzione dei problemi nella relativa documentazione. Per risolvere un errore relativo a un'API, consulta la documentazione specifica dell'API, ad esempio Pub/Sub, Document AI e Cloud Storage.

Eccezioni

Quando si verifica un errore imprevisto durante una chiamata al metodo dell'API, ad esempio una configurazione errata dell'SDK o un errore di comunicazione HTTP, l'SDK genera un'eccezione di classe di tipo /GOOG/CX_SDK. Devi intercettare questa eccezione nel codice e scrivere una logica di gestione degli errori appropriata.

Gestisci eccezione

Puoi ottenere il messaggio di errore chiamando il metodo get_text della classe dell'eccezione. Il messaggio di errore restituito dalla classe eccezione ha il seguente formato:

/GOOG/MSG : Return_Code - Error_Message

La causa dell'errore e i passaggi per la risoluzione dipendono dal valore di Return_Code.

Valore di Return_Code Causa dell'errore Risoluzione
461 L'ABAP SDK for Google Cloud utilizza un codice di ritorno speciale, 461, per informarti che un determinato passaggio di installazione e configurazione non è stato completato o è stato completato in modo errato. Error_Message corrispondente fornisce ulteriori dettagli sull'errore. Devi esaminare attentamente le istruzioni di installazione e configurazione dell'SDK e assicurarti che siano state eseguite correttamente.
Qualsiasi altro valore Questo codice di ritorno è l'ultimo errore HTTP della classe client HTTP SAP standard. Questo errore indica che SAP ICM ha riscontrato un problema di comunicazione durante la chiamata a un metodo dell'API REST Google. Devi esaminare attentamente le impostazioni di rete, firewall e SAP ICM e assicurarti che le configurazioni consentano le chiamate HTTP alle API Google Cloud.

Per i messaggi di errore tipici attivati nell'SDK ABAP per Google Cloud e la relativa risoluzione, consulta la guida alla risoluzione dei problemi.

Logging

La versione SAP BTP dell'SDK ABAP per Google Cloud ti consente di registrare i messaggi di errore utilizzando un framework di registrazione incorporato. L'oggetto log /GOOG/LOG_OBJECT e l'oggetto secondario /GOOG/LOG_SUBOBJECT sono forniti con l'SDK e possono essere utilizzati per creare la configurazione di log predefinita. Per ulteriori informazioni sulla creazione della configurazione dei log predefinita, consulta Configurare il logging.

Puoi visualizzare i log delle applicazioni utilizzando l'app Google SDK:Visualizzazione log delle applicazioni. Per ulteriori informazioni, consulta Visualizzare i log.

Mappatura dei tipi di dati

La tabella seguente fornisce un elenco completo dei valori type e format supportati dal servizio di rilevamento delle API di Google e il corrispondente tipo di dati ABAP.

Per ulteriori informazioni sui valori type e format supportati dal servizio di rilevamento delle API di Google, consulta Riepilogo di tipi e formati.

Digita il valore Formatta valore Tipo di dati ABAP Significato
tutte TYPE REF TO DATA La proprietà può essere di qualsiasi tipo. Definito dalla specifica JSON Schema.
matrice TIPO DI TABELLA CON CHIAVI NON UNIVERSE Un array JavaScript di valori. La proprietà items indica lo schema per i valori dell'array. Definito dalla specifica JSON Schema.
boolean ABAP_BOOLEAN Un valore booleano, "true" o "false". Definito dalla specifica JSON Schema.
integer int32 INT4 Un numero intero a 32 bit con segno. Ha un valore minimo di -2.147.483.648 e un valore massimo di 2.147.483.647 (inclusi).
integer uint32 INT4 Un numero intero non firmato a 32 bit. Ha un valore minimo di 0 e un valore massimo di 4.294.967.295 (incluso).
numero double /GOOG/NUM_DOUBLE (stringa) Un numero in virgola mobile IEEE 754 a 64 bit a precisione doppia.
numero float /GOOG/NUM_FLOAT (stringa) Un numero in virgola mobile IEEE 754 a precisione singola a 32 bit.
oggetto TIPI Un oggetto JavaScript. Definito dalla specifica JSON Schema.
string STRING Una stringa arbitraria. Definito dalla specifica JSON Schema.
string byte STRING Una stringa di byte con padding e codifica base64, codificata con un alfabeto sicuro per URL e nomi file (a volte indicato come "sicuro per il web" o "base64url"). Definito da RFC 4648.
string data STRING Una data RFC 3339 nel formato AAAA-MM-GG. Definito nella specifica JSON Schema.
string data-ora STRING Un timestamp RFC 3339 nel fuso orario UTC. Nel formato aaaa-MM-ggThh:mm:ss.SSSZ. La parte dei millisecondi (".SSS") è facoltativa. Definito nella specifica JSON Schema.
string google-dataora STRING Un timestamp RFC 3339 nel fuso orario UTC. nel formato aaaa-MM-ggThh:mm:ss.SSSZ. La parte dei millisecondi (".SSS") è facoltativa.
string google-duration STRING Una stringa termina con il suffisso "s" (che indica i secondi) ed è preceduta dal numero di secondi, con i nanosecondi espressi come frazioni di secondo. Il punto viene sempre utilizzato come virgola decimale, non come virgola.
string google-fieldmask STRING Una stringa in cui i nomi dei campi sono separati da una virgola. I nomi dei campi sono
rappresentati nelle convenzioni di denominazione Camel case.
string int64 STRING Un numero intero a 64 bit con segno. Ha un valore minimo di -9.223.372.036.854.775.808 e un valore massimo di 9.223.372.036.854.775.807 (inclusi).
string uint64 STRING Un numero intero senza segno a 64 bit. Ha un valore minimo di 0 e un valore massimo di (2^64)-1 (incluso).

Serializzazione e deserializzazione della richiesta e della risposta dell'API

Per impostazione predefinita, la versione SAP BTP dell'SDK ABAP per Google Cloud si occupa del marshalling e dello smarshalling delle richieste e delle risposte dell'API. Ogni classe ABAP per un'API Google Cloud ha tipi ABAP incorporati per formare l'input e l'output dei metodi. Per implementare la trasformazione personalizzata di richiesta e risposta, puoi utilizzare il punto di miglioramento con le definizioni di Business Add In (BAdI) di SAP fornite con l'SDK.

Implementare una trasformazione personalizzata

Lo spot di miglioramento /GOOG/ES_TRANSFORM_JSON, fornito con l'SDK, include le seguenti definizioni BAdI:

  • /GOOG/BADI_SERIALIZE_JSON: per implementare la logica di serializzazione personalizzata.
  • /GOOG/BADI_DESERIALIZE_JSON: per implementare la logica di deserializzazione personalizzata.

Puoi scrivere una logica di trasformazione specifica nelle implementazioni di questi BAdI. Le interfacce di questi BAdI hanno IV_METHOD_NAME come parametro di importazione. Utilizza questo parametro per separare la logica di trasformazione per ogni API e metodo API utilizzando i blocchi IF….ENDIF. Nel blocco di implementazione, imposta il parametro di esportazione EV_HANDLED su X.

Per implementare la trasformazione personalizzata:

  1. Per /GOOG/BADI_SERIALIZE_JSON, crea un'implementazione del miglioramento:

    • Per trasformare le richieste API, crea un'implementazione per BAdI /GOOG/BADI_SERIALIZE_JSON con una classe di implementazione.
    • Per trasformare le risposte dell'API, crea un'implementazione per BAdI /GOOG/BADI_DESERIALIZE_JSON con una classe di implementazione.

  2. Determina l'ID metodo del metodo dell'API per cui devi scrivere la trasformazione. L'ID metodo è la concatenazione di quanto segue:

    • Il valore della costante dell'attributo della classe C_SERVICE_NAME.
    • Il carattere #.
    • La descrizione del metodo della classe dell'API per cui devi implementare la trasformazione.

    Ad esempio, per scrivere trasformazioni per la pubblicazione di messaggi in un argomento Pub/Sub, l'ID metodo sarà: pubsub:v1#pubsub.projects.topics.publish

  3. Nell'implementazione del metodo del BAdI:

    1. Per l'ID metodo, scrivi la trasformazione personalizzata sotto un IF….ENDIF block.

    2. Imposta il parametro di esportazione EV_HANDLED su X.

      Se EV_HANDLED non è impostato su X, viene applicata la logica di marshalling e unmarshalling predefinita dell'SDK.

  4. Contrassegna il API State della classe di implementazione come Use System-Internally (Contract C1). La logica di trasformazione personalizzata viene invocata durante l'esecuzione. La logica di serializzazione e deserializzazione predefinita fornita con l'SDK verrà ignorata.

Spazio dei nomi

Tutto il codice fornito da Google viene inserito nello spazio dei nomi riservato /GOOG/.

Architetture di riferimento

Esplora l'SDK ABAP per Google Cloud con l'aiuto delle architetture di riferimento e scopri come l'SDK può portare innovazione al tuo panorama di applicazioni SAP. Puoi utilizzare l'SDK per eseguire l'integrazione con Vertex AI per funzionalità di AI e machine learning avanzate e con altri servizi Google Cloud come BigQuery, Pub/Sub, Cloud Storage e molti altri ancora. Per ulteriori informazioni, consulta le Architetture di riferimento per l'ABAP SDK per Google Cloud.

Assistenza

Se hai bisogno di aiuto per risolvere i problemi relativi all'SDK ABAP per Google Cloud, segui questi passaggi: