Przegląd

Struktura pliku danych dotyczących zamówień jest zdefiniowana przez schemat relacyjnych zasobów reklamowych. Pełny plik danych dotyczący porządkowania składa się z tych elementów najwyższego poziomu:

Ten diagram pokazuje, w jaki sposób elementy Service, Restaurant i Menu reprezentują jedną restaurację:

Schemat relacji między klasą menu restauracji
Rysunek 1. Ogólna relacja między elementami pliku danych do zamawiania: usługa, restauracja i menu.

Ogólne wskazówki

  • Liczba restauracji w pliku: każdy plik danych powinien reprezentować 1 restaurację z powiązanymi z nią elementami Service i Menu. Używaj nazw plików, które ułatwiają wyszukiwanie pliku z restauracją.

  • Format pliku danych: pliki danych muszą być sformatowane w plikach JSON rozdzielanych znakami nowego wiersza (w formacie ndjson).

  • Wartości daty i godziny: w przypadku właściwości, które wymagają wartości DateTime lub Time, używaj formatów określonych w formatach daty i godziny. Na przykład 2017-05-01T06:30:00+05:30 w przypadku DateTime i T08:08:00+05:30 w przypadku Time.

  • Identyfikatory: użyj właściwości @id do identyfikowania wszystkich unikalnych elementów w ramach typu encji. Maksymalna długość to 300 znaków. @id to unikalny identyfikator elementu danego typu, ale identyfikatory mogą się pokrywać w przypadku różnych jednostek. Załóżmy np., że zdefiniujesz encję Service z właściwością @id ustawioną na a16. Nie możesz utworzyć kolejnego elementu Service z wartością @id o wartości a16. Możesz jednak użyć a16 jako wartości @id elementu Menu.

  • Generowanie identyfikatorów: zadbaj o to, aby identyfikatory były stabilne – nie używaj identyfikatorów UUID ani w inny sposób zmieniaj ich/randomizuj między kolejnymi przesyłaniem plików danych. Ułatwia to rozwiązywanie problemów związanych z podmiotami.

  • Wartości null: nie używaj wartości null zamiast obiektów. Jeśli obiekt jest opcjonalny, musisz pominąć go w pliku danych.

Biblioteki klienta

Generator kodu klienta w sekcji Narzędzia jest dostępny do weryfikacji pełnego pliku danych służącego do składania zamówień.

Dalej
Szybki start