设置使用时限通知

您正在查看 Apigee Edge 文档。
转到 Apigee X 文档。 info

简介

您可以设置与获利相关的限制，如在使用 Monetization Limits Check 政策强制执行获利限制中所述。您还可以设置自动通知，以便在限制即将达到或已达到时提醒开发者 和/或组织中的用户。

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

工具箱

您可以使用管理界面或获利 API 为限制设置自动通知。 如果您使用界面，则可以在“通知”页面上设置自动通知。

如果您使用 API，则可以通过修改获利提供的通知 模板来为限制设置自动通知。然后，您可以指定导致发送 修改后的模板提供的通知的条件。

使用界面设置限制通知

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

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

    例如，如果您设置的支出限制为 100 美元，并且将通知设置为大于或等于 90%，那么当达到或超过限制的 90%（即 90 美元）时，系统会发送通知。

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

    电子邮件收件人：只有在您将 开发者限制条件设置为“任意”或将开发者限制条件设置为特定 开发者时，才能向开发者发送通知。如果您选择了“任意”，您将在电子邮件地址列表中看到“所选开发者（任意）”。 电子邮件地址。这意味着获利将向任何受影响的 开发者发送通知。如果您选择了特定开发者，您将在电子邮件地址列表中看到“所选开发者 ({developer_id})”（其中 {developer_id} 是所选开发者的标识）。获利 将仅向该特定开发者发送通知。

    如果您未选择“任意”开发者限制条件或特定开发者，您 将不会在“发送电子邮件”字段中看到“所选开发者（任意）”。不过，您可以选择要通知的组织用户。

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

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

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

    例如，如果以下所有条件都成立：

    • “停止执行”复选框处于选中状态。
    • 通知级别为 100% 或与限制金额相同。
    • 电子邮件仅发送给组织用户。

    模板如下所示：

    假设开发者的公司名称为“XYZ 公司”，名为“X 软件包”的 API 软件包和名为“Y 产品”的 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 设置限制通知

获利提供了一组模板，其中包含各种类型通知的文本，包括限制通知以及临时通知，例如提醒开发者有新产品可用。您可以根据需要定制这些模板中的任何一个 。如需设置自动限制通知，请先修改相应的模板。然后，您可以指定导致发送修改后的模板提供的通知的条件。如需了解详情，请参阅使用 通知模板设置通知。

后续步骤

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