README

描述

reevoomark-php-api 是一个 PHP 标签库，适用于 Reevoo 评分与评论客户，使他们能够快速轻松地将 Reevoo 内容集成到网站服务器端。

其他语言

标签库也适用于 .NET 和 Java。

功能

在服务器端包含 Reevoo 内容。
包含显示 Reevoo 内容的 CSS。
尊重 Reevoo 设置的缓存控制规则的缓存内容。

支持

对于 Reevoo 评分与评论客户，可以通过发送电子邮件到 operations@reevoo.com 获取支持。

还有一个错误跟踪器可用。

安装

从这里下载 Composer 并安装。

将 reevoo 标签库添加到您的 composer.json 中，如下所示

{
  "require": {
    "reevoo/reevoomark-php-api": "2.4.0"
  }
}

然后执行

$ php composer.phar install

实现

需要 PHP 库（确保您使用 reevoo_mark.php 文件的正确路径），并使用您的 TRKREF 和缓存目录的路径（或如果您不想使用缓存则使用 false）作为构造函数属性创建 ReevooMark 类的新实例

<?php
  require("vendor/reevoo/reevoomark-php-api/lib/reevoo_mark.php");
  $reevooMark = new ReevooMark("REV", "/tmp");
?>

ReevooMark 支持在同一页面上包含多个零售商的内容，在这种情况下，您可以在构造函数中指定多个 TRKREF

<?php
  require("reevoo_mark.php");
  $reevooMark = new ReevooMark("REV1,REV2,REV3", "/tmp");
?>

要包含相关的 CSS，请在页面 <head> 部分中调用 cssAssets() 方法

<head>
  ...
  <?php $reevooMark->cssAssets() ?>
</head>

要包含相关的 JavaScript，请在页面 </body> 标签之前调用 javascriptAssets() 方法

<body>
  ...
  <?php $reevooMark->javascriptAssets() ?>
</body>

替代实现

标准实现内部调用 echo，因此如果您想在页面的上下文之外使用数据，则不太灵活。

作为替代，您可以使用 ReevooMarkApi 类，它的工作方式与 ReevooMark 类类似，但直接返回值，例如

<?php
  require("reevoo_mark_api.php");
  $reevooMark = new ReevooMarkApi("REV", "/tmp");
  $reevooMark->cssAssets();
  //=> <link rel="stylesheet" href="//mark.reevoo.com/stylesheets/reevoomark/embedded_reviews.css" type="text/css" />
?>

标准徽章

产品徽章

要渲染 "产品徽章"，可以使用以下任何示例。SKU 是强制性的，但 trkref 和 variant 是可选的。只有当您在 ReevooMark 构造函数中使用多个 TRKREF 时，才指定 trkref。

<?php $reevooMark->productBadge(array("sku" => "ABC")) ?>
<?php $reevooMark->productBadge(array("sku" => "ABC", "variant" => "undecorated")) ?>
<?php $reevooMark->productBadge(array("sku" => "ABC", "trkref" => "REV", "variant" => "stars_only")) ?>

对话徽章

要渲染 "对话徽章"，可以使用以下任何示例。SKU 是强制性的，但 trkref 和 variant 是可选的。只有当您在 ReevooMark 构造函数中使用多个 TRKREF 时，才指定 trkref。

<?php $reevooMark->conversationsBadge(array("sku" => "ABC")) ?>
<?php $reevooMark->conversationsBadge(array("sku" => "ABC", "variant" => "undecorated")) ?>
<?php $reevooMark->conversationsBadge(array("sku" => "ABC", "trkref" => "REV", "variant" => "stars_only")) ?>

系列徽章

产品徽章

要渲染 "产品系列徽章"，可以使用以下任何示例。SKU 是强制性的，应设置为系列 ID。trkref 和 variant 是可选的。只有当您在 ReevooMark 构造函数中使用多个 TRKREF 时，才指定 trkref。

<?php $reevooMark->productSeriesBadge(array("sku" => "ABC")) ?>
<?php $reevooMark->productSeriesBadge(array("sku" => "ABC", "variant" => "undecorated")) ?>
<?php $reevooMark->productSeriesBadge(array("sku" => "ABC", "trkref" => "REV", "variant" => "stars_only")) ?>

对话系列徽章

要渲染 "对话系列徽章"，可以使用以下任何示例。SKU 是强制性的，应设置为系列 ID。trkref 和 variant 是可选的。只有当您在 ReevooMark 构造函数中使用多个 TRKREF 时，才指定 trkref。

<?php $reevooMark->conversationSeriesBadge(array("sku" => "ABC")) ?>
<?php $reevooMark->conversationSeriesBadge(array("sku" => "ABC", "variant" => "undecorated")) ?>
<?php $reevooMark->conversationSeriesBadge(array("sku" => "ABC", "trkref" => "REV", "variant" => "stars_only")) ?>

整体服务评分徽章

要渲染“整体服务评分徽章”，您可以使用以下示例中的任何一个。`trkref` 和 `variant` 是可选的。仅在您在 `ReevooMark` 构造函数中使用多个 `TRKREF` 时指定 `trkref`。

<?php $reevooMark->overallServiceRatingBadge() ?>
<?php $reevooMark->overallServiceRatingBadge(array("variant" => "undecorated")) ?>
<?php $reevooMark->overallServiceRatingBadge(array("trkref" => "PIU", "variant" => "stars_only")) ?>

客户服务评分徽章

要渲染“客户服务评分徽章”，您可以使用以下示例中的任何一个。`trkref` 和 `variant` 是可选的。仅在您在 `ReevooMark` 构造函数中使用多个 `TRKREF` 时指定 `trkref`。

<?php $reevooMark->customerServiceRatingBadge() ?>
<?php $reevooMark->customerServiceRatingBadge(array("variant" => "undecorated")) ?>
<?php $reevooMark->customerServiceRatingBadge(array("trkref" => "PIU", "variant" => "stars_only")) ?>

配送评分徽章

要渲染“配送评分徽章”，您可以使用以下示例中的任何一个。`trkref` 和 `variant` 是可选的。仅在您在 `ReevooMark` 构造函数中使用多个 `TRKREF` 时指定 `trkref`。

<?php $reevooMark->deliveryRatingBadge() ?>
<?php $reevooMark->deliveryRatingBadge(array("variant" => "undecorated")) ?>
<?php $reevooMark->deliveryRatingBadge(array("trkref" => "PIU", "variant" => "stars_only")) ?>

嵌入式产品评论内容

要渲染“嵌入式评论内容”，您可以使用以下示例中的任何一个。`sku` 属性是必填的，但 `trkref`、`locale`、`numberOfReviews` 和 `paginated` 是可选的。可选属性的任何组合都是可能的。仅在您在 `ReevooMark` 构造函数中使用多个 `TRKREF` 时指定 `trkref`。

<?php $reevooMark->productReviews(array("sku" => "100A")) ?>
<?php $reevooMark->productReviews(array("sku" => "100A", "locale" => "en-GB", "numberOfReviews" => 5)) ?>
<?php $reevooMark->productReviews(array("sku" => "100A", "paginated" => true, "numberOfReviews" => 10)) ?>
<?php $reevooMark->productReviews(array("sku" => "100A", "trkref" => "REV", "paginated" => true, "locale" => "cs-CZ")) ?>

如果您将 `paginated` 属性设置为 true，则嵌入式评论将显示分页链接。

如果没有评论可用，我们将显示由您指定的 `locale` 语言设定的默认消息。如果您想指定自己的消息，可以通过传递具有值 false 的 `showEmptyMessage` 属性并使用返回值为 false 的 `productReviews()` 方法来实现。

<?php if (!$reevooMark->productReviews(array("sku" => "100A", "showEmptyMessage" => false))): ?>
  <h2>Sorry, no product reviews here</h2>
<?php endif ?>

价格优惠小部件

要渲染“价格优惠”，您可以使用以下示例。请提供 `sku` 属性。`trkref` 属性仅在您在 `ReevooMark` 构造函数中使用多个 `TRKREF` 时是必填的。

<?php $reevooMark->offersWidget(array("sku" => "3461209", "trkref" => "PCA")) ?>

如果没有优惠可以显示，您可以在以下示例中显示您自己的自定义消息

<?php if (!$reevooMark->offersWidget(array("sku" => "10023AAA", "trkref" => "PCA"))): ?>
  <h2>Sorry, no price  offers available for this product</h2>
<?php endif ?>

嵌入式客户体验评论内容

要渲染“嵌入式客户体验评论内容”，您可以使用以下示例中的任何一个。`trkref`、`locale`、`numberOfReviews` 和 `paginated` 属性是可选的。可选属性的任何组合都是可能的。仅在您在 `ReevooMark` 构造函数中使用多个 `TRKREF` 时指定 `trkref`。

<?php $reevooMark->customerExperienceReviews() ?>
<?php $reevooMark->customerExperienceReviews(array("numberOfReviews" => 5)) ?>
<?php $reevooMark->customerExperienceReviews(array("paginated" => true, "numberOfReviews" => 10)) ?>
<?php $reevooMark->customerExperienceReviews(array("trkref" => "REV", "paginated" => true, "locale" => "cs-CZ")) ?>

如果您将 `paginated` 属性设置为 true，则嵌入式评论将显示分页链接。

如果没有评论可用，我们将显示由您指定的 `locale` 语言设定的默认消息。如果您想指定自己的消息，可以通过传递具有值 false 的 `showEmptyMessage` 属性并使用返回值为 false 的 `customerExperienceReviews()` 方法来实现。

<?php if (!$reevooMark->customerExperienceReviews(array("showEmptyMessage" => false))): ?>
  <h2>Sorry, no customer experience reviews here</h2>
<?php endif ?>

嵌入式对话内容

要渲染“嵌入式对话内容”，您可以使用以下示例中的任何一个。`sku` 属性是必填的，但 `trkref` 和 `locale` 是可选的。可选属性的任何组合都是可能的。仅在您在 `ReevooMark` 构造函数中使用多个 `TRKREF` 时指定 `trkref`。

<?php $reevooMark->conversations(array("sku" => "100A")) ?>
<?php $reevooMark->conversations(array("sku" => "100A", "locale" => "en-GB")) ?>
<?php $reevooMark->conversations(array("sku" => "100A", "trkref" => "REV")) ?>

如果没有对话可用，我们将显示由您指定的 `locale` 语言设定的默认消息。如果您想指定自己的消息，可以通过传递具有值 false 的 `showEmptyMessage` 属性并使用返回值为 false 的 `conversations()` 方法来实现。

<?php if (!$reevooMark->conversations(array("sku" => "100A", "showEmptyMessage" => false))): ?>
  <h2>Sorry, no conversations here</h2>
<?php endif ?>

跟踪

如果您在标签页显示评论或以其他方式需要访客在您的网站上点击元素后才看到嵌入式评论，请添加以下 onclick 属性以跟踪点击次数

如果您的 `trkref` 值例如为 "REV"，则添加以下内容

onclick="ReevooMark_REV.track_click_through(‘<SKU>’)”

如果您的 `trkref` 值例如为 "PIU"，则添加以下内容

onclick="ReevooMark_PIU.track_click_through(‘<SKU>’)”

在上面的示例中，您需要将 `trkref` 值作为后缀添加到 `ReevooMark_` 部分。同时请记住用实际产品的 `sku` 替换 ``。

购买跟踪

如果您的网站包含在线购物功能，您可以在“订单确认页面”上使用 `purchaseTrackingEvent()` 方法。

<?php $reevooMark->purchaseTrackingEvent(array("skus" => "111,222,333", "value" => "250")) ?>
<?php $reevooMark->purchaseTrackingEvent(array("trkref" => "HYU", "skus" => "111,222,333", "value" => "250")) ?>

skus 属性值是以逗号分隔的列表，包含了作为订单一部分购买的所有SKU。
value 属性值是订单的总价，不需要包含货币符号。
只有在您在 ReevooMark 构造函数中使用多个 TRKREF 时，才需要指定 trkref 属性值。

所有这些跟踪信息都将通过您的 Reevoo 分析账户供您使用。

购买倾向跟踪

此类型跟踪用于替代没有在其店内提供在线购买且没有订单确认页的零售商的购买跟踪。

这些零售商可以使用 propensityToBuyTrackingEvent() 方法，该方法可以添加到网站上任何他们希望添加的页面上。

<?php $reevooMark->propensityToBuyTrackingEvent(array("action" => "Brochure")) ?>
<?php $reevooMark->propensityToBuyTrackingEvent(array("trkref" => "REV", "action" => "Locate Store", "sku" => "123")) ?>

action 属性值是要跟踪的事件类型，可以是您想要的任何内容，如“用户访问了“立即购买”页面”或“用户请求了宣传册”或“用户请求试驾”等。
sku 属性是可选的，只有当您希望将跟踪事件链接到特定的产品SKU时，才需要包含它。
只有在您在 ReevooMark 构造函数中使用多个 TRKREF 时，才需要指定 trkref 属性值。

所有这些跟踪信息都将通过您的 Google Analytics 账户供您使用。

reevoo / reevoomark-php-api

维护者

详细信息

README

描述

其他语言

功能

支持

安装

实现

替代实现

标准徽章

产品徽章

对话徽章

系列徽章

产品徽章

对话系列徽章

整体服务评分徽章

客户服务评分徽章

配送评分徽章

嵌入式产品评论内容

价格优惠小部件

嵌入式客户体验评论内容

嵌入式对话内容

跟踪

购买跟踪

购买倾向跟踪

更多示例