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

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

Criar o corpo da solicitação

Crie um recurso UserList. 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 da conta.

description

Uma breve descrição da lista.

integrationCode

Um ID do seu sistema.

membershipDuration

O período em que um membro do público-alvo permanece na lista depois de 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 de assinatura de 90 dias, use o valor 7776000s desde 90 * 86400 = 7776000.

Se você estiver usando o formato de buffer de protocolo, use o método de conveniência para construir um objeto Duration com base no número de dias, se esse método existir. Por exemplo, a biblioteca protobuf-java-util para Java tem um método de conveniência fromDays(). 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 de segmentação 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 à lista de público-alvo.

Lista de informações de contato

Defina os seguintes campos se quiser usar dados 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

Definido 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 mensagem ContactIdInfo com o dataSourceType definido como o valor apropriado do enumerador DataSourceType.

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

Definido 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 mensagem de MobileIdInfo:

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

• Defina keySpace como IOS ou ANDROID.

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

  • No iOS, a string do ID é a de 9 dígitos que aparece no final do URL da App Store. Por exemplo, 476943146 para o app "Flood-It!" com o link da App Store https://apps.apple.com/us/app/flood-it/id476943146.

  • No Android, a string do ID é o nome do pacote do aplicativo. Por exemplo, com.labpixies.flood para o app "Flood-It!" com o link do Google Play https://play.google.com/store/apps/details?id=com.labpixies.flood.

Crie a solicitação

Para criar um público-alvo com a segmentação 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 que você criou para o corpo da solicitação.

3. Se as 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.

Dados de contato

Abrir no API Explorer

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

Abrir no API Explorer

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

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 UserList criado com os campos id e name preenchidos. Anote os valores nesses campos, porque você vai precisar deles em solicitações para adicionar membros ao 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 os problemas e envie a solicitação e os cabeçalhos atualizados.