Zuora

Il connettore Zuora ti consente di connetterti a un'istanza Zuora e accedere ai dati Zuora come un database tradizionale.

Versioni supportate

Questo connettore utilizza la versione v1 dell'API Zuora per abilitare l'accesso bidirezionale a Zuora.

Prima di iniziare

Prima di utilizzare il connettore Zuora, esegui le seguenti attività:

• Nel tuo progetto Google Cloud:
  • Concedi il ruolo IAM roles/connectors.admin all'utente. configurazione del connettore.
  • Concedi i seguenti ruoli IAM all'account di servizio che vuoi utilizzare per il connettore:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Un account di servizio è un tipo speciale di Account Google destinato a rappresentare una persona non umana utente che deve autenticarsi e avere l'autorizzazione ad accedere ai dati nelle API di Google. Se non hai un account di servizio, devi crearne uno. Per ulteriori informazioni le informazioni, vedi Creazione di un account di servizio.

  • Attiva i seguenti servizi:
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (API Connectors)

    Per informazioni su come abilitare i servizi, vedi Attivazione dei servizi.

  Se questi servizi o autorizzazioni non sono stati abilitati in precedenza per il tuo progetto, ti viene chiesto di abilitarli durante la configurazione del connettore.

Configura il connettore

Per configurare il connettore è necessario creare una connessione al tuo origine dati (sistema di backend). Una connessione è specifica per un'origine dati. it significa che se hai molte origini dati, devi creare una connessione separata per ogni origine dati. Per creare una connessione:

1. Nella console Cloud, vai a Connettori di integrazione > Pagina Connessioni e poi selezionare o creare un progetto Google Cloud.

   Vai alla pagina Connessioni .

2. Fai clic su + Crea nuova per aprire la pagina Crea connessione.
3. Nella sezione Posizione, scegli la località per la connessione.
   1. Regione: seleziona una località dall'elenco a discesa.

      Le regioni supportate per i connettori includono:

      Per l'elenco di tutte le aree geografiche supportate, consulta la sezione Località.

   2. Fai clic su Avanti.
4. Nella sezione Dettagli connessione, completa i seguenti passaggi:
   .
   1. Connettore: seleziona Zuora dall'elenco a discesa dei connettori disponibili.
   2. Versione connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
   3. Nel campo Nome connessione, inserisci un nome per l'istanza di connessione.

      I nomi delle connessioni devono soddisfare i seguenti criteri:

      • I nomi delle connessioni possono contenere lettere, numeri o trattini.
      • Le lettere devono essere minuscole.
      • I nomi delle connessioni devono iniziare con una lettera e terminare con una lettera o un numero.
      • I nomi delle connessioni non possono contenere più di 63 caratteri.
   4. Facoltativamente, inserisci una descrizione per l'istanza di connessione.
   5. Account di servizio: seleziona un account di servizio con i ruoli richiesti.
   6. Facoltativamente, configura le impostazioni del nodo di connessione:
      • Numero minimo di nodi: inserisci il numero minimo di nodi di connessione.
      • Numero massimo di nodi: inserisci il numero massimo di nodi di connessione.

      Un nodo è un'unità (o una replica) di una connessione che elabora le transazioni. Sono necessari più nodi per elaborare più transazioni per una connessione e, per elaborare meno transazioni. Per comprendere in che modo i nodi influiscono sui prezzi dei connettori, consulta Prezzi per i nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita il numero minimo di nodi è impostato su 2 (per una migliore disponibilità) e il numero massimo di nodi è impostato su 50.

   Nota: puoi personalizzare i valori del nodo di connessione solo se un cliente con pagamento a consumo.
   7. Tenant: impostalo sul tenant di Zuora. Per impostazione predefinita, utilizziamo "USProduction" tenant.
   8. URL: è obbligatorio solo nel caso in cui tu abbia un ambiente di copia di produzione statunitense. Se viene fornita questa proprietà, il valore della proprietà tenant non ha alcun effetto sul processo di autenticazione.
   9. ZuoraService: specifica il servizio o lo schema di esecuzione da utilizzare
   10. Use Client Side Paging (Usa il paging lato client): indica se il provider ADO.NET CData per SAP Cloud for Customer deve utilizzare o meno il paging lato client.
   11. Utilizza servizio personalizzato: indica se deve essere utilizzato il servizio OData personalizzato SAP Cloud for Customer.
   12. Visualizzazioni definite dall'utente: un percorso file che rimanda al file di configurazione JSON contenente le viste personalizzate.
   13. Facoltativamente, fai clic su + Aggiungi etichetta per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
   14. Fai clic su Avanti.
5. Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
   1. Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.

      La connessione Zuora supporta i seguenti tipi di autenticazione:

      • Credenziali client OAuth 2.0

   Per informazioni su come configurare questi tipi di autenticazione, consulta l'articolo Configurare l'autenticazione.

   2. Fai clic su Avanti.
6. Verifica: controlla i dettagli della connessione e dell'autenticazione.
7. Fai clic su Crea.

Configura l'autenticazione

Inserisci i dettagli in base all'autenticazione che vuoi utilizzare.

• Credenziali client OAuth 2.0 .
  .
  • ID client: l'ID client fornito dal connettore per l'app che hai creato.
  • Client Secret: secret di Secret Manager contenente il client secret per l'app connessa che hai creato.

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti l'applicazione connessa. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione ti viene esposta sotto forma di entità, operazioni e azioni.

Nota: puoi visualizzare le entità, le operazioni e le azioni di un nell'attività Connettori.

• Entità: un'entità può essere considerata un oggetto o un insieme di proprietà nel un'applicazione o un servizio connesso. La definizione di un'entità differisce da connettore di rete. Ad esempio, in un connettore di database, le tabelle sono le entità, connettore file server, le cartelle sono le entità e, in un connettore del sistema di messaggistica, le code sono le entità.

  Tuttavia, è possibile che un connettore non supporti o non disponga di entità. In questo caso, L'elenco Entities sarà vuoto.

• Operazione: un'operazione è l'attività che è possibile eseguire su un'entità. Puoi eseguire una qualsiasi delle seguenti operazioni su un'entità:
  • Elenca
  • Scarica
  • Crea
  • Aggiorna
  • Elimina

  Selezionando un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta operazioni di entity. Tuttavia, se un connettore non supporta nessuna delle operazioni relative alle entità, ad esempio operazioni non sono elencate nell'elenco Operations.

• Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione. attraverso l'interfaccia del connettore. Un'azione consente di apportare modifiche a una o più entità variano da connettore a connettore. Normalmente, un'azione ha alcuni parametri di input e un output . Tuttavia, è possibile che un connettore non supporta alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Nota : a tutte le entità e alle azioni è associato uno schema. Ad esempio, uno schema delle azioni avrà i dettagli dei parametri, come ad esempio il parametro e il tipo di dati corrispondente. Lo schema (metadati) per entità e azioni viene recuperato dalla connessione in dal tuo backend. In caso di aggiornamenti allo schema, questi aggiornamenti non saranno si riflette automaticamente sulle connessioni esistenti; devi aggiornare manualmente lo schema. Per aggiornare lo schema di una connessione, apri la pagina Dettagli connessione della connessione e fai clic su Aggiorna lo schema di connessione.

Esempi di operazioni con entità

Questa sezione mostra come eseguire alcune delle operazioni relative alle entità in questo connettore.

Esempio: elenca tutti i dati registrati in Rimborsi

In questo esempio sono elencati tutti i record nell'entità Refunds.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Refunds dall'elenco Entity.
3. Seleziona l'operazione List e fai clic su Fine.
4. Facoltativamente, nella sezione Input attività dell'attività Connettori, puoi filtra il set di risultati specificando una clausola di filtro.

Esempio: visualizzare una nota di addebito

Questo esempio ottiene un record il cui ID è 45 dall'entità Debit_Memo.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Debit_Memo dall'elenco Entity.
3. Seleziona l'operazione Get e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su EntityId e quindi inserisci 45 nel campo Valore predefinito.

   In questo caso, 45 è un valore di chiave primaria nell'entità Debit_Memo.

Esempio: creare un ticket

Questo esempio crea un ticket nell'entità Ticket.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Tickets dall'elenco Entity.
3. Seleziona l'operazione Create e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload, quindi inserisci un valore simile al seguente nella Campo Default Value:

   {
   "Name": "Test735362767",
   "Label": "Test735362767",
   "Type": "String",
   "FieldType": "Insert ticket1",
   "GroupName": "ticketinformation",
   "Description": "Test ticket"
   }

   Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un simile al seguente:

   {
   "Name": "Test1695971640609"
   }

Esempio: aggiornare una voce relativa a deal

Questo esempio aggiorna il record il cui ID è 97 nell'entità Deals.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Deals dall'elenco Entity.
3. Seleziona l'operazione Update e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload, quindi inserisci un valore simile al seguente nella Campo Default Value:

   {
   "Description": "New description"
   }

5. Fai clic su entityId e inserisci 97 nel campo Default Value (Valore predefinito).

   In alternativa, invece di specificare entityId, puoi anche impostare il parametro filterClause su 97.

Esempio - Eliminare un modulo

Questo esempio elimina il record il cui ID è 78 nell'entità Forms.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Forms dall'elenco Entity.
3. Seleziona l'operazione Delete e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su entityId e quindi inserisci 78 nel campo Valore predefinito.

Utilizzare Terraform per creare connessioni

Puoi utilizzare il comando Terraform risorsa per creare una nuova connessione.

Per scoprire come applicare o rimuovere una configurazione Terraform, consulta: Comandi Terraform di base.

Per visualizzare un modello Terraform di esempio per la creazione di connessioni, vedi il modello di esempio.

Quando crei questa connessione utilizzando Terraform, devi impostare le seguenti variabili nel file di configurazione di Terraform:

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
tenant	ENUM	Falso	Impostalo sul tenant di Zuora. Per impostazione predefinita, utilizziamo "USProduction" tenant. I valori supportati sono: USProduction, USAPISandbox, USPerformanceTest, EUProduction, EUSandbox, EUCentralSandbox, USCloudProduction, USCloudAPISandbox, USCentralSandbox
url	STRINGA	Falso	Questa operazione è necessaria solo nel caso in cui tu abbia un ambiente di produzione negli Stati Uniti. Se viene fornita questa proprietà, il valore della proprietà tenant non ha alcun effetto sul processo di autenticazione.
zuora_service	ENUM	Falso	Specifica il servizio o lo schema di esecuzione da utilizzare. I valori supportati sono: DataQuery, AQuADataExport
use_client_side_paging	BOOLEANO	Falso	Indica se il provider CData ADO.NET per SAP Cloud for Customer deve utilizzare il paging lato client.
use_custom_service	BOOLEANO	Falso	Indica se deve essere utilizzato il servizio SAP Cloud for Customer OData personalizzato.
user_defined_views	STRINGA	Falso	Un percorso file che rimanda al file di configurazione JSON contenente le viste personalizzate.

Utilizzare la connessione Zuora in un'integrazione

Dopo aver creato la connessione, questa diventa disponibile in Apigee Integration e Application Integration. Puoi usare la connessione in un'integrazione tramite l'attività Connettori.

• Per capire come creare e utilizzare l'attività Connectors in Apigee Integration, vedi Attività connettori.
• Per capire come creare e utilizzare l'attività Connettori in Application Integration, vedi Attività connettori.

Ricevi assistenza dalla community Google Cloud

Puoi pubblicare le tue domande e discutere di questo connettore in Google Cloud community presso i forum Cloud.

Passaggi successivi

• Scopri come sospendere e ripristinare una connessione.
• Scopri come monitorare l'utilizzo dei connettori.
• Scopri come visualizzare i log del connettore.