REST Resource: accountTypes.accounts.userLists

Recurso: UserList

Um recurso de lista de usuários.

Representação JSON 
{
  "name": string,
  "id": string,
  "readOnly": boolean,
  "membershipDuration": string,
  "accessReason": enum (AccessReason),
  "sizeInfo": {
    object (SizeInfo)
  },
  "targetNetworkInfo": {
    object (TargetNetworkInfo)
  },
  "displayName": string,
  "description": string,
  "membershipStatus": enum (MembershipStatus),
  "integrationCode": string,
  "closingReason": enum (ClosingReason),
  "accountAccessStatus": enum (AccessStatus),

  // Union field user_list_info can be only one of the following:
  "ingestedUserListInfo": {
    object (IngestedUserListInfo)
  }
  // End of list of possible types for union field user_list_info.
}
Campos
name

string

Identificador. O nome do recurso da lista de usuários. Formato: accountTypes/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

Apenas saída. O ID exclusivo da lista de usuários.
readOnly

boolean

Apenas saída. Uma opção que indica se um usuário pode editar uma lista.
membershipDuration

string (Duration format)

Opcional. O período em que um usuário permanece na lista de usuários. As durações válidas são múltiplos exatos de 24 horas (86.400 segundos). Fornecer um valor que não seja um múltiplo exato de 24 horas vai resultar em um erro INVALID_ARGUMENT.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
accessReason

enum (AccessReason)

Apenas saída. O motivo pelo qual essa conta recebeu acesso à lista.
sizeInfo

object (SizeInfo)

Apenas saída. Número estimado de membros nessa lista de usuários em diferentes redes de destino.
targetNetworkInfo

object (TargetNetworkInfo)

Opcional. Informações de qualificação para diferentes redes de destino.
displayName

string

Obrigatório. O nome de exibição da lista de usuários.
description

string

Opcional. Uma descrição da lista de usuários.
membershipStatus

enum (MembershipStatus)

Opcional. Status de associação desta lista de usuários.
integrationCode

string

Opcional. Um ID de um sistema externo. Usado por vendedores de listas de usuários para correlacionar IDs nos sistemas deles.
closingReason

enum (ClosingReason)

Apenas saída. O motivo de o status de associação à lista de usuários estar fechado.
accountAccessStatus

enum (AccessStatus)

Opcional. Indica se o compartilhamento ainda está ativado. Quando uma lista de usuários é compartilhada com a conta, esse campo é definido como ENABLED. Depois, o proprietário da lista de usuários pode revogar o compartilhamento e torná-la DISABLED.
Campo de união user_list_info. Informações adicionais sobre a lista de usuários. user_list_info pode ser apenas de um dos tipos a seguir:
ingestedUserListInfo

object (IngestedUserListInfo)

Opcional. Representa uma lista de usuários preenchida com dados ingeridos pelo usuário.

MembershipStatus

Status da lista de usuários.

Tipos enumerados
MEMBERSHIP_STATUS_UNSPECIFIED Não especificado.
OPEN Status aberto: a lista de usuários está acumulando membros e pode ser segmentada.
CLOSED Status "Fechado": nenhum novo membro está sendo adicionado.

ClosingReason

Indica o motivo do encerramento da lista de usuários. Essa enumeração só é usada quando uma lista é fechada automaticamente pelo sistema.

Tipos enumerados
CLOSING_REASON_UNSPECIFIED Não especificado.
UNUSED A lista de usuários foi encerrada porque não foi usada na segmentação recentemente. Consulte https://support.google.com/google-ads/answer/2472738 para mais detalhes.

AccessReason

Enumeração que descreve possíveis motivos de acesso.

Tipos enumerados
ACCESS_REASON_UNSPECIFIED Não especificado.
OWNED O recurso pertence ao usuário.
SHARED O recurso é compartilhado com o usuário.
LICENSED O recurso está licenciado para o usuário.
SUBSCRIBED O usuário se inscreveu no recurso.
AFFILIATED O recurso está acessível ao usuário.

AccessStatus

Indica se o cliente ainda tem acesso à lista.

Tipos enumerados
ACCESS_STATUS_UNSPECIFIED Não especificado.
ENABLED O acesso está ativado.
DISABLED O acesso está desativado.

SizeInfo

Número estimado de membros nessa lista de usuários em diferentes redes de destino.

Representação JSON 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string,
  "youtubeMembersCount": string,
  "gmailMembersCount": string
}
Campos
displayNetworkMembersCount

string (int64 format)

Apenas saída. Número estimado de membros nessa lista de usuários na Rede de Display do Google.
searchNetworkMembersCount

string (int64 format)

Apenas saída. Número estimado de membros nesta lista de usuários no domínio google.com. Estes são os membros disponíveis para segmentação em campanhas de pesquisa.
youtubeMembersCount

string (int64 format)

Apenas saída. Número estimado de membros nesta lista de usuários no YouTube.
gmailMembersCount

string (int64 format)

Apenas saída. Número estimado de membros nesta lista de usuários no Gmail.

TargetNetworkInfo

Informações de qualificação para diferentes redes de destino.

Representação JSON 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
Campos
eligibleForDisplay

boolean

Apenas saída. Indica que esta lista de usuários está qualificada para a Rede de Display do Google.

IngestedUserListInfo

Representa uma lista de usuários preenchida com dados fornecidos pelo usuário.

Representação JSON 
{
  "uploadKeyTypes": [
    enum (UploadKeyType)
  ],
  "contactIdInfo": {
    object (ContactIdInfo)
  },
  "mobileIdInfo": {
    object (MobileIdInfo)
  },
  "userIdInfo": {
    object (UserIdInfo)
  },
  "pairIdInfo": {
    object (PairIdInfo)
  },
  "pseudonymousIdInfo": {
    object (PseudonymousIdInfo)
  },
  "partnerAudienceInfo": {
    object (PartnerAudienceInfo)
  }
}
Campos
uploadKeyTypes[]

enum (UploadKeyType)

Obrigatório. Imutável. Tipos de chaves de upload dessa lista de usuários.
contactIdInfo

object (ContactIdInfo)

Opcional. Informações adicionais quando CONTACT_ID é um dos uploadKeyTypes.
mobileIdInfo

object (MobileIdInfo)

Opcional. Informações adicionais quando MOBILE_ID é um dos uploadKeyTypes.
userIdInfo

object (UserIdInfo)

Opcional. Informações adicionais quando USER_ID é um dos uploadKeyTypes.
pairIdInfo

object (PairIdInfo)

Opcional. Informações adicionais quando PAIR_ID é um dos uploadKeyTypes.

Esse recurso está disponível apenas para parceiros de dados.
pseudonymousIdInfo

object (PseudonymousIdInfo)

Opcional. Informações adicionais para PSEUDONYMOUS_ID são uma das uploadKeyTypes.
partnerAudienceInfo

object (PartnerAudienceInfo)

Opcional. Informações adicionais para públicos-alvo de parceiros.

Esse recurso está disponível apenas para parceiros de dados.

UploadKeyType

Enumeração que contém os possíveis tipos de chave de upload de uma lista de usuários.

Tipos enumerados
UPLOAD_KEY_TYPE_UNSPECIFIED Não especificado.
CONTACT_ID Informações do cliente, como endereço de e-mail, número de telefone ou endereço físico.
MOBILE_ID IDs de publicidade móvel.
USER_ID IDs de usuários fornecidos por terceiros.
PAIR_ID IDs de reconciliação de dados de identificação entre publishers e anunciantes.
PSEUDONYMOUS_ID IDs da plataforma de gerenciamento de dados: - ID de usuário do Google - ID fornecido pelo parceiro - ID fornecido pelo editor - IDFA do iOS - ID de publicidade do Android - ID do Roku - ID do Amazon Fire TV - ID do Xbox ou da Microsoft

ContactIdInfo

Informações adicionais quando CONTACT_ID é um dos uploadKeyTypes.

Representação JSON 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
Campos
matchRatePercentage

integer

Apenas saída. Taxa de correspondência para listas de usuários da segmentação por lista de clientes.
dataSourceType

enum (DataSourceType)

Opcional. Imutável. Origem dos dados de upload

DataSourceType

Indica a origem dos dados de upload.

Tipos enumerados
DATA_SOURCE_TYPE_UNSPECIFIED Não especificado.
DATA_SOURCE_TYPE_FIRST_PARTY Os dados enviados são dados próprios.
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU Os dados enviados são de uma agência de crédito terceirizada.
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE Os dados enviados são de um arquivo de eleitores de terceiros.
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA Os dados enviados são de parceiros terceirizados.

MobileIdInfo

Informações adicionais quando MOBILE_ID é um dos uploadKeyTypes.

Representação JSON 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
Campos
dataSourceType

enum (DataSourceType)

Opcional. Imutável. Origem dos dados de upload.
keySpace

enum (KeySpace)

Obrigatório. Imutável. O espaço de chaves dos IDs de dispositivos móveis.
appId

string

Obrigatório. Imutável. Uma string que identifica de forma exclusiva um aplicativo para dispositivos móveis de onde os dados foram coletados.

KeySpace

Espaço de chave para ID móvel.

Tipos enumerados
KEY_SPACE_UNSPECIFIED Não especificado.
IOS O espaço de chaves do iOS.
ANDROID O keyspace do Android.

UserIdInfo

Informações adicionais quando USER_ID é um dos uploadKeyTypes.

Representação JSON 
{
  "dataSourceType": enum (DataSourceType)
}
Campos
dataSourceType

enum (DataSourceType)

Opcional. Imutável. Origem dos dados de upload.

PairIdInfo

Informações adicionais quando PAIR_ID é um dos uploadKeyTypes.

Esse recurso está disponível apenas para parceiros de dados.

Representação JSON 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
Campos
publisherId

string (int64 format)

Obrigatório. Imutável. Identifica o publisher com que a lista de usuários da reconciliação de dados de identificação entre publishers e anunciantes é reconciliada. Esse campo é fornecido pelo provedor da sala limpa e é exclusivo apenas no escopo dela. Ele não pode ser usado como um identificador global em várias cleanrooms.
publisherName

string

Obrigatório. Nome descritivo do publisher a ser exibido na interface para uma melhor experiência de segmentação.
matchRatePercentage

integer

Obrigatório. Esse campo indica a porcentagem de correspondência de associação dessa lista de usuários com os dados próprios do publisher correspondente. Precisa estar entre 0 e 100 (inclusive).
advertiserIdentifierCount

string (int64 format)

Opcional. A contagem dos registros de dados próprios do anunciante que foram enviados para um provedor de data clean room. Isso não significa o tamanho de uma lista de usuários do PAIR.
cleanRoomIdentifier

string

Obrigatório. Imutável. Identifica uma relação exclusiva entre anunciante e editor com um ou vários provedores de data clean room.

PseudonymousIdInfo

Informações adicionais quando PSEUDONYMOUS_ID é um dos uploadKeyTypes.

Representação JSON 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
Campos
syncStatus

enum (SyncStatus)

Apenas saída. Status da sincronização da lista de usuários.
billableRecordCount

string (int64 format)

Opcional. Imutável. O número de registros faturáveis (por exemplo, enviados ou correspondentes).

SyncStatus

Status da sincronização da lista de usuários.

Tipos enumerados
SYNC_STATUS_UNSPECIFIED Não especificado.
CREATED A lista de usuários foi criada como um marcador de posição. O conteúdo e/ou os metadados da lista ainda estão sendo sincronizados. A lista de usuários não está pronta para uso.
READY_FOR_USE A lista de usuários está pronta para uso. O conteúdo e os cookies foram sincronizados corretamente.
FAILED Ocorreu um erro ao sincronizar o conteúdo e/ou os metadados da lista de usuários. Não é possível usar a lista de usuários.

PartnerAudienceInfo

Informações adicionais para públicos-alvo de parceiros.

Esse recurso está disponível apenas para parceiros de dados.

Representação JSON 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
Campos
partnerAudienceSource

enum (PartnerAudienceSource)

Obrigatório. Imutável. A origem do público-alvo do parceiro.
commercePartner

string

Opcional. O nome do parceiro comercial. Permitido apenas se partnerAudienceSource for COMMERCE_AUDIENCE.

PartnerAudienceSource

Origem de público-alvo de parceiro.

Tipos enumerados
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED Não especificado.
COMMERCE_AUDIENCE A origem de público-alvo do parceiro é um público-alvo de comércio.
LINEAR_TV_AUDIENCE A origem de público-alvo do parceiro é o público-alvo de TV linear.
AGENCY_PROVIDER_AUDIENCE A origem de público-alvo do parceiro é um público-alvo de agência/provedor.

Métodos

create

 Cria uma UserList.

delete

 Exclui uma UserList.

get

 Recebe uma UserList.

list

 Lista UserLists.

patch

 Atualiza uma UserList.