Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

Kebijakan MonetizationLimitsCheck

Kebijakan yang dapat diperluas

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Kebijakan MonetizationLimitsCheck memungkinkan Anda menerapkan batas monetisasi.

Secara khusus, kebijakan ini dipicu jika developer aplikasi yang mengakses API yang dimonetisasi belum membeli langganan ke produk API terkait atau jika developer memiliki saldo yang tidak mencukupi. Dalam kasus ini, kebijakan MonetizationLimitsCheck akan menampilkan kesalahan dan memblokir panggilan API. Untuk mengetahui informasi selengkapnya, lihat Mewajibkan langganan developer ke produk API.

Saat Anda melampirkan kebijakan MonetizationLimitsCheck ke proxy API, variabel alur mint.limitscheck.* dan mint.subscription_* akan diisi, seperti yang dijelaskan dalam referensi variabel alur mint.

Kebijakan ini adalah Kebijakan yang dapat diperluas dan penggunaan kebijakan ini mungkin memiliki implikasi biaya atau penggunaan, bergantung pada lisensi Apigee Anda. Untuk mengetahui informasi tentang jenis kebijakan dan implikasi penggunaannya, lihat Jenis kebijakan.

`<MonetizationLimitsCheck>`

Menentukan kebijakan MonetizationLimitsCheck.

Nilai Default	T/A
Wajib?	Wajib
Jenis	Jenis kompleks
Elemen Induk	T/A
Elemen Turunan	`<DisplayName>` `<FaultResponse>` `<IgnoreUnresolvedVariables>`

Tabel berikut memberikan deskripsi umum tentang elemen turunan <MonetizationLimitsCheck>:

Elemen Turunan	Wajib?	Deskripsi
`<DisplayName>`	Opsional	Nama kustom untuk kebijakan.
`<FaultResponse>`	Opsional	Menentukan pesan respons yang ditampilkan ke klien yang meminta.
`<IgnoreUnresolvedVariables>`	Opsional	Mengabaikan error variabel yang belum terselesaikan dalam alur.

Elemen <MonetizationLimitsCheck> menggunakan sintaksis berikut:

Sintaksis

<?xml version="1.0" encoding="UTF-8" standalone="no"?><MonetizationLimitsCheck continueOnError="[true|false]" enabled="[true|false]" name="policy_name">
   <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
   <FaultResponse>
        <AssignVariable>
          <Name/>
          <Value/>
        </AssignVariable>
        <Add>
            <Headers/>
        </Add>
        <Copy source="request">
            <Headers/>
            <StatusCode/>
       </Copy>
        <Remove>
            <Headers/>
        </Remove>
        <Set>
            <Headers/>
            <Payload/>
            <StatusCode/>
        </Set>
    </FaultResponse>
    <IgnoreUnresolvedVariables>VALUE</IgnoreUnresolvedVariables>
</MonetizationLimitsCheck>

Contoh

Dalam contoh berikut, jika developer belum membeli langganan ke produk API terkait, akses ke API yang dimonetisasi akan diblokir, dan status 403 akan ditampilkan dengan pesan kustom.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<MonetizationLimitsCheck continueOnError="false" enabled="true" name="MonetizationLimitsCheck-1">
  <DisplayName>Monetization-Limits-Check-1</DisplayName>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <FaultResponse>
    <Set>
      <Payload contentType="text/xml">
        <error>
          <messages>
            <message>Usage has been exceeded ({mint.limitscheck.isRequestBlocked}) or app developer has been suspended</message>
          </messages>
        </error>
      </Payload>
      <StatusCode>403</StatusCode>
    </Set>
  </FaultResponse>
</MonetizationLimitsCheck>

Elemen ini memiliki atribut berikut yang umum untuk semua kebijakan:

Atribut	Default	Wajib?	Deskripsi
`name`	T/A	Wajib	Nama internal kebijakan. Nilai atribut `name` dapat berisi huruf, angka, spasi, tanda hubung, garis bawah, dan titik. Nilai ini tidak boleh melebihi 255 karakter. Secara opsional, gunakan elemen `<DisplayName>` untuk memberi label pada kebijakan di editor proxy UI pengelolaan dengan nama bahasa alami yang berbeda.
`continueOnError`	false	Opsional	Tetapkan ke `false` untuk menampilkan error saat kebijakan gagal. Perilaku ini wajar terjadi untuk sebagian besar kebijakan. Tetapkan ke `true` agar eksekusi alur berlanjut meskipun setelah kebijakan gagal. Lihat juga: Aturan error HANYA dipicu dalam status error (tentang continueOnError) Menangani error dalam alur saat ini
`enabled`	benar	Opsional	Tetapkan ke `true` untuk menerapkan kebijakan. Tetapkan ke `false` untuk menonaktifkan kebijakan. Kebijakan tidak akan diterapkan meskipun tetap terlampir ke alur.
`async`	false	Tidak digunakan lagi	Atribut ini tidak digunakan lagi.

Referensi elemen turunan

Bagian ini menjelaskan elemen turunan <MonetizationLimitsCheck>.

`<DisplayName>`

Gunakan selain atribut name untuk memberi label pada kebijakan di editor proxy UI pengelolaan dengan nama yang berbeda dan lebih terdengar alami.

Elemen <DisplayName> umum untuk semua kebijakan.

Nilai Default	T/A
Wajib?	Opsional. Jika Anda menghilangkan `<DisplayName>`, nilai atribut `name` kebijakan akan digunakan.
Jenis	String
Elemen Induk	<`PolicyElement`>
Elemen Turunan	Tidak ada

Elemen <DisplayName> menggunakan sintaksis berikut:

Sintaks

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

Contoh

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

Elemen <DisplayName> tidak memiliki atribut atau elemen turunan.

`<FaultResponse>`

Menentukan pesan respons yang ditampilkan ke klien yang meminta. FaultResponse menggunakan setelan yang sama dengan elemen <FaultResponse> dalam kebijakan RaiseFault.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	`<MonetizationLimitsCheck>`
Elemen Turunan	`<AssignVariable>` `<Add>` `<Copy>` `<Remove>` `<Set>`

`<AssignVariable>`

Menetapkan nilai ke variabel alur tujuan. Jika variabel alur tidak ada, AssignVariable akan membuatnya.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	`<FaultResponse>`
Elemen Turunan	`<Name>` `<Value>`

Misalnya, gunakan kode berikut untuk menetapkan variabel bernama myFaultVar dalam kebijakan MonetizationLimitsCheck:

<FaultResponse>
<AssignVariable>
  <Name>myFaultVar</Name>
  <Value>42</Value>
</AssignVariable>
</FaultResponse>

Kebijakan dalam aturan kesalahan kemudian dapat mengakses variabel. Misalnya, kebijakan AssignMessage berikut menggunakan variabel untuk menetapkan Header dalam respons error:

<AssignMessage enabled="true" name="Assign-Message-1">
<Add>
  <Headers>
    <Header name="newvar">{myFaultVar}</Header>
  </Headers>
</Add>
<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
<AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

<AssignVariable> dalam kebijakan MonetizationLimitsCheck menggunakan sintaksis yang sama dengan elemen <AssignVariable> dalam kebijakan AssignMessage.

`<Name>`

Nama variabel. Untuk mengetahui informasi selengkapnya, lihat elemen Name dalam kebijakan AssignMessage.

Nilai Default	T/A
Wajib?	Opsional
Jenis	String
Elemen Induk	`<AssignVariable>`
Elemen Turunan	Tidak ada

`<Value>`

Nilai variabel. Untuk mengetahui informasi selengkapnya, lihat elemen Nilai dalam kebijakan AssignMessage.

Nilai Default	T/A
Wajib?	Opsional
Jenis	String
Elemen Induk	`<AssignVariable>`
Elemen Turunan	Tidak ada

`<Add>`

Menambahkan header HTTP ke pesan error.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	`<FaultResponse>`
Elemen Turunan	`<Headers>`

`<Headers>`

Menentukan header HTTP yang akan ditambahkan, ditetapkan, disalin, atau dihapus.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	`<Add>` `<Copy>` `<Remove>` `<Set>`
Elemen Turunan	Tidak ada

Contoh:

Tambahkan header

Contoh berikut menyalin nilai variabel alur request.user.agent ke dalam header:

<Add>
    <Headers>
        <Header name="user-agent">{request.user.agent}</Header>
    </Headers>
</Add>

Menetapkan header

Contoh berikut menetapkan header user-agent ke variabel pesan yang ditentukan dengan elemen <AssignTo>.

<Set>
    <Headers>
        <Header name="user-agent">{request.header.user-agent}</Header>
    </Headers>
</Set>

Salin header - 1

Contoh berikut menyalin headerA dari permintaan:

<Copy source='request'>
    <Headers>
        <Header name="headerA"/>
    </Headers>
</Copy>

Salin header - 2

Contoh berikut menyalin beberapa header:

<Copy source='request'>
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
</Copy>

Contoh ini menyalin "h1", "h2", dan nilai kedua "h3". Jika "h3" hanya memiliki satu nilai, maka "h3" tidak disalin.

Hapus header - 1

Contoh berikut menghapus header:

<Remove>
    <Headers>
        <Header name="user-agent"/>
    </Headers>
</Remove>

Hapus header - 2

Contoh berikut menghapus beberapa header:

<Remove>
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
</Remove>

Contoh ini menghapus "h1", "h2", dan nilai kedua "h3". Jika "h3" hanya memiliki satu nilai, "h3" tidak akan dihapus.

`<Copy>`

Menyalin informasi dari pesan yang ditentukan oleh atribut source ke pesan error.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	`<FaultResponse>`
Elemen Turunan	`<Headers>` `<StatusCode>`

Tabel berikut menjelaskan atribut <Copy>:

Atribut	Wajib?	Jenis	Deskripsi
sumber	Opsional	String	Menentukan objek sumber salinan. Jika source tidak ditentukan, pesan akan diperlakukan sebagai pesan sederhana. Misalnya, jika kebijakan berada dalam alur permintaan, maka sumber akan ditetapkan secara default ke objek request. Jika kebijakan ada dalam alur respons, kebijakan akan ditetapkan secara default ke objek response. Jika Anda menghilangkan sumber, Anda dapat menggunakan referensi absolut ke variabel alur sebagai sumber salinan. Misalnya, tentukan nilai sebagai {request.header.user-agent}. Jika variabel sumber tidak dapat di-resolve, atau di-resolve ke jenis non-pesan, <Copy> gagal merespons.

Atribut

Wajib?

Jenis

Deskripsi

sumber

Opsional

String

Menentukan objek sumber salinan.

Jika source tidak ditentukan, pesan akan diperlakukan sebagai pesan sederhana. Misalnya, jika kebijakan berada dalam alur permintaan, maka sumber akan ditetapkan secara default ke objek request. Jika kebijakan ada dalam alur respons, kebijakan akan ditetapkan secara default ke objek response. Jika Anda menghilangkan sumber, Anda dapat menggunakan referensi absolut ke variabel alur sebagai sumber salinan. Misalnya, tentukan nilai sebagai {request.header.user-agent}.
Jika variabel sumber tidak dapat di-resolve, atau di-resolve ke jenis non-pesan, <Copy> gagal merespons.

`<StatusCode>`

Menentukan kode status HTTP dalam pesan error. Anda dapat menyalin atau menetapkan nilai dari untuk objek yang ditentukan oleh atribut source.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	`<Copy>` `<Set>`
Elemen Turunan	Tidak ada

Contoh:

Menyalin kode status

<Copy source='response'>
    <StatusCode>404</StatusCode>
</Copy>

Menetapkan kode status

<Set source='request'>
    <StatusCode>404</StatusCode>
</Set>

`<Remove>`

Menghapus header HTTP tertentu dari pesan error. Untuk menghapus semua header, tentukan <Remove><Headers/></Remove>.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	`<FaultResponse>`
Elemen Turunan	`<Headers>`

`<Set>`

Menetapkan informasi dalam pesan error.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	`<FaultResponse>`
Elemen Turunan	`<Headers>` `<Payload>` `<StatusCode>`

`<Payload>`

Menetapkan payload pesan error.

Nilai Default	T/A
Wajib?	Opsional
Jenis	String
Elemen Induk	`<Set>`
Elemen Turunan	Tidak ada

Contoh:

Menetapkan payload teks

<Set>
    <Payload contentType="text/plain">test1234</Payload>
</Set>

Tetapkan payload JSON - 1

<Set>
    <Payload contentType="application/json">
        {"name":"foo", "type":"bar"}
    </Payload>
</Set>

Menetapkan payload JSON - 2

<Set>
    <Payload contentType="application/json" variablePrefix="@" variableSuffix="#">
        {"name":"foo", "type":"@variable_name#"}
    </Payload>
</Set>

Contoh ini menyisipkan variabel menggunakan atribut variablePrefix dan variableSuffix dengan karakter pembatas.

Setel payload JSON - 3

<Set>
    <Payload contentType="application/json">
        {"name":"foo", "type":"{variable_name}"}
    </Payload>
</Set>

Contoh ini menyisipkan variabel menggunakan tanda kurung kurawal. Anda dapat menggunakan tanda kurung kurawal mulai dengan rilis 16.08.17.

Menetapkan payload XML

<Set>
    <Payload contentType="text/xml">
        <root>
          <e1>sunday</e1>
          <e2>funday</e2>
          <e3>{var1}</e3>
    </Payload>
</Set>

Contoh ini menyisipkan variabel menggunakan tanda kurung kurawal. Anda dapat menggunakan tanda kurung kurawal mulai dengan rilis 16.08.17.

`<IgnoreUnresolvedVariables>`

Menentukan apakah pemrosesan berhenti saat variabel yang belum diselesaikan ditemukan.

Setel ke true untuk mengabaikan variabel yang belum diselesaikan dan melanjutkan pemrosesan; jika tidak, setel ke false. Nilai default-nya adalah true.

Menetapkan <IgnoreUnresolvedVariables> ke true berbeda dengan menetapkan continueOnError <MonetizationLimitsCheck>ke true. Jika Anda menetapkan continueOnError ke true, Apigee akan mengabaikan semua error, bukan hanya error dalam variabel.

Elemen <IgnoreUnresolvedVariables> menggunakan sintaksis berikut:

Sintaksis

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

Contoh

Contoh berikut menetapkan <IgnoreUnresolvedVariables> ke false:

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

Kode error

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`mint.service.subscription_not_found_for_developer`	`500`	This error occurs when a developer does not have a subscription to the API Product.
`mint.service.wallet_not_found_for_developer`	`500`	This error occurs when a prepaid developer attempts to consume a monetized API without maintaining a wallet for the currency specified in rate plan.
`mint.service.developer_usage_exceeds_balance`	`500`	This error occurs when a prepaid developer's usage exceeds the wallet balance.
`mint.service.wallet_blocked_due_to_inactivity`	`500`	This error occurs when a prepaid developer's wallet is not topped up in over 1.5 years and the developer attempts to consume an API.

Fault variables

Whenever there are execution errors in a policy, Apigee generates error messages. You can view these error messages in the error response. Many a time, system generated error messages might not be relevant in the context of your product. You might want to customize the error messages based on the type of error to make the messages more meaningful.

To customize the error messages, you can use either fault rules or the RaiseFault policy. For information about differences between fault rules and the RaiseFault policy, see FaultRules vs. the RaiseFault policy. You must check for conditions using the Condition element in both the fault rules and the RaiseFault policy. Apigee provides fault variables unique to each policy and the values of the fault variables are set when a policy triggers runtime errors. By using these variables, you can check for specific error conditions and take appropriate actions. For more information about checking error conditions, see Building conditions.

Variables	Where	Example
`fault.name`	The `fault.name` can match to any of the faults listed in the Runtime errors table. The fault name is the last part of the fault code.	`fault.name Matches "UnresolvedVariable"`
`MonetizationLimitsCheck.POLICY_NAME.failed`	`POLICY_NAME` is the user-specified name of the policy that threw the fault.	`MonetizationLimitsCheck.monetization-limits-check-1.failed = true`

For more information about policy errors, see What you need to know about policy errors

Variabel alur

Variabel alur standar berikut akan otomatis terisi saat kebijakan MonetizationLimitsCheck dijalankan. Untuk mengetahui informasi selengkapnya, lihat variabel alur mint.

Variabel alur	Deskripsi
`mint.limitscheck.is_request_blocked`	`true` untuk permintaan yang diblokir.
`mint.limitscheck.is_subscription_found`	`true` jika langganan API ditemukan.
`mint.limitscheck.purchased_product_name`	Nama produk API yang dibeli. Misalnya: `MyProduct`.
`mint.limitscheck.status_message`	Pesan status. Nilai berikut dapat ditampilkan: `limits_check_success` - Pemeriksaan batas berhasil. `apiproduct_name_and_developer_email_not_available` - Tidak dapat menentukan developer API atau nama produk API untuk melakukan pemeriksaan batas. `apiproduct_name_not_available` - Tidak dapat menentukan nama produk API untuk melakukan pemeriksaan batas. `developer_email_not_available` - Tidak dapat menentukan email developer API untuk melakukan pemeriksaan batas. `developer_usage_exceeds_balance` - Saldo developer prabayar terlalu rendah. `rateplan_not_available` - Produk API tanpa paket tarif, tidak ada kesalahan. `subscription_not_available` - Developer API yang memiliki aplikasi tidak memiliki langganan. `wallet_disabled_due_to_inactivity` - Developer belum menggunakan wallet-nya selama lebih dari setahun. Pengisian ulang minimal satu unit (dalam dolar, ini akan menjadi $0,01) akan mengaktifkannya kembali. `wallet_not_found` - Developer tidak memiliki dompet. Hal ini dapat terjadi jika tidak ada pengisian ulang yang dilakukan untuk developer tersebut.
`mint.subscription_end_time_ms`	Waktu berakhir langganan produk API.
`mint.subscription_start_time_ms`	Waktu mulai langganan produk API. Misalnya: `1618433956209`.

Kebijakan MonetizationLimitsCheck Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

<MonetizationLimitsCheck>

Sintaksis

Contoh

Referensi elemen turunan

<DisplayName>

Sintaks

Contoh

<FaultResponse>

<AssignVariable>

<Name>

<Value>

<Add>

<Headers>

Tambahkan header

Menetapkan header

Salin header - 1

Salin header - 2

Hapus header - 1

Hapus header - 2

<Copy>

<StatusCode>

Menyalin kode status

Menetapkan kode status

<Remove>

<Set>

<Payload>

Menetapkan payload teks

Tetapkan payload JSON - 1

Menetapkan payload JSON - 2

Setel payload JSON - 3

Menetapkan payload XML

<IgnoreUnresolvedVariables>

Sintaksis

Contoh

Kode error

Runtime errors

Fault variables

Variabel alur

Kebijakan MonetizationLimitsCheck

`<MonetizationLimitsCheck>`

`<DisplayName>`

`<FaultResponse>`

`<AssignVariable>`

`<Name>`

`<Value>`

`<Add>`

`<Headers>`

`<Copy>`

`<StatusCode>`

`<Remove>`

`<Set>`

`<Payload>`

`<IgnoreUnresolvedVariables>`