Create custom attributes

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Create a profile of custom attributes.

When a user requests the creation of custom attributes, the NCLUE system registers the request job and returns the profile ID. The creation process is as follows.

Creation process

Order	Creation status	Description
Step 1	Registered `registered`	Status where the creation job is registered in the system. It is the status before starting the job. You can cancel the job by deleting it at this point
Step 2	Pending `pending`	Status where the creation job is queued in the system
Step 3	Creating `in_progress`	Status where the job is being executed on the server. Creation time varies depending on the service's available resources
Step 4	Creation complete Available `completed` Failed `failed`	Once creation is complete, it will be available for use when successful with the "Available" status. If an error occurs during the operation, it will be in the "Failed" status, and the error message can be used to troubleshoot the problem

The creation of custom attributes varies in time depending on the service's available resources. To check the progress of the creation, call the Get custom attributes API and check the "status" field in the response body.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
POST	/api/v1/profile/custom-attributes

Request headers

For information about the headers common to all NCLUE APIs, see Common NCLUE headers.

Request body

You can include the following data in the body of your request:

Field	Type	Required	Description
`name`	String	Required	Profile name (40-character limit)
`feature_id`	String	Required	Feature ID to profile
`keyword_set`	String	Required	A list of attribute keywords entered by the user (keywords to check similarity with the target user) Use a line break ("\n") as a delimiter Up to 1000 characters can be entered
`result_bucket`	String	Required	Name of the Object Storage bucket to store custom attributes job results
`result_file_path`	String	Required	File path to store the results in the result_bucket bucket File paths containing the following special characters can't be entered &$@=;:+,?*\{}^%`[]<>~#\\|"' Characters with ASCII codes 0 to 31 and 128 to 255

Request example

The request example is as follows:

curl --location --request POST 'https://nclue.apigw.ntruss.com/api/v1/profile/custom-attributes' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}' 
--data '{
    "name":"Running profiling",
    "feature_id":"79eb85b5-8ec5-4e1a-8617-64a1977c8062",
    "keyword_set":"Running\nrun\nmarathon\njogging\nrunning shoes\nrunning socks\nrunning app",
    "result_bucket":"your.bucket.name",
    "result_file_path":"running_profiling"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`profile_id`	String	-	Profile ID
`profile_name`	String	-	Profile name of the custom attributes entered by the user
`feature_id`	String	-	Feature ID to profile
`feature_name`	String	-	Feature name to profile
`keyword_set`	String	-	A list of attribute keywords entered by the user (keywords to check similarity with the target user) Unlike when inputting, here the delimiter is a comma
`created_at`	String	-	Custom attributes creation request date (ISO 8601 format)
`result_bucket`	String	-	Name of the Object Storage bucket to store custom attributes job results
`result_file_path`	String	-	File path to save the results in the result_bucket bucket

Response example

The response example is as follows:

Succeeded

The following is a sample response upon a successful call.

{
    "profile_id":"efc3f714-d267-44e2-a574-75497cc7712c",
    "profile_name":"Running profiling",
    "feature_id":"79eb85b5-8ec5-4e1a-8617-64a1977c8062",
    "feature_name":"Shopping behavior sequence - 2024",
    "keyword_set":"Running, run, marathon, jogging, running shoes, running socks, running app",
    "created_at":"2024-11-05T11:42:53",
    "result_bucket":"your.bucket.name",
    "result_file_path":"running_profiling"
}

Failure

For examples of responses in the event of a failed call, see Response status codes.

Was this article helpful?

What's Next

Delete custom attributes

Table of contents

Request
Response