Package google.shopping.merchant.datasources.v1beta

Índice

DataSourcesService

Servicio para administrar fuentes de datos principales, complementarias, de inventario y otras. Obtén más información en el artículo de ayuda de Merchant Center.

CreateDataSource

rpc CreateDataSource(CreateDataSourceRequest) returns (DataSource)

Crea la nueva configuración de la fuente de datos para la cuenta determinada.

Permisos 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.
DeleteDataSource

rpc DeleteDataSource(DeleteDataSourceRequest) returns (Empty)

Borra una fuente de datos de tu cuenta de Merchant Center.

Permisos 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.
FetchDataSource

rpc FetchDataSource(FetchDataSourceRequest) returns (Empty)

Realiza la recuperación de datos de inmediato (incluso fuera de la programación de recuperación) en una fuente de datos de tu cuenta de Merchant Center. Si necesitas llamar a este método más de una vez al día, debes usar el servicio de productos para actualizar tus datos de productos. Este método solo funciona en fuentes de datos con un conjunto de entrada de archivo.

Permisos 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.
GetDataSource

rpc GetDataSource(GetDataSourceRequest) returns (DataSource)

Recupera la configuración de la fuente de datos de la cuenta determinada.

Permisos 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.
ListDataSources

rpc ListDataSources(ListDataSourcesRequest) returns (ListDataSourcesResponse)

Muestra una lista de las configuraciones de las fuentes de datos de la cuenta determinada.

Permisos 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.
UpdateDataSource

rpc UpdateDataSource(UpdateDataSourceRequest) returns (DataSource)

Actualiza la configuración de la fuente de datos existente. Se borrarán los campos que se establezcan en la máscara de actualización, pero que no se proporcionen en el recurso.

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

FileUploadsService

Servicio para administrar las cargas de archivos de fuentes de datos.

GetFileUpload

rpc GetFileUpload(GetFileUploadRequest) returns (FileUpload)

Obtiene la carga de archivo de fuente de datos más reciente. Solo se acepta el alias latest para subir un archivo.

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

CreateDataSourceRequest

Mensaje de solicitud para el método CreateDataSource.

Campos
parent

string

Obligatorio. La cuenta en la que se creará esta fuente de datos. Formato: accounts/{account}
data_source

DataSource

Obligatorio. Es la fuente de datos que se creará.

DataSource

La fuente de datos de la cuenta de Merchant Center

Campos
name

string

Identificador. Es el nombre de la fuente de datos. Formato: {datasource.name=accounts/{account}/dataSources/{datasource}}
data_source_id

int64

Solo salida. Es el ID de la fuente de datos.
display_name

string

Obligatorio. Es el nombre de la fuente de datos que se muestra en la IU de Merchant Center.
input

Input

Solo salida. Determina el tipo de entrada a la fuente de datos. Según la entrada, es posible que algunos parámetros de configuración no funcionen. Solo se pueden crear fuentes de datos genéricas a través de la API.
file_input

FileInput

Opcional. El campo solo se usa cuando los datos se administran a través de un archivo.
Campo de unión Type. El tipo de fuente de datos. Las direcciones (Type) solo pueden ser una de las siguientes opciones:
primary_product_data_source

PrimaryProductDataSource

Obligatorio. La fuente de datos principal para los productos locales y en línea.
supplemental_product_data_source

SupplementalProductDataSource

Obligatorio. La fuente de datos complementaria para productos locales y en línea.
local_inventory_data_source

LocalInventoryDataSource

Obligatorio. La fuente de datos del inventario local
regional_inventory_data_source

RegionalInventoryDataSource

Obligatorio. La fuente de datos del inventario regional
promotion_data_source

PromotionDataSource

Obligatorio. La fuente de datos de promoción
product_review_data_source

ProductReviewDataSource

Obligatorio. La fuente de datos de opiniones sobre productos
merchant_review_data_source

MerchantReviewDataSource

Obligatorio. La fuente de datos de las opiniones sobre comercios

Entrada

Determina el tipo de entrada a la fuente de datos. Según la entrada, es posible que algunos parámetros de configuración no sean compatibles.

Enumeraciones
INPUT_UNSPECIFIED No se especificó la entrada.
API Representa las fuentes de datos para las que los datos se proporcionan principalmente a través de la API.
FILE Representa las fuentes de datos para las que los datos se proporcionan principalmente a través de la entrada de archivos. Los datos aún se pueden proporcionar a través de la API.
UI

Es la fuente de datos de los productos que se agregaron directamente en Merchant Center.

Este tipo de fuente de datos no se puede crear ni actualizar a través de esta API, solo a través de la IU de Merchant Center.

Este tipo de fuente de datos es de solo lectura.
AUTOFEED Esto también se conoce como feeds automáticos, que se usan para crear automáticamente tus datos de productos. Este tipo de fuente de datos se puede habilitar o inhabilitar a través del paquete Cuentas.

DataSourceReference

La referencia de la fuente de datos se puede usar para administrar fuentes de datos relacionadas dentro del servicio de fuentes de datos.

Campos

Campo de unión data_source_id.

data_source_id puede ser una de las siguientes opciones:
self

bool

Self se debe usar para hacer referencia a la fuente de datos principal.
primary_data_source_name

string

Opcional. Es el nombre de la fuente de datos principal. Formato: accounts/{account}/dataSources/{datasource}
supplemental_data_source_name

string

Opcional. Es el nombre de la fuente de datos complementaria. Formato: accounts/{account}/dataSources/{datasource}

DeleteDataSourceRequest

Mensaje de solicitud para el método DeleteDataSource.

Campos
name

string

Obligatorio. Es el nombre de la fuente de datos que se borrará. Formato: accounts/{account}/dataSources/{datasource}

FetchDataSourceRequest

Mensaje de solicitud para el método FetchDataSource.

Campos
name

string

Obligatorio. Es el nombre del recurso de la fuente de datos que se recuperará. Formato: accounts/{account}/dataSources/{datasource}

FileInput

Los datos específicos de las fuentes de datos de archivos Este campo está vacío para otras entradas de fuentes de datos.

Campos
fetch_settings

FetchSettings

Opcional. Recupera detalles para entregar la fuente de datos. Contiene parámetros de configuración para los tipos de entrada de archivos FETCH y GOOGLE_SHEETS. Los campos obligatorios varían según la frecuencia de recuperación.
file_name

string

Opcional. Es el nombre de archivo de la fuente de datos. Obligatorio para el tipo de entrada de archivo UPLOAD.
file_input_type

FileInputType

Solo salida. Es el tipo de entrada de archivo.

FetchSettings

Recupera detalles para entregar la fuente de datos.

Campos
enabled

bool

Opcional. Habilita o pausa la programación de recuperación.
day_of_month

int32

Opcional. Es el día del mes en el que se debe recuperar el archivo de la fuente de datos (del 1 al 31). Este campo solo se puede configurar para la frecuencia mensual.
time_of_day

TimeOfDay

Opcional. Es la hora del día en la que se debe recuperar el archivo de la fuente de datos. Los minutos y segundos no son compatibles y se ignorarán.
day_of_week

DayOfWeek

Opcional. Es el día de la semana en el que se debe recuperar el archivo de la fuente de datos. Este campo solo se puede establecer para la frecuencia semanal.
time_zone

string

Opcional. Zona horaria que se usa para la programación. UTC de forma predeterminada. Por ejemplo, “America/Los_Angeles”.
frequency

Frequency

Obligatorio. Es la frecuencia que describe la programación de recuperación.
fetch_uri

string

Opcional. Es la URL desde la que se puede recuperar el archivo de la fuente de datos. Google Merchant Center admite cargas automáticas programadas con los protocolos HTTP, HTTPS o SFTP, por lo que el valor debe ser un vínculo válido con uno de esos tres protocolos. Es inmutable para los archivos de Hojas de cálculo de Google.
username

string

Opcional. Es un nombre de usuario opcional para fetch_uri. Se usa para enviar fuentes de datos a través de SFTP.
password

string

Opcional. Una contraseña opcional para fetch_uri. Se usa para enviar fuentes de datos a través de SFTP.

Frecuencia

Los campos obligatorios varían según la frecuencia de recuperación. Para un programa de recuperación mensual, se requieren [día del mes][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month] y [hora del día][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]. Para un programa de recuperación semanal, se requieren [día de la semana][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week] y [hora del día][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]. Para un programa de actualización diaria, solo se requiere un [hour of day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day].

Enumeraciones
FREQUENCY_UNSPECIFIED No se especificó la frecuencia.
FREQUENCY_DAILY La recuperación se realiza todos los días.
FREQUENCY_WEEKLY La recuperación se realiza todas las semanas.
FREQUENCY_MONTHLY La recuperación se realiza todos los meses.

FileInputType

Es el método de publicación de archivos.

Enumeraciones
FILE_INPUT_TYPE_UNSPECIFIED No se especificó el tipo de entrada de archivo.
UPLOAD El archivo se sube a través de SFTP, Google Cloud Storage o de forma manual en Merchant Center.
FETCH El archivo se recupera del fetch_uri configurado.
GOOGLE_SHEETS El archivo se recupera de Hojas de cálculo de Google especificado en fetch_uri.

FileUpload

Es la carga de archivos de una fuente de datos específica, es decir, el resultado de la recuperación de la fuente de datos en una marca de tiempo determinada que se calcula de forma asíncrona cuando finaliza el procesamiento de la fuente de datos. Solo se aplica a las fuentes de datos de archivos.

Campos
name

string

Identificador. Es el nombre de la carga del archivo de la fuente de datos. Formato: {datasource.name=accounts/{account}/dataSources/{datasource}/fileUploads/{fileupload}}
data_source_id

int64

Solo salida. Es el ID de la fuente de datos.
processing_state

ProcessingState

Solo salida. El estado de procesamiento de la fuente de datos.
issues[]

Issue

Solo salida. Es la lista de problemas que se producen en la fuente de datos.
items_total

int64

Solo salida. Es la cantidad de elementos de la fuente de datos que se procesaron.
items_created

int64

Solo salida. Es la cantidad de elementos de la fuente de datos que se crearon.
items_updated

int64

Solo salida. Es la cantidad de elementos de la fuente de datos que se actualizaron.
upload_time

Timestamp

Solo salida. Es la fecha en la que se subió el archivo de la fuente de datos.

Problema

Un error en la fuente de datos, como “precio no válido”.

Campos
title

string

Solo salida. Es el título del problema, por ejemplo, “El elemento es demasiado grande”.
description

string

Solo salida. La descripción del error, por ejemplo, "Tu fuente de datos contiene artículos que se omitirán por contener demasiados atributos o ser demasiado grandes. Se eliminarán estos elementos".
code

string

Solo salida. Es el código del error, por ejemplo, "validation/invalid_value". Muestra "?" si se desconoce el código.
count

int64

Solo salida. Es la cantidad de veces que se produjo el error en la carga del archivo.
severity

Severity

Solo salida. La gravedad del problema.
documentation_uri

string

Solo salida. Vínculo a la documentación en la que se explica el problema con más detalles, si está disponible

Gravedad

La gravedad del problema.

Enumeraciones
SEVERITY_UNSPECIFIED Gravedad sin especificar.
WARNING El problema es la advertencia.
ERROR El problema es un error.

ProcessingState

El estado de procesamiento de la fuente de datos.

Enumeraciones
PROCESSING_STATE_UNSPECIFIED No se especificó el estado de procesamiento.
FAILED No se pudo procesar la fuente de datos o todos los elementos tenían errores.
IN_PROGRESS Se está procesando la fuente de datos.
SUCCEEDED La fuente de datos se procesó correctamente, aunque es posible que algunos elementos hayan tenido errores.

GetDataSourceRequest

Mensaje de solicitud para el método GetDataSource.

Campos
name

string

Obligatorio. Es el nombre de la fuente de datos que se recuperará. Formato: accounts/{account}/dataSources/{datasource}

GetFileUploadRequest

Mensaje de solicitud para el método GetFileUploadRequest.

Campos
name

string

Obligatorio. Es el nombre de la carga de archivo de la fuente de datos que se recuperará. Formato: accounts/{account}/dataSources/{datasource}/fileUploads/latest

ListDataSourcesRequest

Mensaje de solicitud para el método ListDataSources.

Campos
parent

string

Obligatorio. La cuenta para la que se enumerarán las fuentes de datos. Formato: accounts/{account}
page_size

int32

Opcional. Es la cantidad máxima de fuentes de datos que se mostrarán. El servicio puede mostrar menos que este valor. El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000. Si no se especifica, se mostrará la cantidad máxima de fuentes de datos.
page_token

string

Opcional. Un token de página, recibido desde una llamada ListDataSources anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListDataSources deben coincidir con la llamada que proporcionó el token de la página.

ListDataSourcesResponse

Mensaje de respuesta para el método ListDataSources.

Campos
data_sources[]

DataSource

Las fuentes de datos de la cuenta especificada.
next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

LocalInventoryDataSource

La fuente de datos del inventario local.

Campos
feed_label

string

Obligatorio. Inmutable. La etiqueta del feed de las ofertas a las que se proporciona el inventario local.

Debe tener menos de 20 letras mayúsculas (A-Z), números (0-9) y guiones (-).

Consulta también la migración a etiquetas de feeds.
content_language

string

Obligatorio. Inmutable. Es el idioma ISO 639-1 de dos letras de los artículos a los que se proporciona el inventario local.

MerchantReviewDataSource

Este tipo no tiene campos.

La fuente de datos de opiniones sobre comercios.

PrimaryProductDataSource

La fuente de datos principal para los productos locales y en línea.

Campos
channel

Channel

Obligatorio. Inmutable. Especifica el tipo de canal de fuente de datos.
countries[]

string

Opcional. Los países en los que se pueden mostrar los artículos. Se representa como un código de territorio de CLDR.
default_rule

DefaultRule

Opcional. Administración de reglas predeterminadas de la fuente de datos. Si se establece, se reemplazarán las fuentes de datos vinculadas.
feed_label

string

Opcional. Inmutable. Es la etiqueta del feed que se especifica a nivel de la fuente de datos.

Debe tener menos de 20 letras mayúsculas (A-Z), números (0-9) y guiones (-).

Consulta también la migración a etiquetas de feeds.

feedLabel y contentLanguage deben estar configurados o no para las fuentes de datos con el tipo de contenido de productos. Se deben configurar para fuentes de datos con una entrada de archivo.

Si se establece, la fuente de datos solo aceptará productos que coincidan con esta combinación. Si no se establece, la fuente de datos aceptará productos sin esa restricción.
content_language

string

Opcional. Inmutable. Es el idioma ISO 639-1 de dos letras de los artículos de la fuente de datos.

feedLabel y contentLanguage deben establecerse o no establecerse. Los campos solo se pueden restablecer para las fuentes de datos sin entrada de archivos.

Si se establece, la fuente de datos solo aceptará productos que coincidan con esta combinación. Si no se establece, la fuente de datos aceptará productos sin esa restricción.

Canal

Canal de la fuente de datos.

El canal se usa para distinguir entre las fuentes de datos de diferentes verticales de productos.

Enumeraciones
CHANNEL_UNSPECIFIED No se especifica.
ONLINE_PRODUCTS Producto en línea.
LOCAL_PRODUCTS Producto local.
PRODUCTS Fuente de datos unificada para productos locales y en línea. Nota: No es posible administrar productos a través de la API para este canal.

DefaultRule

Administración de reglas predeterminadas de la fuente de datos.

Campos
take_from_data_sources[]

DataSourceReference

Obligatorio. La lista de fuentes de datos vinculadas en la regla predeterminada Esta lista se ordena según la prioridad predeterminada de la regla para unir los datos. Puede incluir una o varias referencias a self y fuentes de datos complementarias.

La lista no debe estar vacía.

Para vincular la fuente de datos a la regla predeterminada, debes agregar una referencia nueva a esta lista (en orden secuencial).

Para desvincular la fuente de datos de la regla predeterminada, debes quitar la referencia determinada de esta lista.

Si cambias el orden de esta lista, se cambiará la prioridad de las fuentes de datos en la regla predeterminada.

Por ejemplo, si proporcionas la siguiente lista: [1001, self], se tomarán los valores del atributo de la fuente de datos complementaria 1001 y se usará self como alternativa si el atributo no está configurado en 1001.

ProductReviewDataSource

Este tipo no tiene campos.

La fuente de datos de opiniones sobre productos.

PromotionDataSource

La fuente de datos de la promoción.

Campos
target_country

string

Obligatorio. Inmutable. Es el país de destino que se usa como parte del identificador único. Se representa como un código de territorio de CLDR.

Las promociones solo están disponibles en países seleccionados.
content_language

string

Obligatorio. Inmutable. Es el idioma ISO 639-1 de dos letras de los artículos de la fuente de datos.

RegionalInventoryDataSource

La fuente de datos del inventario regional

Campos
feed_label

string

Obligatorio. Inmutable. Es la etiqueta de feed de las ofertas a las que se proporciona el inventario regional.

Debe tener menos de 20 letras mayúsculas (A-Z), números (0-9) y guiones (-).

Consulta también la migración a etiquetas de feeds.
content_language

string

Obligatorio. Inmutable. Es el idioma ISO 639-1 de dos letras de los artículos a los que se proporciona el inventario regional.

SupplementalProductDataSource

La fuente de datos complementaria para los productos locales y en línea. Después de crearla, asegúrate de vincular la fuente de datos de productos complementarios a una o más fuentes de datos de productos principales.

Campos
referencing_primary_data_sources[]

DataSourceReference

Solo salida. Es la lista (no ordenada y sin duplicados) de todas las fuentes de datos principales vinculadas a esta fuente de datos en reglas predeterminadas o personalizadas. No se puede borrar la fuente de datos complementaria antes de quitar todos los vínculos.
feed_label

string

Opcional. Inmutable. Es la etiqueta del feed que se especifica a nivel de la fuente de datos.

Debe tener menos de 20 letras mayúsculas (A-Z), números (0-9) y guiones (-).

Consulta también la migración a etiquetas de feeds.

feedLabel y contentLanguage deben estar configurados o no para las fuentes de datos con el tipo de contenido de productos.

Se deben configurar para fuentes de datos con un file input. Los campos no se deben establecer para las fuentes de datos sin file input.

Si se establece, la fuente de datos solo aceptará productos que coincidan con esta combinación. Si no se establece, la fuente de datos aceptará productos sin esa restricción.
content_language

string

Opcional. Inmutable. Es el idioma ISO 639-1 de dos letras de los artículos de la fuente de datos.

feedLabel y contentLanguage deben establecerse o no establecerse. Los campos solo se pueden restablecer para las fuentes de datos sin entrada de archivos.

Si se establece, la fuente de datos solo aceptará productos que coincidan con esta combinación. Si no se establece, la fuente de datos aceptará productos sin esa restricción.

UpdateDataSourceRequest

Mensaje de solicitud para el método UpdateDataSource.

Campos
data_source

DataSource

Obligatorio. Es el recurso de la fuente de datos que se actualizará.
update_mask

FieldMask

Obligatorio. La lista de campos de la fuente de datos que se actualizarán.

Los campos especificados en la máscara de actualización sin un valor especificado en el cuerpo se borrarán de la fuente de datos.

No se admite proporcionar un valor especial "*" para el reemplazo completo de la fuente de datos.