REST Resource: accountTypes.accounts.userLists

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

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

JSON-представление 
{
  "name": string,
  "id": string,
  "readOnly": boolean,
  "membershipDuration": string,
  "accessReason": enum (AccessReason),
  "sizeInfo": {
    object (SizeInfo)
  },
  "targetNetworkInfo": {
    object (TargetNetworkInfo)
  },
  "displayName": string,
  "description": string,
  "membershipStatus": enum (MembershipStatus),
  "integrationCode": string,
  "closingReason": enum (ClosingReason),
  "accountAccessStatus": enum (AccessStatus),

  // Union field user_list_info can be only one of the following:
  "ingestedUserListInfo": {
    object (IngestedUserListInfo)
  }
  // End of list of possible types for union field user_list_info.
}
Поля
name

string

Идентификатор. Имя ресурса списка пользователей. Формат: accountTypes/{accountType}/accounts/{account}/userLists/{userList}

id

string ( int64 format)

Только вывод. Уникальный идентификатор списка пользователей.

readOnly

boolean

Только для вывода. Параметр, указывающий, может ли пользователь редактировать список.

membershipDuration

string ( Duration format)

Необязательный параметр. Продолжительность пребывания пользователя в списке пользователей. Допустимые значения — точные кратные 24 часам (86400 секундам). Указание значения, не являющегося точным кратным 24 часам, приведет к ошибке INVALID_ARGUMENT.

Длительность в секундах, содержащая до девяти знаков после запятой, заканчивающаяся на « s ». Пример: "3.5s" .

accessReason

enum ( AccessReason )

Только вывод. Причина, по которой этому аккаунту был предоставлен доступ к списку.

sizeInfo

object ( SizeInfo )

Только вывод. Примерное количество участников в этом списке пользователей в различных целевых сетях.

targetNetworkInfo

object ( TargetNetworkInfo )

Необязательно. Информация о соответствии критериям для различных целевых сетей.

displayName

string

Обязательно. Отображаемое имя списка пользователей.

description

string

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

membershipStatus

enum ( MembershipStatus )

Необязательно. Статус членства в этом списке пользователей.

integrationCode

string

Необязательный параметр. Идентификатор из внешней системы. Используется продавцами списков пользователей для сопоставления идентификаторов в своих системах.

closingReason

enum ( ClosingReason )

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

accountAccessStatus

enum ( AccessStatus )

Необязательно. Указывает, включена ли эта функция общего доступа. Когда список пользователей предоставляется в общий доступ учетной записи, это поле устанавливается в ENABLED . Позже владелец списка пользователей может отозвать доступ и DISABLED его.

Поле объединения user_list_info . Дополнительная информация о списке пользователей. user_list_info может принимать только одно из следующих значений:
ingestedUserListInfo

object ( IngestedUserListInfo )

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

Статус членства

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

Перечисления
MEMBERSHIP_STATUS_UNSPECIFIED Не указан.
OPEN Статус «Открыт» — список пользователей пополняется участниками, и его можно таргетировать.
CLOSED Статус: Закрыто — новые участники не добавляются.

Причина закрытия

Указывает причину закрытия списка пользователей. Этот перечислимый тип используется только в том случае, если список автоматически закрывается системой.

Перечисления
CLOSING_REASON_UNSPECIFIED Не указан.
UNUSED Список пользователей был закрыт, поскольку в последнее время он не использовался для таргетинга. Подробности см. на странице https://support.google.com/google-ads/answer/2472738 .

Причина доступа

Перечислите возможные причины доступа.

Перечисления
ACCESS_REASON_UNSPECIFIED Не указан.
OWNED Ресурс принадлежит пользователю.
SHARED Ресурс предоставляется пользователю.
LICENSED Ресурс предоставляется пользователю по лицензии.
SUBSCRIBED Пользователь оформил подписку на ресурс.
AFFILIATED Данный ресурс доступен пользователю.

Статус доступа

Указывает, имеет ли данный клиент по-прежнему доступ к списку.

Перечисления
ACCESS_STATUS_UNSPECIFIED Не указан.
ENABLED Доступ разрешен.
DISABLED Доступ отключен.

Информация о размере

Примерное количество участников в этом списке пользователей в различных целевых сетях.

JSON-представление 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string,
  "youtubeMembersCount": string,
  "gmailMembersCount": string
}
Поля
displayNetworkMembersCount

string ( int64 format)

Только для вывода. Примерное количество участников в этом списке пользователей в контекстно-медийной сети Google.

searchNetworkMembersCount

string ( int64 format)

Только для вывода. Примерное количество участников в этом списке пользователей в домене google.com. Это участники, доступные для таргетинга в поисковых кампаниях.

youtubeMembersCount

string ( int64 format)

Только вывод. Примерное количество участников в этом списке пользователей на YouTube.

gmailMembersCount

string ( int64 format)

Только вывод. Примерное количество участников в этом списке пользователей Gmail.

TargetNetworkInfo

Информация о критериях отбора для различных целевых сетей.

JSON-представление 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
Поля
eligibleForDisplay

boolean

Только для вывода. Указывает, что этот список пользователей подходит для показа в контекстно-медийной сети Google.

IngestedUserListInfo

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

JSON-представление 
{
  "uploadKeyTypes": [
    enum (UploadKeyType)
  ],
  "contactIdInfo": {
    object (ContactIdInfo)
  },
  "mobileIdInfo": {
    object (MobileIdInfo)
  },
  "userIdInfo": {
    object (UserIdInfo)
  },
  "pairIdInfo": {
    object (PairIdInfo)
  },
  "pseudonymousIdInfo": {
    object (PseudonymousIdInfo)
  },
  "partnerAudienceInfo": {
    object (PartnerAudienceInfo)
  }
}
Поля
uploadKeyTypes[]

enum ( UploadKeyType )

Обязательно. Неизменяемо. Загрузите типы ключей этого списка пользователей.

contactIdInfo

object ( ContactIdInfo )

Необязательно. Дополнительная информация, если CONTACT_ID является одним из uploadKeyTypes .

mobileIdInfo

object ( MobileIdInfo )

Необязательно. Дополнительная информация, если MOBILE_ID является одним из uploadKeyTypes .

userIdInfo

object ( UserIdInfo )

Необязательно. Дополнительная информация, если USER_ID является одним из uploadKeyTypes .

pairIdInfo

object ( PairIdInfo )

Необязательно. Дополнительная информация, если PAIR_ID является одним из uploadKeyTypes .

Эта функция доступна только партнерам по передаче данных.

pseudonymousIdInfo

object ( PseudonymousIdInfo )

Необязательно. Дополнительная информация для PSEUDONYMOUS_ID — это один из параметров uploadKeyTypes .

partnerAudienceInfo

object ( PartnerAudienceInfo )

Необязательно. Дополнительная информация для партнеров.

Эта функция доступна только партнерам по передаче данных.

UploadKeyType

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

Перечисления
UPLOAD_KEY_TYPE_UNSPECIFIED Не указан.
CONTACT_ID Информация о клиенте, такая как адрес электронной почты, номер телефона или физический адрес.
MOBILE_ID Идентификаторы мобильной рекламы.
USER_ID Идентификаторы пользователей предоставлены третьей стороной.
PAIR_ID Идентификаторы для согласования данных издателя и рекламодателя.
PSEUDONYMOUS_ID Идентификаторы платформы управления данными: - Идентификатор пользователя Google - Идентификатор, предоставленный партнером - Идентификатор, предоставленный издателем - IDFA для iOS - Рекламный идентификатор Android - Идентификатор Roku - Идентификатор Amazon Fire TV - Идентификатор Xbox или Microsoft

ContactIdInfo

Дополнительная информация, если CONTACT_ID является одним из uploadKeyTypes .

JSON-представление 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
Поля
matchRatePercentage

integer

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

dataSourceType

enum ( DataSourceType )

Необязательный. Неизменяемый. Источник данных для загрузки.

Тип источника данных

Указывает источник загружаемых данных.

Перечисления
DATA_SOURCE_TYPE_UNSPECIFIED Не указан.
DATA_SOURCE_TYPE_FIRST_PARTY Загруженные данные являются данными от первого лица.
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU Загруженные данные получены из стороннего кредитного бюро.
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE Загруженные данные получены из базы данных избирателей, предоставленной третьей стороной.
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA Загруженные данные являются данными сторонних партнеров.

MobileIdInfo

Дополнительная информация, если MOBILE_ID является одним из uploadKeyTypes .

JSON-представление 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
Поля
dataSourceType

enum ( DataSourceType )

Необязательно. Неизменяемо. Источник данных для загрузки.

keySpace

enum ( KeySpace )

Обязательный. Неизменяемый. Ключевое пространство мобильных идентификаторов.

appId

string

Обязательный параметр. Неизменяемый. Строка, однозначно идентифицирующая мобильное приложение, из которого были собраны данные.

Пространство клавиш

Ключевое пространство для мобильной идентификации.

Перечисления
KEY_SPACE_UNSPECIFIED Не указан.
IOS Пространство ключей iOS.
ANDROID Пространство ключей Android.

UserIdInfo

Дополнительная информация, если USER_ID является одним из uploadKeyTypes .

JSON-представление 
{
  "dataSourceType": enum (DataSourceType)
}
Поля
dataSourceType

enum ( DataSourceType )

Необязательно. Неизменяемо. Источник данных для загрузки.

PairIdInfo

Дополнительная информация, если PAIR_ID является одним из uploadKeyTypes .

Эта функция доступна только партнерам по передаче данных.

JSON-представление 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
Поля
publisherId

string ( int64 format)

Обязательное поле. Неизменяемое. Идентифицирует издателя, с которым согласовывается список пользователей Publisher Advertiser Identity Reconciliation. Это поле предоставляется поставщиком чистой комнаты и является уникальным только в рамках данной чистой комнаты. Его нельзя использовать в качестве глобального идентификатора для нескольких чистых комнат.

publisherName

string

Обязательно. Описательное название издателя для отображения в пользовательском интерфейсе с целью улучшения таргетинга.

matchRatePercentage

integer

Обязательное поле. В этом поле указывается процент соответствия состава списка пользователей данным издателя, полученным непосредственно от издателя. Значение должно быть от 0 до 100 включительно.

advertiserIdentifierCount

string ( int64 format)

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

cleanRoomIdentifier

string

Обязательный. Неизменяемый. Идентифицирует уникальные отношения между рекламодателем и издателем, установленные одним поставщиком чистых помещений или несколькими поставщиками чистых помещений.

PseudonymousIdInfo

Дополнительная информация, если PSEUDONYMOUS_ID является одним из uploadKeyTypes .

JSON-представление 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
Поля
syncStatus

enum ( SyncStatus )

Только вывод. Статус синхронизации списка пользователей.

billableRecordCount

string ( int64 format)

Необязательный параметр. Неизменяемый параметр. Количество платных записей (например, загруженных или сопоставленных).

SyncStatus

Статус синхронизации списка пользователей.

Перечисления
SYNC_STATUS_UNSPECIFIED Не указан.
CREATED Список пользователей создан как временный. Содержимое списка и/или метаданные все еще синхронизируются. Список пользователей не готов к использованию.
READY_FOR_USE Список пользователей готов к использованию. Содержимое и файлы cookie синхронизированы корректно.
FAILED Произошла ошибка при синхронизации содержимого списка пользователей и/или метаданных. Список пользователей не может быть использован.

PartnerAudienceInfo

Дополнительная информация для партнеров.

Эта функция доступна только партнерам по передаче данных.

JSON-представление 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
Поля
partnerAudienceSource

enum ( PartnerAudienceSource )

Обязательный. Неизменяемый. Источник партнерской аудитории.

commercePartner

string

Необязательно. Название партнера по коммерции. Допускается только в том случае, если partnerAudienceSource имеет значение COMMERCE_AUDIENCE .

PartnerAudienceSource

Источник аудитории партнёра.

Перечисления
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED Не указан.
COMMERCE_AUDIENCE Источником партнерской аудитории является коммерческая аудитория.
LINEAR_TV_AUDIENCE Источником целевой аудитории для партнеров является аудитория традиционного телевидения.
AGENCY_PROVIDER_AUDIENCE Источником целевой аудитории для партнеров является аудитория агентства/поставщика услуг.

Методы

create

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

delete

 Удаляет список пользователей.

get

 Получает список пользователей (UserList).

list

 Отображает списки пользователей.

patch

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