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 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 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,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  },
  "eventName": string,
  "clientId": string,
  "userId": string,
  "additionalEventParameters": [
    {
      object (EventParameter)
    }
  ],
  "thirdPartyUserData": {
    object (UserData)
  },
  "eventLocation": {
    object (EventLocation)
  },
  "appInstanceId": string,
  "conversionValue": number,
  "conversionCount": number
}
Pola
destinationReferences[]

string

Opcjonalnie. Ciąg znaków odniesienia 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 zdarzenia. Wymagane w przypadku zdarzeń wysyłanych jako dodatkowe źródło danych na potrzeby konwersji rejestrowanych przez tag.
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.
eventSource

enum (EventSource)

Opcjonalnie. Sygnał wskazujący, gdzie wystąpiło zdarzenie (w internecie, w aplikacji, w 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ą ostatecznie zostać włączone do interfejsu API.
userProperties

object (UserProperties)

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

string

Opcjonalnie. Nazwa zdarzenia. Wymagany w przypadku zdarzeń GA4.
clientId

string

Opcjonalnie. Unikalny identyfikator instancji użytkownika klienta internetowego w tym strumieniu danych z sieci GA4.
userId

string

Opcjonalnie. Unikalny identyfikator użytkownika zdefiniowany przez reklamodawcę.
additionalEventParameters[]

object (EventParameter)

Opcjonalnie. Zbiór dowolnych parametrów zdarzenia, które mają być uwzględnione w zdarzeniu, a nie zostały jeszcze określone za pomocą innych pól strukturalnych.
thirdPartyUserData

object (UserData)

Opcjonalnie. Ten sam typ danych, który jest podawany w parametrze userData, ale wyraźnie oznaczony jako dane należące do innej firmy, a nie do reklamodawcy oferującego własne usługi.
eventLocation

object (EventLocation)

Opcjonalnie. Informacje zebrane o lokalizacji użytkownika w momencie wystąpienia tego zdarzenia.
appInstanceId

string

Opcjonalnie. Unikalny identyfikator instancji użytkownika klienta aplikacji w tym strumieniu danych aplikacji w GA4.
conversionValue

number

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

number

Opcjonalnie. Ilość konwersji powiązanych ze zdarzeniem w przypadku konwersji opartych na zliczaniu.

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)
  },
  "mobileDeviceId": string,
  "dclid": string,
  "impressionId": string,
  "matchId": string,
  "encryptedUserIds": [
    {
      object (EncryptedUserId)
    }
  ]
}
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 używanym urządzeniu (jeśli takie jest) w momencie wejścia do witryny reklamodawcy po interakcji z reklamą.
mobileDeviceId

string

Opcjonalnie. Identyfikator wyświetlania reklam mobilnych dla reklamodawców. W przypadku iOS będzie to IDFA, w przypadku Androida – AdID, a w przypadku innych platform – identyfikatory dla reklamodawców.
dclid

string

Opcjonalnie. Identyfikator kliknięcia w reklamie displayowej powiązany z tym zdarzeniem.
impressionId

string

Opcjonalnie. Identyfikator wyświetlenia powiązany z tym zdarzeniem.
matchId

string

Opcjonalnie. Pole identyfikatora dopasowania używane do łączenia tego zdarzenia z poprzednim zdarzeniem.
encryptedUserIds[]

object (EncryptedUserId)

Opcjonalnie. Dowolna liczba zaszyfrowanych identyfikatorów użytkowników.

EncryptedUserId

Identyfikator użytkownika wydany do celów atrybucji. Jeśli używasz tego parametru, wszystkie pola są wymagane.

Zapis JSON 
{
  "encryptedId": string,
  "entityType": enum (EncryptionEntityType),
  "entityId": string,
  "source": enum (EncryptionSource)
}
Pola
encryptedId

string

Wymagane. Alfanumeryczny zaszyfrowany identyfikator.
entityType

enum (EncryptionEntityType)

Wymagane. Typ jednostki szyfrowania. Powinno to być zgodne z konfiguracją szyfrowania na potrzeby wyświetlania reklam lub przenoszenia danych.
entityId

string (int64 format)

Wymagane. Identyfikator jednostki szyfrowania. Powinno to być zgodne z konfiguracją szyfrowania na potrzeby wyświetlania reklam lub przenoszenia danych.
source

enum (EncryptionSource)

Wymagane. Określa, czy zaszyfrowany plik cookie został otrzymany z wyświetlania reklam (makro %m) czy z przenoszenia danych.

EncryptionEntityType

Typ jednostki szyfrowania.

Wartości w polu enum
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED Nieokreślony typ elementu szyfrowania.
CAMPAIGN_MANAGER_ACCOUNT konto w usłudze Campaign Manager 360;
CAMPAIGN_MANAGER_ADVERTISER reklamodawcą w usłudze Campaign Manager 360.
DISPLAY_VIDEO_PARTNER partnera Display & Video 360.
DISPLAY_VIDEO_ADVERTISER reklamodawcą Display & Video 360;
GOOGLE_ADS_CUSTOMER klient Google Ads;
GOOGLE_AD_MANAGER_NETWORK_CODE Kod sieci Google Ad Managera.

EncryptionSource

Źródło szyfrowania.

Wartości w polu enum
ENCRYPTION_SOURCE_UNSPECIFIED Nieokreślone źródło szyfrowania.
AD_SERVING Źródło szyfrowania wyświetlania reklam.
DATA_TRANSFER Źródło szyfrowania przesyłania danych.

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.
MESSAGE Wydarzenie zostało wygenerowane na podstawie wiadomości.
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)
    }
  ],
  "couponCodes": [
    string
  ]
}
Pola
merchantId

string

Opcjonalnie. Identyfikator w 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.
couponCodes[]

string

Opcjonalnie. Lista kodów kuponów zastosowanych w koszyku. Kody kuponów na poziomie koszyka i produktu są niezależne od siebie.

Jeśli zdarzenie jest przeznaczone dla miejsca docelowego Google Analytics, podaj tylko jeden kod kuponu. Google Analytics ignoruje dodatkowe kody kuponów.

Element

Reprezentuje produkt w koszyku powiązany ze zdarzeniem.

Zapis JSON 
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": number,
  "itemId": string,
  "additionalItemParameters": [
    {
      object (ItemParameter)
    }
  ],
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "customVariables": [
    {
      object (ItemCustomVariable)
    }
  ],
  "conversionValue": 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.
itemId

string

Opcjonalnie. Unikalny identyfikator, który umożliwia odwoływanie się do elementu.
additionalItemParameters[]

object (ItemParameter)

Opcjonalnie. Zbiór parametrów zdarzenia związanych z produktem, które mają być uwzględnione w zdarzeniu, a nie zostały jeszcze określone za pomocą innych pól strukturalnych.
merchantId

string

Opcjonalnie. Identyfikator w Merchant Center powiązany z produktem. W przypadku zdarzeń związanych ze sprzedażą w sklepie stacjonarnym ta wartość zastąpi wartość ustawioną na poziomie koszyka. W przypadku innych zdarzeń to pole jest ignorowane.
merchantFeedLabel

string

Opcjonalnie. Etykieta pliku danych Merchant Center. Jeśli nadal używasz krajów, możesz zamiast nich użyć 2-literowego kodu kraju w formacie ISO-3166-1 alfa-2. W przypadku zdarzeń związanych ze sprzedażą w sklepie stacjonarnym ta wartość zastąpi wartość ustawioną na poziomie koszyka. W przypadku innych zdarzeń to pole jest ignorowane.
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.
customVariables[]

object (ItemCustomVariable)

Opcjonalnie. Dodatkowe informacje o parach klucz/wartość, które mają być wysyłane do kontenerów konwersji (działania powodującego konwersję lub aktywności Floodlight) podczas śledzenia konwersji poszczególnych produktów.
conversionValue

number

Opcjonalnie. Wartość konwersji powiązana z tym elementem w zdarzeniu w przypadku, gdy wartość konwersji jest inna dla każdego elementu.

ItemParameter

Zbiór parametrów zdarzenia związanych z produktem, które mają być uwzględnione w zdarzeniu, a nie zostały jeszcze określone za pomocą innych pól strukturalnych.

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

string

Wymagane. Nazwa parametru do użycia.
value

string

Wymagane. Ciąg znaków reprezentujący wartość parametru do ustawienia.

ItemCustomVariable

Zmienna niestandardowa na poziomie produktu 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ść do zapisania 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 to pole jest puste, użyta zostanie wartość Event.destination_references.

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ść do zapisania 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 to pole jest puste, użyta zostanie 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),
  "additionalUserProperties": [
    {
      object (UserProperty)
    }
  ]
}
Pola
customerType

enum (CustomerType)

Opcjonalnie. Typ klienta powiązanego ze zdarzeniem.
customerValueBucket

enum (CustomerValueBucket)

Opcjonalnie. Wartość klienta określona przez reklamodawcę.
additionalUserProperties[]

object (UserProperty)

Opcjonalnie. Zbiór dodatkowych właściwości użytkownika powiązanych z tym zdarzeniem.

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.

UserProperty

Zbiór dodatkowych właściwości użytkownika powiązanych z tym zdarzeniem.

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

string

Wymagane. Nazwa właściwości użytkownika do użycia.
value

string

Wymagane. Ciąg znaków reprezentujący wartość właściwości użytkownika do użycia.

EventParameter

Parametr zdarzenia w przypadku zdarzeń GA4.

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

string

Wymagane. Nazwa parametru do użycia.
value

string

Wymagane. Ciąg znaków reprezentujący wartość parametru do ustawienia.

EventLocation

Lokalizacja, w której wystąpiło zdarzenie.

Zapis JSON 
{
  "storeId": string,
  "city": string,
  "subdivisionCode": string,
  "regionCode": string,
  "subcontinentCode": string,
  "continentCode": string
}
Pola
storeId

string

Opcjonalnie. Wymagane w przypadku sprzedaży w sklepie. Identyfikator reprezentujący sklep stacjonarny, w którym wystąpiło zdarzenie.
city

string

Opcjonalnie. Nazwa miasta, w którym wystąpiło zdarzenie.
subdivisionCode

string

Opcjonalnie. Kod podziału administracyjnego zgodny ze standardem ISO 3166-2, w którym wystąpiło zdarzenie.
regionCode

string

Opcjonalnie. 2-literowy kod regionu CLDR w adresie użytkownika.
subcontinentCode

string

Opcjonalnie. Kod subkontynentu w formacie UN M49, na którym wystąpiło zdarzenie.
continentCode

string

Opcjonalnie. Kod kontynentu w formacie UN M49, na którym wystąpiło zdarzenie.