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)
  }
  // End of list of possible types for union field Type.
}
Campos
name

string

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

fileInput

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

object (PrimaryProductDataSource)

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

regionalInventoryDataSource

object (RegionalInventoryDataSource)

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

promotionDataSource

object (PromotionDataSource)

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

PrimaryProductDataSource

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

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

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

feedLabel

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.

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 definidos. Os campos só podem ser definidos 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 pela API neste canal.

SupplementalProductDataSource

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

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

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.

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 definidos. Os campos só podem ser definidos 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.

LocalInventoryDataSource

A origem de 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 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.

contentLanguage

string

Obrigatório. Imutável. O idioma ISO 639-1 de duas letras dos itens aos 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 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.

contentLanguage

string

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

PromotionDataSource

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

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

contentLanguage

string

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

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

FileInput

Os dados específicos para as 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 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.

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

FetchSettings

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

timeOfDay

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

dayOfWeek

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

timeZone

string

Opcional. Fuso horário usado para 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 automáticos programados com 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.

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 do dia no formato de 24 horas. Precisa ser de 0 a 23. Uma API pode permitir o valor "24:00:00" para o horário de fechamento da empresa, por exemplo.

minutes

integer

Minutos da hora do dia. Precisa ser de 0 a 59.

seconds

integer

Segundos do minutos do horário. Normalmente precisa ser de 0 a 59. Uma API pode permitir o valor 60 se permitir segundos bissextos.

nanos

integer

Frações de segundos em nanossegundos. Precisa ser de 0 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, 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 de arquivos.

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 [fetchUri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri] configurado.
GOOGLE_SHEETS O arquivo é buscado nas Planilhas Google especificadas em [fetchUri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri].

Métodos

create

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

delete

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

fetch

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

get

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

list

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

patch

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