Package google.shopping.merchant.datasources.v1beta

Índice

DataSourcesService

Serviço para gerenciar fontes de dados primárias, 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 de 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 fonte 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)

Executa a busca de dados imediatamente (mesmo fora da programação) 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 Produtos para atualizar os dados do produto. Esse método só funciona em fontes de dados com um conjunto de entrada 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.
GetDataSource

rpc GetDataSource(GetDataSourceRequest) returns (DataSource)

Recupera a configuração da fonte de dados da 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 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.
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.

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. 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 para a fonte de dados. Dependendo da entrada, algumas configurações podem não funcionar. Somente fontes genéricas podem ser criadas com a API.
file_input

FileInput

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

PrimaryProductDataSource

Obrigatório. A principal fonte de dados 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 origem de dados de inventário local.
regional_inventory_data_source

RegionalInventoryDataSource

Obrigatório. A origem de dados de inventário regional.
promotion_data_source

PromotionDataSource

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

Entrada

Determina o tipo de entrada para a fonte de dados. Dependendo da entrada, algumas configurações podem não ser compatíveis.

Enums
INPUT_UNSPECIFIED Entrada não especificada.
API Representa fontes de dados para as quais os dados são fornecidos principalmente por meio da API.
FILE Representa fontes de dados para as quais os dados são fornecidos principalmente pela 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 meio dessa API, somente pela interface do Merchant Center.

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

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

Mensagem de solicitação 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 as fontes de dados de arquivos. Este campo fica vazio para outras entradas de fonte de dados.

Campos
fetch_settings

FetchSettings

Opcional. Buscar detalhes para exibir a fonte de dados. Ela contém configurações para os 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 do arquivo.

FetchSettings

Buscar detalhes para exibir 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 de fonte de dados deve ser buscado (1 a 31). Esse campo só pode ser definido para frequência mensal.
time_of_day

TimeOfDay

Opcional. A hora do dia em que o arquivo de fonte de dados deve ser buscado. Minutos e segundos não são compatíveis e serão ignorados.
day_of_week

DayOfWeek

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

string

Opcional. Fuso horário usado para 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 é compatível com uploads automáticos programados que usam os protocolos HTTP, HTTPS ou SFTP. Portanto, o valor precisa ser um link válido que usa um desses três protocolos. Imutável para arquivos do Planilhas Google.
username

string

Opcional. Um nome de usuário opcional para [fetch url][google.shopping.content.bundles.DataSources.FileInput.fetch_url]. Usado para enviar fontes de dados por SFTP.
password

string

Opcional. Uma senha opcional para [fetch url][google.shopping.content.bundles.DataSources.FileInput.fetch_url]. Usado para enviar fontes de dados por SFTP.

Frequência

Os campos obrigatórios variam de acordo com a frequência de busca. Para uma programação de busca mensal, são necessários [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]. Para uma programação de busca semanal, são necessários [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]. Para uma programação de busca diária, apenas uma [hora do dia][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day] é necessária.

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 do arquivo.

Enums
FILE_INPUT_TYPE_UNSPECIFIED Tipo de entrada de arquivo não especificado.
UPLOAD O arquivo é enviado por SFTP, pelo Google Cloud Storage ou manualmente no Merchant Center.
FETCH O arquivo é buscado no [fetch_uri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri] configurado.
GOOGLE_SHEETS O arquivo é buscado nas Planilhas Google especificadas em [fetch_uri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri].

GetDataSourceRequest

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

Campos
name

string

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

ListDataSourcesRequest

Mensagem de solicitação 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 fontes 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, será retornado o número máximo de fontes de dados.
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 fontes 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 de dados do inventário local.

Campos
feed_label

string

Obrigatório. Imutável. O rótulo do feed das ofertas em que o inventário local é fornecido.

Precisa ter no máximo 20 letras maiúsculas (A-Z), números (0-9) e traços (-).

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

string

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

PrimaryProductDataSource

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

Campos
channel

Channel

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

string

Opcional. Os países onde os itens podem ser exibidos. Representado como um código de território CLDR (em inglês).
feed_label

string

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

Precisa ter no máximo 20 letras maiúsculas (A-Z), números (0-9) e traços (-).

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

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

Se definida, a fonte de dados aceitará apenas produtos que correspondam a essa combinação. Se ela não for definida, a fonte de dados 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 definidos. Os campos só podem ser desconfigurados para fontes de dados sem entrada de arquivos.

Se definida, a fonte de dados aceitará apenas produtos que correspondam a essa combinação. Se ela não for definida, a fonte de dados aceitará produtos sem essa restrição.

Canal

Canal da fonte de dados.

O canal é usado para distinguir entre fontes de dados de diferentes indústrias 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 por meio da API neste canal.

PromotionDataSource

Fonte 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 (em inglês).

As promoções só estão disponíveis 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 em que o inventário regional é fornecido.

Precisa ter no máximo 20 letras maiúsculas (A-Z), números (0-9) e traços (-).

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

string

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

SupplementalProductDataSource

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

Campos
feed_label

string

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

Precisa ter no máximo 20 letras maiúsculas (A-Z), números (0-9) e traços (-).

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

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

Se definida, a fonte de dados aceitará apenas produtos que correspondam a essa combinação. Se ela não for definida, a fonte de dados aceitará produts 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 definidos. Os campos só podem ser desconfigurados para fontes de dados sem entrada de arquivos.

Se definida, a fonte de dados aceitará apenas produtos que correspondam a essa combinação. Se ela não for definida, a fonte de dados aceitará produts sem essa restrição.

UpdateDataSourceRequest

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

Campos
data_source

DataSource

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

FieldMask

Obrigatório. A lista de campos da fonte de dados a ser atualizada.

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

Fornecer um "*" especial para substituição completa da fonte de dados não é compatível.