MonetizationLimitsبررسی سیاست

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات

نمای کلی

سیاست MonetizationLimitsCheck به شما امکان می‌دهد محدودیت‌های کسب درآمد را روی فراخوانی‌های API خود که توسط توسعه‌دهنده برنامه انجام می‌شود، اعمال کنید.

برخی از مواردی که این سیاست فعال می‌شود عبارتند از:

• اگر توسعه‌دهنده‌ی اپلیکیشنی که به API پولی دسترسی دارد، اشتراک محصول API مرتبط را خریداری نکرده باشد
• موجودی حساب توسعه‌دهنده کافی نیست.
• توسعه‌دهنده از محدودیت حجم تراکنش عبور کرده است.

برای اطلاعات بیشتر در مورد نحوه‌ی الصاق این سیاست به پروکسی API خود، به اعمال محدودیت‌های کسب درآمد روی پروکسی‌های API مراجعه کنید.

عنصر <MonetizationLimitsCheck>

سیاست MonetizationLimitsCheck را مشخص می‌کند.

جدول زیر توضیحات سطح بالایی از عناصر فرزند <MonetizationLimitsCheck> ارائه می‌دهد:

عنصر <MonetizationLimitsCheck> از سینتکس زیر استفاده می‌کند:

<?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>

این عنصر دارای ویژگی های زیر است که در همه سیاست ها مشترک است:

مرجع عنصر فرزند

<DisplayName>

علاوه بر ویژگی name ، برای برچسب گذاری خط مشی در ویرایشگر پروکسی رابط کاربری مدیریت با نامی متفاوت و طبیعی تر، از آن استفاده کنید.

عنصر <DisplayName> در همه خط مشی ها مشترک است.

عنصر <DisplayName> از نحو زیر استفاده می کند:

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

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

عنصر <DisplayName> هیچ ویژگی یا عنصر فرزند ندارد.

<IgnoreUnresolvedVariables>

تعیین می‌کند که آیا پردازش سیاست باید هنگام مواجهه Apigee با یک متغیر حل نشده متوقف شود یا خیر.

برای نادیده گرفتن متغیرهای حل نشده و ادامه پردازش، مقدار را روی true تنظیم کنید؛ در غیر این صورت false . مقدار پیش‌فرض true است.

تنظیم <IgnoreUnresolvedVariables> روی true با تنظیم continueOnError عنصر <MonetizationLimitsCheck> روی true متفاوت است. اگر continueOnError روی true تنظیم کنید، Apigee نه تنها خطاهای متغیر، بلکه تمام خطاها را نادیده می‌گیرد.

عنصر <IgnoreUnresolvedVariables> از سینتکس زیر استفاده می‌کند:

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

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<Variables>

متغیرهای جریانی را که می‌خواهید نام موجودیت‌ها یا منابع را در طول اجرای سیاست از آنها دریافت کنید، مشخص می‌کند.

شما فقط می‌توانید عنصر <Product> را درون عنصر <Variables> مشخص کنید. Apigee نام محصول API را از متغیر جریان مشخص شده در عنصر <Product> دریافت می‌کند. اگر عنصر <Variables> را مشخص نکنید، Apigee به طور پیش‌فرض نام محصول API را از متغیر زمینه apiproduct.name دریافت می‌کند. با استفاده از نام محصول API، Apigee طرح نرخ مربوطه را برای محصول دریافت می‌کند و بررسی محدودیت‌های کسب درآمد را انجام می‌دهد.

عنصر <Variables> از سینتکس زیر استفاده می‌کند:

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

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

<Product>

متغیری را مشخص می‌کند که نام محصول API را دارد.

عنصر <Product> از سینتکس زیر استفاده می‌کند:

<Product>VARIABLE_NAME</Product>

<Product>myproductvar.name</Product>

<FaultResponse>

پیام پاسخی را که در صورت بروز خطا به کلاینت درخواست‌کننده برگردانده می‌شود، تعریف می‌کند. می‌توانید پیام‌های پاسخ را بر اساس نیازهای خود سفارشی کنید. برای اطلاعات بیشتر در مورد عنصر و تمام عناصر فرزند آن، به FaultResponse مراجعه کنید.

متغیرهای جریان

اگر ویژگی ContinueOnError عنصر <MonetizationLimitsCheck> را روی true تنظیم کنید، هیچ خطایی رخ نمی‌دهد. در این حالت، متغیرهای جریان، mint.limitsViolated ، mint.isDeveloperSuspended و mint.limitsPolicyError به طور خودکار تنظیم می‌شوند. در صورت لزوم، می‌توان از این متغیرها برای انجام مدیریت بیشتر خطاها استفاده کرد.