REST Resource: customers.userLists

Ресурс: список пользователей

Определяет список пользователей, управляемый Ads Data Hub.

Представление JSON
{
  "name": string,
  "userListId": string,
  "adsDataCustomerId": string,
  "title": string,
  "description": string,
  "type": enum (UserListType),
  "createEmail": string,
  "listSize": string,
  "populateTime": string,
  "recipientAdsDataLinks": [
    string
  ],
  "state": enum (State),

  // Union field user_list can be only one of the following:
  "frequencyList": {
    object (FrequencyBasedListInfo)
  },
  "remarketingList": {
    object (RemarketingListInfo)
  }
  // End of list of possible types for union field user_list.
}
Поля
name

string

Только вывод. Имя, которое однозначно идентифицирует список пользователей Ads Data Hub. Он имеет форму customers/[customerId]/userLists/[userListId]

userListId

string ( int64 format)

Только вывод. Идентификатор списка пользователей. Это поле создается службой и используется для заполнения UserList.

adsDataCustomerId

string ( int64 format)

Неизменный. Связанный идентификатор клиента Ads Data Hub, связанный с этим списком пользователей. Этот идентификатор должен быть указан как adsDataCustomerId при выполнении заданий UserListQuery с использованием этого списка пользователей. Если отсутствует, будет использоваться родительский клиент. Это нельзя изменить после создания списка.

title

string

Необходимый. Название списка пользователей, уникальное для указанного adsDataCustomerId.

description

string

Необходимый. Описание списка пользователей.

type

enum ( UserListType )

Только вывод. Значения типа UserList должны быть согласованы с userList. Это значение доступно только для чтения и будет доступно для запросов get/list.

createEmail

string

Только вывод. Адрес электронной почты пользователя, создавшего этот список пользователей.

listSize

string ( int64 format)

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

populateTime

string ( Timestamp format)

Только вывод. Время последнего заполнения списка.

Временная метка в формате RFC3339 UTC "Zulu" с разрешением в наносекунды и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

state

enum ( State )

Только вывод. Состояние списка пользователей (Активный/Удаленный). Это значение доступно только для чтения и будет доступно для запросов get/list.

Поле user_list . Дальнейшая настройка в зависимости от типа списка пользователей.

Точно один должен быть установлен. user_list может быть только одним из следующих:

frequencyList

object ( FrequencyBasedListInfo )

Список пользователей для ограничения частоты показов.

remarketingList

object ( RemarketingListInfo )

Список ремаркетинга.

UserListType

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

перечисления
USER_LIST_TYPE_UNSPECIFIED Значение по умолчанию: не следует использовать.
REMARKETING Аудитории ремаркетинга, созданные с помощью SQL-запросов в ADH. Список ремаркетинга можно использовать для положительного и отрицательного таргетинга.
FREQUENCY_BASED Аудитория с ограниченной частотой. Аудитории такого типа ограничены негативным таргетингом.

Информация о списке на основе частоты

Метаданные для частотного списка пользователей.

Представление JSON
{
  "dv360LineitemIds": [
    string
  ],
  "cmCampaignIds": [
    string
  ],
  "googleAdsCampaignIds": [
    string
  ],
  "eventMatchers": [
    {
      object (EventMatcher)
    }
  ],
  "frequencyConstraint": {
    object (FrequencyConstraint)
  },
  "slidingWindowDays": integer
}
Поля
dv360LineitemIds[]
(deprecated)

string ( int64 format)

Идентификаторы позиций DV360, которые влияют на частоту.

cmCampaignIds[]
(deprecated)

string ( int64 format)

Идентификаторы для кампаний CM, которые способствуют частоте.

googleAdsCampaignIds[]
(deprecated)

string ( int64 format)

Идентификаторы кампаний Google Ads, которые влияют на частоту.

eventMatchers[]

object ( EventMatcher )

Какие события влияют на частоту. При создании списков пользователей, основанных на частоте, предпочтительным является eventMatchers для указания событий, влияющих на частоту. dv360LineitemIds, cmCampaignIds и googleAdsCampaignIds используются, если eventMatchers пуст.

frequencyConstraint

object ( FrequencyConstraint )

Описывает, когда пользователь добавляется в список.

slidingWindowDays

integer

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

Сопоставление событий

Общее событие, влияющее на частоту.

Представление JSON
{
  "matchType": enum (MatchType),
  "value": string
}
Поля
matchType

enum ( MatchType )

Тип ограничения, которое будет включено в подсчет частоты.

value

string

Значение ограничения. Например, для указания идентификатора кампании Google Реклама = 1234, matchType будет GOOGLE_ADS_CAMPAIGN_ID, а значение будет «1234». События, имеющие это значение для соответствующего MatchType, будут включены в подсчет частоты.

Тип соответствия

Типы ограничений, поддерживаемые для подсчета частоты. В будущем в это перечисление могут быть добавлены дополнительные типы для поддержки дополнительных ограничений. Вы можете указать фильтр для MatchType в DescribeValidFrequencyLimitingEventMatchersRequest, чтобы ограничить сопоставители событий, возвращаемые в результатах, только теми, которые поддерживаются вашим API. Например, установка фильтра как "eventMatcher.match_type=CM_CAMPAIGN_ID ИЛИ eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID" вернет EventMatcher только этих двух типов.

перечисления
MATCH_TYPE_UNSPECIFIED Значение по умолчанию. Это значение не используется.
CM_CAMPAIGN_ID Тип ограничения, представляющий идентификатор кампании Менеджера кампаний.
DV360_INSERTION_ORDER_ID Тип ограничения, представляющий идентификатор заказа на размещение DV360.
DV360_LINE_ITEM_ID Тип ограничения, представляющий идентификатор позиции DV360.
GOOGLE_ADS_CAMPAIGN_ID Тип ограничения, представляющий идентификатор кампании Google Реклама.

ЧастотаОграничение

Укажите минимальное количество событий для шапки.

Представление JSON
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
Поля
eventType

enum ( EventType )

Неизменный. Тип события, которое будет учитываться в отношении thresholdEventCount. На данный момент мы не представляем явно ограничения сравнения, предполагая, что все они являются GREATER_OR_EQUAL.

thresholdEventCount

string ( int64 format)

Необходимый. Каждый пользователь должен появиться как минимум в K событиях.

Тип события

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

перечисления
EVENT_TYPE_UNSPECIFIED Значение по умолчанию: не следует использовать.
IMPRESSIONS Подсчитайте все показы.

РемаркетингListInfo

Метаданные для списков ремаркетинга.

Представление JSON
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
Поля
userListQuery

string

Неизменный. Ресурс запроса списка пользователей Ads Data Hub, который указывает, как пользователи добавляются в эту аудиторию. Имеет вид: customers/[customerId]/userListQueries/[query_resource_id]

populatingUserListQueries[]

string

Только вывод. Пользователь Ads Data Hub перечисляет ресурсы запроса, которые заполнили эту аудиторию. Это поле предназначено в качестве устаревшего поля для поддержки списков пользователей, которые были заполнены несколькими запросами до того, как вступили в силу ограничения 1:1 список пользователей:запрос. Имеет вид: customers/[customerId]/userListQueries/[query_resource_id]

Состояние

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

перечисления
STATE_UNSPECIFIED Значение по умолчанию/неустановленное.
STATE_ACTIVE Список пользователей по-прежнему открыт и активен.
STATE_DELETED Список пользователей помечен как удаленный и больше не должен использоваться для таргетинга.

Методы

addEventMatchers

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

addRecipients

 Добавляйте объекты в список получателей, управляемый Ads Data Hub.

create

 Создает список пользователей, управляемый Ads Data Hub.

delete

 Удалите запрошенный список пользователей, управляемый Ads Data Hub.

generateFrequencyListMemberships

 Создание членства для UserList.

get

 Получает запрошенный список пользователей, управляемый Ads Data Hub.

list

 Список списков пользователей, которыми управляет указанный клиент Ads Data Hub.

patch

 Обновляет запрошенный список пользователей, управляемый Ads Data Hub.

removeRecipients

 Удаляет объекты из списка получателей, управляемого Ads Data Hub.