Benachrichtigungen zu Limits einrichten

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

Einführung

Du kannst Einschränkungen für die Monetarisierung festlegen, wie unter Monetarisierungsbeschränkungen mithilfe der Richtlinie zur Überprüfung der Monetarisierungsbeschränkungen erzwingen beschrieben. Sie können auch automatische Benachrichtigungen einrichten, mit denen Entwickler und/oder Nutzer in Ihrer Organisation benachrichtigt werden, wenn ein Limit bald erreicht oder erreicht wird.

Sie können automatische Benachrichtigungen für benutzerdefinierte und implizite Grenzwerte einrichten. Beispielsweise setzt das System ein implizites Limit für deine Prepaid-Entwickler – das Prepaidguthaben. Sie können automatische Benachrichtigungen einrichten, damit Ihre Entwickler benachrichtigt werden, wenn sie ihr Prepaidguthaben fast erreicht oder erreicht haben.

Abbildung: Toolbox

Sie können automatische Benachrichtigungen für Limits über die Verwaltungsoberfläche oder die Monetarisierungs-API einrichten. Wenn Sie die Benutzeroberfläche verwenden, richten Sie automatische Benachrichtigungen auf der Seite „Benachrichtigungen“ ein.

Wenn du die API verwendest, kannst du automatische Benachrichtigungen für Limits einrichten, indem du eine von der Monetarisierung bereitgestellte Benachrichtigungsvorlage bearbeitest. Anschließend geben Sie die Bedingung an, die zum Senden der von der bearbeiteten Vorlage bereitgestellten Benachrichtigung führt.

Limitbenachrichtigungen über die Benutzeroberfläche einrichten

  1. Klicken Sie auf der Seite "Limit hinzufügen" im Abschnitt Benachrichtigungen auf Hinzufügen. Der Bereich „Benachrichtigungen“ wird geöffnet.

  2. Wählen Sie eine Stufe für die Benachrichtigung aus. Dabei handelt es sich um einen Grenzwert, der auf einer absoluten Zahl oder einem Prozentsatz des Limits basiert. Wählen Sie eine der folgenden Optionen aus:
    • Das Größer- oder Gleichheitszeichen (?) oder das Kleiner-als- oder Gleichheitszeichen (?) aus dem Drop-down-Menü.
    • Eine ganze Zahl, d. h. keine Dezimalstellen Absolut (zur Angabe eines Zahlenwerts) oder Prozentsatz für einen Prozentsatz. Achten Sie bei prozentualen Limits immer darauf, den Grenzwert auf > zu setzen. Dies bedeutet, dass die Benachrichtigung gesendet wird, wenn der Entwickler diesen Prozentsatz erreicht oder überschreitet.

    Wenn Sie beispielsweise eine Ausgabengrenze von 100 $festlegen und für die Benachrichtigung einen Wert von mindestens 90 % festlegen, wird die Benachrichtigung gesendet, wenn 90% des Limits (90 $) erreicht oder überschritten werden.

  3. Wählen Sie im Feld „E-Mail senden“ einen oder mehrere Entwickler oder einen oder mehrere Nutzer in Ihrer Organisation aus. Die betroffenen Entwickler oder Nutzer werden benachrichtigt.

    E-Mail-Empfänger:Sie können Benachrichtigungen nur an Entwickler senden, wenn Sie als Bedingung für das Entwicklerlimit „Beliebig“ oder mit einem bestimmten Entwickler eine Bedingung für das Entwicklerlimit festlegen. Wenn Sie „Alle“ ausgewählt haben, wird „Ausgewählter Entwickler (alle)“ in der Liste der E-Mail-Adressen angezeigt. Alle betroffenen Entwickler werden über die Monetarisierung benachrichtigt. Wenn Sie einen bestimmten Entwickler ausgewählt haben, wird „Ausgewählter Entwickler ({developer_id})“ in der Liste der E-Mail-Adressen angezeigt, wobei {developer_id} die Identifikation des ausgewählten Entwicklers ist. Bei der Monetarisierung wird nur an diesen Entwickler eine Benachrichtigung gesendet.

    Wenn Sie als Bedingung für das Entwicklerlimit nicht „Alle“ oder einen bestimmten Entwickler ausgewählt haben, wird „Ausgewählter Entwickler (alle)“ nicht im Feld „E-Mail senden“ angezeigt. Sie können jedoch auswählen, welche Nutzer Ihrer Organisation Sie benachrichtigen möchten.

    Sie können E-Mail-Adressen für die Nutzer Ihrer Organisation hinzufügen, indem Sie auf dem Tab „Admin“ die Option „Organisationsnutzer“ auswählen.

    E-Mail-Vorlagen: Sie sehen eine E-Mail-Vorlage, nachdem Sie im Feld "E-Mail senden" "Ausgewählter Entwickler (alle)" oder E-Mail-Adressen von Nutzern in Ihrer Organisation (oder beides) ausgewählt haben. Was in der Vorlage angezeigt wird, hängt von folgenden Faktoren ab:

    • Die Benachrichtigungsstufe.
    • Gibt an, ob das Limit ein angehaltenes Ausführungslimit war oder nicht.
    • Ob die E-Mail an Nutzer der Organisation, an Entwickler oder an beides gerichtet ist

    Beispiel:

    • Das Kästchen „Ausführung anhalten“ ist markiert.
    • Die Benachrichtigungsstufe beträgt 100% oder entspricht dem Grenzwert.
    • Die E-Mail ist nur für Nutzer der Organisation bestimmt.

    Die Vorlage sieht so aus:

    Angenommen, der Unternehmensname des Entwicklers lautet „Unternehmen XYZ“. Das Limit für das Transaktionsvolumen beträgt für ein API-Paket namens „X Package“ und ein API-Produkt namens „Y Product“ 50. Das Ablaufdatum ist der 30. September 2013. Die gesendete E-Mail würde so aussehen:

    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

    Wenn die E-Mail „Ausgewählter Entwickler (alle)“ lautet, sieht die Vorlage so aus:

    Beide Vorlagen lösen die relevanten Variablen wie Entwicklername (falls zutreffend), Paketname (falls zutreffend) und Produktname (falls zutreffend) auf. Sie können die Mitteilung bearbeiten, um Ihre Anforderungen zu erfüllen. Klicken Sie dazu links neben der Vorlage auf „Bearbeiten“.

    Wenn das Limit „Beliebig“ oder eine bestimmte Anwendung und „Beliebig“ oder einen bestimmten Nutzer ist, müssen Sie der Vorlage auch Variablen für die Anwendung(en) und Nutzer hinzufügen. Gehen Sie dazu so vor:

    • Klicken Sie links neben der Vorlage auf Bearbeiten.
    • ${user.name} user, depending on whether the limit is for application and/or user. hinzufügen

    Unten sehen Sie eine Vorlage, die für „Beliebig“ oder eine bestimmte Anwendung bearbeitet wurde.

    Wenn die Option „Ausführung anhalten“ nicht aktiviert ist oder die Benachrichtigungsstufe größer oder gleich 100 % ist, sieht die Vorlage für einen ausgewählten Entwickler so aus:

    Wenn das Limit für „Alle“ (oder eine bestimmte) Anwendung, „Alle“ (oder einen bestimmten) Nutzer gilt, müssen Sie die Vorlage bearbeiten und dann die ${application.name}-Anwendung und/oder ${user.name}-Nutzer hinzufügen, je nachdem, ob das Limit für eine Anwendung, einen Nutzer oder beides gilt.

    Vorlagenvariablen:Wenn Sie die Nachricht in einer E-Mail-Vorlage bearbeiten, können Sie die folgenden Variablen einfügen.

    Variable Beschreibung
    ${developer.name}

    Der Name des Entwicklers.
    ${developer.legalName}

    Der Name des Unternehmens des Entwicklers.
    ${ratePlan.monetizationPackage.displayName}

    Der Name des API-Pakets.
    ${application.name}

    Der Name der Anwendung.
    ${USER}

    Der Nutzername.
    ${USAGE}

    Aktuelle Nutzung (Gesamtumsatz, Kosten oder Volumen).
    ${PERCENT}

    Der Prozentsatz des Limits, der aufgrund der aktuellen Nutzung erreicht wurde.
    ${QUOTA_TYPE}

    Die Art der Grenze (Transaktionsvolumen, Ausgabengrenze oder Gebührenpräsenz).
    ${QUOTA_UNIT}

    Die Grundeinheit für das Limit: Währung (für ein Ausgabenlimit) oder Aufrufe (für ein Transaktionslimit).
    ${QUOTA_LIMIT}

    Der Betrag des Limits.
    ${EXPIRY_DATE}

    Datum oder Uhrzeit des Ablaufs oder der Zurücksetzung des Limits.

    Wenn Sie beispielsweise benachrichtigt werden möchten, wenn ein Entwickler einen bestimmten Prozentsatz des Transaktionsvolumens für ein Paket in einer Anwendung erreicht hat, können Sie die Vorlage wie folgt bearbeiten:

    ${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. Fügen Sie für weitere Stufen bei Bedarf Benachrichtigungen hinzu. Klicken Sie für jede weitere Ebene auf „Hinzufügen“. Dadurch wird der Bereich „Benachrichtigungen“ der Seite um die Vorlagenbereiche „Ebene“, „E-Mail senden“ und „E-Mail“ ergänzt. Sie können bis zu sechs Benachrichtigungsstufen hinzufügen. Wenn Sie für die Benachrichtigung beispielsweise > 70%, 80%, 90%, 100 % festlegen, wird eine Benachrichtigung gesendet, sobald jede dieser Werte erreicht ist.
  5. Nachdem Sie alle Benachrichtigungen hinzugefügt haben, klicken Sie auf Speichern (um die Benachrichtigungen zu speichern und später zu veröffentlichen), Speichern und Veröffentlichen (um jetzt zu veröffentlichen) oder auf Abbrechen (Abbrechen).

Limitbenachrichtigungen mithilfe der API einrichten

Für die Monetarisierung stehen verschiedene Vorlagen zur Verfügung, die Text für verschiedene Arten von Benachrichtigungen enthalten. Dazu gehören auch Limitbenachrichtigungen sowie Ad-hoc-Benachrichtigungen, z. B. um Entwickler über die Verfügbarkeit neuer Produkte zu informieren. Sie können jede dieser Vorlagen an Ihre Anforderungen anpassen. Um eine automatische Limitbenachrichtigung einzurichten, bearbeiten Sie zunächst eine entsprechende Vorlage. Geben Sie dann die Bedingung an, die zum Senden der von der bearbeiteten Vorlage bereitgestellten Benachrichtigung führt. Weitere Informationen finden Sie unter Benachrichtigungen mit Benachrichtigungsvorlagen einrichten.

Nächste Schritte

Erfahren Sie, wie Sie automatische Benachrichtigungen einrichten, damit Sie Entwickler über Ereignisse wie neue Produkte, neue Versionen der Nutzungsbedingungen oder neue Preispläne informieren können. Siehe Benachrichtigungen mit Benachrichtigungsvorlagen einrichten.