Atnaujinti · Taisyklės — Paieškos analitika ir taisyklės
Pakeiskite nurodytus „Paieškos analitika ir taisyklės“ duomenis. Privalomi laukai ir rašymo taisyklės aprašyti toliau.
PATCH/api/v1/search/rules/{rule_id}
- Tapatybės patvirtinimas
Bearer- Prieinama nuo plano
- STANDARD
- Būtinos teisės
search.rule:update
Kodo pavyzdžiai
Užklausos pavyzdys
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request PATCH \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--header 'Idempotency-Key: example-update_rule_api_v1_search_rules__rule_id__patch' \
--header 'Content-Type: application/json' \
--data-raw '{
"expected_version": 1,
"name": "Example"
}' \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/search/rules/example
PHP
<?php
declare(strict_types=1);
$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
isset($origin['query']) || isset($origin['fragment'])) {
throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
throw new RuntimeException('Invalid credential');
}
$headers = ['Idempotency-Key: example-update_rule_api_v1_search_rules__rule_id__patch', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/search/rules/example');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_SSL_VERIFYHOST => 2,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_TIMEOUT => 30,
CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
if (str_contains($line, ':')) {
[$name, $value] = explode(':', $line, 2);
$responseHeaders[strtolower(trim($name))] = trim($value);
}
return strlen($line);
},
]);
curl_setopt($handle, CURLOPT_POSTFIELDS, '{
"expected_version": 1,
"name": "Example"
}');
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
throw new RuntimeException('HTTP ' . $status . '; request_id=' .
($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;
Python
from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit
import requests # python -m pip install requests
base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
raise ValueError("Invalid credential")
headers = {'Idempotency-Key': 'example-update_rule_api_v1_search_rules__rule_id__patch'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n "expected_version": 1,\n "name": "Example"\n}'
if body is not None:
headers["Content-Type"] = "application/json"
with ExitStack() as stack:
session = stack.enter_context(requests.Session())
files = None
if False:
image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
if os.fstat(image.fileno()).st_size > 5242880:
raise ValueError("Image exceeds 5 MiB")
files = {"file": ("article.png", image, "image/png")}
response = session.request(
'PATCH', base_url + '/api/v1/search/rules/example', headers=headers,
data=body.encode("utf-8") if body is not None else None, files=files,
timeout=(5, 30), allow_redirects=False,
)
if not 200 <= response.status_code < 300:
raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
if False:
if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
raise ValueError("Unexpected image response")
with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
output.write(response.content)
else:
result = response.json() if response.content else None
print(json.dumps(result, ensure_ascii=False, indent=2))
Atsakymo pavyzdys 200
{
"data": {
"deleted": false,
"id": "example",
"version": 1
},
"meta": {
"request_id": "example"
}
}
Kaip tai veikia
- GET /api/v1/search/overview ir /api/v1/search/queries pateikia bendrą statistiką bei sugrupuotas užklausas.
- Užklausos pasikartojimus gaukite naudodami jos query_hash.
- Ataskaitų laikotarpiai yra 7, 30 arba 90 dienų, taikant kiekvieno prieigos taško išvardytus filtrus.
- Paieškos taisyklės susieja frazes su pasirinktais produktais ir kategorijomis; jas galima kurti, skaityti, keisti ir šalinti.
- Taisyklėms ir analitikai suteikiamos atskiros teisės; teisė skaityti paieškos statistiką nesuteikia prieigos prie konfigūracijos.
Parametrai
Kelio parametrai
rule_idEilutėPrivalomasPaieškos taisyklės identifikatorius.
Apribojimai
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Užklausos parametrai
localeEilutė nullNeprivalomasŠiai užklausai pasirinkta kalba.
Eilutė:minLength:2maxLength:20market_idEilutė nullNeprivalomasKonteksto prieigos taško grąžintas rinkos identifikatorius.
Apribojimai · Eilutė 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeEilutė nullNeprivalomasKonteksto prieigos taško grąžintas rinkos kodas.
Eilutė:minLength:1maxLength:16
Užklausos antraštės
Idempotency-KeyEilutėPrivalomasVienos loginės įrašymo operacijos unikalus identifikatorius.
minLength:1maxLength:128Apribojimai
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Užklausos turinys
application/json · Privalomas
RuleUpdate
category_idsMasyvas <Eilutė> NeprivalomasSusijusių kategorijų identifikatoriai.
maxItems:100Masyvas:minLength:1maxLength:63enabledLoginė reikšmėNeprivalomasAr šis nustatymas įjungtas.
expected_versionSveikasis skaičiusPrivalomasPrieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.
minimum:1maximum:2147483647market_idsMasyvas <Eilutė> NeprivalomasPasirinktų rinkų identifikatoriai.
maxItems:1000Masyvas:minLength:1maxLength:63market_scopeEilutėNeprivalomasAr išteklius taikomas visoms, ar pasirinktoms rinkoms.
Apribojimai
enum["all", "selected"]
nameEilutėNeprivalomasIštekliaus pavadinimas atitinkamame kontekste.
minLength:1maxLength:160phrasesMasyvas <Eilutė> NeprivalomasPaieškos taisyklėje naudojamos frazės.
maxItems:20Masyvas:minLength:1maxLength:255product_idsMasyvas <Eilutė> NeprivalomasSusijusių produktų identifikatoriai.
maxItems:100Masyvas:minLength:1maxLength:63
Atsakymai
Atsakymas 200
Visas modelis: ApiResponse_MutationData_
dataMutationDataPrivalomasSėkmingo atsakymo duomenys.
Laukai ·
datadeletedLoginė reikšmėPrivalomasAr šalinimas buvo atliktas.
idEilutėPrivalomasIštekliaus identifikatorius; išsaugokite grąžintą išraišką.
versionSveikasis skaičius nullPrivalomasIštekliaus versija lygiagrečių pakeitimų kontrolei.
metaContextPageMetaContextMetaPageMetaRequestMetaPrivalomasAtsakymo metaduomenys.
Laukai ·
metaVisas modelis:
ContextPageMetalocaleEilutėPrivalomasŠiai užklausai pasirinkta kalba.
market_codeEilutėPrivalomasKonteksto prieigos taško grąžintas rinkos kodas.
market_idEilutėPrivalomasKonteksto prieigos taško grąžintas rinkos identifikatorius.
paginationPaginationPrivalomasSkaidymo į puslapius pagal žymeklį metaduomenys.
request_idEilutėPrivalomasPrašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.
minLength:1maxLength:100
localeEilutėPrivalomasŠiai užklausai pasirinkta kalba.
market_codeEilutėPrivalomasKonteksto prieigos taško grąžintas rinkos kodas.
market_idEilutėPrivalomasKonteksto prieigos taško grąžintas rinkos identifikatorius.
request_idEilutėPrivalomasPrašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.
minLength:1maxLength:100
paginationPaginationPrivalomasSkaidymo į puslapius pagal žymeklį metaduomenys.
request_idEilutėPrivalomasPrašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.
minLength:1maxLength:100
request_idEilutėPrivalomasPrašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.
minLength:1maxLength:100
HTTP būsena
200- Sėkmingas atsakymas Schema
400- Netinkama užklausa
401- Būtinas tapatybės patvirtinimas
403- Prieiga uždrausta
404- Išteklius nerastas
409- Versijų konfliktas
422- Tikrinimo klaida
429- Viršytas užklausų limitas
Kitos HTTP būsenos (7)
405- Metodas neleidžiamas
413- Užklausa per didelė
415- Nepalaikomas formatas
500- Serverio klaida
502- API tinklų sietuvo klaida
503- Paslauga nepasiekiama
504- Baigėsi laukimo laikas
Klaidų katalogas: ErrorResponse
Antraštės
401
WWW-AuthenticateEilutėNeprivalomasServerio reikalaujama tapatybės patvirtinimo schema.
405
AllowEilutėNeprivalomasŠio ištekliaus palaikomi HTTP metodai.
429, 503
Retry-AfterSveikasis skaičiusNeprivalomasMažiausias laukimo laikas prieš kartojant, sekundėmis.
minimum:0