RBM Management API

RBM Management API 复制了 RBM 开发者控制台的功能。对于运营自己的广告系列平台并希望将 RBM 无缝集成为渠道的汇总平台和合作伙伴,此 API 尤其有用。

RBM Management API 是一种 REST API,可让开发者以编程方式执行以下操作:

  • 创建和修改 RBM 代理定义并上传素材资源。
  • 提交 RBM 代理以进行验证和发布。
  • 检索验证和发布信息。

RBM 管理 API 作为 RCS 扩展程序向 Google 的 Business Communications API 公开。

身份验证凭据

任何 RBM 开发者都可以访问 RBM Management API。调用 API 时,您需要使用在开发者控制台中创建的服务账号进行身份验证。

您的服务账号密钥用于向 Google OAuth2 服务器进行身份验证,以获取访问令牌,然后使用该令牌调用 RBM Management API。如需详细了解此过程,请参阅服务账号身份验证页面。

此 API 的 OAuth 范围为 businesscommunications

以下代码段演示了如何使用 Google 的公开身份验证库。

cURL

使用 curl 时,您可以使用 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)
此代码摘自我们的 RBM 管理 API 示例

鉴于实现令牌过期和刷新机制的复杂性,我们强烈建议开发者不要自行实现身份验证。

示例代码

如需更好地了解如何使用 RBM Management API,请下载以下多种语言的示例代码:

客户端库

客户端库可处理身份验证和 API 编组与解组,从而简化您的开发工作。这些指南以多种语言发布:

工作流程

如需使用 RBM 管理 API 创建和启动代理,请按照以下步骤操作:

  1. 创建品牌。
  2. 在品牌中创建代理。
  3. 向代理添加测试人员,以便验证用户体验。
  4. 提交代理以进行验证。
  5. 提交代理以供一个或多个运营商发布。
  6. 检查启动状态。