MonetizationLimitsCheck politikası

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Genel Bakış

MonetizationLimitsCheck politikası, uygulama geliştirici tarafından yapılan API çağrılarınızda para kazandırma sınırları uygulamanıza olanak tanır.

Politikanın tetiklendiği durumlardan bazıları şunlardır:

• Para kazanma özelliği etkinleştirilmiş API'ye erişen bir uygulama geliştiricisi, ilişkili API ürününe abonelik satın almamışsa
• Geliştiricinin hesabında yeterli bakiye yok.
• Geliştirici, işlem hacmi sınırını aştı.

Politikayı API proxy'nize nasıl ekleyeceğiniz hakkında bilgi edinmek için API proxy'lerinde para kazandırma sınırlarını zorunlu kılma başlıklı makaleyi inceleyin.

<MonetizationLimitsCheck> öğesi

MonetizationLimitsCheck politikasını belirtir.

Aşağıdaki tabloda, <MonetizationLimitsCheck> öğesinin alt öğeleriyle ilgili üst düzey bir açıklama verilmektedir:

<MonetizationLimitsCheck> öğesi şu söz dizimini kullanır:

<?xml version="1.0" encoding="UTF-8"?>
<MonetizationLimitsCheck async="false" continueOnError="false" enabled="true" name="POLICY_NAME">
    <DisplayName>DISPLAY_NAME</DisplayName>
    <IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>
    <Variables>
        <Product>VARIABLE_NAME</Product>
    </Variables>
    <FaultResponse>
        <Set>
            <Payload contentType="text/xml">
                <error>
                    <messages>
                        <message>MESSAGE_TEXT</message>
                        <message>MESSAGE_TEXT</message>
                    </messages>
                </error>
            </Payload>
            <StatusCode>HTTP_STATUS</StatusCode>
            <ReasonPhrase>REASON_TEXT</ReasonPhrase>
        </Set>
    </FaultResponse>
</MonetizationLimitsCheck>

<?xml version="1.0" encoding="UTF-8"?>
<MonetizationLimitsCheck async="false" continueOnError="false" enabled="true" name="Monetization-Limits-Check">
    <DisplayName>Monetization Limits Check</DisplayName>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <Variables>
        <Product>myproductvar.name</Product>
    </Variables>
	<FaultResponse>
	        <Set>
	            <Payload contentType="text/xml">
	                <error>
	                    <messages>
	                        <message>Developer has reached usage quota</message>
	                        <message>Is Developer Suspended - {monetizationLimits.isDeveloperSuspended} </message>
	                    </messages>
	                </error>
	            </Payload>
	            <StatusCode>403</StatusCode>
	            <ReasonPhrase>Forbidden</ReasonPhrase>
	        </Set>
	</FaultResponse>
 </MonetizationLimitsCheck>

Bu öğe, tüm politikalarda ortak olan aşağıdaki özelliklere sahiptir:

Alt öğe referansı

<DisplayName>

Politikayı yönetim kullanıcı arayüzü proxy düzenleyicisinde farklı ve daha doğal bir adla etiketlemek için name özelliğiyle birlikte kullanın.

<DisplayName> öğesi tüm politikalarda ortaktır.

<DisplayName> öğesi şu söz dizimini kullanır:

<PolicyElement>
  <DisplayName>policy_display_name</DisplayName>
  ...
</PolicyElement>

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

<DisplayName> öğesinin özelliği veya alt öğesi yoktur.

<IgnoreUnresolvedVariables>

Apigee, çözümlenmemiş bir değişkenle karşılaştığında politikanın işlenmesinin durdurulup durdurulmayacağını belirler.

Çözümlenmemiş değişkenleri yoksaymak ve işleme devam etmek için değeri true olarak ayarlayın; aksi takdirde false. Varsayılan değer true'dır.

<IgnoreUnresolvedVariables> öğesini true olarak ayarlamak, <MonetizationLimitsCheck> öğesinin continueOnError özelliğini true olarak ayarlamaktan farklıdır. continueOnError değerini true olarak ayarlarsanız Apigee yalnızca değişken hatalarını değil, tüm hataları yoksayar.

<IgnoreUnresolvedVariables> öğesi şu söz dizimini kullanır:

<IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<Variables>

Politika yürütülürken varlık veya kaynak adlarını getirmek istediğiniz akış değişkenlerini belirtir.

<Variables> öğesi içinde yalnızca <Product> öğesini belirtebilirsiniz. Apigee, API ürün adını <Product> öğesinde belirtilen akış değişkeninden alır. <Variables> öğesini belirtmezseniz Apigee varsayılan olarak API ürün adını apiproduct.name bağlam değişkeninden alır. Apigee, API ürün adını kullanarak ürünün karşılık gelen ücret planını alır ve para kazanma sınırları kontrolünü gerçekleştirir.

<Variables> öğesi şu söz dizimini kullanır:

<Variables>
    <Product>VARIABLE_NAME</Product>
</Variables>

<Variables>
    <Product>myproductvar.name</Product>
</Variables>

<Product>

API ürün adını içeren değişkeni belirtir.

<Product> öğesi şu söz dizimini kullanır:

<Product>VARIABLE_NAME</Product>

<Product>myproductvar.name</Product>

<FaultResponse>

Bir hata oluştuğunda istekte bulunan istemciye döndürülen yanıt mesajını tanımlar. Yanıt mesajlarını gereksinimlerinize göre özelleştirebilirsiniz. öğesi ve tüm alt öğeleri hakkında daha fazla bilgi için FaultResponse bölümüne bakın.

Akış değişkenleri

<MonetizationLimitsCheck> öğesinin ContinueOnError özelliğini doğru olarak ayarlarsanız hata oluşmaz. Bu durumda, akış değişkenleri mint.limitsViolated, mint.isDeveloperSuspended ve mint.limitsPolicyError otomatik olarak ayarlanır. Bu değişkenler, gerekirse daha fazla istisna işleme gerçekleştirmek için kullanılabilir.