服务器端集成

发布商主要使用服务器端集成来管理读者及其 使用权。大多数情况下,发布商使用 UpdateReaderEntitlements 来更新 Google 的 PPID 产品 ID 使用权记录。

Google Cloud 设置

在 Google Cloud 中配置订阅关联包括两个主要组件:

  1. 为给定项目启用 API
  2. 创建用于访问 API 的服务账号

启用 Subscription Links API

要使用服务账号和管理读者的授权,Google Cloud 一个项目必须同时启用 Subscription links API, 配置 OAuth 服务账号。要为 请从菜单 ->API 和服务 ->书库并搜索 Subscription Linking,或直接访问该网页:


https://console.cloud.google.com/apis/library?project=gcp_project_id

API

图 1. 导航到 API 库并为 Google 启用 API Cloud 项目中。

创建服务账号

服务账号用于允许从您的应用访问 订阅关联 API。

  1. 在项目的 控制台。
  2. 为服务账号创建凭据,并存储 将 credentials.json 文件放在应用可访问的安全位置。
  3. 授予 IAM 角色“Subscription Links Admin”添加到 服务账号。想要精确控制 服务账号,则可以从下表中分配适当的角色。
功能 / 角色 Subscription Linking Admin Subscription Linking Viewer Subscription Linking Entitlements Viewer
获取读者使用权
吸引读者
更新读者权益
删除读者

将服务账号与 Subscription Links API 搭配使用

使用服务账号对对 Subscription Links API 的调用进行身份验证。 使用 googleapis 客户端库或通过对请求进行签名 与 REST API 搭配使用客户端库会自动处理请求 相应的 access_token,而 REST API 需要检索 id_token 然后将其替换为 access_token

以下两个客户端 库和 REST API 示例使用 getReader() 端点。现场直播 演示所有 API 方法,请参阅 订阅关联演示网站或其代码

使用 node.js googleapis 客户端库的示例请求

import {readerrevenuesubscriptionlinking_v1, Auth} from 'googleapis';
const subscriptionLinking = readerrevenuesubscriptionlinking_v1.Readerrevenuesubscriptionlinking;

class SubscriptionLinking {
  constructor() {
    this.auth = new Auth.GoogleAuth({
      keyFile: process.env.KEY_FILE,
      scopes: [
        'https://www.googleapis.com/auth/readerrevenue.subscriptionlinking.manage'
      ],
    })
  }

  init() {
    return new subscriptionLinking(
        {version: 'v1', auth: this.auth})
  }
}

const api = new SubscriptionLinking();
const client = api.init();

async function getReader(ppid) {
  const publicationId = process.env.PUBLICATION_ID;
  return await client.publications.readers.get({
    name: `publications/${publicationId}/readers/${ppid}`,
  });
};

async function updateEntitlements(ppid) {
  const publicationId = process.env.PUBLICATION_ID;
  const requestBody = {
    /*
    Refer to
    https://developers.google.com/news/subscribe/subscription-linking/appendix/glossary#entitlements_object
    */
    entitlements : [{
      product_id: `${publicationId}:basic`,
      subscription_token: 'abc1234',
      detail: 'This is our basic plan',
      expire_time: '2025-10-21T03:05:08.200564Z'
    }]
  };
  return await client.publications.readers.updateEntitlements({
    name: `publications/${publicationId}/readers/${ppid}`,
    requestBody
  });
};

手动对 REST API 请求签名

import fetch from 'node-fetch'
import jwt from 'jsonwebtoken'

function getSignedJwt() {
  /*
    Either store the credentials string in an environmental variable
    Or implement logic to fetch it.
  */
  const key_file = process.env.CREDENTIALS_STRING

  const issueDate = new Date()
  const expireMinutes = 60
  const offsetInSeconds = issueDate.getTimezoneOffset() * 60000
  const expireDate = new Date(issueDate.getTime() + (expireMinutes * 60000))
  const iat = Math.floor((issueDate.getTime() + offsetInSeconds) / 1000)
  const exp = Math.floor((expireDate.getTime() + offsetInSeconds) / 1000)

  const token = {
    iss: key_file.client_email,
    iat,
    exp,
    aud: 'https://oauth2.googleapis.com/token',
    scope:'https://www.googleapis.com/auth/readerrevenue.subscriptionlinking.manage',
  }
  return jwt.sign(token, key_file.private_key, {
    algorithm: 'RS256',
    keyid: key_file.private_key_id,
  })
}

async function getAccessToken(signedJwt) {
  let body = new URLSearchParams();
  body.set('grant_type', 'urn:ietf:params:oauth:grant-type:jwt-bearer')
  body.set('assertion', signedJwt)
  const request = await fetch('https://oauth2.googleapis.com/token', {
    method: 'POST',
    headers: {'Content-Type': 'application/x-www-form-urlencoded'},
    body
  })

  const accessResponse = await accessFetch.json()
  return accessResponse.access_token
}

async function getReader(ppid) {
  const publicationId = process.env.PUBLICATION_ID
  const base_url = 'https://readerrevenuesubscriptionlinking.googleapis.com/v1'
  const endpoint = `${base_url}/publications/${publicationId}/readers/${ppid}`
  const signedJwt = await getSignedJwt()
  const accessToken = await getAccessToken(signedJwt)

  const reader = await fetch(endpoint, {
     method: 'GET',
     headers: {
       Authorization: `Bearer ${accessToken}`,
     },
   }).then((response) => {
    return response.json()
  })

  return reader
}