pytracking2 0.4.6

1. 将跟踪信息添加到电子邮件中

要跟踪电子邮件打开，通常的做法是在电子邮件末尾添加一个小型的1x1透明像素。当用户打开电子邮件时，电子邮件客户端（例如，gmail、outlook、thunderbird）将通过发出GET请求来加载像素。然后，服务请求的Web服务器将记录打开情况并向邮件发送者发送通知。

要跟踪链接点击，通常的做法是将电子邮件中的链接重写以更改目标为代理。一旦用户点击链接，代理将用户重定向到真实链接并通知邮件发送者。

pytracking提供了一种无状态的打开和点击跟踪策略：您想要跟踪的所有信息都编码在像素（打开）和代理（点击）URL中。例如，如果您想跟踪与特定电子邮件关联的客户ID和交易ID，pytracking将在URL中编码这些信息。当用户打开电子邮件或点击链接时，客户ID和交易ID将被解码，然后可以发送到webhook。

请参阅获取打开跟踪链接部分以获取快速示例。

2. 处理电子邮件打开和链接点击

一旦用户打开电子邮件或点击链接，电子邮件客户端将向编码的URL发送请求。您的Web服务器将接收此类请求并将其传递给pytracking，pytracking将解码跟踪信息。然后您可以直接使用跟踪信息（例如，更新您的跟踪数据库）或将信息发送到webhook。

在链接跟踪的情况下，解码的信息将包含您必须将电子邮件客户端重定向到的原始URL。

请参阅从URL获取打开跟踪数据部分以获取快速示例。

pytracking提供的可选主要功能

1. 加密：pytracking使用base 64对您的跟踪信息进行编码，任何人都可以解码。您可以选择加密您的跟踪信息，这样只有拥有密钥的人才能解码。请参阅加密数据部分以获取更多信息。

2. HTML修改：pytracking可以修改HTML电子邮件以替换所有链接并添加跟踪像素。请参阅修改HTML电子邮件以添加跟踪链接部分。

3. Django：如果您使用Django来服务打开和点击跟踪URL，则可以扩展pytracking Django视图，它已提供了重定向和像素服务。请参阅与Django一起使用pytracking部分。

4. Webhooks：pytracking提供了一个快捷函数来向webhook发送POST请求。请参阅通知Webhooks部分。

编码

您可以在两种链接中编码元数据。例如，您可以将客户ID与点击跟踪链接相关联，这样当客户点击链接时，您就能确切知道是哪个客户点击了它。

pylinktracking实现了一种无状态跟踪策略：所有必要的信息都可以编码在跟踪链接中。您可以选择在单独的配置中保留常用设置（例如，与所有链接关联的默认元数据、webhook URL）。

信息使用URL安全的base64进行编码，因此任何拦截您链接的人，包括您的客户，都可能解密信息。您可以选择加密跟踪信息（见下文）。

大多数函数都接受一个pytracking.Configuration实例作为参数，该实例告诉如何生成链接。您也可以将配置参数作为**kwargs参数传递，或者混合两者：kwargs将覆盖配置参数。

解码

一旦您从跟踪链接收到请求，您可以使用pytracking解码链接并获取一个pytracking.TrackingResult实例，该实例包含有关要重定向到的链接（如果它是点击跟踪链接）、关联的元数据、要通知的webhook URL等信息。

获取打开跟踪链接

import pytracking

open_tracking_url = pytracking.get_open_tracking_url(
    {"customer_id": 1}, base_open_tracking_url="https://trackingdomain.com/path/",
    webhook_url="http://requestb.in/123", include_webhook_url=True)

# This will produce a URL such as:
# https://trackingdomain.com/path/e30203jhd9239754jh21387293jhf989sda=

带有配置的获取打开跟踪链接

import pytracking

configuration = pytracking.Configuration(
    base_open_tracking_url="https://trackingdomain.com/path/",
    webhook_url="http://requestb.in/123",
    include_webhook_url=False)

open_tracking_url = pytracking.get_open_tracking_url(
    {"customer_id": 1}, configuration=configuration)

# This will produce a URL such as:
# https://trackingdomain.com/path/e30203jhd9239754jh21387293jhf989sda=

获取点击跟踪链接

import pytracking

click_tracking_url = pytracking.get_click_tracking_url(
    "http://www.example.com/?query=value", {"customer_id": 1},
    base_click_tracking_url="https://trackingdomain.com/path/",
    webhook_url="http://requestb.in/123", include_webhook_url=True)

# This will produce a URL such as:
# https://trackingdomain.com/path/e30203jhd9239754jh21387293jhf989sda=

从URL获取打开跟踪数据

import pytracking

full_url = "https://trackingdomain.com/path/e30203jhd9239754jh21387293jhf989sda="
tracking_result = pytracking.get_open_tracking_result(
    full_url, base_open_tracking_url="https://trackingdomain.com/path/")

# Metadata is in tracking_result.metadata
# Webhook URL is in tracking_result.webhook_url

从URL获取点击跟踪数据

import pytracking

full_url = "https://trackingdomain.com/path/e30203jhd9239754jh21387293jhf989sda="
tracking_result = pytracking.get_click_tracking_result(
    full_url, base_click_tracking_url="https://trackingdomain.com/path/")

# Metadata is in tracking_result.metadata
# Webhook URL is in tracking_result.webhook_url
# Tracked URL to redirect to is in tracking_result.tracked_url

获取一个1x1透明的PNG像素

import pytracking

(pixel_byte_string, mime_type) = pytracking.get_open_tracking_pixel()

Django设置中的配置参数

您可以通过在设置文件中添加此键来在Django设置中提供默认配置参数

PYTRACKING_CONFIGURATION = {
    "webhook_url": "http://requestb.in/123",
    "base_open_tracking_url": "http://tracking.domain.com/open/",
    "base_click_tracking_url": "http://tracking.domain.com/click/",
    "default_metadata": {"analytics_key": "123456"}
}

扩展默认视图

from pytracking import Configuration
from pytracking.django import OpenTrackingView, ClickTrackingView

class MyOpenTrackingView(OpenTrackingView):

    def notify_tracking_event(self, tracking_result):
        # Override this method to do something with the tracking result.
        # tracking_result.request_data["user_agent"] and
        # tracking_result.request_data["user_ip"] contains the user agent
        # and ip of the client.
        send_tracking_result_to_queue(tracking_result)

    def notify_decoding_error(self, exception, request):
        # Called when the tracking link cannot be decoded
        # Override this to, for example, log the exception
        logger.log(exception)

    def get_configuration(self):
        # By defaut, fetchs the configuration parameters from the Django
        # settings. You can return your own Configuration object here if
        # you do not want to use Django settings.
        return Configuration()


class MyClickTrackingView(ClickTrackingView):

    def notify_tracking_event(self, tracking_result):
        # Override this method to do something with the tracking result.
        # tracking_result.request_data["user_agent"] and
        # tracking_result.request_data["user_ip"] contains the user agent
        # and ip of the client.
        send_tracking_result_to_queue(tracking_result)

    def notify_decoding_error(self, exception, request):
        # Called when the tracking link cannot be decoded
        # Override this to, for example, log the exception
        logger.log(exception)

    def get_configuration(self):
        # By defaut, fetchs the configuration parameters from the Django
        # settings. You can return your own Configuration object here if
        # you do not want to use Django settings.
        return Configuration()

URL配置

将此添加到您的urls.py文件中

urlpatterns = [
    url(
        "^open/(?P<path>[\w=-]+)/$", MyOpenTrackingView.as_view(),
        name="open_tracking"),
    url(
        "^click/(?P<path>[\w=-]+)/$", MyClickTrackingView.as_view(),
        name="click_tracking"),
]