सूचना सेवा

AFP सूचना सेवा की मदद से, AFP डायरेक्ट प्लैटफ़ॉर्म को सूचनाएं मिलती हैं उप-खाते के लिए और site राज्य में बदलाव. प्लैटफ़ॉर्म, प्लैटफ़ॉर्म एपीआई, ताकि बदलावों की जांच की जा सके.

सूचनाएं पाने के लिए, ऐसा सर्वर लागू करें जो यह स्वीकार करता हो POST अनुरोध करता है और स्कीमा में बताए गए JSON पेलोड को पार्स करता है (देखें उदाहरण के लिए सेटअप). इसके बाद आपको एंडपॉइंट यूआरएल देना होगा को चालू करने के लिए अपने स्ट्रटीजिक पार्टनर मैनेजर से संपर्क करें.

स्कीमा

सूचना पेलोड को इस स्कीमा का पालन करना होगा:

{
  "$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}`);
});

एंडपॉइंट यूआरएल का उदाहरण: https://yourdomain.com/your-endpoint

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>