Служба уведомлений

Служба уведомлений AFP позволяет платформам AFP Direct получать уведомления об изменениях состояния субаккаунтов и сайтов . Платформы могут использовать API платформы для изучения изменений.

Чтобы получать уведомления, реализуйте сервер, который принимает запросы POST и анализирует полезную нагрузку JSON, указанную в схеме (см. пример настройки ). Затем вам необходимо предоставить 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 .

Убедитесь, что ваша конечная точка работает, отправив POST-запрос с помощью curl :

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>