Package google.shopping.merchant.conversions.v1beta

Índice

ConversionSourcesService

Servicio para administrar fuentes de conversiones de una cuenta de comerciante.

CreateConversionSource

rpc CreateConversionSource(CreateConversionSourceRequest) returns (ConversionSource)

Crea una nueva fuente de conversiones.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
DeleteConversionSource

rpc DeleteConversionSource(DeleteConversionSourceRequest) returns (Empty)

Archiva una fuente de conversiones existente. Si la fuente de conversiones es un destino de Merchant Center, podrá recuperarse durante 30 días. Si la fuente de conversiones es una vinculación de Google Analytics, se borrará de inmediato y se podrá restablecer creando una nueva.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
GetConversionSource

rpc GetConversionSource(GetConversionSourceRequest) returns (ConversionSource)

Recupera una fuente de conversiones.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
ListConversionSources

rpc ListConversionSources(ListConversionSourcesRequest) returns (ListConversionSourcesResponse)

Recupera la lista de fuentes de conversiones a las que tiene acceso el emisor.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
UndeleteConversionSource

rpc UndeleteConversionSource(UndeleteConversionSourceRequest) returns (ConversionSource)

Vuelve a habilitar una fuente de conversiones archivada. Solo está disponible para las fuentes de conversiones de destino de Merchant Center.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
UpdateConversionSource

rpc UpdateConversionSource(UpdateConversionSourceRequest) returns (ConversionSource)

Actualiza la información de una fuente de conversiones existente. Disponible solo para las fuentes de conversiones de destino de Merchant Center.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.

AttributionSettings

Representa la configuración de atribución de las fuentes de conversiones que reciben datos de atribución previa.

Campos
attribution_lookback_window_days

int32

Obligatorio. Ventanas de visualización (en días) que se usan para la atribución en esta fuente Los valores admitidos son 7, 30 y 40.
attribution_model

AttributionModel

Obligatorio. Modelo de atribución.
conversion_type[]

ConversionType

Inmutable. Lista sin ordenar. Es una lista de los diferentes tipos de conversión con los que se puede clasificar un evento de conversión. Se creará automáticamente un tipo de "compra" estándar si la lista está vacía en el momento de la creación.

AttributionModel

Es el modelo de atribución que se usa para esta fuente. Admitimos el mismo conjunto de modelos que ofrece Google Analytics 4, como se describe en https://support.google.com/analytics/answer/10596866.

Enumeradores
ATTRIBUTION_MODEL_UNSPECIFIED Modelo no especificado.
CROSS_CHANNEL_LAST_CLICK Modelo de último clic de varios canales
ADS_PREFERRED_LAST_CLICK Modelo de último clic con preferencia de Google Ads.
CROSS_CHANNEL_DATA_DRIVEN Modelo basado en datos de varios canales.
CROSS_CHANNEL_FIRST_CLICK Modelo de primer clic de varios canales.
CROSS_CHANNEL_LINEAR Modelo lineal de varios canales.
CROSS_CHANNEL_POSITION_BASED Modelo según la posición de varios canales.
CROSS_CHANNEL_TIME_DECAY Modelo de decaimiento temporal de varios canales

ConversionType

Mensaje que representa los tipos de eventos de conversión

Campos
name

string

Solo salida. Es el nombre del evento de conversión, tal como lo informará el cliente.
report

bool

Solo salida. Es una opción que indica si se debe incluir el tipo en los informes de Merchant Center.

ConversionSource

Representa una fuente de conversiones que es propiedad de una cuenta de comerciante. Una cuenta de comerciante puede tener hasta 200 fuentes de conversiones.

Campos
name

string

Solo salida. Identificador. Lo genera Content API cuando se crea un ConversionSource nuevo. Formato: [a-z]{4}:.+ Los cuatro caracteres antes de los dos puntos representan el tipo de fuente de conversión. El contenido después de los dos puntos representa el ID de la fuente de conversiones dentro de ese tipo. El ID de dos fuentes de conversiones diferentes puede ser el mismo en diferentes tipos. Se admiten los siguientes prefijos de tipo: - galk: para fuentes de GoogleAnalyticsLink. - mcdn: Para las fuentes de MerchantCenterDestination.
state

State

Solo salida. Es el estado actual de esta fuente de conversiones. No se pueden editar mediante la API.
expire_time

Timestamp

Solo salida. El momento en que una fuente de conversiones archivada se borra de forma permanente y ya no está disponible para recuperarla.
controller

Controller

Solo salida. Es el controlador de la fuente de conversiones.
Campo de unión source_data. Obligatorio. Son datos específicos de la fuente de conversiones para cada tipo diferente de fuente. Las direcciones (source_data) solo pueden ser una de las siguientes opciones:
merchant_center_destination

MerchantCenterDestination

Fuente de conversiones del tipo “Destino de la etiqueta de Merchant Center”.

Controlador

Es la entidad que controla la fuente de conversiones.

Enumeradores
CONTROLLER_UNSPECIFIED Valor predeterminado Este valor no se usa.
MERCHANT Controlado por el comercio propietario de la fuente de conversiones
YOUTUBE_AFFILIATES Controlado por el programa de afiliados de YT

Estado

Representa el estado de la fuente de conversiones.

Enumeradores
STATE_UNSPECIFIED La fuente de conversiones tiene un estado no especificado.
ACTIVE La fuente de conversiones funciona correctamente.
ARCHIVED La fuente de conversiones se archivó en los últimos 30 días y no funciona en este momento. Se puede restablecer con el método de recuperación.
PENDING Se inició la creación de la fuente de conversiones, pero aún no se completó por completo.

CreateConversionSourceRequest

Mensaje de solicitud para el método CreateConversionSource.

Campos
parent

string

Obligatorio. La cuenta del comerciante propietaria de la nueva fuente de conversiones Formato: accounts/{account}
conversion_source

ConversionSource

Obligatorio. Es la descripción de la fuente de conversiones. Se le asignará automáticamente un nuevo ID cuando se cree.

DeleteConversionSourceRequest

Mensaje de solicitud para el método DeleteConversionSource.

Campos
name

string

Obligatorio. Es el nombre de la fuente de conversiones que se borrará. Formato: accounts/{account}/conversionSources/{conversion_source}

GetConversionSourceRequest

Mensaje de solicitud para el método GetConversionSource.

Campos
name

string

Obligatorio. El nombre de la fuente de conversiones que se recuperará. Formato: accounts/{account}/conversionsources/{conversion_source}

ListConversionSourcesRequest

Mensaje de solicitud para el método ListConversionSources.

Campos
parent

string

Obligatorio. La cuenta del comerciante propietaria de la colección de fuentes de conversiones Formato: accounts/{account}
page_size

int32

Opcional. La cantidad máxima de fuentes de conversiones que se mostrarán en una página. Si no se especifica un page_size, se usa 100 como valor predeterminado. El valor máximo es 200. Los valores superiores a 200 se convertirán en 200. Independientemente de la paginación, se muestran como máximo 200 fuentes de conversiones en total.
page_token

string

Opcional. Token de la página
show_deleted

bool

Opcional. Mostrar la opción de eliminación (archivado).

ListConversionSourcesResponse

Mensaje de respuesta para el método ListConversionSources.

Campos
conversion_sources[]

ConversionSource

Lista de fuentes de conversiones.
next_page_token

string

El token que se usará para recuperar la siguiente página de resultados.

MerchantCenterDestination

Las fuentes de "Destino de Merchant Center" se pueden usar para enviar eventos de conversión desde una tienda en línea mediante una etiqueta de Google directamente a una cuenta de Merchant Center en la que se crea la fuente.

Campos
destination

string

Solo salida. ID de destino de Merchant Center.
attribution_settings

AttributionSettings

Obligatorio. Configuración de atribución que se utiliza para el destino de Merchant Center.
display_name

string

Obligatorio. Es el nombre visible que especifica el comercio para el destino. Este es el nombre que identifica la fuente de conversiones en la IU de Merchant Center. Límite de 64 caracteres.
currency_code

string

Obligatorio. Es el código de moneda de tres letras (ISO 4217). El código de moneda define en qué moneda se informarán las conversiones que se envíen a este destino en Merchant Center.

UndeleteConversionSourceRequest

Mensaje de solicitud para el método UndeleteConversionSource.

Campos
name

string

Obligatorio. Es el nombre de la fuente de conversiones que se recuperará. Formato: accounts/{account}/conversionSources/{conversion_source}

UpdateConversionSourceRequest

Mensaje de solicitud para el método UpdateConversionSource.

Campos
conversion_source

ConversionSource

Obligatorio. La versión nueva de los datos de la fuente de conversiones. Formato: accounts/{account}/conversionSources/{conversion_source}
update_mask

FieldMask

Obligatorio. Lista de campos que se están actualizando.