Benachrichtigungen zu Limits einrichten

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu Apigee X. info

Einführung

Sie können Monetarisierungslimits festlegen, wie unter Monetarisierungslimits mit der Richtlinie „Monetization Limits Check“ erzwingen beschrieben. Sie können auch automatische Benachrichtigungen einrichten, die Entwickler, und/oder Nutzer in Ihrer Organisation benachrichtigen, wenn ein Limit sich nähert oder erreicht wird.

Sie können automatische Benachrichtigungen für benutzerdefinierte Limits sowie für implizite Limits einrichten. Das System legt beispielsweise ein implizites Limit für Ihre Prepaid-Entwickler fest, nämlich ihr Prepaid Guthaben. Sie können automatische Benachrichtigungen einrichten, damit Ihre Entwickler benachrichtigt werden, wenn sie sich ihrem Prepaid-Guthaben nähern oder es erreicht haben.

Toolbox

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

Wenn Sie die API verwenden, richten Sie automatische Benachrichtigungen für Limits ein, indem Sie eine von der Monetarisierung bereitgestellte Benachrichtigung svorlage bearbeiten. Anschließend geben Sie die Bedingung an, die zum Senden der Benachrichtigung führt, die von der bearbeiteten Vorlage bereitgestellt wird.

Limitbenachrichtigungen über die UI einrichten

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

  2. Wählen Sie eine Ebene für die Benachrichtigung aus. Dies ist ein Schwellenwert, der auf einer absoluten Zahl oder einem Prozentsatz der Limitbasis basiert. Wählen Sie Folgendes aus:
    • Das Zeichen „größer als oder gleich“ (?) oder das Zeichen „kleiner als oder gleich“ (?) aus dem Drop-down-Menü.
    • Eine ganze Zahl (d. h. keine Dezimalstellen). „Absolut“ (für einen Zahlenwert) oder „Prozentsatz“ (für einen Prozentwert). Bei prozentualen Limits müssen Sie das Limit immer auf „>“ festlegen. Das bedeutet, dass die Benachrichtigung gesendet wird, wenn der Entwickler diesen Prozentsatz erreicht oder überschreitet.

    Wenn Sie beispielsweise ein Ausgabenlimit von 100 $ festlegen und die Benachrichtigung auf „größer als oder gleich 90 %“ setzen, wird die Benachrichtigung gesendet, wenn 90% des Limits (90 $) erreicht oder überschritten werden.

  3. Wählen Sie im Feld „E‑Mail senden an“ einen oder mehrere Entwickler oder einen oder mehrere Nutzer in Ihrer Organisation aus. Die Benachrichtigung wird an die betroffenen Entwickler oder Nutzer gesendet.

    E‑Mail-Empfänger:Sie können Benachrichtigungen nur an Entwickler senden, wenn Sie die Limitbedingung „Entwickler“ auf „Beliebig“ oder eine Limitbedingung für einen bestimmten Entwickler festlegen. Wenn Sie „Beliebig“ ausgewählt haben, wird in der Liste der E‑Mail-Adressen „Ausgewählter Entwickler (Beliebig)“ angezeigt. Das bedeutet, dass die Monetarisierung eine Benachrichtigung an alle betroffenen Entwickler sendet. Wenn Sie einen bestimmten Entwickler ausgewählt haben, wird in der Liste der E‑Mail-Adressen „Ausgewählter Entwickler ({developer_id})“ angezeigt, wobei {developer_id} die ID des ausgewählten Entwicklers ist. Die Monetarisierung sendet nur an diesen bestimmten Entwickler eine Benachrichtigung.

    Wenn Sie keine Limitbedingung für Entwickler mit dem Wert "Beliebig" oder einen bestimmten Entwickler ausgewählt haben, wird im Feld "E‑Mail senden an" nicht "Ausgewählter Entwickler (Beliebig)" angezeigt. Sie können jedoch auswählen, welche Nutzer Ihrer Organisation benachrichtigt werden sollen.

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

    E‑Mail-Vorlagen: Eine E‑Mail-Vorlage wird angezeigt, nachdem Sie im Feld „E‑Mail senden an“ die Option „Ausgewählter Entwickler (Beliebig)“ oder E‑Mail-Adressen von Nutzern in Ihrer Organisation (oder beides) ausgewählt haben. Was in der Vorlage angezeigt wird, hängt von Folgendem ab:

    • Die Ebene der Benachrichtigung.
    • Ob das Limit ein Limit für die Ausführung war.
    • Ob die E‑Mail für Organisationsnutzer, Entwickler oder beide bestimmt war.

    Wenn beispielsweise alle folgenden Bedingungen erfüllt sind:

    • Das Kästchen „Ausführung anhalten“ ist angekreuzt.
    • Die Ebene der Benachrichtigung ist 100% oder entspricht dem Limit.
    • Die E‑Mail ist nur für Organisationsnutzer bestimmt.

    Die Vorlage sieht so aus:

    Angenommen, der Name des Unternehmens des Entwicklers ist „XYZ company“, das Limit für das Transaktionsvolumen ist auf 50 für ein API-Paket mit dem Namen „X Package“ und ein API-Produkt mit dem Namen „Y Product“ festgelegt, und das Ablaufdatum ist der 30. September 2013. Die gesendete E‑Mail-Nachricht sieht so aus:

    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 an „Ausgewählter Entwickler (Beliebig)“ gesendet wird, sieht die Vorlage so aus:

    In beiden Vorlagen werden die relevanten Variablen wie Entwicklername (falls zutreffend), Paketname (falls zutreffend) und Produktname (falls zutreffend) aufgelöst. Sie können die Nachricht an Ihre Anforderungen anpassen, indem Sie links neben der Vorlage auf „Bearbeiten“ klicken.

    Wenn das Limit für "Beliebig" oder eine bestimmte Anwendung und "Beliebig" oder einen bestimmten Nutzer gilt, müssen Sie der Vorlage auch Variablen für die Anwendung(en) und den/die Nutzer hinzufügen. So geht das:

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

    Unten sehen Sie eine für „Beliebig“ oder eine bestimmte Anwendung bearbeitete Vorlage.

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

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

    Vorlagenvariablen: Wenn Sie die Nachricht in einer E‑Mail-Vorlage bearbeiten, können Sie eine der 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 oder -gebühren oder -volumen).
    ${PERCENT}

    Der Prozentsatz des Limits, der durch die aktuelle Nutzung erreicht wurde.
    ${QUOTA_TYPE}

    Die Art des Limits (Transaktionsvolumen, Ausgabenlimit oder Gebührenrisiko).
    ${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}

    Das Datum oder die Uhrzeit, an dem/der das Limit abläuft oder zurückgesetzt wird.

    Wenn Sie beispielsweise benachrichtigt werden möchten, wenn ein Entwickler einen bestimmten Prozent des Transaktionsvolumens für ein beliebiges Paket in einer beliebigen Anwendung erreicht hat, können Sie die Vorlage so 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 nach Bedarf Benachrichtigungen für zusätzliche Ebenen hinzu. Klicken Sie für jede zusätzliche Ebene auf „Hinzufügen“. Dadurch werden dem Abschnitt „Benachrichtigungen“ der Seite die Bereiche „Ebene“, „E‑Mail senden an“ und „E‑Mail-Vorlage“ hinzugefügt. Sie können bis zu sechs Ebenen für Ihre Benachrichtigungen hinzufügen. Wenn Sie die Benachrichtigung beispielsweise auf „> 70%, 80%, 90%, 100 %“ festlegen, wird eine Benachrichtigung gesendet, wenn jede dieser Ebenen erreicht wird.
  5. Nachdem Sie alle Benachrichtigungen hinzugefügt haben, klicken Sie auf „Speichern“ (um die Benachrichtigungen zu speichern und zu einem späteren Zeitpunkt zu veröffentlichen), „Speichern und veröffentlichen“ (um sie jetzt zu veröffentlichen) oder „Abbrechen“ (um den Vorgang abzubrechen).

Limitbenachrichtigungen über die API einrichten

Die Monetarisierung bietet eine Reihe von Vorlagen, die den Text für verschiedene Arten von Benachrichtigungen enthalten, darunter 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 Bedürfnisse anpassen. Um eine automatische Limitbenachrichtigung einzurichten, bearbeiten Sie zuerst eine geeignete Vorlage. Anschließend geben Sie die Bedingung an, die zum Senden der Benachrichtigung führt, die von der bearbeiteten Vorlage bereitgestellt wird. Weitere Informationen finden Sie unter Benachrichtigungen mit Benachrichtigungsvorlagen einrichten.

Nächste Schritte

Informationen zum Einrichten automatischer Benachrichtigungen, damit Sie Entwickler über Ereignisse wie neue Produkte, neue Versionen der Nutzungsbedingungen oder neue Preispläne informieren können, finden Sie unter Benachrichtigungen mit Benachrichtigungsvorlagen einrichten.