Δημιουργία · Κανόνες — Ανάλυση αναζήτησης και κανόνες
Εκτελέστε «Δημιουργία · Κανόνες» στο «Ανάλυση αναζήτησης και κανόνες» με τα δεδομένα που περιγράφονται παρακάτω.
POST/api/v1/search/rules
- Έλεγχος ταυτότητας
Bearer- Διαθέσιμο από
- STANDARD
- Απαιτούμενα δικαιώματα
search.rule:create
Παραδείγματα κώδικα
Παράδειγμα αιτήματος
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request POST \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--header 'Idempotency-Key: example-create_rule_api_v1_search_rules_post' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Example",
"phrases": [
"example"
],
"product_ids": [
"example"
]
}' \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/search/rules
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-create_rule_api_v1_search_rules_post', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/search/rules');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'POST',
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, '{
"name": "Example",
"phrases": [
"example"
],
"product_ids": [
"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-create_rule_api_v1_search_rules_post'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n "name": "Example",\n "phrases": [\n "example"\n ],\n "product_ids": [\n "example"\n ]\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(
'POST', base_url + '/api/v1/search/rules', 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))
Παράδειγμα απόκρισης 201
{
"data": {
"deleted": false,
"id": "example",
"version": 1
},
"meta": {
"request_id": "example"
}
}
Αρχές
- Τα GET /api/v1/search/overview και /api/v1/search/queries παρέχουν συνοπτικά στατιστικά και ομαδοποιημένες αναζητήσεις.
- Ανακτήστε τις εμφανίσεις μιας αναζήτησης μέσω του query_hash.
- Οι περίοδοι αναφοράς υποστηρίζουν 7, 30 ή 90 ημέρες, με τα φίλτρα που αναφέρει κάθε σημείο πρόσβασης.
- Οι κανόνες αναζήτησης συνδέουν φράσεις με επιλεγμένα προϊόντα και κατηγορίες και μπορούν να δημιουργούνται, να διαβάζονται, να ενημερώνονται ή να διαγράφονται.
- Οι κανόνες και τα αναλυτικά δεδομένα έχουν ξεχωριστά δικαιώματα.
- Η ανάγνωση στατιστικών αναζήτησης δεν παρέχει πρόσβαση στη διαμόρφωση.
Παράμετροι
Παράμετροι ερωτήματος
localeΣυμβολοσειρά nullΠροαιρετικόΓλώσσα που επιλέχθηκε για αυτό το αίτημα.
Συμβολοσειρά:minLength:2maxLength:20market_idΣυμβολοσειρά nullΠροαιρετικόΑναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.
Περιορισμοί · Συμβολοσειρά 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeΣυμβολοσειρά nullΠροαιρετικόΚωδικός αγοράς που επιστρέφει το endpoint πλαισίου.
Συμβολοσειρά:minLength:1maxLength:16
Κεφαλίδες αιτήματος
Idempotency-KeyΣυμβολοσειράΥποχρεωτικόΜοναδικό αναγνωριστικό μίας λογικής πράξης εγγραφής.
minLength:1maxLength:128Περιορισμοί
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Περιεχόμενο αιτήματος
application/json · Υποχρεωτικό
RuleCreate
category_idsΠίνακας <Συμβολοσειρά> ΠροαιρετικόΑναγνωριστικά σχετικών κατηγοριών.
maxItems:100Πίνακας:minLength:1maxLength:63enabledΛογική τιμήΠροαιρετικόΔείχνει αν η ρύθμιση είναι ενεργοποιημένη.
market_idsΠίνακας <Συμβολοσειρά> ΠροαιρετικόΑναγνωριστικά επιλεγμένων αγορών.
maxItems:1000Πίνακας:minLength:1maxLength:63market_scopeΣυμβολοσειράΠροαιρετικόΔείχνει αν ο πόρος ισχύει για όλες ή για επιλεγμένες αγορές.
Περιορισμοί
enum["all", "selected"]
nameΣυμβολοσειράΥποχρεωτικόΌνομα πόρου στο σχετικό πλαίσιο.
minLength:1maxLength:160phrasesΠίνακας <Συμβολοσειρά> ΥποχρεωτικόΦράσεις που χρησιμοποιεί ο κανόνας αναζήτησης.
minItems:1maxItems:20Πίνακας:minLength:1maxLength:255product_idsΠίνακας <Συμβολοσειρά> ΠροαιρετικόΑναγνωριστικά σχετικών προϊόντων.
maxItems:100Πίνακας:minLength:1maxLength:63
Αποκρίσεις
Απόκριση 201
Πλήρες μοντέλο: ApiResponse_MutationData_
dataMutationDataΥποχρεωτικόΔεδομένα επιτυχούς απόκρισης.
Πεδία ·
datadeletedΛογική τιμήΥποχρεωτικόΔείχνει αν εφαρμόστηκε η διαγραφή.
idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται.
versionΑκέραιος nullΥποχρεωτικόΈκδοση πόρου για έλεγχο ταυτόχρονων εγγραφών.
metaContextPageMetaContextMetaPageMetaRequestMetaΥποχρεωτικόΜεταδεδομένα απόκρισης.
Πεδία ·
metaΠλήρες μοντέλο:
ContextPageMetalocaleΣυμβολοσειράΥποχρεωτικόΓλώσσα που επιλέχθηκε για αυτό το αίτημα.
market_codeΣυμβολοσειράΥποχρεωτικόΚωδικός αγοράς που επιστρέφει το endpoint πλαισίου.
market_idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.
paginationPaginationΥποχρεωτικόΜεταδεδομένα σελιδοποίησης με cursor.
request_idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.
minLength:1maxLength:100
localeΣυμβολοσειράΥποχρεωτικόΓλώσσα που επιλέχθηκε για αυτό το αίτημα.
market_codeΣυμβολοσειράΥποχρεωτικόΚωδικός αγοράς που επιστρέφει το endpoint πλαισίου.
market_idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.
request_idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.
minLength:1maxLength:100
paginationPaginationΥποχρεωτικόΜεταδεδομένα σελιδοποίησης με cursor.
request_idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.
minLength:1maxLength:100
request_idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.
minLength:1maxLength:100
Κατάσταση HTTP
201- Δημιουργήθηκε πόρος Σχήμα
400- Μη έγκυρο αίτημα
401- Απαιτείται ταυτοποίηση
403- Δεν επιτρέπεται η πρόσβαση
404- Ο πόρος δεν βρέθηκε
409- Διένεξη έκδοσης
422- Αποτυχία επικύρωσης
429- Υπέρβαση ορίου αιτημάτων
Άλλες καταστάσεις HTTP (7)
405- Η μέθοδος δεν επιτρέπεται
413- Πολύ μεγάλο αίτημα
415- Μη υποστηριζόμενος τύπος
500- Σφάλμα διακομιστή
502- Σφάλμα πύλης API
503- Μη διαθέσιμη υπηρεσία
504- Υπέρβαση χρόνου αναμονής
Κατάλογος σφαλμάτων: ErrorResponse
Κεφαλίδες
201
LocationΣυμβολοσειράΠροαιρετικόΣχετικό URL του πόρου που δημιουργήθηκε.
401
WWW-AuthenticateΣυμβολοσειράΠροαιρετικόΣχήμα ελέγχου ταυτότητας που απαιτεί ο διακομιστής.
405
AllowΣυμβολοσειράΠροαιρετικόΜέθοδοι HTTP που υποστηρίζει αυτός ο πόρος.
429, 503
Retry-AfterΑκέραιοςΠροαιρετικόΕλάχιστος χρόνος αναμονής πριν από νέα προσπάθεια, σε δευτερόλεπτα.
minimum:0