Method: events.ingest

Przesyła listę zasobów Event z podanego pliku Destination.

Żądanie HTTP

POST https://datamanager.googleapis.com/v1/events:ingest

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "consent": {
    object (Consent)
  },
  "validateOnly": boolean,
  "encoding": enum (Encoding),
  "encryptionInfo": {
    object (EncryptionInfo)
  }
}
Pola
destinations[]

object (Destination)

Wymagane. Lista miejsc docelowych, do których mają być wysyłane zdarzenia.
events[]

object (Event)

Wymagane. Lista zdarzeń do wysłania do określonych miejsc docelowych. W jednym żądaniu można wysłać maksymalnie 2000 zasobów Event.
consent

object (Consent)

Opcjonalnie: Zgoda na poziomie żądania, która ma być stosowana do wszystkich użytkowników w żądaniu. Zgoda na poziomie użytkownika zastępuje zgodę na poziomie żądania i może być określona w każdym Event.
validateOnly

boolean

Opcjonalnie: Do celów testowych. Jeśli true, żądanie jest weryfikowane, ale nie wykonywane. Zwracane są tylko błędy, a nie wyniki.
encoding

enum (Encoding)

Opcjonalnie: Wymagane w przypadku przesyłania plików w UserData. Typ kodowania identyfikatorów użytkowników. W przypadku zaszyfrowanych identyfikatorów użytkowników jest to typ kodowania zaszyfrowanego ciągu znaków. W przypadku zaszyfrowanych, zahaszowanych identyfikatorów użytkowników jest to typ kodowania zewnętrznego zaszyfrowanego ciągu znaków, ale niekoniecznie wewnętrznego zahaszowanego ciągu znaków. Oznacza to, że wewnętrzny zahaszowany ciąg znaków może być zakodowany w inny sposób niż zewnętrzny zaszyfrowany ciąg znaków. W przypadku przesyłania plików innych niż UserData to pole jest ignorowane.
encryptionInfo

object (EncryptionInfo)

Opcjonalnie: Informacje o szyfrowaniu przesyłanych plików UserData. Jeśli nie jest ustawiona, zakłada się, że przesłane informacje umożliwiające identyfikację są zahaszowane, ale nie zaszyfrowane. W przypadku przesyłania plików innych niż UserData to pole jest ignorowane.

Treść odpowiedzi

Odpowiedź z IngestEventsRequest.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "requestId": string
}
Pola
requestId

string

Automatycznie wygenerowany identyfikator żądania.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/datamanager

Zdarzenie

Zdarzenie reprezentujące interakcję użytkownika z witryną lub aplikacją reklamodawcy.

Zapis JSON 
{
  "destinationReferences": [
    string
  ],
  "transactionId": string,
  "eventTimestamp": string,
  "lastUpdatedTimestamp": string,
  "userData": {
    object (UserData)
  },
  "consent": {
    object (Consent)
  },
  "adIdentifiers": {
    object (AdIdentifiers)
  },
  "currency": string,
  "conversionValue": number,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  }
}
Pola
destinationReferences[]

string

Opcjonalnie: Ciąg znaków referencyjny używany do określania miejsca docelowego. Jeśli to pole jest puste, zdarzenie zostanie wysłane do wszystkich destinations w żądaniu.
transactionId

string

Opcjonalnie: Unikalny identyfikator tego wydarzenia. Wymagane w przypadku konwersji korzystających z wielu źródeł danych.
eventTimestamp

string (Timestamp format)

Wymagane. Czas wystąpienia zdarzenia.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
lastUpdatedTimestamp

string (Timestamp format)

Opcjonalnie: Ostatnia aktualizacja wydarzenia.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
userData

object (UserData)

Opcjonalnie: Fragmenty danych przekazywanych przez użytkowników, które reprezentują użytkownika powiązanego ze zdarzeniem.
consent

object (Consent)

Opcjonalnie: Informacje o tym, czy powiązany użytkownik wyraził zgodę na różne rodzaje przetwarzania danych.
adIdentifiers

object (AdIdentifiers)

Opcjonalnie: Identyfikatory i inne informacje używane do dopasowywania zdarzenia konwersji do innej aktywności online (np. kliknięć reklam).
currency

string

Opcjonalnie: Kod waluty powiązany ze wszystkimi wartościami pieniężnymi w tym zdarzeniu.
conversionValue

number

Opcjonalnie: Wartość konwersji powiązana ze zdarzeniem w przypadku konwersji opartych na wartości.
eventSource

enum (EventSource)

Opcjonalnie: Sygnał wskazujący, gdzie wystąpiło zdarzenie (w internecie, aplikacji, sklepie stacjonarnym itp.).
eventDeviceInfo

object (DeviceInfo)

Opcjonalnie: Informacje zebrane o używanym urządzeniu (jeśli takie było) w momencie wystąpienia zdarzenia.
cartData

object (CartData)

Opcjonalnie: Informacje o transakcji i produktach powiązanych ze zdarzeniem.
customVariables[]

object (CustomVariable)

Opcjonalnie: Dodatkowe informacje o parach klucz/wartość do wysłania do kontenerów konwersji (działanie powodujące konwersję lub aktywność FL).
experimentalFields[]

object (ExperimentalField)

Opcjonalnie: Lista par klucz/wartość dla pól eksperymentalnych, które mogą zostać włączone do interfejsu API.
userProperties

object (UserProperties)

Opcjonalnie: Informacje o użytkowniku ocenione przez reklamodawcę w momencie wystąpienia zdarzenia.

AdIdentifiers

Identyfikatory i inne informacje używane do dopasowywania zdarzenia konwersji do innej aktywności online (np. kliknięć reklam).

Zapis JSON 
{
  "sessionAttributes": string,
  "gclid": string,
  "gbraid": string,
  "wbraid": string,
  "landingPageDeviceInfo": {
    object (DeviceInfo)
  }
}
Pola
sessionAttributes

string

Opcjonalnie: Atrybuty sesji na potrzeby atrybucji i modelowania zdarzeń.
gclid

string

Opcjonalnie: Identyfikator kliknięcia Google (gclid) powiązany z tym zdarzeniem.
gbraid

string

Opcjonalnie: Identyfikator kliknięcia w przypadku kliknięć powiązanych ze zdarzeniami w aplikacji pochodzącymi z urządzeń z systemem iOS od wersji 14.
wbraid

string

Opcjonalnie: Identyfikator kliknięcia w przypadku kliknięć powiązanych ze zdarzeniami w witrynie pochodzącymi z urządzeń z systemem iOS od wersji 14.
landingPageDeviceInfo

object (DeviceInfo)

Opcjonalnie: Informacje zebrane o urządzeniu używanym (jeśli dotyczy) w momencie wejścia na stronę reklamodawcy po interakcji z reklamą.

DeviceInfo

Informacje o urządzeniu używanym (jeśli dotyczy) w momencie wystąpienia zdarzenia.

Zapis JSON 
{
  "userAgent": string,
  "ipAddress": string
}
Pola
userAgent

string

Opcjonalnie: Ciąg znaków klienta użytkownika urządzenia w danym kontekście.
ipAddress

string

Opcjonalnie: Adres IP urządzenia w danym kontekście.

Uwaga: Google Ads nie obsługuje dopasowywania adresów IP użytkowników z Europejskiego Obszaru Gospodarczego (EOG), Wielkiej Brytanii i Szwajcarii. Dodaj logikę, która warunkowo wyklucza udostępnianie adresów IP użytkowników z tych regionów, i zadbaj o to, aby udostępniać użytkownikom jasne i wyczerpujące informacje na temat danych, które zbierasz w swoich witrynach, aplikacjach i innych usługach, a jeśli jest to wymagane przez prawo lub obowiązujące zasady Google, uzyskać ich zgodę. Więcej informacji znajdziesz na stronie Importowanie konwersji offline.

EventSource

Źródło zdarzenia.

Wartości w polu enum
EVENT_SOURCE_UNSPECIFIED Nieokreślone źródło zdarzeń. Nigdy nie należy go używać.
WEB Wydarzenie zostało wygenerowane w przeglądarce.
APP Wydarzenie zostało wygenerowane przez aplikację.
IN_STORE Wydarzenie zostało wygenerowane na podstawie transakcji w sklepie stacjonarnym.
PHONE Wydarzenie zostało wygenerowane na podstawie rozmowy telefonicznej.
OTHER Wydarzenie zostało wygenerowane z innych źródeł.

CartData

Dane koszyka powiązane ze zdarzeniem.

Zapis JSON 
{
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "transactionDiscount": number,
  "items": [
    {
      object (Item)
    }
  ]
}
Pola
merchantId

string

Opcjonalnie: Identyfikator Merchant Center powiązany z produktami.
merchantFeedLabel

string

Opcjonalnie: Etykieta pliku danych Merchant Center powiązana z plikiem danych produktów.
merchantFeedLanguageCode

string

Opcjonalnie: Kod języka w formacie ISO 639-1 powiązany z plikiem danych Merchant Center, w którym przesyłane są Twoje produkty.
transactionDiscount

number

Opcjonalnie: Suma wszystkich rabatów powiązanych z transakcją.
items[]

object (Item)

Opcjonalnie: Lista produktów powiązanych ze zdarzeniem.

Element

Reprezentuje element w koszyku powiązany ze zdarzeniem.

Zapis JSON 
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": number
}
Pola
merchantProductId

string

Opcjonalnie: Identyfikator produktu na koncie Merchant Center.
quantity

string (int64 format)

Opcjonalnie: Liczba tego produktu powiązanego ze zdarzeniem.
unitPrice

number

Opcjonalnie: Cena jednostkowa bez podatku, dostawy i wszelkich rabatów na poziomie transakcji.

Zmienna niestandardowa

Zmienna niestandardowa na potrzeby konwersji z reklam.

Zapis JSON 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
Pola
variable

string

Opcjonalnie: Nazwa zmiennej niestandardowej do ustawienia. Jeśli zmienna nie zostanie znaleziona w przypadku danego miejsca docelowego, zostanie zignorowana.
value

string

Opcjonalnie: Wartość, która ma być przechowywana w zmiennej niestandardowej.
destinationReferences[]

string

Opcjonalnie: Ciąg odniesienia używany do określania, do którego z Event.destination_references należy wysłać zmienną niestandardową. Jeśli pole jest puste, używana jest wartość Event.destination_references.

ExperimentalField

Eksperymentalne pole reprezentujące nieoficjalne pola.

Zapis JSON 
{
  "field": string,
  "value": string
}
Pola
field

string

Opcjonalnie: Nazwa pola do użycia.
value

string

Opcjonalnie: Wartość pola do ustawienia.

UserProperties

Informacje o użytkowniku ocenione przez reklamodawcę w momencie wystąpienia zdarzenia. Więcej informacji znajdziesz na stronie https://support.google.com/google-ads/answer/14007601.

Zapis JSON 
{
  "customerType": enum (CustomerType),
  "customerValueBucket": enum (CustomerValueBucket)
}
Pola
customerType

enum (CustomerType)

Opcjonalnie: Typ klienta powiązanego ze zdarzeniem.
customerValueBucket

enum (CustomerValueBucket)

Opcjonalnie: Wartość klienta określona przez reklamodawcę.

CustomerType

Typ klienta powiązanego ze zdarzeniem.

Wartości w polu enum
CUSTOMER_TYPE_UNSPECIFIED Nieokreślony typ klienta. Nigdy nie należy go używać.
NEW klient jest nowy dla reklamodawcy.
RETURNING Klient wraca do reklamodawcy.
REENGAGED Klient ponownie zaangażował się w interakcję z reklamodawcą.

CustomerValueBucket

Wartość klienta określona przez reklamodawcę.

Wartości w polu enum
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Unspecified CustomerValueBucket. Nigdy nie należy go używać.
LOW Klient ma niską wartość.
MEDIUM Klient ma średnią wartość.
HIGH Klient jest wartościowy.