tencent cloud

APIs

문서APIsTencent Cloud Super App as a ServiceData Types

Data Types

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-05-26 10:36:03

APPOverview

Superapp data overview.

Used by actions: DescribeAPPDataOverview.

Name Type Description
BaseData APPOverviewData No description available.
Note: This field may return null, indicating that no valid values can be obtained.
Overview APPOverviewData Superapp overview summary data.
Note: This field may return null, indicating that no valid values can be obtained.
PageData APPOverviewData No description available.
Note: This field may return null, indicating that no valid values can be obtained.
Payment APPOverviewData No description available.
Note: This field may return null, indicating that no valid values can be obtained.

APPOverviewData

Superapp overview data details.

Used by actions: DescribeAPPDataOverview.

Name Type Description
AllActiveDeviceNum Integer Superapp active device count.
AllNewDeviceNum Integer Superapp new device count.
CorpNum Integer Mini program team count.
GameActiveDeviceNum Integer Mini game active device count.
GameNewDeviceNum Integer Mini game new device count.
MiniAppNum Integer Created mini program count.
MngNum Integer Created mini game count.
NewDeviceNum Integer Mini program new device count.
OnlineMiniAppNum Integer Released mini program count.
OnlineMngNum Integer Released mini game count.
VisitNum Integer Mini program active device count.
FlushTime String Data refresh timestamp.

AccessAnalysisDetail

Access analysis detail data.

Used by actions: DescribeGlobalOverviewDataSummary, DescribeMNGAccessAnalysisDetail, DescribeMNGAccessAnalysisOverview, DescribeMNPAccessAnalysisOverview, DescribeMNPReportDetail.

Name Type Description
ActiveCount Integer Number of new devices.
AvgDevice String Average visit duration per user.
AvgOnce String Average visit duration per session.
AvgOpenCount String Average opens per user.
DataTime String Date.
FlushTime String Data refresh time.
NewCount Integer Number of active devices.
OpenCount Integer Number of opens.
TotalShareNum Integer Number of shares.
TotalUserNum Integer Cumulative users.

AccessAnalysisOverview

Access analysis overview.

Used by actions: DescribeGlobalOverviewDataSummary, DescribeMNGAccessAnalysisOverview, DescribeMNPAccessAnalysisOverview.

Name Type Description
BaseData AccessAnalysisDetail Access analysis overview data.
Note: This field may return null, indicating that no valid values can be obtained.
Overview Overview Not returned by this API.
Note: This field may return null, indicating that no valid values can be obtained.
PageData AccessAnalysisDetail Not returned by this API.
Note: This field may return null, indicating that no valid values can be obtained.
Payment AccessAnalysisDetail Not returned by this API.
Note: This field may return null, indicating that no valid values can be obtained.

AdTrendChart

Ad trend data.

Used by actions: DescribeAdvertisingLineChart, DescribeMNGAdvertisingLineChart.

Name Type Description
EstimatedEarnings Array of AnalysisData Estimated revenue.
Note: This field may return null, indicating that no valid values can be obtained.
RequestsNumber Array of AnalysisData Number of requests.
Note: This field may return null, indicating that no valid values can be obtained.
Impressions Array of AnalysisData Number of impressions.
Note: This field may return null, indicating that no valid values can be obtained.
ECPM Array of AnalysisData eCPM (effective cost per mille).
Note: This field may return null, indicating that no valid values can be obtained.
ClicksNumber Array of AnalysisData Number of taps.
Note: This field may return null, indicating that no valid values can be obtained.

AdvertDataOverview

Ad data overview.

Used by actions: DescribeMNGAdvertisingOverview.

Name Type Description
EstimatedEarnings String Estimated revenue.
Note: This field may return null, indicating that no valid values can be obtained.
RequestsNumber Integer Number of requests.
Note: This field may return null, indicating that no valid values can be obtained.
Impressions Integer Number of impressions.
Note: This field may return null, indicating that no valid values can be obtained.
ClicksNumber Integer Number of taps.
Note: This field may return null, indicating that no valid values can be obtained.
ECPM String eCPM (effective cost per mille).
Note: This field may return null, indicating that no valid values can be obtained.

AnalysisAdvertOverview

Ad analysis data overview.

Used by actions: DescribeMNGAdvertisingOverview.

Name Type Description
OverviewData AdvertDataOverview Ad overview.
Note: This field may return null, indicating that no valid values can be obtained.

AnalysisData

Trend data value.

Used by actions: DescribeAdvertisingLineChart, DescribeMNGAdvertisingLineChart.

Name Type Description
DataTime String Data time.
Number String Data value.

ApplicationConfigInfo

Superapp configuration infomation.

Used by actions: DescribeApplicationConfigInfos.

Name Type Description
ApplicationType Integer Superapp configuration type. Valid values: 1 Non-production; 2 Production.
AppKey String Superapp package name.
AppURL String Superapp URL.
Id Integer Superapp configuration ID.

ApprovalItem

Mini program approval processing details.

Used by actions: ProcessMNPApproval.

Name Type Required Description
AppId String Yes Superapp ID.
ApprovalResult Integer Yes Approval result. Valid value: 2: Rejected; 3: Approved.
ApprovalNote String No Approval notes. It is required when the request is rejected.

BooleanInfo

Used for Data object when no data is returned after a successful action.

Used by actions: AddTeamMember, ConfigureMNGPreview, ConfigureMNPPreview, CreateApplicationConfig, CreateApplicationSensitiveAPI, CreateMNGDomainACL, CreateMNPDomainACL, DeleteApplication, DeleteApplicationSensitiveAPI, DeleteMNG, DeleteMNP, DeleteTeam, DeleteTeamMember, DeleteUser, DisableApplicationSensitiveAPI, EnableApplicationSensitiveAPI, ModifyApplication, ModifyApplicationConfig, ModifyMNGDomain, ModifyMNPDomain, ModifyTeam, ModifyTeamMember, ModifyUser, ProcessMNPApproval, ProcessMNPSensitiveAPIPermissionApproval, ReleaseMNGVersion, ReleaseMNPVersion, RemoveMNG, RemoveMNP, RollbackMNGVersion, RollbackMNPVersion.

Name Type Description
Result Boolean The Boolean response object.
Note: This field may return null, indicating that no valid values can be obtained.

CategoryInfo

Category information.

Used by actions: DescribeApplicationMNPList.

Name Type Description
ID String Category ID.
Name String Category name.
SubItems Array of CategoryItem Subcategory information.

CategoryItem

Subcategory item information.

Used by actions: DescribeApplicationMNPList.

Name Type Description
ID String Category ID.
Name String Category name.

CreateApplicationSensitiveAPIReq

Request object for creating a sensitive API.

Used by actions: CreateApplicationSensitiveAPI.

Name Type Required Description
APIName String No

API name.
APIDesc String No

API description.
APIType Integer No

API type. Valid values: 1: System; 2: Custom.
UseScope Integer No

Applicable scope: Valid values: 0: Mini program; 1: Mini game; 100: Both.

CreateDomainParam

Request parameters for creating a domain.

Used by actions: CreateMNGDomainACL, CreateMNPDomainACL, ModifyMNGDomain, ModifyMNPDomain.

Name Type Required Description
DomainUrlList Array of String Yes Array of domain URLs.
DomainType Integer Yes Domain type. Valid values: 1: Request domain; 2: Business domain; 3: Socket domain; 4: File upload; 5: File download.

CreateGlobalDomainResp

Response for creating a global domain.

Used by actions: CreateGlobalDomainACL.

Name Type Description
Result Boolean Operation result.
RepeatUrls Array of String Duplicate domains.
ExistsWhiteUrls Array of String Domains that already exist in the allowlist.
ExistsBlackUrls Array of String Domains that already exist in the blocklist.

CreateMNGApprovalResp

Response for submitting a mini game version for approval.

Used by actions: CreateMNGApproval.

Name Type Description
Result Boolean

Boolean response object.


Note: This field may return null, indicating that no valid values can be obtained.
ApprovalNo String

Approval number.

CreateMNGVersionResp

Response for creating a mini game version.

Used by actions: CreateMNGVersion.

Name Type Required Description
TaskId String No

Mini game version compilation task ID.

CreateMNPApprovalResp

Response for submitting a mini program version for approval.

Used by actions: CreateMNPApproval.

Name Type Description
Result Boolean The Boolean response object.
ApprovalNo String Approval nunmber.

CreateMNPSecretKeyResp

Response for creating a mini program secret key.

Used by actions: CreateMNPSecretKey.

Name Type Description
KeyId String

Key ID.
SecretKey String

Secret key.

CreateMNPVersionResp

Response for creating a mini program version.

Used by actions: CreateMNPVersion.

Name Type Required Description
TaskId String No Mini program version compilation task ID.

CreateTeamMemberInfoReq

Member information for adding a team member.

Used by actions: AddTeamMember.

Name Type Required Description
UserId String No User ID.
UserRoleId Integer No User role ID.

DescribeApplicationConfigInfo

Response for querying superapp configuration information.

Used by actions: DescribeApplicationConfigInfos.

Name Type Description
AndroidConfig Array of ApplicationConfigInfo Android configuration list.
IosConfig Array of ApplicationConfigInfo iOS configuration list.

DescribeApplicationListData

Superapp information.

Used by actions: DescribeApplicationList.

Name Type Description
ApplicationId String Superapp ID.
AppIdentityId Integer Superapp identity ID.
ApplicationName String Superapp name.
Logo String Superapp icon.
Remark String Remarks.
AndroidAppKey String Android superapp package name.
IosAppKey String iOS superapp bundle ID.
CreateUser String Creator.
CreateTime String Creation time.
UpdateUser String Last modifier.
UpdateTime String Last modified time.
Intro String Superapp introduction.
TeamId String Team ID.
TeamName String Team name.
SensitiveApiCount Integer Number of sensitive APIs.
ApplicationType Integer Superapp type. Valid values: 1: Test; 2: Production.

DescribeApplicationListResp

Response for querying the superapp list.

Used by actions: DescribeApplicationList.

Name Type Description
TotalCount Integer Total number of entries.
DataList Array of DescribeApplicationListData Superapp list data.

DescribeApplicationMNPInfoResp

The mini program or mini game data associated with a superapp.

Used by actions: DescribeApplicationMNPList.

Name Type Description
MNPId String Mini program or mini game appid.
MNPIcon String Mini program or mini game icon.
MNPName String Mini program or mini game name.
MNPIntro String Mini program or mini game information.
CreateUser String Creator.
CreateTime String Creation time.
UpdateUser String Last modifier.
UpdateTime String Last modified time.
OnlineStatus Integer Available status. Valid value: 0: Not available; 1 Available; 2: In canary release.
EngineType Integer Engine type. Specifies the runtime engine by product type. Valid values: 0: Mini program; 1: Mini game.
CategoryList Array of CategoryInfo Category information.

DescribeApplicationMNPListResp

Returned mini program or mini game list.

Used by actions: DescribeApplicationMNPList.

Name Type Description
TotalCount Integer Total number of entries.
DataList Array of DescribeApplicationMNPInfoResp List data.

DescribeApplicationResp

Superapp details.

Used by actions: DescribeApplication.

Name Type Description
ApplicationId String Superapp ID.
AppIdentityId Integer Product ID.
ApplicationName String Superapp name.
Logo String Superapp icon.
Remark String Remarks.
AndroidAppKey String Android superapp package name.
IosAppKey String iOS superapp bundle ID.
CreateUser String Creator.
CreateTime String Creation time.
UpdateUser String Last modifier.
UpdateTime String Last modified time.
Intro String Superapp introduction.
TeamId String Team ID.
TeamName String Team name.
SensitiveApiCount Integer Number of sensitive APIs.
ApplicationType Integer Superapp type. Valid values: 1: Test; 2: Production.
Scheme String Superapp scheme.

DescribeApplicationSensitiveAPIListData

Superapp sensitive API list data.

Used by actions: DescribeApplicationSensitiveAPIList.

Name Type Description
APIId String API ID.
APIName String API name.
APIMethod String API request method.
APIDesc String API description.
CreateUser String Creator.
CreateTime String Creation time.
UpdateUser String Last modifier.
UpdateTime String Last modified time.
ApplicationId String Superapp ID.
ApplicationName String Superapp name.
TeamId String Team ID.
TeamName String Team name.
ApplicationLogo String Superapp icon.
APIType Integer API type. Valid values: 1: System; 2: Custom.
Status Integer API status. Valid values: 0: Public; 1: Restricted.
UseScope Integer Applicable scope: Valid values: 0: Mini program; 1: Mini game; 100: Both.

DescribeApplicationSensitiveAPIListResp

Response for querying the superapp sensitive API list.

Used by actions: DescribeApplicationSensitiveAPIList.

Name Type Description
TotalCount Integer Total number of entries.
DataList Array of DescribeApplicationSensitiveAPIListData List data.

DescribeDomainInfoParam

Response parameters for querying domain information.

Used by actions: DescribeMNPDomainACL.

Name Type Description
DomainUrl String Multiple domains concatenated with semicolons (;).
DomainType Integer Domain type. Valid values: 1 Requests domain; 2 web-view domain.

DescribeGlobalDomainsListData

Global domain list information.

Used by actions: DescribeGlobalDomainACL.

Name Type Description
DomainId Integer Domain ID.
DomainUrl String Domain name.
DomainType Integer Domain type. Valid value: 1: Allowed; 2: Blocked.
CreateUser String Creator.
CreateTime String Creation time.
UpdateUser String Last modifier.
UpdateTime String Last modified time.

DescribeGlobalDomainsResp

Paginated global domain list.

Used by actions: DescribeGlobalDomainACL.

Name Type Description
TotalCount Integer Total number of entries.
DataList Array of DescribeGlobalDomainsListData Domain information.

DescribeMNGAllStageVersionsResp

Response for querying all-stage versions of a mini game.

Used by actions: DescribeMNGAllStageVersions.

Name Type Description
MNPId String

Mini game appid.
MNPVersionId Integer

Mini game version ID.
MNPName String

Mini game name.
MNPIcon String

Mini game icon.
MNPType String

Mini game category.
MNPIntro String

Mini game introduction.
MNPDesc String

Mini game description.
CreateUser String

Creator.
CreateTime String

Creation time.
MNPVersion String

Mini game version.
MNPVersionIntro String

Version feature introduction.
Phase String

Stage: Develop, preview, available.
ApprovalStatus Integer

Approval status. Valid values: 0: Pending; 1: Processing; 2: Rejected; 3: Approved; 4: Cancelled.
ApprovalNo String

Approval number.
ShowCase Integer

Whether this is a preview. Valid values: 0: No; 1: Yes.
RollbackVersion Integer

Rollback version number.
Status Integer

Available status.
VersionCurrentStatus Integer

Current version approval status. Valid values: 0: Pending; 1: Processing; 2: Rejected; 3: Approved; 4: Cancelled.

DescribeMNGDomainInfoResp

Response parameters for querying domain information.

Used by actions: DescribeMNGDomainACL.

Name Type Description
DomainUrl String

Multiple domains concatenated with semicolons (;).
DomainType Integer

Domain type. Valid values: 1: Requests domain; 2: web-view domain.

DescribeMNGListData

Mini game list data.

Used by actions: DescribeMNGList.

Name Type Description
MNPId String

Mini game appid.
MNPIcon String

Mini game icon.
MNPName String

Mini game name.
TeamName String

Team name.
MNPType String

Mini game category.
Status Integer

Mini game available status. Valid values: 1: Available; 2: Not available.
MNPIntro String

Mini game introduction.
CreateUser String

Creator.
CreateTime String

Creation time.
UpdateUser String

Last modifier.
UpdateTime String

Last modified time.
ApplicationName String

Superapp name.
EffectStatus Integer

Binding effective status for the superapp. Valid values: 1: Not effective; 2: Effective.
EffectMNPVersionId Integer

Effective mini game version ID bound to the superapp.
EffectMNPVersion String

Effective mini game version number bound to the superapp.

DescribeMNGListResp

Response for querying the mini game list.

Used by actions: DescribeMNGList.

Name Type Description
TotalCount Integer

Total number of entries.
DataList Array of DescribeMNGListData

List data.

DescribeMNGManagerDetailData

Mini game detail information.

Used by actions: DescribeMNG.

Name Type Description
MNPType String

Mini game category.
MNPId String

Mini game appid.
MNPName String

Mini game name.
MNPIcon String

Mini game icon.
MNPIntro String

Mini game introduction.
MNPDesc String

Mini game description.
CreateTime String

Creation time.
CreateUser String

Creator.
AccessStatus Integer Access status. Valid values: 1: Not connected; 2: Connected.
TeamName String

Team name.
TeamId String

Team ID.
Status Integer

Mini game available status. Valid values: 1: Available; 2: Not available.
I18nList Array of MNPDetailI18nVO The mini game name and description in multiple languages.

DescribeMNGPreviewResp

Response for querying the preview.

Used by actions: DescribeMNGPreview.

Name Type Description
MNPId String

Mini game appid.
MNPName String

Mini game name.
MNPDesc String

Mini game description.
MNPVersion String

Mini game version.
MNPVersionIntro String

Mini game version description.
QRCodeUrl String

Mini game version QR code URL.
PreviewEntrancePath String

Preview path.
QRCodeContent String

Information encoded in the QR code.

DescribeMNGRevertOnlineVersionPageResp

Response of querying the rollback version list.

Used by actions: DescribeMNGReleasedVersionHistory.

Name Type Description
TotalCount Integer

Total number of entries.
DataList Array of QueryMNGOnlineVersionResp

List data.

DescribeMNGSensitiveAPIPermissionApprovalData

Detail data for querying mini game sensitive API permission approval.

Used by actions: DescribeMNGSensitiveAPIPermissionApproval.

Name Type Description
APIId String

API ID.
APIMethod String

API method.
ApplyReason String

Reason for request.
RejectReason String

Reason for rejection.
ApprovalStatus Integer

Approval status. Valid values: 20: Rejected; 30: Approved.
APIDesc String

API feature description.
APIType Integer

API type. Valid values: 1: System; 2: Custom.

DescribeMNGSensitiveAPIPermissionListData

List data for querying callable sensitive APIs of a mini game.

Used by actions: DescribeMNGSensitiveAPIPermissionList.

Name Type Description
APIId String

API ID.
APIName String

API name.
APIMethod String

API method.
APIStatus Integer

API status.
APIApplyStatus Integer

API request status.
RejectReason String

Reason for rejection.
ApprovalNo String

Approval number.
ApplicationId String

Superapp ID.
ApplicationIcon String

Superapp icon.
ApplicationName String

Superapp name.
APIType Integer

API type. Valid values: 1: System; 2: Custom.
APIDesc String

API feature description.

DescribeMNGSensitiveAPIPermissionListResp

Response for querying the list of callable sensitive APIs of a mini game.

Used by actions: DescribeMNGSensitiveAPIPermissionList.

Name Type Description
TotalCount Integer

Total number of entries.
DataList Array of DescribeMNGSensitiveAPIPermissionListData

List data.


Note: This field may return null, indicating that no valid values can be obtained.

DescribeMNGVersionResp

Response for querying the mini game version creation result.

Used by actions: DescribeMNGVersion.

Name Type Description
MNPId String

Mini game appid.
TaskId String

Task ID.
TaskStatus Integer

Task status. Valid values: 1: Pending; 20: Running; 30: Failed; 60: Succeeded.
TaskMsg String

Task status information.
MNPVersionId Integer

Mini game version ID (returned upon successful compilation).

DescribeMNPApprovalListData

Mini program approval list information.

Used by actions: DescribeMNPApprovalList.

Name Type Description
ApprovalNo String Approval number.
ApplicationId String Superapp ID.
ApprovalStatus Integer Approval status. Valid values: 1: Processing; 2: Rejected; 3: Approved; 4: Cancelled.
MNPId String Mini program appid.
MNPVersion String Mini program version.
MNPVersionId Integer Mini program version ID.
ApplyUser String Applicant.
ApplyTime String Application time.
MNPName String Mini program name.
MNPIcon String Mini program icon.
ApplicationName String Superapp name.
ApplicationLogo String Superapp icon.
TeamId String Team ID.
TeamName String Team name.
MNPQrCodeUrl String Mini program approval QR code URL.
MNPType String Mini program category.
ApprovalUser String Approver.
ApprovalTime String Approval time.
ApprovalNote String Approval note.

DescribeMNPApprovalListResp

Paginated mini program approval list.

Used by actions: DescribeMNPApprovalList.

Name Type Description
TotalCount Integer Total number of entries.
DataList Array of DescribeMNPApprovalListData List data.

DescribeMNPListData

Mini program list data.

Used by actions: DescribeMNPList.

Name Type Description
MNPId String Mini program appid.
MNPIcon String Mini program icon.
MNPName String Mini program name.
TeamName String Team name.
MNPType String Mini program category.
Status Integer Mini program available status. Valid values: 1: Available; 2: Removed.
MNPIntro String Mini program introduction.
CreateUser String Creator.
CreateTime String Creation time.
UpdateUser String Last modifier.
UpdateTime String Last modified time.
ApplicationName String Superapp name.
EffectStatus Integer Binding effective status for the superapp. Valid values: 1: Not effective; 2: Effective.
EffectMNPVersionId Integer Effective mini program version ID bound to the superapp.
EffectMNPVersion String Effective mini program version number bound to the superapp.

DescribeMNPListResp

Response for querying the mini program list.

Used by actions: DescribeMNPList.

Name Type Description
TotalCount Integer Total number of entries.
DataList Array of DescribeMNPListData List data.

DescribeMNPManagerDetailData

Mini program details.

Used by actions: DescribeMNP.

Name Type Description
MNPType String Mini program category.
MNPId String Mini program appid.
MNPName String Mini program name.
MNPIcon String Mini program icon.
MNPIntro String Mini program introduction.
MNPDesc String Mini program description.
CreateTime String Creation time.
CreateUser String Creator.
AccessStatus Integer Access status. Valid values: 1: not connected; 2: connected.
TeamName String Team name.
TeamId String Team ID.
Status Integer Mini program available status. Valid values: 1: Available; 2: Removed.
I18nList Array of MNPDetailI18nVO The mini program name and description in multiple languages.

DescribeMNPPreviewResp

Response for querying the preview.

Used by actions: DescribeMNPPreview.

Name Type Description
MNPId String Mini program appid.
MNPName String Mini program name.
MNPDesc String Mini program description.
MNPVersion String Mini program version.
MNPVersionIntro String Mini program version introduction.
QRCodeUrl String Mini program QR code URL.
PreviewEntrancePath String Preview path.
QRCodeContent String Information encoded in the QR code.

DescribeMNPSensitiveAPIPermissionApprovalData

Detail data for querying mini program sensitive API permission approval.

Used by actions: DescribeMNPSensitiveAPIPermissionApproval.

Name Type Description
APIId String API ID.
APIMethod String API method.
ApplyReason String Reason for request.
RejectReason String Reason for rejection.
ApprovalStatus Integer Approval status. Valid values: 20: Rejected; 30: Approved.
APIDesc String API feature description.
APIType Integer API type. Valid values: 1: System; 2: Custom.

DescribeMNPSensitiveAPIPermissionApprovalListData

List data for querying mini program sensitive API permission approvals.

Used by actions: DescribeMNPSensitiveAPIPermissionApprovalList.

Name Type Description
ApprovalNo String Approval number.
APIId String Sensitive API ID.
APIName String API name.
APIMethod String API method.
MNPId String Mini program appid.
MNPName String Mini program name.
ApplyUser String Applicant.
ApplyTime String Application time.
ApplyNote String Application note.
ApprovalStatus Integer Approval status. Valid values: 1: Processing; 20: Rejected; 30: Approved.
ApprovalUser String Approver.
ApprovalTime String Approval time.
ApprovalNote String Approval note.
ApplicationId String Superapp ID.
ApplicationName String Superapp name.
ApplicationLogo String Superapp icon.
APIType Integer API type. Valid values: 1: System; 2: Custom.
APIDesc String API feature description.

DescribeMNPSensitiveAPIPermissionApprovalListResp

Response for querying the mini program sensitive API permission approval list.

Used by actions: DescribeMNPSensitiveAPIPermissionApprovalList.

Name Type Description
TotalCount Integer Total number of entries.
DataList Array of DescribeMNPSensitiveAPIPermissionApprovalListData List data.

DescribeMNPSensitiveAPIPermissionListData

List data for querying callable sensitive APIs of a mini program.

Used by actions: DescribeMNPSensitiveAPIPermissionList.

Name Type Description
APIId String API ID.
APIName String API name.
APIMethod String API method.
APIStatus Integer API status.
APIApplyStatus Integer API application status.
RejectReason String Reason for rejection.
ApprovalNo String Approval number.
ApplicationId String Superapp ID.
ApplicationIcon String Superapp icon.
ApplicationName String Superapp name.
APIType Integer API type. Valid values: 1: System; 2: Custom.
APIDesc String API feature description.

DescribeMNPSensitiveAPIPermissionListResp

Response for querying the list of callable sensitive APIs of a mini program.

Used by actions: DescribeMNPSensitiveAPIPermissionList.

Name Type Description
TotalCount Integer Total number of entries.
DataList Array of DescribeMNPSensitiveAPIPermissionListData List data.
Note: This field may return null, indicating that no valid values can be obtained.

DescribeMNPVersionResp

Response for querying the mini program version creation result.

Used by actions: DescribeMNPVersion.

Name Type Description
MNPId String

Mini program appid.
TaskId String

Task ID.
TaskStatus Integer Task status. Valid values: 1: Pending; 20: Running; 30: Failed; 60: Succeeded.
TaskMsg String

Task status information.
MNPVersionId Integer

Mini program version ID (returned upon successful compilation).

DescribeMPAllStageVersionsResp

Response for querying all-stage versions of a mini program.

Used by actions: DescribeMNPAllStageVersions.

Name Type Description
MNPId String Mini program appid.
MNPVersionId Integer Mini program version primary key ID.
MNPName String Mini program name.
MNPIcon String Mini program icon.
MNPType String Mini program category.
MNPIntro String Mini program introduction.
MNPDesc String Mini program description.
CreateUser String Creator.
CreateTime String Creation time.
MNPVersion String Mini program version number.
MNPVersionIntro String Version introduction.
Phase String Stage: Develop, preview, released.
ApprovalStatus Integer Approval status. Valid values: 0: Pending; 1: Processing; 2: Rejected; 3: Approved; 4: Cancelled.
ApprovalNo String Approval number.
ShowCase Integer Whether this is a preview. Valid values: 0: No; 1: Yes.
RollbackVersion Integer Rollback version number.
Status Integer Available status. Valid value: 0: All; 1 Available; 2: In canary release.
VersionCurrentStatus Integer Current version approval status. Valid values: 0: Pending; 1: Processing; 2: Rejected; 3: Approved; 4: Cancelled.

DescribeRevertOnlineVersionPageResp

Response of querying the rollback version list.

Used by actions: DescribeMNPReleasedVersionHistory.

Name Type Description
TotalCount Integer Total number of entries.
DataList Array of QueryOnlineVersionResp List data.

DescribeRoleListData

Role list data.

Used by actions: DescribeRoleList.

Name Type Description
RoleId Integer Role ID.
RoleName String Role name.
TeamName String Team name.
CreateTime String Creation time.
RoleType Integer Role type. Valid values: 1: Preset role; 2: Custom role.

DescribeRoleListResp

Response for querying the role list data.

Used by actions: DescribeRoleList.

Name Type Description
TotalCount Integer Total number of entries.
DataList Array of DescribeRoleListData List data.

DescribeTeamDetailResp

Team details.

Used by actions: DescribeTeam.

Name Type Description
TeamName String Team name.
TeamRoleType Integer Team role type. Valid values: 1: Mini program team; 2: Superapp team.
AdminUserAccount String Admin account.
CreateUser String Creator.
CreateTime String Creation time.
MemberCount Integer Number of team members.
BindMiniTeamCount Integer Number of bound mini program teams.
BindTeamName String Name of the bound team.
RegisterLink String Team registration link.
ApplicationName String Superapp name. Only returned for mini program teams.
ExpireTime Integer Team expiration time. 0 indicates no expiration.
Status Integer Team status. Valid values: 1: Active; 2: Disabled; 3: Expired.

DescribeTeamListInfoResp

Team list information.

Used by actions: DescribeTeamList.

Name Type Description
TeamId String Team ID.
TeamName String Team name.
AdminUserId String Admin user ID.
AdminUserAccount String Admin account.
AdminUserName String Admin username.
MemberCount Integer Number of team members.
RegisterLink String Team registration link.
TeamRoleTypeList Array of Integer Team role types.
RelatedTeamId Integer Associated team ID.
ExpireTime Integer Team expiration time. 0 indicates no expiration.
Status Integer Team status. Valid values: 1: Active; 2: Disabled; 3: Expired.

DescribeTeamMemberInfoResp

Team member information.

Used by actions: DescribeTeamMemberList.

Name Type Description
UserId String User ID.
UserAccount String User account.
UserName String User name.
TeamId String Team ID.
TeamName String Team name.
TeamRoleName String Team role name.
TeamRoleId Integer Team role ID.
CanEdit Boolean Whether it can be edited.

DescribeTeamMemberListPageResp

Paginated team member list.

Used by actions: DescribeTeamMemberList.

Name Type Description
TotalCount Integer Total number of entries.
DataList Array of DescribeTeamMemberInfoResp List data.

DescribeTeamPageResp

Paginated team list.

Used by actions: DescribeTeamList.

Name Type Description
TotalCount Integer Total number of entries.
DataList Array of DescribeTeamListInfoResp List data.

DescribeUserDetailResp

Response for querying user details.

Used by actions: DescribeUser.

Name Type Description
UserId String User ID.
UserAccount String User account.
AccountType Integer User account type. Valid values: 1: Super admin; 2: Platform admin; 3: Regular member. If left empty, all types are returned.
UserName String User name.

DescribeUserListData

User list data.

Used by actions: DescribeUserList.

Name Type Description
UserId String User ID.
UserAccount String User account.
AccountType Integer User account type. Valid values: 1: Super admin; 2: Platform admin; 3: Regular member.
UserName String User name.
CreateTime String Creation time.
Status Integer Status. Valid values: 1: Active; 2: Disabled.
TeamName String Team name.

DescribeUserListResp

Response for querying the user list.

Used by actions: DescribeUserList.

Name Type Description
TotalCount Integer Total number of entries.
Note: This field may return null, indicating that no valid values can be obtained.
DataList Array of DescribeUserListData List data.
Note: This field may return null, indicating that no valid values can be obtained.

DownloadApplicationConfigResp

Superapp configuration information.

Used by actions: DescribeApplicationConfigFile.

Name Type Description
File String Configuration information in Base64 encoding.
Note: This field may return null, indicating that no valid values can be obtained.

GlobalDomainDeleteResp

Response for deleting a global domain.

Used by actions: DeleteGlobalDomain.

Name Type Description
Result Boolean Operation result.

GlobalDomainModifyRespResp

Response for modifying a global domain.

Used by actions: ModifyGlobalDomain.

Name Type Description
Result Integer Operation result. Valid values: 0: Succeeded; 1: Exists in the allowlist; 2: Exists in the blocklist.

MAUChartData

MAU line chart data.

Used by actions: DescribeMNPMAULineChart.

Name Type Description
DataTime Integer Date in YYYYMM format.
MAUCount Integer MAU count.
UpdateTime Integer Data update time. Only has a value when MAUCount is greater than 0.

MAUDetail

Mini program MAU details.

Used by actions: DescribeMNGMAUDataDetail, DescribeMNPMAUDataDetail.

Name Type Description
MNPName String Mini program name.
DataList Array of MAULineChartData MAU details.

MAUDetailData

MAU detailed data.

Used by actions: DescribeMNPAdvertisingDetail.

Name Type Description
DataTime String Date.
MNPName String Mini program name.
MNPType String Mini program category.
EstimatedEarnings String Estimated revenue.
RequestsNumber Integer Number of requests.
Impressions Integer Number of impressions.
ECPM String eCPM (effective cost per mille).
ClicksNumber Integer Number of taps.

MAUIndicatorCard

MAU metric comparison response data.

Used by actions: DescribeMNGMAUMonthlyComparisonMetricCard, DescribeMNPMAUMetricCard.

Name Type Description
ComparisonRatio String Growth rate, calculated as (targetData - sourceData) / sourceData. Returns 0 when SourceMAUNum is 0.
ComparisonResult Integer Comparison result. Valid values: 1: Increase; 2: Decrease. Returns 0 when SourceMAUNum is 0.
SourceMAUNum Integer Previous month MAU.
TargetMAUNum Integer Current month MAU.
FlushTime Integer Data timestamp.

MAULineChartData

Line chart data.

Used by actions: DescribeMNGMAUDataDetail, DescribeMNPMAUDataDetail.

Name Type Description
DataTime Integer Date in YYYYMM format.
Note: This field may return null, indicating that no valid values can be obtained.
MAUCount String MAU count.
Note: This field may return null, indicating that no valid values can be obtained.

MNGMAULineChartData

Mini game MAU line chart data.

Used by actions: DescribeMNGMAULineChart.

Name Type Description
DataTime Integer Date in YYYYMM format.
Note: This field may return null, indicating that no valid values can be obtained.
MAUCount Integer MAU count.
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime Integer Last modified time.

MNGPaymentOverview

Payment overview data.

Used by actions: DescribeMNGPaymentOverview, DescribeMNGPaymentReportDetail.

Name Type Description
ARPPu String ARPPU. Calculated as: paying revenue / paying users * 100%.
DataTime String Data time in YYYYMMDD format.
NewPaidUseRatio String New paying user ratio. Calculated as: NewUserNum / OrderUserNum * 100%.
NewPaidUserNum Integer Number of new paying users.
NewUserPaidAmount String Total payment amount from new users.
PaidAmount String Total payment amount.
PaidUserNum Integer Number of paying users.
RefundAmount String Refund amount.
RefundNum Integer Number of refund orders.
UpdateTime Integer Last modified time (timestamp in seconds).

MNGTypeDefine

Mini game category definition.

Used by actions: DescribeMNGCategory.

Name Type Required Description
TypeName String No

Mini game category name.
TypeValue Array of String No

Mini game category.
TypeId Integer No

Category ID.
CreateTime Integer No

Creation time.
CreateUser String No

Creator.
IsSystem Boolean No

Whether it is a system category.

MNPAdOverview

Mini program ad overview.

Used by actions: DescribeAdvertisingOverview.

Name Type Description
EstimatedEarnings String Estimated revenue.
Note: This field may return null, indicating that no valid values can be obtained.
ECPM String eCPM (effective cost per mille).
Note: This field may return null, indicating that no valid values can be obtained.
RequestsNumber Integer Number of requests.
Note: This field may return null, indicating that no valid values can be obtained.
Impressions Integer Number of impressions.
Note: This field may return null, indicating that no valid values can be obtained.
ClicksNumber Integer Number of taps.
Note: This field may return null, indicating that no valid values can be obtained.

MNPAdvertisingOverview

Mini program advertising revenue.

Used by actions: DescribeAdvertisingOverview.

Name Type Description
OverviewData MNPAdOverview Data.
Note: This field may return null, indicating that no valid values can be obtained.

MNPDetailI18nVO

The mini program name and description in multiple languages.

Used by actions: DescribeMNG, DescribeMNP.

Name Type Description
ID Integer Language ID.
Lang String Language type. Valid values: en-US: English; zh-CN: Simplified Chinese; zh-Hant: Traditional Chinese; fr-FR: French; ar-SA: Arabic; id-ID: Indonesian; vi-VN: Vietnamese. Default value: en-US.
IsDefault Integer Whether this is the default language. Valid values: 0: No; 1: Yes. Default value: 0.
MNPName String Mini program name.
MNPIntro String Mini program introduction.

MNPI18NSyncDto

The mini program name and description in multiple languages.

Used by actions: CreateMNG, CreateMNP, ModifyMNG, ModifyMNP.

Name Type Required Description
Lang String No Language type. Valid values: en-US: English; zh-CN: Simplified Chinese; zh-Hant: Traditional Chinese; fr-FR: French; ar-SA: Arabic; id-ID: Indonesian; vi-VN: Vietnamese. Default value: en-US.
IsDefault Integer No Whether this is the default language. Valid values: 0: No; 1: Yes. Default value: 0.
MNPName String No Mini program name.
MNPIntro String No Mini program introduction.

MNPPaymentOverview

Payment overview data.

Used by actions: DescribePaymentDataOverview.

Name Type Description
OrderMNPNum Integer Mini program count with orders.
Note: This field may return null, indicating that no valid values can be obtained.
OrderNum Integer Total orders.

Note: This field may return null, indicating that no valid values can be obtained.
OrderPaidNum Integer Total paid orders.

Note: This field may return null, indicating that no valid values can be obtained.
OrderRefundNum Integer Number of refund orders.

Note: This field may return null, indicating that no valid values can be obtained.
OrderUnpaidNum Integer Total unpaid orders.
Note: This field may return null, indicating that no valid values can be obtained.
OrderUserNum Integer Total order users.
Note: This field may return null, indicating that no valid values can be obtained.
PaidUserNum Integer Total paying users.
Note: This field may return null, indicating that no valid values can be obtained.
PaidAmount String Amount paid.
Note: This field may return null, indicating that no valid values can be obtained.
RefundAmount String Total amount refunded.
Note: This field may return null, indicating that no valid values can be obtained.
TotalAmount String Total order amount.
Note: This field may return null, indicating that no valid values can be obtained.
UnpaidAmount String Unpaid amount.
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime Integer Timestamp.
Note: This field may return null, indicating that no valid values can be obtained.
DataTime String Data time.
Note: This field may return null, indicating that no valid values can be obtained.

MNPTypeDefine

Mini program category information.

Used by actions: DescribeMNPCategory.

Name Type Required Description
TypeName String No Mini program category name.
TypeValue Array of String No Mini program category values.
TypeId Integer No Category ID.
CreateTime Integer No Creation time.
CreateUser String No Creator.
IsSystem Boolean No Whether it is a system category.

Overview

Global overview data.

Used by actions: DescribeGlobalOverviewDataSummary, DescribeMNGAccessAnalysisOverview, DescribeMNPAccessAnalysisOverview.

Name Type Description
AppNum Integer Number of superapps.
CorpNum Integer Number of teams.
FlushTime String Refresh timestamp.
MiniAppNum Integer Number of mini programs.
MiniGameNum Integer Number of mini games.
MiniGameVisitNum Integer Number of mini game visits.
UpdateNum Integer Number of mini program updates.
VisitNum Integer Number of mini program visits.

OverviewDetail

Ad data list fields.

Used by actions: DescribeMNGAdvertisingDetail.

Name Type Description
DataTime String Time.
MNPName String Name.
MNPType String Category.
EstimatedEarnings String Estimated revenue.
RequestsNumber Integer Number of requests.
Impressions Integer Number of impressions.
ECPM String eCPM (effective cost per mille).
ClicksNumber Integer Number of taps.

PaymentActiveRetention

Payment user active retention data.

Used by actions: DescribeMNGPaymentRetentionAnalysis.

Name Type Description
OneDayRetentionUsers Integer Day 1 active retention of paying users.
TwoDayRetentionUsers Integer Day 2 active retention of paying users.
ThreeDayRetentionUsers Integer Day 3 active retention of paying users.
FourDayRetentionUsers Integer Day 4 active retention of paying users.
FiveDayRetentionUsers Integer Day 5 active retention of paying users.
SixDayRetentionUsers Integer Day 6 active retention of paying users.
SevenDayRetentionUsers Integer Day 7 active retention of paying users.
FourteenDayRetentionUsers Integer Day 14 active retention of paying users.
FifteenDayRetentionUsers Integer Day 15 active retention of paying users.
ThirtyDayRetentionUsers Integer Day 30 active retention of paying users.
PaymentUserNum Integer Number of paying users.
DataTime String Data time in YYYYMMDD format.

PaymentDetail

Mini program payment detailed data.

Used by actions: DescribePaymentDataDetail.

Name Type Description
DataTime String Date in YYYYMMDD format.
OrderMNPNum Integer Mini program count with orders.
OrderNum Integer Total orders.
OrderPaidNum Integer Paid orders.
OrderRefundNum Integer Number of refund orders.
OrderUnpaidNum Integer Total unpaid orders.
OrderUserNum Integer Number of ordering users (by OpenID).
PaidAmount String Amount paid.
RefundAmount String Amount refunded.
TotalAmount String Total amount.
UnpaidAmount String Unpaid amount.
UpdateTime Integer Data update timestamp.

PresetResp

Response for obtaining the encryption key.

Used by actions: CreatePresetKey.

Name Type Description
Key String RSA public key.

QueryMNGOnlineVersionResp

Response for querying mini game released version IDs.

Used by actions: DescribeMNGReleasedVersionHistory.

Name Type Description
MNPId String

Mini game appid.
MNPVersion String

Version number.
MNPVersionId Integer

Version ID.
MNPVersionNote String

Version note.
UpdateTime String

Last modified time.

QueryOnlineVersionResp

Response for querying mini program released version IDs.

Used by actions: DescribeMNPReleasedVersionHistory.

Name Type Description
MNPId String Mini program appid.
MNPVersion String Version number.
MNPVersionId Integer Version ID.
MNPVersionNote String Version note.
UpdateTime String Last modified time.

ReportDataResult

General response for data query reports.

Used by actions: DescribeAPPDataDetailLineChart, DescribeGlobalOverviewReportDetail, DescribeMNGAccessAnalysisLineChart, DescribeMNGActiveUserRealTimeStatistics, DescribeMNGPaymentLineChart, DescribeMNPActiveUserRealTimeStatistics, DescribeMNPReportDataLineChart, DescribePaymentDataLineChart.

Name Type Description
DataResult String Result data in Base64 encoding.
ExecSql String Executed SQL.
Note: This field may return null, indicating that no valid values can be obtained.
ExecTime Integer Execution time.
Note: This field may return null, indicating that no valid values can be obtained.
IndexId String Query index ID.
Note: This field may return null, indicating that no valid values can be obtained.

ResourceIdInfo

Unified ID data returned on successful operation (Integer type).

Used by actions: ModifyMNG, ModifyMNP.

Name Type Description
ResourceId Integer Resource ID returned by the operation. Valid values: 0: No preview exists; 1: Preview exists and was uploaded by the current user; 2: Preview exists and was uploaded by another user. Example value: 2940.

ResourceIdStringInfo

Unified ID data returned on successful operation.

Used by actions: CreateApplication, CreateMNG, CreateMNGSensitiveAPIPermissionApproval, CreateMNP, CreateMNPSensitiveAPIPermissionApproval, CreateUser.

Name Type Description
ResourceId String Resource ID returned by the operation.
Note: This field may return null, indicating that no valid values can be obtained.

RetentionData

Retention data.

Used by actions: DescribeMNGRetentionData, DescribeMNPRetentionData.

Name Type Description
ActiveUserCount Integer Number of active users.
OneDayRetentionUsers Integer Day 1 retention of active users.
TwoDayRetentionUsers Integer Day 2 retention of active users.
ThreeDayRetentionUsers Integer Day 3 retention of active users.
FourDayRetentionUsers Integer Day 4 retention of active users.
FiveDayRetentionUsers Integer Day 5 retention of active users.
SixDayRetentionUsers Integer Day 6 retention of active users.
SevenDayRetentionUsers Integer Day 7 retention of active users.
FourteenDayRetentionUsers Integer Day 14 retention of active users.
ThirtyDayRetentionUsers Integer Day 30 retention of active users.
NewUserCount Integer Number of new users.
OneDayRetentionNewUsers Integer Day 1 retention of new users.
TwoDayRetentionNewUsers Integer Day 2 retention of new users.
ThreeDayRetentionNewUsers Integer Day 3 retention of new users.
FourDayRetentionNewUsers Integer Day 4 retention of new users.
FiveDayRetentionNewUsers Integer Day 5 retention of new users.
SixDayRetentionNewUsers Integer Day 6 retention of new users.
SevenDayRetentionNewUsers Integer Day 7 retention of new users.
FourteenDayRetentionNewUsers Integer Day 14 retention of new users.
ThirtyDayRetentionNewUsers Integer Day 30 retention of new users.
DataTime String Data time in YYYYMMDD format.

StringData

String data object.

Used by actions: DescribeMNGOfflinePackageURL, DescribeMNPOfflinePackageURL.

Name Type Required Description
Data String No String response data.

UploadFileTempSecret

Temporary credentials for file upload.

Used by actions: DescribeTempSecret4UploadFile2Cos.

Name Type Description
Bucket String Storage bucket.
Note: This field may return null, indicating that no valid values can be obtained.
Region String Region.
Note: This field may return null, indicating that no valid values can be obtained.
Path String Upload path.
Note: This field may return null, indicating that no valid values can be obtained.
TempSecretId String Temporary secret ID.
Note: This field may return null, indicating that no valid values can be obtained.
TempSecretKey String Temporary secret key.
Note: This field may return null, indicating that no valid values can be obtained.
Token String Token credential.
Note: This field may return null, indicating that no valid values can be obtained.
AccelerateEnable Integer Whether global acceleration is enabled. Valid values: 0: No; 1: Yes.

VisitData

Page visit data.

Used by actions: DescribeMNPPageAnalysisDetail.

Name Type Description
VisitCount Integer Number of visits.
AvgDeviceVisitDeep String Average pages viewed per device. Calculated as: visit_page_count / active_device_num.
AvgCountVisitDeep String Average pages viewed per session. Calculated as: visit_page_count / miniapp_open_num.
AvgPageVisitDuration String Average page visit duration. Calculated as: miniapp_total_duration / visit_page_count.
AvgCountVisitDuration String Average visit duration per session. Calculated as: miniapp_total_duration / miniapp_open_num.
DataTime Integer Refresh time in YYYYMMDD format.
이전 주제: DescribePaymentDataOverview다음 주제: History

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백