Dela via


ProductContractProperties interface

Produktprofil.

Extends

Egenskaper

displayName

Produktnamn.

Ärvda egenskaper

approvalRequired

om prenumerationsgodkännande krävs. Om det är falskt godkänns nya prenumerationer automatiskt så att utvecklare kan anropa produktens API:er omedelbart efter prenumerationen. Om det är sant måste administratörer godkänna prenumerationen manuellt innan utvecklaren kan något av produktens API:er. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false.

description

Produktbeskrivning. Kan innehålla HTML-formateringstaggar.

state

om produkten har publicerats eller inte. Publicerade produkter kan identifieras av användare av utvecklarportalen. Icke-publicerade produkter är endast synliga för administratörer. Standardtillståndet för Produkt är intePublicerat.

subscriptionRequired

Om en produktprenumeration krävs för åtkomst till API:er som ingår i den här produkten. Om det är sant kallas produkten "skyddad" och en giltig prenumerationsnyckel krävs för att en begäran till ett API som ingår i produkten ska lyckas. Om det är falskt kallas produkten "öppen" och begäranden till ett API som ingår i produkten kan göras utan en prenumerationsnyckel. Om egenskapen utelämnas när en ny produkt skapas antas värdet vara sant.

subscriptionsLimit

Om antalet prenumerationer som en användare kan ha på den här produkten samtidigt. Ange till null eller utelämna om du vill tillåta obegränsade prenumerationer per användare. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false.

terms

Användningsvillkor för produkten. Utvecklare som försöker prenumerera på produkten kommer att presenteras och måste godkänna dessa villkor innan de kan slutföra prenumerationsprocessen.

Egenskapsinformation

displayName

Produktnamn.

displayName: string

Egenskapsvärde

string

Information om ärvda egenskaper

approvalRequired

om prenumerationsgodkännande krävs. Om det är falskt godkänns nya prenumerationer automatiskt så att utvecklare kan anropa produktens API:er omedelbart efter prenumerationen. Om det är sant måste administratörer godkänna prenumerationen manuellt innan utvecklaren kan något av produktens API:er. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false.

approvalRequired?: boolean

Egenskapsvärde

boolean

Ärvd frånProductEntityBaseParameters.approvalRequired

description

Produktbeskrivning. Kan innehålla HTML-formateringstaggar.

description?: string

Egenskapsvärde

string

Ärvd frånProductEntityBaseParameters.description

state

om produkten har publicerats eller inte. Publicerade produkter kan identifieras av användare av utvecklarportalen. Icke-publicerade produkter är endast synliga för administratörer. Standardtillståndet för Produkt är intePublicerat.

state?: ProductState

Egenskapsvärde

Ärvd frånProductEntityBaseParameters.state

subscriptionRequired

Om en produktprenumeration krävs för åtkomst till API:er som ingår i den här produkten. Om det är sant kallas produkten "skyddad" och en giltig prenumerationsnyckel krävs för att en begäran till ett API som ingår i produkten ska lyckas. Om det är falskt kallas produkten "öppen" och begäranden till ett API som ingår i produkten kan göras utan en prenumerationsnyckel. Om egenskapen utelämnas när en ny produkt skapas antas värdet vara sant.

subscriptionRequired?: boolean

Egenskapsvärde

boolean

Ärvd frånProductEntityBaseParameters.subscriptionRequired

subscriptionsLimit

Om antalet prenumerationer som en användare kan ha på den här produkten samtidigt. Ange till null eller utelämna om du vill tillåta obegränsade prenumerationer per användare. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false.

subscriptionsLimit?: number

Egenskapsvärde

number

Ärvd frånProductEntityBaseParameters.subscriptionsLimit

terms

Användningsvillkor för produkten. Utvecklare som försöker prenumerera på produkten kommer att presenteras och måste godkänna dessa villkor innan de kan slutföra prenumerationsprocessen.

terms?: string

Egenskapsvärde

string

Ärvd frånProductEntityBaseParameters.terms