Data dictionary

Name

Type

Description

Required

name

String

The name of the first-level category that a mini program belongs to.

M

identifier

String

The unique ID that is assigned by Mini Program Platform to identify the first-level mini program category.

M

category2

String

The name of the secondary category that a mini program belongs to.

O

categoryCode2

String

The unique ID that is assigned by Mini Program Platform to identify the secondary mini program category.

O

category3

String

The name of the tertiary category that a mini program belongs to.

O

categoryCode3

String

The unique ID that is assigned by Mini Program Platform to identify the tertiary mini program category.

O

Name

Type

Description

Required

identifier

String

The unique ID that is assigned by Mini Program Platform to identify a mini program.

M

name

String

The mini program name.

M

slogan

String

The mini program tagline.

M

iconURL

String

The URL of the mini program logo.

M

releaseVersion

String

The release version of a mini program, which follows the major.minor.patch.timestamp pattern. For example, "1.0.1.1653969582308".

M

categories

Array<AppCategory>

The categories that a mini program belongs to.

O

firstPublishTime

Long

The date and time of the first release of the mini program, which is in the timestamp format.

O

Name

Type

Description

Required

totalCount

Integer

The quantity of the mini programs that match the specified query conditions.

M

appInfos

Array<AppInfo>

The list of the mini programs. An empty array is returned when the value of totalCount is 0.

Maximum size: 50 elements

M

Name

Type

Description

Required

category

String

The name of the first-level category that a mini program belongs to.

O

categoryId

String

The unique ID that is assigned by Mini Program Platform to identify the first-level mini program category.

O

category2

String

The name of the secondary category that a mini program belongs to.

O

categoryCode2

String

The unique ID that is assigned by Mini Program Platform to identify the secondary mini program category.

O

category3

String

The name of the tertiary category that a mini program belongs to.

O

categoryCode3

String

The unique ID that is assigned by Mini Program Platform to identify the tertiary mini program category.

O

Name

Type

Description

Required

errorCode

Integer

The error code about the request. This parameter is returned if the request fails. See the Error codes section of each API specification for details.

O

errorMessage

String

The error message about the request. This parameter is returned if the request fails. See the Error codes section of each API specification for details.

O

Name

Type

Description

Required

developerVersion

String

The release version of a mini program, which follows the major.minor.patch pattern. For example, "1.0.1".

M

appId

String

The unique ID that is assigned by Mini Program Platform to identify a mini program.

M

appName

String

The mini program name.

M

deployVersion

String

The release version of a mini program, which follows the major.minor.patch.timestamp pattern. For example, "1.0.1.1653969582308".

M

appSlogan

String

The mini program tagline.

M

appDesc

String

The mini program description.

M

iconUrl

String

The URL of the mini program logo.

M

status

String

The mini program release status in your super app. Valid values are:

• GRAY: The mini program is in a grayscale release.
• ONLINE: The mini program is fully released and runs online.

M

packageSize

String

The mini program package size.

M

createTime

Long

The date and time when a mini program is created, which is in the timestamp format.

M

firstPublishTime

Long

The date and time of the first release of the mini program, which is in the timestamp format.

O

categoryInfos

Array<CategoryInfo>

The categories that a mini program belongs to.

O

Name

Type

Default

Description

Required

queryStartIndex

Integer

0

The starting index to query the mini program list. The index is determined by the specified setRelatedEnv, setCategory, and setAppIdList parameters.

M

querySize

Integer

0

The quantity of the mini programs to be queried.

M

relatedEnv

String

prod

The type of environment where mini programs are released. Valid values are:

• prod: The production environment.
• dev: The development environment.
• test: The test environment.
• sandbox: The sandbox environment.

O

category

String

N/A

The category that mini programs belong to. Specify this parameter with the unique category ID that is assigned by Mini Program Platform. You can get the ID from the Mini Program Platform console.

O

appIdList

Array<String>

N/A

Specify a list of mini program IDs to determine the mini programs to query.

M

Name

Type

Default

Description

Required

queryStartIndex

Integer

0

The starting index to query the mini program list. The index list is determined by the specified setSortDescriptor, setAscending, setRelatedEnv, and setCategory parameters.

M

querySize

Integer

0

The quantity of the mini programs to be queried.

M

sortDescriptor

String

APP_CREATE_TIME

The way mini programs are sorted. Valid values are:

• APP_ID: Sort by the mini program IDs.
• PUBLISH_TIME: Sort by the mini program release time.
• APP_NAME: Sort by the mini program names.
• APP_DESC: Sort by the mini program descriptions.
• APP_CREATE_TIME: Sort by the mini program creation time.

O

ascending

Boolean

true

Whether to sort mini programs in ascending order. The order follows the utf8mb4_general_ci sorting rule. Valid values are:

• true: Sort in ascending order.
• false: Sort in descending order.

O

relatedEnv

String

prod

The type of environment where mini programs are released. Valid values are:

• prod: The production environment.
• dev: The development environment.
• test: The test environment.
• sandbox: The sandbox environment.

O

category

String

N/A

The category that mini programs belong to. Specify this parameter with the unique category ID that is assigned by Mini Program Platform. You can get the ID from the Mini Program Platform console.

O

Name

Type

Description

Required

totalCount

Integer

The quantity of the mini programs that match the specified query conditions.

M

appInfoList

Array<FetchAppInfo>

The list of the mini programs. An empty array is returned when the value of totalCount is 0.

Maximum size: 50 elements

M

Name

Type

Description

clazz

Class

The class of bridge that implements the class.

actionList

List<String>

The JSAPI name list.

Return type

Method

Description

Required

void

error

The method that is used to return the error code and error message for mini program launch failure. See Error for details.

O

Name

Type

Description

Required

url

String

The decoded URL. This parameter is required if the decoding succeeds.

O

errorCode

Int

The error code. This parameter is required if the decoding fails.

O

errorMessage

String

The error message. This parameter is required if the decoding fails.

O

Name

Type

Description

handlerClassName

String

The full path className of event handler that implements class.

eventFilters

List<String>

The event list.

scope

Class<? extends Scope>

The scope of event handler. It should be {@link com.alibaba.ariver.app.api.Page} or {@link com.alibaba.ariver.app.api.App}.

Name

Type

Description

extensionClass

Class<? extends GriverExtension>

The class of extension that implements the GriverExtension class.

extensionImpl

GriverExtension

The object of extension that implements the GriverExtension class.

Field

Data type

Description

Required

appId

String

The unique ID that is assigned by Mini Program Platform to identify a mini program. This parameter is specified if the user information request is from mini programs.

No

scopes

Set<String>

The type of user information that is requested. The only valid value is auth_user, which indicates all available basic user information is requested. This is the default value.

No

extendedInfo

Map<String,String>

An extended attribute that is used to provide additional information if necessary.

No

Field

Data type

Description

Required

memberInfo

MemberInfo

The actual object that contains the user information.

Yes

Field

Data type

Description

Required

userId

String

The unique ID that is specified by the super app to identify a user.

Yes

avatar

String

The URL of the avatar image.

No

extendInfo

Dictionary<String, Any>

An extended attribute that is used to provide additional information. This parameter is specified in key-value pairs with the following valid key:

• nickName: Optional String. The user's nickname.

No

Field

Data type

Description

Required

authCode

String

The authorization code that is generated by the Super App.

Yes

authErrorScopes

Map<String, String>

The authorization scopes that are failed to be granted. The parameter value is in the key-value format. The key is the scope and the value is a numeric error code that is specified in the Error codes section of OAuthService. For example, "auth_user":"1000".

Specify this parameter if any requested scopes are denied.

No

authSuccessScopes

Array<String>

The authorization scopes that are successfully granted. Specify this parameter if any requested scopes are granted.

No

resultError

Error

Authorization error occurred. Specify this parameter if the authorization fails.

No

Field

Data type

Description

Required

authorizedScopes

Array<String>

A list of scopes that the super app supports. The super app can implement and define the scopes to meet your specific requirements. However, it is recommended to follow the guidelines and implement the values that are stated in the Scopes section of OAuthService.

Yes

Field

Data type

Description

Required

paymentString

String

The payment certificate, which corresponds to the value of the type parameter.

Yes

type

String

The type of payment certificate. Valid values are:

• orderId: A unique ID that identifies an order.
• paymentId: A unique ID that identifies a payment.
• cashierUrl: The URL of the cashier page.
• orderStr: A string of complete payment parameters.

Yes

extendedInfo

Map<String,String>

An extended attribute that is used to provide additional information if necessary.

extendedInfo keys:

• paymentId: optional, appears when paymentType is cashierUrl. paymentId can be in the extendedInfo.

No

Field

Data type

Description

Required

resultCode

String

The result code for the payment request. Valid values are:

• CODE_PENDING: The payment is pending. The underlying result code is 8000 (PAY_PENDING).
• CODE_FAILURE: The payment has failed. The underlying result code is 4000 (PAY_FAILURE).
• CODE_SUCCESS: The payment has succeeded. The underlying result code is 9000 (PAY_SUCCESS).
• CODE_USER_CANCEL: The user cancels the payment. The underlying result code is 6001 (USER_CANCEL).

Yes

resultMessage

String

The result message for the payment request.

No

Field

Data type

Description

Required

type

String

The type of code that the mini program requests to scan. Valid values are:

• qrCode: The mini program requests to scan a QR code. This is the default value.
• barCode: The mini program requests to scan a barcode.

No

hideAlbum

Boolean

Whether the mini program needs to display an album entry on the code scan page for users to read and scan from albums. Valid values are:

• true: The mini program does not need to display an album entry.
• false: The mini program needs to hide an album entry.

The value defaults to false.

Yes

extendedInfo

Map<String,String>

An extended attribute that is used to provide additional information.

No

Field

Data type

Description

Required

code

String

The scan result, which is a code string extracted from the QR code or barcode image. Specify this parameter if the scanning operation is successful. Return null if scan error happens.

No

Name

Type

Description

query

String

This parameter is used to retrieve information about the current startup and pass it with key-value pairs to the mini program.

showTitleBar

Boolean

Whether to show the title bar. If this parameter is not specified, the title bar is shown by default. Valid values are:

• true: Show the title bar.
• false: Hide the title bar.

showLoading

Boolean

Whether to show the loading view on the page. If this parameter is not specified, the view is shown by default. Valid values are:

• true: Show the loading view.
• false: Hide the loading view.

showTitleLoading

Boolean

Whether to show the loading view on the title bar. If this parameter is not specified, the view is hidden by default. Valid values are:

• true: Show the loading view.
• false: Hide the loading view.

titleColor

Integer

The page title text color. Specify this parameter with the color codes in hexadecimal notation that follow the ARGB color model.

titleBarColor

Integer

The title bar color. Specify this parameter with the color codes in hexadecimal notation that follow the ARGB color model.

backButtonColor

Integer

The color of the back button on the title bar. Specify this parameter with the color codes in hexadecimal notation that follow the ARGB color model.

screenOrientation

String

The initial screen orientation of a mini program when it is first launched. If this parameter is not specified, the mini program is opened in the portrait position by default. Valid values are:

• landscape: Open a mini program in the landscape orientation.
• portrait: Open a mini program in the portrait orientation.
• auto: Open a mini program in the same orientation as the device.

titleAlignment

String

The horizontal positioning of the page title. If this parameter is not specified, the page title is aligned to the left by default. Valid value is:

• auto: Align the page title to the center.

nbupdate

String

This parameter is used to configure the mini program update mode (Default update mode, Async update mode, and Sync update mode). For details see Mini program update mechanism.
Valid values are:

• asyncforce: indicate the Async update mode
• syncforce: indicate the Sync update mode
• null / async: indicate the Default update mode