设置使用时限通知

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档
信息

简介

您可以按照通过“创收”页面实施创收限制功能中的说明,设置与创收相关的限制 限制检查政策。您还可以设置自动通知, 和/或贵组织中的用户。

您可以为自定义限制和隐式限制设置自动通知。对于 例如,系统会为您的预付费开发者设置隐式上限,即他们的预付费 余额。您可以设置自动通知,以便开发者在遇到以下情况时收到通知 即将或已经达到预付款余额。

工具箱

您可以使用管理界面或 monetization API 设置针对限额的自动通知。 如果您使用界面,请在“通知”页面上设置自动通知。

如果您使用 API,则可以通过修改通知来设置针对限制的自动通知 创收功能提供的模板然后指定在什么条件下发送 通过修改后的模板提供的通知

使用界面设置限制通知

  1. 在“添加限制”页面“通知”部分中点击“添加”。此操作会打开通知 部分。

  2. 选择通知级别。这是一个基于绝对数或 百分比。选择: <ph type="x-smartling-placeholder">
      </ph>
    • 大于等于符号 (?) 或小于或等于符号 (?) 的 下拉菜单中。
    • 整数(即不包含小数位)。绝对(表示数字值)或 表示百分比值的百分比。对于百分比限制,请务必将 限制为 >,这表示当开发者达到或 该百分比水平的变化。

    例如,如果您将支出限额设置为 100 美元,并将通知设置为大于 或达到限额的 90% 时发送通知,或者 超出上限。

  3. 在“Send Email”(发送电子邮件)字段中,选择一个或多个开发者,或者选择 组织。系统会向受影响的开发者或用户发送通知。

    电子邮件收件人:只有在设置了 开发者限制条件为“不限”或设置开发者限制条件 开发者。如果您选择了“不限”,则会看到“已选择的开发者(不限)”在 电子邮件地址。也就是说,创收功能会向所有受影响的 开发者。如果您选择了某个特定开发者,则会看到“已选择的开发者” ({developer_id})&quot;(其中 {developer_id} 是所选开发者的标识)。变现 将只向该特定开发者发送通知。

    如果您没有将开发者限制条件选为“不限”或者某个特定开发者, 不会看到“已选择的开发者(任意)”。不过,您可以选择 您要通知贵组织的哪些用户。

    您可以选择“组织”,为贵组织的用户添加电子邮件地址 “管理”标签页中的用户。

    电子邮件模板:在“发送电子邮件”选项中选择后,您会看到一个电子邮件模板 字段“已选择的开发者(任意)”或组织中用户的电子邮件地址(或 模板中显示的内容取决于以下因素:

    • 通知的级别。
    • 该限制是否是暂停执行限制。
    • 该电子邮件的收件人是组织用户、开发者,还是两者都是。

    例如,如果满足以下所有条件:

    • 已选中“暂停执行”复选框。
    • 通知等级为 100% 或与上限相同。
    • 此电子邮件地址仅面向组织用户。

    该模板如下所示:

    假设开发者的公司名称为“XYZ company”,交易量为 针对名为“X Package”的 API 软件包,限制设置为 50和一个名为“Y Product”的 API 产品 失效日期设置为 2013 年 9 月 30 日系统发送的电子邮件将 如下所示:

    Developer XYZ company has exceeded their transaction volume limit of 50 transactions for X package, Y product. Their API calls will be blocked till 2013-09-30

    如果电子邮件发送至“选定的开发者(任意)”标签,则模板将如下所示:

    这两个模板都会解析相关变量,例如开发者名称(如果适用)、 产品名称(如果适用)和产品名称。您可以编辑消息以 只要点击模板左侧的“修改”即可

    如果上限是“不限”或“任意”还是特定用户 需要将应用和用户变量添加到模板中。为此,您可以 如下:

    • 点击模板左侧的 修改 。
    • 添加${user.name} user, depending on whether the limit is for application and/or user.

    针对“Any”修改的模板或具体的应用。

    如果未选中“停止执行”,或者通知级别大于或等于 100%,所选开发者的模板如下所示:

    同样,如果上限是“不限”或“任意”(或特定) 您需要修改模板,然后添加 ${application.name} 应用 和/或 ${user.name} 位用户,具体取决于限制是否针对应用。 还是两者都有

    模板变量:在电子邮件模板中修改邮件时,您可以添加 以下任意变量。

    变量 说明
    ${developer.name}

    开发者的名称。

    ${developer.legalName}

    开发者公司名称。

    ${ratePlan.monetizationPackage.displayName}

    API 软件包的名称。

    ${application.name}

    应用名称。

    ${USER}

    用户的名称。

    ${USAGE}

    当前用量(总收入/费用,或数量)。

    ${PERCENT}

    当前用量达到的限额百分比。

    ${QUOTA_TYPE}

    限制的类型(交易量、支出限额或费用风险)。

    ${QUOTA_UNIT}

    限额的基本单位:币种(表示支出限额)或来电次数(表示 交易限额)。

    ${QUOTA_LIMIT}

    限额金额。

    ${EXPIRY_DATE}

    限制到期或重置的日期或时间。

    例如,如果您希望在某个开发者达到 任何应用的任何软件包的交易量百分比,您可以修改 如下所示:

    ${developer.legalName} has reached a total volume of ${USAGE} on ${ratePlan.monetizationPackage.displayName}. This is ${PERCENT} of the daily/weekly/monthly (state period of limit as appropriate) transaction volume limit of ${QUOTA_LIMIT}.
  4. 根据需要为其他级别添加通知。对于每个额外的级别,请点击“添加”。 此操作会在 页面。您最多可以为通知添加 6 个级别。例如,如果您将 通知名称 >70%、80%、90%、100%,那么每当达到 70%、80%、90%、100% 时,系统都会发送通知。 级别。
  5. 添加所有通知后,点击“保存”(以保存通知并以 保存并发布(立即发布)或“取消”(取消)。

使用 API 设置限制通知

变现服务提供了一组模板,这些模板为各种类型的 通知(包括限制通知)和临时通知(例如提醒) 可让开发者及时了解新产品的发布情况您可以根据自己的需要 满足您的需求如需设置自动限制通知,请先修改相应的模板。然后 指定在什么条件下发送修改后的模板提供的通知。 有关详情,请参阅使用 通知模板

后续步骤

了解如何设置自动通知,以便向开发者发送如下事件提醒: 例如新产品、新版条款及条件或新费率方案。请参阅使用 通知模板