Skonfiguruj konfigurowalny plan powiadomień

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X.
informacje.

Wprowadzenie

W możliwym do dostosowania planie powiadomień dostawca interfejsu API może dostosować docelową liczbę transakcji na poszczególnych deweloperów aplikacji. Możesz określić, czy i kiedy mają być wysyłane powiadomienia w przypadku osiągnięcia pewnej wartości procentowej liczby docelowej, np. 90%, 100% lub 150%. Dodatkowe informacje Transakcje nie są blokowane po osiągnięciu docelowej liczby.

Konfigurowanie planu powiadomień z możliwością dostosowania za pomocą interfejsu

Skonfiguruj plany powiadomień, które można dostosować, w sposób opisany poniżej.

Edge

Aby skonfigurować plan powiadomień z możliwością dostosowania w interfejsie Edge podczas dodawania lub edytowania szybkości wybierz dla planu typ planu stawek Dostosowywanie powiadomień, a w sekcji Powiadomienie z możliwością dostosowania skonfiguruj te informacje:

Pole Opis Domyślny
Częstotliwość obliczania Okres, w którym obliczana jest liczba transakcji (lub liczba związana z atrybutami niestandardowymi). Wybierz liczbę miesięcy (1–24 miesiące). 1 miesiąc

Jeśli masz zdefiniowane atrybuty niestandardowe dla produktu API, możesz skonfigurować niestandardowy parametr oceny, aby zdefiniować licznik transakcji na podstawie atrybutu niestandardowego.

Możesz na przykład potrzebować:

  • Deweloperzy mogą pobierać z nich zmienną kwotę na podstawie wartości podanej w komunikacie wywołania interfejsu API.
    Na przykład możesz określić opłaty dla deweloperów aplikacji na podstawie liczby bajtów przesłanych w żądaniu do interfejsu API.
  • Łączenie wielu wywołań interfejsu API w jedną transakcję.
    W takim przypadku wybierz opcję „Użyj parametru niestandardowego oceny” i wybierz atrybut niestandardowy z listy.

Więcej informacji znajdziesz w artykule Konfigurowanie planu stawek z wykorzystaniem atrybutów niestandardowych.

Classic Edge (Private Cloud)

Aby skonfigurować plany powiadomień z możliwością dostosowania w interfejsie Classic Edge:

  1. W polu Typ abonamentu wybierz Dostosowywanie powiadomienia. na karcie Szczegóły abonamentu w oknie Plan taryf.

    Przeczytaj artykuł Tworzenie planu stawek w interfejsie. .

  2. W polu Okres odnowienia wpisz liczbę miesięcy, w których przypadku plan miał obowiązywać. zostanie automatycznie odnowiona (chyba że deweloper rozwiąże umowę przed tą datą). Jeśli Jeśli ustawisz tę wartość na 0, plan będzie obowiązywał, dopóki deweloper nie zdecyduje się go zakończyć.
  3. W sekcji Abonament ogólny kliknij Szczegóły.
  4. Jako Podstawę agregacji ustaw okres, w którym liczebność liczba transakcji jest agregowana. Wybierz liczbę od 1 do 24 miesięcy. Domyślna wartość to 1. miesiąc.
  5. Kliknij Zastosuj i zamknij.
  6. Kliknij Zapisz wersję roboczą.
  7. Publikuj plan tylko wtedy, gdy masz absolutną pewność, że jest ostateczny. Przeczytaj artykuł Plany stawek do publikacji dla: Dowiedz się więcej o ustawianiu daty publikacji i publikowaniu planu.

    Po opublikowaniu planu stawek możesz zmienić tylko datę zakończenia. Nie możesz usunąć ceny plan jest dostępny po jego opublikowaniu, ale możesz go anulować i zastąpić jego przyszłą stawką zgodnie z opisem w sekcji Wygaśnięcie opublikowanej stawki .

Konfigurowanie dostosowywanego planu powiadomień przy użyciu interfejsu API

Określ szczegóły planu powiadomień, które można dostosować, we właściwości ratePlanDetails w treści żądania POST pod adresem /organizations/{org_name}/monetization-packages/{package_id}/rate-plans

Aby określić plan powiadomień, który można dostosować, podaj te wartości w RatePlanDetails treści żądania:

Właściwość Wartość
type Ustaw jako: USAGE_TARGET.
meteringType Ustaw jako: DEV_SPECIFIC.
duration Ustaw przedział czasu używany jako podstawa agregacji, razem z parametrem durationType W przypadku planów stawek za powiadomienia z możliwością dostosowania podaj liczbę całkowitą. od 1 do 24.
durationType

Ustaw przedział czasu używany jako podstawa agregacji, razem z parametrem durationType W przypadku planów stawek powiadomień z możliwością dostosowania ustaw tę wartość do MONTH.

Więcej informacji o właściwościach konfiguracji, które można ustawić podczas określania możliwe do dostosowania szczegóły planu powiadomień, patrz Szczegóły abonamentu ustawienia konfiguracji.

Poniższy przykład definiuje możliwy do dostosowania plan powiadomień z zasadą agregacji ustawiony na 1 miesiąc.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "Adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "VOLUME",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password

Ustawianie wartości docelowej liczba transakcji na każdego dewelopera aplikacji korzystającego z interfejsu API

W przypadku każdego dewelopera aplikacji, który zaakceptował plan z możliwością dostosowania stawki, musisz: ustaw docelową liczbę transakcji. Możesz określić, czy i kiedy będą wysyłane powiadomienia na podstawie tego, kiedy zostanie osiągnięta określona wartość procentowa, np. 90%, 100% lub 150%. Dodatkowe transakcje nie są blokowane po osiągnięciu docelowej liczby transakcji.

Możesz ustawić docelową liczbę transakcji dla dewelopera aplikacji po zaakceptowaniu go przez dewelopera plan stawek, a później możesz zaktualizować tę wartość.

Ustawianie docelowej liczby transakcji podczas akceptowania abonamentu

Aby ustawić docelową liczbę transakcji podczas akceptowania abonamentu, podaj w polu quotaTarget w treści żądania w żądaniu POST wysyłanym do /organizations/{org_name}/developers/{developer_id}/developer-rateplans zasób. Ustaw quotaTarget na dodatnią liczbę całkowitą lub 0, aby wyłączyć powiadomienia z aplikacji Google Play. Jeśli nie podasz żadnej wartości, właściwość quotaTarget ma domyślną wartość 0.

Na przykład to żądanie ustawia docelową liczbę transakcji na 4000, gdy aplikacja akceptuje plan zmian.

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

Ustawianie docelowej liczby transakcji podczas aktualizowania akceptowanego abonamentu

Aby ustawić docelową liczbę transakcji, możesz zaktualizować zaakceptowany abonament i określić właściwość quotaTarget w treści żądania w żądaniu PUT w funkcji /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} . Ustaw quotaTarget na dodatnią liczbę całkowitą lub 0, aby wyłączyć powiadomienia wysyłane przez dewelopera aplikacji. Jeśli nie podasz żadnej wartości, właściwość quotaTarget ma domyślną wartość 0.

Gdy zaakceptujesz{developer_rateplan_id} opublikowanego planu stawek.

Na przykład:

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

Możesz też uzyskać {developer-rateplan-id} dla stawki dewelopera planu lekcji, wysyłając żądanie GET do /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, gdzie {developer_id} to adres e-mail dewelopera. Aby dowiedzieć się więcej, Więcej informacji: Wyświetlanie wszystkich planów stawek akceptowanych przez jako deweloper.

Na przykład:

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}
        

To żądanie aktualizuje docelową liczbę transakcji do 4000.

$ curl -H "Content-Type:aplikacja/json" –X UPUT -d \
{ 
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"deweloper@mojafirma.com"
   }
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   }
   "startDate": "2016-04-15 00:00:00",
   "quotaTarget": 4000,
   "suppressOstrzeżenie":false
}' 
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password