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

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

Es 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

Es 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

Es 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

Es 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
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 (LMD) 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.

Enumeraciones
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.

Enumeraciones
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.

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

Destino

El 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 el IngestEventsRequest.
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

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

string

Es 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 o un ID de público de Display & Video 360.

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 proporcionar a los usuarios 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.

Enumeraciones
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 Platform.

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

Es obligatorio. Es el identificador único de este evento.
event_timestamp

Timestamp

Es obligatorio. La hora en que ocurrió el evento.
last_updated_timestamp

Timestamp

Opcional. Fecha y hora en la que se actualizó el evento por última vez.
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.

Enumeraciones
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

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

string

Es obligatorio. Es el proveedor del grupo de Workload Identity requerido para usar la KEK.
kek_uri

string

Es obligatorio. ID del recurso de Cloud Key Management Service de Google Cloud Platform.
encrypted_dek

string

Es 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.

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

IngestAudienceMembersRequest

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

Campos
destinations[]

Destination

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

AudienceMember

Es 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 hasheado, este es el tipo de codificación de la cadena hasheada. 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

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

Campos
destinations[]

Destination

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

Event

Es obligatorio. Es la lista de eventos que se enviarán a los destinos especificados. Se pueden enviar como máximo 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 hasheado, este es el tipo de codificación de la cadena hasheada. 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 elemento 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.

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

Es 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 para el público. Se requiere al menos un ID de PAIR.

Campos
pair_ids[]

string

Es 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.

Producto

Representa un producto específico de Google. Se usa para ubicar cuentas y destinos.

Enumeraciones
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

Product

Es obligatorio. Producto al que pertenece la cuenta. Por ejemplo, GOOGLE_ADS.
account_id

string

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

RemoveAudienceMembersRequest

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

Campos
destinations[]

Destination

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

AudienceMember

Es 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.

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 para todas las cargas en las listas de usuarios de Segmentación por clientes.

TermsOfServiceStatus

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

Enumeraciones
TERMS_OF_SERVICE_STATUS_UNSPECIFIED No se especifica.
ACCEPTED Es el estado que indica que el llamador 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

Es 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 con codificación hash a través de 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.