REST Resource: accounts.dataSources

Recurso: DataSource

A fonte de dados da conta do Merchant Center.

Representação JSON 
{
  "name": string,
  "dataSourceId": string,
  "displayName": string,
  "input": enum (Input),
  "fileInput": {
    object (FileInput)
  },

  // Union field Type can be only one of the following:
  "primaryProductDataSource": {
    object (PrimaryProductDataSource)
  },
  "supplementalProductDataSource": {
    object (SupplementalProductDataSource)
  },
  "localInventoryDataSource": {
    object (LocalInventoryDataSource)
  },
  "regionalInventoryDataSource": {
    object (RegionalInventoryDataSource)
  },
  "promotionDataSource": {
    object (PromotionDataSource)
  },
  "productReviewDataSource": {
    object (ProductReviewDataSource)
  },
  "merchantReviewDataSource": {
    object (MerchantReviewDataSource)
  }
  // End of list of possible types for union field Type.
}
Campos
name

string

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

string (int64 format)

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

string

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

enum (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.
fileInput

object (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:
primaryProductDataSource

object (PrimaryProductDataSource)

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

object (SupplementalProductDataSource)

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

object (LocalInventoryDataSource)

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

object (RegionalInventoryDataSource)

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

object (PromotionDataSource)

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

object (ProductReviewDataSource)

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

object (MerchantReviewDataSource)

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

PrimaryProductDataSource

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

Representação JSON 
{
  "channel": enum (Channel),
  "countries": [
    string
  ],
  "defaultRule": {
    object (DefaultRule)
  },
  "feedLabel": string,
  "contentLanguage": string
}
Campos
channel

enum (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.
defaultRule

object (DefaultRule)

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

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

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.

Representação JSON 
{
  "takeFromDataSources": [
    {
      object (DataSourceReference)
    }
  ]
}
Campos
takeFromDataSources[]

object (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.

DataSourceReference

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

Representação JSON 
{

  // Union field data_source_id can be only one of the following:
  "self": boolean,
  "primaryDataSourceName": string,
  "supplementalDataSourceName": string
  // End of list of possible types for union field data_source_id.
}
Campos

Campo de união data_source_id.

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

boolean

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

string

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

string

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

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.

Representação JSON 
{
  "referencingPrimaryDataSources": [
    {
      object (DataSourceReference)
    }
  ],
  "feedLabel": string,
  "contentLanguage": string
}
Campos
referencingPrimaryDataSources[]

object (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.
feedLabel

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

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.

LocalInventoryDataSource

A origem dos dados do inventário local.

Representação JSON 
{
  "feedLabel": string,
  "contentLanguage": string
}
Campos
feedLabel

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

string

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

RegionalInventoryDataSource

A origem de dados de inventário regional.

Representação JSON 
{
  "feedLabel": string,
  "contentLanguage": string
}
Campos
feedLabel

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

string

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

PromotionDataSource

A origem de dados da promoção.

Representação JSON 
{
  "targetCountry": string,
  "contentLanguage": string
}
Campos
targetCountry

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

string

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

ProductReviewDataSource

Esse tipo não tem campos.

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

MerchantReviewDataSource

Esse tipo não tem campos.

A origem de dados de avaliações 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.

FileInput

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

Representação JSON 
{
  "fetchSettings": {
    object (FetchSettings)
  },
  "fileName": string,
  "fileInputType": enum (FileInputType)
}
Campos
fetchSettings

object (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.
fileName

string

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

enum (FileInputType)

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

FetchSettings

Buscar detalhes para entregar a fonte de dados.

Representação JSON 
{
  "enabled": boolean,
  "dayOfMonth": integer,
  "timeOfDay": {
    object (TimeOfDay)
  },
  "dayOfWeek": enum (DayOfWeek),
  "timeZone": string,
  "frequency": enum (Frequency),
  "fetchUri": string,
  "username": string,
  "password": string
}
Campos
enabled

boolean

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

integer

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

object (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.
dayOfWeek

enum (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.
timeZone

string

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

enum (Frequency)

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

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 fetchUri. Usado para enviar fontes de dados pelo SFTP.
password

string

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

TimeOfDay

Representa um horário do dia. A data e o fuso horário não são relevantes ou são especificados em outro lugar. Uma API pode permitir segundos bissextos. Os tipos relacionados são google.type.Date e google.protobuf.Timestamp.

Representação JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Campos
hours

integer

Horas de um dia no formato de 24 horas. Precisa ser maior ou igual a 0 e normalmente precisa ser menor ou igual a 23. Uma API pode permitir o valor "24:00:00" para o horário de fechamento da empresa, por exemplo.
minutes

integer

Minutos de uma hora. Precisa ser maior ou igual a 0 e menor ou igual a 59.
seconds

integer

Segundos de um minuto. Precisa ser maior ou igual a 0 e normalmente precisa ser menor ou igual a 59. Uma API pode permitir o valor 60 se permitir segundos bissextos.
nanos

integer

Frações de segundos em nanossegundos. Precisa ser maior ou igual a 0 e menor ou igual a 999.999.999.

DayOfWeek

Representa um dia da semana.

Enums
DAY_OF_WEEK_UNSPECIFIED O dia da semana não é especificado.
MONDAY Segunda-feira
TUESDAY Terça-feira
WEDNESDAY Quarta-feira
THURSDAY Quinta-feira
FRIDAY Sexta-feira
SATURDAY Sábado
SUNDAY Domingo

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 fetchUri configurado.
GOOGLE_SHEETS O arquivo é buscado nas Planilhas Google especificado em fetchUri.

Métodos

create

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

delete

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

fetch

 Faz a busca de dados imediatamente (mesmo fora da programação de busca) em uma fonte de dados da sua conta do Merchant Center.

get

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

list

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

patch

 Atualiza a configuração da fonte de dados atual.