Package google.shopping.merchant.datasources.v1beta

Индекс

Служба источников данных

Сервис для управления первичными, дополнительными, инвентарными и другими источниками данных. Подробную информацию можно найти в справочной статье Merchant Center .

Создать источник данных

rpc CreateDataSource( CreateDataSourceRequest ) returns ( DataSource )

Создает новую конфигурацию источника данных для данной учетной записи.

Области авторизации

Требуется следующая область действия OAuth:

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

Для получения дополнительной информации см.OAuth 2.0 Overview .

Удалить источник данных

rpc DeleteDataSource( DeleteDataSourceRequest ) returns ( Empty )

Удаляет источник данных из вашего аккаунта Merchant Center.

Области авторизации

Требуется следующая область действия OAuth:

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

Для получения дополнительной информации см.OAuth 2.0 Overview .

FetchDataSource

rpc FetchDataSource( FetchDataSourceRequest ) returns ( Empty )

Выполняет немедленную выборку данных (даже вне расписания) из источника данных из вашей учетной записи Merchant Center. Если вам нужно вызывать этот метод более одного раза в день, вместо этого вам следует использовать службу «Продукты» для обновления данных о ваших продуктах. Этот метод работает только с источниками данных с набором файловых входных данных.

Области авторизации

Требуется следующая область действия OAuth:

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

Для получения дополнительной информации см.OAuth 2.0 Overview .

GetDataSource

rpc GetDataSource( GetDataSourceRequest ) returns ( DataSource )

Получает конфигурацию источника данных для данной учетной записи.

Области авторизации

Требуется следующая область действия OAuth:

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

Для получения дополнительной информации см.OAuth 2.0 Overview .

Список источников данных

rpc ListDataSources( ListDataSourcesRequest ) returns ( ListDataSourcesResponse )

Перечисляет конфигурации источников данных для данной учетной записи.

Области авторизации

Требуется следующая область действия OAuth:

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

Для получения дополнительной информации см.OAuth 2.0 Overview .

Обновление источника данных

rpc UpdateDataSource( UpdateDataSourceRequest ) returns ( DataSource )

Обновляет существующую конфигурацию источника данных. Поля, заданные в маске обновления, но не предоставленные в ресурсе, будут удалены.

Области авторизации

Требуется следующая область действия OAuth:

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

Для получения дополнительной информации см.OAuth 2.0 Overview .

FileUploadsService

Сервис для управления загрузкой файлов источников данных.

GetFileUpload

rpc GetFileUpload( GetFileUploadRequest ) returns ( FileUpload )

Получает последнюю загруженную версию файла источника данных. Для загрузки файла принимается только latest псевдоним.

Области авторизации

Требуется следующая область действия OAuth:

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

Для получения дополнительной информации см.OAuth 2.0 Overview .

Создать запрос источника данных

Сообщение запроса для метода CreateDataSource.

Поля
parent

string

Необходимый. Учетная запись, в которой будет создан этот источник данных. Формат: accounts/{account}

data_ source

DataSource

Необходимый. Источник данных, который нужно создать.

Источник данных

Источник данных для аккаунта Merchant Center.

Поля
name

string

Идентификатор. Имя источника данных. Формат: {datasource.name=accounts/{account}/dataSources/{datasource}}

data_ source_ id

int64

Только вывод. Идентификатор источника данных.

display_ name

string

Необходимый. Отображаемое имя источника данных в пользовательском интерфейсе Merchant Center.

input

Input

Только вывод. Определяет тип ввода в источник данных. Судя по введенным данным, некоторые настройки могут не работать. С помощью API можно создавать только общие источники данных.

file_ input

FileInput

Необязательный. Поле используется только в том случае, если управление данными осуществляется через файл.

Type поля объединения. Необходимый. Тип источника данных. Type может быть только одним из следующих:
primary_ product_ data_ source

PrimaryProductDataSource

Основной источник данных для местных и онлайн-продуктов.

supplemental_ product_ data_ source

SupplementalProductDataSource

Дополнительный источник данных для местных и онлайн-продуктов.

local_ inventory_ data_ source

LocalInventoryDataSource

Источник данных о локальных запасах .

regional_ inventory_ data_ source

RegionalInventoryDataSource

Источник данных региональной инвентаризации .

promotion_ data_ source

PromotionDataSource

Источник данных о промоакции .

product_ review_ data_ source

ProductReviewDataSource

Источник данных обзора продукта .

merchant_ review_ data_ source

MerchantReviewDataSource

Источник данных отзывов продавцов .

Вход

Определяет тип ввода в источник данных. Судя по введенным данным, некоторые настройки могут не поддерживаться.

Перечисления
INPUT_UNSPECIFIED Ввод не указан.
API Представляет источники данных, для которых данные в основном предоставляются через API.
FILE Представляет источники данных, для которых данные в основном предоставляются посредством ввода файла. Данные по-прежнему можно предоставлять через API.
UI

Источник данных для товаров, добавленных непосредственно в Merchant Center.

Этот тип источника данных нельзя создать или обновить с помощью этого API, только с помощью пользовательского интерфейса Merchant Center.

Этот тип источника данных доступен только для чтения.

AUTOFEED Это также известно как автоматические каналы, используемые для автоматического создания данных о ваших продуктах. Этот тип источника данных можно включить или отключить с помощью пакета «Аккаунты».

Ссылка на источник данных

Ссылку на источник данных можно использовать для управления связанными источниками данных в службе источников данных.

Поля

Поле объединения data_source_id .

data_source_id может быть только одним из следующих:

self

bool

Self следует использовать для ссылки на сам основной источник данных.

primary_ data_ source_ name

string

Необязательный. Имя основного источника данных. Формат: accounts/{account}/dataSources/{datasource}

supplemental_ data_ source_ name

string

Необязательный. Имя дополнительного источника данных. Формат: accounts/{account}/dataSources/{datasource}

УдалитьDataSourceRequest

Сообщение запроса для метода DeleteDataSource.

Поля
name

string

Необходимый. Имя источника данных, который требуется удалить. Формат: accounts/{account}/dataSources/{datasource}

FetchDataSourceRequest

Сообщение запроса для метода FetchDataSource.

Поля
name

string

Необходимый. Имя извлекаемого ресурса источника данных. Формат: accounts/{account}/dataSources/{datasource}

ФилеИнпут

Данные, специфичные для файловых источников данных. Это поле пусто для других входных данных источника данных.

Поля
fetch_ settings

FetchSettings

Необязательный. Получите сведения для доставки источника данных. Он содержит настройки для типов ввода файлов FETCH и GOOGLE_SHEETS . Обязательные поля различаются в зависимости от частоты получения.

file_ name

string

Необязательный. Имя файла источника данных. Требуется для типа ввода файла UPLOAD .

file_ input_ type

FileInputType

Только вывод. Тип ввода файла.

Получить настройки

Получите сведения для доставки источника данных.

Поля
enabled

bool

Необязательный. Включает или приостанавливает расписание выборки.

day_ of_ month

int32

Необязательный. День месяца, когда должен быть получен файл источника данных (1–31). В этом поле можно установить только ежемесячную частоту.

time_ of_ day

TimeOfDay

Необязательный. Час дня, когда должен быть получен файл источника данных. Минуты и секунды не поддерживаются и будут игнорироваться.

day_ of_ week

DayOfWeek

Необязательный. День недели, когда следует получить файл источника данных. В этом поле можно установить только еженедельную частоту.

time_ zone

string

Необязательный. Часовой пояс, используемый для расписания. UTC по умолчанию. Например, «Америка/Лос-Анджелес».

frequency

Frequency

Необходимый. Частота, описывающая расписание выборки.

fetch_ uri

string

Необязательный. URL-адрес, по которому можно получить файл источника данных. Google Merchant Center поддерживает автоматическую запланированную загрузку с использованием протоколов HTTP, HTTPS или SFTP, поэтому значение должно быть действительной ссылкой, использующей один из этих трех протоколов. Неизменяемый для файлов Google Таблиц.

username

string

Необязательный. Необязательное имя пользователя для fetch_uri . Используется для отправки источников данных через SFTP .

password

string

Необязательный. Необязательный пароль для fetch_uri . Используется для отправки источников данных через SFTP .

Частота

Обязательные поля различаются в зависимости от частоты получения. Для ежемесячного расписания получения: [день месяца][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month] и [час дня][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day ] необходимы. Для еженедельного расписания загрузки [день недели][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week] и [час дня][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day ] необходимы. Для ежедневного расписания получения требуется только [час дня][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day].

Перечисления
FREQUENCY_UNSPECIFIED Частота не указана.
FREQUENCY_DAILY Загрузка происходит каждый день.
FREQUENCY_WEEKLY Сбор происходит каждую неделю.
FREQUENCY_MONTHLY Загрузка происходит каждый месяц.

филеинпуттипе

Способ доставки файлов.

Перечисления
FILE_INPUT_TYPE_UNSPECIFIED Тип входного файла не указан.
UPLOAD Файл загружается через SFTP, Google Cloud Storage или вручную в Merchant Center.
FETCH Файл извлекается из настроенного fetch_uri .
GOOGLE_SHEETS Файл извлекается из Google Таблиц, указанных в fetch_uri .

Загрузка файла

Загрузка файла определенного источника данных, то есть результат извлечения источника данных в определенную временную метку, вычисляемый асинхронно после завершения обработки источника данных. Применимо только к файловым источникам данных.

Поля
name

string

Идентификатор. Имя загружаемого файла источника данных. Формат: {datasource.name=accounts/{account}/dataSources/{datasource}/fileUploads/{fileupload}}

data_ source_ id

int64

Только вывод. Идентификатор источника данных.

processing_ state

ProcessingState

Только вывод. Состояние обработки источника данных.

issues[]

Issue

Только вывод. Список проблем, возникающих в источнике данных.

items_ total

int64

Только вывод. Количество обработанных элементов в источнике данных.

items_ created

int64

Только вывод. Количество созданных элементов в источнике данных.

items_ updated

int64

Только вывод. Количество элементов в источнике данных, которые были обновлены.

upload_ time

Timestamp

Только вывод. Дата загрузки файла источника данных.

Проблема

В источнике данных произошла ошибка, например «недопустимая цена».

Поля
title

string

Только вывод. Название проблемы, например: «Слишком большой предмет».

description

string

Только вывод. Описание ошибки, например: «Ваш источник данных содержит элементы, которые имеют слишком много атрибутов или слишком велики. Эти элементы будут удалены».

code

string

Только вывод. Код ошибки, например, «валидация/недействительное_значение». Возвращает "?" если код неизвестен.

count

int64

Только вывод. Количество ошибок при загрузке файла.

severity

Severity

Только вывод. Серьезность проблемы.

documentation_ uri

string

Только вывод. Ссылка на документацию, объясняющую проблему более подробно, если таковая имеется.

Серьезность

Серьезность проблемы.

Перечисления
SEVERITY_UNSPECIFIED Тяжесть не указана.
WARNING Проблема в предупреждении.
ERROR Проблема в ошибке.

Состояние обработки

Состояние обработки источника данных.

Перечисления
PROCESSING_STATE_UNSPECIFIED Статус обработки не указан.
FAILED Источник данных не удалось обработать, или во всех элементах были ошибки.
IN_PROGRESS Источник данных обрабатывается.
SUCCEEDED Источник данных обработан успешно, хотя в некоторых элементах могли быть ошибки.

GetDataSourceRequest

Сообщение запроса для метода GetDataSource.

Поля
name

string

Необходимый. Имя источника данных для получения. Формат: accounts/{account}/dataSources/{datasource}

GetFileUploadRequest

Сообщение запроса для метода GetFileUploadRequest.

Поля
name

string

Необходимый. Имя файла источника данных, загружаемого для получения. Формат: accounts/{account}/dataSources/{datasource}/fileUploads/latest

Запрос ListDataSourcesRequest

Сообщение запроса для метода ListDataSources.

Поля
parent

string

Необходимый. Учетная запись, для которой нужно перечислить источники данных. Формат: accounts/{account}

page_ size

int32

Необязательный. Максимальное количество возвращаемых источников данных. Служба может возвращать меньшее значение, чем это значение. Максимальное значение — 1000; значения выше 1000 будут приведены к 1000. Если не указано, будет возвращено максимальное количество источников данных.

page_ token

string

Необязательный. Токен страницы, полученный в результате предыдущего вызова ListDataSources . Предоставьте это, чтобы получить следующую страницу.

При разбиении на страницы все остальные параметры, предоставляемые ListDataSources должны соответствовать вызову, который предоставил токен страницы.

ListDataSourcesResponse

Ответное сообщение для метода ListDataSources.

Поля
data_ sources[]

DataSource

Источники данных из указанного аккаунта.

next_ page_ token

string

Токен, который можно отправить как page_token для получения следующей страницы. Если это поле опущено, последующие страницы отсутствуют.

ЛокалИнвенторидатасаурце

Источник данных о локальных запасах.

Поля
feed_ label

string

Необходимый. Неизменяемый. Ярлык фида предложений, для которых предоставляется местный инвентарь.

Должно быть меньше или равно 20 заглавным буквам (AZ), цифрам (0–9) и тире (-).

См. также переход на ярлыки фидов .

content_ language

string

Необходимый. Неизменяемый. Двухбуквенный язык ISO 639-1 для товаров, для которых предоставляется локальный инвентарь.

ПродавецОбзорDataSource

Этот тип не имеет полей.

Источник данных отзывов продавцов.

Первичныйпродуктовый источник данных

Основной источник данных для местных и онлайн-продуктов.

Поля
channel

Channel

Необходимый. Неизменяемый. Указывает тип канала источника данных.

countries[]

string

Необязательный. Страны, в которых могут отображаться товары. Представлен в виде кода территории CLDR .

default_ rule

DefaultRule

Необязательный. Управление правилами по умолчанию для источника данных. Если установлено, связанные источники данных будут заменены.

feed_ label

string

Необязательный. Неизменяемый. Метка фида, указанная на уровне источника данных.

Должно быть меньше или равно 20 заглавным буквам (AZ), цифрам (0–9) и тире (-).

См. также переход на ярлыки фидов .

feedLabel и contentLanguage должны быть либо установлены, либо не установлены для источников данных с типом контента «продукт». Их необходимо задать для источников данных с файловым вводом.

Если этот параметр установлен, источник данных будет принимать только продукты, соответствующие этой комбинации. Если этот параметр не установлен, источник данных будет принимать продукты без этого ограничения.

content_ language

string

Необязательный. Неизменяемый. Двухбуквенный язык ISO 639-1 для элементов в источнике данных.

feedLabel и contentLanguage должны быть либо установлены, либо не установлены. Поля можно сбросить только для источников данных без ввода файла.

Если этот параметр установлен, источник данных будет принимать только продукты, соответствующие этой комбинации. Если этот параметр не установлен, источник данных будет принимать продукты без этого ограничения.

Канал

Канал источника данных.

Канал используется для различения источников данных для разных вертикалей продуктов.

Перечисления
CHANNEL_UNSPECIFIED Не указан.
ONLINE_PRODUCTS Интернет-продукт.
LOCAL_PRODUCTS Местный продукт.
PRODUCTS Единый источник данных для локальных и онлайн-продуктов. Примечание. Для этого канала невозможно управление продуктами через API.

Правило по умолчанию

Управление правилами по умолчанию для источника данных.

Поля
take_ from_ data_ sources[]

DataSourceReference

Необходимый. Список источников данных, связанных в правиле по умолчанию . Этот список упорядочен по приоритету правила по умолчанию для объединения данных. Он может включать отсутствие или несколько ссылок на self и дополнительные источники данных.

Список не должен быть пустым.

Чтобы связать источник данных с правилом по умолчанию, вам необходимо добавить в этот список новую ссылку (в последовательном порядке).

Чтобы отсоединить источник данных от правила по умолчанию, необходимо удалить данную ссылку из этого списка.

Изменение порядка этого списка приведет к изменению приоритета источников данных в правиле по умолчанию.

Например, если предоставить следующий список: [ 1001 , self ] будут принимать значения атрибутов из дополнительного источника данных 1001 и возвращаться к self если атрибут не установлен в 1001 .

Обзор продуктаИсточник данных

Этот тип не имеет полей.

Источник данных обзора продукта.

Источник данных для продвижения

Источник данных о промоакции.

Поля
target_ country

string

Необходимый. Неизменяемый. Целевая страна используется как часть уникального идентификатора. Представлен в виде кода территории CLDR .

Специальные предложения доступны только в некоторых странах .

content_ language

string

Необходимый. Неизменяемый. Двухбуквенный язык ISO 639-1 для элементов в источнике данных.

РегиональныйИнвенториDataSource

Источник данных региональной инвентаризации.

Поля
feed_ label

string

Необходимый. Неизменяемый. Ярлык фида предложений, для которых предоставлен региональный инвентарь.

Должно быть меньше или равно 20 заглавным буквам (AZ), цифрам (0–9) и тире (-).

См. также переход на ярлыки фидов .

content_ language

string

Необходимый. Неизменяемый. Двухбуквенный язык ISO 639-1 для элементов, для которых предоставляется региональная инвентаризация.

Дополнительный источник данных о продукте

Дополнительный источник данных для местных и онлайн-продуктов. После создания необходимо обязательно связать дополнительный источник данных о продукте с одним или несколькими основными источниками данных о продукте.

Поля
referencing_ primary_ data_ sources[]

DataSourceReference

Только вывод. Список (неупорядоченный и дедуплицированный) всех основных источников данных, связанных с этим источником данных в правилах по умолчанию или в настраиваемых правилах. Дополнительный источник данных нельзя удалить, пока не будут удалены все ссылки.

feed_ label

string

Необязательный. Неизменяемый. Метка фида, указанная на уровне источника данных.

Должно быть меньше или равно 20 заглавным буквам (AZ), цифрам (0–9) и тире (-).

См. также переход на ярлыки фидов .

feedLabel и contentLanguage должны быть либо установлены, либо не установлены для источников данных с типом контента «продукт».

Их необходимо задать для источников данных с file input . Поля должны быть отключены для источников данных без file input .

Если этот параметр установлен, источник данных будет принимать только продукты, соответствующие этой комбинации. Если этот параметр не установлен, источник данных будет принимать продукты без этого ограничения.

content_ language

string

Необязательный. Неизменяемый. Двухбуквенный язык ISO 639-1 для элементов в источнике данных.

feedLabel и contentLanguage должны быть либо установлены, либо не установлены. Поля можно сбросить только для источников данных без ввода файла.

Если этот параметр установлен, источник данных будет принимать только продукты, соответствующие этой комбинации. Если этот параметр не установлен, источник данных будет принимать продукты без этого ограничения.

Запрос обновления источника данных

Сообщение запроса для метода UpdateDataSource.

Поля
data_ source

DataSource

Необходимый. Ресурс источника данных для обновления.

update_ mask

FieldMask

Необходимый. Список полей источника данных, которые необходимо обновить.

Поля, указанные в маске обновления без значения, указанного в теле, будут удалены из источника данных.

Предоставление специального значения «*» для полной замены источника данных не поддерживается.