Sviluppo di applicazioni con la versione SAP BTP dell'SDK ABAP per Google Cloud

Questo documento fornisce informazioni e risorse utili per 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 dalla versione SAP BTP dell'SDK ABAP per Google Cloud, vedi SDK ABAP per le librerie client di Google Cloud.

Finestra singola di interazione

Ogni API Google Cloud abilitata nell'SDK ABAP per Google Cloud è rappresentata da una classe ABAP, contenuta nel pacchetto /GOOG/CLIENT. Un corso ABAP è composto di più metodi pubblici e ognuno di questi metodi pubblici corrisponde Metodo API Google Cloud. Ogni metodo pubblico è costituito inoltre da Parametri IMPORTING e EXPORTING parametri. Un corso ABAP contiene anche tipi di dati personalizzati, che possono essere utilizzati per costruire e mappare IMPORTING e EXPORTING. Questi tipi di dati personalizzati sono mappati allo schema dell'API le tue definizioni.

Per ogni interazione con un'API Google Cloud di destinazione, viene restituito Gli ABAP sono l'unica classe punto di interazione. Questo concetto è chiamato finestra singola di interazione, che protegge tutte le complessità di fondo dell'interazione con un API Google Cloud e presenta un'interfaccia semplificata. Questa interfaccia semplificata di concentrarti sulle soluzioni aziendali che vengono sviluppate l'SDK, senza preoccuparti delle relative funzionalità.

Finestra singola di interazione

Flusso di interazione

Per chiamare un metodo API, devi utilizzare il seguente flusso di interazione:

  1. Connettersi a un'API.
  2. Crea una richiesta di input utilizzando i tipi ABAP.
  3. Chiama un metodo API.
  4. Analizza errori ed eccezioni.
  5. Leggi la risposta utilizzando i tipi ABAP.

Interazione dello sviluppatore

stub del client API

Una tipica classe stub del client API è composta dalle seguenti sezioni:

  • I tipi di ABAP mappati agli schemi dell'API. Puoi usare 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 API per interagire con le risorse API.

Struttura del corso

Funzionalità

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

  • Comunicazione HTTP: l'SDK stabilisce una connessione HTTP con gli endpoint API.
  • marshaling delle richieste: l'SDK converte i dati nei tipi ABAP in payload JSON che viene inviato come corpo della richiesta.
  • Gestione di errori ed eccezioni: l'SDK gestisce i codici restituiti e i messaggi di errore restituiti dall'API e solleva eventuali eccezioni.
  • Risposta di demarshalling: l'SDK riconverti il payload JSON nel il corpo della risposta ai tipi di ABAP corrispondenti.
  • Logging degli errori locale: l'SDK registra i messaggi di errore utilizzando il framework logging.

Progettazione delle API ed Explorer API di Google

Le API pubblicate da Google seguono la progettazione orientata alle risorse. Per scoprire di più su Per la progettazione delle API di Google, consulta la guida alla progettazione delle API.

L'SDK ABAP 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 relativi metodi ABAP corrispondenti.

Costrutti di codice

Spiega i costrutti del codice che utilizzi per creare i tuoi programmi ABAP usando l'SDK ABAP per Google Cloud.

Costruttore

Innanzitutto, crei l'istanza della classe API che vuoi utilizzare. Il costruttore ogni classe API avrebbe un pattern 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

Importazione dei parametri

La seguente tabella spiega 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 utilizzerai per creare una connessione a Google Cloud. Per informazioni su configurazione della chiave client, consulta Autenticazione.
iv_log_object balobj_d Facoltativo Specifica l'oggetto log dell'applicazione, che che utilizzi per archiviare gli errori generati dall'SDK. Per informazioni sulla configurazione del logging, vedi Logging delle applicazioni.
iv_log_subobject balsubobj Facoltativo Specifica l'oggetto secondario del log dell'applicazione, che che utilizzi per archiviare gli errori generati dall'SDK. Per informazioni sulla configurazione del logging, vedi Logging delle applicazioni.

Metodo API

Con la progettazione orientata alle risorse delle API di Google Cloud, un metodo API è eseguibile 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 la risorsa Topics per ottenere la configurazione di un argomento.

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

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

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

Descrizione del metodo SAP UI

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

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

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

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

Nome metodo

Importazione dei parametri

Un metodo API può avere i seguenti parametri di importazione. Questi parametri sono facoltativo e puoi passare i parametri in base ai requisiti del metodo API che devi utilizzare.

Nome parametro Tipo Categoria Descrizione

iv_q_NAME

(dal giorno 0 al giorno n)

 Stringa Parametri di query

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

Sono utilizzate per definire l'ordinamento, l'impaginazione o il filtro.

Potrebbero esserci da 0 a n parametri di ricerca.

iv_p_NAME

(dal giorno 0 al giorno n)

 Stringa Parametri del percorso

I parametri del percorso fanno parte dell'endpoint.

Vengono usate per puntare a risorse API REST specifiche.

Potrebbero esserci da 0 a n parametri del percorso.

is_input

(dal giorno 0 al giorno 1)

TY_CODE (Tipo di corso)

 Parametri 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 completamente digitato che viene convertito in payload JSON la classe API e lo sviluppatore non è tenuto a lavorare con JSON.

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

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

Esportazione dei parametri

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 (Errore o Operazione riuscita) restituito dal metodo API. Mappa questo parametro a un di tipo Stringa per ricevere la stringa di risposta JSON.

Nei casi in cui 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 o scenari avanzati relativi alle API.
es_output TY_CODE (Tipo di corso) Struttura dell'output

La risposta JSON viene deserializzata alla struttura ABAP e restituito utilizzando questo parametro di esportazione digitato.

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 restituito che puoi utilizzare per verificare se il metodo API l'esecuzione è stata in grado di eseguire correttamente la sua funzionalità.

Per ulteriori informazioni, consulta la sezione sulla restituzione delle API codici, errori ed eccezioni.
ev_err_text Stringa Testo dell'errore

Se la chiamata al metodo non è riuscita, questo parametro contiene il messaggio di errore che per conoscere il motivo dell'errore.

Per ulteriori informazioni, vedi Codici restituiti dell'API, errori ed eccezioni.
ev_err_resp
  • Tipo di errore = CHAR 60
  • Descrizione errore = STRING
 Risposta di errore

Il parametro fornisce informazioni aggiuntive sull'errore.

Per ulteriori informazioni, consulta la sezione sulla restituzione delle API codici, errori ed eccezioni.

Tipo di classe

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

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

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

Tipo di classe

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

ABAP Doc commenti vengono aggiunti a tutte le classi dell'API client. Mentre utilizzi gli strumenti di sviluppo ABAP per SAP NetWeaver (ADT) per lo sviluppo, questi commenti forniscono descrizioni dei tipi di corsi.

Codici restituiti dell'API, errori ed eccezioni

Se si verifica un errore quando viene chiamato il metodo API della classe ABAP, l'SDK ABAP per Google Cloud passa le informazioni sull'errore al programma chiamante utilizzando i parametri di esportazione dell'SDK o generando eccezioni.

Nome risposta restituita

Codice restituito ed errori dell'API

Le API Google Cloud utilizzano un modello di errore che offre una coerenza all'avanguardia in diverse API. Quando un metodo API Google Cloud viene chiamato dall'SDK, i seguenti parametri contengono il codice di ritorno dell'API e i messaggi:

Per controllare lo stato di una chiamata API, utilizza il metodo IS_SUCCESS. Puoi utilizzare lo valore ev_ret_code per determinare se la chiamata API è stata successo o meno. In generale, quando ev_ret_code = 2XX, la chiamata al metodo è hanno avuto successo. Per tutti gli altri valori, la chiamata al metodo viene considerata non riuscito.

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

Per alcune API Google Maps Platform, nel caso in cui chiami un'API con input non validi, l'API restituisce un codice di stato di operazione riuscita HTTP 2XX con un messaggio e lo stato di errore al posto di un codice di stato di errore HTTP (4XX o 5XX). Questo messaggio e stato di errore nell'API può aiutarti a risolvere il problema e a correggere gli input non validi.

Per queste API di Google Maps Platform, in aggiunta codice di reso ev_ret_code, controlla il messaggio e lo stato dell'errore restituiti nella risposta dell'API chiamando il metodo IS_STATUS_OK dopo la chiamata API. Il seguente snippet mostra un esempio di come puoi usa 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 informazioni aggiuntive sull'errore. La seguente tabella illustra i campi del parametro es_err_resp.

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

Gestire gli errori restituiti dalle API Google Cloud

Utilizza le seguenti indicazioni per gestire gli errori restituiti dal API Google Cloud:

  • Codici di errore comuni:per informazioni sugli errori comuni restituiti dal server. API Google Cloud e relativa causa, vedi i codici di errore.

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

  • Visualizza errore dettagliato:per visualizzare informazioni dettagliate sull'errore, utilizza una delle seguenti opzioni utilizza i seguenti metodi:

    • Debugger: visualizza i contenuti della variabile che contiene la risposta JSON all'interno dello strumento di debug ABAP per ulteriori analisi.

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

      Il seguente snippet di codice illustra 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 delle API: alcune API Google Cloud forniscono un errore dettagliato informazioni e suggerimenti per la risoluzione dei problemi all'interno del singolo individuo documentazione. Per risolvere un errore relativo a un'API, consulta la documentazione specifica per l'API, ad esempio, Pub/Sub, Document AI e Cloud Storage.

Eccezioni

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

Gestisci eccezione

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

/GOOG/MSG : Return_Code - Error_Message

La causa dell'errore e dei passaggi di risoluzione dipende dal valore di Return_Code.

Valore di Return_Code Causa dell'errore Risoluzione
461 L'SDK ABAP per Google Cloud utilizza un codice di ritorno speciale, 461, per comunicare che non è stato completato un passaggio specifico di installazione e configurazione o non è stata completata correttamente. Il campo Error_Message corrispondente fornisce ulteriori dettagli sull'errore. Devi esaminare attentamente l'installazione e la configurazione istruzioni per l'SDK e assicurati che siano eseguite correttamente.
Qualsiasi altro valore Questo codice restituito è l'ultimo errore HTTP della richiesta HTTP SAP standard Classe client. Questo errore indica che SAP ICM ha ricevuto una comunicazione un problema durante la chiamata a un metodo dell'API REST Google. Devi esaminare attentamente le impostazioni di rete, firewall, SAP ICM, e assicurati 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 loro risoluzione, consulta la guida alla risoluzione dei problemi.

Logging

La versione SAP BTP dell'SDK ABAP per Google Cloud consente di registrare i messaggi di errore utilizzando un framework di logging incorporato. Oggetto log /GOOG/LOG_OBJECT e oggetto secondario /GOOG/LOG_SUBOBJECT vengono spediti con l'SDK che puoi utilizzare per creando la configurazione predefinita dei log. Per ulteriori informazioni sulla creazione configurazione predefinita dei log, consulta Configurare il logging.

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

Mappatura dei tipi di dati

La tabella seguente fornisce un elenco completo di type e format supportati dal servizio di rilevamento delle API di Google e i valori corrispondenti Tipo di dati ABAP.

Per ulteriori informazioni su type e format supportati dal servizio di rilevamento delle API di Google, consulta Riepilogo tipo e formato.

Digita valore Valore formato Tipo di dati ABAP Significato
tutte DIGITA RIF. AI DATI La proprietà può essere di qualsiasi tipo. Definito dalla specifica dello schema JSON.
matrice TIPO DI TABELLA CON CHIAVE NON UNICHE Un array di valori JavaScript. La proprietà items indica lo schema per i valori dell'array. Definito dalla specifica dello schema JSON.
boolean ABAP_BOOLEAN Un valore booleano, può essere "true" o "false". Definito dalla specifica dello schema JSON.
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 (compreso).
integer uint32 INT4 Un numero intero senza segno a 32 bit. Ha un valore minimo pari a 0 e un valore massimo di 4.294.967.295 (compreso).
numero double /GOOG/NUM_DOUBLE (stringa) rappresentazione in virgola mobile IEEE 754 a 64 bit a precisione doppia.
numero numero in virgola mobile /GOOG/NUM_FLOAT (stringa) rappresentazione in virgola mobile IEEE 754 a 32 bit a precisione singola.
oggetto TIPI Un oggetto JavaScript. Definito dalla specifica dello schema JSON.
string STRINGA Una stringa arbitraria. Definito dalla specifica dello schema JSON.
string byte STRINGA Una stringa riempita di byte con codifica Base64, codificata con un URL e un nome file alfabeto sicuro (a volte indicato come "sicuro per il web" o "base64url"). Definito da RFC 4648.
string data STRINGA Una data RFC 3339 nel formato AAAA-MM-GG. Definito nella specifica dello schema JSON.
string data-ora STRINGA Un timestamp RFC 3339 nel fuso orario UTC. Nel formato yyyy-MM-ddTHH:mm:ss.SSSZ. La parte in millisecondi (".SSS") è facoltativa. Definito nella specifica dello schema JSON.
string google-datetime STRINGA Un timestamp RFC 3339 nel fuso orario UTC. Nel formato yyyy-MM-ddTHH:mm:ss.SSSZ. La parte in millisecondi (".SSS") è facoltativa.
string google-duration STRINGA Una stringa termina con il suffisso "s" (che indica i secondi) ed è preceduta dal carattere numero di secondi, con i nanosecondi espressi come secondi frazionari. La il punto viene sempre utilizzato come punto decimale, non come virgola.
string maschera-google-field STRINGA Una stringa in cui i nomi dei campi sono separati da una virgola. I nomi dei campi sono
rappresentati in convenzioni di denominazione con cammello inferiore.
string int64 STRINGA 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 (incluso).
string uint64 STRINGA Un numero intero senza segno a 64 bit. Ha un valore minimo pari a 0 e un valore massimo di (2^64)-1 (incluso).

Serializzazione e deserializzazione della richiesta e della risposta API

Per impostazione predefinita, la versione SAP BTP dell'SDK ABAP per Google Cloud si occupa del marshalling e dell'annullamento del marshalling di richieste e risposte API. Ogni classe ABAP per un Google Cloud L'API 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 SAP Business Add In (BAdI) definizioni fornite con l'SDK.

Implementare la trasformazione personalizzata

L'area di miglioramento /GOOG/ES_TRANSFORM_JSON, fornita con l'SDK, include le seguenti definizioni di BAdI:

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

Puoi scrivere logica di trasformazione specifica nelle implementazioni di questi BAdI. Le interfacce di questi BAdI hanno IV_METHOD_NAME come parametro di importazione. Utilizzerai questo parametro per isolare la logica di trasformazione per ogni API e Metodo API che utilizza i blocchi IF….ENDIF. Nel blocco di implementazione, imposta il parametro di esportazione EV_HANDLED in X.

Per implementare la trasformazione personalizzata:

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

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

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

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

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

  3. Nell'implementazione del metodo del BAdI:

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

    2. Imposta il parametro di esportazione EV_HANDLED su X.

      Se il criterio EV_HANDLED non viene impostato su X, viene eseguito il marshalling predefinito e la logica di unmarshalling dell'SDK.

  4. Contrassegna l'elemento API State del corso di implementazione come Use System-Internally (Contract C1). La logica di trasformazione personalizzata viene richiamata durante il runtime. Il valore predefinito La logica di serializzazione e deserializzazione fornita con l'SDK verrà saltata.

Spazio dei nomi

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

Assistenza

Se hai bisogno di aiuto per risolvere i problemi con l'SDK ABAP per Google Cloud, procedi le seguenti: