एंड-टु-एंड उदाहरण

इस लेख में Python में App Engine ऐप्लिकेशन बनाने का तरीका बताया गया है. यह तरीका ऐसे उपयोगकर्ताओं को व्याख्या वाले ईमेल भेजता है जिनमें ईमेल पाने वाले लोगों की सूची की सदस्यता की पुष्टि करने के लिए, सीधे उनके इनबॉक्स से अनुरोध किया जाता है. साथ ही, यह Datastore में सदस्यताएं इकट्ठा करता है.

ज़रूरी शर्तें और प्रोजेक्ट सेटअप

यह गाइड यह मानता है कि आपने पहले से ही App Engine SDK टूल इंस्टॉल कर लिया है. साथ ही, आपको App Engine प्रोजेक्ट बनाने, चलाने, और पब्लिश करने का तरीका पता है.

पहले, अपने प्रोजेक्ट के लिए एक डायरेक्ट्री बनाएं. अपनी ऐप्लिकेशन की सभी फ़ाइलें इस निर्देशिका में रखें.

नीचे दिए गए कोड को app.yaml नाम की फ़ाइल में कॉपी करें और {{ APPID }} प्लेसहोल्डर को अपने खास App Engine ऐप्लिकेशन आईडी से बदलें:

application: {{ APPID }}
version: 1
runtime: python27
api_version: 1
threadsafe: true

handlers:
- url: /.*
  script: main.app

libraries:
- name: jinja2
  version: latest

अपने App Engine प्रोजेक्ट फ़ोल्डर में main.py नाम की फ़ाइल बनाएं. इसके बाद, सदस्यताओं को इकट्ठा करने और उनकी सूची बनाने और जानकारी वाले ईमेल भेजने के लिए हैंडलर सेट अप करने के लिए नीचे दिए गए कोड को कॉपी करें:

import webapp2

from emailsender import EmailSender
from subscribe import SubscribeHandler

app = webapp2.WSGIApplication([('/', SubscribeHandler), ('/email', EmailSender)], debug=True)

ईमेल में स्ट्रक्चर्ड डेटा जोड़ना

चलिए, एक बहुत आसान ईमेल से शुरुआत करते हैं, जिसमें उपयोगकर्ता से ईमेल पाने वाले लोगों की सूची की सदस्यता की पुष्टि करने के लिए कहा जाता है:

<html>
  <head>
    <title>Please confirm your subscription to Mailing-List XYZ?</title>
  </head>
  <body>
    <p>
      Dear John, please confirm that you wish to be subscribed to the
      mailing list XYZ
    </p>
  </body>
</html>

रेस्टोरेंट के बारे में बताने के लिए, ईमेल के head में JSON-LD या Microdata) स्ट्रक्चर्ड डेटा जोड़ा जा सकता है. साथ ही, उसमें OneClickAction भी जोड़ा जा सकता है. हालांकि, यह ज़रूरी है कि वह इस फ़ॉर्मैट में काम करे. Gmail, OneClickAction के साथ काम करता है. साथ ही, उपयोगकर्ताओं को एक खास यूज़र इंटरफ़ेस (यूआई) दिखाता है, ताकि वे इनबॉक्स से अपनी सदस्यता की पुष्टि कर सकें.

नीचे दिए गए मार्कअप को mail_template.html नाम की फ़ाइल में कॉपी करें:

JSON-LD

<html>
  <head>
  <title>Please confirm your subscription to Mailing-List XYZ?</title>
  </head>
  <body>
    <script type="application/ld+json">
    {
      "@context": "http://schema.org",
      "@type": "EmailMessage",
      "potentialAction": {
        "@type": "ConfirmAction",
        "name": "Confirm Subscription",
        "handler": {
          "@type": "HttpActionHandler",
          "url": "{{ confirm_url }}",
          "method": "http://schema.org/HttpRequestMethod/POST",
        }
      },
      "description": "Confirm subscription to mailing list XYZ"
    }
    </script>
    <p>
      Dear John, please confirm that you wish to be subscribed to the mailing list XYZ.
    </p>
  </body>
</html>

माइक्रोडेटा

<html>
  <head>
    <title>Please confirm your subscription to Mailing-List XYZ?</title>
  </head>
  <body>
    <div itemscope itemtype="http://schema.org/EmailMessage">
      <div itemprop="potentialAction" itemscope itemtype="http://schema.org/ConfirmAction">
        <meta itemprop="name" content="Approve Expense"/>
        <div itemprop="handler" itemscope itemtype="http://schema.org/HttpActionHandler">
          <link itemprop="url" href="https://myexpenses.com/approve?expenseId=abc123"/>
          <meta itemprop="url" content="{{ confirm_url }}"/>
          <link itemprop="method" href="http://schema.org/HttpRequestMethod/POST"/>
        </div>
      </div>
      <meta itemprop="description" content="Approval request for John's $10.13 expense for office supplies"/>
    </div>
    <p>
      Dear John, please confirm that you wish to be subscribed to the mailing list XYZ.
    </p>
  </body>
</html>

ऊपर दिए गए स्ट्रक्चर्ड डेटा में, ईमेल पाने वाले लोगों की सूची "XYZ" और ConfirmAction के बारे में बताया गया है. कार्रवाई का हैंडलर HttpActionHandler है, जो url प्रॉपर्टी में दिए गए यूआरएल पर पोस्ट अनुरोध भेजता है.

उपयोगकर्ताओं को सदस्यता के अनुरोध भेजना

इस कोड को App Engine प्रोजेक्ट फ़ोल्डर में emailsender.py नाम की फ़ाइल में कॉपी करें:

import jinja2
import os
import webapp2

from google.appengine.api import mail
from google.appengine.api import users

from urlparse import urlparse

class EmailSender(webapp2.RequestHandler):

  def get(self):
    # require users to be logged in to send emails
    user = users.get_current_user()
    if not user:
      self.redirect(users.create_login_url(self.request.uri))
      return

    email = user.email()

    # The confirm url corresponds to the App Engine app url
    pr = urlparse(self.request.url)
    confirm_url = '%s://%s?user=%s' % (pr.scheme, pr.netloc, user.user_id())

    # load the email template and replace the placeholder with the confirm url
    jinja_environment = jinja2.Environment(
        loader=jinja2.FileSystemLoader(os.path.dirname(__file__)))
    template = jinja_environment.get_template('mail_template.html')
    email_body = template.render({'confirm_url': confirm_url})

    message = mail.EmailMessage(
        sender = email,
        to = email,
        subject = 'Please confirm your subscription to Mailing-List XYZ',
        html = email_body)

    try:
      message.send()
      self.response.write('OK')
    except:
      self.error(500)

EmailSender क्लास के लिए, उपयोगकर्ता का लॉग इन करना ज़रूरी है, ताकि उसका ईमेल पता वापस पाया जा सके. इसके बाद, यह mail_template.html से ईमेल के मुख्य हिस्से को लोड करता है और उसमें confirm_url प्लेसहोल्डर को App Engine ऐप्लिकेशन (https://APP-ID.appspot.com) के रूट यूआरएल से बदल देता है. साथ ही, उस उपयोगकर्ता को ईमेल भेजता है जिसने फ़िलहाल लॉग इन किया हुआ है.

सदस्यताएं इकट्ठा करना और उनकी लिस्टिंग करना

इस कोड को App Engine प्रोजेक्ट फ़ोल्डर में subscribe.py नाम की फ़ाइल में कॉपी करें:

import webapp2

from emailsender import EmailSender
from google.appengine.ext import db


class SubscribeHandler(webapp2.RequestHandler):

  def post(self):
    user_id = self.request.get('user')

    # insert the subscription into the Datastore
    subscription = Subscription(user_id=user_id)
    subscription.put()

  def get(self):
    # retrieve up to 1000 subscriptions from the Datastore
    subscriptions = Subscription.all().fetch(1000)

    if not subscriptions:
      self.response.write('No subscriptions')
      return

    count = len(subscriptions)

    for s in subscriptions:
      self.response.write('%s subscribed<br/>' % (s.user_id))

    self.response.write('<br/>')
    self.response.write('%d subscriptions.' % (count))


class Subscription(db.Model):
    user_id = db.TextProperty(required=True)

SubscribeHandlerclass listens to bothPOSTandGETrequests sent to the app root url (https://APP-ID.appspot.com).POSTrequests are used by Gmail to insert new subscriptions including theuser_id` पैरामीटर, जो उपयोगकर्ता से जुड़ा होता है, जैसा कि इस उदाहरण में दिखाया गया है:

https://subscribe.appspot.com/?user_id=123abcd

अनुरोध हैंडलर सिर्फ़ यह जांच करता है कि ज़रूरी user_id तय किया गया है या नहीं. इसके बाद, यह सदस्यता को Datastore में सेव करता है. इस वजह से, HTTP 200 रिस्पॉन्स कोड वापस Gmail को भेजा जाता है, ताकि अनुरोध को सही माना जा सके. अगर अनुरोध में ज़रूरी फ़ील्ड शामिल नहीं है, तो अनुरोध हैंडलर HTTP 400 रिस्पॉन्स कोड देगा, जो अमान्य अनुरोध का सिग्नल देगा.

ऐप्लिकेशन रूट यूआरएल के GET अनुरोधों का इस्तेमाल, इकट्ठा की गई सदस्यताओं की सूची बनाने के लिए किया जाता है. अनुरोध हैंडलर सबसे पहले Datastore से सभी सदस्यताओं को फ़ेच करता है और फिर उन्हें एक आसान काउंटर के साथ, पेज पर प्रिंट करता है.

ऐप्लिकेशन को टेस्ट किया जा रहा है

खुद को व्याख्या किया गया ईमेल भेजने के लिए अपना ऐप्लिकेशन App Engine पर डिप्लॉय करें और https://APP-ID.appspot.com/email पर जाएं (APP-ID को अपने App Engine के ऐप्लिकेशन आईडी से बदलें).

Gmail में कार्रवाइयां

अपना ऐप्लिकेशन डिप्लॉय करने और कुछ सदस्यताएं डालने के बाद, https://APP-ID.appspot.com पर अपने ऐप्लिकेशन पर जाएं और सदस्यताओं के बारे में खास जानकारी देने वाला पेज देखें