Подинтерфейс API «Продукты» позволяет вносить частичные обновления в существующие товары. Это идеально подходит для часто меняющихся данных, таких как цена и доступность, поскольку избавляет от необходимости повторно отправлять данные о товаре при небольшом изменении. Однако вам следует регулярно добавлять товары повторно, чтобы обеспечить синхронизацию всех данных.
В этом руководстве описывается, как использовать метод productinputs.patch
для обновления ваших продуктов.
Предпосылки
Прежде чем обновить продукт, вам необходимо следующее:
- Существующий продукт, который нужно обновить. Чтобы узнать, как создавать продукты, см. руководство «Добавление и управление продуктами» .
-
name
источника данных, к которому относится входная информация о продукте (например,accounts/12345/dataSources/67890
). Чтобы узнать, как это найти, см. руководство «Управление источниками данных API для загрузки данных о продукте» .
Обновите подробную информацию о продукте
Чтобы изменить некоторые данные о продукте, например его цену или доступность, без повторной отправки всей информации, используйте метод productInputs.patch
.
Вы можете указать, какие поля вы изменяете, в параметре updateMask
. Параметр updateMask
представляет собой список полей, которые вы хотите обновить, разделённый запятыми. Метод patch
работает следующим образом:
- Поля в
updateMask
и body: эти поля обновляются новыми значениями. - Поля в
updateMask
, но не в теле: эти поля удаляются из ввода продукта. - Поля, отсутствующие в
updateMask
: эти поля остаются без изменений. - Параметр
updateMask
пропущен: все поля, указанные в теле запроса, обновляются. Поля, не указанные в теле запроса, не удаляются из поля ввода товара.
Вот пример данных о продукте до обновления:
{
"name": "accounts/{ACCOUNT_ID}/productInputs/en~US~SKU12345",
"product": "accounts/{ACCOUNT_ID}/products/en~US~SKU12345",
"offerId": "SKU12345",
"contentLanguage": "en",
"feedLabel": "US",
"productAttributes": {
"title": "Classic Cotton T-Shirt",
"description": "A comfortable, durable, and stylish t-shirt made from 100% cotton.",
"link": "https://www.example.com/p/SKU12345",
"availability": "IN_STOCK",
"price": {
"amountMicros": "15990000",
"currencyCode": "USD"
},
"condition": "NEW",
"gtins": [
"9780007350896"
],
"imageLink": "https://www.example.com/image/SKU12345"
}
}
В этом примере обновляется title
и availability
товара, а также удаляется его imageLink
. description
и price
не включены в updateMask
и останутся неизменными.
PATCH https://merchantapi.googleapis.com/products/v1/accounts/{ACCOUNT_ID}/productInputs/en~US~SKU12345?updateMask=productAttributes.title,productAttributes.availability,productAttributes.imageLink&dataSource=accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}
{
"productAttributes": {
"title": "Classic Cotton T-Shirt - New Edition",
"availability": "OUT_OF_STOCK",
"description": "A comfortable T-shirt from premium cotton, newer edition.",
"price": {
"amountMicros": "9990000",
"currencyCode": "USD"
}
}
}
Успешный вызов возвращает обновлённый ресурс ProductInput
. title
и availability
обновляются, а ссылка imageLink
удаляется, поскольку она присутствовала в updateMask
, но отсутствовала в теле запроса. description
и price
остаются неизменными, поскольку они не были указаны в updateMask
.
{
"name": "accounts/{ACCOUNT_ID}/productInputs/en~US~SKU12345",
"product": "accounts/{ACCOUNT_ID}/products/en~US~SKU12345",
"offerId": "SKU12345",
"contentLanguage": "en",
"feedLabel": "US",
"productAttributes": {
"title": "Classic Cotton T-Shirt - New Edition",
"description": "A comfortable, durable, and stylish t-shirt made from 100% cotton.",
"link": "https://www.example.com/p/SKU12345",
"availability": "OUT_OF_STOCK",
"price": {
"amountMicros": "15990000",
"currencyCode": "USD"
},
"condition": "NEW",
"gtins": [
"9780007350896"
],
}
}
В следующих примерах кода показано, как обновить продукт.
Ява
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.protobuf.FieldMask;
import com.google.shopping.merchant.datasources.v1.DataSourceName;
import com.google.shopping.merchant.products.v1.Availability;
import com.google.shopping.merchant.products.v1.Condition;
import com.google.shopping.merchant.products.v1.ProductAttributes;
import com.google.shopping.merchant.products.v1.ProductInput;
import com.google.shopping.merchant.products.v1.ProductInputName;
import com.google.shopping.merchant.products.v1.ProductInputsServiceClient;
import com.google.shopping.merchant.products.v1.ProductInputsServiceSettings;
import com.google.shopping.merchant.products.v1.UpdateProductInputRequest;
import com.google.shopping.type.CustomAttribute;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/** This class demonstrates how to update a product input */
public class UpdateProductInputSample {
public static void updateProductInput(Config config, String productId, String dataSourceId)
throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the credentials retrieved above.
ProductInputsServiceSettings productInputsServiceSettings =
ProductInputsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates product name to identify product.
String name =
ProductInputName.newBuilder()
.setAccount(config.getAccountId().toString())
.setProductinput(productId)
.build()
.toString();
// Just productAttributes and customAttributes can be updated
FieldMask fieldMask =
FieldMask.newBuilder()
.addPaths("product_attributes.title")
.addPaths("product_attributes.description")
.addPaths("product_attributes.link")
.addPaths("product_attributes.image_link")
.addPaths("product_attributes.availability")
.addPaths("product_attributes.condition")
.addPaths("product_attributes.gtins")
.addPaths("custom_attributes.mycustomattribute")
.build();
// Calls the API and catches and prints any network failures/errors.
try (ProductInputsServiceClient productInputsServiceClient =
ProductInputsServiceClient.create(productInputsServiceSettings)) {
ProductAttributes attributes =
ProductAttributes.newBuilder()
.setTitle("A Tale of Two Cities")
.setDescription("A classic novel about the French Revolution")
.setLink("https://exampleWebsite.com/tale-of-two-cities.html")
.setImageLink("https://exampleWebsite.com/tale-of-two-cities.jpg")
.setAvailability(Availability.IN_STOCK)
.setCondition(Condition.NEW)
.addGtins("9780007350896")
.build();
// The datasource can be either a primary or supplemental datasource.
String dataSource =
DataSourceName.newBuilder()
.setAccount(config.getAccountId().toString())
.setDatasource(dataSourceId)
.build()
.toString();
UpdateProductInputRequest request =
UpdateProductInputRequest.newBuilder()
.setUpdateMask(fieldMask)
// You can only update product attributes and custom_attributes
.setDataSource(dataSource)
.setProductInput(
ProductInput.newBuilder()
.setName(name)
.setProductAttributes(attributes)
.addCustomAttributes(
CustomAttribute.newBuilder()
.setName("mycustomattribute")
.setValue("Example value")
.build())
.build())
.build();
System.out.println("Sending update ProductInput request");
ProductInput response = productInputsServiceClient.updateProductInput(request);
System.out.println("Updated ProductInput Name below");
// The last part of the product name will be the product ID assigned to a product by Google.
// Product ID has the format `contentLanguage~feedLabel~offerId`
System.out.println(response.getName());
System.out.println("Updated Product below");
System.out.println(response);
} catch (Exception e) {
System.out.println(e);
}
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
// An ID assigned to a product by Google. In the format
// contentLanguage~feedLabel~offerId
String productId = "en~label~sku123"; // Replace with your product ID.
// Identifies the data source that will own the product input.
String dataSourceId = "{INSERT_DATASOURCE_ID}"; // Replace with your datasource ID.
updateProductInput(config, productId, dataSourceId);
}
}
PHP
use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;
use Google\Shopping\Merchant\Products\V1\Availability;
use Google\Shopping\Merchant\Products\V1\Condition;
use Google\Shopping\Merchant\Products\V1\ProductAttributes;
use Google\Shopping\Merchant\Products\V1\Client\ProductInputsServiceClient;
use Google\Shopping\Merchant\Products\V1\ProductInput;
use Google\Shopping\Merchant\Products\V1\UpdateProductInputRequest;
use Google\Shopping\Type\CustomAttribute;
/**
* This class demonstrates how to update a product input.
*/
class UpdateProductInputSample
{
// An ID assigned to a product by Google. In the format
// contentLanguage~feedLabel~offerId
// Please ensure this product ID exists for the update to succeed.
private const PRODUCT_ID = "online~en~label~sku123";
// Identifies the data source that will own the product input.
// Please ensure this data source ID exists.
private const DATASOURCE_ID = "<INSERT_DATASOURCE_ID>";
/**
* Helper function to construct the full product input resource name.
*
* @param string $accountId The merchant account ID.
* @param string $productInputId The product input ID (e.g., "online~en~label~sku123").
* @return string The full product input resource name.
*/
private static function getProductInputName(string $accountId, string $productInputId): string
{
return sprintf("accounts/%s/productInputs/%s", $accountId, $productInputId);
}
/**
* Helper function to construct the full data source resource name.
*
* @param string $accountId The merchant account ID.
* @param string $dataSourceId The data source ID.
* @return string The full data source resource name.
*/
private static function getDataSourceName(string $accountId, string $dataSourceId): string
{
return sprintf("accounts/%s/dataSources/%s", $accountId, $dataSourceId);
}
/**
* Updates an existing product input in your Merchant Center account.
*
* @param array $config The configuration array containing the account ID.
* @param string $productId The ID of the product input to update.
* @param string $dataSourceId The ID of the data source.
*/
public static function updateProductInput(
array $config,
string $productId,
string $dataSourceId
): void {
// Gets the OAuth credentials to make the request.
$credentials = Authentication::useServiceAccountOrTokenFile();
// Creates options config containing credentials for the client to use.
$options = ['credentials' => $credentials];
// Creates a ProductInputsServiceClient.
$productInputsServiceClient = new ProductInputsServiceClient($options);
// Construct the full resource name of the product input to be updated.
$name = self::getProductInputName($config['accountId'], $productId);
// Define the FieldMask to specify which fields to update.
// Only 'attributes' and 'custom_attributes' can be specified in the
// FieldMask for product input updates.
$fieldMask = new FieldMask([
'paths' => [
"product_attributes.title",
"product_attributes.description",
"product_attributes.link",
"product_attributes.image_link",
"product_attributes.availability",
"product_attributes.condition",
"product_attributes.gtin",
"custom_attributes.mycustomattribute" // Path for a specific custom attribute
]
]);
// Calls the API and handles any network failures or errors.
try {
// Define the new attributes for the product.
$attributes = new ProductAttributes([
'title' => 'A Tale of Two Cities 3',
'description' => 'A classic novel about the French Revolution',
'link' => 'https://exampleWebsite.com/tale-of-two-cities.html',
'image_link' => 'https://exampleWebsite.com/tale-of-two-cities.jpg',
'availability' => Availability::IN_STOCK,
'condition' => Condition::PBNEW,
'gtins' => ['9780007350896'] // GTIN is a repeated field.
]);
// Construct the full data source name.
// This specifies the data source context for the update.
$dataSource = self::getDataSourceName($config['accountId'], $dataSourceId);
// Create the ProductInput object with the desired updates.
// The 'name' field must match the product input being updated.
$productInput = new ProductInput([
'name' => $name,
'product_attributes' => $attributes,
'custom_attributes' => [ // Provide the list of custom attributes.
new CustomAttribute([
'name' => 'mycustomattribute',
'value' => 'Example value'
])
]
]);
// Create the UpdateProductInputRequest.
$request = new UpdateProductInputRequest([
'update_mask' => $fieldMask,
'data_source' => $dataSource,
'product_input' => $productInput
]);
print "Sending update ProductInput request\n";
// Make the API call to update the product input.
$response = $productInputsServiceClient->updateProductInput($request);
print "Updated ProductInput Name below\n";
// The name of the updated product input.
// The last part of the product name is the product ID (e.g., contentLanguage~feedLabel~offerId).
print $response->getName() . "\n";
print "Updated Product below\n";
// Print the full updated product input object.
print_r($response);
} catch (ApiException $e) {
printf("ApiException caught: %s\n", $e->getMessage());
}
}
/**
* Executes the UpdateProductInput sample.
*/
public function callSample(): void
{
$config = Config::generateConfig();
$productId = self::PRODUCT_ID;
$dataSourceId = self::DATASOURCE_ID;
self::updateProductInput($config, $productId, $dataSourceId);
}
}
// Run the script.
$sample = new UpdateProductInputSample();
$sample->callSample();
Питон
"""A module to update a product input."""
from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.protobuf import field_mask_pb2
from google.shopping.merchant_products_v1 import Availability
from google.shopping.merchant_products_v1 import Condition
from google.shopping.merchant_products_v1 import ProductAttributes
from google.shopping.merchant_products_v1 import ProductInput
from google.shopping.merchant_products_v1 import ProductInputsServiceClient
from google.shopping.merchant_products_v1 import UpdateProductInputRequest
from google.shopping.type import CustomAttribute
# Fetches the Merchant Center account ID from the authentication examples.
# This ID is needed to construct resource names for the API.
_ACCOUNT_ID = configuration.Configuration().read_merchant_info()
def update_product_input(account_id: str, product_id: str, data_source_id: str):
"""Updates an existing product input for a specific account.
Args:
account_id: The Merchant Center account ID.
product_id: The ID of the product input to update. This ID is assigned by
Google and has the format `contentLanguage~feedLabel~offerId`.
data_source_id: The ID of the data source that owns the product input.
"""
# Obtains OAuth credentials for authentication.
credentials = generate_user_credentials.main()
# Creates a ProductInputsServiceClient instance.
client = ProductInputsServiceClient(credentials=credentials)
# Constructs the full resource name for the product input.
# Format: accounts/{account}/productInputs/{productinput}
name = f"accounts/{account_id}/productInputs/{product_id}"
# Defines the FieldMask to specify which fields of the product input
# are being updated. Only 'attributes' and 'custom_attributes' can be updated.
field_mask = field_mask_pb2.FieldMask(
paths=[
"product_attributes.title",
"product_attributes.description",
"product_attributes.link",
"product_attributes.image_link",
"product_attributes.availability",
"product_attributes.condition",
"product_attributes.gtins",
"custom_attributes.mycustomattribute",
]
)
# Prepares the new attribute values for the product.
attributes = ProductAttributes(
title="A Tale of Two Cities updated",
description="A classic novel about the French Revolution",
link="https://exampleWebsite.com/tale-of-two-cities.html",
image_link="https://exampleWebsite.com/tale-of-two-cities.jpg",
availability=Availability.IN_STOCK,
condition=Condition.NEW,
gtins=["9780007350896"], # GTIN is a repeated field.
)
# Constructs the full resource name for the data source.
# The data source can be primary or supplemental.
# Format: accounts/{account}/dataSources/{datasource}
data_source = f"accounts/{account_id}/dataSources/{data_source_id}"
# Prepares the ProductInput object with the updated information.
product_input_data = ProductInput(
name=name,
product_attributes=attributes,
custom_attributes=[
CustomAttribute(
name="mycustomattribute", value="Example value"
)
],
)
# Creates the UpdateProductInputRequest.
request = UpdateProductInputRequest(
update_mask=field_mask,
data_source=data_source,
product_input=product_input_data,
)
# Sends the update request to the API.
try:
print("Sending update ProductInput request")
response = client.update_product_input(request=request)
print("Updated ProductInput Name below")
# The response includes the name of the updated product input.
# The last part of the product name is the product ID assigned by Google.
print(response.name)
print("Updated Product below")
print(response)
except RuntimeError as e:
# Catches and prints any errors that occur during the API call.
print(e)
if __name__ == "__main__":
# The ID of the product to be updated.
# This ID is assigned by Google and typically follows the format:
# contentLanguage~feedLabel~offerId
# Replace with an actual product ID from your Merchant Center account.
product_id_to_update = "online~en~label~sku123"
# The ID of the data source that will own the updated product input.
# Replace with an actual data source ID from your Merchant Center account.
data_source_id_for_update = "<INSERT_DATA_SOURCE_ID>"
update_product_input(
_ACCOUNT_ID, product_id_to_update, data_source_id_for_update
)
cURL
curl --location --request PATCH 'https://merchantapi.googleapis.com/products/v1/accounts/{ACCOUNT_ID}/productInputs/en~US~SKU12345?updateMask=productAttributes.title,productAttributes.description&dataSource=accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}' \
--header 'Authorization: Bearer <API_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"productAttributes": {
"title": "A Tale of Two Cities",
"description": "A classic novel about the French Revolution"
}
}'
Обновление с использованием пользовательских атрибутов
Вы можете обновить как стандартные, так и настраиваемые атрибуты за один вызов. Чтобы обновить настраиваемый атрибут, добавьте к его имени префикс customAttributes
в updateMask
.
В этом примере выполняется несколько действий в одном запросе:
- Обновляет стандартный атрибут
title
напрямую. - Обновляет существующий пользовательский атрибут (
myCustomAttrToBeUpdated
). - Вставляет новый пользовательский атрибут (
myCustomAttrToBeInserted
). - Удаляет существующий пользовательский атрибут (
myCustomAttrToBeDeleted
).
PATCH https://merchantapi.googleapis.com/products/v1/accounts/{ACCOUNT_ID}/productInputs/en~US~SKU12345?updateMask=productAttributes.title,customAttributes.myCustomAttrToBeInserted,customAttributes.myCustomAttrToBeUpdated,customAttributes.myCustomAttrToBeDeleted&dataSource=accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}
{
"productAttributes": {
"title": "ProductTitle Updated"
},
"customAttributes": [
{
"name": "description",
"value": "A newly updated description."
},
{
"name": "myCustomAttrToBeUpdated",
"value": "myCustomAttrToBeUpdated updated value"
},
{
"name": "myCustomAttrToBeInserted",
"value": "new from update"
}
]
}
Успешный запрос возвращает обновленный ProductInput
, отражающий все указанные изменения.
Понимание обновлений пользовательских атрибутов
Вы можете использовать поле customAttributes
для обновления атрибутов, которые вы определили самостоятельно. Они не соответствуют стандартной спецификации и будут сохранены как пользовательские атрибуты в конечном продукте.
Как обрабатываются обновления продукта
При отправке запроса patch
обновление применяется к конкретным данным ProductInput
до применения каких-либо правил. Это обеспечивает согласованность действий при добавлении и обновлении товаров.
Вот как обрабатывается ваше обновление:
Обновление входных данных: ваш запрос
patch
изменяет конкретныйProductInput
, связанный с предоставленным вами источником данных.Обработка и объединение: После обновления входных данных начинается обработка:
- Правила фида и дополнительные источники данных: правила, настроенные для основного источника товара, объединяют
ProductInput
из основного и дополнительных источников. Эти правила могут изменять атрибуты или создавать новые. Подробнее о настройке правил см. в статье https://support.google.com/merchants/answer/14994083 . - Другие источники данных: данные из других источников (например, автоматические улучшения) также объединяются с входными данными основного источника.
- Проверка: объединенные данные проверяются на соответствие спецификации данных о продукте и политике покупок Google.
- Правила фида и дополнительные источники данных: правила, настроенные для основного источника товара, объединяют
Конечный продукт: результатом этого конвейера является конечный обработанный ресурс
Product
, который можно получить с помощьюproducts.get
илиproducts.list
. Это также версия продукта, которая отображается в Merchant Center и может отображаться в различных местах назначения.
Из-за этого многоэтапного процесса существует задержка, обычно в несколько минут, между отправкой запроса на обновление и отражением изменений в конечном ресурсе Product
, который можно получить с помощью products.get
.
Пример: обновление продукта с одним основным входом
Это наиболее распространённый вариант использования. Товар существует в одном первичном источнике данных, и вам нужно обновить некоторые его атрибуты.
- Начальное состояние: в вашем первичном источнике данных существует продукт
en~US~SKU12345
сtitle: "Classic T-Shirt"
иprice: 15.99 USD
. - Запрос на обновление: Вы отправляете запрос
patch
, чтобы обновитьprice
до14.99 USD
и установитьavailability
наout of stock
. - Обработка:
-
ProductInput
дляSKU12345
обновлен.
-
- Конечный продукт: Конечный
Product
теперь имеетtitle: "Classic T-Shirt"
,price: 14.99 USD
иavailability: "out of stock"
.
Пример: обновление продукта с помощью дополнительных данных и правил
В этом примере показано, как правила ленты могут повлиять на обновление, в результате чего некоторые изменения будут применены, а другие — переопределены.
- Начальное состояние:
- Основной ввод:
en~US~SKU12345
имеетtitle: "Great T-Shirt"
иdescription: "A great short-sleeve t-shirt."
. - Дополнительный ввод: тот же продукт имеет запись в дополнительном источнике данных с
title: "Awesome T-Shirt"
иdescription: "An awesome short-sleeve t-shirt."
. - Правило подачи: установлено правило, берущее
title
из дополнительного источника данных. Дляdescription
правила нет. - Результат: Конечный обработанный
Product
имеетtitle: "Awesome T-Shirt"
иdescription: "A great short-sleeve t-shirt."
.
- Основной ввод:
- Запрос на обновление: вы отправляете запрос
patch
, чтобы обновить первичный источник данных, устанавливаяtitle
на"Fantastic T-Shirt"
иdescription
на"A fantastic short-sleeve t-shirt."
. - Обработка:
-
ProductInput
в первичном источнике данных обновлен и теперь имеетtitle: "Fantastic T-Shirt"
иdescription: "A fantastic short-sleeve t-shirt."
. - Работает конвейер переработки.
- Для
title
правило фида определяет, что значение из дополнительного источника данных (Awesome T-Shirt
) имеет приоритет, переопределяя ваше обновление. - Поскольку нет правила переопределения, для
description
используется обновленное значение из основного ввода (A fantastic short-sleeve t-shirt.
).
-
- Конечный продукт: Заголовок конечного
Product
осталсяAwesome T-Shirt
(ваше обновление было отменено), но его описание теперьA fantastic short-sleeve t-shirt.
(ваше обновление было применено).
Выбирайте между обновлениями и дополнительными источниками данных
Вы можете изменить данные о продукте, используя файл productinputs.patch
или добавляя данные в дополнительные источники данных. Оптимальный выбор зависит от вашей стратегии управления данными.
Чтобы избежать непредсказуемых результатов, мы рекомендуем вам не использовать одновременно productinputs.patch
и дополнительные источники данных для управления одними и теми же данными о продукте для одного и того же продукта.
Вот подробное сравнение:
Особенность | productinputs.patch (Обновления) | Дополнительные источники данных |
---|---|---|
Лучше всего подходит для | Быстрые, частые, частичные изменения существующих данных (например, цены, доступности). | Логически разделенные данные, управление различными атрибутами с помощью разных систем или сложные переопределения на основе правил. |
Механизм | Изменяет существующий ProductInput на месте. | Создает новый, отдельный ProductInput в дополнительном источнике данных. |
Степень детализации данных | Работает с определенными полями одного ProductInput . | Действует на весь ProductInput в дополнительном источнике. |
Упорство | Изменения сохраняются до тех пор, пока тот же ProductInput не будет перезаписан полной insert или другим patch . | Сохранение данных контролируется правилами фида. Может неограниченно переопределять первичные данные, если правила отдают им приоритет. |
Правила взаимодействия | Может использоваться без правил фида, поскольку обновляет существующий источник данных и ProductInput . | Требуется явная настройка правила для основного источника для привязки дополнительного источника. |
Настройка источника данных | Работает на основе существующего источника данных. Новые источники не требуются. | Требуется создание и управление отдельными дополнительными источниками данных и их связывание с помощью правил подачи. |