设置使用时限通知

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息

简介

您可以设置与创收相关的限制，如使用创收限制检查政策强制执行创收限制中所述。您还可以设置自动通知，在接近或达到上限时提醒组织中的开发者和/或用户。

您可以为自定义限制和隐式限制设置自动通知。例如，系统会为您的预付费开发者设置隐式限额，即其预付余额。您可以设置自动通知，以便开发者在接近或已达到预付款余额时收到通知。

工具箱

您可以使用管理界面或 Monetize API 设置与限制有关的自动通知。 如果使用界面，您可以在“通知”页面上设置自动通知。

如果您使用该 API，则可以通过修改创收提供的通知模板来设置自动限制通知。然后，您可以指定相应的条件，使系统发送修改后的模板所提供的通知。

使用界面设置限制通知

  1. 在“添加限制”页的“通知”部分，点击“添加”。系统随即会打开“通知”部分。

  2. 选择通知的级别。这是基于绝对数量或限制百分比的阈值。选择：
    • 下拉菜单中的大于或等于号 (?) 或小于或等于号 (?)。
    • 一个整数（即不包含小数）。绝对值（表示数字值）或百分比（表示百分比值）。对于百分比限制，请务必确保将该限制设置为 >，这意味着当开发者达到或超过该百分比水平时，系统会发送通知。

    例如，如果您将支出限额设置为 100 美元，并将通知设置为大于或等于 90%，则在达到或超过限额 90%（90 美元）时发送通知。

  3. 在“发送电子邮件”字段中，选择一个或多个开发者，或者选择组织中的一个或多个用户。通知将发送给受影响的开发者或用户。

    电子邮件收件人：只有在您将开发者限制条件设置为“不限”或针对特定开发者设置开发者限制条件时，您才能向开发者发送通知。如果选择“不限”，则电子邮件地址列表中会显示“所选开发者（任何）”选项。这意味着，创收功能会向所有受影响的开发者发送通知。如果您选择了某个特定开发者，则会在电子邮件地址列表（其中 {developer_id} 是所选开发者的身份）中看到“所选开发者 ({developer_id})”。创收功能将仅向该特定开发者发送通知。

    如果您未选择“任何”或某个特定开发者作为开发者限制条件，“发送电子邮件”字段中将不会显示“所选开发者（任何）”字样。不过，您可以选择通知贵组织的哪些用户。

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

    电子邮件模板：在“发送电子邮件”字段中选择“所选开发者（任意）”和/或您组织中用户的电子邮件地址后，即会看到电子邮件模板。模板中显示的内容取决于以下因素：

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

    例如，如果满足以下所有条件：

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

    模板如下所示：

    假设开发者的公司名称为“XYZ company”，一个名为“X Package”的 API 软件包和一个名为“Y Product”的 API 产品的交易量上限为 50，到期日期设为 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.

    下面显示的是针对“任何”或特定应用修改过的模板。

    如果未选中“暂停执行”，或者通知级别大于或等于 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%，那么当达到各个级别时，系统会发送通知。
  5. 添加所有通知后，点击“保存”（保存并稍后发布通知）、“保存并发布”（立即发布）或“取消”（取消通知）。

使用 API 设置限制通知

变现服务提供了一组模板，用于为各种类型的通知提供文本，包括限制通知和临时通知（例如提醒开发者有新产品到货）。您可以根据自己的需求定制任何模板。若要设置自动发送限制通知，请先修改相应的模板。然后，指定导致发送修改后的模板提供的通知的条件。 如需了解详情，请参阅使用通知模板设置通知。

后续步骤

了解如何设置自动通知，以便提醒开发者有关新产品、新版条款及条件或新的费率方案等事件。请参阅使用通知模板设置通知。