Method: customers.uploadClickConversions

Przetwarzanie podanych konwersji 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

string

To pole jest wymagane. Identyfikator klienta, który przesyła dane.

Treść żądania

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

Zapis JSON
{
  "conversions": [
    {
      object (ClickConversion)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean,
  "debugEnabled": boolean,
  "jobId": integer
}
Pola
conversions[]

object (ClickConversion)

To pole jest wymagane. Konwersje, które są przesyłane.

partialFailure

boolean

To pole jest wymagane. Jeśli ma wartość true (prawda), udane operacje będą wykonywane, a nieprawidłowe – zwrócą błędy. Jeśli ma wartość false (fałsz), wszystkie operacje są wykonywane w ramach jednej transakcji i tylko wtedy, gdy są prawidłowe. To pole zawsze powinno mieć wartość Prawda. Więcej informacji o częściowych błędach znajdziesz na stronie https://developers.google.com/google-ads/api/docs/best-practices/partial-failures.

validateOnly

boolean

Jeśli ma wartość true (prawda), żądanie jest weryfikowane, ale nie jest wykonywane. Zwracane są tylko błędy, a nie wyniki.

debugEnabled

boolean

Jeśli ma wartość true (prawda), interfejs API będzie sprawdzał przesyłanie i zwraca ewentualne błędy. Jeśli ma wartość false (fałsz), przeprowadza tylko podstawową weryfikację danych wejściowych, pomija kolejne kontrole przesyłania i zwraca powodzenie nawet wtedy, gdy w przypadku podanego atrybutu userIdentifiers nie znaleziono żadnego kliknięcia.

To ustawienie wpływa tylko na konwersje rozszerzone dotyczące przesyłanych danych o potencjalnych klientach, które korzystają z metody userIdentifiers zamiast GCLID, GBRAID lub WBRAID. Podczas przesyłania konwersji rozszerzonych dotyczących potencjalnych klientów musisz przesłać do interfejsu API wszystkie zdarzenia konwersji, także te, które nie pochodzą z kampanii Google Ads. Jeśli w tym polu ustawiono wartość true, przesłanie zdarzenia, które nie pochodzi z kampanii Google Ads, spowoduje pojawienie się błędu CLICK_NOT_FOUND. W przypadku takich zdarzeń te błędy są spodziewane, dlatego wybierz w tym polu wartość false, aby mieć pewność, że przesyłane pliki są prawidłowo sformatowane, ale zignorujesz CLICK_NOT_FOUND błędy w przypadku wszystkich konwersji niepochodzących z kampanii Google Ads. Dzięki temu skupisz się tylko na błędach, które można poprawić.

Wartość domyślna to false (fałsz).

jobId

integer

Opcjonalnie. Opcjonalne dane wejściowe ustawienia identyfikatora zadania. Musi być liczbą nieujemną, mniejszą 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 jobId UploadClickConversionsResponse.

Treść odpowiedzi

Odpowiedź na pytanie: ConversionUploadService.UploadClickConversions.

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

Zapis JSON
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (ClickConversionResult)
    }
  ],
  "jobId": string
}
Pola
partialFailureError

object (Status)

Błędy związane z nieudanymi konwersjami w trybie awarii częściowej. Zwracany, gdy w konwersji wystąpią wszystkie błędy. Jeśli jakiekolwiek błędy wystąpią poza konwersjami (np. błędy uwierzytelniania), zwrócimy błąd na poziomie RPC. Więcej informacji o częściowych błędach znajdziesz na stronie https://developers.google.com/google-ads/api/docs/best-practices/partial-failures.

results[]

object (ClickConversionResult)

Zwrot w przypadku pomyślnie przetworzonych konwersji. Pole Proto będzie puste w przypadku wierszy, w których wystąpił błąd. Gdy sprawdzanie poprawności ma wartość true (prawda), wyniki nie są zwracane.

jobId

string (int64 format)

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 omówieniu protokołu OAuth 2.0.

ClickConversion

Konwersja po kliknięciu.

Zapis JSON
{
  "gbraid": string,
  "wbraid": string,
  "externalAttributionData": {
    object (ExternalAttributionData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "cartData": {
    object (CartData)
  },
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "conversionEnvironment": enum (ConversionEnvironment),
  "consent": {
    object (Consent)
  },
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string,
  "conversionValue": number,
  "currencyCode": string,
  "orderId": string
}
Pola
gbraid

string

Identyfikator kliknięcia w przypadku kliknięć powiązanych z konwersjami w aplikacji i pochodzących z urządzeń z iOS od systemu iOS 14.

wbraid

string

Identyfikator kliknięcia w przypadku kliknięć powiązanych z konwersjami w witrynie i pochodzących z urządzeń z iOS od systemu iOS 14.

externalAttributionData

object (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 powinno być ustawione inaczej.

customVariables[]

object (CustomVariable)

Zmienne niestandardowe powiązane z tą konwersją.

cartData

object (CartData)

Dane koszyka powiązane z tą konwersją.

userIdentifiers[]

object (UserIdentifier)

Identyfikatory użytkownika powiązane z tą konwersją. W przesyłaniu konwersji obsługiwane są tylko wartości hashedEmail i hashedPhoneNumber. Maksymalna liczba identyfikatorów użytkownika na każdą konwersję to 5.

conversionEnvironment

enum (ConversionEnvironment)

Środowisko, w którym zarejestrowano tę konwersję, np. aplikacja lub witryna.

consent

object (Consent)

Ustawienie dotyczące zgody na przetwarzanie danych w przypadku zdarzenia.

gclid

string

Identyfikator kliknięcia Google (gclid) powiązany z tą konwersją.

conversionAction

string

Nazwa zasobu działania powodującego konwersję powiązanego z tą konwersją. Uwaga: mimo że 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

string

Data i godzina wystąpienia konwersji. Musi być późniejsza niż czas kliknięcia. Musisz określić strefę czasową. Format to „rrrr-mm-dd hh:mm:ss+|-gg:mm”, np. „2019-01-01 12:32:45-08:00”.

conversionValue

number

Wartość konwersji dla reklamodawcy.

currencyCode

string

Waluta powiązana z wartością konwersji. 3-znakowy kod waluty zgodny ze standardem ISO 4217. Na przykład: PLN, EUR.

orderId

string

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

number

Odzwierciedla odsetek konwersji, która została przypisana kliknięciu Google Ads.

externalAttributionModel

string

Określa nazwę modelu atrybucji.

CartData

Zawiera dodatkowe informacje o danych koszyka.

Zapis JSON
{
  "merchantId": string,
  "feedCountryCode": string,
  "feedLanguageCode": string,
  "localTransactionCost": number,
  "items": [
    {
      object (Item)
    }
  ]
}
Pola
merchantId

string (int64 format)

Identyfikator w Merchant Center, na które przesyłane są produkty.

feedCountryCode

string

Kod kraju powiązany z plikiem danych, w którym przesyłane są produkty.

feedLanguageCode

string

Kod języka powiązany z plikiem danych, w którym przesyłane są produkty.

localTransactionCost

number

Suma wszystkich rabatów na poziomie transakcji, takich jak bezpłatna dostawa i rabaty na kupony na cały koszyk. Kod waluty jest taki sam jak w wiadomości dotyczącej konwersji po kliknięciu.

items[]

object (Item)

Dane dotyczące kupionych produktów.

Element

Zawiera dane na temat kupionych produktów.

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

string

Identyfikator zakupu produktu. Musi być taki sam jak identyfikator produktu w Merchant Center.

quantity

integer

Liczba sprzedanych przedmiotów.

unitPrice

number

Cena za jednostkę bez podatku, dostawy i wszelkich rabatów na poziomie transakcji. Kod waluty jest taki sam jak w wiadomości dotyczącej konwersji po kliknięciu.

ConversionEnvironment

Środowisko, w którym wystąpiła przesłana konwersja.

Wartości w polu enum
UNSPECIFIED Nie określono.
UNKNOWN Używana tylko w przypadku wartości zwracanej. Reprezentuje wartość nieznaną w tej wersji.
APP Konwersja została zarejestrowana w aplikacji.
WEB Konwersja została zarejestrowana w witrynie.

ClickConversionResult

Identyfikacja informacji o poprawnie przetworzonej wartości ClickConversion.

Zapis JSON
{
  "gbraid": string,
  "wbraid": string,
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string
}
Pola
gbraid

string

Identyfikator kliknięcia w przypadku kliknięć powiązanych z konwersjami w aplikacji i pochodzących z urządzeń z iOS od systemu iOS 14.

wbraid

string

Identyfikator kliknięcia w przypadku kliknięć powiązanych z konwersjami w witrynie i pochodzących z urządzeń z iOS od systemu iOS 14.

userIdentifiers[]

object (UserIdentifier)

Identyfikatory użytkownika powiązane z tą konwersją. W przesyłaniu konwersji obsługiwane są tylko wartości hashedEmail i hashedPhoneNumber. Maksymalna liczba identyfikatorów użytkownika na każdą konwersję to 5.

gclid

string

Identyfikator kliknięcia Google (gclid) powiązany z tą konwersją.

conversionAction

string

Nazwa zasobu działania powodującego konwersję powiązanego z tą konwersją.

conversionDateTime

string

Data i godzina wystąpienia konwersji. Format to „rrrr-mm-dd hh:mm:ss+|-gg:mm”, np. „2019-01-01 12:32:45-08:00”.