Package google.shopping.merchant.conversions.v1beta

Индекс

Служба конверсионных источников

Сервис для управления источниками конверсий для мерчант-аккаунта.

CreateConversionSource

rpc CreateConversionSource( CreateConversionSourceRequest ) returns ( ConversionSource )

Создает новый источник конверсий.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/content

Для получения дополнительной информации см.OAuth 2.0 Overview .

Удалитьконверсиюсаурце

rpc DeleteConversionSource( DeleteConversionSourceRequest ) returns ( Empty )

Архивирует существующий источник конверсий. Если источником конверсии является пункт назначения Merchant Center, его можно будет восстановить в течение 30 дней. Если источником конверсии является ссылка Google Analytics, она будет немедленно удалена и ее можно будет восстановить, создав новую.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/content

Для получения дополнительной информации см.OAuth 2.0 Overview .

GetConversionSource

rpc GetConversionSource( GetConversionSourceRequest ) returns ( ConversionSource )

Получает источник конверсии.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/content

Для получения дополнительной информации см.OAuth 2.0 Overview .

Список источников конверсий

rpc ListConversionSources( ListConversionSourcesRequest ) returns ( ListConversionSourcesResponse )

Получает список источников конверсий, к которым имеет доступ вызывающий объект.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/content

Для получения дополнительной информации см.OAuth 2.0 Overview .

UndeleteConversionSource

rpc UndeleteConversionSource( UndeleteConversionSourceRequest ) returns ( ConversionSource )

Повторно включает архивный источник конверсий. Доступно только для целевых источников конверсий Merchant Center.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/content

Для получения дополнительной информации см.OAuth 2.0 Overview .

ОбновлениеConversionSource

rpc UpdateConversionSource( UpdateConversionSourceRequest ) returns ( ConversionSource )

Обновляет информацию о существующем источнике конверсий. Доступно только для целевых источников конверсий Merchant Center.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/content

Для получения дополнительной информации см.OAuth 2.0 Overview .

Настройки атрибуции

Представляет настройки атрибуции для источников конверсий, получающих данные предварительной атрибуции.

Поля
attribution_ lookback_ window_ days

int32

Необходимый. Окна ретроспективного анализа (в днях), используемые для атрибуции в этом источнике. Поддерживаемые значения: 7, 30, 40.

attribution_ model

AttributionModel

conversion_ type[]

ConversionType

Неизменяемый. Неупорядоченный список. Список различных типов конверсий, к которым можно отнести событие конверсии. Стандартный тип «покупка» будет создан автоматически, если этот список пуст на момент создания.

Модель атрибуции

Модель атрибуции, использованная для этого источника. Мы поддерживаем тот же набор моделей, что и Google Analytics 4, как описано в: https://support.google.com/analytics/answer/10596866 .

Перечисления
ATTRIBUTION_MODEL_UNSPECIFIED Неуказанная модель.
CROSS_CHANNEL_LAST_CLICK Межканальная модель последнего клика.
ADS_PREFERRED_LAST_CLICK Модель последнего клика, предпочтительная для рекламы.
CROSS_CHANNEL_DATA_DRIVEN Межканальная модель, управляемая данными.
CROSS_CHANNEL_FIRST_CLICK Межканальная модель первого клика.
CROSS_CHANNEL_LINEAR Межканальная линейная модель.
CROSS_CHANNEL_POSITION_BASED Межканальная модель на основе позиции.
CROSS_CHANNEL_TIME_DECAY Межканальная модель временного распада.

Тип конверсии

Сообщение, представляющее типы событий-конверсий

Поля
name

string

Только вывод. Название события конверсии, как оно будет сообщено клиентом.

report

bool

Только вывод. Опция, указывающая, следует ли включать этот тип в отчеты Merchant Center.

Источник конверсии

Представляет источник конверсий, принадлежащий учетной записи продавца. Мерчант-аккаунт может иметь до 200 источников конверсий.

Поля
name

string

Только вывод. Идентификатор. Создается Content API при создании нового ConversionSource . Формат: [az]{4}:.+ Четыре символа перед двоеточием обозначают тип источника преобразования. Содержимое после двоеточия представляет собой идентификатор источника конверсии внутри этого типа. Идентификаторы двух разных источников конверсий могут быть одинаковыми для разных типов. Поддерживаются следующие префиксы типов: - galk: для источников GoogleAnalyticsLink. - mcdn: для источников MerchantCenterDestination.

state

State

Только вывод. Текущее состояние этого источника конверсий. Невозможно редактировать через API.

expire_ time

Timestamp

Только вывод. Время, когда заархивированный источник конверсий удаляется без возможности восстановления и становится недоступным для восстановления.

controller

Controller

Только вывод. Контроллер источника преобразования.

Поле объединения source_data . Необходимый. Данные источника конверсий, специфичные для каждого типа источника. source_data может быть только одним из следующих:
merchant_ center_ destination

MerchantCenterDestination

Источник конверсий типа "Назначение тега Merchant Center".

Контроллер

Объект, контролирующий источник конверсий.

Перечисления
CONTROLLER_UNSPECIFIED Значение по умолчанию. Это значение не используется.
MERCHANT Контролируется Продавцом, которому принадлежит Источник конверсий.
YOUTUBE_AFFILIATES Контролируется программой YT Affiliates.

Состояние

Представляет состояние источника преобразования.

Перечисления
STATE_UNSPECIFIED Источник преобразования имеет неопределенное состояние.
ACTIVE Источник конверсий полностью функционален.
ARCHIVED Источник конверсий был заархивирован за последние 30 дней и в настоящее время не работает. Можно восстановить методом восстановления.
PENDING Создание источника конверсий началось, но еще не завершено.

CreateConversionSourceRequest

Сообщение запроса для метода CreateConversionSource.

Поля
parent

string

Необходимый. Торговый аккаунт, которому будет принадлежать новый источник конверсий. Формат: аккаунты/{аккаунт}

conversion_ source

ConversionSource

Необходимый. Описание источника конверсии. При создании ему будет автоматически присвоен новый идентификатор.

Удалениеконверсиисаурцерекуест

Сообщение запроса для метода DeleteConversionSource.

Поля
name

string

Необходимый. Имя источника конверсии, который нужно удалить. Формат: account/{account}/conversionSources/{conversion_source}.

GetConversionSourceRequest

Сообщение запроса для метода GetConversionSource.

Поля
name

string

Необходимый. Имя источника конверсии, который нужно получить. Формат: account/{account}/conversionSources/{conversion_source}.

Запрос ListConversionSourcesRequest

Сообщение запроса для метода ListConversionSources.

Поля
parent

string

Необходимый. Торговый аккаунт, которому принадлежит коллекция источников конверсий. Формат: аккаунты/{аккаунт}

page_ size

int32

Необязательный. Максимальное количество источников конверсий, возвращаемых на странице. Если page_size не указан, в качестве значения по умолчанию используется 100 . Максимальное значение — 200 . Значения выше 200 будут уменьшены до 200 . Независимо от нумерации страниц, всего возвращается не более 200 источников конверсий.

page_ token

string

Необязательный. Токен страницы.

show_ deleted

bool

Необязательный. Показать удаленную (заархивированную) опцию.

ListConversionSourcesResponse

Ответное сообщение для метода ListConversionSources.

Поля
conversion_ sources[]

ConversionSource

Список источников конверсий.

next_ page_ token

string

Токен, который будет использоваться для получения следующей страницы результатов.

MerchantCenterDestination

Источники "Назначение Merchant Center" можно использовать для отправки событий конверсии из интернет-магазина с помощью тега Google непосредственно в аккаунт Merchant Center, где создан источник.

Поля
destination

string

Только вывод. Идентификатор места назначения Merchant Center.

attribution_ settings

AttributionSettings

Необходимый. Настройки атрибуции, используемые для пункта назначения Merchant Center.

display_ name

string

Необходимый. Отображаемое имя пункта назначения, указанное продавцом. Это имя, которое идентифицирует источник конверсии в пользовательском интерфейсе Merchant Center. Ограничено 64 символами.

currency_ code

string

Необходимый. Трехбуквенный код валюты (ISO 4217). Код валюты определяет, в какой валюте конвертации, отправленные в этот пункт назначения, будут учитываться в Merchant Center.

Восстановить конверсиюсаурцереквест

Сообщение запроса для метода UndeleteConversionSource.

Поля
name

string

Необходимый. Имя источника конверсии, удаление которого требуется восстановить. Формат: account/{account}/conversionSources/{conversion_source}.

UpdateConversionSourceRequest

Сообщение запроса для метода UpdateConversionSource.

Поля
conversion_ source

ConversionSource

Необходимый. Новая версия исходных данных конверсий. Формат: account/{account}/conversionSources/{conversion_source}.

update_ mask

FieldMask

Необязательный. Список полей обновляется.