README

Java/Scala:

referer-parser 是一个多语言库，用于从 referer URL 中提取营销归因数据（如搜索词），灵感来源于ua-parser项目（用于用户代理解析的等效库）。

referer-parser 是 Snowplow 的核心组件，Snowplow 是一个由 Hadoop 和 Redshift 驱动的开源网络级分析平台。

请注意，在这个项目中我们始终使用原始的 HTTP 中的拼写错误 'referer'（以及 'referal'），而不是 'referrer'。

维护者

• PHP: [Yuehlin Chung] yuehlin at Shapeways, Inc
• referers.yml: [Snowplow Analytics] snowplow-analytics

使用: PHP

这个库的 PHP 版本使用更新后的 API，并可以识别搜索、社交、网络邮件、内部和未知 referer。

use Snowplow\RefererParser\Parser;

$parser = new Parser();
$referer = $parser->parse(
    'http://www.google.com/search?q=gateway+oracle+cards+denise+linn&hl=en&client=safari',
    'http:/www.psychicbazaar.com/shop'
);

if ($referer->isKnown()) {
    echo $referer->getMedium(); // "Search"
    echo $referer->getSource(); // "Google"
    echo $referer->getTerm();   // "gateway oracle cards denise linn"
}

有关更多信息，请参阅 PHP [README] php-readme。

referers.yml

referer-parser 通过与 [referers.yml] referers-yml 文件进行比对，来识别一个 URL 是否是已知的 referer；目的是让这个 YAML 文件可以被 referer-parser 的每种语言实现重复使用。

文件被划分为支持的不同媒介部分

• unknown 当我们知道来源，但不知道媒介时使用
• email 用于网络邮件服务提供商
• social 用于社交媒体服务
• search 用于搜索引擎

然后在每个部分内部，我们按照名称列出每个已知的提供者（称为 source），然后列出每个提供者使用的域名。对于搜索引擎，我们还会列出用于在搜索引擎 URL 中识别搜索 term 的参数。例如

Google: # Name of search engine referer
  parameters:
    - 'q' # First parameter used by Google
    - 'p' # Alternative parameter used by Google
  domains:
    - google.co.uk  # One domain used by Google
    - google.com    # Another domain used by Google
    - ...

引用者和它们使用的域的数量会不断增长 - 我们需要保持 referers.yml 的更新，并希望社区能提供帮助！

贡献

我们欢迎对 referer-parser 的贡献

1. 新的搜索引擎和其他 referer - 如果你注意到 referers.yml 中缺少搜索引擎、社交网络或其他网站，请分叉存储库，添加缺少的条目并提交拉取请求
2. 将 referer-parser 移植到其他语言 - 我们欢迎将 referer-parser 移植到新的编程语言（例如 Lua、Go、Haskell、C）
3. 错误修复、功能请求等 - 非常感谢！

在提交拉取请求之前，请签署 [Snowplow CLA] cla。

支持

referer-parser 的一般支持由 Snowplow Analytics Ltd. 的团队处理。

您可以通过他们维基上列出的任何[渠道] talk-to-us 联系 Snowplow Analytics 团队。

版权和许可证

referers.yml 基于 [Piwik] 的 piwik [SearchEngines.php] piwik-search-engines 和 [Socials.php] piwik-socials，版权所有 2012 Matthieu Aubry，并受 [GNU 通用公共许可证 v3] gpl-license 保护。

PHP 版本的版权属于 2013-2014 [Lars Strojny] lstrojny，并受 [MIT 许可证] mit-license 保护。