Package google.shopping.merchant.datasources.v1beta

Индекс

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

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

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

rpc CreateDataSource( CreateDataSourceRequest ) returns ( DataSource )

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

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

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

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

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

rpc DeleteDataSource( DeleteDataSourceRequest ) returns ( Empty )

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

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

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

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

FetchDataSource

rpc FetchDataSource( FetchDataSourceRequest ) returns ( Empty )

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

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

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

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

GetDataSource

rpc GetDataSource( GetDataSourceRequest ) returns ( DataSource )

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

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

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

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

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

rpc ListDataSources( ListDataSourcesRequest ) returns ( ListDataSourcesResponse )

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

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

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

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

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

rpc UpdateDataSource( UpdateDataSourceRequest ) returns ( DataSource )

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

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

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

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

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

Сообщение запроса для метода 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

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

Вход

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

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

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

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

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

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

Удаление запроса источника данных

Сообщение запроса для метода 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 url][google.shopping.content.bundles.DataSources.FileInput.fetch_url]. Используется для отправки источников данных через SFTP .

password

string

Необязательный. Необязательный пароль для [fetch url][google.shopping.content.bundles.DataSources.FileInput.fetch_url]. Используется для отправки источников данных через 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.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri].
GOOGLE_SHEETS Файл извлекается из Google Таблиц, указанных в [fetch_uri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri].

GetDataSourceRequest

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

Поля
name

string

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

Запрос 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 для товаров, для которых предоставляется локальный инвентарь.

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

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

Поля
channel

Channel

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

countries[]

string

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

feed_label

string

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

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

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

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

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

content_language

string

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

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

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

Канал

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

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

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

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

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

Поля
target_country

string

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

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

content_language

string

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

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

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

Поля
feed_label

string

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

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

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

content_language

string

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

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

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

Поля
feed_label

string

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

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

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

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

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

content_language

string

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

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

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

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

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

Поля
data_source

DataSource

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

update_mask

FieldMask

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

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

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