Package google.shopping.merchant.datasources.v1beta

Índice

DataSourcesService

Serviço para gerenciar fontes de dados principais, complementares, de inventário e outras. Saiba mais no artigo de ajuda do Merchant Center.

CreateDataSource

rpc CreateDataSource(CreateDataSourceRequest) returns (DataSource)

Cria a nova configuração da fonte de dados para a conta especificada.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.
DeleteDataSource

rpc DeleteDataSource(DeleteDataSourceRequest) returns (Empty)

Exclui uma origem de dados da sua conta do Merchant Center.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.
FetchDataSource

rpc FetchDataSource(FetchDataSourceRequest) returns (Empty)

Faz a busca de dados imediatamente (mesmo fora da programação de busca) em uma fonte de dados da sua conta do Merchant Center. Se você precisar chamar esse método mais de uma vez por dia, use o serviço de produtos para atualizar os dados do produto. Esse método só funciona em fontes de dados com um conjunto de entrada de arquivo.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.
GetDataSource

rpc GetDataSource(GetDataSourceRequest) returns (DataSource)

Recupera a configuração da fonte de dados para a conta especificada.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListDataSources

rpc ListDataSources(ListDataSourcesRequest) returns (ListDataSourcesResponse)

Lista as configurações das fontes de dados da conta.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.
UpdateDataSource

rpc UpdateDataSource(UpdateDataSourceRequest) returns (DataSource)

Atualiza a configuração da fonte de dados atual. Os campos definidos na máscara de atualização, mas não fornecidos no recurso, serão excluídos.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

FileUploadsService

Serviço para gerenciar uploads de arquivos de origem de dados.

GetFileUpload

rpc GetFileUpload(GetFileUploadRequest) returns (FileUpload)

Recebe o upload mais recente do arquivo da fonte de dados. Apenas o alias latest é aceito para o upload de arquivos.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

CreateDataSourceRequest

Mensagem de solicitação para o método CreateDataSource.

Campos
parent

string

Obrigatório. A conta em que essa fonte de dados será criada. Formato: accounts/{account}
data_source

DataSource

Obrigatório. A fonte de dados a ser criada.

DataSource

A fonte de dados da conta do Merchant Center.

Campos
name

string

Identificador. O nome da fonte de dados. Formato: {datasource.name=accounts/{account}/dataSources/{datasource}}
data_source_id

int64

Apenas saída. O ID da fonte de dados.
display_name

string

Obrigatório. O nome da fonte de dados exibido na interface do Merchant Center.
input

Input

Apenas saída. Determina o tipo de entrada na fonte de dados. Com base na entrada, algumas configurações podem não funcionar. Somente fontes de dados genéricas podem ser criadas pela API.
file_input

FileInput

Opcional. O campo é usado apenas quando os dados são gerenciados por um arquivo.
Campo de união Type. O tipo de origem de dados. Type pode ser apenas de um dos tipos a seguir:
primary_product_data_source

PrimaryProductDataSource

Obrigatório. A fonte de dados principal para produtos locais e on-line.
supplemental_product_data_source

SupplementalProductDataSource

Obrigatório. A fonte de dados complementar para produtos locais e on-line.
local_inventory_data_source

LocalInventoryDataSource

Obrigatório. A fonte de dados do inventário local.
regional_inventory_data_source

RegionalInventoryDataSource

Obrigatório. A fonte de dados do inventário regional.
promotion_data_source

PromotionDataSource

Obrigatório. A fonte de dados da promoção.
product_review_data_source

ProductReviewDataSource

Obrigatório. A fonte de dados de avaliação do produto.
merchant_review_data_source

MerchantReviewDataSource

Obrigatório. A fonte de dados de avaliação do comerciante.

Entrada

Determina o tipo de entrada na fonte de dados. Com base na entrada, algumas configurações podem não ser compatíveis.

Enums
INPUT_UNSPECIFIED Entrada não especificada.
API Representa fontes de dados que fornecem dados principalmente pela API.
FILE Representa fontes de dados em que os dados são fornecidos principalmente por entrada de arquivo. Os dados ainda podem ser fornecidos pela API.
UI

A fonte de dados dos produtos adicionados diretamente no Merchant Center.

Esse tipo de fonte de dados não pode ser criado ou atualizado por essa API, apenas pela interface do Merchant Center.

Esse tipo de fonte de dados é somente leitura.
AUTOFEED Isso também é conhecido como feeds automáticos, usados para criar automaticamente os dados do produto. Esse tipo de origem de dados pode ser ativado ou desativado no pacote de contas.

DataSourceReference

A referência da fonte de dados pode ser usada para gerenciar fontes de dados relacionadas no serviço da fonte de dados.

Campos

Campo de união data_source_id.

data_source_id pode ser apenas de um dos tipos a seguir:
self

bool

O "self" deve ser usado para fazer referência à própria fonte de dados principal.
primary_data_source_name

string

Opcional. O nome da fonte de dados principal. Formato: accounts/{account}/dataSources/{datasource}
supplemental_data_source_name

string

Opcional. O nome da fonte de dados complementar. Formato: accounts/{account}/dataSources/{datasource}

DeleteDataSourceRequest

Mensagem de solicitação para o método DeleteDataSource.

Campos
name

string

Obrigatório. O nome da fonte de dados a ser excluída. Formato: accounts/{account}/dataSources/{datasource}

FetchDataSourceRequest

Solicita uma mensagem para o método FetchDataSource.

Campos
name

string

Obrigatório. O nome do recurso da fonte de dados a ser buscado. Formato: accounts/{account}/dataSources/{datasource}

FileInput

Os dados específicos para fontes de dados de arquivos. Este campo fica vazio para outras entradas de fonte de dados.

Campos
fetch_settings

FetchSettings

Opcional. Buscar detalhes para entregar a fonte de dados. Ele contém configurações para tipos de entrada de arquivo FETCH e GOOGLE_SHEETS. Os campos obrigatórios variam de acordo com a frequência de busca.
file_name

string

Opcional. O nome do arquivo da fonte de dados. Obrigatório para o tipo de entrada de arquivo UPLOAD.
file_input_type

FileInputType

Apenas saída. O tipo de entrada de arquivo.

FetchSettings

Buscar detalhes para entregar a fonte de dados.

Campos
enabled

bool

Opcional. Ativa ou pausa a programação de busca.
day_of_month

int32

Opcional. O dia do mês em que o arquivo da fonte de dados precisa ser buscado (1 a 31). Esse campo só pode ser definido para a frequência mensal.
time_of_day

TimeOfDay

Opcional. A hora do dia em que o arquivo da fonte de dados precisa ser buscado. Os minutos e segundos não são aceitos e serão ignorados.
day_of_week

DayOfWeek

Opcional. O dia da semana em que o arquivo de origem de dados precisa ser buscado. Esse campo só pode ser definido para a frequência semanal.
time_zone

string

Opcional. Fuso horário usado para a programação. UTC por padrão. Por exemplo, "América/Los_Angeles".
frequency

Frequency

Obrigatório. A frequência que descreve a programação de busca.
fetch_uri

string

Opcional. O URL em que o arquivo da fonte de dados pode ser buscado. O Google Merchant Center aceita uploads programados automáticos usando os protocolos HTTP, HTTPS ou SFTP. Portanto, o valor precisa ser um link válido usando um desses três protocolos. Imutável para arquivos das Planilhas Google.
username

string

Opcional. Um nome de usuário opcional para fetch_uri. Usado para enviar fontes de dados pelo SFTP.
password

string

Opcional. Uma senha opcional para fetch_uri. Usado para enviar fontes de dados pelo SFTP.

Frequência

Os campos obrigatórios variam de acordo com a frequência de busca. Para uma programação de busca mensal, [dia do mês][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month] e [hora do dia][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day] são necessários. Para uma programação de busca semanal, [dia da semana][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week] e [hora do dia][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day] são necessários. Para uma programação de busca diária, apenas um [horário do dia][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day] é necessário.

Enums
FREQUENCY_UNSPECIFIED Frequência não especificada.
FREQUENCY_DAILY A busca acontece todos os dias.
FREQUENCY_WEEKLY A busca acontece toda semana.
FREQUENCY_MONTHLY A busca acontece todo mês.

FileInputType

O método de envio de arquivos.

Enums
FILE_INPUT_TYPE_UNSPECIFIED O tipo de entrada de arquivo não foi especificado.
UPLOAD O arquivo é enviado por SFTP, Google Cloud Storage ou manualmente no Merchant Center.
FETCH O arquivo é buscado do fetch_uri configurado.
GOOGLE_SHEETS O arquivo é buscado nas Planilhas Google especificado em fetch_uri.

FileUpload

O upload de arquivo de uma fonte de dados específica, ou seja, o resultado da recuperação da fonte de dados em um determinado carimbo de data/hora computado de forma assíncrona quando o processamento da fonte de dados é concluído. Aplicável apenas a origens de dados de arquivos.

Campos
name

string

Identificador. O nome do upload do arquivo da fonte de dados. Formato: {datasource.name=accounts/{account}/dataSources/{datasource}/fileUploads/{fileupload}}
data_source_id

int64

Apenas saída. O ID da fonte de dados.
processing_state

ProcessingState

Apenas saída. O estado de processamento da fonte de dados.
issues[]

Issue

Apenas saída. Lista de problemas que ocorrem na fonte de dados.
items_total

int64

Apenas saída. O número de itens na fonte de dados que foram processados.
items_created

int64

Apenas saída. O número de itens na fonte de dados que foram criados.
items_updated

int64

Apenas saída. O número de itens na fonte de dados que foram atualizados.
upload_time

Timestamp

Apenas saída. A data em que o arquivo da fonte de dados foi enviado.

Problema

Um erro na fonte de dados, como "preço inválido".

Campos
title

string

Apenas saída. O título do problema, por exemplo, "Item muito grande".
description

string

Apenas saída. A descrição do erro, por exemplo, "Sua fonte de dados contém itens que têm muitos atributos ou são grandes demais. Esses itens serão excluídos".
code

string

Apenas saída. O código do erro, por exemplo, "validation/invalid_value". Retorna "?" se o código for desconhecido.
count

int64

Apenas saída. O número de ocorrências do erro no envio de arquivos.
severity

Severity

Apenas saída. A gravidade do problema.
documentation_uri

string

Apenas saída. Link para a documentação que explica o problema com mais detalhes, se disponível.

Gravidade

A gravidade do problema.

Enums
SEVERITY_UNSPECIFIED Gravidade não especificada.
WARNING O problema é o aviso.
ERROR O problema é um erro.

ProcessingState

O estado de processamento da fonte de dados.

Enums
PROCESSING_STATE_UNSPECIFIED Estado de processamento não especificado.
FAILED Não foi possível processar a fonte de dados ou todos os itens tinham erros.
IN_PROGRESS A fonte de dados está sendo processada.
SUCCEEDED A fonte de dados foi processada, mas alguns itens podem ter apresentado erros.

GetDataSourceRequest

Solicita uma mensagem para o método GetDataSource.

Campos
name

string

Obrigatório. O nome da fonte de dados a ser recuperada. Formato: accounts/{account}/dataSources/{datasource}

GetFileUploadRequest

Solicita uma mensagem para o método GetFileUploadRequest.

Campos
name

string

Obrigatório. O nome do upload do arquivo da fonte de dados a ser recuperado. Formato: accounts/{account}/dataSources/{datasource}/fileUploads/latest

ListDataSourcesRequest

Solicite uma mensagem para o método ListDataSources.

Campos
parent

string

Obrigatório. A conta para listar as fontes de dados. Formato: accounts/{account}
page_size

int32

Opcional. O número máximo de origens de dados a serem retornadas. O serviço pode retornar menos que esse valor. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000. Se não for especificado, o número máximo de origens de dados será retornado.
page_token

string

Opcional. Um token de página recebido de uma chamada ListDataSources anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListDataSources precisam corresponder à chamada que forneceu o token da página.

ListDataSourcesResponse

Mensagem de resposta para o método ListDataSources.

Campos
data_sources[]

DataSource

As origens de dados da conta especificada.
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

LocalInventoryDataSource

A origem dos dados do inventário local.

Campos
feed_label

string

Obrigatório. Imutável. O rótulo do feed das ofertas para as quais o inventário local é fornecido.

Precisa ter menos de 20 letras maiúsculas (A-Z), números (0-9) e traços (-).

Consulte também a migração para rótulos de feed.
content_language

string

Obrigatório. Imutável. O idioma ISO 639-1 de duas letras dos itens para os quais o inventário local é fornecido.

MerchantReviewDataSource

Esse tipo não tem campos.

A origem de dados de avaliações do comerciante.

PrimaryProductDataSource

A fonte de dados principal para produtos locais e on-line.

Campos
channel

Channel

Obrigatório. Imutável. Especifica o tipo de canal da fonte de dados.
countries[]

string

Opcional. Os países em que os itens podem ser exibidos. Representado como um código de território CLDR.
default_rule

DefaultRule

Opcional. Gerenciamento de regras padrão da origem de dados. Se definido, as fontes de dados vinculadas serão substituídas.
feed_label

string

Opcional. Imutável. O rótulo do feed especificado no nível da fonte de dados.

Precisa ter menos de 20 letras maiúsculas (A-Z), números (0-9) e traços (-).

Consulte também a migração para rótulos de feed.

feedLabel e contentLanguage precisam ser definidos ou não para fontes de dados com tipo de conteúdo de produto. Eles precisam ser definidos para fontes de dados com uma entrada de arquivo.

Se definido, a fonte de dados só vai aceitar produtos que correspondam a essa combinação. Se não for definido, a fonte de dados vai aceitar produtos sem essa restrição.
content_language

string

Opcional. Imutável. O idioma ISO 639-1 de duas letras dos itens na fonte de dados.

feedLabel e contentLanguage precisam ser definidos ou não. Os campos só podem ser redefinidos para fontes de dados sem entrada de arquivo.

Se definido, a fonte de dados só vai aceitar produtos que correspondam a essa combinação. Se não for definido, a fonte de dados vai aceitar produtos sem essa restrição.

Canal

Canal da origem de dados.

O canal é usado para distinguir as fontes de dados de diferentes verticais de produtos.

Enums
CHANNEL_UNSPECIFIED Não especificado.
ONLINE_PRODUCTS Produto on-line.
LOCAL_PRODUCTS Produto disponível na loja física.
PRODUCTS Fonte de dados unificada para produtos locais e on-line. Observação: não é possível gerenciar produtos usando a API para esse canal.

DefaultRule

Gerenciamento de regras padrão da origem de dados.

Campos
take_from_data_sources[]

DataSourceReference

Obrigatório. A lista de fontes de dados vinculadas na regra padrão. Essa lista é ordenada pela prioridade da regra padrão de mesclagem dos dados. Ele pode incluir nenhuma ou várias referências a self e fontes de dados complementares.

A lista não pode estar vazia.

Para vincular a fonte de dados à regra padrão, adicione uma nova referência a essa lista (em ordem sequencial).

Para desvincular a fonte de dados da regra padrão, remova a referência dela da lista.

Mudar a ordem dessa lista vai resultar na mudança da prioridade das fontes de dados na regra padrão.

Por exemplo, fornecer a seguinte lista: [1001, self] vai usar os valores de atributo da fonte de dados suplementar 1001 e vai usar self como fallback se o atributo não estiver definido em 1001.

ProductReviewDataSource

Esse tipo não tem campos.

A origem de dados de avaliações do produto.

PromotionDataSource

A origem de dados da promoção.

Campos
target_country

string

Obrigatório. Imutável. O país de destino usado como parte do identificador exclusivo. Representado como um código de território CLDR.

As promoções estão disponíveis apenas em alguns países.
content_language

string

Obrigatório. Imutável. O idioma ISO 639-1 de duas letras dos itens na fonte de dados.

RegionalInventoryDataSource

A origem de dados de inventário regional.

Campos
feed_label

string

Obrigatório. Imutável. O rótulo do feed das ofertas para as quais o inventário regional é fornecido.

Precisa ter menos de 20 letras maiúsculas (A-Z), números (0-9) e traços (-).

Consulte também a migração para rótulos de feed.
content_language

string

Obrigatório. Imutável. O idioma ISO 639-1 de duas letras dos itens para os quais o inventário regional é fornecido.

SupplementalProductDataSource

A fonte de dados complementar para produtos locais e on-line. Após a criação, vincule a fonte de dados de produtos complementares a uma ou mais fontes de dados de produtos principais.

Campos
referencing_primary_data_sources[]

DataSourceReference

Apenas saída. A lista (não ordenada e sem duplicações) de todas as origens de dados principais vinculadas a essa origem em regras padrão ou personalizadas. Não é possível excluir a fonte de dados suplementar antes de remover todos os links.
feed_label

string

Opcional. Imutável. O rótulo do feed especificado no nível da fonte de dados.

Precisa ter menos de 20 letras maiúsculas (A-Z), números (0-9) e traços (-).

Consulte também a migração para rótulos de feed.

feedLabel e contentLanguage precisam ser definidos ou não para fontes de dados com tipo de conteúdo de produto.

Eles precisam ser definidos para fontes de dados com um file input. Os campos precisam ser redefinidos para fontes de dados sem file input.

Se definido, a fonte de dados só vai aceitar produtos que correspondam a essa combinação. Se não for definido, a fonte de dados vai aceitar produtos sem essa restrição.
content_language

string

Opcional. Imutável. O idioma ISO 639-1 de duas letras dos itens na fonte de dados.

feedLabel e contentLanguage precisam ser definidos ou não. Os campos só podem ser redefinidos para fontes de dados sem entrada de arquivo.

Se definido, a fonte de dados só vai aceitar produtos que correspondam a essa combinação. Se não for definido, a fonte de dados vai aceitar produtos sem essa restrição.

UpdateDataSourceRequest

Solicita uma mensagem para o método UpdateDataSource.

Campos
data_source

DataSource

Obrigatório. O recurso de fonte de dados a ser atualizado.
update_mask

FieldMask

Obrigatório. A lista de campos da fonte de dados a serem atualizados.

Os campos especificados na máscara de atualização sem um valor especificado no corpo serão excluídos da fonte de dados.

Não é possível fornecer o valor especial "*" para a substituição completa da fonte de dados.