Package google.ads.datamanager.v1

Índice

IngestionService

Servicio para enviar datos de público a destinos compatibles.

IngestAudienceMembers

rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse)

Sube una lista de recursos AudienceMember al Destination proporcionado.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/datamanager
IngestEvents

rpc IngestEvents(IngestEventsRequest) returns (IngestEventsResponse)

Sube una lista de recursos Event del Destination proporcionado.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/datamanager
RemoveAudienceMembers

rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse)

Quita una lista de recursos AudienceMember del Destination proporcionado.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/datamanager
RetrieveRequestStatus

rpc RetrieveRequestStatus(RetrieveRequestStatusRequest) returns (RetrieveRequestStatusResponse)

Obtiene el estado de una solicitud según su ID.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/datamanager

AdIdentifiers

Identificadores y otra información que se utilizan para correlacionar el evento de conversión con otra actividad en línea (como los clics en anuncios).

Campos
session_attributes

string

Opcional. Son los atributos de la sesión para el modelado y la atribución de eventos.
gclid

string

Opcional. Es el ID de clic de Google (GCLID) asociado con este evento.
gbraid

string

Opcional. Es el identificador de clics para los clics asociados con los eventos de aplicaciones y que provienen de dispositivos iOS a partir de iOS 14.
wbraid

string

Opcional. Es el identificador de clics para los clics asociados con los eventos web y que provienen de dispositivos iOS a partir de iOS 14.
landing_page_device_info

DeviceInfo

Opcional. Es la información recopilada sobre el dispositivo que se usa (si corresponde) en el momento de llegar al sitio del anunciante después de interactuar con el anuncio.

AddressInfo

Es la información de la dirección del usuario.

Campos
given_name

string

Obligatorio. Nombre (primero) del usuario, todo en minúsculas, sin signos de puntuación, sin espacios en blanco iniciales o finales, y con codificación hash como SHA-256.
family_name

string

Obligatorio. Apellido del usuario, todo en minúsculas, sin signos de puntuación, sin espacios en blanco iniciales o finales, y con codificación hash como SHA-256.
region_code

string

Obligatorio. Es el código de región de 2 letras según ISO-3166-1 alpha-2 de la dirección del usuario.
postal_code

string

Obligatorio. Es el código postal de la dirección del usuario.

AudienceMember

Es el miembro del público sobre el que se realizará la operación.

Campos
destination_references[]

string

Opcional. Define a qué Destination se enviará al miembro del público.
consent

Consent

Opcional. Es el parámetro de configuración de consentimiento del usuario.
Campo de unión data. Es el tipo de datos de identificación con los que se operará. Las direcciones (data) solo pueden ser una de las siguientes opciones:
user_data

UserData

Son los datos proporcionados por el usuario que lo identifican.
pair_data

PairData

IDs de la Conciliación de Identidades de Publicador y Anunciante (PAIR)
mobile_data

MobileData

Son los datos que identifican los dispositivos móviles del usuario.

CartData

Son los datos del carrito asociados con el evento.

Campos
merchant_id

string

Opcional. Es el ID de Merchant Center asociado con los artículos.
merchant_feed_label

string

Opcional. Es la etiqueta de feed de Merchant Center asociada al feed de los artículos.
merchant_feed_language_code

string

Opcional. Es el código de idioma en ISO 639-1 asociado al feed de Merchant Center de los artículos en el que se suben tus artículos.
transaction_discount

double

Opcional. Es la suma de todos los descuentos asociados con la transacción.
items[]

Item

Opcional. Es la lista de elementos asociados con el evento.

Es la configuración del consentimiento de la Ley de Mercados Digitales (DMA) para el usuario.

Campos
ad_user_data

ConsentStatus

Opcional. Representa si el usuario da su consentimiento para el uso de datos del usuario de anuncios.
ad_personalization

ConsentStatus

Opcional. Representa si el usuario da su consentimiento para la personalización de anuncios.

ConsentStatus

Representa si el usuario otorgó, rechazó o no especificó el consentimiento.

Enums
CONSENT_STATUS_UNSPECIFIED No se especifica.
CONSENT_GRANTED Se otorgó el permiso.
CONSENT_DENIED Se rechazó.

CustomVariable

Es la variable personalizada para las conversiones de anuncios.

Campos
variable

string

Opcional. Nombre de la variable personalizada que se establecerá. Si no se encuentra la variable para el destino determinado, se ignorará.
value

string

Opcional. Es el valor que se almacenará para la variable personalizada.
destination_references[]

string

Opcional. Es la cadena de referencia que se usa para determinar a cuál de los objetos Event.destination_references se debe enviar la variable personalizada. Si está vacío, se usará Event.destination_references.

CustomerType

Es el tipo de cliente asociado al evento.

Enums
CUSTOMER_TYPE_UNSPECIFIED No se especificó CustomerType. No debe usarse nunca.
NEW El cliente es nuevo para el anunciante.
RETURNING El cliente regresa al anunciante.
REENGAGED El cliente volvió a interactuar con el anunciante.

CustomerValueBucket

Es el valor del cliente según la evaluación del anunciante.

Enums
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Es el valor no especificado de CustomerValueBucket. No debe usarse nunca.
LOW El cliente es de bajo valor.
MEDIUM El cliente tiene un valor medio.
HIGH El cliente es valioso.

Destino

Producto de Google al que envías datos. Por ejemplo, una cuenta de Google Ads.

Campos
reference

string

Opcional. Es el ID de este recurso Destination, que es único dentro de la solicitud. Se usa para hacer referencia a este Destination en IngestEventsRequest y IngestAudienceMembersRequest.
login_account

ProductAccount

Opcional. Es la cuenta que se usó para realizar esta llamada a la API. Para agregar o quitar datos de operating_account, este login_account debe tener acceso de escritura a operating_account. Por ejemplo, una cuenta de administrador de operating_account o una cuenta con un vínculo establecido a operating_account.
linked_account

ProductAccount

Opcional. Es una cuenta a la que el login_account del usuario que llama tiene acceso a través de una vinculación de cuenta establecida. Por ejemplo, el login_account de un socio de datos podría tener acceso al linked_account de un cliente. Es posible que el socio use este campo para enviar datos del linked_account a otro operating_account.
operating_account

ProductAccount

Obligatorio. Es la cuenta a la que se enviarán los datos o de la que se quitarán.
product_destination_id

string

Obligatorio. Es el objeto dentro de la cuenta de productos en el que se realizará la transferencia de datos. Por ejemplo, un ID de público de Google Ads, un ID de público de Display & Video 360 o un ID de acción de conversión de Google Ads.

DeviceInfo

Es la información sobre el dispositivo que se usaba (si corresponde) cuando ocurrió el evento.

Campos
user_agent

string

Opcional. Es la cadena de usuario-agente del dispositivo para el contexto determinado.
ip_address

string

Opcional. Es la dirección IP del dispositivo para el contexto determinado.

Nota: Google Ads no admite la correlación de direcciones IP para los usuarios finales del Espacio Económico Europeo (EEE), el Reino Unido (RU) o Suiza (CH). Agrega lógica para excluir de forma condicional el uso compartido de direcciones IP de los usuarios de estas regiones y asegúrate de proporcionarles información clara y completa sobre los datos que recopilas en tus sitios, aplicaciones y otras propiedades, y de obtener el consentimiento cuando lo exija la ley o las políticas aplicables de Google. Consulta la página Acerca de las importaciones de conversiones sin conexión para obtener más detalles.

Codificación

Es el tipo de codificación de la información de identificación hasheada.

Enums
ENCODING_UNSPECIFIED Tipo de codificación sin especificar. No debe usarse nunca.
HEX Es la codificación hexadecimal.
BASE64 Codificación en Base64.

EncryptionInfo

Es la información de encriptación de los datos que se transfieren.

Campos
Campo de unión wrapped_key. Es la clave unida que se usa para encriptar los datos. wrapped_key puede ser solo uno de los siguientes:
gcp_wrapped_key_info

GcpWrappedKeyInfo

Es la información de la clave encapsulada de Google Cloud.

ErrorCount

Es el recuento de errores para un motivo de error determinado.

Campos
record_count

int64

Es el recuento de los registros que no se pudieron subir por un motivo determinado.
reason

ProcessingErrorReason

Es el motivo del error de los registros fallidos.

ErrorInfo

Recuentos de errores para cada tipo de error.

Campos
error_counts[]

ErrorCount

Es una lista de errores y recuentos por motivo de error. Es posible que no se complete en todos los casos.

Evento

Es un evento que representa la interacción de un usuario con el sitio web o la aplicación de un anunciante.

Campos
destination_references[]

string

Opcional. Es la cadena de referencia que se usa para determinar el destino. Si está vacío, el evento se enviará a todos los destinations de la solicitud.
transaction_id

string

Opcional. Es el identificador único de este evento. Se requiere para las conversiones que utilizan varias fuentes de datos.
event_timestamp

Timestamp

Obligatorio. La hora en que ocurrió el evento.
last_updated_timestamp

Timestamp

Opcional. Es la última vez que se actualizó el evento.
user_data

UserData

Opcional. Son fragmentos de datos proporcionados por el usuario que representan al usuario con el que se asocia el evento.
consent

Consent

Opcional. Es información sobre si el usuario asociado proporcionó diferentes tipos de consentimiento.
ad_identifiers

AdIdentifiers

Opcional. Identificadores y otra información que se utilizan para correlacionar el evento de conversión con otra actividad en línea (como los clics en anuncios).
currency

string

Opcional. Es el código de moneda asociado con todos los valores monetarios de este evento.
conversion_value

double

Opcional. Es el valor de conversión asociado al evento para las conversiones basadas en el valor.
event_source

EventSource

Opcional. Es un indicador del lugar donde ocurrió el evento (Web, aplicación, en la tienda, etc.).
event_device_info

DeviceInfo

Opcional. Es la información recopilada sobre el dispositivo que se usaba (si corresponde) cuando ocurrió el evento.
cart_data

CartData

Opcional. Es la información sobre la transacción y los artículos asociados con el evento.
custom_variables[]

CustomVariable

Opcional. Es información adicional de pares clave-valor que se envía a los contenedores de conversiones (acción de conversión o actividad de FL).
experimental_fields[]

ExperimentalField

Opcional. Es una lista de pares clave-valor para los campos experimentales que, eventualmente, podrían promoverse para formar parte de la API.
user_properties

UserProperties

Opcional. Es la información sobre el usuario que evaluó el anunciante en el momento en que ocurrió el evento.

EventSource

Es la fuente del evento.

Enums
EVENT_SOURCE_UNSPECIFIED EventSource no especificado. No debe usarse nunca.
WEB El evento se generó desde un navegador web.
APP El evento se generó a partir de una app.
IN_STORE El evento se generó a partir de una transacción en la tienda.
PHONE El evento se generó a partir de una llamada telefónica.
OTHER El evento se generó a partir de otras fuentes.

ExperimentalField

Es un campo experimental que representa campos no oficiales.

Campos
field

string

Opcional. Es el nombre del campo que se usará.
value

string

Opcional. Es el valor que se establecerá en el campo.

GcpWrappedKeyInfo

Es información sobre la clave encapsulada de Google Cloud Platform.

Campos
key_type

KeyType

Obligatorio. Es el tipo de algoritmo que se usa para encriptar los datos.
wip_provider

string

Obligatorio. Es el proveedor del grupo de Workload Identity que se requiere para usar la KEK.
kek_uri

string

Obligatorio. ID del recurso de Cloud Key Management Service de Google Cloud Platform. Debe tener el formato "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}".
encrypted_dek

string

Obligatorio. Es la clave de encriptación de datos encriptada y codificada en base64.

KeyType

Es el tipo de algoritmo que se usa para encriptar los datos.

Enums
KEY_TYPE_UNSPECIFIED Es un tipo de clave sin especificar. No debe usarse nunca.
XCHACHA20_POLY1305 Algoritmo XChaCha20-Poly1305

IngestAudienceMembersRequest

Solicita subir miembros del público a los destinos proporcionados. Devuelve un IngestAudienceMembersResponse.

Puedes probar este método en el Explorador de APIs de REST:
Pruébalo con REST
Campos
destinations[]

Destination

Obligatorio. Es la lista de destinos a los que se enviarán los miembros del público.
audience_members[]

AudienceMember

Obligatorio. Es la lista de usuarios a los que se enviará el mensaje a los destinos especificados. Se pueden enviar como máximo 10,000 recursos AudienceMember en una sola solicitud.
consent

Consent

Opcional. Es el consentimiento a nivel de la solicitud que se aplica a todos los usuarios incluidos en la solicitud. El consentimiento a nivel del usuario anula el consentimiento a nivel de la solicitud y se puede especificar en cada AudienceMember.
validate_only

bool

Opcional. Solo con fines de prueba. Si es true, la solicitud se valida, pero no se ejecuta. Solo se devuelven errores, no resultados.
encoding

Encoding

Opcional. Se requiere para las cargas de UserData. Es el tipo de codificación de los identificadores de usuario. En el caso de los identificadores de usuario hash, este es el tipo de codificación de la cadena hash. En el caso de los identificadores de usuario con hash encriptados, este es el tipo de codificación de la cadena encriptada externa, pero no necesariamente de la cadena con hash interna, lo que significa que la cadena con hash interna podría estar codificada de una manera diferente a la cadena encriptada externa. En el caso de las cargas que no son de UserData, este campo se ignora.
encryption_info

EncryptionInfo

Opcional. Es la información de encriptación para las cargas de UserData. Si no se configura, se supone que la información de identificación subida tiene codificación hash, pero no está encriptada. En el caso de las cargas que no son de UserData, este campo se ignora.
terms_of_service

TermsOfService

Opcional. Son las condiciones del servicio que el usuario aceptó o rechazó.

IngestAudienceMembersResponse

Respuesta de IngestAudienceMembersRequest.

Campos
request_id

string

Es el ID generado automáticamente de la solicitud.

IngestEventsRequest

Solicita subir miembros del público a los destinos proporcionados. Devuelve un IngestEventsResponse.

Puedes probar este método en el Explorador de APIs de REST:
Pruébalo con REST
Campos
destinations[]

Destination

Obligatorio. Es la lista de destinos a los que se enviarán los eventos.
events[]

Event

Obligatorio. Es la lista de eventos que se enviarán a los destinos especificados. Se pueden enviar hasta 2,000 recursos Event en una sola solicitud.
consent

Consent

Opcional. Es el consentimiento a nivel de la solicitud que se aplica a todos los usuarios incluidos en la solicitud. El consentimiento a nivel del usuario anula el consentimiento a nivel de la solicitud y se puede especificar en cada Event.
validate_only

bool

Opcional. Solo con fines de prueba. Si es true, la solicitud se valida, pero no se ejecuta. Solo se devuelven errores, no resultados.
encoding

Encoding

Opcional. Se requiere para las cargas de UserData. Es el tipo de codificación de los identificadores de usuario. En el caso de los identificadores de usuario hash, este es el tipo de codificación de la cadena hash. En el caso de los identificadores de usuario con hash encriptados, este es el tipo de codificación de la cadena encriptada externa, pero no necesariamente de la cadena con hash interna, lo que significa que la cadena con hash interna podría estar codificada de una manera diferente a la cadena encriptada externa. En el caso de las cargas que no son de UserData, este campo se ignora.
encryption_info

EncryptionInfo

Opcional. Es la información de encriptación para las cargas de UserData. Si no se configura, se supone que la información de identificación subida tiene codificación hash, pero no está encriptada. En el caso de las cargas que no son de UserData, este campo se ignora.

IngestEventsResponse

Respuesta de IngestEventsRequest.

Campos
request_id

string

Es el ID generado automáticamente de la solicitud.

Elemento

Representa un artículo del carrito asociado al evento.

Campos
merchant_product_id

string

Opcional. Es el ID del producto en la cuenta de Merchant Center.
quantity

int64

Opcional. Es la cantidad de este elemento asociado con el evento.
unit_price

double

Opcional. Es el precio por unidad sin impuestos, envío ni descuentos a nivel de la transacción.

MatchRateRange

Es el rango del porcentaje de coincidencias de la carga o la lista de usuarios.

Enums
MATCH_RATE_RANGE_UNKNOWN Se desconoce el rango de la tasa de coincidencias.
MATCH_RATE_RANGE_NOT_ELIGIBLE El rango de porcentaje de coincidencias no es apto.
MATCH_RATE_RANGE_LESS_THAN_20 El rango del porcentaje de coincidencias es inferior al 20% (en el intervalo [0, 20)).
MATCH_RATE_RANGE_20_TO_30 El rango del porcentaje de coincidencias se encuentra entre el 20% y el 30% (en el intervalo [20, 31)).
MATCH_RATE_RANGE_31_TO_40 El rango del porcentaje de coincidencias se encuentra entre el 31% y el 40% (en el intervalo [31, 41)).
MATCH_RATE_RANGE_41_TO_50 El rango del porcentaje de coincidencias se encuentra entre el 41% y el 50% (en el intervalo [41, 51)).
MATCH_RATE_RANGE_51_TO_60 El rango del porcentaje de coincidencias está entre el 51% y el 60% (en el intervalo [51, 61)).
MATCH_RATE_RANGE_61_TO_70 El rango del porcentaje de coincidencias se encuentra entre el 61% y el 70% (en el intervalo [61, 71)).
MATCH_RATE_RANGE_71_TO_80 El rango de porcentaje de coincidencias se encuentra entre el 71% y el 80% (en el intervalo [71, 81)).
MATCH_RATE_RANGE_81_TO_90 El rango del porcentaje de coincidencias se encuentra entre el 81% y el 90% (en el intervalo [81, 91)).
MATCH_RATE_RANGE_91_TO_100

El rango de porcentaje de coincidencias se encuentra entre el 91% y el 100% (en el intervalo [91, 100]).

MobileData

Son los IDs de dispositivos móviles del público. Se requiere al menos un ID de dispositivo móvil.

Campos
mobile_ids[]

string

Obligatorio. Es la lista de IDs de dispositivos móviles (ID de publicidad o IDFA). Se pueden proporcionar hasta 10 mobileIds en un solo AudienceMember.

PairData

Son los IDs de PAIR del público. Se requiere al menos un ID de par.

Campos
pair_ids[]

string

Obligatorio. Son los datos de PII proporcionados por la sala limpia, codificados con hash con SHA256 y encriptados con un cifrado conmutativo de EC que usa la clave del publicador para la lista de usuarios de PAIR. Se pueden proporcionar hasta 10 pairIds en un solo AudienceMember.

ProcessingErrorReason

Es el motivo del error de procesamiento.

Enums
PROCESSING_ERROR_REASON_UNSPECIFIED Se desconoce el motivo del error de procesamiento.
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE La variable personalizada no es válida.
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED El estado de la variable personalizada no está habilitado.
PROCESSING_ERROR_REASON_EVENT_TOO_OLD La conversión es anterior a la antigüedad máxima admitida.
PROCESSING_ERROR_REASON_DUPLICATE_GCLID Ya existe en el sistema una conversión con el mismo GCLID y horario de conversión.
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID Ya se subió una conversión con la misma combinación de ID de pedido y acción de conversión.
PROCESSING_ERROR_REASON_INVALID_GBRAID No se pudo decodificar el gbraid.
PROCESSING_ERROR_REASON_INVALID_GCLID No se pudo decodificar el ID de clic de Google.
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID El ID de comercio contiene caracteres que no son dígitos.
PROCESSING_ERROR_REASON_INVALID_WBRAID No se pudo decodificar el wbraid.
PROCESSING_ERROR_REASON_INTERNAL_ERROR Error interno.
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED No se firmaron las condiciones de las conversiones avanzadas en la cuenta de destino.
PROCESSING_ERROR_REASON_INVALID_EVENT El evento no es válido.
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS Las transacciones coincidentes son inferiores al umbral mínimo.
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS Las transacciones son inferiores al umbral mínimo.
PROCESSING_ERROR_REASON_INVALID_FORMAT El evento tiene un error de formato.
PROCESSING_ERROR_REASON_DECRYPTION_ERROR El evento tiene un error de desencriptación.
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR No se pudo desencriptar la DEK.
PROCESSING_ERROR_REASON_INVALID_WIP El WIP tiene un formato incorrecto o no existe.
PROCESSING_ERROR_REASON_INVALID_KEK La KEK no puede desencriptar los datos porque es incorrecta o no existe.
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED No se pudo usar el WIP porque se rechazó por su condición de certificación.
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED El sistema no tenía los permisos necesarios para acceder a la KEK.
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR No se pudieron desencriptar los datos de UserIdentifier con la DEK.
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER El usuario intentó transferir eventos con un identificador de publicidad que no proviene de los anuncios de la cuenta operativa.

ProcessingWarningReason

Es el motivo de la advertencia de procesamiento.

Enums
PROCESSING_WARNING_REASON_UNSPECIFIED Se desconoce el motivo de la advertencia de procesamiento.
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED El sistema no tenía los permisos necesarios para acceder a la KEK.
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR No se pudo desencriptar la DEK.
PROCESSING_WARNING_REASON_DECRYPTION_ERROR El evento tiene un error de desencriptación.
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED No se pudo usar el WIP porque se rechazó por su condición de certificación.
PROCESSING_WARNING_REASON_INVALID_WIP El WIP tiene un formato incorrecto o no existe.
PROCESSING_WARNING_REASON_INVALID_KEK La KEK no puede desencriptar los datos porque es incorrecta o no existe.
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR No se pudieron desencriptar los datos de UserIdentifier con la DEK.
PROCESSING_WARNING_REASON_INTERNAL_ERROR Error interno.

Producto

Obsoleta. Usa AccountType en su lugar. Representa un producto específico de Google.

Enums
PRODUCT_UNSPECIFIED Producto no especificado. No debe usarse nunca.
GOOGLE_ADS Google Ads.
DISPLAY_VIDEO_PARTNER Socio de Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Ser anunciante de Display & Video 360
DATA_PARTNER Socio de datos.

ProductAccount

Representa una cuenta específica.

Campos
product
(deprecated)

Product

Obsoleta. Usa account_type en su lugar.
account_id

string

Obligatorio. Es el ID de la cuenta. Por ejemplo, el ID de tu cuenta de Google Ads.
account_type

AccountType

Opcional. Es el tipo de cuenta. Por ejemplo, GOOGLE_ADS. Se requiere account_type o el parámetro product que dejó de estar disponible. Si se configuran ambos, los valores deben coincidir.

AccountType

Representa los tipos de cuentas de Google. Se usa para ubicar cuentas y destinos.

Enums
ACCOUNT_TYPE_UNSPECIFIED Producto no especificado. No debe usarse nunca.
GOOGLE_ADS Google Ads.
DISPLAY_VIDEO_PARTNER Socio de Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Ser anunciante de Display & Video 360
DATA_PARTNER Socio de datos.

RemoveAudienceMembersRequest

Solicita quitar usuarios de un público en los destinos proporcionados. Muestra un objeto RemoveAudienceMembersResponse.

Puedes probar este método en el Explorador de APIs de REST:
Pruébalo con REST
Campos
destinations[]

Destination

Obligatorio. Es la lista de destinos de los que se quitarán los usuarios.
audience_members[]

AudienceMember

Obligatorio. Es la lista de usuarios que se quitarán.
validate_only

bool

Opcional. Solo con fines de prueba. Si es true, la solicitud se valida, pero no se ejecuta. Solo se devuelven errores, no resultados.
encoding

Encoding

Opcional. Se requiere para las cargas de UserData. Es el tipo de codificación de los identificadores de usuario. Se aplica solo a la codificación externa de los identificadores de usuario encriptados. En el caso de las cargas que no son de UserData, este campo se ignora.
encryption_info

EncryptionInfo

Opcional. Es la información de encriptación para las cargas de UserData. Si no se configura, se supone que la información de identificación subida tiene codificación hash, pero no está encriptada. En el caso de las cargas que no son de UserData, este campo se ignora.

RemoveAudienceMembersResponse

Respuesta de RemoveAudienceMembersRequest.

Campos
request_id

string

Es el ID generado automáticamente de la solicitud.

RequestStatusPerDestination

Es el estado de la solicitud por destino.

Campos
destination

Destination

Es un destino dentro de una solicitud a la API de DM.
request_status

RequestStatus

Es el estado de la solicitud del destino.
error_info

ErrorInfo

Es un error de información de error que contiene el motivo del error y los recuentos de errores relacionados con la carga.
warning_info

WarningInfo

Es información de advertencia que contiene el motivo y la cantidad de advertencias relacionadas con la carga.
Campo de unión status. Es el estado del destino. Las direcciones (status) solo pueden ser una de las siguientes opciones:
audience_members_ingestion_status

IngestAudienceMembersStatus

Es el estado de la solicitud de miembros del público de la transferencia.
events_ingestion_status

IngestEventsStatus

Es el estado de la solicitud de eventos de transferencia.
audience_members_removal_status

RemoveAudienceMembersStatus

Es el estado de la solicitud para quitar miembros del público.

IngestAudienceMembersStatus

Es el estado de la solicitud de miembros del público de la transferencia.

Campos
Campo de unión status. Es el estado de la transferencia de los miembros del público al destino. Las direcciones (status) solo pueden ser una de las siguientes opciones:
user_data_ingestion_status

IngestUserDataStatus

Es el estado de la transferencia de datos del usuario al destino.
mobile_data_ingestion_status

IngestMobileDataStatus

Es el estado de la transferencia de datos móviles al destino.
pair_data_ingestion_status

IngestPairDataStatus

Es el estado de la transferencia de datos de pares al destino.

IngestEventsStatus

Es el estado de la transferencia de volúmenes altos de eventos al destino.

Campos
record_count

int64

Es el recuento total de eventos enviados en la solicitud de carga. Incluye todos los eventos de la solicitud, independientemente de si se procesaron correctamente o no.

IngestMobileDataStatus

Es el estado de la transferencia de datos móviles al destino que contiene estadísticas relacionadas con la transferencia.

Campos
record_count

int64

Es el recuento total de los miembros del público que se enviaron en la solicitud de carga para el destino. Incluye a todos los miembros del público en la solicitud, independientemente de si se incorporaron correctamente o no.
mobile_id_count

int64

Es el recuento total de IDs de dispositivos móviles enviados en la solicitud de carga para el destino. Incluye todos los IDs de dispositivos móviles de la solicitud, independientemente de si se incorporaron correctamente o no.

IngestPairDataStatus

Es el estado de la transferencia de datos de pares al destino que contiene estadísticas relacionadas con la transferencia.

Campos
record_count

int64

Es el recuento total de los miembros del público que se enviaron en la solicitud de carga para el destino. Incluye a todos los miembros del público en la solicitud, independientemente de si se incorporaron correctamente o no.
pair_id_count

int64

Es el recuento total de los IDs de pares enviados en la solicitud de carga para el destino. Incluye todos los IDs de pares en la solicitud, independientemente de si se procesaron correctamente o no.

IngestUserDataStatus

Es el estado de la transferencia de datos del usuario al destino que contiene estadísticas relacionadas con la transferencia.

Campos
record_count

int64

Es el recuento total de los miembros del público que se enviaron en la solicitud de carga para el destino. Incluye a todos los miembros del público en la solicitud, independientemente de si se incorporaron correctamente o no.
user_identifier_count

int64

Es el recuento total de identificadores de usuario enviados en la solicitud de carga para el destino. Incluye todos los identificadores de usuario en la solicitud, independientemente de si se incorporaron correctamente o no.
upload_match_rate_range

MatchRateRange

Es el rango del porcentaje de coincidencias de la carga.

RemoveAudienceMembersStatus

Es el estado de la solicitud para quitar miembros del público.

Campos
Campo de unión status. Es el estado de la eliminación de los miembros del público del destino. Las direcciones (status) solo pueden ser una de las siguientes opciones:
user_data_removal_status

RemoveUserDataStatus

Es el estado de la eliminación de los datos del usuario del destino.
mobile_data_removal_status

RemoveMobileDataStatus

Es el estado de la eliminación de los datos móviles del destino.
pair_data_removal_status

RemovePairDataStatus

Es el estado de la eliminación de los datos de pares del destino.

RemoveMobileDataStatus

Es el estado de la eliminación de los datos móviles del destino.

Campos
record_count

int64

Es el recuento total de los miembros del público incluidos en la solicitud de eliminación. Incluye a todos los miembros del público en la solicitud, independientemente de si se quitaron correctamente o no.
mobile_id_count

int64

Es el recuento total de IDs de dispositivos móviles enviados en la solicitud de eliminación. Incluye todos los IDs de dispositivos móviles de la solicitud, independientemente de si se quitaron correctamente o no.

RemovePairDataStatus

Es el estado de la eliminación de los datos de pares del destino.

Campos
record_count

int64

Es el recuento total de los miembros del público incluidos en la solicitud de eliminación. Incluye a todos los miembros del público en la solicitud, independientemente de si se quitaron correctamente o no.
pair_id_count

int64

Es el recuento total de los IDs de pares enviados en la solicitud de eliminación. Incluye todos los IDs de pares en la solicitud, independientemente de si se quitaron correctamente o no.

RemoveUserDataStatus

Es el estado de la eliminación de los datos del usuario del destino.

Campos
record_count

int64

Es el recuento total de los miembros del público incluidos en la solicitud de eliminación. Incluye a todos los miembros del público en la solicitud, independientemente de si se quitaron correctamente o no.
user_identifier_count

int64

Es el recuento total de identificadores de usuario enviados en la solicitud de eliminación. Incluye todos los identificadores de usuario en la solicitud, independientemente de si se quitaron correctamente o no.

RequestStatus

Es el estado de la solicitud.

Enums
REQUEST_STATUS_UNKNOWN Se desconoce el estado de la solicitud.
SUCCESS La solicitud se realizó correctamente.
PROCESSING Se está procesando la solicitud.
FAILED Se produjo un error en la solicitud.
PARTIAL_SUCCESS La solicitud se realizó parcialmente.

RetrieveRequestStatusRequest

Es una solicitud para obtener el estado de la solicitud realizada a la API de DM para un ID de solicitud determinado. Muestra un objeto RetrieveRequestStatusResponse.

Puedes probar este método en el Explorador de APIs de REST:
Pruébalo con REST
Campos
request_id

string

Obligatorio. Obligatorio. Es el ID de la solicitud a la API de Data Manager.

RetrieveRequestStatusResponse

Respuesta de RetrieveRequestStatusRequest.

Campos
request_status_per_destination[]

RequestStatusPerDestination

Es una lista de los estados de las solicitudes por destino. El orden de los estados coincide con el orden de los destinos en la solicitud original.

TermsOfService

Son las condiciones del servicio que el usuario aceptó o rechazó.

Campos
customer_match_terms_of_service_status

TermsOfServiceStatus

Opcional. Condiciones del servicio de Segmentación por clientes: https://support.google.com/adspolicy/answer/6299717 Se debe aceptar cuando se ingieren UserData o MobileData. Este campo no es obligatorio para la lista de usuarios de la Segmentación por socios.

TermsOfServiceStatus

Representa la decisión del llamador de aceptar o rechazar las condiciones del servicio.

Enums
TERMS_OF_SERVICE_STATUS_UNSPECIFIED No se especifica.
ACCEPTED Es el estado que indica que el llamante eligió aceptar las condiciones del servicio.
REJECTED Es el estado que indica que el llamador eligió rechazar las condiciones del servicio.

UserData

Son los datos que identifican al usuario. Se requiere al menos un identificador.

Campos
user_identifiers[]

UserIdentifier

Obligatorio. Son los identificadores del usuario. Es posible proporcionar varias instancias del mismo tipo de datos (por ejemplo, varias direcciones de correo electrónico). Para aumentar las probabilidades de obtener una coincidencia, proporciona la mayor cantidad posible de identificadores. Se pueden proporcionar hasta 10 userIdentifiers en un solo AudienceMember o Event.

UserIdentifier

Es un identificador único para el usuario.

Campos
Campo de unión identifier. Se debe especificar exactamente uno. Las direcciones (identifier) solo pueden ser una de las siguientes opciones:
email_address

string

Dirección de correo electrónico con codificación hash que utiliza la función hash SHA-256 después de la normalización.
phone_number

string

Número de teléfono codificado con la función hash SHA-256 después de la normalización (estándar E164).
address

AddressInfo

Son los componentes conocidos de la dirección de un usuario. Contiene una agrupación de identificadores que se correlacionan de una sola vez.

UserProperties

Es la información sobre el usuario que evaluó el anunciante en el momento en que ocurrió el evento. Consulta https://support.google.com/google-ads/answer/14007601 para obtener más detalles.

Campos
customer_type

CustomerType

Opcional. Es el tipo de cliente asociado al evento.
customer_value_bucket

CustomerValueBucket

Opcional. Es el valor del cliente según la evaluación del anunciante.

WarningCount

Es el recuento de advertencias para un motivo de advertencia determinado.

Campos
record_count

int64

Es el recuento de registros que tienen una advertencia.
reason

ProcessingWarningReason

Es el motivo de la advertencia.

WarningInfo

Son los recuentos de advertencias para cada tipo de advertencia.

Campos
warning_counts[]

WarningCount

Es una lista de advertencias y recuentos por motivo de advertencia.