Индекс
-
IngestionService(интерфейс) -
MarketingDataInsightsService(интерфейс) -
PartnerLinkService(интерфейс) -
UserListDirectLicenseService(интерфейс) -
UserListGlobalLicenseService(интерфейс) -
UserListService(интерфейс) -
AdIdentifiers(сообщение) -
AddressInfo(message) -
AgeRange(перечисление) -
AudienceMember(сообщение) -
AwsWrappedKeyInfo(message) -
AwsWrappedKeyInfo.KeyType(enum) -
Baseline(сообщение) -
Baseline.Location(message) -
CartData(message) -
Consent(сообщение) -
ConsentStatus(enum) -
ContactIdInfo(message) -
CreatePartnerLinkRequest(message) -
CreateUserListDirectLicenseRequest(message) -
CreateUserListGlobalLicenseRequest(message) -
CreateUserListRequest(message) -
CustomVariable(message) -
CustomerType(перечисление) -
CustomerValueBucket(enum) -
DataSourceType(перечисление) -
DeletePartnerLinkRequest(message) -
DeleteUserListRequest(message) -
Destination(сообщение) -
DeviceInfo(сообщение) -
Encoding(перечисление) -
EncryptionInfo(message) -
ErrorCount(message) -
ErrorInfo(message) -
ErrorReason(enum) -
Event(сообщение) -
EventParameter(message) -
EventSource(enum) -
ExperimentalField(message) -
GcpWrappedKeyInfo(message) -
GcpWrappedKeyInfo.KeyType(enum) -
Gender(перечисление) -
GetUserListDirectLicenseRequest(message) -
GetUserListGlobalLicenseRequest(message) -
GetUserListRequest(message) -
IngestAudienceMembersRequest(message) -
IngestAudienceMembersResponse(message) -
IngestEventsRequest(message) -
IngestEventsResponse(message) -
IngestedUserListInfo(message) -
IngestedUserListInfo.UploadKeyType(enum) -
Item(сообщение) -
ItemParameter(message) -
ListUserListDirectLicensesRequest(message) -
ListUserListDirectLicensesResponse(сообщение) -
ListUserListGlobalLicenseCustomerInfosRequest(message) -
ListUserListGlobalLicenseCustomerInfosResponse(message) -
ListUserListGlobalLicensesRequest(message) -
ListUserListGlobalLicensesResponse(сообщение) -
ListUserListsRequest(message) -
ListUserListsResponse(message) -
MatchRateRange(enum) -
MobileData(сообщение) -
MobileIdInfo(message) -
MobileIdInfo.KeySpace(enum) -
PairData(message) -
PairIdInfo(message) -
PartnerAudienceInfo(message) -
PartnerAudienceInfo.PartnerAudienceSource(enum) -
PartnerLink(сообщение) -
PpidData(message) -
ProcessingErrorReason(enum) -
ProcessingWarningReason(enum) -
Product(перечисление) (устарело) -
ProductAccount(message) -
ProductAccount.AccountType(enum) -
PseudonymousIdInfo(message) -
PseudonymousIdInfo.SyncStatus(enum) -
RemoveAudienceMembersRequest(message) -
RemoveAudienceMembersResponse(message) -
RequestStatusPerDestination(message) -
RequestStatusPerDestination.IngestAudienceMembersStatus(message) -
RequestStatusPerDestination.IngestEventsStatus(message) -
RequestStatusPerDestination.IngestMobileDataStatus(message) -
RequestStatusPerDestination.IngestPairDataStatus(message) -
RequestStatusPerDestination.IngestPpidDataStatus(message) -
RequestStatusPerDestination.IngestUserDataStatus(message) -
RequestStatusPerDestination.IngestUserIdDataStatus(message) -
RequestStatusPerDestination.RemoveAudienceMembersStatus(message) -
RequestStatusPerDestination.RemoveMobileDataStatus(message) -
RequestStatusPerDestination.RemovePairDataStatus(message) -
RequestStatusPerDestination.RemovePpidDataStatus(message) -
RequestStatusPerDestination.RemoveUserDataStatus(message) -
RequestStatusPerDestination.RemoveUserIdDataStatus(message) -
RequestStatusPerDestination.RequestStatus(enum) -
RetrieveInsightsRequest(message) -
RetrieveInsightsResponse(message) -
RetrieveInsightsResponse.MarketingDataInsight(message) -
RetrieveInsightsResponse.MarketingDataInsight.AudienceInsightsDimension(enum) -
RetrieveInsightsResponse.MarketingDataInsight.MarketingDataInsightsAttribute(message) -
RetrieveRequestStatusRequest(message) -
RetrieveRequestStatusResponse(message) -
SearchPartnerLinksRequest(message) -
SearchPartnerLinksResponse(message) -
SizeInfo(message) -
TargetNetworkInfo(message) -
TermsOfService(сообщение) -
TermsOfServiceStatus(enum) -
UpdateUserListDirectLicenseRequest(message) -
UpdateUserListGlobalLicenseRequest(message) -
UpdateUserListRequest(message) -
UserData(сообщение) -
UserIdData(message) -
UserIdInfo(message) -
UserIdentifier(сообщение) -
UserList(сообщение) -
UserList.AccessReason(enum) -
UserList.AccessStatus(enum) -
UserList.ClosingReason(enum) -
UserList.MembershipStatus(enum) -
UserListDirectLicense(message) -
UserListGlobalLicense(message) -
UserListGlobalLicenseCustomerInfo(message) -
UserListGlobalLicenseType(перечисление) -
UserListLicenseClientAccountType(enum) -
UserListLicenseMetrics(message) -
UserListLicensePricing(message) -
UserListLicensePricing.UserListPricingBuyerApprovalState(enum) -
UserListLicensePricing.UserListPricingCostType(enum) -
UserListLicenseStatus(enum) -
UserProperties(сообщение) -
UserProperty(message) -
WarningCount(message) -
WarningInfo(message)
Служба приема данных
Сервис для отправки данных об аудитории в поддерживаемые пункты назначения.
| IngestAudienceMembers |
|---|
Загружает список ресурсов
|
| IngestEvents |
|---|
Загружает список ресурсов
|
| RemoveAudienceMembers |
|---|
Удаляет список ресурсов
|
| RetrieveRequestStatus |
|---|
Получает статус запроса по заданному идентификатору запроса.
|
MarketingDataInsightsService
Сервис для предоставления аналитической информации на основе маркетинговых данных.
Эта функция доступна только партнерам по передаче данных.
| RetrieveInsights |
|---|
Получает маркетинговые данные и аналитику для заданного списка пользователей. Эта функция доступна только партнерам по передаче данных. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API:
|
PartnerLinkService
Сервис для управления партнерскими ссылками.
| CreatePartnerLink |
|---|
Создает партнерскую ссылку для указанного аккаунта. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API:
|
| УдалитьПартнерскуюСсылку |
|---|
Удаляет партнерскую ссылку для указанного аккаунта. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API:
|
| SearchPartnerLinks |
|---|
Выполняет поиск всех партнерских ссылок, ведущих к указанному аккаунту и исходящих от него. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API:
|
UserListDirectLicenseService
Сервис для управления прямыми лицензиями списка пользователей. Удаление не поддерживается для UserListDirectLicenses. Для деактивации лицензии следует изменить статус лицензии на DISABLED.
Эта функция доступна только партнерам по передаче данных.
| CreateUserListDirectLicense |
|---|
Создает список пользователей и прямую лицензию. Эта функция доступна только партнерам по передаче данных.
|
| GetUserListDirectLicense |
|---|
Получает список пользователей и прямую лицензию. Эта функция доступна только партнерам по передаче данных.
|
| ListUserListDirectLicenses |
|---|
Отображает список всех лицензий, принадлежащих родительской учетной записи. Эта функция доступна только партнерам по передаче данных.
|
| UpdateUserListDirectLicense |
|---|
Обновляет список пользователей, предоставляя прямую лицензию. Эта функция доступна только партнерам по передаче данных.
|
UserListGlobalLicenseService
Сервис для управления глобальными лицензиями списка пользователей. Удаление не поддерживается для UserListGlobalLicenses. Для деактивации лицензии следует изменить статус лицензии на DISABLED.
Эта функция доступна только партнерам по передаче данных.
| CreateUserListGlobalLicense |
|---|
Создает глобальную лицензию для списка пользователей. Эта функция доступна только партнерам по передаче данных.
|
| GetUserListGlobalLicense |
|---|
Получает список глобальных лицензий пользователей. Эта функция доступна только партнерам по передаче данных.
|
| ListUserListGlobalLicenseCustomerInfos |
|---|
Отображает всю информацию о клиенте для глобальной лицензии, содержащей список пользователей. Эта функция доступна только партнерам по передаче данных.
|
| ListUserListGlobalLicenses |
|---|
Отображает список всех глобальных лицензий пользователей, принадлежащих родительской учетной записи. Эта функция доступна только партнерам по передаче данных.
|
| UpdateUserListGlobalLicense |
|---|
Обновляет глобальную лицензию списка пользователей. Эта функция доступна только партнерам по передаче данных.
|
UserListService
Сервис для управления ресурсами UserList.
| CreateUserList |
|---|
Создает список пользователей. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API:
|
| DeleteUserList |
|---|
Удаляет список пользователей. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API:
|
| GetUserList |
|---|
Получает список пользователей (UserList). Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API:
|
| ListUserLists |
|---|
Отображает списки пользователей. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API:
|
| Обновить список пользователей |
|---|
Обновляет список пользователей. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API:
|
AdIdentifiers
Идентификаторы и другая информация, используемая для сопоставления события конверсии с другой онлайн-активностью (например, кликами по рекламе).
| Поля | |
|---|---|
session_attributes | Необязательно. Атрибуты сессии для атрибуции событий и моделирования. |
gclid | Необязательно. Идентификатор клика Google (gclid), связанный с этим событием. |
gbraid | Необязательный параметр. Идентификатор клика для кликов, связанных с событиями приложения и исходящих с устройств iOS, начиная с iOS 14. |
wbraid | Необязательный параметр. Идентификатор клика для кликов, связанных с веб-событиями и происходящих на устройствах iOS, начиная с iOS 14. |
landing_page_device_info | Необязательно. Информация, собираемая об используемом устройстве (если таковое имелось) в момент перехода на сайт рекламодателя после взаимодействия с рекламой. |
Информация об адресе
Адресная информация для пользователя.
| Поля | |
|---|---|
given_name | Обязательно. Укажите имя пользователя (в нижнем регистре), без знаков препинания, пробелов в начале и конце, хешированное как SHA-256. |
family_name | Обязательно. Фамилия пользователя, все строчные буквы, без знаков препинания, без пробелов в начале и конце, хешированная как SHA-256. |
region_code | Обязательно. Двухбуквенный региональный код адреса пользователя в формате ISO-3166-1 alpha-2. |
postal_code | Обязательно. Почтовый индекс адреса пользователя. |
Возрастной диапазон
Демографические возрастные диапазоны
| Перечисления | |
|---|---|
AGE_RANGE_UNSPECIFIED | Не указан. |
AGE_RANGE_UNKNOWN | Неизвестный. |
AGE_RANGE_18_24 | В возрасте от 18 до 24 лет. |
AGE_RANGE_25_34 | В возрасте от 25 до 34 лет. |
AGE_RANGE_35_44 | В возрасте от 35 до 44 лет. |
AGE_RANGE_45_54 | В возрасте от 45 до 54 лет. |
AGE_RANGE_55_64 | В возрасте от 55 до 64 лет. |
AGE_RANGE_65_UP | 65 лет и старше. |
Участник аудитории
Участника аудитории, которому будет проведена операция.
| Поля | |
|---|---|
destination_references[] | Необязательный параметр. Определяет, в какое |
consent | Необязательно. Настройки согласия пользователя. |
data поля объединения. Тип идентификационных данных, с которыми необходимо выполнить операцию. data могут быть только одним из следующих типов: | |
user_data | Данные, предоставленные пользователем, позволяющие идентифицировать пользователя. |
pair_data | Идентификаторы PAIR (Publisher Advertiser Identity Reconciliation) . Эта функция доступна только партнерам по передаче данных. |
mobile_data | Данные, идентифицирующие мобильные устройства пользователя. |
user_id_data | Данные, относящиеся к уникальным идентификаторам пользователя, определенным рекламодателем. |
ppid_data | Данные, относящиеся к идентификаторам, предоставленным издателем. Эта функция доступна только партнерам по передаче данных. |
AwsWrappedKeyInfo
Ключ шифрования данных, упакованный в ключ AWS KMS.
| Поля | |
|---|---|
key_type | Обязательно. Тип алгоритма, используемого для шифрования данных. |
role_arn | Обязательно. Имя ресурса Amazon для роли IAM, которая будет использоваться для доступа к расшифровке KMS. Должно быть в формате |
kek_uri | Обязательно. URI ключа AWS KMS, используемого для расшифровки DEK. Должен быть в формате |
encrypted_dek | Обязательно. Ключ шифрования данных, закодированных в base64. |
KeyType
Тип алгоритма, используемого для шифрования данных.
| Перечисления | |
|---|---|
KEY_TYPE_UNSPECIFIED | Тип ключа не указан. Использовать его не следует. |
XCHACHA20_POLY1305 | Алгоритм XChaCha20-Poly1305 |
Исходный уровень
Базовые критерии, с которыми сравниваются полученные результаты.
| Поля | |
|---|---|
baseline поля объединения. Базовое местоположение, с которым сравниваются полученные данные. baseline может быть только одной из следующих: | |
baseline_location | Базовое местоположение запроса. Базовое местоположение представляет собой список запрашиваемых регионов, заданный оператором ИЛИ. |
location_auto_detection_enabled | Если установить значение true, сервис попытается автоматически определить базовое местоположение для получения аналитических данных. |
Расположение
Базовое местоположение запроса. Базовое местоположение указано в списке кодов регионов ISO 3166-1 alpha-2 (OR-list) для запрашиваемых регионов.
| Поля | |
|---|---|
region_codes[] | Список кодов регионов ISO 3166-1 alpha-2. |
CartData
Данные корзины, связанные с событием.
| Поля | |
|---|---|
merchant_id | Необязательно. Идентификатор торгового центра, связанный с товарами. |
merchant_feed_label | Необязательно. Метка фида Merchant Center, связанная с фидом товаров. |
merchant_feed_language_code | Необязательно. Код языка в ISO 639-1, связанный с фидом товаров в Merchant Center, куда загружаются ваши товары. |
transaction_discount | Необязательно. Сумма всех скидок, связанных с данной транзакцией. |
items[] | Необязательно. Список предметов, связанных с мероприятием. |
Согласие
Настройки согласия пользователя в соответствии с Законом о цифровых рынках (DMA) .
| Поля | |
|---|---|
ad_user_data | Необязательный параметр. Указывает, согласен ли пользователь на предоставление данных о пользователе рекламной сети. |
ad_personalization | Необязательный параметр. Указывает, согласен ли пользователь на персонализацию рекламы. |
Статус согласия
Указывает, дал ли пользователь согласие, отклонил его или не указал явно.
| Перечисления | |
|---|---|
CONSENT_STATUS_UNSPECIFIED | Не указан. |
CONSENT_GRANTED | Предоставленный. |
CONSENT_DENIED | Отклонен. |
ContactIdInfo
Дополнительная информация, если CONTACT_ID является одним из типов upload_key_types .
| Поля | |
|---|---|
match_rate_percentage | Только для вывода. Коэффициент совпадения для списков пользователей, соответствующих требованиям клиента. |
data_source_type | Необязательный. Неизменяемый. Источник данных для загрузки. |
CreatePartnerLinkRequest
Запрос на создание ресурса PartnerLink . Возвращает объект PartnerLink .
| Поля | |
|---|---|
parent | Обязательно. Родительский ресурс, которому принадлежит эта коллекция партнерских ссылок. Формат: accountTypes/{account_type}/accounts/{account} |
partner_link | Обязательно. Партнерская ссылка для создания. |
CreateUserListDirectLicenseRequest
Запрос на создание ресурса UserListDirectLicense .
| Поля | |
|---|---|
parent | Обязательно. Учетная запись, которой принадлежит лицензируемый список пользователей. Формат должен быть accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}. |
user_list_direct_license | Обязательно. Для создания списка пользователей требуется прямая лицензия. |
CreateUserListGlobalLicenseRequest
Запрос на создание ресурса UserListGlobalLicense .
| Поля | |
|---|---|
parent | Обязательно. Учетная запись, которой принадлежит лицензируемый список пользователей. Формат должен быть accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}. |
user_list_global_license | Обязательно. Необходимо создать глобальную лицензию для списка пользователей. |
CreateUserListRequest
Сообщение запроса для функции CreateUserList.
| Поля | |
|---|---|
parent | Обязательно. Родительская учетная запись, в которой будет создан этот список пользователей. Формат: accountTypes/{account_type}/accounts/{account} |
user_list | Обязательно. Список пользователей для создания. |
validate_only | Необязательный параметр. Если значение равно true, запрос проверяется, но не выполняется. |
Пользовательская переменная
Пользовательская переменная для конверсий в рекламе.
| Поля | |
|---|---|
variable | Необязательно. Имя пользовательской переменной для установки. Если переменная не найдена для указанного места назначения, она будет проигнорирована. |
value | Необязательный параметр. Значение, которое будет сохранено для пользовательской переменной. |
destination_references[] | Необязательный параметр. Строка-ссылка, используемая для определения того, в какой из объектов |
Тип клиента
Тип клиента, участвующего в мероприятии.
| Перечисления | |
|---|---|
CUSTOMER_TYPE_UNSPECIFIED | Тип клиента не указан. Использовать его не следует. |
NEW | Клиент впервые обращается к рекламодателю. |
RETURNING | Клиент возвращается к рекламодателю. |
REENGAGED | Клиент возобновил взаимодействие с рекламодателем. |
CustomerValueBucket
Оценочная стоимость клиента, определяемая рекламодателем.
| Перечисления | |
|---|---|
CUSTOMER_VALUE_BUCKET_UNSPECIFIED | Неуказанный CustomerValueBucket. Использовать его не следует. |
LOW | Клиент имеет низкую ценность. |
MEDIUM | Клиент относится к категории средней ценности. |
HIGH | Клиент имеет высокую ценность. |
Тип источника данных
Указывает источник загружаемых данных.
| Перечисления | |
|---|---|
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 | Загруженные данные являются данными сторонних партнеров. |
DeletePartnerLinkRequest
Запрос на удаление ресурса PartnerLink . Возвращает google.protobuf.Empty .
| Поля | |
|---|---|
name | Обязательно. Имя ресурса партнерской ссылки для удаления. Формат: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} |
DeleteUserListRequest
Сообщение запроса для удаления списка пользователей (DeleteUserList).
| Поля | |
|---|---|
name | Обязательно. Название списка пользователей для удаления. Формат: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} |
validate_only | Необязательный параметр. Если значение равно true, запрос проверяется, но не выполняется. |
Место назначения
Продукт Google, в который вы отправляете данные. Например, аккаунт Google Ads.
| Поля | |
|---|---|
reference | Необязательный параметр. Идентификатор для этого ресурса |
login_account | Необязательно. Учетная запись, используемая для выполнения этого вызова API. Для добавления или удаления данных из |
linked_account | Необязательно. Учетная запись, к которой имеет доступ |
operating_account | Обязательно. Учетная запись, на которую следует отправить данные или с которой следует удалить данные. |
product_destination_id | Обязательно. Объект в аккаунте продукта, в который необходимо импортировать данные. Например, идентификатор аудитории Google Ads, идентификатор аудитории Display & Video 360 или идентификатор действия конверсии Google Ads. |
Информация об устройстве
Информация об используемом устройстве (если таковое имелось) в момент происшествия.
| Поля | |
|---|---|
user_agent | Необязательный параметр. Строка user-gent устройства для данного контекста. |
ip_address | Необязательный параметр. IP-адрес устройства для данного контекста. Примечание: Google Ads не поддерживает сопоставление IP-адресов конечных пользователей из Европейской экономической зоны (ЕЭЗ), Великобритании (UK) или Швейцарии (CH). Добавьте логику для условного исключения обмена IP-адресами пользователей из этих регионов и убедитесь, что вы предоставляете пользователям четкую и исчерпывающую информацию о данных, которые вы собираете на своих сайтах, в приложениях и других ресурсах, а также получаете согласие там, где это требуется по закону или в соответствии с применимыми политиками Google. Дополнительные сведения см. на странице «Об импорте данных о конверсиях в офлайн-режиме» . |
Кодирование
Тип кодирования хешированной идентификационной информации.
| Перечисления | |
|---|---|
ENCODING_UNSPECIFIED | Тип кодировки не указан. Использовать его не следует. |
HEX | Шестнадцатеричное кодирование. |
BASE64 | Кодирование Base64. |
EncryptionInfo
Информация для шифрования обрабатываемых данных.
| Поля | |
|---|---|
Поле объединения wrapped_key . Зашифрованный ключ, используемый для шифрования данных. wrapped_key может принимать только одно из следующих значений: | |
gcp_wrapped_key_info | Платформа Google Cloud Platform скрыла ключевую информацию. |
aws_wrapped_key_info | Amazon Web Services скрыла ключевую информацию. |
ErrorCount
Количество ошибок по указанной причине.
| Поля | |
|---|---|
record_count | Количество записей, которые не удалось загрузить по указанной причине. |
reason | Причина ошибки, из-за которой не удалось записать данные. |
ErrorInfo
Для каждого типа ошибок подсчитывается количество ошибок.
| Поля | |
|---|---|
error_counts[] | Список ошибок и количество ошибок по каждой причине. Может быть заполнено не во всех случаях. |
Причина ошибки
Причины ошибок API менеджера данных. ПРИМЕЧАНИЕ: Данное перечисление не зафиксировано, и в будущем могут быть добавлены новые значения.
| Перечисления | |
|---|---|
ERROR_REASON_UNSPECIFIED | Не используйте это значение по умолчанию. |
INTERNAL_ERROR | Произошла внутренняя ошибка. |
DEADLINE_EXCEEDED | На обработку запроса потребовалось слишком много времени. |
RESOURCE_EXHAUSTED | Слишком много запросов. |
NOT_FOUND | Ресурс не найден. |
PERMISSION_DENIED | У пользователя нет необходимых прав или ресурс не найден. |
INVALID_ARGUMENT | Возникла проблема с запросом. |
REQUIRED_FIELD_MISSING | Отсутствует обязательное поле. |
INVALID_FORMAT | Неверный формат. |
INVALID_HEX_ENCODING | Значение в шестнадцатеричном формате некорректно. |
INVALID_BASE64_ENCODING | Закодированное в base64 значение имеет некорректный формат. |
INVALID_SHA256_FORMAT | Закодированное значение SHA256 имеет некорректный формат. |
INVALID_POSTAL_CODE | Почтовый индекс недействителен. |
INVALID_COUNTRY_CODE | Код страны недействителен. |
INVALID_ENUM_VALUE | Значение перечисления использовать нельзя. |
INVALID_USER_LIST_TYPE | Тип списка пользователей не имеет значения для данного запроса. |
INVALID_AUDIENCE_MEMBER | Данный зритель недействителен. |
TOO_MANY_AUDIENCE_MEMBERS | Максимальное количество зрителей, допускаемых по одному запросу, составляет 10 000 человек. |
TOO_MANY_USER_IDENTIFIERS | Максимальное количество идентификаторов пользователей, разрешенных для одного участника аудитории, составляет 10. |
TOO_MANY_DESTINATIONS | Максимальное количество пунктов назначения, разрешенных для одного запроса, составляет 10. |
INVALID_DESTINATION | Этот пункт назначения недействителен. |
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED | У партнера по данным нет доступа к списку пользователей, принадлежащих операционной учетной записи. |
INVALID_MOBILE_ID_FORMAT | Формат мобильного идентификатора недействителен. |
INVALID_USER_LIST_ID | Список пользователей недействителен. |
MULTIPLE_DATA_TYPES_NOT_ALLOWED | В одном запросе не допускается обработка данных нескольких типов. |
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER | В конфигурациях назначения, содержащих учетную запись для входа в DataPartner, эта учетная запись должна быть одинаковой во всех конфигурациях назначения. |
TERMS_AND_CONDITIONS_NOT_SIGNED | Обязательные условия не принимаются. |
INVALID_NUMBER_FORMAT | Неверный формат числа. |
INVALID_CONVERSION_ACTION_ID | Идентификатор действия конверсии недействителен. |
INVALID_CONVERSION_ACTION_TYPE | Тип действия преобразования недопустим. |
INVALID_CURRENCY_CODE | Код валюты не поддерживается. |
INVALID_EVENT | Данное мероприятие недействительно. |
TOO_MANY_EVENTS | Максимальное количество событий, разрешенных для одного запроса, составляет 10 000. |
DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS | Для целевого аккаунта не активирована функция повышения конверсии лидов. |
DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS | Использование расширенных показателей конверсии для целевого аккаунта невозможно из-за политики Google в отношении данных клиентов. Обратитесь к представителю Google. |
DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED | Целевой аккаунт не согласился с условиями повышения конверсии. |
DUPLICATE_DESTINATION_REFERENCE | В запросе два или более пункта назначения имеют одинаковую ссылку. |
UNSUPPORTED_OPERATING_ACCOUNT_FOR_DATA_PARTNER | Неподдерживаемый операционный аккаунт для авторизации партнеров по передаче данных. |
UNSUPPORTED_LINKED_ACCOUNT_FOR_DATA_PARTNER | Неподдерживаемая связанная учетная запись для авторизации партнеров по данным. |
NO_IDENTIFIERS_PROVIDED | Данные о событиях не содержат идентификаторов пользователей или рекламных идентификаторов. |
INVALID_PROPERTY_TYPE | Данный тип свойства не поддерживается. |
INVALID_STREAM_TYPE | Тип потока не поддерживается. |
LINKED_ACCOUNT_ONLY_ALLOWED_WITH_DATA_PARTNER_LOGIN_ACCOUNT | Связанная учетная запись поддерживается только в том случае, если учетная запись для входа является учетной записью DATA_PARTNER . |
OPERATING_ACCOUNT_LOGIN_ACCOUNT_MISMATCH | Для данного сценария использования учетная запись для входа в систему должна совпадать с операционной учетной записью. |
EVENT_TIME_INVALID | Событие не произошло в допустимые сроки. |
RESERVED_NAME_USED | Параметр использует зарезервированное имя. |
INVALID_EVENT_NAME | Название события не поддерживается. |
NOT_ALLOWLISTED | Данная учетная запись не включена в список разрешенных для использования указанной функции. |
INVALID_REQUEST_ID | Идентификатор запроса, используемый для получения статуса запроса, недействителен. Статус можно получить только для запросов, которые успешно выполнены и не имеют validate_only=true . |
MULTIPLE_DESTINATIONS_FOR_GOOGLE_ANALYTICS_EVENT | В рамках мероприятия использовалось 2 или более точек доступа Google Analytics. |
FIELD_VALUE_TOO_LONG | Значение поля слишком длинное. |
TOO_MANY_ELEMENTS | В запросе слишком много элементов в списке. |
ALREADY_EXISTS | Ресурс уже существует. |
IMMUTABLE_FIELD_FOR_UPDATE | Была предпринята попытка установить неизменяемое поле для запроса на обновление. |
INVALID_RESOURCE_NAME | Недопустимое имя ресурса. |
INVALID_FILTER | Фильтр запроса недействителен. |
INVALID_UPDATE_MASK | Маска обновления недействительна. |
INVALID_PAGE_TOKEN | Токен страницы недействителен. |
CANNOT_UPDATE_DISABLED_LICENSE | Невозможно обновить отключенную лицензию. |
CANNOT_CREATE_LICENSE_FOR_SENSITIVE_USERLIST | Для данного клиента лицензирование списков конфиденциальных пользователей невозможно. |
INSUFFICIENT_COST | Стоимость этой лицензии слишком низкая. |
CANNOT_DISABLE_LICENSE | Лицензию реселлера нельзя отключить, поскольку она уже используется. |
INVALID_CLIENT_ACCOUNT_ID | Неверный идентификатор учетной записи клиента. |
PRICING_ONLY_ZERO_COST_ALLOWED | Для данного клиентского счета не допускается внесение ненулевых платежей. |
PRICE_TOO_HIGH | Стоимость этой лицензии слишком высока. |
CUSTOMER_NOT_ALLOWED_TO_CREATE_LICENSE | Клиенту не разрешено создавать лицензию. |
INVALID_PRICING_END_DATE | Дата окончания действия ценообразования для данной лицензии недействительна. |
CANNOT_LICENSE_LOGICAL_LIST_WITH_LICENSED_OR_SHARED_SEGMENT | Логический список пользователей с общим или лицензированным сегментом не может быть лицензирован. |
MISMATCHED_ACCOUNT_TYPE | Тип учетной записи клиента, указанный в запросе, не соответствует фактическому типу учетной записи клиента. |
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_LICENSE_TYPE | Тип лицензии не поддерживает оплату за совместное использование медиафайлов. |
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_CLIENT_CUSTOMER | Тип клиента «Клиент» не поддерживает оплату за размещение медиаконтента. |
INVALID_MEDIA_SHARE_COST | Неверная стоимость медиа-аккаунта. |
INVALID_COST_TYPE | Недопустимый тип затрат. |
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_NON_COMMERCE_USER_LIST | Тип UserList не поддерживает стоимость совместного доступа к медиафайлам. |
MAX_COST_NOT_ALLOWED | Максимальная допустимая стоимость может быть установлена только для типа стоимости MEDIA_SHARE. |
COMMERCE_AUDIENCE_CAN_ONLY_BE_DIRECTLY_LICENSED | Коммерческая аудитория может быть лицензирована только напрямую. |
INVALID_DESCRIPTION | Описание неверно. |
INVALID_DISPLAY_NAME | Отображаемое имя недопустимо. |
DISPLAY_NAME_ALREADY_USED | Отображаемое имя уже используется в другом списке пользователей для этой учетной записи. |
OWNERSHIP_REQUIRED_FOR_UPDATE | Для изменения списка пользователей необходимы права владельца. |
USER_LIST_MUTATION_NOT_SUPPORTED | Тип списка пользователей доступен только для чтения и не поддерживает изменение данных. |
SENSITIVE_USER_LIST_IMMUTABLE | Список пользователей, содержащий конфиденциальную информацию или отклоненный по закону, не может быть изменен внешними пользователями. |
BILLABLE_RECORD_COUNT_IMMUTABLE | Поле «Платная запись» в списке пользователей ремаркетинга нельзя изменить после того, как оно установлено. |
USER_LIST_NAME_RESERVED | Название списка пользователей зарезервировано для системных списков. |
ADVERTISER_NOT_ALLOWLISTED_FOR_UPLOADED_DATA | Для использования списков ремаркетинга, созданных на основе загруженных рекламодателем данных, рекламодатель должен быть включен в список разрешенных. |
UNSUPPORTED_PARTNER_AUDIENCE_SOURCE | Для типа списка пользователей источник аудитории партнеров не поддерживается. |
COMMERCE_PARTNER_NOT_ALLOWED | Установка значения поля commerce_partner поддерживается только в том случае, если partner_audience_source имеет COMMERCE_AUDIENCE . |
UNSUPPORTED_PARTNER_AUDIENCE_INFO | Поле partner_audience_info не поддерживается для типа списка пользователей. |
PARTNER_MATCH_FOR_MANAGER_ACCOUNT_DISALLOWED | Списки пользователей Partner Match нельзя создавать с помощью учетных записей менеджеров. |
DATA_PARTNER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA | Данный партнер по передаче данных не включен в список разрешенных для THIRD_PARTY_PARTNER_DATA. |
ADVERTISER_TOS_NOT_ACCEPTED | Рекламодатель не принял условия предоставления услуг партнера. |
ADVERTISER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA | Данный рекламодатель не включен в список разрешенных для использования в рамках проекта THIRD_PARTNER_DATA. |
USER_LIST_TYPE_NOT_SUPPORTED_FOR_ACCOUNT | Для данной учетной записи этот тип списка пользователей не поддерживается. |
INVALID_COMMERCE_PARTNER | Поле commerce_partner недействительно. |
CUSTOMER_NOT_ALLOWLISTED_FOR_COMMERCE_AUDIENCE | Поставщику данных запрещено создавать коммерческие аудитории. |
UNSUPPORTED_USER_LIST_UPLOAD_KEY_TYPES | Типы ключей для загрузки списка пользователей не поддерживаются. |
UNSUPPORTED_INGESTED_USER_LIST_INFO_CONFIG | Конфигурация списка пользователей, полученного из пользовательских файлов, не поддерживается. |
UNSUPPORTED_ACCOUNT_TYPES_FOR_USER_LIST_TYPE | Типы учетных записей не поддерживаются для типа списка пользователей. |
UNSUPPORTED_ACCOUNT_TYPE_FOR_PARTNER_LINK | Для партнерской ссылки указанные типы учетных записей не поддерживаются. |
Событие
Событие, представляющее собой взаимодействие пользователя с веб-сайтом или приложением рекламодателя.
| Поля | |
|---|---|
destination_references[] | Необязательный параметр. Строка-ссылка, используемая для определения пункта назначения. Если поле пустое, событие будет отправлено всем |
transaction_id | Необязательный параметр. Уникальный идентификатор данного события. Обязателен для преобразований с использованием нескольких источников данных. |
event_timestamp | Обязательно. Время, когда произошло событие. |
last_updated_timestamp | Необязательно. Последнее обновление информации о событии. |
user_data | Необязательно. Фрагменты предоставленных пользователем данных, представляющие пользователя, с которым связано событие. |
consent | Необязательно. Информация о том, предоставил ли связанный пользователь различные типы согласия. |
ad_identifiers | Необязательно. Идентификаторы и другая информация, используемая для сопоставления события конверсии с другой онлайн-активностью (например, кликами по рекламе). |
currency | Необязательно. Код валюты, связанный со всеми денежными значениями в рамках этого события. |
event_source | Необязательно. Указывает место проведения события (веб, приложение, магазин и т. д.). |
event_device_info | Необязательно. Собирается информация об используемом устройстве (если таковое имелось) в момент происшествия. |
cart_data | Необязательно. Информация о транзакции и товарах, связанных с мероприятием. |
custom_variables[] | Необязательно. Дополнительная информация в виде пар ключ/значение для отправки в контейнеры конверсии (действие конверсии или активность FL). |
experimental_fields[] | Необязательно. Список пар ключ/значение для экспериментальных полей, которые в будущем могут быть включены в API. |
user_properties | Необязательно. Информация о пользователе, оцененная рекламодателем на момент совершения события. |
event_name | Необязательно. Название мероприятия. Обязательно для мероприятий GA4. |
client_id | Необязательно. Уникальный идентификатор экземпляра веб-клиента пользователя для этого веб-потока GA4. |
user_id | Необязательный параметр. Уникальный идентификатор пользователя, определяемый рекламодателем. |
additional_event_parameters[] | Необязательно. Список любых параметров события , которые должны быть включены в событие и которые не были указаны ранее с помощью других структурированных полей. |
conversion_value | Необязательно. Значение конверсии, связанное с событием, для конверсий, основанных на значении. |
EventParameter
Параметр события для событий GA4.
| Поля | |
|---|---|
parameter_name | Обязательно. Название используемого параметра. |
value | Обязательно. Строковое представление значения параметра, который необходимо установить. |
EventSource
Источник события.
| Перечисления | |
|---|---|
EVENT_SOURCE_UNSPECIFIED | Неуказанный EventSource. Использовать его не следует. |
WEB | Событие было сгенерировано из веб-браузера. |
APP | Событие было сгенерировано с помощью приложения. |
IN_STORE | Событие было инициировано транзакцией в магазине. |
PHONE | Идея мероприятия возникла после телефонного звонка. |
OTHER | Информация о мероприятии была получена из других источников. |
Экспериментальная область
Экспериментальное поле, представляющее собой неофициальные поля.
| Поля | |
|---|---|
field | Необязательно. Название используемого поля. |
value | Необязательный параметр. Значение поля, которое необходимо установить. |
GcpWrappedKeyInfo
Информация о зашифрованном ключе Google Cloud Platform.
| Поля | |
|---|---|
key_type | Обязательно. Тип алгоритма, используемого для шифрования данных. |
wip_provider | Обязательно. Поставщик пула учетных данных рабочей нагрузки должен использовать KEK. |
kek_uri | Обязательно. Идентификатор ресурса службы управления ключами Google Cloud Platform. Должен быть в формате |
encrypted_dek | Обязательно. Ключ шифрования данных, закодированных в base64. |
KeyType
Тип алгоритма, используемого для шифрования данных.
| Перечисления | |
|---|---|
KEY_TYPE_UNSPECIFIED | Тип ключа не указан. Использовать его не следует. |
XCHACHA20_POLY1305 | Алгоритм XChaCha20-Poly1305 |
Пол
Тип демографического пола (например, женский).
| Перечисления | |
|---|---|
GENDER_UNSPECIFIED | Не указан. |
GENDER_UNKNOWN | Неизвестный. |
GENDER_MALE | Мужской. |
GENDER_FEMALE | Женский. |
GetUserListDirectLicenseRequest
Запрос на получение ресурса UserListDirectLicense .
| Поля | |
|---|---|
name | Обязательно. Имя ресурса прямой лицензии списка пользователей. |
GetUserListGlobalLicenseRequest
Запрос на получение ресурса UserListGlobalLicense .
| Поля | |
|---|---|
name | Обязательно. Имя ресурса глобальной лицензии списка пользователей. |
GetUserListRequest
Сообщение запроса для функции GetUserList.
| Поля | |
|---|---|
name | Обязательно. Имя ресурса списка пользователей, который необходимо получить. Формат: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} |
IngestAudienceMembersRequest
Запрос на загрузку данных об участниках аудитории в указанные места назначения. Возвращает объект IngestAudienceMembersResponse .
| Поля | |
|---|---|
destinations[] | Обязательно. Список мест назначения, куда следует направить участников аудитории. |
audience_members[] | Обязательный параметр. Список пользователей, которым необходимо отправить данные в указанные пункты назначения. В одном запросе можно отправить не более 10000 ресурсов |
consent | Необязательно. Согласие на уровне запроса применяется ко всем пользователям в запросе. Согласие на уровне пользователя имеет приоритет над согласием на уровне запроса и может быть указано в каждом |
validate_only | Необязательно. Используется в целях тестирования. Если |
encoding | Необязательно. Обязательно для загрузки |
encryption_info | Необязательно. Информация о шифровании для загружаемых |
terms_of_service | Необязательно. Условия предоставления услуг, которые пользователь принял/отклонил. |
IngestAudienceMembersResponse
Ответ на запрос IngestAudienceMembersRequest .
| Поля | |
|---|---|
request_id | Автоматически сгенерированный идентификатор запроса. |
IngestEventsRequest
Запрос на загрузку данных об участниках аудитории в указанные места назначения. Возвращает объект IngestEventsResponse .
| Поля | |
|---|---|
destinations[] | Обязательно. Список адресатов, куда следует отправлять события. |
events[] | Обязательный параметр. Список событий для отправки в указанные пункты назначения. В одном запросе можно отправить не более 2000 ресурсов |
consent | Необязательно. Согласие на уровне запроса применяется ко всем пользователям в запросе. Согласие на уровне пользователя имеет приоритет над согласием на уровне запроса и может быть указано в каждом |
validate_only | Необязательно. Используется в целях тестирования. Если |
encoding | Необязательно. Обязательно для загрузки |
encryption_info | Необязательно. Информация о шифровании для загружаемых |
IngestEventsResponse
Ответ от IngestEventsRequest .
| Поля | |
|---|---|
request_id | Автоматически сгенерированный идентификатор запроса. |
IngestedUserListInfo
Представляет собой список пользователей, заполняемый данными, предоставленными пользователями.
| Поля | |
|---|---|
upload_key_types[] | Обязательно. Неизменяемо. Загрузите типы ключей этого списка пользователей. |
contact_id_info | Необязательно. Дополнительная информация, если |
mobile_id_info | Необязательно. Дополнительная информация, если |
user_id_info | Необязательно. Дополнительная информация, если |
pair_id_info | Необязательно. Дополнительная информация, если Эта функция доступна только партнерам по передаче данных. |
pseudonymous_id_info | Необязательно. Дополнительная информация для |
partner_audience_info | Необязательно. Дополнительная информация для партнеров. Эта функция доступна только партнерам по передаче данных. |
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 |
Элемент
Представляет собой товар в корзине, связанный с событием.
| Поля | |
|---|---|
merchant_product_id | Необязательно. Идентификатор продукта в учетной записи Merchant Center. |
quantity | Необязательно. Номер данного товара, связанный с мероприятием. |
unit_price | Дополнительно. Цена за единицу товара указана без учета налогов, доставки и любых скидок за транзакцию. |
item_id | Необязательно. Уникальный идентификатор для ссылки на элемент. |
additional_item_parameters[] | Необязательно. Список любых параметров события, относящихся к элементу , который должен быть включен в событие и который не был указан ранее с помощью других структурированных полей. |
ItemParameter
Совокупность любых параметров события, относящихся к элементу, который должен быть включен в событие и который не был предварительно указан с помощью других структурированных полей.
| Поля | |
|---|---|
parameter_name | Обязательно. Название используемого параметра. |
value | Обязательно. Строковое представление значения параметра, который необходимо установить. |
ListUserListDirectLicensesRequest
Запрос на получение списка всех ресурсов UserListDirectLicense для заданной учетной записи.
| Поля | |
|---|---|
parent | Обязательно. Учетная запись, лицензии которой запрашиваются. Формат: accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} |
filter | Необязательно. Фильтры, применяемые к запросу списка. Все поля должны располагаться слева от каждого условия (например: user_list_id = 123). Поддерживаемые операции:
Неподдерживаемые поля:
|
page_size | Необязательный параметр. Максимальное количество лицензий, возвращаемых на странице. Сервис может вернуть меньше этого значения. Если параметр не указан, будет возвращено не более 50 лицензий. Максимальное значение — 1000; значения выше 1000 будут преобразованы в 1000. |
page_token | Необязательный параметр. Токен страницы, полученный из предыдущего вызова При использовании постраничной навигации все остальные параметры, передаваемые в |
ListUserListDirectLicensesResponse
Ответ от ListUserListDirectLicensesRequest .
| Поля | |
|---|---|
user_list_direct_licenses[] | Список лицензий для данного пользователя содержится в запросе. |
next_page_token | Токен, который можно отправить в качестве |
ListUserListGlobalLicenseCustomerInfosRequest
Запрос на получение списка всех ресурсов UserListGlobalLicenseCustomerInfo для заданной глобальной лицензии списка пользователей.
| Поля | |
|---|---|
parent | Обязательно. Глобальная лицензия, информация о клиентах которой запрашивается. Должна быть в формате |
filter | Необязательно. Фильтры, применяемые к запросу списка. Все поля должны располагаться слева от каждого условия (например: user_list_id = 123). Поддерживаемые операции:
Неподдерживаемые поля:
|
page_size | Необязательно. Максимальное количество возвращаемых лицензий. Сервис может вернуть меньше этого значения. Если не указано, будет возвращено не более 50 лицензий. Максимальное значение — 1000; значения выше 1000 будут преобразованы в 1000. |
page_token | Необязательный параметр. Токен страницы, полученный из предыдущего вызова При использовании постраничной навигации все остальные параметры, передаваемые в |
ListUserListGlobalLicenseCustomerInfosResponse
Ответ от [ListUserListGlobalLicensesCustomerInfoRequest][google.ads.datamanager.v1.ListUserListGlobalLicensesCustomerInfoRequest].
| Поля | |
|---|---|
user_list_global_license_customer_infos[] | Информация о клиенте, относящаяся к данной лицензии, указывается в запросе. |
next_page_token | Токен, который можно отправить в качестве |
ListUserListGlobalLicensesRequest
Запрос на получение списка всех ресурсов UserListGlobalLicense для заданной учетной записи.
| Поля | |
|---|---|
parent | Обязательно. Учетная запись, лицензии которой запрашиваются. Формат: accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} |
filter | Необязательно. Фильтры, применяемые к запросу списка. Все поля должны располагаться слева от каждого условия (например: user_list_id = 123). Поддерживаемые операции:
Неподдерживаемые поля:
|
page_size | Необязательно. Максимальное количество возвращаемых лицензий. Сервис может вернуть меньше этого значения. Если не указано, будет возвращено не более 50 лицензий. Максимальное значение — 1000; значения выше 1000 будут преобразованы в 1000. |
page_token | Необязательный параметр. Токен страницы, полученный из предыдущего вызова При использовании постраничной навигации все остальные параметры, передаваемые в |
ListUserListGlobalLicensesResponse
Ответ от ListUserListGlobalLicensesRequest .
| Поля | |
|---|---|
user_list_global_licenses[] | Список лицензий для данного пользователя содержится в запросе. |
next_page_token | Токен, который можно отправить в качестве |
ListUserListsRequest
Запрос сообщения для ListUserLists.
| Поля | |
|---|---|
parent | Обязательно. Родительская учетная запись, которой принадлежит этот набор списков пользователей. Формат: accountTypes/{account_type}/accounts/{account} |
page_size | Необязательный параметр. Максимальное количество списков пользователей для возврата. Сервис может вернуть меньше этого значения. Если параметр не указан, будет возвращено не более 50 списков пользователей. Максимальное значение — 1000; значения выше 1000 будут преобразованы в 1000. |
page_token | Необязательный параметр. Токен страницы, полученный из предыдущего вызова При использовании постраничной навигации все остальные параметры, передаваемые в |
filter | Необязательно. Строка фильтра . Все поля должны находиться слева от каждого условия (например: Поддерживаемые операции:
Поддерживаемые поля:
|
ListUserListsResponse
Ответное сообщение для ListUserLists.
| Поля | |
|---|---|
user_lists[] | Пользователь размещает список с указанного аккаунта. |
next_page_token | Токен, который можно отправить в качестве |
Диапазон коэффициентов соответствия
Диапазон вероятности совпадения для загружаемых файлов или списка пользователей.
| Перечисления | |
|---|---|
MATCH_RATE_RANGE_UNKNOWN | Диапазон вероятности совпадения неизвестен. |
MATCH_RATE_RANGE_NOT_ELIGIBLE | Диапазон коэффициентов соответствия не подходит. |
MATCH_RATE_RANGE_LESS_THAN_20 | Диапазон вероятности совпадения составляет менее 20% (в интервале [0, 20) ). |
MATCH_RATE_RANGE_20_TO_30 | Диапазон вероятности совпадения составляет от 20% до 30% (в интервале [20, 31) ). |
MATCH_RATE_RANGE_31_TO_40 | Диапазон процента совпадений составляет от 31% до 40% (в интервале [31, 41) ). |
MATCH_RATE_RANGE_41_TO_50 | Диапазон процента совпадений составляет от 41% до 50% (в интервале [41, 51) ). |
MATCH_RATE_RANGE_51_TO_60 | Диапазон процента совпадений составляет от 51% до 60% (в интервале [51, 61) . |
MATCH_RATE_RANGE_61_TO_70 | Диапазон процента совпадений составляет от 61% до 70% (в интервале [61, 71) ). |
MATCH_RATE_RANGE_71_TO_80 | Диапазон процента совпадений составляет от 71% до 80% (в интервале [71, 81) ). |
MATCH_RATE_RANGE_81_TO_90 | Диапазон процента совпадений составляет от 81% до 90% (в интервале [81, 91) ). |
MATCH_RATE_RANGE_91_TO_100 | Диапазон вероятности совпадения составляет от 91% до 100% (в интервале |
Мобильные данные
Идентификаторы мобильных телефонов для аудитории. Требуется как минимум один идентификатор мобильного телефона.
| Поля | |
|---|---|
mobile_ids[] | Обязательно. Список идентификаторов мобильных устройств (идентификатор рекламы/IDFA). В одном объекте |
MobileIdInfo
Дополнительная информация, если MOBILE_ID является одним из типов upload_key_types .
| Поля | |
|---|---|
data_source_type | Необязательно. Неизменяемо. Источник данных для загрузки. |
key_space | Обязательный. Неизменяемый. Ключевое пространство мобильных идентификаторов. |
app_id | Обязательный параметр. Неизменяемый. Строка, однозначно идентифицирующая мобильное приложение, из которого были собраны данные. |
Пространство клавиш
Ключевое пространство для мобильной идентификации.
| Перечисления | |
|---|---|
KEY_SPACE_UNSPECIFIED | Не указан. |
IOS | Пространство ключей iOS. |
ANDROID | Пространство ключей Android. |
Парные данные
Идентификаторы пар (PAIR ID) для аудитории. Требуется как минимум один идентификатор пары.
Эта функция доступна только партнерам по передаче данных.
| Поля | |
|---|---|
pair_ids[] | Обязательно. Персональные данные, предоставленные в чистой комнате, хешированные с помощью SHA256 и зашифрованные коммутативным шифром EC с использованием ключа издателя для списка пользователей PAIR . В одном объекте |
PairIdInfo
Дополнительная информация, если PAIR_ID является одним из типов upload_key_types .
Эта функция доступна только партнерам по передаче данных.
| Поля | |
|---|---|
match_rate_percentage | Только для вывода. Это поле обозначает процент соответствия состава списка пользователей данным издателя, полученным непосредственно от издателя. Значение должно быть в диапазоне от 0 до 100 включительно. |
advertiser_identifier_count | Только выходные данные. Количество записей собственных данных рекламодателя, загруженных в систему обработки данных в чистой комнате. Это не указывает на размер списка пользователей PAIR. |
publisher_id | Обязательное поле. Неизменяемое. Идентифицирует издателя, с которым согласовывается список пользователей Publisher Advertiser Identity Reconciliation. Это поле предоставляется поставщиком чистой комнаты и является уникальным только в рамках данной чистой комнаты. Его нельзя использовать в качестве глобального идентификатора для нескольких чистых комнат. |
publisher_name | Необязательно. Описательное название издателя, которое будет отображаться в пользовательском интерфейсе для более эффективного таргетирования. |
clean_room_identifier | Обязательный. Неизменяемый. Идентифицирует уникальные отношения между рекламодателем и издателем, установленные одним поставщиком чистых помещений или несколькими поставщиками чистых помещений. |
PartnerAudienceInfo
Дополнительная информация для партнеров.
Эта функция доступна только партнерам по передаче данных.
| Поля | |
|---|---|
partner_audience_source | Обязательный. Неизменяемый. Источник партнерской аудитории. |
commerce_partner | Необязательно. Название партнера по коммерции. Допускается только в том случае, если |
PartnerAudienceSource
Источник аудитории партнёра.
| Перечисления | |
|---|---|
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED | Не указан. |
COMMERCE_AUDIENCE | Источником партнерской аудитории является коммерческая аудитория. |
LINEAR_TV_AUDIENCE | Источником целевой аудитории для партнеров является аудитория традиционного телевидения. |
AGENCY_PROVIDER_AUDIENCE | Источником целевой аудитории для партнеров является аудитория агентства/поставщика услуг. |
ПартнерЛинк
Партнерская связь между учетной записью владельца и партнерской учетной записью.
| Поля | |
|---|---|
name | Идентификатор. Название партнерской ссылки. Формат: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} |
partner_link_id | Только для вывода. Идентификатор партнерской ссылки. |
owning_account | Required. The owning account granting access to the partner account. |
partner_account | Required. The partner account granted access by the owning account. |
PpidData
Издатель предоставил данные идентификаторов, содержащие ppid. Требуется как минимум один ppid.
Эта функция доступна только партнерам по передаче данных.
| Поля | |
|---|---|
ppids[] | Обязательно. Список предоставленных издателем идентификаторов пользователя. |
ProcessingErrorReason
The processing error reason.
| Перечисления | |
|---|---|
PROCESSING_ERROR_REASON_UNSPECIFIED | The processing error reason is unknown. |
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE | The custom variable is invalid. |
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED | The status of the custom variable is not enabled. |
PROCESSING_ERROR_REASON_EVENT_TOO_OLD | The conversion is older than max supported age. |
PROCESSING_ERROR_REASON_DENIED_CONSENT | The ad user data is denied, either by the user or in the advertiser default settings. |
PROCESSING_ERROR_REASON_NO_CONSENT | Advertiser did not give 3P consent for the Ads core platform services. |
PROCESSING_ERROR_REASON_UNKNOWN_CONSENT | The overall consent (determined from row level consent, request level consent, and account settings) could not be determined for this user |
PROCESSING_ERROR_REASON_DUPLICATE_GCLID | A conversion with the same GCLID and conversion time already exists in the system. |
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID | A conversion with the same order id and conversion action combination was already uploaded. |
PROCESSING_ERROR_REASON_INVALID_GBRAID | The gbraid could not be decoded. |
PROCESSING_ERROR_REASON_INVALID_GCLID | The google click ID could not be decoded. |
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID | Merchant id contains non-digit characters. |
PROCESSING_ERROR_REASON_INVALID_WBRAID | The wbraid could not be decoded. |
PROCESSING_ERROR_REASON_INTERNAL_ERROR | Внутренняя ошибка. |
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED | Enhanced conversions terms are not signed in the destination account. |
PROCESSING_ERROR_REASON_INVALID_EVENT | The event is invalid. |
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS | The matched transactions are less than the minimum threshold. |
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS | The transactions are less than the minimum threshold. |
PROCESSING_ERROR_REASON_INVALID_FORMAT | The event has format error. |
PROCESSING_ERROR_REASON_DECRYPTION_ERROR | The event has a decryption error. |
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR | The DEK failed to be decrypted. |
PROCESSING_ERROR_REASON_INVALID_WIP | The WIP is formatted incorrectly or the WIP does not exist. |
PROCESSING_ERROR_REASON_INVALID_KEK | The KEK cannot decrypt data because it is the wrong KEK, or it does not exist. |
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED | The WIP could not be used because it was rejected by its attestation condition. |
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED | The system did not have the permissions needed to access the KEK. |
PROCESSING_ERROR_REASON_AWS_AUTH_FAILED | The system failed to authenticate with AWS. |
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR | Failed to decrypt the UserIdentifier data using the DEK. |
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER | The user attempted to ingest events with an ad identifier that isn't from the operating account's ads. |
ProcessingWarningReason
The processing warning reason.
| Перечисления | |
|---|---|
PROCESSING_WARNING_REASON_UNSPECIFIED | The processing warning reason is unknown. |
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED | The system did not have the permissions needed to access the KEK. |
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR | The DEK failed to be decrypted. |
PROCESSING_WARNING_REASON_DECRYPTION_ERROR | The event has a decryption error. |
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED | The WIP could not be used because it was rejected by its attestation condition. |
PROCESSING_WARNING_REASON_INVALID_WIP | The WIP is formatted incorrectly or the WIP does not exist. |
PROCESSING_WARNING_REASON_INVALID_KEK | The KEK cannot decrypt data because it is the wrong KEK, or it does not exist. |
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR | Failed to decrypt th UserIdentifier data using the DEK. |
PROCESSING_WARNING_REASON_INTERNAL_ERROR | Внутренняя ошибка. |
PROCESSING_WARNING_REASON_AWS_AUTH_FAILED | The system failed to authenticate with AWS. |
Продукт
Deprecated. Use AccountType
| Перечисления | |
|---|---|
PRODUCT_UNSPECIFIED | Unspecified product. Should never be used. |
GOOGLE_ADS | Google Ads. |
DISPLAY_VIDEO_PARTNER | Display & Video 360 partner. |
DISPLAY_VIDEO_ADVERTISER | Display & Video 360 advertiser. |
DATA_PARTNER | Data Partner. |
ProductAccount
Represents a specific account.
| Поля | |
|---|---|
product | Deprecated. Use |
account_id | Required. The ID of the account. For example, your Google Ads account ID. |
account_type | Optional. The type of the account. For example, |
Тип учетной записи
Represents Google account types. Used to locate accounts and destinations.
| Перечисления | |
|---|---|
ACCOUNT_TYPE_UNSPECIFIED | Unspecified product. Should never be used. |
GOOGLE_ADS | Google Ads. |
DISPLAY_VIDEO_PARTNER | Display & Video 360 partner. |
DISPLAY_VIDEO_ADVERTISER | Display & Video 360 advertiser. |
DATA_PARTNER | Data Partner. |
GOOGLE_ANALYTICS_PROPERTY | Google Analytics. |
GOOGLE_AD_MANAGER_AUDIENCE_LINK | Google Ad Manager audience link. |
PseudonymousIdInfo
Additional information when PSEUDONYMOUS_ID is one of the upload_key_types .
| Поля | |
|---|---|
sync_status | Только вывод. Статус синхронизации списка пользователей. |
billable_record_count | Необязательный параметр. Неизменяемый параметр. Количество платных записей (например, загруженных или сопоставленных). |
SyncStatus
Статус синхронизации списка пользователей.
| Перечисления | |
|---|---|
SYNC_STATUS_UNSPECIFIED | Не указан. |
CREATED | Список пользователей создан как временный. Содержимое списка и/или метаданные все еще синхронизируются. Список пользователей не готов к использованию. |
READY_FOR_USE | Список пользователей готов к использованию. Содержимое и файлы cookie синхронизированы корректно. |
FAILED | Произошла ошибка при синхронизации содержимого списка пользователей и/или метаданных. Список пользователей не может быть использован. |
RemoveAudienceMembersRequest
Request to remove users from an audience in the provided destinations. Returns a RemoveAudienceMembersResponse .
| Поля | |
|---|---|
destinations[] | Required. The list of destinations to remove the users from. |
audience_members[] | Required. The list of users to remove. |
validate_only | Optional. For testing purposes. If |
encoding | Optional. Required for |
encryption_info | Optional. Encryption information for |
RemoveAudienceMembersResponse
Response from the RemoveAudienceMembersRequest .
| Поля | |
|---|---|
request_id | The auto-generated ID of the request. |
RequestStatusPerDestination
A request status per destination.
| Поля | |
|---|---|
destination | A destination within a DM API request. |
request_status | The request status of the destination. |
error_info | An error info error containing the error reason and error counts related to the upload. |
warning_info | A warning info containing the warning reason and warning counts related to the upload. |
Union field status . The status of the destination. status can be only one of the following: | |
audience_members_ingestion_status | The status of the ingest audience members request. |
events_ingestion_status | The status of the ingest events request. |
audience_members_removal_status | The status of the remove audience members request. |
IngestAudienceMembersStatus
The status of the ingest audience members request.
| Поля | |
|---|---|
Union field status . The status of the audience members ingestion to the destination. status can be only one of the following: | |
user_data_ingestion_status | The status of the user data ingestion to the destination. |
mobile_data_ingestion_status | The status of the mobile data ingestion to the destination. |
pair_data_ingestion_status | The status of the pair data ingestion to the destination. |
user_id_data_ingestion_status | The status of the user id data ingestion to the destination. |
ppid_data_ingestion_status | The status of the ppid data ingestion to the destination. |
IngestEventsStatus
The status of the events ingestion to the destination.
| Поля | |
|---|---|
record_count | The total count of events sent in the upload request. Includes all events in the request, regardless of whether they were successfully ingested or not. |
IngestMobileDataStatus
The status of the mobile data ingestion to the destination containing stats related to the ingestion.
| Поля | |
|---|---|
record_count | The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. |
mobile_id_count | The total count of mobile ids sent in the upload request for the destination. Includes all mobile ids in the request, regardless of whether they were successfully ingested or not. |
IngestPairDataStatus
The status of the pair data ingestion to the destination containing stats related to the ingestion.
| Поля | |
|---|---|
record_count | The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. |
pair_id_count | The total count of pair ids sent in the upload request for the destination. Includes all pair ids in the request, regardless of whether they were successfully ingested or not. |
IngestPpidDataStatus
The status of the ppid data ingestion to the destination containing stats related to the ingestion.
| Поля | |
|---|---|
record_count | The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. |
ppid_count | The total count of ppids sent in the upload request for the destination. Includes all ppids in the request, regardless of whether they were successfully ingested or not. |
IngestUserDataStatus
The status of the user data ingestion to the destination containing stats related to the ingestion.
| Поля | |
|---|---|
record_count | The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. |
user_identifier_count | The total count of user identifiers sent in the upload request for the destination. Includes all user identifiers in the request, regardless of whether they were successfully ingested or not. |
upload_match_rate_range | The match rate range of the upload. |
IngestUserIdDataStatus
The status of the user id data ingestion to the destination containing stats related to the ingestion.
| Поля | |
|---|---|
record_count | The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. |
user_id_count | The total count of user ids sent in the upload request for the destination. Includes all user ids in the request, regardless of whether they were successfully ingested or not. |
RemoveAudienceMembersStatus
The status of the remove audience members request.
| Поля | |
|---|---|
Union field status . The status of the audience members removal from the destination. status can be only one of the following: | |
user_data_removal_status | The status of the user data removal from the destination. |
mobile_data_removal_status | The status of the mobile data removal from the destination. |
pair_data_removal_status | The status of the pair data removal from the destination. |
user_id_data_removal_status | The status of the user id data removal from the destination. |
ppid_data_removal_status | The status of the ppid data removal from the destination. |
RemoveMobileDataStatus
The status of the mobile data removal from the destination.
| Поля | |
|---|---|
record_count | The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. |
mobile_id_count | The total count of mobile Ids sent in the removal request. Includes all mobile ids in the request, regardless of whether they were successfully removed or not. |
RemovePairDataStatus
The status of the pair data removal from the destination.
| Поля | |
|---|---|
record_count | The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. |
pair_id_count | The total count of pair ids sent in the removal request. Includes all pair ids in the request, regardless of whether they were successfully removed or not. |
RemovePpidDataStatus
The status of the ppid data removal from the destination.
| Поля | |
|---|---|
record_count | The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. |
ppid_count | The total count of ppids sent in the removal request. Includes all ppids in the request, regardless of whether they were successfully removed or not. |
RemoveUserDataStatus
The status of the user data removal from the destination.
| Поля | |
|---|---|
record_count | The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. |
user_identifier_count | The total count of user identifiers sent in the removal request. Includes all user identifiers in the request, regardless of whether they were successfully removed or not. |
RemoveUserIdDataStatus
The status of the user id data removal from the destination.
| Поля | |
|---|---|
record_count | The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. |
user_id_count | The total count of user ids sent in the removal request. Includes all user ids in the request, regardless of whether they were successfully removed or not. |
RequestStatus
The request status.
| Перечисления | |
|---|---|
REQUEST_STATUS_UNKNOWN | The request status is unknown. |
SUCCESS | Запрос был успешно выполнен. |
PROCESSING | The request is processing. |
FAILED | Запрос не выполнен. |
PARTIAL_SUCCESS | The request partially succeeded. |
RetrieveInsightsRequest
Request message for DM API MarketingDataInsightsService.RetrieveInsights
| Поля | |
|---|---|
parent | Required. The parent account that owns the user list. Format: |
baseline | Required. Baseline for the insights requested. |
user_list_id | Required. The user list ID for which insights are requested. |
RetrieveInsightsResponse
Response message for DM API MarketingDataInsightsService.RetrieveInsights
| Поля | |
|---|---|
marketing_data_insights[] | Contains the insights for the marketing data. |
MarketingDataInsight
Insights for marketing data.
Эта функция доступна только партнерам по передаче данных.
| Поля | |
|---|---|
dimension | The dimension to which the insight belongs. |
attributes[] | Insights for values of a given dimension. |
AudienceInsightsDimension
Possible dimensions for use in generating insights.
| Перечисления | |
|---|---|
AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED | Не указан. |
AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN | The value is unknown in this version. |
AFFINITY_USER_INTEREST | An Affinity UserInterest. |
IN_MARKET_USER_INTEREST | An In-Market UserInterest. |
AGE_RANGE | An age range. |
GENDER | A gender. |
MarketingDataInsightsAttribute
Insights for a collection of related attributes of the same dimension.
| Поля | |
|---|---|
user_interest_id | The user interest ID. |
lift | Measure of lift that the audience has for the attribute value as compared to the baseline. Range [0-1]. |
age_range | Age range of the audience for which the lift is provided. |
gender | Gender of the audience for which the lift is provided. |
RetrieveRequestStatusRequest
Request to get the status of request made to the DM API for a given request ID. Returns a RetrieveRequestStatusResponse .
| Поля | |
|---|---|
request_id | Required. Required. The request ID of the Data Manager API request. |
RetrieveRequestStatusResponse
Response from the RetrieveRequestStatusRequest .
| Поля | |
|---|---|
request_status_per_destination[] | A list of request statuses per destination. The order of the statuses matches the order of the destinations in the original request. |
SearchPartnerLinksRequest
Request to search for PartnerLink resources. Returns a SearchPartnerLinksResponse .
| Поля | |
|---|---|
parent | Required. Account to search for partner links. If no Format: |
page_size | Максимальное количество партнерских ссылок, которое может быть возвращено. Сервис может вернуть меньше этого значения. Если значение не указано, будет возвращено не более 10 партнерских ссылок. Максимальное значение — 100; значения выше 100 будут преобразованы в 100. |
page_token | A page token, received from a previous When paginating, all other parameters provided to |
filter | Optional. A filter string . All fields need to be on the left hand side of each condition (for example: Поддерживаемые операции:
Поддерживаемые поля:
Example: |
SearchPartnerLinksResponse
Ответ от запроса SearchPartnerLinksRequest .
| Поля | |
|---|---|
partner_links[] | Партнерские ссылки для данного аккаунта. |
next_page_token | A token, which can be sent as |
Информация о размере
Примерное количество участников в этом списке пользователей в различных целевых сетях.
| Поля | |
|---|---|
display_network_members_count | Только для вывода. Примерное количество участников в этом списке пользователей в контекстно-медийной сети Google. |
search_network_members_count | Только для вывода. Примерное количество участников в этом списке пользователей в домене google.com. Это участники, доступные для таргетинга в поисковых кампаниях. |
TargetNetworkInfo
Информация о критериях отбора для различных целевых сетей.
| Поля | |
|---|---|
eligible_for_display | Только для вывода. Указывает, что этот список пользователей подходит для показа в контекстно-медийной сети Google. |
eligible_for_search | Необязательно. Указывает, подходит ли этот список пользователей для показа в поисковой сети Google. |
Условия предоставления услуг
The terms of service that the user has accepted/rejected.
| Поля | |
|---|---|
customer_match_terms_of_service_status | Optional. The Customer Match terms of service: https://support.google.com/adspolicy/answer/6299717 . This must be accepted when ingesting |
TermsOfServiceStatus
Represents the caller's decision to accept or reject the terms of service.
| Перечисления | |
|---|---|
TERMS_OF_SERVICE_STATUS_UNSPECIFIED | Не указан. |
ACCEPTED | Status indicating the caller has chosen to accept the terms of service. |
REJECTED | Status indicating the caller has chosen to reject the terms of service. |
UpdateUserListDirectLicenseRequest
Request to update a UserListDirectLicense resource.
| Поля | |
|---|---|
user_list_direct_license | Required. The licenses' |
update_mask | Необязательный параметр. Список полей для обновления. Специальный символ |
UpdateUserListGlobalLicenseRequest
Request to update a UserListGlobalLicense resource.
| Поля | |
|---|---|
user_list_global_license | Required. The licenses' |
update_mask | Необязательный параметр. Список полей для обновления. Специальный символ |
UpdateUserListRequest
Request message for UpdateUserList.
| Поля | |
|---|---|
user_list | Required. The user list to update. The user list's |
update_mask | Необязательный параметр. Список полей для обновления. |
validate_only | Необязательный параметр. Если значение равно true, запрос проверяется, но не выполняется. |
Пользовательские данные
Data that identifies the user. At least one identifier is required.
| Поля | |
|---|---|
user_identifiers[] | Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 |
UserIdData
Данные идентификатора пользователя, содержащие идентификатор пользователя.
| Поля | |
|---|---|
user_id | Обязательно. Уникальный идентификатор пользователя, определенный рекламодателем. |
UserIdInfo
Additional information when USER_ID is one of the upload_key_types .
| Поля | |
|---|---|
data_source_type | Необязательно. Неизменяемо. Источник данных для загрузки. |
Идентификатор пользователя
A single identifier for the user.
| Поля | |
|---|---|
Union field identifier . Exactly one must be specified. identifier can be only one of the following: | |
email_address | Hashed email address using SHA-256 hash function after normalization. |
phone_number | Hashed phone number using SHA-256 hash function after normalization (E164 standard). |
address | The known components of a user's address. Holds a grouping of identifiers that are matched all at once. |
Список пользователей
Ресурс со списком пользователей.
| Поля | |
|---|---|
name | Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} |
id | Только вывод. Уникальный идентификатор списка пользователей. |
read_only | Только для вывода. Параметр, указывающий, может ли пользователь редактировать список. |
membership_duration | Необязательный параметр. Продолжительность пребывания пользователя в списке пользователей. Допустимые значения — точные кратные 24 часам (86400 секундам). Указание значения, не являющегося точным кратным 24 часам, приведет к ошибке INVALID_ARGUMENT. |
access_reason | Только вывод. Причина, по которой этому аккаунту был предоставлен доступ к списку. |
size_info | Только вывод. Примерное количество участников в этом списке пользователей в различных целевых сетях. |
target_network_info | Необязательно. Информация о соответствии критериям для различных целевых сетей. |
display_name | Обязательно. Отображаемое имя списка пользователей. |
description | Необязательно. Описание списка пользователей. |
membership_status | Необязательно. Статус членства в этом списке пользователей. |
integration_code | Необязательный параметр. Идентификатор из внешней системы. Используется продавцами списков пользователей для сопоставления идентификаторов в своих системах. |
closing_reason | Только вывод. Причина, по которой членство в этом списке пользователей закрыто. |
account_access_status | Необязательно. Указывает, включена ли эта функция общего доступа. Когда список пользователей предоставляется в общий доступ учетной записи, это поле устанавливается в |
Поле объединения user_list_info . Дополнительная информация о списке пользователей. user_list_info может принимать только одно из следующих значений: | |
ingested_user_list_info | Необязательный параметр. Представляет собой список пользователей, заполняемый данными, введенными пользователями. |
Причина доступа
Перечислите возможные причины доступа.
| Перечисления | |
|---|---|
ACCESS_REASON_UNSPECIFIED | Не указан. |
OWNED | Ресурс принадлежит пользователю. |
SHARED | Ресурс предоставляется пользователю. |
LICENSED | Ресурс предоставляется пользователю по лицензии. |
SUBSCRIBED | Пользователь оформил подписку на ресурс. |
AFFILIATED | Данный ресурс доступен пользователю. |
Статус доступа
Указывает, имеет ли данный клиент по-прежнему доступ к списку.
| Перечисления | |
|---|---|
ACCESS_STATUS_UNSPECIFIED | Не указан. |
ENABLED | Доступ разрешен. |
DISABLED | Доступ отключен. |
Причина закрытия
Указывает причину закрытия списка пользователей. Этот перечислимый тип используется только в том случае, если список автоматически закрывается системой.
| Перечисления | |
|---|---|
CLOSING_REASON_UNSPECIFIED | Не указан. |
UNUSED | Список пользователей был закрыт, поскольку в последнее время он не использовался для таргетинга. Подробности см. на странице https://support.google.com/google-ads/answer/2472738 . |
Статус членства
Статус списка пользователей.
| Перечисления | |
|---|---|
MEMBERSHIP_STATUS_UNSPECIFIED | Не указан. |
OPEN | Статус «Открыт» — список пользователей пополняется участниками, и его можно таргетировать. |
CLOSED | Статус: Закрыто — новые участники не добавляются. |
UserListDirectLicense
A user list direct license.
Эта функция доступна только партнерам по передаче данных.
| Поля | |
|---|---|
name | Identifier. The resource name of the user list direct license. |
user_list_display_name | Только вывод. Название списка пользователей, для которых предоставляется лицензия. Это поле доступно только для чтения. |
client_account_display_name | Только вывод. Имя клиента, которому предоставляется лицензия на список пользователей. Это поле доступно только для чтения. |
pricing | Optional. UserListDirectLicense pricing. |
historical_pricings[] | Только вывод. История цен на лицензию для этого списка пользователей. Это поле доступно только для чтения. |
metrics | Только для вывода. Метрики, относящиеся к данной лицензии. This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call |
user_list_id | Immutable. ID of the user list being licensed. |
client_account_type | Immutable. Account type of client customer which the user list is being licensed to. |
client_account_id | Immutable. ID of client customer which the user list is being licensed to. |
status | Optional. Status of UserListDirectLicense - ENABLED or DISABLED. |
UserListGlobalLicense
A user list global license.
Эта функция доступна только партнерам по передаче данных.
| Поля | |
|---|---|
name | Идентификатор. Имя ресурса глобальной лицензии списка пользователей. |
user_list_display_name | Только вывод. Название списка пользователей, для которых предоставляется лицензия. Это поле доступно только для чтения. |
pricing | Optional. UserListGlobalLicense pricing. |
historical_pricings[] | Только вывод. История цен на лицензию для этого списка пользователей. Это поле доступно только для чтения. |
metrics | Только для вывода. Метрики, относящиеся к данной лицензии. This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call |
user_list_id | Immutable. ID of the user list being licensed. |
license_type | Immutable. Product type of client customer which the user list is being licensed to. |
status | Optional. Status of UserListGlobalLicense - ENABLED or DISABLED. |
UserListGlobalLicenseCustomerInfo
Информация о клиенте, использующем глобальную лицензию, будет автоматически создана системой при покупке клиентом глобальной лицензии.
| Поля | |
|---|---|
name | Идентификатор. Имя ресурса списка пользователей, глобальной лицензии клиента. |
user_list_id | Только вывод. Идентификатор списка пользователей, для которого предоставляется лицензия. |
user_list_display_name | Только вывод. Название списка пользователей, для которых предоставляется лицензия. |
license_type | Только вывод. Тип продукта клиента, которому предоставляется лицензия на список пользователей. |
status | Только вывод. Статус UserListDirectLicense — ВКЛЮЧЕНО или ОТКЛЮЧЕНО. |
pricing | Только вывод. Цены UserListDirectLicense. |
client_account_type | Только вывод. Тип продукта клиента, которому предоставляется лицензия на список пользователей. |
client_account_id | Только вывод. Идентификатор клиента, которому предоставляется лицензия на список пользователей. |
client_account_display_name | Только вывод. Имя клиента, которому предоставляется лицензия на список пользователей. |
historical_pricings[] | Только вывод. История цен на лицензию для этого списка пользователей. |
metrics | Только для вывода. Метрики, относящиеся к данной лицензии. This field is only populated if the start and end dates are set in the ListUserListGlobalLicenseCustomerInfos call. |
UserListGlobalLicenseType
User list global license types.
| Перечисления | |
|---|---|
USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED | UNSPECIFIED. |
USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER | Reseller license. |
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE | DataMart Sell Side license. |
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE | DataMart Buy Side license. |
UserListLicenseClientAccountType
Possible product of a client account for a user list license.
| Перечисления | |
|---|---|
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN | Неизвестный. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS | Google Ads customer. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER | Display & Video 360 partner. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER | Display & Video 360 advertiser. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK | Google Ad Manager audience link. |
UserListLicenseMetrics
Показатели, относящиеся к лицензии на список пользователей.
| Поля | |
|---|---|
click_count | Только вывод. Количество кликов для получения лицензии на список пользователей. |
impression_count | Только для вывода. Количество показов для лицензии списка пользователей. |
revenue_usd_micros | Только вывод. Доход от лицензии на список пользователей в микродолларах США. |
start_date | Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If |
end_date | Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If |
UserListLicensePricing
A user list license pricing.
| Поля | |
|---|---|
pricing_id | Output only. The ID of this pricing. |
start_time | Output only. Start time of the pricing. |
end_time | Optional. End time of the pricing. |
pricing_active | Output only. Whether this pricing is active. |
buyer_approval_state | Output only. The buyer approval state of this pricing. Это поле доступно только для чтения. |
cost_micros | Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if |
currency_code | Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. |
cost_type | Immutable. The cost type of this pricing. Can be set only in the |
max_cost_micros | Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to |
UserListPricingBuyerApprovalState
User list pricing buyer approval state.
| Перечисления | |
|---|---|
USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED | UNSPECIFIED. |
PENDING | User list client has not yet accepted the pricing terms set by the user list owner. |
APPROVED | User list client has accepted the pricing terms set by the user list owner. |
REJECTED | User list client has rejected the pricing terms set by the user list owner. |
UserListPricingCostType
User list pricing cost type.
| Перечисления | |
|---|---|
USER_LIST_PRICING_COST_TYPE_UNSPECIFIED | Не указано. |
CPC | Стоимость за клик. |
CPM | Cost per mille (thousand impressions). |
MEDIA_SHARE | Media share. |
UserListLicenseStatus
Статус лицензии списка пользователей.
| Перечисления | |
|---|---|
USER_LIST_LICENSE_STATUS_UNSPECIFIED | Неизвестный. |
USER_LIST_LICENSE_STATUS_ENABLED | Статус: список пользователей все еще находится в процессе лицензирования. |
USER_LIST_LICENSE_STATUS_DISABLED | Статус: неактивен — лицензия на список пользователей больше не выдается. |
UserProperties
Advertiser-assessed information about the user at the time that the event happened. See https://support.google.com/google-ads/answer/14007601 for more details.
| Поля | |
|---|---|
customer_type | Optional. Type of the customer associated with the event. |
customer_value_bucket | Optional. The advertiser-assessed value of the customer. |
additional_user_properties[] | Optional. A bucket of any additional user properties for the user associated with this event. |
UserProperty
A bucket of any additional user properties for the user associated with this event.
| Поля | |
|---|---|
property_name | Required. The name of the user property to use. |
value | Required. The string representation of the value of the user property to use. |
WarningCount
The warning count for a given warning reason.
| Поля | |
|---|---|
record_count | The count of records that have a warning. |
reason | The warning reason. |
WarningInfo
Warning counts for each type of warning.
| Поля | |
|---|---|
warning_counts[] | A list of warnings and counts per warning reason. |