Servicio de tipo de identidad

Artículo
05/18/2024

Nota:

Este servicio se encuentra actualmente en Alpha. Todavía está en desarrollo y puede estar sujeto a cambios sin previo aviso. Póngase en contacto con su representante de cuenta de Microsoft para habilitarlo.

El servicio Identity Type de Identity Management Framework se puede usar para recuperar, crear, actualizar y eliminar un identificador en la plataforma. Además, este servicio permite a los propietarios administrar permisos para sus soluciones de identidad. Con este servicio, los propietarios de identidades pueden:

Determine los publicadores a los que se les permite usar su identificador dentro de la secuencia de pujas.
Decida los asociados de la plataforma que pueden incorporar datos mediante su identificador.
Elija los licitadores externos que sean aptos para acceder a su identificador.
Seleccione los asociados de la plataforma que son aptos para recibir el valor del identificador en sus fuentes de distribución de datos de nivel de registro.

Importante

Para registrar o crear un nuevo identificador, póngase en contacto con su representante de cuenta de Microsoft, ya que esta funcionalidad está restringida al rol de administrador de Microsoft.

API de REST

Http (método)	Endpoint	Description
`GET`	https://api.appnexus.com/identity-type?id=IDENTITY_ID1	Vea un identificador específico por su identificador. Este es el `IDENTITY_ID1` ejemplo del identificador de un identificador.
`GET`	https://api.appnexus.com/identity-type?id=IDENTITY_ID1,IDENTITY_ID2,IDENTITY_ID3	Vea varios identificadores por sus identificadores mediante una lista separada por comas.
`GET`	https://api.appnexus.com/identity-type?source=SOURCE1	Vea un identificador específico por un origen como LiveRamp, Warner Media, etc. `SOURCE1` Este es un ejemplo del origen de un identificador.
`GET`	https://api.appnexus.com/identity-type?source=SOURCE1,SOURCE2	Vea varios identificadores por origen mediante una lista separada por comas.
`GET`	https://api.appnexus.com/identity-type?member_owner_id=OWNERID1	Vea los identificadores por el identificador de un propietario de identidad.
`GET`	https://api.appnexus.com/identity-type?member_owner_id=OWNERID1,OWNERID2	Vea varios identificadores por varios identificadores de propietarios mediante una lista separada por comas.
`PUT`	https://api.appnexus.com/identity-type?id=IDENTITY_ID1	Actualice un identificador específico por su identificador.
`POST`	https://api.appnexus.com/identity-type	Agregue un identificador mediante json de carga, como se muestra en el ejemplo. Campo solo administrador de Microsoft.
`DELETE`	https://api.appnexus.com/identity-type?id=IDENTITY_ID1& member_id=MEMBER_ID1	Eliminar un identificador existente pertenece a un miembro. Campo solo administrador de Microsoft.

Campos JSON

Campos de registro con control de solo administrador

Campo	Tipo	Descripción
`id`	Entero	Identificador creado por Microsoft del identificador. Solo lectura. Obligatorio activado:`PUT` y `DELETE`.
`member_owner_id`	Entero	Identificador de miembro del propietario del identificador (normalmente un publicador). Obligatorio activado:`POST` Campo de solo escritura del administrador de Microsoft.
`source`	string	Origen del identificador. Por ejemplo, LiveRamp, Warner Media, etc. El origen debe ser único para el identificador. Obligatorio activado:`POST`
`requires_platform_resolution`	booleano	Es la resolución de plataforma requerida por un identificador para la codificación y descodificación. Obligatorio activado:`POST`
`requires_seat_resolution`	booleano	Es la resolución de puestos requerida por el identificador de cada licitador (RampID).
`identity_resolver_check`
`is_auction_usage_single_context`	booleano	El contexto de identificador establecido para el uso de privacidad pertinente (CPRA). Si el identificador se usa para identificar a un usuario en 2 o más dominios o sitios web, debe establecerse en `false`. Obligatorio activado:`POST`
`is_passthrough`	booleano	La configuración maestra para permitir el límite de frecuencia y la segmentación de audiencia en la plataforma. Predeterminado:`False`
`requires_rti_partner_match`	booleano	Campo necesario para los identificadores relacionados con The Trade Desk.
`rti_partner`	booleano	Campo necesario para los identificadores relacionados con The Trade Desk.
`is_experimental`	booleano	Campo usado para FLoC/Topics. Para obtener más información sobre FLoC, vea Aprendizaje federado de cohortes (FLoC)
`opt_out_default`	booleano	Cuando `true`es , el identificador de tipo de sector se desactiva de forma predeterminada y viceversa. Cuando se opta por el tipo de identidad, no es necesario consultar el solucionador de identidades para comprobar si hay algún tipo de exclusión. Sin embargo, cuando el tipo de identidad se desactiva inicialmente de forma predeterminada, el solucionador de identidades debe determinar si se debe participar o no en el identificador.
`enforce_adx_specification`	booleano	El campo especifica si la longitud del identificador de validación de la unidad en Impression Bus es mayor que 32.

La configuración del control maestro para un propietario de identificador

Campo	Tipo	Descripción
`status`	string	Estado del identificador, ya sea su `active` o `inactive`.
`auction_participation_control`	objeto	La configuración maestra para controlar si otros publicadores pueden emplear este identificador y especificar los que tienen permiso para hacerlo. Para obtener más detalles, consulte Contols de participación en subastas a continuación.
`audience_segmentation_control`	objeto	La configuración maestra para controlar los permisos para otros miembros para la segmentación de audiencia mediante el identificador . Este campo en la solicitud define la lista de miembros para los que se permite la incorporación de segmentos para el identificador registrado.
`external_bidder_control`	objeto	La configuración maestra para controlar si el identificador se puede enviar a los licitadores externos y especificar los licitadores externos aptos. Este campo define la lista predeterminada de licitadores que recibirán el origen y el identificador recién registrados. De forma predeterminada, los participantes miembros pueden usar los licitadores definidos en el nivel de identificador o pueden invalidar mediante la API de participante del tipo de identidad.
`lld_exposure_control`	objeto	La configuración maestra para regular si el identificador se puede usar en los datos de nivel de registro (LLD) y determinar los destinatarios autorizados. Este campo define la lista de miembros que podrán ver los valores de identificador reales en la fuente LLD para el origen y el identificador recién registrados. De forma predeterminada, los participantes miembros pueden usar los miembros definidos en el nivel de identificador o pueden invalidar la API de participante del tipo de identidad.

Control de participación en subastas

La configuración maestra para controlar si otros publicadores pueden emplear este identificador y especificar los que tienen permiso para hacerlo. Este campo de la solicitud define la lista de miembros para los que está habilitada la subasta. Los miembros habilitados para subastas se convierten en los participantes de un identificador en el marco.

Campo	Tipo	Descripción
`allow_participation`	string	Vendedores habilitados para la participación en subastas: Opciones: - `"all"` - `"none"` - `“include_subset”`
`participant_member_list`	matriz de enteros	Lista de `member_id` habilitados para: `“include_subset”`

Control de segmentación de audiencia

La configuración maestra para controlar los permisos para otros miembros para la segmentación de audiencia mediante el identificador . Este campo en la solicitud define la lista de miembros para los que se permite la incorporación de segmentos para el identificador registrado.

Campo	Tipo	Descripción
`allow_segmentation`	string	Miembros habilitados para la segmentación de público: Opciones: - `"all"` - `"none"` - `“include_subset”`
`segmentation_member_list`	matriz de enteros	Lista de `member_id` habilitados para: `“include_subset”`

Control del licitador externo

La configuración maestra para controlar si el identificador se puede enviar a los licitadores externos y especificar los licitadores externos aptos. Este campo define la lista predeterminada de licitadores que recibirán el origen y el identificador recién registrados. De forma predeterminada, los participantes miembros pueden usar los licitadores definidos en el nivel de identificador o pueden invalidar mediante la API de participante del tipo de identidad.

Campo	Tipo	Descripción
`allow_bidders`	matriz	Miembros de licitadores externos habilitados para recibir el identificador: Opciones: - `"all"` - `"none"` - `“include_subset”`
`external_bidder_list`	matriz de enteros	Lista de `member_id` habilitados para: `“include_subset”`

Control de exposición de datos de nivel de registro

La configuración maestra para regular si el identificador se puede usar en los datos de nivel de registro (LLD) y determinar los destinatarios autorizados. Este campo define la lista de miembros que podrán ver los valores de identificador reales en la fuente LLD para el origen y el identificador recién registrados. De forma predeterminada, los participantes miembros pueden usar los miembros definidos en el nivel de identificador o pueden invalidar la API de participante del tipo de identidad donde los publicadores tienen la opción de usar el servicio de participantes para ejercer un control adicional sobre cómo la plataforma emplea y expone el identificador que proporcionan.

Campo	Tipo	Descripción
`lld_exposure_allowed`	matriz	Miembros habilitados para recibir valores de identificador en LLD. Opciones: - `"all"` - `"none"` - `“include_subset”` - `"participant_only"`
`exposure_member_list`	matriz de enteros	Lista de `member_id` habilitados para: `“include_subset”`

Ejemplos

Creación de un identificador

$ cat new_identifier.json
{
  "identity_type": {
      "source": "test.com",
      "member_owner_id": 958,
      "requires_platform_resolution": true,
      "identity_resolver_check": true,
      "is_auction_usage_single_context": true,
      "is_passthrough": true,
      "requires_seat_resolution": false,
      "requires_rti_partner_match": false,
      "rti_partner": "",
      "is_experimental": false,
      "opt_out_default": false,
      "status": "active",
      "enforce_adx_specification": false,
      "auction_participation_control": {
        "allow_participation": "include_subset",
        "participant_member_list": [
          123,
          456
        ]
      },
      "audience_segmentation_control": {
        "allow_segmentation": "include_subset",
        "segmentation_member_list": [
          456
        ]
      },
      "external_bidder_control": {
        "allow_bidders": "all",
        "external_bidder_list": [
          111,
          112
        ]
      },
      "lld_exposure_control": {
        "lld_exposure_allowed": "include_subset",
        "exposure_member_list": [
          311,
          312
        ]
      }
    }
  }
$ curl -b cookie -c cookie -X POST  'https://api.appnexus.com/identity-type'
{
    "response": {
        "status":"OK",
        "id":IDENTITY_ID_001
        }
        }

Nota:

En el caso de los orígenes recién registrados, los identificadores se generan en el orden incremental, mientras que el resto de los valores de campo se almacenan en la base de datos en función de la solicitud enviada a través de la API.

Ver los detalles de un identificador específico

$ curl -b cookies -c cookies 'https://api.appnexus.com/identity-type?id=IDENTITY_ID_001'
{
  "response": {
    "status": "OK",
    "identity_type": {
        "id": IDENTITY_ID_001,
        "source": "test.com",
        "member_owner_id": 958,
        "requires_platform_resolution": true,
        "identity_resolver_check": true,
        "is_auction_usage_single_context": true,
        "is_passthrough": true,
        "requires_seat_resolution": false,
        "requires_rti_partner_match": false,
        "rti_partner": "",
        "is_experimental": false,
        "opt_out_default": false,
        "status": "active",
        "enforce_adx_specification": false,
        "auction_participation_control": {
          "allow_participation": "include_subset",
          "participant_member_list": [
            123,
            456
          ]
        },
        "audience_segmentation_control": {
        "allow_segmentation": "include_subset",
        "segmentation_member_list": [
          456
         ]
        },
        "external_bidder_control": {
        "allow_bidders": "all",
        "external_bidder_list": [
          111,
          112
         ]
        },
        "lld_exposure_control": {
        "lld_exposure_allowed": "include_subset",
        "exposure_member_list": [
          311,
          312
        ]
      }
    }
  }
}

Servicio participante del tipo de identidad

Compartir a través de

Servicio de tipo de identidad

API de REST

Campos JSON

Campos de registro con control de solo administrador

La configuración del control maestro para un propietario de identificador

Control de participación en subastas

Control de segmentación de audiencia

Control del licitador externo

Control de exposición de datos de nivel de registro

Ejemplos

Creación de un identificador

Ver los detalles de un identificador específico

Recursos adicionales

Compartir a través de

Servicio de tipo de identidad

API de REST

Campos JSON

Campos de registro con control de solo administrador

La configuración del control maestro para un propietario de identificador

Control de participación en subastas

Control de segmentación de audiencia

Control del licitador externo

Control de exposición de datos de nivel de registro

Ejemplos

Creación de un identificador

Ver los detalles de un identificador específico

Tema relacionado

Recursos adicionales