Criar um público-alvo segmentado por lista de clientes

Crie um público-alvo segmentado por lista de clientes enviando uma CreateUserListRequest.

Criar o corpo da solicitação

Crie um UserList recurso. Confira os campos comuns a serem definidos.

displayName
Obrigatório : o nome de exibição da lista. O nome precisa ser exclusivo entre todas as listas de propriedade da conta.
description
Uma breve descrição da lista.
integrationCode
Um ID do seu sistema.
membershipDuration

A duração em que um membro do público-alvo permanece na lista após ser adicionado. O valor precisa corresponder a dias inteiros. Se não for definido, o padrão será o máximo.

Se você estiver usando JSON, calcule o número de segundos multiplicando os dias de duração por 86400 (o número de segundos por dia). Em seguida, defina o valor como o resultado da multiplicação, seguido por s. Por exemplo, se você quiser uma duração da associação de 90 dias, use o valor 7776000s, já que 90 * 86400 = 7776000.

Se você estiver usando o formato de buffer de protocolo, use o método de conveniência para criar um Duration objeto com base no número de dias, se houver um método de conveniência. Por exemplo, a protobuf-java-util biblioteca para Java tem um fromDays() método de conveniência. Caso contrário, calcule o número de segundos multiplicando os dias de duração por 86400 (o número de segundos por dia) e use o resultado para definir o campo seconds do objeto Duration.

Campos obrigatórios para a segmentação por lista de clientes

O campo ingestedUserListInfo é obrigatório para um público-alvo segmentado por lista de clientes.

Confira os campos a serem definidos no IngestedUserListInfo com base no tipo de dados que você quer usar para adicionar membros do público-alvo à lista.

Lista de informações de contato

Defina os seguintes campos se quiser usar informações de contato (endereços de e-mail, números de telefone ou endereços com hash) para definir os membros do público-alvo:

uploadKeyTypes

Defina como uma lista que contém o tipo de chave de upload CONTACT_ID.

A lista uploadKeyTypes precisa conter apenas uma entrada.

contactIdInfo

Defina como uma ContactIdInfo mensagem com o dataSourceType definido como o valor apropriado da DataSourceType enumeração.

Lista de IDs de dispositivos móveis

Defina os seguintes campos se quiser usar IDs de dispositivos móveis para definir os membros do público-alvo:

uploadKeyTypes

Defina como uma lista que contém o tipo de chave de upload MOBILE_ID.

A lista uploadKeyTypes precisa conter apenas uma entrada.

mobileIdInfo

Defina como uma MobileIdInfo mensagem:

  • Defina o dataSourceType como o valor apropriado da DataSourceType enumeração.

  • Defina o keySpace como IOS ou ANDROID.

  • Defina o appId como a string que identifica exclusivamente o aplicativo para dispositivos móveis em que os dados foram coletados.

Lista de IDs de usuários

Defina os seguintes campos se quiser usar IDs de usuários para definir os membros do público-alvo:

uploadKeyTypes

Defina como uma lista que contém o tipo de chave de upload USER_ID.

A lista uploadKeyTypes precisa conter apenas uma entrada.

Criar a solicitação

Para criar um público-alvo segmentado por lista de clientes, crie uma create solicitação para o recurso UserList.

  1. Defina o campo parent como o nome do recurso da conta. O nome do recurso precisa seguir o formato accountTypes/{accountType}/accounts/{account_id}.

  2. Use o UserList criado para o corpo da solicitação.

  3. Se suas credenciais não forem de uma Conta do Google que seja um usuário no parent, defina os cabeçalhos conforme descrito em Configurar destinos e cabeçalhos.

Confira exemplos de solicitações em JSON para os diferentes tipos de informações do usuário. Cada solicitação define o membershipDuration como 2592000s, em que 2592000 é o número de segundos em 30 dias. Clique no botão Abrir no APIs Explorer para testar uma solicitação.

Informações de contato

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

IDs de dispositivos móveis

{
    "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"
}

IDs de usuários

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

Enviar a solicitação

Envie a solicitação e, se necessário, inclua cabeçalhos de solicitação.

Se a solicitação for bem-sucedida, a resposta vai conter o criado UserList com o id e name preenchidos. Anote os valores nesses campos, porque eles são necessários em solicitações para adicionar membros do público-alvo.

Se a solicitação falhar, inspecione os erros para determinar a causa da falha, atualize a solicitação e os cabeçalhos para corrigir problemas e envie a solicitação e os cabeçalhos atualizados.