REST Resource: accountTypes.accounts.userLists

Recurso: UserList

Es un recurso de lista de usuarios.

Representación 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

Es el identificador. Es el nombre del recurso de la lista de usuarios. Formato: accountTypes/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

Solo salida. Es el ID único de la lista de usuarios.
readOnly

boolean

Solo salida. Es una opción que indica si un usuario puede editar una lista.
membershipDuration

string (Duration format)

Opcional. Es la duración durante la que un usuario permanece en la lista de usuarios. Las duraciones válidas son múltiplos exactos de 24 horas (86,400 segundos). Si se proporciona un valor que no es un múltiplo exacto de 24 horas, se generará un error INVALID_ARGUMENT.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
accessReason

enum (AccessReason)

Solo salida. Es el motivo por el que se le otorgó acceso a esta cuenta a la lista.
sizeInfo

object (SizeInfo)

Solo salida. Es la cantidad estimada de miembros en esta lista de usuarios en diferentes redes de segmentación.
targetNetworkInfo

object (TargetNetworkInfo)

Opcional. Es la información de elegibilidad para diferentes redes objetivo.
displayName

string

Obligatorio. Es el nombre visible de la lista de usuarios.
description

string

Opcional. Es una descripción de la lista de usuarios.
membershipStatus

enum (MembershipStatus)

Opcional. Es el estado de membresía de esta lista de usuarios.
integrationCode

string

Opcional. Es un ID de un sistema externo. Los vendedores de listas de usuarios lo utilizan para correlacionar los IDs en sus sistemas.
closingReason

enum (ClosingReason)

Solo salida. Es el motivo por el que se cerró este estado de membresía de la lista de usuarios.
accountAccessStatus

enum (AccessStatus)

Opcional. Indica si este uso compartido aún está habilitado. Cuando una lista de usuarios se comparte con la cuenta, este campo se establece en ENABLED. Más adelante, el propietario de la lista de usuarios puede decidir revocar el uso compartido y establecerlo como DISABLED.
Campo de unión user_list_info. Es información adicional sobre la lista de usuarios. user_list_info puede ser solo uno de los parámetros siguientes:
ingestedUserListInfo

object (IngestedUserListInfo)

Opcional. Representa una lista de usuarios que se completa con los datos que se transfieren del usuario.

MembershipStatus

Es el estado de la lista de usuarios.

Enums
MEMBERSHIP_STATUS_UNSPECIFIED No se especifica.
OPEN Estado abierto: La lista de usuarios está acumulando miembros y se puede segmentar para ella.
CLOSED Estado cerrado: No se agregan miembros nuevos.

ClosingReason

Indica el motivo por el que se cerró la lista de usuarios. Este enum solo se usa cuando el sistema cierra automáticamente una lista.

Enums
CLOSING_REASON_UNSPECIFIED No se especifica.
UNUSED Se cerró la lista de usuarios porque no se usó en la segmentación recientemente. Consulta https://support.google.com/google-ads/answer/2472738 para obtener más detalles.

AccessReason

Es una enumeración que describe los posibles motivos de acceso.

Enums
ACCESS_REASON_UNSPECIFIED No se especifica.
OWNED El usuario es propietario del recurso.
SHARED El recurso se comparte con el usuario.
LICENSED El recurso tiene licencia para el usuario.
SUBSCRIBED El usuario se suscribió al recurso.
AFFILIATED El usuario puede acceder al recurso.

AccessStatus

Indica si este cliente aún tiene acceso a la lista.

Enums
ACCESS_STATUS_UNSPECIFIED No se especifica.
ENABLED El acceso está habilitado.
DISABLED El acceso está inhabilitado.

SizeInfo

Es la cantidad estimada de miembros en esta lista de usuarios en diferentes redes de segmentación.

Representación JSON 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string
}
Campos
displayNetworkMembersCount

string (int64 format)

Solo salida. Es la cantidad estimada de miembros en esta lista de usuarios, en la Red de Display de Google.
searchNetworkMembersCount

string (int64 format)

Solo salida. Es la cantidad estimada de miembros en esta lista de usuarios en el dominio google.com. Estos son los miembros disponibles para la segmentación en las campañas de Búsqueda.

TargetNetworkInfo

Es la información de elegibilidad para diferentes redes objetivo.

Representación JSON 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
Campos
eligibleForDisplay

boolean

Solo salida. Indica que esta lista de usuarios es apta para la Red de Display de Google.

IngestedUserListInfo

Representa una lista de usuarios que se completa con datos proporcionados por el usuario.

Representación 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)

Obligatorio. Inmutable. Son los tipos de claves de carga de esta lista de usuarios.
contactIdInfo

object (ContactIdInfo)

Opcional. Es información adicional cuando CONTACT_ID es uno de los uploadKeyTypes.
mobileIdInfo

object (MobileIdInfo)

Opcional. Es información adicional cuando MOBILE_ID es uno de los uploadKeyTypes.
userIdInfo

object (UserIdInfo)

Opcional. Es información adicional cuando USER_ID es uno de los uploadKeyTypes.
pairIdInfo

object (PairIdInfo)

Opcional. Es información adicional cuando PAIR_ID es uno de los uploadKeyTypes.

Esta función solo está disponible para los socios de datos.
pseudonymousIdInfo

object (PseudonymousIdInfo)

Opcional. La información adicional para PSEUDONYMOUS_ID es uno de los uploadKeyTypes.
partnerAudienceInfo

object (PartnerAudienceInfo)

Opcional. Es información adicional para los públicos de socios.

Esta función solo está disponible para los socios de datos.

UploadKeyType

Es una enumeración que contiene los posibles tipos de claves de carga de una lista de usuarios.

Enums
UPLOAD_KEY_TYPE_UNSPECIFIED No se especifica.
CONTACT_ID Información del cliente, como dirección de correo electrónico, número de teléfono o dirección física
MOBILE_ID Son los IDs de publicidad para dispositivos móviles.
USER_ID Son los IDs de usuario proporcionados por terceros.
PAIR_ID Son los IDs de conciliación de la identidad del publicador y el anunciante.
PSEUDONYMOUS_ID IDs de la plataforma de administración de datos: - ID de usuario de Google - ID proporcionado por el socio - ID proporcionado por el publicador - IDFA de iOS - ID de publicidad de Android - ID de Roku - ID de Amazon Fire TV - ID de Xbox o Microsoft

ContactIdInfo

Es información adicional cuando CONTACT_ID es uno de los uploadKeyTypes.

Representación JSON 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
Campos
matchRatePercentage

integer

Solo salida. Es el porcentaje de coincidencias de las listas de usuarios de segmentación por clientes.
dataSourceType

enum (DataSourceType)

Opcional. Inmutable. Fuente de los datos de carga

DataSourceType

Indica la fuente de los datos de carga.

Enums
DATA_SOURCE_TYPE_UNSPECIFIED No se especifica.
DATA_SOURCE_TYPE_FIRST_PARTY Los datos subidos son datos de origen.
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU Los datos subidos provienen de una agencia de informes crediticios externa.
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE Los datos subidos provienen de un registro de votantes externo.
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA Los datos subidos son datos de socios externos.

MobileIdInfo

Es información adicional cuando MOBILE_ID es uno de los uploadKeyTypes.

Representación JSON 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
Campos
dataSourceType

enum (DataSourceType)

Opcional. Inmutable. Es la fuente de los datos de carga.
keySpace

enum (KeySpace)

Obligatorio. Inmutable. Es el espacio de claves de los IDs de dispositivos móviles.
appId

string

Obligatorio. Inmutable. Es una cadena que identifica de forma única una aplicación para dispositivos móviles desde la que se recopilaron los datos.

KeySpace

Es el espacio de claves para el ID de dispositivo móvil.

Enums
KEY_SPACE_UNSPECIFIED No se especifica.
IOS Es el espacio de claves de iOS.
ANDROID Es el espacio de claves de Android.

UserIdInfo

Es información adicional cuando USER_ID es uno de los uploadKeyTypes.

Representación JSON 
{
  "dataSourceType": enum (DataSourceType)
}
Campos
dataSourceType

enum (DataSourceType)

Opcional. Inmutable. Es la fuente de los datos de carga.

PairIdInfo

Es información adicional cuando PAIR_ID es uno de los uploadKeyTypes.

Esta función solo está disponible para los socios de datos.

Representación JSON 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
Campos
publisherId

string (int64 format)

Obligatorio. Inmutable. Identifica al publicador con el que se concilia la lista de usuarios de la Conciliación de la identidad del anunciante y el publicador. El proveedor de la sala limpia proporciona este campo, y solo es único en el alcance de esa sala limpia. No se puede usar como identificador global en varias salas limpias.
publisherName

string

Obligatorio. Es el nombre descriptivo del publicador que se mostrará en la IU para brindar una mejor experiencia de segmentación.
matchRatePercentage

integer

Obligatorio. Este campo indica el porcentaje de coincidencia de membresía de esta lista de usuarios con los datos de origen del publicador correspondiente. Debe estar comprendido entre 0 y 100, ambos incluidos.
advertiserIdentifierCount

string (int64 format)

Opcional. Es el recuento de los registros de datos de origen del anunciante que se subieron a un proveedor de salas limpias. Esto no indica el tamaño de una lista de usuarios de PAIR.
cleanRoomIdentifier

string

Obligatorio. Inmutable. Identifica una relación única entre el publicador y el anunciante con un proveedor de sala limpia o con varios.

PseudonymousIdInfo

Es información adicional cuando PSEUDONYMOUS_ID es uno de los uploadKeyTypes.

Representación JSON 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
Campos
syncStatus

enum (SyncStatus)

Solo salida. Es el estado de sincronización de la lista de usuarios.
billableRecordCount

string (int64 format)

Opcional. Inmutable. Es la cantidad de registros facturables (p.ej., subidos o coincidentes).

SyncStatus

Es el estado de sincronización de la lista de usuarios.

Enums
SYNC_STATUS_UNSPECIFIED No se especifica.
CREATED Se creó la lista de usuarios como marcador de posición. Aún se están sincronizando el contenido y los metadatos de la lista. La lista de usuarios no está lista para usarse.
READY_FOR_USE La lista de usuarios está lista para usarse. El contenido y las cookies se sincronizaron correctamente.
FAILED Se produjo un error al sincronizar el contenido o los metadatos de la lista de usuarios. No se puede usar la lista de usuarios.

PartnerAudienceInfo

Es información adicional para los públicos de socios.

Esta función solo está disponible para los socios de datos.

Representación JSON 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
Campos
partnerAudienceSource

enum (PartnerAudienceSource)

Obligatorio. Inmutable. Es la fuente de datos del público del socio.
commercePartner

string

Opcional. Es el nombre del socio comercial. Solo se permite si partnerAudienceSource es COMMERCE_AUDIENCE.

PartnerAudienceSource

Es la fuente de datos del público del socio.

Enums
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED No se especifica.
COMMERCE_AUDIENCE La fuente de datos del público del socio es un público de comercio.
LINEAR_TV_AUDIENCE La fuente de datos del público del socio es el público de la TV lineal.
AGENCY_PROVIDER_AUDIENCE La fuente de datos del público de socios es un público de agencias o proveedores.

Métodos

create

 Crea un UserList.

delete

 Borra una UserList.

get

 Obtiene un UserList.

list

 Enumera UserLists.

patch

 Actualiza una UserList.