خط‌مشی MonetizationLimitsCheck

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

نمای کلی

خط‌مشی MonetizationLimitsCheck به شما امکان می‌دهد محدودیت‌های درآمدزایی را بر روی تماس‌های 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 با تنظیم عنصر <MonetizationLimitsCheck> continueOnError روی 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 را ببینید.

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

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