Z tego artykułu dowiesz się, jak włączyć interfejs API menu na Twoim koncie i zintegrować z nim interfejs API. Poniżej znajdziesz szczegółowy opis procesu wdrażania i wymagań wstępnych. Zapoznaj się z tą stroną podczas planowania działań związanych z integracją.
- Konfiguracja – konfiguracja konta i planowanie procesu programowania.
- Programowanie – tworzenie i testowanie plików danych.
- Wprowadzenie – ocena danych przed wdrożeniem
Konfiguracja
Na tym etapie musisz potwierdzić, że Twoje konto w portalu dla partnerów jest w pełni skonfigurowane i gotowe do przyjmowania plików danych dotyczących statycznych menu. Jeśli masz już aktywną integrację OwG Redirect lub RwG, do której dodajesz metadane menu, Twoje istniejące konto zostanie ponownie użyte na potrzeby tej integracji. W przypadku integracji OwG Direct na tej platformie lub braku integracji tworzone jest nowe konto, a szczegóły dostępu są przekazywane e-mailem.
Otwórz swoje konto w portalu dla partnerów i otwórz stronę konfiguracji skrzynki referencyjnej Konfiguracja > Pliki danych. Do integracji pliku danych menu potrzebne są 2 skrzynki referencyjne: Ogólne i Sprzedawcy. Sprawdź, czy w obu skrzynkach referencyjnych skonfigurowany jest klucz publiczny SSH. Więcej informacji o konfigurowaniu kluczy SSH znajdziesz na tej stronie.
Ogólna skrzynka referencyjna może przyjmować różne pliki danych zgodne z różnymi schematami danych. Typ pliku danych akceptujący uporządkowane dane menu nazywa się google.food_menu. Zwykle jest on domyślnie włączony na Twoim koncie na początku rejestracji. Jeśli przy próbie przesłania pliku danych zobaczysz komunikat o błędzie:
„Nie udało się przetworzyć pliku danych. Podczas analizowania Twojego pliku danych wystąpił błąd wewnętrzny. Opcja „google.food_menu” nie jest włączona. Popraw ten plik i spróbuj ponownie.", skontaktuj się z osobą kontaktową w Google, aby włączyć ten typ pliku danych.
Na koniec otwórz stronę Konfiguracja > Informacje kontaktowe i upewnij się, że wszystkie dane kontaktowe są aktualne.
Programowanie
Etap programowania obejmuje główną część działań wdrożeniowych, czyli generowanie i testowanie plików danych. Pliki danych muszą być tworzone i przesyłane codziennie do docelowej skrzynki referencyjnej. Przetwarzanie plików danych przesłanych w trybie piaskownicy powinno rozpocząć się w ciągu godziny od ich przesłania. Pliki danych produkcyjnych są przetwarzane raz dziennie o 12:00 według strefy czasowej PST. Przetwarzamy tylko ostatnio przesłany plik danych. Podczas generowania plików danych korzystaj ze specyfikacji i przykładów. Chociaż specyfikacja jest przedstawiona w formacie protobuf, zalecamy przesyłanie plików danych w formacie JSON, ponieważ łatwiej jest rozwiązywać problemy. Dlatego przykłady plików danych są też dostępne w formacie JSON.
Jeden plik danych można szybko przetestować za pomocą narzędzia online walidatora plików danych, które sprawdza, czy plik jest zgodny ze specyfikacją. Narzędzie pokazuje, czy plik jest zgodny ze schematem danych, a jeśli nie, wyświetla listę błędów. Jeśli chcesz przetestować cały plik danych, który składa się z wielu plików, prześlij go w środowisku piaskownicy, a po zakończeniu przetwarzania zapoznaj się z wynikami w Portalu dla partnerów. Podczas przetwarzania pliku danych są stosowane dodatkowe reguły weryfikacji, które pozwalają przetestować logikę biznesową i jakość danych.
Uruchom
Etap wprowadzania na rynek można rozpocząć po zakończeniu prac integracyjnych, gdy plik danych o produktach będzie prawidłowo odzwierciedlał cały asortyment menu restauracji.
Wymagania wstępne uruchomienia
Aby można było uruchomić integrację, muszą być spełnione te warunki:
- Pliki danych są przetwarzane w środowisku produkcyjnym bez błędów.
- Produkcyjny plik danych zawiera pełny asortyment ograniczony do tej integracji na początku tej integracji.
- Większość danych sprzedawcy jest zgodna z lokalizacjami w Mapach Google.
- Pliki danych w wersji produkcyjnej przeszły ocenę jakości danych.
- Integracja jest zgodna ze wszystkimi zasadami i wymaganiami dotyczącymi menu żywieniowego.
Ocena danych
Gdy pliki danych produkcyjnych zostaną pozyskane bez błędów, może zachodzić wewnętrzny proces oceny jakości danych menu. Ten proces ma na celu znajdowanie niespójności w jakości danych, np. treści niezwiązanych z jedzeniem w opisach dań, niezgodności w nazwach dań, cenach itp. W przypadku takich ustaleń przekażemy opinię zespołowi programistów.