Konfigurowanie powiadomień o limitach

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Wstęp

Limity związane z zarabianiem możesz ustawić w sposób opisany w artykule Egzekwowanie limitów zarabiania za pomocą zasady sprawdzania limitów zarabiania. Możesz też skonfigurować automatyczne powiadomienia, które będą informować deweloperów lub użytkowników w Twojej organizacji o zbliżającym się lub osiągnięciu limitu.

Możesz skonfigurować automatyczne powiadomienia o limitach niestandardowych i niejawnych. System ustawia na przykład niejawny limit dla deweloperów korzystających z przedpłaty, czyli ich saldo z przedpłaty. Możesz skonfigurować automatyczne powiadomienia, tak aby deweloperzy byli powiadamiani o zbliżających się środkach przedpłaconych lub osiągnięciu ich salda z przedpłaty.

Zestaw narzędzi

Automatyczne powiadomienia o limitach możesz skonfigurować w interfejsie zarządzania lub interfejsie Monetization API. Jeśli korzystasz z interfejsu, możesz skonfigurować automatyczne powiadomienia na stronie Powiadomienia.

Jeśli korzystasz z tego interfejsu API, możesz skonfigurować automatyczne powiadomienia o limitach, edytując szablon powiadomień pochodzący z funkcji zarabiania. Następnie określ warunek, który spowoduje wysłanie powiadomienia dostarczonego przez edytowany szablon.

Konfigurowanie powiadomień o limitach za pomocą interfejsu

  1. Kliknij przycisk Dodaj w sekcji Powiadomienia na stronie Dodaj limit. Otworzy się sekcja powiadomień.

  2. Wybierz poziom powiadomienia. Jest to wartość progowa oparta na liczbie bezwzględnej lub wartości procentowej limitu. Wybierz:
    • Znak większości lub równości (?) albo mniejszy lub równy (?) w menu.
    • Liczba całkowita (bez miejsc po przecinku). Bezwzględna (aby określić wartość liczbową) lub wartość procentowa wskazująca wartość procentową. W przypadku limitów procentowych pamiętaj, by zawsze ustawić limit na >, co oznacza, że powiadomienie jest wysyłane, gdy deweloper osiągnie lub przekroczy ten poziom.

    Jeśli na przykład ustawisz limit wydatków na 100 USD i ustawisz powiadomienie na co najmniej 90%, to powiadomienie zostanie wysłane po osiągnięciu lub przekroczeniu 90% limitu (90 USD).

  3. W polu Wyślij e-maila wybierz co najmniej 1 programistę albo wskaż co najmniej 1 użytkownika w swojej organizacji. Do deweloperów lub użytkowników, których dotyczy ta zmiana, wyślemy powiadomienie.

    Odbiorcy e-maili: powiadomienia możesz wysyłać do deweloperów tylko wtedy, gdy ustawisz warunek limitu dewelopera na „Dowolny” lub określisz warunek limitu dewelopera u określonego dewelopera. Jeśli wybierzesz „Dowolny”, na liście adresów e-mail zobaczysz komunikat „Wybrany deweloper (dowolny)”. Oznacza to, że wszyscy deweloperzy, których dotyczy ta zmiana, otrzymają powiadomienie. Jeśli wybierzesz konkretnego dewelopera, na liście adresów e-mail zobaczysz tekst „Wybrany deweloper ({developer_id})” (gdzie {developer_id} to identyfikator wybranego dewelopera). Funkcja zarabiania spowoduje wysłanie powiadomienia tylko do określonego dewelopera.

    Jeśli nie wybierzesz warunku Limit liczby programistów „Dowolny” lub konkretnego dewelopera, w polu Wyślij e-mail nie zobaczysz opcji „Wybrany deweloper (dowolny)”. Możesz jednak wybrać, których użytkowników w organizacji chcesz powiadomić.

    Możesz dodać adresy e-mail użytkowników w organizacji, wybierając opcję Użytkownicy organizacji na karcie Administracja.

    Szablony e-maili: po zaznaczeniu pola Wyślij e-maila w polu Wyślij e-maila (dowolny deweloper) lub adresów e-mail użytkowników w organizacji (albo obu) pojawi się szablon e-maila. To, co pojawia się w szablonie, zależy od tych czynników:

    • Poziom powiadomienia.
    • Wskazuje, czy limit był ustawiony jako limit na zatrzymanie wykonywania.
    • Określa, czy e-mail był adresowany do użytkowników w organizacji, do deweloperów czy do obu tych osób.

    Jeśli na przykład spełnione są wszystkie te warunki:

    • Pole wyboru Zatrzymaj wykonywanie jest zaznaczone.
    • Powiadomienie musi mieć wartość 100% lub taką samą jak limit.
    • Ten e-mail jest przeznaczony tylko dla użytkowników z organizacji.

    Szablon wygląda tak:

    Załóżmy, że nazwa firmy dewelopera to „firma XYZ”, limit liczby transakcji jest ustawiony na 50 dla pakietu API o nazwie „X Package” i usługi API o nazwie „Y Product”, a data ważności jest ustawiona na 30 września 2013 r. Wysłany e-mail wygląda tak:

    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

    Jeśli adres e-mail to „Wybrany programista (dowolny)”, szablon wygląda tak:

    Oba szablony będą wyświetlać odpowiednie zmienne, np. nazwę dewelopera (w stosownych przypadkach), nazwę pakietu (w odpowiednich przypadkach) i nazwę produktu (w odpowiednich przypadkach). Możesz edytować wiadomość tak, aby spełniała wymagania, klikając Edytuj po lewej stronie szablonu.

    Jeśli limit obejmuje opcję „Dowolna” lub tylko na konkretną aplikację i „Dowolny” lub konkretnego użytkownika, musisz też dodać do szablonu zmienne aplikacji i użytkowników. Możesz to zrobić w następujący sposób:

    • Kliknij Edytuj po lewej stronie szablonu.
    • Dodaj: ${user.name} user, depending on whether the limit is for application and/or user.

    Poniżej znajdziesz szablon zmodyfikowany dla typu „Dowolna” lub dla konkretnej aplikacji.

    Jeśli nie zaznaczysz opcji Zatrzymaj wykonywanie lub poziom powiadomienia jest większy lub równy 100%, szablon wybranego programisty wygląda tak:

    Również jeśli limit dotyczy „Dowolna”, (lub konkretnej) aplikacji albo „Dowolna” (albo dla konkretnego użytkownika), musisz edytować szablon, a następnie dodać aplikację ${application.name} i/lub ${user.name} użytkownika, w zależności od tego, czy limit dotyczy aplikacji, użytkownika czy obu tych rodzajów użytkowników.

    Zmienne szablonu: gdy edytujesz wiadomość w szablonie e-maila, możesz dodać dowolną z tych zmiennych.

    Zmienna Opis
    ${developer.name}

    Nazwa dewelopera.
    ${developer.legalName}

    Nazwa firmy dewelopera.
    ${ratePlan.monetizationPackage.displayName}

    Nazwa pakietu interfejsu API.
    ${application.name}

    Nazwa aplikacji.
    ${USER}

    Nazwa użytkownika.
    ${USAGE}

    Obecne wykorzystanie (łączne przychody, opłaty lub liczba operacji)
    ${PERCENT}

    Wartość procentowa limitu osiągniętego przez bieżące użycie.
    ${QUOTA_TYPE}

    Typ limitu (liczba transakcji, limit wydatków lub narażenie na opłaty).
    ${QUOTA_UNIT}

    Podstawowa jednostka limitu: waluta (w przypadku limitu wydatków) lub wywołania (limit transakcji).
    ${QUOTA_LIMIT}

    Kwota limitu.
    ${EXPIRY_DATE}

    Data i godzina wygaśnięcia limitu lub jego zresetowania.

    Jeśli na przykład chcesz otrzymywać powiadomienia, gdy dowolny programista osiągnie określony procent liczby transakcji dowolnego pakietu w dowolnej aplikacji, możesz zmodyfikować szablon tak:

    ${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. W razie potrzeby dodaj powiadomienia dotyczące kolejnych poziomów. Dla każdego dodatkowego poziomu kliknij Dodaj. Spowoduje to dodanie obszarów Poziom, Wyślij e-maila i Szablon e-maila do sekcji Powiadomienia na tej stronie. Możesz dodać maksymalnie 6 poziomów powiadomień. Jeśli na przykład ustawisz wartość powiadomień na >70%, 80%, 90%, 100%, otrzymasz powiadomienie po osiągnięciu każdego z tych poziomów.
  5. Po dodaniu wszystkich powiadomień kliknij Zapisz (aby zapisać i opublikować powiadomienia później), Zapisz i opublikuj (aby opublikować od razu) lub Anuluj (aby anulować).

Konfigurowanie powiadomień o limitach przy użyciu interfejsu API

Funkcja zarabiania udostępnia zestaw szablonów, które zawierają tekst różnego typu powiadomień, m.in. powiadomień o ograniczeniach oraz bieżących powiadomień, takich jak alerty deweloperów o dostępności nowych usług. Możesz dostosować dowolny z tych szablonów do swoich potrzeb. Aby skonfigurować automatyczne powiadomienia o limitach, zmień najpierw odpowiedni szablon. Następnie określ warunek, który spowoduje wysłanie powiadomienia dostarczonego przez edytowany szablon. Więcej informacji znajdziesz w artykule o konfigurowaniu powiadomień z użyciem szablonów powiadomień.

Dalsze kroki

Dowiedz się, jak skonfigurować powiadomienia automatyczne, aby informować deweloperów o takich wydarzeniach jak nowe produkty, nowe wersje warunków lub nowe abonamenty. Zapoznaj się z artykułem Konfigurowanie powiadomień przy użyciu szablonów powiadomień.