- HTTP-запрос
- Параметры пути
- Тело запроса
- Тело ответа
- Области авторизации
- НажмитеКонверсия
- Внешние данные атрибуции
- Данные корзины
- Элемент
- Конверсионная среда
- НажмитеКонверсияРезультат
- Попробуй это!
Обрабатывает указанные конверсии по кликам.
Список выброшенных ошибок: AuthenticationError AuthorizationError ConversionUploadError HeaderError InternalError PartialFailureError QuotaError RequestError
HTTP-запрос
POST https://googleads.googleapis.com/v14/customers/{customerId}:uploadClickConversions
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
customerId | Необходимый. Идентификатор клиента, выполняющего загрузку. |
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{
"conversions": [
{
object ( |
Поля | |
---|---|
conversions[] | Необходимый. Конверсии, которые загружаются. |
partialFailure | Необходимый. Если это правда, будут выполнены успешные операции, а недопустимые операции вернут ошибки. Если false, все операции будут выполняться за одну транзакцию тогда и только тогда, когда все они действительны. Для этого параметра всегда должно быть установлено значение true. Дополнительную информацию о частичном сбое см. на странице https://developers.google.com/google-ads/api/docs/best-practices/partial-failures . |
validateOnly | Если это правда, запрос проверяется, но не выполняется. Возвращаются только ошибки, а не результаты. |
debugEnabled | Если это правда, API выполнит все проверки загрузки и вернет ошибки, если таковые будут обнаружены. Если значение равно false, он будет выполнять только базовую проверку ввода, пропускать последующие проверки загрузки и возвращать успех, даже если для предоставленных Этот параметр влияет только на расширенное преобразование для загрузок потенциальных клиентов, которые используют По умолчанию — ложь. |
Тело ответа
Ответное сообщение для ConversionUploadService.UploadClickConversions
.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{ "partialFailureError": { object ( |
Поля | |
---|---|
partialFailureError | Ошибки, связанные со сбоями преобразования в режиме частичного сбоя. Возвращается, когда внутри преобразований возникают все ошибки. Если возникают какие-либо ошибки вне преобразований (например, ошибки аутентификации), мы возвращаем ошибку уровня RPC. Дополнительную информацию о частичном сбое см. на странице https://developers.google.com/google-ads/api/docs/best-practices/partial-failures . |
results[] | Возвращается для успешно обработанных конверсий. Proto будет пустым для строк, получивших ошибку. Результаты не возвращаются, если validateOnly имеет значение true. |
jobId | Идентификатор задания для пакета загрузки. |
Области авторизации
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/adwords
Дополнительную информацию см. в обзоре OAuth 2.0 .
НажмитеКонверсия
Конверсия по кликам.
JSON-представление |
---|
{ "gbraid": string, "wbraid": string, "externalAttributionData": { object ( |
Поля | |
---|---|
gbraid | Идентификатор клика для кликов, связанных с конверсиями в приложении и происходящих с устройств iOS, начиная с iOS14. |
wbraid | Идентификатор клика для кликов, связанных с веб-конверсиями и исходящих с устройств iOS, начиная с iOS14. |
externalAttributionData | Дополнительные данные о конверсиях с внешней атрибуцией. Это поле является обязательным для конверсий с действием-конверсией с внешней атрибуцией, но не должно быть указано иное. |
customVariables[] | Пользовательские переменные, связанные с этим преобразованием. |
cartData | Данные корзины, связанные с этой конверсией. |
userIdentifiers[] | Идентификаторы пользователей, связанные с этим преобразованием. Для загрузки конверсий поддерживаются только hashedEmail и hashedPhoneNumber. Максимальное количество идентификаторов пользователей для каждой конверсии — 5. |
conversionEnvironment | Среда, в которой было зарегистрировано это преобразование, например приложение или Интернет. |
gclid | Идентификатор клика Google (gclid), связанный с этой конверсией. |
conversionAction | Название ресурса действия-конверсии, связанного с этой конверсией. Примечание. Хотя имя этого ресурса состоит из идентификатора клиента и идентификатора действия-конверсии, при проверке идентификатор клиента будет игнорироваться, а идентификатор действия-конверсии будет использоваться в качестве единственного идентификатора действия-конверсии. |
conversionDateTime | Дата и время, когда произошло преобразование. Должно быть после времени клика. Часовой пояс должен быть указан. Формат: «гггг-мм-дд чч:мм:сс+|-чч:мм», например «2019-01-01 12:32:45-08:00». |
conversionValue | Ценность конверсии для рекламодателя. |
currencyCode | Валюта, связанная со стоимостью конверсии. Это трехзначный код валюты ISO 4217. Например: доллар США, евро. |
orderId | Идентификатор заказа, связанный с конверсией. Идентификатор заказа можно использовать только для одной конверсии на одно действие-конверсию. |
Внешние данные атрибуции
Содержит дополнительную информацию о конверсиях с внешней атрибуцией.
JSON-представление |
---|
{ "externalAttributionCredit": number, "externalAttributionModel": string } |
Поля | |
---|---|
externalAttributionCredit | Представляет долю конверсии, связанную с кликом Google Рекламы. |
externalAttributionModel | Указывает имя модели атрибуции. |
Данные корзины
Содержит дополнительную информацию о данных корзины.
JSON-представление |
---|
{
"merchantId": string,
"feedCountryCode": string,
"feedLanguageCode": string,
"localTransactionCost": number,
"items": [
{
object ( |
Поля | |
---|---|
merchantId | Идентификатор Merchant Center, куда загружаются товары. |
feedCountryCode | Код страны, связанный с фидом, в который загружаются элементы. |
feedLanguageCode | Код языка, связанный с фидом, в который загружаются элементы. |
localTransactionCost | Сумма всех скидок на уровне транзакции, таких как бесплатная доставка и скидки по купонам для всей корзины. Код валюты тот же, что и в сообщении ClickConversion. |
items[] | Данные о купленных товарах. |
Элемент
Содержит данные о купленных товарах.
JSON-представление |
---|
{ "productId": string, "quantity": integer, "unitPrice": number } |
Поля | |
---|---|
productId | Торговый идентификатор товара. Должно быть равно идентификатору продукта Merchant Center. |
quantity | Количество проданных товаров. |
unitPrice | Цена за единицу без учета налогов, доставки и скидок на уровне транзакции. Код валюты тот же, что и в сообщении ClickConversion. |
Конверсионная среда
Среда конвертации загруженной конверсии.
Перечисления | |
---|---|
UNSPECIFIED | Не указан. |
UNKNOWN | Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии. |
APP | Конверсия была зафиксирована в приложении. |
WEB | Конверсия была зафиксирована на веб-сайте. |
НажмитеКонверсияРезультат
Идентификационная информация для успешно обработанного ClickConversion.
JSON-представление |
---|
{
"gbraid": string,
"wbraid": string,
"userIdentifiers": [
{
object ( |
Поля | |
---|---|
gbraid | Идентификатор клика для кликов, связанных с конверсиями в приложении и происходящих с устройств iOS, начиная с iOS14. |
wbraid | Идентификатор клика для кликов, связанных с веб-конверсиями и исходящих с устройств iOS, начиная с iOS14. |
userIdentifiers[] | Идентификаторы пользователей, связанные с этим преобразованием. Для загрузки конверсий поддерживаются только hashedEmail и hashedPhoneNumber. Максимальное количество идентификаторов пользователей для каждой конверсии — 5. |
gclid | Идентификатор клика Google (gclid), связанный с этой конверсией. |
conversionAction | Название ресурса действия-конверсии, связанного с этой конверсией. |
conversionDateTime | Дата и время, когда произошло преобразование. Формат: «гггг-мм-дд чч:мм:сс+|-чч:мм», например «2019-01-01 12:32:45-08:00». |