Package google.shopping.merchant.datasources.v1beta

Índice

DataSourcesService

Servicio para administrar fuentes de datos principales, complementarias, de inventario y de otro tipo. 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 fuente de datos para la cuenta determinada.

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

rpc DeleteDataSource(DeleteDataSourceRequest) returns (Empty)

Borra una fuente de datos de tu cuenta 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.
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, usa el servicio de Productos para actualizar tus datos de productos. Este método solo funciona en fuentes de datos con un conjunto de entradas de archivo.

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

rpc GetDataSource(GetDataSourceRequest) returns (DataSource)

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

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

rpc ListDataSources(ListDataSourcesRequest) returns (ListDataSourcesResponse)

Enumera las configuraciones de las fuentes de datos de la cuenta determinada.

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

rpc UpdateDataSource(UpdateDataSourceRequest) returns (DataSource)

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

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.

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. La fuente de datos que se creará.

DataSource

Es 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 para 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. Es el tipo de fuente de datos. Las direcciones (Type) solo pueden ser una de las siguientes opciones:
primary_product_data_source

PrimaryProductDataSource

Obligatorio. Es la fuente de datos principal para productos locales y en línea.
supplemental_product_data_source

SupplementalProductDataSource

Obligatorio. Es la fuente de datos complementaria para los productos locales y en línea.
local_inventory_data_source

LocalInventoryDataSource

Obligatorio. Es la fuente de datos del inventario local.
regional_inventory_data_source

RegionalInventoryDataSource

Obligatorio. Es la fuente de datos del inventario regional.
promotion_data_source

PromotionDataSource

Obligatorio. Es la fuente de datos de la promoción.

Entrada

Determina el tipo de entrada para la fuente de datos. Según la entrada, es posible que no se admitan algunos parámetros de configuración.

Enumeraciones
INPUT_UNSPECIFIED Entrada sin especificar.
API Representa fuentes de datos para las que los datos se proporcionan principalmente a través de la API.
FILE Representa fuentes de datos para las que los datos se proporcionan principalmente a través de entradas de archivos. De todos modos, se pueden proporcionar datos a través de la API.
UI

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

Con esta API, no se puede crear ni actualizar este tipo de fuente de datos. Solo se puede usar la IU de Merchant Center en esta API.

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

DeleteDataSourceRequest

Mensaje de solicitud para el método DeleteDataSource.

Campos
name

string

Obligatorio. 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. El nombre del recurso de 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 fuente de datos.

Campos
fetch_settings

FetchSettings

Opcional. Recupera detalles para entregar la fuente de datos. Contiene la configuración para los tipos de entrada de archivo 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 del 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 detiene la programación de actualización de información.
day_of_month

int32

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

TimeOfDay

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

DayOfWeek

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

string

Opcional. Se usa la zona horaria para el programa. UTC de forma predeterminada. Por ejemplo, “America/Los_Angeles”.
frequency

Frequency

Obligatorio. La frecuencia con la que se describe el programa de recuperación.
fetch_uri

string

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

string

Opcional. Un nombre de usuario opcional para [fetch url][google.shopping.content.bundles.DataSources.FileInput.fetch_url]. Se usa para enviar fuentes de datos a través del SFTP.
password

string

Opcional. Una contraseña opcional para [fetch url][google.shopping.content.bundles.DataSources.FileInput.fetch_url]. Se usa para enviar fuentes de datos a través del SFTP.

Frecuencia

Los campos obligatorios varían según la frecuencia de recuperación. Para una programación de actualizació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 una programación de actualizació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 una programación de recuperación diaria, solo se requiere una [hora del día][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day].

Enumeraciones
FREQUENCY_UNSPECIFIED Frecuencia sin especificar.
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 entrega de archivos.

Enumeraciones
FILE_INPUT_TYPE_UNSPECIFIED Tipo de entrada del archivo sin especificar.
UPLOAD El archivo se sube a través de SFTP, Google Cloud Storage o de forma manual a Merchant Center.
FETCH El archivo se recupera del [fetch_uri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri] configurado.
GOOGLE_SHEETS El archivo se recupera de las Hojas de cálculo de Google que se especifican en el [fetch_uri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri].

GetDataSourceRequest

Mensaje de solicitud para el método GetDataSource.

Campos
name

string

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

ListDataSourcesRequest

Mensaje de solicitud para el método ListDataSources.

Campos
parent

string

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

int32

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

Son 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. Es la etiqueta de feed de las ofertas a las que se proporciona el inventario local.

Debe tener como máximo 20 letras mayúsculas (A-Z), números (0-9) y guiones (-).

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

string

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

PrimaryProductDataSource

Es la fuente principal de datos para productos locales y en línea.

Campos
channel

Channel

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

string

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

string

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

Debe tener como máximo 20 letras mayúsculas (A-Z), números (0-9) y guiones (-).

Consulta también la migración a las etiquetas de feed.

Se deben establecer o no configurar feedLabel y contentLanguage 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 la estableces, la fuente de datos aceptará productos sin esa restricción.
content_language

string

Opcional. Inmutable. Es el lenguaje ISO 639-1 de dos letras de los elementos de la fuente de datos.

Se deben establecer o no configurar feedLabel y contentLanguage. Los campos solo se pueden desactivar para fuentes de datos sin entrada de archivo.

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

Canal

Canal de fuente de datos.

El canal se utiliza para distinguir entre fuentes de datos para 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 se puede administrar productos mediante la API para este canal.

PromotionDataSource

Es la fuente de datos de promociones.

Campos
target_country

string

Obligatorio. Inmutable. Indica el país de segmentación que se utiliza como parte del identificador único. Se representa como un código de territorio de CLDR.

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

string

Obligatorio. Inmutable. Es el lenguaje ISO 639-1 de dos letras de los elementos de la fuente de datos.

RegionalInventoryDataSource

Es 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 como máximo 20 letras mayúsculas (A-Z), números (0-9) y guiones (-).

Consulta también la migración a las etiquetas de feed.
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 productos locales y en línea.

Campos
feed_label

string

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

Debe tener como máximo 20 letras mayúsculas (A-Z), números (0-9) y guiones (-).

Consulta también la migración a las etiquetas de feed.

Se deben establecer o no configurar feedLabel y contentLanguage 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 lenguaje ISO 639-1 de dos letras de los elementos de la fuente de datos.

Se deben establecer o no configurar feedLabel y contentLanguage. Los campos solo se pueden desactivar para fuentes de datos sin 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.

UpdateDataSourceRequest

Mensaje de solicitud para el método UpdateDataSource.

Campos
data_source

DataSource

Obligatorio. El recurso de fuente de datos que se actualizará.
update_mask

FieldMask

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

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.

Proporcionar un “*” especial para el reemplazo completo de la fuente de datos.