Ta strona została przetłumaczona przez Cloud Translation API.

Aktualizacje w czasie rzeczywistym

W tej sekcji opisujemy, jak wysyłać pilne aktualizacje zasobów reklamowych podmiotom Google. Interfejs Realtime Updates API umożliwia przekazywanie aktualizacji i usuwanie tych zasobach w zasobach piaskownicy lub produkcyjnych w czasie zbliżonym do rzeczywistego.

Ta funkcja służy przede wszystkim do wprowadzania aktualizacji, których nie można przewidzieć. takie jak zamknięcia awaryjne, usunięcie pozycji z menu czy aktualizacja ceny elementu menu, co musi szybko znaleźć się w interfejsie Google. Jeśli zmiana nie muszą być widoczne od razu, możesz użyć pozyskiwania zbiorczego. Aktualizacje w czasie rzeczywistym są przetwarzane w nie dłużej niż 5 minut.

Wymagania wstępne

Przed wdrożeniem aktualizacji w czasie rzeczywistym wymagane są następujące elementy:

Interfejs Maps Booking API jest włączony:
- W GCP otwórz Interfejsy API Usługi > Biblioteka
- Wyszukaj „Google Maps Booking API”.
- Znajdź instancję piaskownicy („Google Maps Booking API (Dev)”) i kliknij Włącz
- Znajdź instancję produkcyjną („Google Maps Booking API”) i kliknij Włącz
Zostanie utworzone konto usługi z przypisaną rolą edytującego Twój projekt GCP. Dla: więcej szczegółów znajdziesz w Zakładanie konta.
Pliki danych produkcyjnych lub piaskownicy są hostowane i przetwarzane. Aby dowiedzieć się więcej, Więcej informacji znajdziesz w sekcji Przetwarzanie zbiorcze.
Do uwierzytelniania interfejsu API zaleca się zainstalowanie Biblioteka klienta Google w języku wyboru. Używaj „https://www.googleapis.com/auth/mapsbooking” jako protokołu OAuth. zakresu. Wymienione poniżej przykładowe fragmenty kodu korzystają z tych bibliotek. W przeciwnym razie musisz ręcznie obsługiwać wymianę tokenów, zgodnie z Korzystanie z protokołu OAuth 2.0 na potrzeby dostępu do interfejsów API Google

Omówienie

Interfejs API aktualizacji w czasie rzeczywistym obsługuje 2 typy operacji. Pierwsza operacja to upsert do aktualizowania istniejących encji. a druga operacja to usuwanie, czyli usunięcie encji z zasobów reklamowych. Obie opcje wykonywane są operacje na zakresie jednostek wymienionych w treści żądania. Ty może wprowadzać zmiany w maksymalnie 1000 elementów w jednym wywołaniu interfejsu API. Interfejs API akceptuje wszystkie przychodzące żądania i umieszcza je w kolejce do dalszego przetworzenia. W związku z tym żądania RTU są przetwarzane asynchronicznie.

Interfejs API aktualizacji w czasie rzeczywistym działa w 2 środowiskach: piaskownicy i produkcji. Środowisko piaskownicy używane do testowania żądań do interfejsu API oraz środowiska produkcyjnego w celu aktualizacji treści widocznych dla użytkowników korzystających z usługi Order-to-End. Nazwy hostów w obu środowiskach:

Piaskownica – partnerdev-mapsbooking.googleapis.com
Produkcja – mapsbooking.googleapis.com

Punkty końcowe

Interfejs Real-time Updates API ujawnia 2 punkty końcowe do obsługi żądań przychodzących dotyczące aktualizacji asortymentu:

UPSERT – /v1alpha/inventory/partners/PARTNER_ID/feeds/owg.v2/record:batchPush
USUŃ – /v1alpha/inventory/partners/PARTNER_ID/feeds/owg.v2/record:batchDelete

Parametr PARTNER_ID znajdziesz w Centrum działań. wyświetlany jako Identyfikator partnera na stronie Konto i użytkownicy, jak widać na stronie zrzut ekranu poniżej.

Identyfikator partnera w Portalu dla partnerów

Biorąc pod uwagę 10000001 jako wartość PARTNER_ID jako przykład z metody zrzut ekranu powyżej, pełne adresy URL do wysyłania żądań do interfejsu API w trybie piaskownicy oraz jak w poniższych przykładach.

# Sandbox UPSERT
https://partnerdev-mapsbooking.googleapis.com/v1alpha/inventory/partners/10000001/feeds/owg.v2/record:batchPush

# Sandbox DELETE
https://partnerdev-mapsbooking.googleapis.com/v1alpha/inventory/partners/10000001/feeds/owg.v2/record:batchDelete

# Production UPSERT
https://mapsbooking.googleapis.com/v1alpha/inventory/partners/10000001/feeds/owg.v2/record:batchPush

# Production DELETE
https://mapsbooking.googleapis.com/v1alpha/inventory/partners/10000001/feeds/owg.v2/record:batchDelete

Aktualizuję elementy

Aby zaktualizować elementy w zasobach reklamowych, użyj punktu końcowego UPSERT, i wysyłanie żądań HTTP POST. Każde żądanie POST musi zawierać parametr PARTNER_ID wraz z ładunkiem JSON zawierającym danych strukturalnych dowolnego typu wymienionego w schemacie zasobów reklamowych.

Wstaw ładunek żądania upsert

Treść żądania to obiekt JSON z listą rekordów. Każdy rekord odpowiada aktualizowanej encji. Składa się z pola data_record z ładunkiem encji zakodowanym w Base64 i generation_timestamp wskazujący czas aktualizacji elementu:

  {
    "records": [
      {
        "data_record":"BASE_64_ENCODED_ENTITY",
        "generation_timestamp":"UPDATE_TIMESTAMP"
      }
    ]
  }

W powyższym ładunku zastąp następujące elementy:

BASE_64_ENCODED_ENTITY: ciąg znaków JSON zakodowany w standardzie Base64 podmiotu zabezpieczeń. Zdekodowana encja w formacie JSON powinien mieć taką samą strukturę jak w specyfikacji pliku danych, na przykład:
```
{"@type":"MenuSection","name":"My Updated Menu Section","menuId":{"@id":"10824","displayOrder":1},"@id":"853705"}
```
UPDATE_TIMESTAMP: pamiętaj, aby podać sygnaturę czasową miejsca została wygenerowana w systemach backendu. Ta sygnatura czasowa jest używana do: zapewnić prawidłową kolejność aktualizacji asortymentu. Jeśli to pole nie zostało uwzględnione, zostanie ustawiony na moment, w którym Google otrzyma żądanie. Podczas aktualizowania elementu za pomocą żądania batchPush, pole generation_timestamp ma postać używany do obsługi wersji encji. Zobacz oczekiwaną wartość format wartości czasowych w relacyjnych zasobach reklamowych schemat.

Każda prośba o aktualizację w czasie rzeczywistym musi spełniać te warunki:

Rozmiar ładunku nie powinien przekraczać 5 MB. Podobnie jak w przypadku wsadu plików danych, zalecamy usunięcie odstępów, aby zebrać więcej danych.
Żądanie batchPush może zawierać maksymalnie 1000 elementów.

Przykłady

Przykład 1. Aktualizowanie informacji o restauracji

Załóżmy, że chcesz pilnie zaktualizować numer telefonu do restauracji. Twoje update zawiera kod JSON dla całej restauracji.

Weźmy na przykład wsadowy plik danych, który wygląda tak:

{
  "@type": "Restaurant",
  "@id": "restaurant12345",
  "name": "Some Restaurant",
  "url": "https://www.provider.com/somerestaurant",
  "telephone": "+16501234570",
  "streetAddress": "345 Spear St",
  "addressLocality": "San Francisco",
  "addressRegion": "CA",
  "postalCode": "94105",
  "addressCountry": "US",
  "latitude": 37.472842,
  "longitude": -122.217144
}

Wtedy aktualizacja w czasie rzeczywistym przez żądanie HTTP POST będzie wyglądać tak:

JSON

Uwaga: to nie jest prawidłowe żądanie do interfejsu API – Plik data_record został zdekodowany i sformatowany pod kątem czytelności. Zobacz na karcie Base64.

POST v1alpha/inventory/partners/PARTNER_ID/feeds/owg.v2/record:batchPush
Host: mapsbooking.googleapis.com
Content-Type: application/json
{
  "records": [
    {
      "data_record": {
        "@type": "Restaurant",
        "@id": "restaurant12345",
        "name": "Some Restaurant",
        "url": "https://www.provider.com/somerestaurant",
        "telephone": "+16501234570",
        "streetAddress": "345 Spear St",
        "addressLocality": "San Francisco",
        "addressRegion": "CA",
        "postalCode": "94105",
        "addressCountry": "US",
        "latitude": 37.472842,
        "longitude": -122.217144
      }
      "generation_timestamp": "2022-08-19T17:11:10.750Z"
    }
  ]
}

Base64

Ten sam przykład z ładunkiem zakodowanym w standardzie Base64.

POST v1alpha/inventory/partners/PARTNER_ID/feeds/owg.v2/record:batchPush
Host: mapsbooking.googleapis.com
Content-Type: application/json
{
  "records": [
    {
      "data_record": "eyJAdHlwZSI6IlJlc3RhdXJhbnQiLCJAaWQiOiJyZXN0YXVyYW50MTIzNDUiLCJuYW1lIjoiU29tZSBSZXN0YXVyYW50IiwidXJsIjoiaHR0cHM6Ly93d3cucHJvdmlkZXIuY29tL3NvbWVyZXN0YXVyYW50IiwidGVsZXBob25lIjoiKzE2NTAxMjM0NTcwIiwic3RyZWV0QWRkcmVzcyI6IjM0NSBTcGVhciBTdCIsImFkZHJlc3NMb2NhbGl0eSI6IlNhbiBGcmFuY2lzY28iLCJhZGRyZXNzUmVnaW9uIjoiQ0EiLCJwb3N0YWxDb2RlIjoiOTQxMDUiLCJhZGRyZXNzQ291bnRyeSI6IlVTIiwibGF0aXR1ZGUiOjM3LjQ3Mjg0MiwibG9uZ2l0dWRlIjotMTIyLjIxNzE0NH0="
      "generation_timestamp": "2022-08-19T17:11:10.750Z"
    }
  ]
}

Przykład 2. Aktualizowanie wielu restauracji

Aby zaktualizować 2 elementy restauracji w pojedynczym wywołaniu interfejsu API, żądanie HTTP POST będzie wyglądać tak:

JSON

Uwaga: to nie jest prawidłowe żądanie do interfejsu API – Plik data_record został zdekodowany i sformatowany pod kątem czytelności. Zobacz na karcie Base64.

POST v1alpha/inventory/partners/PARTNER_ID/feeds/owg.v2/record:batchPush
Host: mapsbooking.googleapis.com
Content-Type: application/json
{
  "records": [
    {
      "data_record": {
        "@type": "Restaurant",
        "@id": "restaurant12345",
        "name": "Some Restaurant",
        "url": "https://www.provider.com/somerestaurant",
        "telephone": "+16501235555",
        "streetAddress": "345 Spear St",
        "addressLocality": "San Francisco",
        "addressRegion": "CA",
        "postalCode": "94105",
        "addressCountry": "US",
        "latitude": 37.472842,
        "longitude": -122.217144
      },
      "generation_timestamp": "2022-08-19T17:11:10.850Z"
    },
    {
      "data_record": {
        "@type": "Restaurant",
        "@id": "restaurant123",
        "name": "Some Other Restaurant",
        "url": "https://www.provider.com/someotherrestaurant",
        "telephone": "+16501231235",
        "streetAddress": "385 Spear St",
        "addressLocality": "San Mateo",
        "addressRegion": "CA",
        "postalCode": "94115",
        "addressCountry": "US"
      },
      "generation_timestamp": "2022-08-19T17:11:10.850Z"
    }
  ]
}

Base64

Ten sam przykład z ładunkiem zakodowanym w standardzie Base64.

POST v1alpha/inventory/partners/PARTNER_ID/feeds/owg.v2/record:batchPush
Host: mapsbooking.googleapis.com
Content-Type: application/json
{
  "records": [
    {
      "data_record": "eyJAdHlwZSI6IlJlc3RhdXJhbnQiLCJAaWQiOiJyZXN0YXVyYW50MTIzNDUiLCJuYW1lIjoiU29tZSBSZXN0YXVyYW50IiwidXJsIjoiaHR0cHM6Ly93d3cucHJvdmlkZXIuY29tL3NvbWVyZXN0YXVyYW50IiwidGVsZXBob25lIjoiKzE2NTAxMjM1NTU1Iiwic3RyZWV0QWRkcmVzcyI6IjM0NSBTcGVhciBTdCIsImFkZHJlc3NMb2NhbGl0eSI6IlNhbiBGcmFuY2lzY28iLCJhZGRyZXNzUmVnaW9uIjoiQ0EiLCJwb3N0YWxDb2RlIjoiOTQxMDUiLCJhZGRyZXNzQ291bnRyeSI6IlVTIiwibGF0aXR1ZGUiOjM3LjQ3Mjg0MiwibG9uZ2l0dWRlIjotMTIyLjIxNzE0NH0=",
      "generation_timestamp": "2022-08-19T17:11:10.850Z"
    },
    {
      "data_record": "eyJAdHlwZSI6IlJlc3RhdXJhbnQiLCJAaWQiOiJyZXN0YXVyYW50MTIzIiwibmFtZSI6IlNvbWUgT3RoZXIgUmVzdGF1cmFudCIsInVybCI6Imh0dHBzOi8vd3d3LnByb3ZpZGVyLmNvbS9zb21lcmVzdGF1cmFudCIsInRlbGVwaG9uZSI6IisxNjUwMTIzMTIzNSIsInN0cmVldEFkZHJlc3MiOiIzODUgU3BlYXIgU3QiLCJhZGRyZXNzTG9jYWxpdHkiOiJTYW4gTWF0ZW8iLCJhZGRyZXNzUmVnaW9uIjoiQ0EiLCJwb3N0YWxDb2RlIjoiOTQxMTUiLCJhZGRyZXNzQ291bnRyeSI6IlVTIn0=",
      "generation_timestamp": "2022-08-19T17:11:10.850Z"
    }
  ]
}

Przykład 3. Aktualizowanie ceny pozycji menu

Przyjmijmy, że musisz zmienić cenę pozycji w menu.

Weźmy na przykład wsadowy plik danych, który wygląda tak:

{
  "@type": "MenuItemOffer",
  "@id": "menuitemoffer6680262",
  "sku": "offer-cola",
  "menuItemId": "menuitem896532",
  "price": 2,
  "priceCurrency": "USD"
}

Gdy to zrobisz, aktualizacja w czasie rzeczywistym przez POST będzie wyglądać tak:

JSON

Uwaga: to nie jest prawidłowe żądanie do interfejsu API – Plik data_record został zdekodowany i sformatowany pod kątem czytelności. Zobacz na karcie Base64.

POST v1alpha/inventory/partners/PARTNER_ID/feeds/owg.v2/record:batchPush
Host: mapsbooking.googleapis.com
Content-Type: application/json
{
  "records": [
    {
      "data_record": {
        "@type": "MenuItemOffer",
        "@id": "menuitemoffer6680262",
        "sku": "offer-cola",
        "menuItemId": "menuitem896532",
        "price": 2,
        "priceCurrency": "USD"
      },
      "generation_timestamp": "2022-08-19T17:20:10Z"
    }
  ]
}

Base64

Ten sam przykład z ładunkiem zakodowanym w standardzie Base64.

POST v1alpha/inventory/partners/PARTNER_ID/feeds/owg.v2/record:batchPush
Host: mapsbooking.googleapis.com
Content-Type: application/json
{
  "records": [
    {
      "data_record": "eyJAdHlwZSI6Ik1lbnVJdGVtT2ZmZXIiLCJAaWQiOiJtZW51aXRlbW9mZmVyNjY4MDI2MiIsInNrdSI6Im9mZmVyLWNvbGEiLCJtZW51SXRlbUlkIjoibWVudWl0ZW04OTY1MzIiLCJwcmljZSI6MiwicHJpY2VDdXJyZW5jeSI6IlVTRCJ9",
      "generation_timestamp": "2022-08-19T17:20:10Z"
    }
  ]
}

Dodawanie encji

Nie dodawaj nowych elementów w czasie rzeczywistym, ponieważ może to doprowadzić do niespójności danych. Zamiast tego użyj plików zbiorczych jak opisano w przypadku pozyskiwania zbiorczego.

Usuwam jednostki

Aby usunąć elementy z zasobów reklamowych, użyj opcji USUŃ punktu końcowego i wysyłać żądania HTTP POST. Każde żądanie POST musi dołącz parametr PARTNER_ID wraz z ładunkiem JSON zawierający identyfikator dowolnego elementu w Twoich zasobach reklamowych.

Usuń ładunek żądania

Treść żądania usunięcia ma strukturę podobną do żądanie aktualizacji. Zawiera też listę rekordów z polami data_record i delete_time:

  {
    "records": [
      {
        "data_record":"BASE_64_ENCODED_REFERENCE",
        "delete_time": "DELETE_TIMESTAMP"
      }
    ]
  }

W powyższym ładunku zastąp następujące elementy:

BASE_64_ENCODED_REFERENCE: ciąg znaków JSON zakodowany w standardzie Base64 odniesienia do elementu, który jest usuwany. Plik referencyjny składa się tylko z z typu i identyfikatora encji, na przykład reprezentacji obiektu JSON odniesienie do sekcji MenuSection:
```
{"@type":"MenuSection","@id":"853705"}
```
DELETE_TIMESTAMP: pamiętaj, aby podać sygnaturę czasową podczas została usunięta w systemie backendu. Ta sygnatura czasowa jest używana do: określają kolejność, w jakiej mają zostać usunięte zasoby reklamowe.

Żądanie batchDelete może zawierać maksymalnie 1000 elementów.

Przykłady

Przykład 1: usuwanie 2 elementów `MenuItem`

Aby można było usunąć 2 pozycje menu w pojedynczym wywołaniu interfejsu API, żądanie HTTP POST będzie wyglądać tak: następujące:

JSON

Uwaga: to nie jest prawidłowe żądanie do interfejsu API – Plik data_record został zdekodowany i sformatowany pod kątem czytelności. Zobacz na karcie Base64.

POST v1alpha/inventory/partners/PARTNER_ID/feeds/owg.v2/record:batchDelete
Host: mapsbooking.googleapis.com
Content-Type: application/json
{
  "records": [
    {
      "data_record": {
        "@type": "MenuItem",
        "@id": "item_1234"
      },
      "delete_time": "2022-08-21T15:23:00.000Z"
    },
    {
      "data_record": {
        "@type": "MenuItem",
        "@id": "item_5678"
      },
      "delete_time": "2022-08-21T15:23:00.000Z"
    }
  ]
}

Base64

Ten sam przykład z ładunkiem zakodowanym w standardzie Base64.

POST v1alpha/inventory/partners/PARTNER_ID/feeds/owg.v2/record:batchDelete
Host: mapsbooking.googleapis.com
Content-Type: application/json
{
  "records": [
    {
      "data_record": "eyJAdHlwZSI6Ik1lbnVJdGVtIiwiQGlkIjoiaXRlbV8xMjM0In0="
      "delete_time": "2022-08-21T15:23:00.000Z"
    },
    {
      "data_record": "eyJAdHlwZSI6Ik1lbnVJdGVtIiwiQGlkIjoiaXRlbV81Njc4In0="
      "delete_time": "2022-08-21T15:23:00.000Z"
    },
  ]
}

Przykład 2. Usuwanie encji `Restaurant`

Załóżmy, że chcesz usunąć restaurację z pliku danych wsadowych. Musisz usunąć tylko element restauracji. Nie usuwaj podelementów, takich jak usług i menu, ponieważ zostaną one automatycznie usunięte.

Przykładowe żądanie usunięcia elementu restauracja o identyfikatorze https://www.provider.com/restaurant/12345:

JSON

Uwaga: to nie jest prawidłowe żądanie do interfejsu API – Plik data_record został zdekodowany i sformatowany pod kątem czytelności. Zobacz na karcie Base64.

POST v1alpha/inventory/partners/PARTNER_ID/feeds/owg.v2/record:batchDelete
Host: mapsbooking.googleapis.com
Content-Type: application/json
{
  "records": [
    {
      "data_record": {
        "@type": "Restaurant",
        "@id": "https://www.provider.com/restaurant/12345"
      },
      "delete_time": "2022-08-19T17:11:10.750Z"
    }
  ]
}

Base64

Ten sam przykład z ładunkiem zakodowanym w standardzie Base64.

POST v1alpha/inventory/partners/PARTNER_ID/feeds/owg.v2/record:batchDelete
Host: mapsbooking.googleapis.com
Content-Type: application/json
{
  "records": [
    {
      "data_record": "ewogICJAdHlwZSI6ICJSZXN0YXVyYW50IiwKICAiQGlkIjogImh0dHBzOi8vd3d3LnByb3ZpZGVyLmNvbS9yZXN0YXVyYW50LzEyMzQ1Igp9"
      "delete_time": "2022-08-19T17:11:10.750Z"
    }
  ]
}

Weryfikacja Kody odpowiedzi interfejsu API

W przypadku wywołań interfejsu API aktualizacji w czasie rzeczywistym wykonywane są 2 typy weryfikacji:

Poziom żądania – weryfikacje sprawdzają, czy ładunek jest zgodny z Upert lub delete schematu, a każdy element data_record zawiera zarówno pola @id, jak i @type. Te kontrole są synchroniczne, a wyniki są zwracane do interfejsu API treść odpowiedzi. Kod odpowiedzi 200 i pusta treść JSON {} oznaczają, że: zaliczonych weryfikacji, a elementy w tym żądaniu zostały umieszczone w kolejce o przetwarzaniu danych. Kod odpowiedzi inny niż 200 oznacza co najmniej jeden z tych weryfikacja zakończyła się niepowodzeniem i całe żądanie zostało odrzucone (w tym wszystkie encji w ładunku). Jeśli na przykład w data_record brakowało elementu @type, zostanie zwrócona ta odpowiedź na błąd:

{
  "error": {
    "code": 400,
    "message": "Record:{\"@id\":\"2717/86853/DELIVERY\",\"applicableServiceType\":[\"DELIVERY\",\"TAKEOUT\"],\"menuId\":[{\"@id\":\"2717/DELIVERY\",\"displayOrder\":1},{\"@id\":\"2717/TAKEOUT\",\"displayOrder\":2}],\"name\":\"Salad\",\"offeredById\":[\"2717\"]} has following errors: \nThe entity type could not be extracted from the entity value.\n",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.DebugInfo",
        "detail": "[ORIGINAL ERROR] generic::invalid_argument: Failed to parse one or more rtu records. Record:{\"@id\":\"2717/86853/DELIVERY\",\"applicableServiceType\":[\"DELIVERY\",\"TAKEOUT\"],\"menuId\":[{\"@id\":\"2717/DELIVERY\",\"displayOrder\":1},{\"@id\":\"2717/TAKEOUT\",\"displayOrder\":2}],\"name\":\"Salad\",\"offeredById\":[\"2717\"]} has following errors: \nThe entity type could not be extracted from the entity value.\n [google.rpc.error_details_ext] { message: \"Record:{\\\"@id\\\":\\\"2717/86853/DELIVERY\\\",\\\"applicableServiceType\\\":[\\\"DELIVERY\\\",\\\"TAKEOUT\\\"],\\\"menuId\\\":[{\\\"@id\\\":\\\"2717/DELIVERY\\\",\\\"displayOrder\\\":1},{\\\"@id\\\":\\\"2717/TAKEOUT\\\",\\\"displayOrder\\\":2}],\\\"name\\\":\\\"Salad\\\",\\\"offeredById\\\":[\\\"2717\\\"]} has following errors: \\nThe entity type could not be extracted from the entity value.\\n\" }"
      }
    ]
  }
}

Poziom encji – każdy element w ładunku jest weryfikowany pod kątem schemat relacyjny. Problemy napotkane na tej fazie weryfikacji nie są zgłaszane w interfejsie API . Są one raportowane tylko w Zgłaszanie naruszeń w czasie rzeczywistym (RTU) panelu.

Limity interfejsu API

Aktualizacje interfejsu API w czasie rzeczywistym mają limit 1500 żądań co 60 sekund, czyli 25 żądań żądań na sekundę. W przypadku przekroczenia limitu Google w odpowiedzi przesyła następujący komunikat o błędzie:

{
  "error": {
    "code": 429,
    "message": "Insufficient tokens for quota ...",
    "status": "RESOURCE_EXHAUSTED",
    "details": [...]
  }
}

Aby to zrobić, ponawiaj wywołanie w znacznie większych odstępach czasu, aż sukces. Jeśli regularnie wyczerpujesz limit, zastanów się nad dodaniem większej liczby elementów w jednym żądaniu do interfejsu API. Jedno wywołanie interfejsu API może zawierać do 1000 elementów.

Przykładowe fragmenty kodu

Poniżej znajdziesz kilka przykładów użycia interfejsu API do aktualizacji w czasie rzeczywistym w różnych języki. W tych przykładach korzystamy z bibliotek uwierzytelniania Google do uwierzytelniania pliku klucza konta usługi wygenerowanego podczas Zakładanie konta. Rozwiązania alternatywne znajdziesz tutaj: Używanie protokołu OAuth 2.0 w aplikacjach międzyserwerowych. Rozważ użycie schematu dostępnego w sekcji Generuj biblioteki klienta, aby wygenerować kod źródłowy na potrzeby typów zasobów reklamowych i obiektów aktualizacji w czasie rzeczywistym.

Aktualizuję elementy

Node.js

Ten kod korzysta z biblioteki uwierzytelniania Google dla Node.js.

/* Sample code for Real-time update batchPush implementation.
 *
 * Required libraries:
 * - google-auth-library
 */

const {JWT} = require('google-auth-library');

// ACTION REQUIRED: Change this to the path of the service account client secret
// file downloaded from the Google Cloud Console.
const serviceAccountJson = require('./service-account.json');

// ACTION REQUIRED: Change this to your Partner ID received from Google.
// The Partner ID is available on the Partner Portal.
const PARTNER_ID = 1234;

const HOST = {
  prod: 'https://mapsbooking.googleapis.com',
  sandbox: 'https://partnerdev-mapsbooking.googleapis.com'
};

// ACTION REQUIRED: Change to 'prod' for production
const ENV = 'sandbox';

// Feed name for Order with Google including the version.
const FEED_NAME = 'owg.v2';

// Endpoint url
const url = `${HOST[ENV]}/v1alpha/inventory/partners/${PARTNER_ID}/feeds/${
    FEED_NAME}/record:batchPush`;

/**
 * Send a Real-time update request to update/insert entities
 */
async function batchUpsert(entities) {
  /**
   * Sign JWT token using private key from service account secret file
   * provided. The client can be created without providing a service account
   * secret file by implementing Application Default Credentials.
   * https://github.com/googleapis/google-auth-library-nodejs
   */
  const client = new JWT({
    email: serviceAccountJson.client_email,
    key: serviceAccountJson.private_key,
    scopes: ['https://www.googleapis.com/auth/mapsbooking'],
  });
  const request = {records: toPushRecords(entities)};
  const body = JSON.stringify(request);
  try {
    const response = await client.request({
      method: 'POST',
      url,
      data: body,
      headers: {'Content-Type': 'application/json'}
    });
    console.log('request body:', body);
    console.log('response status:', response.status);
    console.log(
        'response data:', response.data);  // successful response returns '{}'
  } catch (error) {
    console.log('error:', error);
  }
}

/**
 * Maps array of entities to records for batch push requests
 */
const toPushRecords = (entities) => {
  return entities.map((entity) => {
    // Using dateModified to set generation_timestamp. Defaulting to the
    // current timestamp for records that do not have dateModified.
    const generation_timestamp =
        entity.dateModified ? entity.dateModified : new Date().toISOString();
    return {data_record: btoa(JSON.stringify(entity)), generation_timestamp};
  });
};

// Call batchUpsert with example entities. dateModified is optional and is
// used to hold the actual timestamp when the entity was updated/created.
batchUpsert([
  {
    '@type': 'MenuItemOffer',
    '@id': '6680261',
    'menuItemId': '18931508',
    'price': 15.5,
    'priceCurrency': 'USD',
    'applicableServiceType': ['DELIVERY', 'TAKEOUT'],
    'inventoryLevel': 0,
    'dateModified': '2022-06-19T15:43:50.970Z'
  },
  {
    '@type': 'MenuItemOffer',
    '@id': '6680262',
    'menuItemId': '18931509',
    'price': 25.5,
    'priceCurrency': 'USD',
    'applicableServiceType': ['DELIVERY', 'TAKEOUT'],
    'inventoryLevel': 0,
    'dateModified': '2022-06-19T15:43:50.970Z'
  }
]);

Python

Ten kod korzysta z biblioteki uwierzytelniania Google dla Pythona.

"""Sample code for the Real-time update batchPush implementation."""

# Required libraries:
# - google-auth

import base64
import datetime
import json
from google.auth.transport.requests import AuthorizedSession
from google.oauth2 import service_account

# ACTION REQUIRED: Change this to the Partner ID received from Google.
# Partner ID is available on the Partner Portal.
# https://partnerdash.google.com/apps/reservewithgoogle
_PARTNER_ID = '1234'

# ACTION REQUIRED: Change this to the path of the service account client secret
# file downloaded from the Google Cloud Console.
_SERVICE_ACCOUNT_KEY_JSON_FILE = 'service-account-creds.json'

_HOST_MAP = {
    'sandbox': 'https://partnerdev-mapsbooking.googleapis.com',
    'prod': 'https://mapsbooking.googleapis.com'
}

# ACTION REQUIRED: Change to 'prod' for production
_ENV = 'sandbox'

# Feed name for Order with Google including the version.
_FEED_NAME = 'owg.v2'

_ENDPOINT = '{}/v1alpha/inventory/partners/{}/feeds/{}/record:batchPush'.format(
    _HOST_MAP[_ENV], _PARTNER_ID, _FEED_NAME)


def batch_upsert(entities):
  """Makes a batchPush request using the Real-time updates REST service.

  Args:
      entities: The list of entity objects to update or add.
  """

  # Creates credentials by providing a json file. Credentials can also be
  # provided by implementing Application Default Credentials.
  # https://googleapis.dev/python/google-auth/latest/user-guide.html
  credentials = service_account.Credentials.from_service_account_file(
      _SERVICE_ACCOUNT_KEY_JSON_FILE,
      scopes=['https://www.googleapis.com/auth/mapsbooking'])
  authorized_session = AuthorizedSession(credentials)

  # JSON request object
  batch_request = {'records': [create_push_record(x) for x in entities]}
  response = authorized_session.post(_ENDPOINT, json=batch_request)
  print('request body:', json.dumps(batch_request))
  print('response status:', response.status_code)
  print('response data:', response.text)  # successful response returns '{}'


def create_push_record(entity):
  """Creates a record from an entity for batchPush requests.

  Args:
      entity: The entity object to create the record from.

  Returns:
      The constructed record for the batchPush request payload.
  """
  data_bytes = json.dumps(entity).encode('utf-8')
  base64_bytes = base64.b64encode(data_bytes)
  # Using dateModified to set generation_timestamp. Defaulting to the
  # current timestamp for records that do not have dateModified.
  generation_timestamp = entity.dateModified if 'dateModified' in entity else datetime.datetime.now(
  ).strftime('%Y-%m-%dT%H:%M:%S.%fZ')
  return {
      'generation_timestamp': generation_timestamp,
      'data_record': base64_bytes.decode('utf-8')
  }


# Call batch_upsert with example entities. dateModified is optional and is
# used to hold the actual timestamp when the entity was updated/created.
batch_upsert([{
    '@type': 'MenuItemOffer',
    '@id': '6680261',
    'menuItemId': '18931508',
    'price': 15.5,
    'priceCurrency': 'USD',
    'applicableServiceType': ['DELIVERY', 'TAKEOUT'],
    'inventoryLevel': 0,
    'dateModified': '2022-06-19T15:43:50.970Z'
}, {
    '@type': 'MenuItemOffer',
    '@id': '6680262',
    'menuItemId': '18931509',
    'price': 25.5,
    'priceCurrency': 'USD',
    'applicableServiceType': ['DELIVERY', 'TAKEOUT'],
    'inventoryLevel': 0,
    'dateModified': '2022-06-19T15:43:50.970Z'
}])

Java

Ten kod korzysta z biblioteki uwierzytelniania Google dla języka Java.

Modele kodu źródłowego klienta w pakietach rtusamples.inventory i rtusamples.realtime zostały utworzone przez wykonanie czynności opisanych w artykule Generowanie bibliotek klienta.

/*
 * Required Libraries:
 * - JDK >= 11
 * - google-auth-library-oauth2-http
 */
package rtusamples;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.auth.oauth2.AccessToken;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.FileInputStream;
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpRequest.BodyPublishers;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.nio.charset.Charset;
import java.time.Clock;
import java.time.OffsetDateTime;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Base64;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import rtusamples.inventory.MenuItemOffer;
import rtusamples.inventory.MenuItemOfferType;
import rtusamples.inventory.ServiceTypeElement;
import rtusamples.realtime.BatchPushGenericRecordRequest;
import rtusamples.realtime.GenericRecord;

/** Sample code for Real-time update batchPush implementation. */
public final class BasicPush {
  // ACTION REQUIRED: Change this to your Partner ID received from Google. The Partner ID is
  // available on the Partner Portal.
  private static final long PARTNER_ID = 12345678;

  // ACTION REQUIRED: Change this to the path of the service account client secret file downloaded
  // from the Google Cloud Console.
  private static final String JSON_KEY_FULL_PATH =
      "<path to your JSON credentials>/credentials.json";

  // ACTION REQUIRED: Change this to the endpoint that is needed.
  private static final String ENDPOINT =
      //    "https://partnerdev-mapsbooking.googleapis.com"; // for sandbox
      "https://mapsbooking.googleapis.com"; // for prod

  // Feed name for Order with Google including the version.
  private static final String FEED_NAME = "owg.v2";

  private static final ObjectMapper objectMapper = new ObjectMapper();

  private static final DateTimeFormatter TIMESTAMP_FORMATTER =
      DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss[.SSS]'Z'");

  private static final Charset UTF_8 = Charset.forName("UTF-8");

  public static void main(String[] args) throws Exception {

    /**
     * Create credentials from service account secret file. Alternatively, the credentials can be
     * created by implementing Application Default Credentials.
     * https://github.com/googleapis/google-auth-library-java
     */
    // GoogleCredentials sourceCredentials =
    //     GoogleCredentials.getApplicationDefault()
    //         .createScoped(Arrays.asList("https://www.googleapis.com/auth/mapsbooking"));

    // ImpersonatedCredentials credentials =
    //     ImpersonatedCredentials.create(
    //         sourceCredentials,
    //         "fo-test@projectname.iam.gserviceaccount.com",
    //         null,
    //         Arrays.asList("https://www.googleapis.com/auth/mapsbooking"),
    //         300);

    GoogleCredentials credentials =
        GoogleCredentials.fromStream(new FileInputStream(JSON_KEY_FULL_PATH))
            .createScoped(Arrays.asList("https://www.googleapis.com/auth/mapsbooking"));

    // Create example MenuItemOffer entities, dateModified is optional and is used to hold
    // the actual timestamp when the entity was updated/created.
    MenuItemOffer menuItemOfferPizza = new MenuItemOffer();
    menuItemOfferPizza.setID("6680261");
    menuItemOfferPizza.setType(MenuItemOfferType.MENU_ITEM_OFFER);
    menuItemOfferPizza.setMenuItemID("18931508");
    menuItemOfferPizza.setPrice(15.5);
    menuItemOfferPizza.setPriceCurrency("USD");
    menuItemOfferPizza.setApplicableServiceType(
        new ServiceTypeElement[] {ServiceTypeElement.TAKEOUT, ServiceTypeElement.DELIVERY});
    menuItemOfferPizza.setInventoryLevel(0.0);
    menuItemOfferPizza.setDateModified("2022-10-07T13:00:00.000Z");

    MenuItemOffer menuItemOfferSalad = new MenuItemOffer();
    menuItemOfferSalad.setID("6680262");
    menuItemOfferSalad.setType(MenuItemOfferType.MENU_ITEM_OFFER);
    menuItemOfferSalad.setMenuItemID("18931509");
    menuItemOfferSalad.setPrice(25.5);
    menuItemOfferSalad.setPriceCurrency("USD");
    menuItemOfferSalad.setApplicableServiceType(
        new ServiceTypeElement[] {ServiceTypeElement.TAKEOUT, ServiceTypeElement.DELIVERY});
    menuItemOfferSalad.setInventoryLevel(0.0);
    menuItemOfferSalad.setDateModified("2022-10-07T13:00:00.000Z");

    // Example array of MenuItemOffer entities to update.
    List<MenuItemOffer> menuItemOffers = Arrays.asList(menuItemOfferPizza, menuItemOfferSalad);

    // Create list of GenericRecord from menuItemOffers.
    List<GenericRecord> menuItemOfferGenericRecords =
        menuItemOffers.stream()
            .map(
                (menuItemOffer) ->
                    toBatchPushRecord(menuItemOffer, menuItemOffer.getDateModified()))
            .collect(Collectors.toList());

    // List of records to be updated/created.
    List<GenericRecord> recordsToBeUpdated = new ArrayList<>();

    // Add list of menuItemOffer generic records.
    recordsToBeUpdated.addAll(menuItemOfferGenericRecords);

    // Request object that contains all records.
    BatchPushGenericRecordRequest batchPushRequest = new BatchPushGenericRecordRequest();
    batchPushRequest.setRecords(recordsToBeUpdated.toArray(new GenericRecord[0]));

    // Execute batchPush request.
    BasicPush basicPush = new BasicPush();
    basicPush.batchPush(batchPushRequest, credentials);
  }

  public void batchPush(
      BatchPushGenericRecordRequest batchPushRequest, GoogleCredentials credentials)
      throws IOException {

    credentials.refreshIfExpired();
    AccessToken token = credentials.getAccessToken();

    String requestBody = objectMapper.writeValueAsString(batchPushRequest);
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request =
        HttpRequest.newBuilder()
            .uri(
                URI.create(
                    String.format(
                        "%s/v1alpha/inventory/partners/%s/feeds/%s/record:batchPush",
                        ENDPOINT, PARTNER_ID, FEED_NAME)))
            .header("Content-Type", "application/json")
            .header("Authorization", String.format("Bearer %s", token.getTokenValue()))
            .POST(BodyPublishers.ofString(requestBody))
            .build();

    HttpResponse<String> response = null;
    try {
      response = client.send(request, BodyHandlers.ofString());
      System.out.println("Request body:" + requestBody);
      System.out.println("Response status:" + response.statusCode());
      System.out.println("Response body:" + response.body());
    } catch (IOException | InterruptedException e) {
      e.printStackTrace();
    }
  }

  public static <T> GenericRecord toBatchPushRecord(T entity, String dateModified) {
    GenericRecord genericRecord = new GenericRecord();
    try {
      String json = objectMapper.writeValueAsString(entity);
      genericRecord.setDataRecord(Base64.getEncoder().encodeToString(json.getBytes(UTF_8)));
      // Using dateModified to set generation_timestamp. Defaulting to the
      // current timestamp for records that do not have dateModified.
      String generationTimestamp =
          Optional.ofNullable(dateModified)
              .orElse(OffsetDateTime.now(Clock.systemUTC()).format(TIMESTAMP_FORMATTER));
      genericRecord.setGenerationTimestamp(generationTimestamp);
    } catch (JsonProcessingException e) {
      System.out.println(e.getMessage());
    }
    return genericRecord;
  }
}

Usuwam elementy

Node.js

Ten kod korzysta z biblioteki uwierzytelniania Google dla Node.js.

/* Sample code for Real-time update batchDelete implementation.
 *
 * Required libraries:
 * - google-auth-library
 */

const {JWT} = require('google-auth-library');

// ACTION REQUIRED: Change this to the path of the service account client secret
// file downloaded from the Google Cloud Console.
const serviceAccountJson = require('./service-account.json');

// ACTION REQUIRED: Change this to your Partner ID received from Google.
// The Partner ID is available on the Partner Portal.
const PARTNER_ID = 1234;

const HOST = {
  prod: 'https://mapsbooking.googleapis.com',
  sandbox: 'https://partnerdev-mapsbooking.googleapis.com'
};

// ACTION REQUIRED: Change to 'prod' for production
const ENV = 'sandbox';

// Feed name for Order with Google including the version.
const FEED_NAME = 'owg.v2';

// Endpoint url
const url = `${HOST[ENV]}/v1alpha/inventory/partners/${PARTNER_ID}/feeds/${
    FEED_NAME}/record:batchDelete`;


/**
 * Send a Real-time update request to delete entities
 */
async function batchDelete(entities) {
  try {
    /**
     * Sign JWT token using private key from service account secret file
     * provided. The client can be created without providing a service account
     * secret file by implementing Application Default Credentials.
     * https://github.com/googleapis/google-auth-library-nodejs
     */
    const client = new JWT({
      email: serviceAccountJson.client_email,
      key: serviceAccountJson.private_key,
      scopes: ['https://www.googleapis.com/auth/mapsbooking'],
    });
    const request = {
      records: toDeleteRecords(entities)
    };
    const body = JSON.stringify(request);
    try {
      const response = await client.request({
        method: 'POST',
        url,
        data: body,
        headers: {'Content-Type': 'application/json'}
      });
      console.log('request body:', body);
      console.log('response status:', response.status);
      console.log('response data:', response.data);  // successful response returns '{}'
    } catch (error) {
      console.log('error:', error);
    }
  }

  /**
   * Maps array of entities to records for batch delete requests
   */
  const toDeleteRecords = (entities) => {
    return entities.map((entity) => {
      // Using dateModified to set delete_time. Defaulting to the current
      // timestamp for records that do not have dateModified.
      const delete_time =
          entity.dateModified ? entity.dateModified : new Date().toISOString();
      return {data_record: btoa(JSON.stringify(entity)), delete_time};
    });
  };

  // Call batchDelete with example entities. dateModified is optional and is
  // used to hold the actual timestamp when the entity was deleted.
  batchDelete([
    {
      '@type': 'Menu',
      '@id': '853706',
      'dateModified': '2022-06-19T15:43:50.970Z'
    },
    {
      '@type': 'Menu',
      '@id': '853705',
      'dateModified': '2022-06-19T15:13:00.280Z'
    }
  ]);

Python

Ten kod korzysta z biblioteki uwierzytelniania Google dla Pythona.

"""Sample code for the Real-time update batchDelete implementation."""

# Required libraries:
# - google-auth

import base64
import datetime
import json
from google.auth.transport.requests import AuthorizedSession
from google.oauth2 import service_account

# ACTION REQUIRED: Change this to the Partner ID received from Google.
# Partner ID is available on the Partner Portal.
# https://partnerdash.google.com/apps/reservewithgoogle
_PARTNER_ID = '1234'

# ACTION REQUIRED: Change this to the path of the service account client secret
# file downloaded from the Google Cloud Console.
_SERVICE_ACCOUNT_KEY_JSON_FILE = 'service-account-creds.json'

_HOST_MAP = {
    'sandbox': 'https://partnerdev-mapsbooking.googleapis.com',
    'prod': 'https://mapsbooking.googleapis.com'
}

# ACTION REQUIRED: Change to 'prod' for production
_ENV = 'sandbox'

# Feed name for Order with Google including the version.
_FEED_NAME = 'owg.v2'

_ENDPOINT = '{}/v1alpha/inventory/partners/{}/feeds/{}/record:batchDelete'.format(
    _HOST_MAP[_ENV], _PARTNER_ID, _FEED_NAME)


def batch_delete(entities):
  """Makes a batch delete request using the Real-time updates REST service.

  Args:
      entities: The list of entity objects to delete.
  """

  # Creates credentials by providing a json file. Credentials can also be
  # provided by implementing Application Default Credentials.
  # https://googleapis.dev/python/google-auth/latest/user-guide.html
  credentials = service_account.Credentials.from_service_account_file(
      _SERVICE_ACCOUNT_KEY_JSON_FILE,
      scopes=['https://www.googleapis.com/auth/mapsbooking'])
  authorized_session = AuthorizedSession(credentials)

  # JSON request object
  batch_request = {'records': [create_delete_record(x) for x in entities]}
  response = authorized_session.post(_ENDPOINT, json=batch_request)
  print('request body:', json.dumps(batch_request))
  print('response status:', response.status_code)
  print('response data:', response.text)  # successful response returns '{}'


def create_delete_record(entity):
  """Creates a record from an entity for batchDelete requests.

  Args:
    entity: The entity object to create the record from.

  Returns:
    The constructed record for the batchDelete request payload.
  """
  data_bytes = json.dumps(entity).encode('utf-8')
  base64_bytes = base64.b64encode(data_bytes)
  # Using dateModified to set delete_time. Defaulting to the current
  # timestamp for records that do not have dateModified.
  delete_time = entity.dateModified if 'dateModified' in entity else datetime.datetime.now(
  ).strftime('%Y-%m-%dT%H:%M:%S.%fZ')
  return {
      'delete_time': delete_time,
      'data_record': base64_bytes.decode('utf-8')
  }


# Call batch_delete with example entities. dateModified is optional and is
# used to hold the actual timestamp when the entity was deleted.
batch_delete([{
    '@type': 'Menu',
    '@id': '853706',
    'dateModified': '2022-06-19T13:10:00.000Z'
}, {
    '@type': 'Menu',
    '@id': '853705',
    'dateModified': '2022-06-19T13:30:10.000Z'
}])

Java

Ten kod korzysta z biblioteki uwierzytelniania Google dla języka Java.

Modele kodu źródłowego klienta w pakietach rtusamples.inventory i rtusamples.realtime zostały utworzone przez wykonanie czynności opisanych w artykule Generowanie bibliotek klienta.

/*
 * Required Libraries:
 * - JDK >= 11
 * - google-auth-library-oauth2-http
 */
package rtusamples;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.auth.oauth2.AccessToken;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.FileInputStream;
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpRequest.BodyPublishers;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.nio.charset.Charset;
import java.time.Clock;
import java.time.OffsetDateTime;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Base64;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import rtusamples.inventory.Menu;
import rtusamples.inventory.MenuType;
import rtusamples.realtime.BatchDeleteGenericRecordsRequest;
import rtusamples.realtime.GenericDeleteRecord;

/** Sample code for the Real-time update batchDelete implementation. */
public final class BasicDelete {
  // ACTION REQUIRED: Change this to your Partner ID received from Google. The Partner ID is
  // available on the Partner Portal.
  private static final long PARTNER_ID = 123456789;

  // ACTION REQUIRED: Change this to the path of the service account client secret file downloaded
  // from the Google Cloud Console.
  private static final String JSON_KEY_FULL_PATH =
      "<path to your JSON credentials>/credentials.json";

  // ACTION REQUIRED: Change this to the endpoint that is needed.
  private static final String ENDPOINT =
      "https://partnerdev-mapsbooking.googleapis.com"; // for sandbox
  // "https://mapsbooking.googleapis.com" // for prod

  // Feed name for Order with Google including the version.
  private static final String FEED_NAME = "owg.v2";

  private static final ObjectMapper objectMapper = new ObjectMapper();

  private static final DateTimeFormatter TIMESTAMP_FORMATTER =
      DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss[.SSS]'Z'");

  private static final Charset UTF_8 = Charset.forName("UTF-8");

  public static void main(String[] args) throws Exception {

    /**
     * Create credentials from service account secret file. Alternatively, the credentials can be
     * created by implementing Application Default Credentials.
     * https://github.com/googleapis/google-auth-library-java
     */
    // GoogleCredentials sourceCredentials =
    //     GoogleCredentials.getApplicationDefault()
    //         .createScoped(Arrays.asList("https://www.googleapis.com/auth/mapsbooking"));

    // ImpersonatedCredentials credentials =
    //     ImpersonatedCredentials.create(
    //         sourceCredentials,
    //         "fo-test@projectname.iam.gserviceaccount.com",
    //         null,
    //         Arrays.asList("https://www.googleapis.com/auth/mapsbooking"),
    //         300);

    GoogleCredentials credentials =
        GoogleCredentials.fromStream(new FileInputStream(JSON_KEY_FULL_PATH))
            .createScoped(Arrays.asList("https://www.googleapis.com/auth/mapsbooking"));

    // Create example Menu entities, dateModified is optional and is used to hold
    // the actual timestamp when the entity was deleted.
    Menu menuLunch = new Menu();
    menuLunch.setID("853705");
    menuLunch.setType(MenuType.MENU);
    menuLunch.setDateModified("2022-09-19T13:10:00.000Z");

    Menu menuDinner = new Menu();
    menuDinner.setID("853706");
    menuDinner.setType(MenuType.MENU);
    menuDinner.setDateModified("2022-09-19T13:13:10.000Z");

    // Example array of Menu entities to update.
    List<Menu> menus = Arrays.asList(menuLunch, menuDinner);

    // Create list of GenericDeleteRecord from menus.
    List<GenericDeleteRecord> menuGenericDeleteRecords =
        menus.stream()
            .map((menu) -> toBatchDeleteRecord(menu, menu.getDateModified()))
            .collect(Collectors.toList());

    // List of records to be deleted.
    List<GenericDeleteRecord> recordsToBeDeleted = new ArrayList<>();

    // Add list of menu generic records.
    recordsToBeDeleted.addAll(menuGenericDeleteRecords);

    // Request object that contains all records.
    BatchDeleteGenericRecordsRequest batchDeleteRequest = new BatchDeleteGenericRecordsRequest();
    batchDeleteRequest.setRecords(recordsToBeDeleted.toArray(new GenericDeleteRecord[0]));

    // Execute batchDelete request.
    BasicDelete basicDelete = new BasicDelete();
    basicDelete.batchDelete(batchDeleteRequest, credentials);
  }

  public void batchDelete(
      BatchDeleteGenericRecordsRequest batchDeleteRequest, GoogleCredentials credentials)
      throws IOException {

    credentials.refreshIfExpired();
    AccessToken token = credentials.getAccessToken();

    String requestBody = objectMapper.writeValueAsString(batchDeleteRequest);
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request =
        HttpRequest.newBuilder()
            .uri(
                URI.create(
                    String.format(
                        "%s/v1alpha/inventory/partners/%s/feeds/%s/record:batchDelete",
                        ENDPOINT, PARTNER_ID, FEED_NAME)))
            .header("Content-Type", "application/json")
            .header("Authorization", String.format("Bearer %s", token.getTokenValue()))
            .POST(BodyPublishers.ofString(requestBody))
            .build();

    HttpResponse<String> response = null;
    try {
      response = client.send(request, BodyHandlers.ofString());
      System.out.println("Request body:" + requestBody);
      System.out.println("Response status:" + response.statusCode());
      System.out.println("Response body:" + response.body());
    } catch (IOException | InterruptedException e) {
      e.printStackTrace();
    }
  }

  public static <T> GenericDeleteRecord toBatchDeleteRecord(T entity, String dateModified) {
    GenericDeleteRecord genericRecord = new GenericDeleteRecord();
    try {
      String json = objectMapper.writeValueAsString(entity);
      genericRecord.setDataRecord(Base64.getEncoder().encodeToString(json.getBytes(UTF_8)));
      // Using dateModified to set delete_time. Defaulting to the current
      // timestamp for records that do not have dateModified.
      String deleteTime =
          Optional.ofNullable(dateModified)
              .orElse(OffsetDateTime.now(Clock.systemUTC()).format(TIMESTAMP_FORMATTER));
      genericRecord.setDeleteTime(deleteTime);
    } catch (JsonProcessingException e) {
      System.out.println(e.getMessage());
    }
    return genericRecord;
  }
}

Przypadki użycia

Oto przykłady aktualizacji w czasie rzeczywistym, aktualizacji wsadowego pliku danych a treścią ogólną w wywołaniu interfejsu API:

Scenariusz	Element do zaktualizowania	Opis i efekty
Wyłączanie usługi	`Service`	Musisz wyłączyć usługę z nieprzewidzianego powodu. Aktualizacje w czasie rzeczywistym: zaktualizuj element `Service` w ustaw jego właściwość `isDisabled` na `true`, ale nie zmienia innych właściwości. Pełne pliki danych: pamiętaj, aby zaktualizować element z pełnych kanałów. aby `isDisabled` został ustawiony na `true` przed podczas następnego pobierania przez Google. W przeciwnym razie element zostanie ponownie włączony.
Brak produktu w magazynie	`MenuItemOffer`	Aktualizacje w czasie rzeczywistym: wyślij `MenuItemOffer`. encja z wartością `inventoryLevel` ustawioną na 0 dla danej wartości `MenuItem` i wszystkie inne dane bez zmian.
Zmiana ceny pozycji menu	`MenuItemOffer`	Aktualizacje w czasie rzeczywistym: wyślij `MenuItemOffer`. element z wartością `price` ustawioną na zaktualizowaną cenę danego `MenuItem` i wszystkie inne dane bez zmian.
Dodaj nowy element najwyższego poziomu Dotyczy tylko elementu typu `Menu`, `Restaurant` i `Service`.	`Menu`, `Restaurant`, `Service`	Możesz na przykład dodać nowe menu do restauracji. Pełne pliki danych: dodaj element do plików danych i poczekaj na przetworzenie zbiorcze.
Trwale usuń element najwyższego poziomu Dotyczy tylko elementu typu `Menu`, `Restaurant` i `Service`.	`Menu`, `Restaurant`, `Service`	Aktualizacje w czasie rzeczywistym: wyślij powiadomienie usuwać. Pełne pliki danych: pamiętaj, aby usunąć element z pełnych kanałów przed podczas następnego pobierania przez Google. W przeciwnym razie element zostanie ponownie dodany.
Dodaj nowy obszar dostawy w określonym regionie `Service`	`ServiceArea`	Zbiorcze pliki danych: wyślij element `ServiceArea`, którego dotyczy problem, wraz ze wszystkimi jego tak jak zwykle w pełnych plikach danych, a także nowy obszar dostawy. określona w `polygon`, `geoRadius` lub `postalCode`.
Zaktualizuj szacowany czas dostawy za `Service`	`ServiceHours`	Zbiorcze pliki danych: wyślij `ServiceHours` w taki sam sposób jak w pliki danych z wyjątkiem aktualizacji `leadTimeMin` odpowiednio się zmienia.
Zaktualizuj ceny dostawy w: `Service`	`Fee`	Zbiorcze pliki danych: wyślij pełną dostawę `Fee` za pomocą Zaktualizowano: `price`.
Zaktualizuj godziny dostawy lub na wynos w: `Service`	`ServiceHours`	Zbiorcze pliki danych: wyślij `ServiceHours` w taki sam sposób jak w pliki danych z wyjątkiem ich właściwości `opens` i `closes` zostaną zaktualizowane; odpowiednio się zmienia.
`Service` (zmień minimalną kwotę zamówienia)	`Fee`	Zbiorcze pliki danych: wyślij pełne `Fee` za pomocą `minPrice` zaktualizowano
Trwale usuń element `MenuItem`	`Menu`	Zbiorcze pliki danych: wyślij `MenuItem` w taki sam sposób jak plików danych, ale `parentMenuSectionId` jest pusty.

Czasy przetwarzania zadań wsadowych i aktualizacji w czasie rzeczywistym

Encja zaktualizowana lub usunięta przy użyciu zbiorczego pliku danych zostanie przetworzona w ciągu 2 godzin godzin, natomiast podmiot zaktualizowany za pomocą aktualizacji w czasie rzeczywistym zostanie przetworzony 5 minut. O nieaktualny element zostanie usunięta za 14 dni.

Możesz wysłać do Google:

Kilka zadań zbiorczych dziennie, aby aktualizować asortyment, LUB
Jedno zadanie wsadowe dziennie i aktualizacje w czasie rzeczywistym zapewniają aktualność asortymentu.

Dalej

Aktualizacja zamówienia asynchronicznego

Aktualizacje w czasie rzeczywistym

Wymagania wstępne

Omówienie

Punkty końcowe

Aktualizuję elementy

Wstaw ładunek żądania upsert

Przykłady

Przykład 1. Aktualizowanie informacji o restauracji

JSON

Base64

Przykład 2. Aktualizowanie wielu restauracji

JSON

Base64

Przykład 3. Aktualizowanie ceny pozycji menu

JSON

Base64

Dodawanie encji

Usuwam jednostki

Usuń ładunek żądania

Przykłady

Przykład 1: usuwanie 2 elementów MenuItem

JSON

Base64

Przykład 2. Usuwanie encji Restaurant

JSON

Base64

Weryfikacja Kody odpowiedzi interfejsu API

Limity interfejsu API

Przykładowe fragmenty kodu

Aktualizuję elementy

Node.js

Python

Java

Usuwam elementy

Node.js

Python

Java

Przypadki użycia

Czasy przetwarzania zadań wsadowych i aktualizacji w czasie rzeczywistym

Przykład 1: usuwanie 2 elementów `MenuItem`

Przykład 2. Usuwanie encji `Restaurant`