Cree un público de Segmentación por clientes

Para crear un público de Segmentación por clientes, envía una CreateUserListRequest.

Cómo construir el cuerpo de la solicitud

Crea un UserList recurso. Estos son los campos comunes que se deben configurar.

displayName

Obligatorio El nombre visible de la lista. El nombre debe ser único entre todas las listas que posee la cuenta.

description

Una breve descripción de la lista.

integrationCode

Un ID de tu sistema.

membershipDuration

Es el tiempo que un miembro del público permanece en la lista después de agregarse. El valor debe corresponder a días completos. Si no se establece, se usa el valor máximo de forma predeterminada.

Si usas JSON, calcula la cantidad de segundos multiplicando los días de duración por 86400 (la cantidad de segundos por día). Luego, establece el valor en el resultado de la multiplicación, seguido de s. Por ejemplo, si deseas una duración de la membresía de 90 días, usa el valor 7776000s ya que 90 * 86400 = 7776000.

Si usas el formato de búfer de protocolo, usa el método útil para construir un Duration objeto en función de la cantidad de días, si existe dicho método útil. Por ejemplo, la protobuf-java-util biblioteca para Java tiene un fromDays() método útil. De lo contrario, calcula la cantidad de segundos multiplicando los días de duración por 86400 (la cantidad de segundos por día) y usa el resultado para establecer el campo seconds del objeto Duration.

Campos obligatorios para la Segmentación por clientes

El campo ingestedUserListInfo es obligatorio para un público de Segmentación por clientes.

Estos son los campos que se deben configurar en IngestedUserListInfo según el tipo de datos que deseas usar para agregar miembros del público a la lista.

Lista de información de contacto

Configura los siguientes campos si deseas usar información de contacto (direcciones de correo electrónico, números de teléfono o direcciones con codificación hash) para definir a los miembros de tu público:

uploadKeyTypes

Establece una lista que contenga el tipo de clave de carga CONTACT_ID.

La lista uploadKeyTypes debe contener solo una entrada.

contactIdInfo

Establece un ContactIdInfo mensaje con el dataSourceType establecido en el valor adecuado de la DataSourceType enumeración.

Lista de documentos de identidad digitales

Configura los siguientes campos si deseas usar IDs de dispositivos móviles para definir a los miembros de tu público:

uploadKeyTypes

Establece una lista que contenga el tipo de clave de carga MOBILE_ID.

La lista uploadKeyTypes debe contener solo una entrada.

mobileIdInfo

Establece un MobileIdInfo mensaje:

• Establece el dataSourceType en el valor adecuado de la DataSourceType enumeración.

• Establece el keySpace en IOS o ANDROID.

• Establece el appId en la cadena que identifica de forma única la aplicación para dispositivos móviles desde la que se recopilaron los datos.

  • En iOS, la cadena de ID corresponde a la cadena de 9 dígitos que aparece al final de la URL de la App Store. Por ejemplo, 476943146 para la app "Flood-It!" con el vínculo de la App Store https://apps.apple.com/us/app/flood-it/id476943146.

  • En Android, la cadena de ID corresponde al nombre del paquete de la aplicación. Por ejemplo, com.labpixies.flood para la app "Flood-It!" con el vínculo de Google Play https://play.google.com/store/apps/details?id=com.labpixies.flood.

Lista de IDs de usuario

Configura los siguientes campos si deseas usar IDs de usuario para definir a los miembros de tu público:

uploadKeyTypes

Establece una lista que contenga el tipo de clave de carga USER_ID.

La lista uploadKeyTypes debe contener solo una entrada.

Cómo construir la solicitud

Para crear un público de Segmentación por clientes, construye una create solicitud para el recurso UserList.

1. Establece el campo parent en el nombre de recurso de la cuenta. El nombre de recurso debe seguir el formato accountTypes/{accountType}/accounts/{account_id}.

2. Usa el UserList que construiste para el cuerpo de la solicitud.

3. Si tus credenciales no son para una Cuenta de Google que sea un usuario en el parent, establece los encabezados como se describe en Configura destinos y encabezados.

Aquí tienes solicitudes de ejemplo en JSON para los diferentes tipos de información del usuario. Cada solicitud establece el membershipDuration en 2592000s, donde 2592000 es la cantidad de segundos en 30 días. Haz clic en el botón Abrir en el Explorador de APIs para probar una solicitud.

{
    "description": "Customer Match for contact info",
    "displayName": "Contact info audience",
    "ingestedUserListInfo": {
        "contactIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY"
        },
        "uploadKeyTypes": [
            "CONTACT_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

{
    "description": "Customer Match for mobile IDs",
    "displayName": "Mobile ID audience",
    "ingestedUserListInfo": {
        "mobileIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY",
            "keySpace": "ANDROID",
            "appId": "com.labpixies.flood"
        },
        "uploadKeyTypes": [
            "MOBILE_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

{
    "description": "Customer Match for user IDs",
    "displayName": "User ID audience",
    "ingestedUserListInfo": {
        "userIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY"
        },
        "uploadKeyTypes": [
            "USER_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

Envía la solicitud

Envía la solicitud y, si es necesario, incluye los encabezados de solicitud.

Si la solicitud se realiza correctamente, la respuesta contiene el creado UserList con el id y el name propagados. Toma nota de los valores de estos campos, ya que los necesitarás en las solicitudes para agregar miembros del público al público.

Si la solicitud falla, inspecciona los errores para determinar la causa de la falla, actualiza la solicitud y los encabezados para solucionar cualquier problema y, luego, envía la solicitud y los encabezados actualizados.