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ń, które mają być wysyłane 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 zastosowanie do wszystkich użytkowników w żądaniu. Zgoda na poziomie użytkownika zastępuje zgodę na poziomie żądania i można ją określić w każdym Event.
validateOnly

boolean

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

enum (Encoding)

Opcjonalnie: Należy podać 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 zaszyfrowanych identyfikatorów użytkowników jest to typ kodowania zewnętrznego zaszyfrowanego ciągu znaków, ale niekoniecznie wewnętrznego zaszyfrowanego ciągu znaków, co oznacza, że wewnętrzny zaszyfrowany ciąg znaków może być zakodowany w inny sposób niż zewnętrzny zaszyfrowany ciąg znaków. W przypadku przesyłania innych plików niż UserData to pole jest ignorowane.
encryptionInfo

object (EncryptionInfo)

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

Treść odpowiedzi

Odpowiedź od: IngestEventsRequest.

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

Zapis JSON 
{
  "requestId": string,
  "fieldWarnings": [
    {
      object (FieldWarning)
    }
  ]
}
Pola
requestId

string

Automatycznie wygenerowany identyfikator prośby.
fieldWarnings[]

object (FieldWarning)

szczegółowe ostrzeżenia na poziomie wiersza ze ścieżkami pól;

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,
  "callInfo": {
    object (CallInfo)
  },
  "conversionValue": number,
  "conversionCount": number
}
Pola
destinationReferences[]

string

Opcjonalnie: Ciąg 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 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: Czas ostatniej aktualizacji 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".
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 udzielił różnych rodzajów zgody.
adIdentifiers

object (AdIdentifiers)

Opcjonalnie: identyfikatory i inne informacje używane do dopasowywania zdarzenia konwersji do innych działań 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 miało miejsce zdarzenie (w internecie, aplikacji, sklepie stacjonarnym itp.).
eventDeviceInfo

object (DeviceInfo)

Opcjonalnie: Informacje zebrane o urządzeniu, które było używane (jeśli dotyczy) 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ść, które mają być wysyłane do kontenerów konwersji (działanie powodujące konwersję lub aktywność Floodlight).
experimentalFields[]

object (ExperimentalField)

Opcjonalnie: Lista par klucz-wartość dla pól eksperymentalnych, które mogą zostać ostatecznie promowane jako część interfejsu API.
userProperties

object (UserProperties)

Opcjonalnie: Informacje o użytkowniku w momencie wystąpienia zdarzenia, które zostały ocenione przez reklamodawcę.
eventName

string

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

string

Opcjonalnie: Unikalny identyfikator instancji użytkownika klienta internetowego dla tego strumienia danych z sieci GA4.
userId

string

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

object (EventParameter)

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

object (UserData)

Opcjonalnie: Ten sam typ danych co w userData, ale wyraźnie oznaczony jako dane należące do firmy zewnętrznej, a nie do reklamodawcy.
eventLocation

object (EventLocation)

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

string

Opcjonalnie: Unikalny identyfikator instancji użytkownika klienta aplikacji dla tego strumienia danych z aplikacji GA4.
callInfo

object (CallInfo)

Opcjonalnie: Informacje zebrane o połączeniu (jeśli miało miejsce), które doprowadziło do tego zdarzenia.
conversionValue

number

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

number

Opcjonalnie: Liczba konwersji powiązanych ze zdarzeniem w przypadku konwersji opartych na zliczaniu.

AdIdentifiers

identyfikatory i inne informacje używane do dopasowywania zdarzenia konwersji do innych działań 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)
    }
  ],
  "ppid": string,
  "visitorPpid": string,
  "leadId": string
}
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ących 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 o urządzeniu używanym (jeśli dotyczy) w momencie wejścia na stronę reklamodawcy po interakcji z reklamą.
mobileDeviceId

string

Opcjonalnie: Identyfikator mobilny dla reklamodawców. Może to być IDFA na iOS, AdID na Androidzie lub identyfikatory dla reklamodawców na innych platformach.
dclid

string

Opcjonalnie: Identyfikator kliknięcia w sieci reklamowej 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.
ppid

string

Opcjonalnie: Unikalny identyfikator uwierzytelnionego (zalogowanego) użytkownika zdefiniowany przez wydawcę.
visitorPpid

string

Opcjonalnie: Unikalny identyfikator nieuwierzytelnionego użytkownika (użytkownika, który nie jest zalogowany) zdefiniowany przez wydawcę.
leadId

string

Opcjonalnie: Identyfikator wygenerowany przez Google, gdy użytkownik przesyła formularz kontaktowy.

EncryptedUserId

Identyfikator użytkownika wydany na potrzeby atrybucji. Jeśli używasz tego elementu, wszystkie pola są wymagane.

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

string

Wymagane. Zaszyfrowany identyfikator alfanumeryczny.
entityType

enum (EncryptionEntityType)

Wymagane. Typ encji szyfrowania. Powinna ona być zgodna z konfiguracją szyfrowania na potrzeby wyświetlania reklam lub Przenoszenia danych.
entityId

string (int64 format)

Wymagane. Identyfikator encji szyfrowania. Powinna ona być zgodna z konfiguracją szyfrowania na potrzeby wyświetlania reklam lub Przenoszenia danych.
source

enum (EncryptionSource)

Wymagane. Wskazuje, czy zaszyfrowany plik cookie został odebrany z serwera reklam (makro %m) czy z Przenoszenia danych.

EncryptionEntityType

Typ encji szyfrowania.

Wartości w polu enum
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED Nieokreślony typ encji szyfrowania.
CAMPAIGN_MANAGER_ACCOUNT Konto Campaign Managera 360.
CAMPAIGN_MANAGER_ADVERTISER reklamodawcą w usłudze Campaign Manager 360.
DISPLAY_VIDEO_PARTNER Partner w Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Reklamodawca w 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 zdarzenia. Nigdy nie należy go używać.
WEB Zdarzenie zostało wygenerowane w przeglądarce.
APP Zdarzenie zostało wygenerowane przez aplikację.
IN_STORE Zdarzenie zostało wygenerowane na podstawie transakcji w sklepie.
PHONE Zdarzenie zostało wygenerowane na podstawie połączenia telefonicznego.
MESSAGE Wydarzenie zostało wygenerowane na podstawie wiadomości.
OTHER Zdarzenie 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 o produktach.
merchantFeedLanguageCode

string

Opcjonalnie: Kod języka w formacie ISO 639-1 powiązany z plikiem danych Merchant Center, w którym przesyłasz 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 do koszyka. 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 1 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 tych produktów powiązanych ze zdarzeniem.
unitPrice

number

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

string

Opcjonalnie: Unikalny identyfikator elementu.
additionalItemParameters[]

object (ItemParameter)

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

string

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

string

Opcjonalnie: Etykieta pliku danych Merchant Center. Jeśli kraje są nadal używane, można zamiast tego użyć 2-literowego kodu kraju w formacie ISO-3166-1 alfa-2. W przypadku zdarzeń sprzedaży w sklepie stacjonarnym zastąpi to 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łasz 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 dotyczących poszczególnych produktów.
conversionValue

number

Opcjonalnie: Wartość konwersji powiązana z tym elementem w ramach zdarzenia, gdy wartość konwersji jest różna dla każdego elementu.

ItemParameter

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

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

string

Wymagane. Nazwa parametru, którego chcesz użyć.
value

string

Wymagane. Reprezentacja ciągu znaków wartości 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, którą chcesz ustawić. Jeśli zmienna nie zostanie znaleziona w danym miejscu docelowym, zostanie zignorowana.
value

string

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

string

Opcjonalnie: Ciąg referencyjny używany do określenia, do którego Event.destination_references ma zostać wysłana zmienna niestandardowa. Jeśli pole jest puste, używana jest 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, którą chcesz ustawić. Jeśli zmienna nie zostanie znaleziona w danym miejscu docelowym, zostanie zignorowana.
value

string

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

string

Opcjonalnie: Ciąg referencyjny używany do określenia, do którego Event.destination_references ma zostać wysłana zmienna niestandardowa. Jeśli pole jest puste, używana jest wartość Event.destination_references.

ExperimentalField

Pole eksperymentalne reprezentujące pola nieoficjalne.

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 w momencie wystąpienia zdarzenia, które zostały ocenione przez reklamodawcę. 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 oszacowana 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 wszedł w interakcję z reklamodawcą.

CustomerValueBucket

Wartość klienta oszacowana przez reklamodawcę.

Wartości w polu enum
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Nieokreślona wartość 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, której chcesz użyć.
value

string

Wymagane. Reprezentacja ciągu znaków wartości właściwości użytkownika, której chcesz użyć.

EventParameter

Parametr zdarzenia w przypadku zdarzeń GA4.

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

string

Wymagane. Nazwa parametru, którego chcesz użyć.
value

string

Wymagane. Reprezentacja ciągu znaków wartości 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 miało miejsce zdarzenie.
city

string

Opcjonalnie: Nazwa miasta, w którym miało miejsce zdarzenie.
subdivisionCode

string

Opcjonalnie: Kod regionu w formacie ISO 3166-2, w którym miało miejsce zdarzenie.
regionCode

string

Opcjonalnie: Dwuliterowy 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, na którym miało miejsce zdarzenie, w formacie UN M49.

CallInfo

Informacje zebrane o połączeniu (jeśli miało miejsce), które doprowadziło do tego zdarzenia.

Zapis JSON 
{
  "startTimestamp": string
}
Pola
startTimestamp

string (Timestamp format)

Wymagane. Godzina rozpoczęcia połączenia telefonicznego, które spowodowało to zdarzenie.

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".