Data dictionary

2024-12-09 16:43

Configuration

Field	Data type	Description	Required
fetchUserId	IFetchUserId	Callback for collecting user IDs	No
isDebug	Boolean	Indicates whether the log component library will use the server address set by ASAPConfiguration.	No
asap	ASAPConfiguration	ASAP log server configuration	No. Required if the ASAPBusiness module is integrated.
rpcSingerMode	RPCSignerMode	Configures the signature mode for wireless security network requests.	No. Required if the ASAPBusiness module is integrated.

ASAPConfiguration

Field	Data type	Description	Required
logUploadURL	String	The URL for uploading log information. It takes effect when the value of isDebug is `true`.	No
rpcURL	String	The URL of the ASAPBusiness module.	No. Specify if the ASAPBusiness module is integrated.
presetWidgetTemplateFilePath	String	The local file path for the predefined template.	No. Specify if the ASAPBusiness module is integrated.

RPCSignerMode

RPCSignerMode.Helper

Field	Data type	Description	Required
key	String	The key required for signing wireless security network requests.	Yes
authCode	String	The authorization code required for signing wireless security network requests.	Yes

RPCSignerMode.Master

Field	Data type	Description	Required
sign	IMasterSigner	The customized signature for network requests.	Yes

LogContentItem

Field	Data type	Description	Required
userId	String	Preset field	No
spaceId	String	Preset field	No
deliveryTaskId	String	Preset field	No
deliveryPlanId	String	Preset field	No
elementType	String	Preset field	No
contentId	String	Preset field	No
sceneId	String	Preset field	No
contentConfigId	String	Preset field	No
businessUnitCode	String	Preset field	No
spaceCode	String	Preset field	No
budgetControlDeliveryMode	String	Preset field	No
positionId	String	Preset field	No
industryOrgId	String	Preset field	No
miniProgramId	String	Preset field	No
miniProgramVersion	String	Preset field	No
traceCode	String	Preset field	No
extras	Map<String, String>	Extra parameters	No

PullOffsetInfo

Field	Data type	Description	Required
overallOffset	Int	The offset of the first space that is pulled.	Yes
pullSize	Int	The number of spaces pulled.	Yes

TouchLandingInfo

Field	Data type	Description	Required
touchDeliveryTaskId	String	This field is obtained from the response of the pullSpaceContents API in Scene A when accessing Scene B using the space information from Scene A.	Yes

SpacePullInfo

Field	Data type	Description	Required
spaceCode	String	Custom code that you create within space management.	Yes
pullOffsetInfo	PullOffsetInfo	Pull offset information.	No
conditions	Map<String, String>	A dictionary of conditions to filter the request. Each key-value pair represents a condition.	No
touchLandingInfo	TouchLandingInfo	Touch landing information.	No

SPMDItem

Field	Data type	Description	Required
key	String	The unique identifier key for the SPM-D item.	No
type	String	The type of the SPM-D item.	No
name	String	The name associated with the SPM-D item.	No
value	String	The value of the SPM-D item.	No
eventType	List<String>	Valid values: exposure click	No

SPM

Field	Data type	Description	Required
a	String	The first attribute of the Super Position Model.	No
b	String	The second attribute of the Super Position Model.	No
c	String	The third attribute of the Super Position Model.	No
dItems	List<SPMDItem>	An array of items related to the Super Position Model.	No

ContentItem

Field	Data type	Description	Required
attributes	Map<String, String>	Attributes of the content item.	No
scm	Map<String, String>	SCM properties related to the content item.	No
extendInfo	Map<String, String>	Extended data.	No
touchLandingInfo	TouchLandingInfo	Touch landing information.	No

SpaceContent

Field	Data type	Description	Required
spaceCode	String	Custom code that you create within space management.	No
spm	SPM	Super Position Model.	No
spaceProperties	Map<String, String>	Properties specific to the space, stored as key-value pairs.	No
contentItems	List<ContentItem>	List of content items within the space.	No
hasMore	Boolean	Indicates if there are more items available for retrieval.	No
extendedAttributes	Map<String, String> Expand data.	Extended data	No
isSuccess	Boolean	A flag indicating whether the recall operation was successful.	No
overallOffset	Int	Overall offset.	No

PullSpaceContentsResponse

Field	Data type	Description	Required
spaceContents	List<SpaceContent>	Array of space contents retrieved from the operation.	No

WidgetDataModel

Field	Data type	Description	Required
id	String	Unique ID for widget data.	Yes
templateCode	String	Template code.	Yes
templateVersion	String	Template version.	Yes
content	Map<String,Any>	Template content.	No
extendedInfo	Map<String,Any>	External Info.	No
spmInfo	Map<String,Any>	SPM info that replaces template placeholders.	No