एपीआई के तरीके

GetReader

GetReader की मदद से, पब्लिशर यह पुष्टि कर सकता है कि पीपीआईडी वाले किसी व्यक्ति ने अपनी सदस्यता को Google से लिंक किया है या नहीं. GET अनुरोध का इस्तेमाल करके, पब्लिशर किसी खास पब्लिकेशन आईडी से जुड़े पीपीआईडी के बारे में क्वेरी करता है.

अनुरोध

//GET /v1/publications/dailybugle.com/readers/6789

जवाब

जवाब के तौर पर एंडपॉइंट, JSON बॉडी में 200 दिखाएगा, जिसमें लिंक की गई सदस्यता का created_time शामिल होगा. अगर पब्लिकेशन के लिए कोई पीपीआईडी नहीं मिलता है, तो यह गड़बड़ी होने की जानकारी देगा. ज़्यादा जानकारी के लिए गड़बड़ियों वाला सेक्शन देखें.

{
  "name": "publications/gtech-demo.appspot.com/readers/81112",  
  "create_time": "2022-04-19T04:53:40+00:00"
}

GetReaderEntitlements

GetReaderEntitlements, पब्लिशर को उस पीपीआईडी के एनटाइटलमेंट के लिए क्वेरी करने की अनुमति देता है जिसे पब्लिशर ने पहले उपलब्ध कराया था. जीईटी अनुरोध का इस्तेमाल करके, पब्लिशर पीपीआईडी और पब्लिकेशन आईडी देकर, एनटाइटलमेंट के लिए अनुरोध करता है.

अनुरोध

//GET /v1/publications/dailybugle.com/readers/6789/entitlements

जवाब

अनुरोध स्वीकार किए जाने के लिए जवाब का फ़ॉर्मैट, UpdateReaderEntitlements PATCH अनुरोध के साथ एनटाइटलमेंट सेव करने के लिए इस्तेमाल किए गए फ़ॉर्मैट जैसा ही होना चाहिए.

{ 
  "name": "publications/dailybugle.com/readers/6789/entitlements",
  "entitlements": [  
      {
        "product_id": "dailybugle.com:basic",
        "subscription_token": "dnabhdufbwinkjanvejskenfw",
        "detail": "This is our basic plan",
        "expire_time": "2022-08-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:premium",
        "subscription_token": "wfwhddgdgnkhngfw",
        "detail": "This is our premium plan",
        "expire_time": "2022-07-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:deluxe",
        "subscription_token": "fefcbwinkjanvejfefw",
        "detail": "This is our deluxe plan",
        "expire_time": "2022-08-20T04:53:40+00:00"
      }
  ]
}

ऐसा हो सकता है कि कुछ लोगों के पास एनटाइटलमेंट नहीं हो, लेकिन लिंक किया हुआ पीपीआईडी हो. उदाहरण के लिए, ऐसा एनटाइटलमेंट जिसकी समयसीमा खत्म हो गई है और उसे पूरी तरह मिटा दिया गया है. ऐसे में, एनटाइटलमेंट के लिए अनुरोध करने पर, स्टैंडर्ड एनटाइटलमेंट ऑब्जेक्ट के हिस्से के तौर पर एनटाइटलमेंट का कलेक्शन खाली दिखेगा.

{ 
  "name": "publications/dailybugle.com/readers/6789/entitlements",
  "createTime": "2023-02-07T17:38:57.425577Z"
}

UpdateReaderEntitlements

UpdateReaderEntitlements का इस्तेमाल, लोगों के पीपीआईडी के आधार पर, एनटाइटलमेंट बनाने और अपडेट करने के लिए किया जाता है.

पेलोड का यह नमूना, पीपीआईडी 6789 एनटाइटलमेंट वाले लोगों को The Daily Bugle के लिए तीन प्रॉडक्ट आईडी dailybugle.com:basic, dailybugle.com:premium, और dailybugle.com:deluxe इस्तेमाल करने की अनुमति देता है. जब पीपीआईडी 6789 एनटाइटलमेंट वाला व्यक्ति, Google के प्लैटफ़ॉर्म से Search और 'डिस्कवर' सुविधा का इस्तेमाल करता है, तो “आपकी सदस्यताओं से” सूची में, dailybugle.com के ऐसे लेखों से काम के नतीजे दिखेंगे जिन्हें इन प्रॉडक्ट आईडी के साथ टैग किया गया है.

ध्यान दें: इस तरीके का इस्तेमाल, लोगों के लिए शुरुआती एनटाइटलमेंट बनाने के साथ-साथ उन्हें अपडेट करने में भी किया जाता है.

अनुरोध

//PATCH /v1/publications/dailybugle.com/readers/6789/entitlements

{
  "name": "publications/dailybugle.com/readers/6789/entitlements",
  "entitlements": [  
      {
        "product_id": "dailybugle.com:basic",
        "subscription_token": "dnabhdufbwinkjanvejskenfw",
        "detail": "This is our basic plan",
        "expire_time": "2022-08-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:premium",
        "subscription_token": "wfwhddgdgnkhngfw",
        "detail": "This is our premium plan",
        "expire_time": "2022-07-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:deluxe",
        "subscription_token": "fefcbwinkjanvejfefw",
        "detail": "This is our deluxe plan",
        "expire_time": "2022-08-20T04:53:40+00:00"
      }
  ]
}

जवाब

पैच कार्रवाई पूरी होने के बाद, सेव किया गया entitlements ऑब्जेक्ट, GetReaderEntitlements के फ़ॉर्मैट में ही दिखाया जाएगा.

DeleteReader

DeleteReader, पब्लिशर को किसी व्यक्ति की लिंक की गई सदस्यता को मैन्युअल तरीके से मिटाने की अनुमति देता है. DELETE अनुरोध का इस्तेमाल करके, पब्लिशर मिटाए जाने वाले पब्लिकेशन आईडी के लिए पीपीआईडी सबमिट करता है.

ध्यान दें: इन्हें मिटाने के लिए यह ज़रूरी है कि लोगों के पास कोई मौजूदा एनटाइटलमेंट न हो. मौजूदा एनटाइटलमेंट वाले किसी व्यक्ति की जानकारी मिटाने के लिए, सबसे पहले उसके एनटाइटलमेंट को खाली कलेक्शन वाले UpdateReaderEntitlements के साथ मिटाना पड़ता है. इसके बाद, उस व्यक्ति की जानकारी को मिटाया जा सकता है.

अनुरोध

//DELETE /v1/publications/dailybugle.com/readers/6789

जवाब

सही तरीके से मिटने पर, जवाब के तौर पर खाली JSON ऑब्जेक्ट {} के साथ 200 दिखेगा.

{}