DocumentaciónAnalyticsGuía de Media Analytics

Validación de solicitudes de eventos validating-event-requests

Last update: Mon Jan 23 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Creado para:

  • User
  • Admin
  • Developer

El cuerpo de la petición JSON para cada tipo de evento se valida en el servidor con esquemas JSON. En el cuerpo de la respuesta HTTP aparecerá un mensaje de error cuando la validación falle para una llamada de API.

Los esquemas de validación de JSON para cada tipo de evento son accesibles aquí: {uri}/api/v1/schemas/{eventType} (por ejemplo, {uri}/api/v1/schemas/sessionEnd). Estos esquemas de validación de JSON son la autoridad absoluta para determinar los parámetros de cuerpo de solicitud correctos para cada tipo de evento.

Por ejemplo, la respuesta a una solicitud del esquema de validación sessionStart se parecerá a esta muestra (ligeramente formateado para mejorar la legibilidad):

HTTP/1.1 200 OK
Server: nginx/1.13.5
Date: Thu, 18 Jan 2018 15:44:50 GMT
Content-Type: application/json
Content-Length: 2716
Connection: keep-alive

{
  "$schema":"https://json-schema.org/draft-04/schema#",
  "id":"https://alpha.hb-api.omtrdc.net/api/v1/schemas/sessionStart",
  "definitions":
  {
    "playerTime":
    {
      "type":"object","properties":
      {
        "playhead":
        {"type":"number"},
        "ts":
        {"type":"integer"}
      },
      "required":["playhead","ts"],
      "additionalProperties":false
    },
    "eventType":
    {
      "type":"string",
      "enum":[
        "sessionStart",
        "play",
        "ping",
        "bufferStart",
        "pauseStart",
        "sessionComplete",
        "bitrateChange",
        "error",
        "adBreakStart",
        "adBreakComplete",
        "adStart",
        "adComplete",
        "adSkip",
        "sessionEnd"
      ]
    },
    "qoeData":
    {
      "type":"object","properties":
      {
        "media.qoe.bitrate":
        {"type":"integer"},
        "media.qoe.droppedFrames":
        {"type":"integer"},
        "media.qoe.framesPerSecond":
        {"type":"integer"},
        "media.qoe.timeToStart":
        {"type":"integer"}
      },
      "required":[],
      "additionalProperties":false
    },
    "customMetadata":
    {
      "type":"object",
      "patternProperties":
      {
        "^[a-zA-Z0-9_\\.]+$":
        {"type":"string"}
      },
      "additionalProperties":false
    },
    "sessionStart":
    {
      "properties":
      {
        "eventType":
        {"type":"string","enum":["sessionStart"]},
        "playerTime":
        {"$ref":"#/definitions/playerTime"},
        "params":
        {"type":"object",
          "properties":
          {
            "appInstallationId":
            {"type":"string"},
            "analytics.trackingServer":
            {"type":"string"},
            "analytics.reportSuite":
            {"type":"string"},
            <...>
            "visitor.marketingCloudOrgId"],
            "additionalProperties":false
          },
          "customMetadata":
          {"$ref":"#/definitions/customMetadata"},
          "qoeData":
          {"$ref":"#/definitions/qoeData"}
        },
        "required":["eventType","playerTime","params"],
        "additionalProperties":false
      }
    },
    "type":"object","$ref":"#/definitions/sessionStart"
  }
}
NOTE
No es posible validar el nivel de sesión porque el contexto no está disponible en la capa de recopilación.
recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb