L'API RBM Management

L'API RBM Management replica le funzionalità della console per sviluppatori RBM. Questa API è particolarmente utile per gli aggregatori e i partner che gestiscono le proprie piattaforme per le campagne e vogliono integrare RBM senza problemi come canale.

L'API RBM Management è un'API REST che consente agli sviluppatori di eseguire le seguenti operazioni in modo programmatico:

  • Crea e modifica le definizioni degli agenti RBM e carica gli asset.
  • Invia gli agenti RBM per la verifica e il lancio.
  • Recupera le informazioni di verifica e lancio.

L'API RBM Management è esposta come estensioni RCS all'API Business Communications di Google.

Credenziali di autenticazione

Qualsiasi sviluppatore RBM può accedere all'API RBM Management. Quando chiami l'API, esegui l'autenticazione utilizzando un account di servizio che hai creato nella Developer Console.

La chiave del service account viene utilizzata per l'autenticazione con il server Google OAuth2 per ottenere un token di accesso che viene poi utilizzato per chiamare l'API RBM Management. Puoi scoprire di più su questa procedura nella pagina Autenticazione service account.

L'ambito OAuth per questa API è businesscommunications.

Questi snippet di codice mostrano come utilizzare le librerie pubbliche di Google per l'autenticazione.

cURL

Quando utilizzi curl, puoi eseguire l'autenticazione generando un token di autorizzazione bearer dalla chiave del service account utilizzando lo strumento oauth2l.
-H "`oauth2l header --json rbm-developer-service-account-credentials.json businesscommunications`"

Python

from google.auth.transport.requests import AuthorizedSession
from google.oauth2 import service_account

BASE_ENDPOINT = 'https://businesscommunications.googleapis.com/v1/'

SCOPES = ['https://www.googleapis.com/auth/businesscommunications']

credentials = service_account.Credentials.from_service_account_file(
  './rbm-developer-service-account-credentials.json',
  scopes = SCOPES)

authed_session = AuthorizedSession(credentials)
Questo codice è un estratto del nostro esempio di API RBM Management.

Consigliamo vivamente agli sviluppatori di non implementare autonomamente l'autenticazione, data la complessità dell'implementazione della scadenza e dell'aggiornamento dei token.

Codice di esempio

Per comprendere meglio come utilizzare l'API RBM Management, scarica il codice campione in una serie di lingue:

Librerie client

Le librerie client gestiscono l'autenticazione e il marshalling e l'unmarshalling delle API per semplificare lo sviluppo. Sono pubblicati in più lingue:

Flusso di lavoro

Per creare e lanciare un agente con l'API RBM Management, segui questi passaggi:

  1. Crea un brand.
  2. Crea un agente nel brand.
  3. Aggiungi tester all'agente per convalidare l'esperienza utente.
  4. Invia l'agente per la verifica.
  5. Invia l'agente per il lancio con uno o più operatori.
  6. Controlla lo stato del lancio.