通知サービス

AFP 通知サービスを使用すると、AFP Direct プラットフォームが通知を受け取ることができます サブアカウント およびサイト 必要があります。プラットフォームは Platform API: 変更を調査します。

通知を受信するには、受信するサーバーを POST リクエストを実行し、スキーマ（ 設定例を参照）。次に、エンドポイント URL を指定する必要があります。 パートナー マネージャーに連絡してサービスを有効にしてください。

スキーマ

通知ペイロードは、次のスキーマに準拠している必要があります。

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Notification",
  "type": "object",
  "properties": {
    "accountName": {
      "type": "string",
      "description": "The name of the modified sub-account."
    },
    "domain": {
      "type": "string",
      "description": "The domain the notification refers to, if any. Optional (only populated for SITE_APPROVAL)"
    },
    "notificationType": {
      "type": "string",
      "enum": ["PUBLISHER_APPROVAL", "SITE_APPROVAL"],
      "description": "Type of notification"
    }
  },
  "required": ["platformPublisherId", "publisherId", "notificationType"],
  "additionalProperties": false
}

notificationTypes と他のフィールドは後で追加できます。

例

パブリッシャーの承認通知は次のようになります。

{
  "accountName" : "platforms/pub-1234567890123456/accounts/pub-0987654321654321",
  "notificationType": "PUBLISHER_APPROVAL"
}

サイトの承認通知は次のようになります。

{
  "accountName" : "platforms/pub-1234567890123456/accounts/pub-0987654321654321",
  "domain": "afpsite.com",
  "notificationType": "SITE_APPROVAL"
}

設定例

次の例は、アプリケーションのコンテンツをログに記録する NodeJS サーバーの例です。 通知:

// Import express
const express = require('express');

// Create an express application
const app = express();

// Middleware to parse JSON bodies
app.use(express.json());

// Define a route to receive POST requests
app.post('/notification', (req, res) => {
    console.log('Received account name:', req.body.accountName)
    console.log('Received Domain:', req.body.domain)
    console.log('Received notification type', req.body.notificationType)

    // Send a response back to the client
    res.status(200).send('Notification received');
});

// Start the server
const PORT = process.env.PORT || 8080;
app.listen(PORT, () => {
  console.log(`Server running on port ${PORT}`);
});

エンドポイント URL の例: https://yourdomain.com/your-endpoint

curl を使用して POST リクエストを送信し、エンドポイントが機能していることを確認します。

curl -X POST https://yourdomain.com/your-endpoint \
     -H "Content-Type: application/json" \
     -d '{"accountName": "platforms/pub-1234567890123456/accounts/pub-0987654321654321", \
        "notificationType": "PUBLISHER_APPROVAL"}'

robots.txt を設定する

通知サービスによるエンドポイントへのアクセスが許可されていることを確認します。「 通知サービスは、 プロジェクトのルートの robots.txt ファイル ドメインがある場合は、

User-agent: GoogleOther
Disallow: <ensure your endpoint is not disallowed>