- Żądanie HTTP
- Parametry ścieżki
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- ClickConversion
- ExternalAttributionData
- CartData
- Element
- ConversionEnvironment
- ClickConversionResult
- Wypróbuj
Przetwarza podane konwersje po kliknięciu.
Lista zgłoszonych błędów: AuthenticationError AuthorizationError ConversionUploadError HeaderError InternalError PartialFailureError QuotaError RequestError
Żądanie HTTP
POST https://googleads.googleapis.com/v16/customers/{customerId}:uploadClickConversions
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
customerId |
Wymagane. Identyfikator klienta wykonującego przesyłanie. |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"conversions": [
{
object ( |
Pola | |
---|---|
conversions[] |
Wymagane. Przesłane konwersje. |
partialFailure |
Wymagane. Jeśli ma wartość true (prawda), wykonywane są udane operacje, a nieprawidłowe – zwracają błędy. W przypadku wartości false (fałsz) wszystkie operacje będą wykonywane w ramach jednej transakcji tylko wtedy, gdy są prawidłowe. W tym polu zawsze powinna być ustawiona wartość Prawda. Więcej informacji o częściowej awarii znajdziesz na stronie https://developers.google.com/google-ads/api/docs/best-practices/partial-failures. |
validateOnly |
Jeśli ma wartość true (prawda), żądanie jest weryfikowane, ale nie jest wykonywane. Zwracane są tylko błędy, a nie wyniki. |
debugEnabled |
Jeśli ma wartość prawda, interfejs API przeprowadza wszystkie testy przesyłania i zwraca błędy, jeśli zostaną znalezione. W przypadku wartości false (fałsz) wykona tylko podstawową weryfikację danych wejściowych, pomija kolejne kontrole przesyłania i zwróci sukces, nawet jeśli w przypadku podanej wartości To ustawienie wpływa tylko na konwersje rozszerzone dotyczące przesyłanych danych o potencjalnych klientach, które używają parametru Wartość domyślna to false (fałsz). |
jobId |
Opcjonalnie: Opcjonalne dane wejściowe do ustawienia identyfikatora zadania. Wartość musi być liczbą nieujemną, która jest mniejsza niż 2^31, jeśli została podana. Jeśli to pole nie zostanie podane, interfejs API wygeneruje identyfikator zadania z zakresu [2^31, (2^63)-1]. Interfejs API zwróci wartość tego żądania w polu |
Treść odpowiedzi
Wiadomość z odpowiedzią dla: ConversionUploadService.UploadClickConversions
.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "partialFailureError": { object ( |
Pola | |
---|---|
partialFailureError |
Błędy, które dotyczą niepowodzeń konwersji w trybie częściowej awarii. Zwracany, gdy w konwersjach wystąpią wszystkie błędy. Jeśli wystąpią jakieś błędy poza konwersjami (np. błędy uwierzytelniania), zwrócimy błąd na poziomie RPC. Więcej informacji o częściowej awarii znajdziesz na stronie https://developers.google.com/google-ads/api/docs/best-practices/partial-failures. |
results[] |
Zwracany w przypadku pomyślnie przetworzonych konwersji. Protokół Proto będzie pusty w wierszach, w których wystąpił błąd. Wyniki nie są zwracane, jeśli parametr validateOnly ma wartość true. |
jobId |
Identyfikator zadania dla przesyłanej partii. |
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/adwords
Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.
ClickConversion
Konwersja po kliknięciu.
Zapis JSON |
---|
{ "gbraid": string, "wbraid": string, "externalAttributionData": { object ( |
Pola | |
---|---|
gbraid |
Identyfikator kliknięcia w przypadku kliknięć powiązanych z konwersjami w aplikacji i pochodzących z urządzeń z iOS od iOS 14. |
wbraid |
Identyfikator kliknięcia w przypadku kliknięć powiązanych z konwersjami w witrynie i pochodzących z urządzeń z iOS od wersji 14. |
externalAttributionData |
Dodatkowe dane o konwersjach przypisanych zewnętrznie. To pole jest wymagane w przypadku konwersji z działaniem powodującym konwersję przypisanym zewnętrznie, ale nie należy ustawiać go w inny sposób. |
customVariables[] |
Zmienne niestandardowe powiązane z tą konwersją. |
cartData |
Dane koszyka powiązane z tą konwersją. |
userIdentifiers[] |
Identyfikatory użytkownika powiązane z daną konwersją. Przesyłanie konwersji obsługuje tylko hashedEmail i hashedPhoneNumber. Maksymalna liczba identyfikatorów użytkownika dla każdej konwersji to 5. |
conversionEnvironment |
Środowisko, w którym została zarejestrowana ta konwersja, np. Aplikacja lub Internet. |
consent |
Ustawienie dotyczące zgody w przypadku danego zdarzenia. |
gclid |
Identyfikator kliknięcia Google (gclid) powiązany z tą konwersją. |
conversionAction |
Nazwa zasobu powiązanego z działaniem powodującym konwersję. Uwaga: chociaż ta nazwa zasobu składa się z identyfikatora klienta i identyfikatora działania powodującego konwersję, weryfikacja zignoruje identyfikator klienta i użyje identyfikatora działania powodującego konwersję jako jedynego identyfikatora działania powodującego konwersję. |
conversionDateTime |
Data i godzina wystąpienia konwersji. Musi być późniejsza niż data kliknięcia. Musisz określić strefę czasową. Użyj formatu „rrrr-mm-dd gg:mm:ss+|-gg:mm”, np. „2019-01-01 12:32:45-08:00”. |
conversionValue |
Wartość konwersji dla reklamodawcy. |
currencyCode |
Waluta powiązana z wartością konwersji. Jest to 3-znakowy kod waluty w standardzie ISO 4217. np. USD, EUR. |
orderId |
Identyfikator zamówienia powiązany z konwersją. Identyfikatora zamówienia można użyć tylko dla jednej konwersji na działanie powodujące konwersję. |
ExternalAttributionData
Zawiera dodatkowe informacje o konwersjach przypisanych zewnętrznie.
Zapis JSON |
---|
{ "externalAttributionCredit": number, "externalAttributionModel": string } |
Pola | |
---|---|
externalAttributionCredit |
Reprezentuje część konwersji przypisanej do kliknięcia Google Ads. |
externalAttributionModel |
Określa nazwę modelu atrybucji. |
CartData
Zawiera dodatkowe informacje o danych koszyka.
Zapis JSON |
---|
{
"merchantId": string,
"feedCountryCode": string,
"feedLanguageCode": string,
"localTransactionCost": number,
"items": [
{
object ( |
Pola | |
---|---|
merchantId |
Identyfikator w Merchant Center, do którego przesyłane są produkty. |
feedCountryCode |
Kod kraju powiązany z plikiem danych, w którym przesyłane są produkty. |
feedLanguageCode |
Kod języka powiązany z plikiem danych, w którym przesyłane są produkty. |
localTransactionCost |
Suma wszystkich rabatów na poziomie transakcji, takich jak bezpłatna dostawa i rabaty kuponów na cały koszyk. Kod waluty jest taki sam jak w wiadomości ClickConversion. |
items[] |
Dane kupionych produktów. |
Element
Zawiera dane o zakupionych produktach.
Zapis JSON |
---|
{ "productId": string, "quantity": integer, "unitPrice": number } |
Pola | |
---|---|
productId |
Identyfikator produktu. Musi być równy identyfikatorowi produktu w Merchant Center. |
quantity |
Liczba sprzedanych przedmiotów. |
unitPrice |
Cena jednostkowa z wyłączeniem podatku, dostawy i wszelkich rabatów na poziomie transakcji. Kod waluty jest taki sam jak w wiadomości ClickConversion. |
ConversionEnvironment
Środowisko, w którym przesłano konwersję.
Wartości w polu enum | |
---|---|
UNSPECIFIED |
Nie określono. |
UNKNOWN |
Używany tylko w przypadku zwracanej wartości. Reprezentuje wartość nieznaną w tej wersji. |
APP |
Konwersja została zarejestrowana w aplikacji. |
WEB |
Konwersja została zarejestrowana w witrynie. |
ClickConversionResult
Identyfikowanie informacji dotyczących pomyślnie przetworzonej konwersji ClickConversion.
Zapis JSON |
---|
{
"gbraid": string,
"wbraid": string,
"userIdentifiers": [
{
object ( |
Pola | |
---|---|
gbraid |
Identyfikator kliknięcia w przypadku kliknięć powiązanych z konwersjami w aplikacji i pochodzących z urządzeń z iOS od iOS 14. |
wbraid |
Identyfikator kliknięcia w przypadku kliknięć powiązanych z konwersjami w witrynie i pochodzących z urządzeń z iOS od wersji 14. |
userIdentifiers[] |
Identyfikatory użytkownika powiązane z daną konwersją. Przesyłanie konwersji obsługuje tylko hashedEmail i hashedPhoneNumber. Maksymalna liczba identyfikatorów użytkownika dla każdej konwersji to 5. |
gclid |
Identyfikator kliknięcia Google (gclid) powiązany z daną konwersją. |
conversionAction |
Nazwa zasobu powiązanego z działaniem powodującym konwersję. |
conversionDateTime |
Data i godzina wystąpienia konwersji. Użyj formatu „rrrr-mm-dd gg:mm:ss+|-gg:mm”, np. „2019-01-01 12:32:45-08:00”. |