Configurar atributos de usuario

Dirección de invocación

POST /v1/user/property

Verificación de invocación

La API REST de EngageLab utiliza HTTP Basic Authentication como método de verificación. Añadir Authorization a la cabecera HTTP:

              
              Authorization: Basic ${base64_auth_string}

            

El valor base64_auth_string se genera mediante el siguiente algoritmo: base64(api_key:api_secret).

• El nombre de la cabecera es "Authorization" y el valor es el par "nombre_de_usuario:contraseña" codificado en base64 (separado por dos puntos).
• Para la API de MA, el nombre de usuario corresponde a la APIKey y la contraseña corresponde al APISecret. Se debe configurar una fuente de datos de tipo API para obtener la APIKey y el API Secret.

Ejemplo de solicitud

Cabecera de solicitud

              
              > POST /v1/user/property
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

            

Cuerpo de solicitud

              
              {
    "euid": 10362473,
    "type": "set",
    "properties": {
        "user_number_once": 46.2, // User property name and property value
        "user_string_once": "refef",
        "user_datetime_once": "2023-12-12 00:56:23"
    }
}

            

Parámetros de solicitud

Tipos de operación

Todas las propiedades de una solicitud usan el mismo type. Se admiten set, increase, add, remove, delete, setOnce y update.

Operaciones de arreglo de objetos

Para object_array, el valor de add es un objeto JSON y el de set es un arreglo de objetos JSON. remove y update localizan un elemento mediante $identifier_key y $identifier_value; el campo identificador debe ser un subcampo string o number definido.

El valor de remove solo puede incluir esos dos campos identificadores:

              
              {
  "euid": 10362473,
  "type": "remove",
  "properties": {
    "devices": {
      "$identifier_key": "device_id",
      "$identifier_value": "ios-001"
    }
  }
}

            

update también requiere un $new_object no vacío. No puede incluir el campo identificador; los campos cuyo valor sea null se eliminan del elemento encontrado. El identificador debe coincidir exactamente con un elemento del arreglo.

              
              {
  "euid": 10362473,
  "type": "update",
  "properties": {
    "devices": {
      "$identifier_key": "device_id",
      "$identifier_value": "ios-001",
      "$new_object": {
        "model": "iPhone 16",
        "legacy_field": null
      }
    }
  }
}

            

Parámetros de respuesta

Todo correcto

              
              {
    "code": 0,
    "message": "success"
}

            

Todo fallido

              
              {
    "code": 55102,
    "message": "Invalid user attributes exist"
}

            

Código de error