Содержание
IngestionService(интерфейс)MarketingDataInsightsService(интерфейс)PartnerLinkService(интерфейс)UserListDirectLicenseService(интерфейс)UserListGlobalLicenseService(интерфейс)UserListService(интерфейс)AdEvent(сообщение)AdEvent.EventSubtype(перечисление)AdEvent.EventType(перечисление)AdFormat(перечисление)AdIdentifiers(сообщение)AdPlacement(перечисление)AdType(перечисление)AddressInfo(сообщение)AgeRange(перечисление)AttributionHint(перечисление)AudienceMember(сообщение)AwsWrappedKeyInfo(сообщение)AwsWrappedKeyInfo.KeyType(перечисление)Baseline(сообщение)Baseline.Location(сообщение)CartData(сообщение)CompositeData(сообщение)Consent(сообщение)ConsentStatus(перечисление)ContactIdInfo(сообщение)CoordinatorKeyInfo(сообщение)CreatePartnerLinkRequest(сообщение)CreateUserListDirectLicenseRequest(сообщение)CreateUserListGlobalLicenseRequest(сообщение)CreateUserListRequest(сообщение)CustomVariable(сообщение)CustomerType(перечисление)CustomerValueBucket(перечисление)DataSourceType(перечисление)DeletePartnerLinkRequest(сообщение)DeleteUserListRequest(сообщение)Destination(сообщение)DeviceInfo(сообщение)Encoding(перечисление)EncryptedUserId(сообщение)EncryptedUserId.EncryptionEntityType(перечисление)EncryptedUserId.EncryptionSource(перечисление)EncryptionInfo(сообщение)ErrorCount(сообщение)ErrorInfo(сообщение)ErrorReason(перечисление)Event(сообщение)EventLocation(сообщение)EventParameter(сообщение)EventSource(перечисление)ExperimentalField(сообщение)FeatureSet(перечисление)FieldWarning(сообщение)GcpWrappedKeyInfo(сообщение)GcpWrappedKeyInfo.KeyType(перечисление)Gender(перечисление)GetUserListDirectLicenseRequest(сообщение)GetUserListGlobalLicenseRequest(сообщение)GetUserListRequest(сообщение)GoogleUserIdData(сообщение)IngestAdEventsRequest(сообщение)IngestAdEventsResponse(сообщение)IngestAudienceMembersRequest(сообщение)IngestAudienceMembersResponse(сообщение)IngestEventsRequest(сообщение)IngestEventsResponse(сообщение)IngestUsersRequest(сообщение)IngestUsersResponse(сообщение)IngestedUserListInfo(сообщение)IngestedUserListInfo.UploadKeyType(перечисление)IpData(сообщение)Item(сообщение)ItemCustomVariable(сообщение)ItemParameter(сообщение)ListUserListDirectLicensesRequest(сообщение)ListUserListDirectLicensesResponse(сообщение)ListUserListGlobalLicenseCustomerInfosRequest(сообщение)ListUserListGlobalLicenseCustomerInfosResponse(сообщение)ListUserListGlobalLicensesRequest(сообщение)ListUserListGlobalLicensesResponse(сообщение)ListUserListsRequest(сообщение)ListUserListsResponse(сообщение)MatchRateRange(перечисление)MediaQuartile(перечисление)MobileData(сообщение)MobileIdInfo(сообщение)MobileIdInfo.KeySpace(перечисление)PairData(сообщение)PairIdInfo(сообщение)PartnerAudienceInfo(сообщение)PartnerAudienceInfo.PartnerAudienceSource(перечисление)PartnerCustomerAccount(сообщение)PartnerLink(сообщение)PartnerLinkMetadata(сообщение)PartnerProvidedIdData(сообщение)Platform(перечисление)PlatformType(перечисление)PpidData(сообщение)ProcessingErrorReason(перечисление)ProcessingWarningReason(перечисление)Product(перечисление) (устарело)ProductAccount(сообщение)ProductAccount.AccountType(перечисление)PseudonymousIdInfo(сообщение)PseudonymousIdInfo.SyncStatus(перечисление)RemoveAllAudienceMembersRequest(сообщение)RemoveAllAudienceMembersResponse(сообщение)RemoveAudienceMembersRequest(сообщение)RemoveAudienceMembersResponse(сообщение)RemoveUsersRequest(сообщение)RemoveUsersResponse(сообщение)RequestStatusPerDestination(сообщение)RequestStatusPerDestination.DataType(перечисление)RequestStatusPerDestination.DataTypeCount(сообщение)RequestStatusPerDestination.IngestAudienceMembersStatus(сообщение)RequestStatusPerDestination.IngestCompositeDataStatus(сообщение)RequestStatusPerDestination.IngestEventsStatus(сообщение)RequestStatusPerDestination.IngestGoogleUserIdDataStatus(сообщение)RequestStatusPerDestination.IngestMobileDataStatus(сообщение)RequestStatusPerDestination.IngestPairDataStatus(сообщение)RequestStatusPerDestination.IngestPartnerProvidedIdDataStatus(сообщение)RequestStatusPerDestination.IngestPpidDataStatus(сообщение)RequestStatusPerDestination.IngestUserDataStatus(сообщение)RequestStatusPerDestination.IngestUserIdDataStatus(сообщение)RequestStatusPerDestination.RemoveAllAudienceMembersStatus(сообщение)RequestStatusPerDestination.RemoveAudienceMembersStatus(сообщение)RequestStatusPerDestination.RemoveCompositeDataStatus(сообщение)RequestStatusPerDestination.RemoveGoogleUserIdDataStatus(сообщение)RequestStatusPerDestination.RemoveMobileDataStatus(сообщение)RequestStatusPerDestination.RemovePairDataStatus(сообщение)RequestStatusPerDestination.RemovePartnerProvidedIdDataStatus(сообщение)RequestStatusPerDestination.RemovePpidDataStatus(сообщение)RequestStatusPerDestination.RemoveUserDataStatus(сообщение)RequestStatusPerDestination.RemoveUserIdDataStatus(сообщение)RequestStatusPerDestination.RequestStatus(перечисление)RetrieveInsightsRequest(сообщение)RetrieveInsightsResponse(сообщение)RetrieveInsightsResponse.MarketingDataInsight(сообщение)RetrieveInsightsResponse.MarketingDataInsight.AudienceInsightsDimension(перечисление)RetrieveInsightsResponse.MarketingDataInsight.MarketingDataInsightsAttribute(сообщение)RetrieveRequestStatusRequest(сообщение)RetrieveRequestStatusResponse(сообщение)SearchPartnerLinksRequest(сообщение)SearchPartnerLinksResponse(сообщение)SizeInfo(сообщение)TargetNetworkInfo(сообщение)TargetingType(перечисление)TermsOfService(сообщение)TermsOfServiceStatus(перечисление)UpdateUserListDirectLicenseRequest(сообщение)UpdateUserListGlobalLicenseRequest(сообщение)UpdateUserListRequest(сообщение)User(сообщение)UserData(сообщение)UserIdData(сообщение)UserIdInfo(сообщение)UserIdentifier(сообщение)UserList(сообщение)UserList.AccessReason(перечисление)UserList.AccessStatus(перечисление)UserList.ClosingReason(перечисление)UserList.MembershipStatus(перечисление)UserListDirectLicense(сообщение)UserListGlobalLicense(сообщение)UserListGlobalLicenseCustomerInfo(сообщение)UserListGlobalLicenseType(перечисление)UserListLicenseClientAccountType(перечисление)UserListLicenseMetrics(сообщение)UserListLicensePricing(сообщение)UserListLicensePricing.UserListPricingBuyerApprovalState(перечисление)UserListLicensePricing.UserListPricingCostType(перечисление)UserListLicenseStatus(перечисление)UserProperties(сообщение)UserProperty(сообщение)ViewType(перечисление)ViewabilityInfo(сообщение)WarningCount(сообщение)WarningInfo(сообщение)WarningReason(перечисление)
IngestionService
Сервис для отправки данных аудитории в поддерживаемые целевые сервисы.
| IngestAdEvents |
|---|
|
Загружает список ресурсов Эта функция доступна только для аккаунтов, добавленных в белый список.
|
| IngestAudienceMembers |
|---|
|
Загружает список ресурсов
|
| IngestEvents |
|---|
|
Загружает список из
|
| IngestUsers |
|---|
|
Загружает список пользователей в указанные целевые сервисы. В отличие от Эта функция доступна только для аккаунтов, добавленных в белый список.
|
| RemoveAllAudienceMembers |
|---|
|
Удаляет всех участников аудитории из указанных целевых сервисов.
|
| RemoveAudienceMembers |
|---|
|
Удаляет список ресурсов
|
| RemoveUsers |
|---|
|
Удаляет список пользователей из указанных целевых сервисов. Эта функция доступна только для аккаунтов, добавленных в белый список.
|
| RetrieveRequestStatus |
|---|
|
Получает статус запроса по его идентификатору.
|
MarketingDataInsightsService
Сервис, который возвращает статистику маркетинговых данных.
Эта функция доступна только партнерам по обработке данных.
| RetrieveInsights |
|---|
|
Получает статистику маркетинговых данных для заданного списка пользователей. Эта функция доступна только партнерам по обработке данных. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, которые определяют, как API авторизует доступ для запроса:
|
PartnerLinkService
Сервис для управления ссылками партнеров.
| CreatePartnerLink |
|---|
|
Создает партнерскую ссылку для указанного аккаунта. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, которые определяют, как API авторизует доступ для запроса:
|
| DeletePartnerLink |
|---|
|
Удаляет связь с партнером для указанного аккаунта. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, которые определяют, как 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 |
|---|
|
Получает список пользователей. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, которые определяют, как API авторизует доступ для запроса:
|
| ListUserLists |
|---|
|
Получает список UserLists. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, которые определяют, как API авторизует доступ для запроса:
|
| UpdateUserList |
|---|
|
Обновляет список пользователей. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, которые определяют, как API авторизует доступ для запроса:
|
AdEvent
Событие объявления.
| Поля | |
|---|---|
advertiser_id |
Обязательно. Идентификатор рекламодателя для события объявления. Он должен совпадать с идентификатором, отправленным в процессе связывания. |
event_type |
Обязательно. Тип события. |
timestamp |
Обязательно. Время, когда произошло событие. |
event_id |
Необязательное поле. Идентификатор, созданный и управляемый вызывающей стороной, который уникальным образом идентифицирует это событие. Обязательный параметр, если вы хотите дедуплицировать события объявлений, включенные в несколько запросов. В остальных случаях это поле можно не заполнять. |
user_data |
Необязательное поле. Несколько фрагментов предоставленных пользователем данных, относящихся к пользователю, с которым связано событие. Можно указать несколько экземпляров одного типа данных (например, адресов электронной почты). Чем больше данных вы предоставите, тем выше вероятность того, что мы найдем совпадение. |
device_info |
Обязательно. Информация об устройстве, которое использовалось при событии, связанном с объявлением. |
ip_address |
Необязательное поле. IP-адрес, используемый для сбора данных. Значение должно совпадать со значением |
mobile_device_id |
Необязательное поле. Идентификатор устройства, на котором было показано объявление. |
campaign_id |
Обязательно. Идентификатор связанной кампании. |
campaign_name |
Обязательно. Название связанной кампании. |
ad_group_id |
Необязательное поле. Идентификатор связанной группы объявлений. |
ad_id |
Необязательное поле. Идентификатор связанного объявления в группе. |
ad_height |
Необязательное поле. Высота объявления в пикселях. |
ad_width |
Необязательное поле. Ширина объявления в пикселях. |
region_code |
Необязательное поле. Страна и административная единица в формате ISO 3166-2. |
source |
Обязательно. Платформа, на которой размещено объявление. Аналогично источнику в Google Аналитике. |
medium |
Обязательно. Канал объявления, аналогичный каналу в Google Аналитике. |
attribution_hint |
Необязательное поле. Статус атрибуции, присвоенный партнером для этого события объявления. Это только сигнал о том, как партнер выполнил атрибуцию, и он не влияет на конечные результаты в отчетах. |
viewability_info |
Обязательно. Подробные сведения о видимости показанного объявления. |
Объединенное поле Для обработки значений, отличных от перечислений, принимается необработанная строка. Если возможно, используйте перечисление. Поле |
|
event_subtype |
Значение перечисления для подтипа события. |
event_subtype_string |
Значение подтипа события в виде строки. |
Объединенное поле Для обработки значений, отличных от перечислений, принимается необработанная строка. Если возможно, используйте перечисление. Поле |
|
ad_type |
Значение перечисления для типа объявления. |
ad_type_string |
Строковое значение типа объявления. |
Объединенное поле Для значений, не относящихся к перечислениям, принимается необработанная строка. Если возможно, используйте перечисление. Поле |
|
ad_format |
Значение перечисления для формата объявления. |
ad_format_string |
Строковое значение для формата объявления. |
Объединенное поле Для обработки значений, отличных от перечислений, принимается необработанная строка. Если возможно, используйте перечисление. Поле |
|
ad_placement |
Перечисляемое значение для места размещения объявления. |
ad_placement_string |
Строковое значение для места размещения объявления. |
Объединенное поле Для значений, не относящихся к перечислениям, принимается необработанная строка. Если возможно, используйте перечисление. Поле |
|
targeting_type |
Значение перечисления для типа таргетинга. |
targeting_type_string |
Строковое значение типа таргетинга. |
Объединенное поле Для обработки значений, отличных от перечислений, принимается необработанная строка. Если возможно, используйте перечисление. Поле |
|
platform_type |
Значение перечисления для типа платформы. |
platform_type_string |
Строковое значение для типа платформы. |
Объединенное поле Для обработки значений, отличных от перечислений, принимается необработанная строка. Если возможно, используйте перечисление. Поле |
|
platform |
Значение enum для платформы. |
platform_string |
Строковое значение для платформы. |
measurement_allowed |
Необязательное поле. Показывает, можно ли использовать строку для целей отслеживания в соответствии с действующим законодательством о конфиденциальности в регионе. |
EventSubtype
Дополнительная классификация типа события объявления.
| Перечисления | |
|---|---|
EVENT_SUBTYPE_UNSPECIFIED |
Неуказанный подтип события. |
EVENT_SUBTYPE_IMPRESSION |
Событие показа. |
EVENT_SUBTYPE_ENGAGED_VIEW |
Событие заинтересованного просмотра. |
EVENT_SUBTYPE_ONSITE_CLICK |
Событие клика на сайте. |
EVENT_SUBTYPE_OUTBOUND_CLICK |
Событие исходящего клика. |
EventType
Тип события.
| Перечисления | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
Неуказанный тип события. |
EVENT_TYPE_VIEW |
Посмотреть описание. |
EVENT_TYPE_CLICK |
Событие клика. |
AdFormat
Формат показанного объявления.
| Перечисления | |
|---|---|
AD_FORMAT_UNSPECIFIED |
Формат объявления не указан. |
AD_FORMAT_AR |
Реклама AR. |
AD_FORMAT_AUDIO |
Аудиообъявление. |
AD_FORMAT_BANNER |
Баннер. |
AD_FORMAT_BUMPER |
Объявление-заставка. |
AD_FORMAT_CAROUSEL |
Объявление-карусель. |
AD_FORMAT_COLLECTION |
Объявление с подборкой. |
AD_FORMAT_IMAGE |
Графические объявления |
AD_FORMAT_INTERACTIVE |
Интерактивное объявление. |
AD_FORMAT_INTERSTITIAL |
Межстраничное объявление. |
AD_FORMAT_IN_FEED |
Объявление в фиде. |
AD_FORMAT_IN_STREAM |
Объявление In-Stream. |
AD_FORMAT_IN_STREAM_SKIPPABLE |
Объявление In-Stream с возможностью пропуска. |
AD_FORMAT_IN_STREAM_NON_SKIPPABLE |
Объявление In-Stream без возможности пропуска. |
AD_FORMAT_NATIVE |
Нативное объявление. |
AD_FORMAT_SHORTS |
Реклама в Shorts. |
AD_FORMAT_STORY |
Объявление-рассказ. |
AD_FORMAT_SPONSORED |
Реклама. |
AD_FORMAT_VIDEO |
Видеореклама |
AdIdentifiers
Идентификаторы и другая информация, используемые для сопоставления события-конверсии с другими действиями в интернете (например, кликами по объявлениям).
| Поля | |
|---|---|
session_attributes |
Необязательное поле. Атрибуты сеанса для атрибуции и моделирования событий. |
gclid |
Необязательное поле. Идентификатор клика Google (gclid), связанный с этим событием. |
gbraid |
Необязательное поле. Идентификатор кликов, которые связаны с событиями в приложении и поступают с устройств iOS начиная с версии iOS14. |
wbraid |
Необязательное поле. Идентификатор кликов, которые связаны с событиями на сайте и поступают с устройств iOS, начиная с версии iOS14. |
landing_page_device_info |
Необязательное поле. Информация об устройстве, которое использовалось в момент перехода на сайт рекламодателя после взаимодействия с объявлением (если такое устройство было). |
mobile_device_id |
Необязательное поле. Мобильный идентификатор для рекламодателей. Это может быть идентификатор IDFA (iOS), AdID (Android) или другой идентификатор для рекламодателей, поддерживаемый платформой. |
dclid |
Необязательное поле. Идентификатор клика в медийной рекламе, связанный с этим событием. |
impression_id |
Необязательное поле. Идентификатор показа, связанный с этим событием. |
match_id |
Необязательное поле. Поле идентификатора соответствия, используемое для объединения этого события с предыдущим. |
encrypted_user_ids[] |
Необязательное поле. Любое количество зашифрованных идентификаторов пользователей. |
ppid |
Необязательное поле. Уникальный идентификатор аутентифицированного пользователя, заданный издателем. |
visitor_ppid |
Необязательное поле. Уникальный идентификатор пользователя, не выполнившего вход в аккаунт, заданный издателем. |
AdPlacement
Место размещения показанного объявления.
| Перечисления | |
|---|---|
AD_PLACEMENT_UNSPECIFIED |
Не указано место размещения объявления. |
AD_PLACEMENT_DISCOVER |
Найти место размещения. |
AD_PLACEMENT_FEED |
Место размещения в фиде. |
AD_PLACEMENT_FOOTER |
Место размещения в нижнем колонтитуле. |
AD_PLACEMENT_HEADER |
Место размещения в заголовке. |
AD_PLACEMENT_HOME |
Главная страница. |
AD_PLACEMENT_IN_CONTENT |
Места размещения в контенте. |
AD_PLACEMENT_PROMOTED |
Продвигаемое место размещения. |
AD_PLACEMENT_SEARCH |
Места размещения в поисковой сети. |
AD_PLACEMENT_STORY |
Место размещения истории. |
AdType
Тип показанного объявления.
| Перечисления | |
|---|---|
AD_TYPE_UNSPECIFIED |
Тип объявления не указан. |
AD_TYPE_DISPLAY |
Медийное объявление. |
AD_TYPE_TEXT |
Текстовое объявление. |
AD_TYPE_IMAGE |
Графические объявления |
AD_TYPE_RICH_MEDIA |
Мультимедийная реклама. |
AD_TYPE_HTML |
HTML-объявление. |
AD_TYPE_AUDIO |
Аудиообъявление. |
AD_TYPE_VIDEO |
Видеореклама |
AddressInfo
Информация об адресе пользователя.
| Поля | |
|---|---|
given_name |
Обязательно. Имя пользователя, написанное строчными буквами, без знаков препинания, пробелов в начале и конце и хешированное с помощью алгоритма SHA-256. |
family_name |
Обязательно. Фамилия пользователя, написанная строчными буквами без знаков препинания, пробелов в начале и конце и хешированная с помощью алгоритма SHA-256. |
region_code |
Обязательно. Двухбуквенный код региона в формате ISO-3166-1 alpha-2. |
postal_code |
Обязательно. Почтовый индекс адреса пользователя. |
address_line |
Необязательное поле. Улица и номер дома пользователя. Используется только в Google Аналитике. Это поле хешируется и может быть зашифровано. Нормализуйте значение перед хешированием:
|
city |
Необязательное поле. Город, указанный в адресе пользователя. Используется только в Google Аналитике. Значение должно быть нормализовано следующим образом:
|
administrative_area |
Необязательное поле. Административный район (штат или провинция) в адресе пользователя. Используется только в Google Аналитике. Значение должно быть нормализовано следующим образом:
|
Возрастная группа
Возрастные диапазоны
| Перечисления | |
|---|---|
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 лет и старше. |
AttributionHint
Статус атрибуции, присвоенный партнером для этого события объявления.
| Перечисления | |
|---|---|
ATTRIBUTION_HINT_UNSPECIFIED |
Статус атрибуции неизвестен. |
ATTRIBUTION_HINT_CONVERTED |
Статус "Преобразовано". |
ATTRIBUTION_HINT_NOT_CONVERTED |
Статус "Не конвертировано". |
AudienceMember
Участник аудитории, с которым нужно выполнить операцию.
| Поля | |
|---|---|
destination_references[] |
Необязательное поле. Определяет, на какой |
consent |
Необязательное поле. Настройка согласия для пользователя. |
Объединенное поле data. Тип идентифицирующих данных, с которыми нужно работать. data может иметь одно из следующих значений: |
|
user_data |
Данные, предоставленные пользователем, которые позволяют его идентифицировать. |
pair_data |
Идентификаторы для сверки данных издателя и рекламодателя (PAIR). Эта функция доступна только партнерам по обработке данных. |
mobile_data |
Данные, идентифицирующие мобильные устройства пользователя. |
user_id_data |
Данные, связанные с уникальными идентификаторами пользователей, заданными рекламодателем. |
ppid_data |
Данные, связанные с идентификаторами, назначаемыми издателем. Эта функция доступна только партнерам по обработке данных. |
composite_data |
Группа из нескольких типов идентификаторов. |
google_user_id_data |
зашифрованные идентификаторы пользователей Google; |
partner_provided_id_data |
Идентификаторы, предоставленные партнером. |
AwsWrappedKeyInfo
Ключ шифрования данных, обернутый ключом AWS KMS.
| Поля | |
|---|---|
key_type |
Обязательно. Тип алгоритма, используемого для шифрования данных. |
role_arn |
Обязательно. Имя ресурса Amazon роли IAM, которую нужно использовать для доступа к расшифровке KMS. Должен быть указан в формате |
kek_uri |
Обязательно. URI ключа AWS KMS, используемого для расшифровки ключа шифрования данных. Должен быть указан в формате |
encrypted_dek |
Обязательно. Зашифрованный ключ шифрования данных в кодировке Base64. |
KeyType
Тип алгоритма, используемого для шифрования данных.
| Перечисления | |
|---|---|
KEY_TYPE_UNSPECIFIED |
Не указан тип ключа. Не следует использовать. |
XCHACHA20_POLY1305 |
Алгоритм XChaCha20-Poly1305 |
Контрольное значение
Базовые критерии, с которыми сравниваются данные.
| Поля | |
|---|---|
Объединенное поле baseline. Базовое местоположение, с которым сравниваются данные. baseline может иметь одно из следующих значений: |
|
baseline_location |
Базовое местоположение запроса. Базовое местоположение – это список регионов, объединенных оператором ИЛИ. |
location_auto_detection_enabled |
Если задано значение true, сервис попытается автоматически определить базовое местоположение для получения статистики. |
Местоположение
Базовое местоположение запроса. Базовое местоположение указано в списке OR кодов регионов ISO 3166-1 alpha-2.
| Поля | |
|---|---|
region_codes[] |
Список кодов регионов по стандарту ISO 3166-1 alpha-2. |
CartData
Данные корзины, связанные с событием.
| Поля | |
|---|---|
merchant_id |
Необязательное поле. Идентификатор Merchant Center, связанный с товарами. |
merchant_feed_label |
Необязательное поле. Ярлык фида Merchant Center, связанный с фидом товаров. |
merchant_feed_language_code |
Необязательное поле. Код языка в формате ISO 639-1, связанный с фидом Merchant Center, в который загружаются данные о товарах. |
transaction_discount |
Необязательное поле. Сумма всех скидок, связанных с транзакцией. |
items[] |
Необязательное поле. Список товаров, связанных с событием. |
coupon_codes[] |
Необязательное поле. Список промокодов, примененных к корзине. Коды купонов на уровне корзины и на уровне товара не зависят друг от друга. Если событие предназначено для Google Аналитики, укажите только один код купона. Google Аналитика игнорирует дополнительные коды купонов. |
CompositeData
Составные данные, содержащие идентификаторы и связанные с ними данные пользователя. Необходимо использовать user_data или ip_data.
| Поля | |
|---|---|
user_data |
Необязательное поле. Данные, предоставленные пользователем, которые позволяют его идентифицировать. |
ip_data[] |
Необязательное поле. Данные об IP-адресах, представляющие взаимодействие с клиентами, которые использовались для создания аудитории. |
Согласие
Настройки согласия пользователя в соответствии с Законом о цифровых рынках (DMA).
| Поля | |
|---|---|
ad_user_data |
Необязательное поле. Указывает, дал ли пользователь согласие на сбор пользовательских данных. |
ad_personalization |
Необязательное поле. Указывает, дал ли пользователь согласие на персонализацию рекламы. |
ConsentStatus
Показывает, предоставил ли пользователь согласие, отказался от него или не указал свое решение.
| Перечисления | |
|---|---|
CONSENT_STATUS_UNSPECIFIED |
Не указано. |
CONSENT_GRANTED |
Предоставлено. |
CONSENT_DENIED |
Отклонено. |
ContactIdInfo
Дополнительная информация, если CONTACT_ID является одним из upload_key_types.
| Поля | |
|---|---|
match_rate_percentage |
Используется только для вывода. Коэффициент соответствия для списков электронных адресов. |
data_source_type |
Необязательное поле. Не меняется. Источник загружаемых данных |
CoordinatorKeyInfo
Информация о ключе координатора.
| Поля | |
|---|---|
key_id |
Обязательно. Идентификатор выбранного ключа координатора. |
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[] |
Необязательное поле. Строка, используемая для определения того, в какой из |
CustomerType
Тип клиента, связанного с событием.
| Перечисления | |
|---|---|
CUSTOMER_TYPE_UNSPECIFIED |
Не указан тип клиента. Не следует использовать. |
NEW |
Пользователь впервые взаимодействует с рекламой рекламодателя. |
RETURNING |
Клиент возвращается к рекламодателю. |
REENGAGED |
Клиент снова взаимодействует с рекламодателем. |
CustomerValueBucket
Ценность клиента, определенная рекламодателем.
| Перечисления | |
|---|---|
CUSTOMER_VALUE_BUCKET_UNSPECIFIED |
Не указано значение CustomerValueBucket. Не следует использовать. |
LOW |
Клиент не представляет большой ценности. |
MEDIUM |
У клиента средняя ценность. |
HIGH |
Клиент является особо ценным. |
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 |
Загруженные данные принадлежат стороннему партнеру. |
DeletePartnerLinkRequest
Запрос на удаление ресурса PartnerLink. Возвращает google.protobuf.Empty.
| Поля | |
|---|---|
name |
Обязательно. Название ресурса партнерской ссылки, которую нужно удалить. Формат: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} |
DeleteUserListRequest
Запрос на удаление списка пользователей.
| Поля | |
|---|---|
name |
Обязательно. Название списка пользователей, который нужно удалить. Формат: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} |
validate_only |
Необязательное поле. Если значение равно true, запрос проверяется, но не выполняется. |
Место назначения
Продукт Google, в который вы отправляете данные. Например, аккаунт Google Рекламы.
| Поля | |
|---|---|
reference |
Необязательное поле. Идентификатор ресурса |
login_account |
Необязательное поле. Аккаунт, использованный для вызова API. Чтобы добавлять или удалять данные из |
linked_account |
Необязательное поле. Аккаунт, к которому у |
operating_account |
Обязательно. Аккаунт, в который нужно отправить данные или из которого нужно удалить данные. |
product_destination_id |
Необязательное поле. Объект в аккаунте продукта, в который нужно загрузить данные. Например, идентификатор аудитории Google Рекламы, идентификатор аудитории Дисплея и Видео 360 или идентификатор действия-конверсии Google Рекламы. Это поле необязательно для сбора событий и данных о пользователях в Google Менеджере рекламы. Во всех остальных случаях атрибут обязателен. |
DeviceInfo
Информация об устройстве, которое использовалось (если использовалось) во время события.
| Поля | |
|---|---|
user_agent |
Необязательное поле. Строка агента пользователя устройства для определенного контекста. |
ip_address |
Необязательное поле. IP-адрес устройства в заданном контексте. Обязательно, если используется в |
category |
Необязательное поле. Категория устройства. Например, "компьютер", "планшет", "мобильное устройство", "Smart TV". |
language_code |
Необязательное поле. Язык устройства в формате ISO 639-1. |
screen_height |
Необязательное поле. Высота экрана в пикселях. |
screen_width |
Необязательное поле. Ширина экрана в пикселях. |
operating_system |
Необязательное поле. Операционная система или платформа устройства. |
operating_system_version |
Необязательное поле. Версия операционной системы или платформы. |
model |
Необязательное поле. Модель устройства. |
brand |
Необязательное поле. Бренд устройства. |
browser |
Необязательное поле. Бренд или тип браузера. |
browser_version |
Необязательное поле. Версия браузера. |
Кодировка
Тип кодировки хешированной идентифицирующей информации.
| Перечисления | |
|---|---|
ENCODING_UNSPECIFIED |
Не указан тип кодировки. Не следует использовать. |
HEX |
Шестнадцатеричное кодирование. |
BASE64 |
Кодировка Base64. |
EncryptedUserId
Идентификатор пользователя, выданный для атрибуции. Если вы используете этот параметр, необходимо заполнить все поля.
| Поля | |
|---|---|
encrypted_id |
Обязательно. Зашифрованный буквенно-цифровой идентификатор. |
entity_type |
Обязательно. Тип объекта шифрования. Она должна совпадать с конфигурацией шифрования для показа объявлений или передачи данных. |
entity_id |
Обязательно. Идентификатор объекта шифрования. Она должна совпадать с конфигурацией шифрования для показа объявлений или передачи данных. |
source |
Обязательно. Показывает, был ли зашифрованный файл cookie получен от показа объявлений (макрос %m) или от передачи данных. |
EncryptionEntityType
Тип объекта шифрования.
| Перечисления | |
|---|---|
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED |
Неопределенный тип объекта шифрования. |
CAMPAIGN_MANAGER_ACCOUNT |
аккаунт Менеджера кампаний 360; |
CAMPAIGN_MANAGER_ADVERTISER |
рекламодателем в Менеджере кампаний 360. |
DISPLAY_VIDEO_PARTNER |
Партнер в Дисплее и Видео 360. |
DISPLAY_VIDEO_ADVERTISER |
Рекламодатель в Дисплее и Видео 360. |
GOOGLE_ADS_CUSTOMER |
Клиент Google Рекламы. |
GOOGLE_AD_MANAGER_NETWORK_CODE |
Код сети Google Менеджера рекламы. |
EncryptionSource
Источник шифрования.
| Перечисления | |
|---|---|
ENCRYPTION_SOURCE_UNSPECIFIED |
Источник шифрования не указан. |
AD_SERVING |
Источник шифрования для показа объявлений. |
DATA_TRANSFER |
Источник шифрования при передаче данных. |
EncryptionInfo
Информация о шифровании для добавляемых данных.
| Поля | |
|---|---|
Объединенное поле wrapped_key. Зашифрованный ключ, используемый для шифрования данных. Поле wrapped_key может иметь одно из следующих значений: |
|
gcp_wrapped_key_info |
Информация о ключе, обернутом в Google Cloud Platform. |
aws_wrapped_key_info |
Информация о зашифрованном ключе Amazon Web Services. |
coordinator_key_info |
Ключевая информация для выбранного ключа координатора. Это не поддерживается для методов |
ErrorCount
Количество ошибок с определенной причиной.
| Поля | |
|---|---|
record_count |
Количество записей, которые не удалось загрузить по определенной причине. |
reason |
Причина ошибки для записей, которые не удалось обработать. |
ErrorInfo
Количество ошибок каждого типа.
| Поля | |
|---|---|
error_counts[] |
Список ошибок и их количество. Может быть не заполнен. |
ErrorReason
Причины ошибок Data Manager API. ПРИМЕЧАНИЕ. Этот перечислитель не является неизменным, и в будущем в него могут быть добавлены новые значения.
| Перечисления | |
|---|---|
ERROR_REASON_UNSPECIFIED |
Не используйте это значение по умолчанию. |
INTERNAL_ERROR |
Произошла внутренняя ошибка. |
DEADLINE_EXCEEDED |
Ответ на запрос был получен слишком поздно. |
RESOURCE_EXHAUSTED |
Слишком много запросов. |
NOT_FOUND |
Ресурс не найден. |
PERMISSION_DENIED |
У пользователя нет разрешения или ресурс не найден. |
INVALID_ARGUMENT |
Возникла проблема с запросом. |
REQUIRED_FIELD_MISSING |
Не заполнено обязательное поле. |
INVALID_FORMAT |
Неверный формат. |
INVALID_HEX_ENCODING |
Значение, закодированное по алгоритму HEX, имеет неправильный формат. |
INVALID_BASE64_ENCODING |
Значение, закодированное по алгоритму Base64, имеет неправильный формат. |
INVALID_SHA256_FORMAT |
Значение, закодированное по алгоритму SHA256, имеет неправильный формат. |
INVALID_POSTAL_CODE |
Неверно указан почтовый индекс. |
INVALID_COUNTRY_CODE |
Устарело: перечисление не используется в Data Manager API. |
INVALID_ENUM_VALUE |
Значение enum нельзя использовать. |
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 |
Данные о событиях не содержат идентификаторов пользователей или объявлений. При сборе данных о событиях Floodlight эта ошибка означает, что в запросах нет идентификаторов объявлений. |
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 |
У события было два или более целевых сервисов Google Аналитики. |
FIELD_VALUE_TOO_LONG |
Слишком длинное значение поля. |
FIELD_VALUE_TOO_SHORT |
Слишком короткое значение поля. |
TOO_MANY_ELEMENTS |
В запросе слишком много элементов в списке. |
TOO_FEW_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 |
Атрибут "максимальная стоимость" [max_cost] можно использовать только со значением "доля медиарасходов" [MEDIA_SHARE] атрибута "тип стоимости" [cost_type]. |
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_PARTY_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 |
Типы аккаунтов не поддерживаются для связи с партнером. |
MEMBERSHIP_DURATION_TOO_LONG |
Срок хранения данных о пользователе в списке слишком длинный. |
INVALID_MERCHANT_ID |
Поле merchant_id недействительно. |
EU_POLITICAL_ADVERTISING_DECLARATION_REQUIRED |
В аккаунте клиента есть кампании, не относящиеся к исключениям, без заявления о политической рекламе для ЕС. |
ACCOUNT_INELIGIBLE_FOR_STORE_SALES |
Отслеживание продаж в магазине недоступно для этого аккаунта. |
INVALID_MERCHANT_FEED_LANGUAGE_CODE |
Недопустимый код языка фида продавца. |
INVALID_REGION_CODE |
Недействительный код региона. |
INVALID_SUBDIVISION_CODE |
Недействительный код региона. |
INVALID_SUBCONTINENT_CODE |
Недействительный код субконтинента. |
INVALID_CONTINENT_CODE |
Недействительный код континента. |
INVALID_DEVICE_CATEGORY |
Недопустимая категория устройства. |
BOTH_CLIENT_ID_AND_APP_INSTANCE_ID_NOT_ALLOWED |
Заданы оба параметра: app_instance_id и client_id. |
GOOGLE_ANALYTICS_SUBPROPERTY_OR_ROLLUP_PROPERTY_NOT_ALLOWED |
Ресурс Google Аналитики является дочерним или агрегированным. |
THIRD_PARTY_USER_DATA_NOT_ALLOWED |
Сторонние пользовательские данные могут задавать только партнеры по обработке данных. |
INVALID_COUPON_CODE |
Недействительный код купона. |
EVENT_SOURCE_AND_DESTINATION_MISMATCH |
Тип источника события не соответствует типу целевого объекта. |
DESTINATION_ACCOUNT_TYPE_MISMATCH |
Тип целевого аккаунта не соответствует указанному идентификатору. |
CUSTOM_VARIABLE_VALUE_CONTAINS_PII |
Значение пользовательской переменной содержит информацию, позволяющую идентифицировать личность. |
CUSTOM_VARIABLE_NOT_ENABLED |
Пользовательская переменная не включена. |
INVALID_CUSTOM_VARIABLE_VALUE |
Недопустимое значение пользовательской переменной. |
CUSTOM_VARIABLE_NOT_FOUND |
У целевого объекта нет пользовательской переменной с именем, соответствующим указанному значению variable. |
TOO_MANY_USERS |
Максимальное количество пользователей в запросе – 10 000. |
BASELINE_LOCATION_AUTO_DETECTION_FAILED |
Поле location_auto_detection_enabled запроса было установлено на значение true, но автоматическое определение базового местоположения не удалось. |
INSIGHTS_MISSING_FOR_DIMENSION |
Для этого параметра нет статистики. |
REQUIRED_PREREQUISITE_LINK_MISSING |
Устарело: ошибка не используется в Data Manager API. |
INVALID_REMOVE_AS_OF_TIME |
Время удаления должно относиться к прошлому или настоящему. При удалении участников целевой аудитории нельзя указывать временные метки из будущего. |
REQUEST_TOO_OLD |
Статус запроса доступен только в течение примерно 50 дней после того, как API получил запрос. |
CONVERSION_ACTION_TOO_RECENTLY_CREATED |
С момента создания действия-конверсии прошло недостаточно времени. |
INVALID_AD_IDENTIFIER_FOR_ACCOUNT |
Идентификатор объявления не принадлежит аккаунту. Например, |
UNSUPPORTED_ACCOUNT_TYPE_FOR_USER_LIST_DIRECT_LICENSE |
Тип аккаунта не поддерживается для client_account_type в UserListDirectLicense. |
Событие
Событие, представляющее собой взаимодействие пользователя с сайтом или приложением рекламодателя.
| Поля | |
|---|---|
destination_references[] |
Необязательное поле. Строка, используемая для определения пункта назначения. Если оставить это поле пустым, событие будет отправлено всем |
transaction_id |
Необязательное поле. Уникальный идентификатор события. Обязательный параметр для событий, отправляемых в качестве дополнительного источника данных для конверсий тега. |
event_timestamp |
Обязательно. Время, когда произошло событие. |
last_updated_timestamp |
Необязательное поле. Дата последнего обновления мероприятия. |
user_data |
Необязательное поле. Фрагменты данных, предоставленных пользователем, которые представляют пользователя, связанного с событием. |
consent |
Необязательное поле. Информация о том, дал ли связанный пользователь согласие на разные типы обработки данных. |
ad_identifiers |
Необязательное поле. Идентификаторы и другая информация, используемые для сопоставления события-конверсии с другими действиями в интернете (например, кликами по объявлениям). |
currency |
Необязательное поле. Код валюты, связанный со всеми денежными значениями в этом событии. |
event_source |
Необязательное поле. Сигнал о том, где произошло событие (на сайте, в приложении, в магазине и т. д.). |
event_device_info |
Необязательное поле. Информация об устройстве, которое использовалось во время события (если применимо). |
cart_data |
Необязательное поле. Информация о транзакции и товарах, связанных с событием. |
custom_variables[] |
Необязательное поле. Дополнительная информация о парах "ключ-значение", которую нужно передать в контейнеры конверсий (действие-конверсию или действие Floodlight). |
experimental_fields[] |
Необязательное поле. Список пар "ключ-значение" для экспериментальных полей, которые могут быть добавлены в API. |
user_properties |
Необязательное поле. Информация о пользователе, полученная рекламодателем в момент события. |
event_name |
Необязательное поле. Название события. Обязательный атрибут для событий GA4. |
client_id |
Необязательное поле. Уникальный идентификатор пользовательского экземпляра веб-клиента для этого веб-потока GA4. |
user_id |
Необязательное поле. Уникальный идентификатор пользователя, заданный рекламодателем. |
additional_event_parameters[] |
Необязательное поле. Контейнер любых параметров событий, которые нужно включить в событие, но которые ещё не были указаны с помощью других структурированных полей. |
third_party_user_data |
Необязательное поле. Данные того же типа, что и в user_data, но с явным указанием, что они принадлежат третьей стороне, а не рекламодателю. |
event_location |
Необязательное поле. Информация о местоположении пользователя, когда произошло событие. |
app_instance_id |
Необязательное поле. Уникальный идентификатор пользовательского экземпляра клиента приложения для этого потока приложения GA4. |
conversion_value |
Необязательное поле. Ценность конверсии, связанная с событием, для конверсий на основе ценности. |
conversion_count |
Необязательное поле. Количество конверсий, связанных с событием, для конверсий на основе подсчета. |
EventLocation
Место, где произошло событие.
| Поля | |
|---|---|
store_id |
Необязательное поле. Обязательно для отслеживания продаж в магазине. Идентификатор обычного магазина, в котором произошло событие. |
city |
Необязательное поле. Название города, в котором произошло событие. |
subdivision_code |
Необязательное поле. Код административной единицы в соответствии со стандартом ISO 3166-2, где произошло событие. |
region_code |
Необязательное поле. Двухбуквенный код региона в формате CLDR, указанный в адресе пользователя. |
subcontinent_code |
Необязательное поле. Код субконтинента, на котором произошло событие, в формате UN M49. |
continent_code |
Необязательное поле. Код континента, на котором произошло событие, в формате UN M49. |
EventParameter
Параметр события для событий GA4.
| Поля | |
|---|---|
parameter_name |
Обязательно. Название параметра, который нужно использовать. |
value |
Обязательно. Строковое представление значения параметра, которое нужно задать. |
EventSource
Источник события.
| Перечисления | |
|---|---|
EVENT_SOURCE_UNSPECIFIED |
Неуказанный источник событий. Не следует использовать. |
WEB |
Событие было создано в веб-браузере. |
APP |
Событие создано приложением. |
IN_STORE |
Событие было создано на основе транзакции в магазине. |
PHONE |
Событие было создано на основе телефонного звонка. |
MESSAGE |
Событие создано на основе письма. |
OTHER |
Событие было сгенерировано из других источников. |
ExperimentalField
Экспериментальное поле, представляющее неофициальные поля.
| Поля | |
|---|---|
field |
Необязательное поле. Название поля, которое нужно использовать. |
value |
Необязательное поле. Значение, которое нужно задать для поля. |
FeatureSet
Набор поддерживаемых функций для ссылки на партнера.
| Перечисления | |
|---|---|
FEATURE_SET_UNSPECIFIED |
Неуказанный набор функций. Если оно не задано, используется значение по умолчанию – FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT. |
FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT |
Указывает на ссылку, используемую для управления аудиториями и событиями. |
FEATURE_SET_AD_EVENT_MANAGEMENT |
Указывает на ссылку, используемую для управления событиями объявлений. |
FieldWarning
Подробное предупреждение на уровне строки с указанием путей к полям.
| Поля | |
|---|---|
reason |
Причина предупреждения. |
description |
Подробное сообщение с описанием проблемы. |
field |
Путь к полю, которое вызвало предупреждение. Используется тот же формат, что и для |
GcpWrappedKeyInfo
Информация о ключе, зашифрованном в Google Cloud Platform.
| Поля | |
|---|---|
key_type |
Обязательно. Тип алгоритма, используемого для шифрования данных. |
wip_provider |
Обязательно. Поставщик пула Workload Identity, необходимый для использования ключа шифрования ключа. |
kek_uri |
Обязательно. Идентификатор ресурса Cloud Key Management Service в 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} |
GoogleUserIdData
Данные идентификатора пользователя Google, содержащие зашифрованные идентификаторы пользователей Google. Требуется указать хотя бы один идентификатор пользователя Google.
| Поля | |
|---|---|
google_user_ids[] |
Обязательно. Список зашифрованных идентификаторов пользователей Google. |
IngestAdEventsRequest
Запрос на загрузку событий, связанных с объявлениями.
| Поля | |
|---|---|
ad_events[] |
Обязательно. Обязательный параметр (не менее одного). Список событий, связанных с объявлениями. |
encryption_info |
Необязательное поле. Информация о ключах шифрования, которые используются для шифрования данных. Это поле обязательно нужно заполнить, если в событиях объявлений есть |
validate_only |
Необязательное поле. Если значение равно true, запрос проверяется, но не выполняется. |
IngestAdEventsResponse
У этого типа нет полей.
Ответ на операцию приема событий объявлений.
IngestAudienceMembersRequest
Запрос на загрузку участников аудитории в указанные целевые сервисы. Возвращает IngestAudienceMembersResponse.
| Поля | |
|---|---|
destinations[] |
Обязательно. Список целевых страниц, на которые будут перенаправляться участники аудитории. |
audience_members[] |
Обязательно. Список пользователей, которых нужно перенаправить на указанные целевые страницы. В одном запросе можно отправить не более 10 000 ресурсов |
consent |
Необязательное поле. Согласие на уровне запроса, которое применяется ко всем пользователям в запросе. Согласие на уровне пользователя переопределяет согласие на уровне запроса и может быть указано в каждом |
validate_only |
Необязательное поле. Для тестирования. Если указано значение |
encoding |
Необязательное поле. Оно необходимо для загрузки файла |
encryption_info |
Необязательное поле. Информация о шифровании загрузок для домена |
terms_of_service |
Необязательное поле. Условия использования, которые пользователь принял или отклонил. |
IngestAudienceMembersResponse
Ответ от IngestAudienceMembersRequest.
| Поля | |
|---|---|
request_id |
Автоматически созданный идентификатор запроса. |
field_warnings[] |
Подробные предупреждения на уровне строк с указанием путей к полям. |
IngestEventsRequest
Запрос на загрузку участников аудитории в указанные целевые сервисы. Возвращает IngestEventsResponse.
| Поля | |
|---|---|
destinations[] |
Обязательно. Список целевых страниц, на которые нужно отправлять события. |
events[] |
Обязательно. Список событий, которые нужно отправить в указанные целевые сервисы. В одном запросе можно отправить не более 2000 ресурсов |
consent |
Необязательное поле. Согласие на уровне запроса, которое применяется ко всем пользователям в запросе. Согласие на уровне пользователя переопределяет согласие на уровне запроса и может быть указано в каждом |
validate_only |
Необязательное поле. Для тестирования. Если указано значение |
encoding |
Необязательное поле. Оно необходимо для загрузки файла |
encryption_info |
Необязательное поле. Информация о шифровании загрузок для домена |
IngestEventsResponse
Ответ от IngestEventsRequest.
| Поля | |
|---|---|
request_id |
Автоматически созданный идентификатор запроса. |
field_warnings[] |
Подробные предупреждения на уровне строк с указанием путей к полям. |
IngestUsersRequest
Запрос на загрузку пользователей в указанные целевые сервисы.
| Поля | |
|---|---|
destinations[] |
Обязательно. Список возможных целевых страниц для загрузки. |
users[] |
Обязательно. Список пользователей для загрузки. |
encryption_info |
Необязательное поле. Информация о ключах шифрования, которые используются для шифрования данных. |
validate_only |
Необязательное поле. Если указано значение |
encoding |
Обязательно. Тип кодировки идентификаторов пользователей. Для зашифрованных идентификаторов пользователей это относится только к внешнему кодированию. |
IngestUsersResponse
Ответ на запрос IngestUsersRequest.
| Поля | |
|---|---|
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 |
Идентификаторы платформы управления данными:
|
IpData
Информация об IP-адресе пользователя. Чтобы повысить коэффициент соответствия списков электронных адресов, рекомендуем добавить параметры observe_start_time и observe_end_time.
| Поля | |
|---|---|
ip_address |
Обязательно. IP-адрес, зафиксированный во время взаимодействия с клиентом. Поддерживаются стандартные строковые форматы для IPv4 и IPv6. |
observe_start_time |
Необязательное поле. Время первого зарегистрированного взаимодействия с этого IP-адреса в сеансе. |
observe_end_time |
Необязательное поле. Время последнего зарегистрированного взаимодействия с этого IP-адреса в сеансе. |
Показатель
Представляет товар в корзине, связанный с событием.
| Поля | |
|---|---|
merchant_product_id |
Необязательное поле. Идентификатор товара в аккаунте Merchant Center. |
quantity |
Необязательное поле. Количество товаров, связанных с событием. |
unit_price |
Необязательное поле. Цена товара без учета налогов, стоимости доставки и скидок, которые применяются к транзакции. |
item_id |
Необязательное поле. Уникальный идентификатор объекта. |
additional_item_parameters[] |
Необязательное поле. Контейнер любых параметров события, связанных с товаром, которые нужно включить в событие, но которые ещё не были указаны с помощью других структурированных полей. |
merchant_id |
Необязательное поле. Идентификатор Merchant Center, связанный с товаром. Для событий "Продажи в магазине" это значение переопределяет значение, заданное на уровне корзины. Для других событий это поле игнорируется. |
merchant_feed_label |
Необязательное поле. Ярлык фида Merchant Center. Если страны по-прежнему используются, вместо них можно использовать двухбуквенный код страны в формате ISO-3166-1 alpha-2. Для событий "Продажи в магазине" это значение переопределяет значение, заданное на уровне корзины. Для других событий это поле игнорируется. |
merchant_feed_language_code |
Необязательное поле. Код языка по стандарту ISO 639-1, связанный с фидом Merchant Center, в который загружаются сведения о товарах. |
custom_variables[] |
Необязательное поле. Дополнительная информация в виде пар "ключ-значение", которая отправляется в контейнеры конверсий (действия-конверсии или действия Floodlight) при отслеживании конверсий на уровне товаров. |
conversion_value |
Необязательное поле. Ценность конверсии, связанная с этим товаром в рамках события, если ценность конверсии для каждого товара отличается. |
ItemCustomVariable
Пользовательская переменная на уровне объекта для конверсий в объявлениях.
| Поля | |
|---|---|
variable |
Необязательное поле. Название пользовательской переменной, которую нужно задать. Если переменная не будет найдена для указанного пункта назначения, она будет проигнорирована. |
value |
Необязательное поле. Значение, которое нужно сохранить для пользовательской переменной. |
destination_references[] |
Необязательное поле. Строка, используемая для определения того, в какой из |
ItemParameter
Контейнер любых параметров события, связанных с товаром, которые нужно включить в событие, но которые ещё не были указаны с помощью других структурированных полей.
| Поля | |
|---|---|
parameter_name |
Обязательно. Название параметра, который нужно использовать. |
value |
Обязательно. Строковое представление значения параметра, которое нужно задать. |
ListUserListDirectLicensesRequest
Запрос на получение списка всех ресурсов UserListDirectLicense для определенного аккаунта.
| Поля | |
|---|---|
parent |
Обязательно. Аккаунт, лицензии которого запрашиваются. Должен иметь формат accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}. |
filter |
Необязательное поле. Строка фильтра, которую нужно применить к запросу списка. Все поля должны быть указаны слева от каждого условия (например, Поддерживаемые операции
Поддерживаемые функции: Неподдерживаемые поля
|
page_size |
Необязательное поле. Максимальное количество лицензий, возвращаемых на странице. Сервис может вернуть меньше результатов. Если значение не указано, будет возвращено не более 50 лицензий. Максимальное значение – 1000. Если указать большее число, оно будет приведено к 1000. |
page_token |
Необязательное поле. Токен страницы, полученный из предыдущего вызова При разбиении на страницы все остальные параметры, переданные в |
ListUserListDirectLicensesResponse
Ответ от ListUserListDirectLicensesRequest.
| Поля | |
|---|---|
user_list_direct_licenses[] |
Лицензии для указанного в запросе списка пользователей. |
next_page_token |
Токен, который можно отправить как |
ListUserListGlobalLicenseCustomerInfosRequest
Запрос на получение списка всех ресурсов UserListGlobalLicenseCustomerInfo для определенного списка пользователей с глобальной лицензией.
| Поля | |
|---|---|
parent |
Обязательно. Глобальная лицензия, информация о клиенте которой запрашивается. Должен быть указан в формате |
filter |
Необязательное поле. Строка фильтра, которую нужно применить к запросу списка. Все поля должны быть указаны слева от каждого условия (например, Поддерживаемые операции
Поддерживаемые функции: Неподдерживаемые поля
|
page_size |
Необязательное поле. Максимальное количество лицензий, которые нужно вернуть. Сервис может вернуть меньше результатов. Если значение не указано, будет возвращено не более 50 лицензий. Максимальное значение – 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 |
Необязательное поле. Строка фильтра, которую нужно применить к запросу списка. Все поля должны быть указаны слева от каждого условия (например, Поддерживаемые операции
Поддерживаемые функции: Неподдерживаемые поля
|
page_size |
Необязательное поле. Максимальное количество лицензий, которые нужно вернуть. Сервис может вернуть меньше результатов. Если значение не указано, будет возвращено не более 50 лицензий. Максимальное значение – 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. |
page_token |
Необязательное поле. Токен страницы, полученный из предыдущего вызова При разбиении на страницы все остальные параметры, переданные в |
filter |
Необязательное поле. Строка фильтра. Все поля должны быть указаны слева от каждого условия (например, Поддерживаемые операции:
Поддерживаемые функции: Поддерживаемые поля:
|
ListUserListsResponse
Сообщение с ответом для ListUserLists.
| Поля | |
|---|---|
user_lists[] |
Списки пользователей из указанного аккаунта. |
next_page_token |
Токен, который можно отправить как |
MatchRateRange
Диапазон коэффициента соответствия для загруженного списка или списка пользователей.
| Перечисления | |
|---|---|
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 % (интервал |
MediaQuartile
Доля воспроизведенного медиаконтента в виде отдельных квартилей.
| Перечисления | |
|---|---|
MEDIA_QUARTILE_UNSPECIFIED |
Не указан квартиль медиаконтента. |
MEDIA_QUARTILE_START |
Кнопка "Начать". |
MEDIA_QUARTILE_FIRST_QUARTILE |
Первый квартиль. |
MEDIA_QUARTILE_MIDPOINT |
Средняя точка. |
MEDIA_QUARTILE_THIRD_QUARTILE |
Третий квартиль. |
MEDIA_QUARTILE_COMPLETE |
Завершено. |
MobileData
Мобильные идентификаторы для аудитории. Требуется хотя бы один идентификатор мобильного устройства.
| Поля | |
|---|---|
mobile_ids[] |
Обязательно. Список идентификаторов мобильных устройств (рекламный идентификатор Android, IDFA для iOS для списков электронных адресов и рекламный идентификатор Android, IDFA для iOS, идентификатор Xbox или Microsoft, идентификатор Amazon Fire TV, идентификатор Roku, общий идентификатор устройства для базовых списков пользователей). В одном файле |
MobileIdInfo
Дополнительная информация, если MOBILE_ID является одним из upload_key_types.
| Поля | |
|---|---|
data_source_type |
Необязательное поле. Не меняется. Источник загруженных данных. |
key_space |
Обязательно. Не меняется. Ключевое пространство идентификаторов мобильных устройств. |
app_id |
Обязательно. Не меняется. Строка, которая уникальным образом идентифицирует мобильное приложение, из которого были собраны данные. |
KeySpace
Пространство ключей для идентификатора мобильного устройства.
| Перечисления | |
|---|---|
KEY_SPACE_UNSPECIFIED |
Не указано. |
IOS |
Пространство ключей iOS. |
ANDROID |
Пространство ключей Android. |
PairData
Идентификаторы PAIR для аудитории. Требуется указать хотя бы один идентификатор PAIR.
Эта функция доступна только партнерам по обработке данных.
| Поля | |
|---|---|
pair_ids[] |
Обязательно. Данные, позволяющие идентифицировать личность, предоставленные чистым помещением, хешированные по алгоритму SHA256 и зашифрованные с помощью коммутативного шифра на основе эллиптических кривых с использованием ключа издателя для списка пользователей PAIR. В одном файле |
PairIdInfo
Дополнительная информация, если PAIR_ID является одним из upload_key_types.
Эта функция доступна только партнерам по обработке данных.
| Поля | |
|---|---|
publisher_id |
Обязательно. Не меняется. Идентификатор издателя, с которым сопоставляется список пользователей для сверки данных издателя и рекламодателя. Это поле предоставляется поставщиком системы PAIR и является уникальным только в рамках этой системы. Его нельзя использовать в качестве глобального идентификатора в нескольких чистых комнатах. |
publisher_name |
Обязательно. Понятное название издателя, которое будет показываться в интерфейсе для более удобной настройки таргетинга. |
match_rate_percentage |
Обязательно. Это поле содержит процент соответствия списка пользователей собственным данным издателя. Значение должно быть в диапазоне от 0 до 100 включительно. |
advertiser_identifier_count |
Необязательное поле. Количество записей собственных данных рекламодателя, загруженных поставщику чистого помещения. Это не означает размер списка пользователей PAIR. |
clean_room_identifier |
Обязательно. Не меняется. Определяет уникальную связь между рекламодателем и издателем с одним или несколькими поставщиками чистого помещения. |
PartnerAudienceInfo
Дополнительная информация об аудиториях партнеров
Эта функция доступна только партнерам по обработке данных.
| Поля | |
|---|---|
partner_audience_source |
Обязательно. Не меняется. Источник аудитории партнера. |
commerce_partner |
Необязательное поле. Название торгового партнера. Разрешено, только если |
PartnerAudienceSource
Источник аудитории партнера.
| Перечисления | |
|---|---|
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED |
Не указано. |
COMMERCE_AUDIENCE |
Источник аудитории партнера – торговая аудитория. |
LINEAR_TV_AUDIENCE |
Источник аудитории партнера – аудитория линейного ТВ. |
AGENCY_PROVIDER_AUDIENCE |
Источник аудитории партнера – аудитория агентства или поставщика. |
PartnerCustomerAccount
Представляет аккаунт клиента в системе партнера.
| Поля | |
|---|---|
account_id |
Обязательно. Идентификатор клиентского аккаунта в пространстве идентификаторов партнера. |
account_name |
Необязательное поле. Название аккаунта. |
account_type |
Необязательное поле. Тип аккаунта. Может использоваться, например, для различения аккаунтов рекламодателей и аккаунтов на уровне компании. |
PartnerLink
Связь между аккаунтом-владельцем и аккаунтом партнера.
| Поля | |
|---|---|
name |
Идентификатор. Название партнерской ссылки. Формат: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} |
partner_link_id |
Используется только для вывода. Идентификатор связи с партнером. |
owning_account |
Обязательно. Аккаунт-владелец, предоставляющий доступ к партнерскому аккаунту. |
partner_account |
Обязательно. Партнерский аккаунт, которому владелец предоставил доступ. |
feature_set |
Необязательное поле. Не меняется. Набор функций, поддерживаемых для ссылки партнера. Если этот параметр не задан, по умолчанию используется значение |
partner_customer_account |
Необязательное поле. Аккаунт клиента в системе партнера. Это необходимо для партнерских ссылок с набором функций |
partner_link_metadata |
Необязательное поле. Метаданные, связанные со ссылкой на партнера. Это необязательный параметр, который можно добавить только в партнерские ссылки с |
PartnerLinkMetadata
Представляет метаданные, связанные со ссылкой на партнера.
| Поля | |
|---|---|
implicit_accounts[] |
Необязательное поле. Список неявных аккаунтов. |
PartnerProvidedIdData
Данные, предоставленные партнером и содержащие идентификаторы, предоставленные партнером. Требуется хотя бы один идентификатор, предоставленный партнером.
| Поля | |
|---|---|
partner_provided_ids[] |
Обязательно. Список идентификаторов, предоставленных партнером. |
Платформа
Дополнительная информация о платформе, на которой было показано объявление.
| Перечисления | |
|---|---|
PLATFORM_UNSPECIFIED |
Платформа не указана. |
PLATFORM_IOS |
платформы iOS. |
PLATFORM_ANDROID |
платформы Android. |
PLATFORM_WEB |
Веб-платформа. |
PlatformType
Тип платформы, на которой было показано объявление.
| Перечисления | |
|---|---|
PLATFORM_TYPE_UNSPECIFIED |
Тип платформы не указан. |
PLATFORM_TYPE_MOBILE |
Мобильная платформа. |
PLATFORM_TYPE_DESKTOP |
Платформа компьютера. |
PLATFORM_TYPE_CTV |
платформы подключенных телевизоров; |
PLATFORM_TYPE_PHONE |
Платформа телефона. |
PLATFORM_TYPE_TABLET |
Платформа планшета. |
PpidData
Данные об идентификаторах, назначаемых издателем, содержащие PPID. Требуется хотя бы один идентификатор PPID.
Эта функция доступна только партнерам по обработке данных.
| Поля | |
|---|---|
ppids[] |
Обязательно. Список идентификаторов, предоставленных издателем для пользователя. |
ProcessingErrorReason
Причина ошибки обработки. В будущем могут быть добавлены новые причины.
| Перечисления | |
|---|---|
PROCESSING_ERROR_REASON_UNSPECIFIED |
Причина ошибки обработки неизвестна. |
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE |
Недопустимая пользовательская переменная. |
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED |
Статус пользовательской переменной не включен. |
PROCESSING_ERROR_REASON_EVENT_TOO_OLD |
Давность конверсии превышает максимально допустимую. |
PROCESSING_ERROR_REASON_DENIED_CONSENT |
Пользовательские данные для рекламы отклонены пользователем или в настройках рекламодателя по умолчанию. |
PROCESSING_ERROR_REASON_NO_CONSENT |
Рекламодатель не предоставил стороннему поставщику согласия на использование основных сервисов платформы Google Рекламы. |
PROCESSING_ERROR_REASON_UNKNOWN_CONSENT |
Не удалось определить общее согласие для этого пользователя (на основе согласия на уровне строки, согласия на уровне запроса и настроек аккаунта). |
PROCESSING_ERROR_REASON_DUPLICATE_GCLID |
В системе уже есть конверсия с тем же GCLID и временем конверсии. |
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID |
Конверсия с таким идентификатором заказа и действием-конверсией уже была загружена. |
PROCESSING_ERROR_REASON_INVALID_GBRAID |
Не удалось декодировать параметр gbraid. |
PROCESSING_ERROR_REASON_INVALID_GCLID |
Не удалось декодировать идентификатор клика Google. |
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID |
Идентификатор продавца содержит нецифровые символы. |
PROCESSING_ERROR_REASON_INVALID_WBRAID |
Не удалось декодировать параметр wbraid. |
PROCESSING_ERROR_REASON_INTERNAL_ERROR |
Внутренняя ошибка. |
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED |
В целевом аккаунте не приняты условия использования расширенного отслеживания конверсий. |
PROCESSING_ERROR_REASON_INVALID_EVENT |
Недействительное событие. |
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS |
Количество сопоставленных транзакций ниже минимального порога. |
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS |
Сумма транзакций меньше минимального порога. |
PROCESSING_ERROR_REASON_INVALID_FORMAT |
Ошибка формата мероприятия. |
PROCESSING_ERROR_REASON_DECRYPTION_ERROR |
При расшифровке мероприятия произошла ошибка. |
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR |
Не удалось расшифровать ключ шифрования данных (DEK). |
PROCESSING_ERROR_REASON_INVALID_WIP |
WIP отформатирован неправильно или не существует. |
PROCESSING_ERROR_REASON_INVALID_KEK |
Ключ шифрования ключа не может расшифровать данные, поскольку он неверный или не существует. |
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED |
Не удалось использовать WIP, так как он был отклонен из-за условия аттестации. |
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED |
У системы не было разрешений, необходимых для доступа к ключу шифрования ключей. |
PROCESSING_ERROR_REASON_AWS_AUTH_FAILED |
Системе не удалось пройти аутентификацию в AWS. |
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR |
Не удалось расшифровать данные UserIdentifier с помощью ключа шифрования данных. |
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER |
Пользователь попытался загрузить события с идентификатором рекламы, который не относится к объявлениям операционного аккаунта. |
PROCESSING_ERROR_REASON_ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID |
Действия-конверсии с подсчетом "одна на клик" нельзя использовать с параметрами braid. |
PROCESSING_ERROR_REASON_MATCH_ID_NOT_FOUND |
Не удалось найти идентификатор матча. |
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_MATCH_ID |
Не удалось найти идентификатор пользователя по идентификатору соответствия. |
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_GCLID |
Не удалось найти идентификатор пользователя для GCLID. |
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_DCLID |
Идентификатор пользователя не найден для DCLID. |
PROCESSING_ERROR_REASON_INVALID_AD_IDENTIFIERS |
Недопустимые идентификаторы объявлений. |
PROCESSING_ERROR_REASON_INVALID_MOBILE_ID_FORMAT |
Недопустимый формат идентификатора мобильного устройства. |
PROCESSING_ERROR_REASON_ORIGINAL_CONVERSIONS_NOT_FOUND |
Не удалось найти исходные конверсии. |
PROCESSING_ERROR_REASON_EVENT_ID_DECODE_ERROR |
Не удалось декодировать идентификатор события (dclid или идентификатор показа). |
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_IMPRESSION_ID |
Не удалось найти идентификатор пользователя для указанного идентификатора показа. |
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND |
Не удается найти идентификатор пользователя. |
PROCESSING_ERROR_REASON_CONVERSION_PRECEDES_CLICK |
Временная метка события предшествует связанному с ним клику. |
PROCESSING_ERROR_REASON_TOO_RECENT_CLICK |
Клик произошел слишком недавно. |
PROCESSING_ERROR_REASON_INVALID_CLICK |
Не удалось связать событие с кликом (GCLID). Возможно, клик не связан с кампанией Google Рекламы. |
PROCESSING_ERROR_REASON_INVALID_OPERATING_ACCOUNT_FOR_CLICK |
Клик, связанный с событием, не относится к |
PROCESSING_ERROR_REASON_CLICK_NOT_FOUND |
Не удалось найти клик, соответствующий указанным атрибутам. |
PROCESSING_ERROR_REASON_EXTERNAL_ATTRIBUTION_DATA_MISSING |
Отсутствуют внешние данные атрибуции. Отправка событий в целевой сервис для действия-конверсии со сторонней атрибуцией не поддерживается. |
PROCESSING_ERROR_REASON_DESTINATION_TOO_RECENTLY_CREATED |
Целевой аккаунт был создан недавно. Повторите попытку через несколько часов. |
PROCESSING_ERROR_REASON_EXPIRED_CLICK |
Сопоставленный клик был выполнен раньше, чем истек период учета конверсий по клику, заданный для действия-конверсии (или 90-дневный период жизни клика). |
ProcessingWarningReason
Причина уведомления об обработке.
| Перечисления | |
|---|---|
PROCESSING_WARNING_REASON_UNSPECIFIED |
Причина предупреждения об обработке неизвестна. |
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED |
У системы не было разрешений, необходимых для доступа к ключу шифрования ключей. |
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR |
Не удалось расшифровать ключ шифрования данных (DEK). |
PROCESSING_WARNING_REASON_DECRYPTION_ERROR |
При расшифровке мероприятия произошла ошибка. |
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED |
Не удалось использовать WIP, так как он был отклонен из-за условия аттестации. |
PROCESSING_WARNING_REASON_INVALID_WIP |
WIP отформатирован неправильно или не существует. |
PROCESSING_WARNING_REASON_INVALID_KEK |
Ключ шифрования ключа не может расшифровать данные, поскольку он неверный или не существует. |
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR |
Не удалось расшифровать данные UserIdentifier с помощью ключа шифрования данных. |
PROCESSING_WARNING_REASON_INTERNAL_ERROR |
Внутренняя ошибка. |
PROCESSING_WARNING_REASON_AWS_AUTH_FAILED |
Системе не удалось пройти аутентификацию в AWS. |
Товар
Устаревший метод. Вместо него используйте AccountType
| Перечисления | |
|---|---|
PRODUCT_UNSPECIFIED |
Не указан товар. Не следует использовать. |
GOOGLE_ADS |
Google Реклама; |
DISPLAY_VIDEO_PARTNER |
Партнер в Дисплее и Видео 360. |
DISPLAY_VIDEO_ADVERTISER |
Рекламодатель в Дисплее и Видео 360. |
DATA_PARTNER |
Партнер по обработке данных. |
ProductAccount
Представляет определенный аккаунт.
| Поля | |
|---|---|
product |
Устаревший метод. Вместо него используйте |
account_id |
Обязательно. Идентификатор аккаунта. Например, идентификатор аккаунта Google Рекламы. |
account_type |
Обязательно. Тип аккаунта. например |
AccountType
Представляет типы аккаунтов Google. Используется для поиска аккаунтов и пунктов назначения.
| Перечисления | |
|---|---|
ACCOUNT_TYPE_UNSPECIFIED |
Не указан товар. Не следует использовать. |
GOOGLE_ADS |
Google Реклама; |
DISPLAY_VIDEO_PARTNER |
Партнер в Дисплее и Видео 360. |
DISPLAY_VIDEO_ADVERTISER |
Рекламодатель в Дисплее и Видео 360. |
DATA_PARTNER |
Партнер по обработке данных. |
GOOGLE_ANALYTICS_PROPERTY |
Google Analytics. |
GOOGLE_AD_MANAGER_AUDIENCE_LINK |
Связь с аудиторией Google Менеджера рекламы. |
FLOODLIGHT_CONFIG |
Конфигурация Floodlight. |
GOOGLE_AD_MANAGER |
Google Менеджер рекламы; |
PseudonymousIdInfo
Дополнительная информация, если PSEUDONYMOUS_ID является одним из upload_key_types.
| Поля | |
|---|---|
sync_status |
Используется только для вывода. Статус синхронизации списка пользователей. |
billable_record_count |
Необязательное поле. Не меняется. Количество оплачиваемых записей (например, загруженных или сопоставленных). |
SyncStatus
Статус синхронизации списка пользователей.
| Перечисления | |
|---|---|
SYNC_STATUS_UNSPECIFIED |
Не указано. |
CREATED |
Список пользователей создан как плейсхолдер. Содержимое и/или метаданные списка ещё синхронизируются. Список пользователей не готов к использованию. |
READY_FOR_USE |
Список пользователей готов к использованию. Содержимое и файлы cookie синхронизированы правильно. |
FAILED |
При синхронизации содержимого и/или метаданных списка пользователей произошла ошибка. Нельзя использовать список пользователей. |
RemoveAllAudienceMembersRequest
Запрос на удаление всех пользователей из аудитории в указанных целевых сервисах. Возвращает RemoveAllAudienceMembersResponse.
| Поля | |
|---|---|
destinations[] |
Обязательно. Список целевых сервисов, из которых нужно удалить пользователей. |
remove_as_of_time |
Необязательное поле. Время удаления. Если задано, будут удалены только те участники аудитории, которые были добавлены до указанного времени. Если значение не задано, по умолчанию используется текущее время. Время удаления не может быть в будущем. |
validate_only |
Необязательное поле. Для тестирования. Если указано значение |
RemoveAllAudienceMembersResponse
Ответ от RemoveAllAudienceMembersRequest.
| Поля | |
|---|---|
request_id |
Автоматически созданный идентификатор запроса. |
RemoveAudienceMembersRequest
Запрос на удаление пользователей из аудитории в указанных целевых сервисах. Возвращает RemoveAudienceMembersResponse.
| Поля | |
|---|---|
destinations[] |
Обязательно. Список целевых сервисов, из которых нужно удалить пользователей. |
audience_members[] |
Обязательно. Список пользователей, которых нужно удалить. |
validate_only |
Необязательное поле. Для тестирования. Если указано значение |
encoding |
Необязательное поле. Оно необходимо для загрузки файла |
encryption_info |
Необязательное поле. Информация о шифровании загрузок для домена |
RemoveAudienceMembersResponse
Ответ от RemoveAudienceMembersRequest.
| Поля | |
|---|---|
request_id |
Автоматически созданный идентификатор запроса. |
RemoveUsersRequest
Запрос на удаление пользователей из указанных мест назначения.
| Поля | |
|---|---|
destinations[] |
Обязательно. Список возможных целевых страниц для загрузки. |
user_data[] |
Обязательно. Отдельные фрагменты UserData, которые выступают в качестве ключей для удаления пользователей. |
encryption_info |
Необязательное поле. Информация о ключах шифрования, которые используются для шифрования данных. |
validate_only |
Необязательное поле. Если указано значение |
encoding |
Обязательно. Тип кодировки идентификаторов пользователей. Для зашифрованных идентификаторов пользователей это относится только к внешнему кодированию. |
RemoveUsersResponse
Ответ на запрос RemoveUsersRequest.
| Поля | |
|---|---|
request_id |
Сгенерированный идентификатор запроса на загрузку. |
RequestStatusPerDestination
Статус запроса для каждого пункта назначения.
| Поля | |
|---|---|
destination |
Целевой объект в запросе к API DM. |
request_status |
Статус запроса для целевого сервиса. |
error_info |
Объект error info, содержащий причину ошибки и количество ошибок, связанных с загрузкой. Заполняется только в том случае, если для типа правила |
warning_info |
Предупреждение, содержащее причину и количество предупреждений, связанных с загрузкой. Это поле не заполняется, если в запросе есть |
Объединенное поле status. Статус целевого местоположения. status может иметь одно из следующих значений: |
|
audience_members_ingestion_status |
Статус запроса на загрузку участников аудитории. |
events_ingestion_status |
Статус запроса на получение событий. |
audience_members_removal_status |
Статус запроса на удаление участников аудитории. |
remove_all_audience_members_status |
Статус запроса на удаление всех участников аудитории. |
DataType
Тип данных.
| Перечисления | |
|---|---|
DATA_TYPE_UNSPECIFIED |
Тип данных не указан. |
EMAIL |
Данные представляют собой адрес электронной почты. |
PHONE_NUMBER |
Данные представляют собой номер телефона. |
ADDRESS |
Данные представляют собой физический адрес. |
IP_ADDRESS |
Данные представляют собой IP-адрес. |
DataTypeCount
Количество для определенного типа данных.
| Поля | |
|---|---|
type |
Тип данных. |
count |
Количество для этого типа данных. |
IngestAudienceMembersStatus
Статус запроса на загрузку участников аудитории.
| Поля | |
|---|---|
Объединенное поле status. Статус передачи данных об участниках аудитории в целевой сервис. status может иметь одно из следующих значений: |
|
user_data_ingestion_status |
Статус приема пользовательских данных в целевой системе. |
mobile_data_ingestion_status |
Статус добавления данных мобильных устройств в целевой сервис. |
pair_data_ingestion_status |
Статус добавления данных в целевой сервис. |
user_id_data_ingestion_status |
Статус добавления данных идентификатора пользователя в целевую систему. |
ppid_data_ingestion_status |
Статус добавления данных PPID в целевой сервис. |
composite_data_ingestion_status |
Статус добавления составных данных в целевой сервис. |
google_user_id_data_ingestion_status |
Статус приема данных идентификатора пользователя Google в целевой системе. |
partner_provided_id_data_ingestion_status |
Статус добавления данных идентификаторов, предоставленных партнером, в целевой сервис. |
IngestCompositeDataStatus
Статус добавления составных данных в целевую систему, содержащий статистику, связанную с добавлением данных.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, отправленных в запросе на загрузку для целевого сервиса. Включает всех участников аудитории в запрос независимо от того, были ли они успешно добавлены. |
data_type_counts[] |
Общее количество типов данных, отправленных в запросе на загрузку для целевого сервиса, с разбивкой по типу данных. Включает все типы данных в запросе, независимо от того, были ли они успешно добавлены. |
upload_match_rate_range |
Диапазон коэффициента соответствия загрузки. |
IngestEventsStatus
Статус передачи событий в целевой сервис.
| Поля | |
|---|---|
record_count |
Общее количество событий, отправленных в запросе на загрузку. Включает все события в запросе, независимо от того, были ли они успешно добавлены. |
IngestGoogleUserIdDataStatus
Статус добавления данных идентификатора пользователя Google в целевой сервис, содержащий статистику, связанную с добавлением данных.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, отправленных в запросе на загрузку для целевого сервиса. Включает всех участников аудитории в запрос независимо от того, были ли они успешно добавлены. |
google_user_id_count |
Общее количество идентификаторов пользователей Google, отправленных в запросе на загрузку для целевого сервиса. Включает все идентификаторы пользователей Google в запросе, независимо от того, были ли они успешно обработаны. |
IngestMobileDataStatus
Статус передачи данных мобильного приложения в целевой сервис, содержащий статистику передачи.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, отправленных в запросе на загрузку для целевого сервиса. Включает всех участников аудитории в запрос независимо от того, были ли они успешно добавлены. |
mobile_id_count |
Общее количество идентификаторов мобильных устройств, отправленных в запросе на загрузку для целевого списка. Включает все идентификаторы мобильных устройств в запросе, независимо от того, были ли они успешно добавлены. |
IngestPairDataStatus
Статус добавления данных пары в целевой сервис, содержащий статистику добавления данных.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, отправленных в запросе на загрузку для целевого сервиса. Включает всех участников аудитории в запросе, независимо от того, были ли они успешно добавлены. |
pair_id_count |
Общее количество идентификаторов пар, отправленных в запросе на загрузку для целевого местоположения. Включает все идентификаторы пар в запросе, независимо от того, были ли они успешно добавлены. |
IngestPartnerProvidedIdDataStatus
Статус добавления данных, предоставленных партнером, в целевой сервис, содержащий статистику, связанную с добавлением данных.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, отправленных в запросе на загрузку для целевого сервиса. Включает всех участников аудитории в запросе, независимо от того, были ли они успешно добавлены. |
partner_provided_id_count |
Общее количество идентификаторов, предоставленных партнером и отправленных в запросе на загрузку для целевого сервиса. Включает все идентификаторы, предоставленные партнером в запросе, независимо от того, были ли они успешно добавлены. |
IngestPpidDataStatus
Статус добавления данных ppid в целевой сервис, содержащий статистику добавления данных.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, отправленных в запросе на загрузку для целевого сервиса. Включает всех участников аудитории в запрос независимо от того, были ли они успешно добавлены. |
ppid_count |
Общее количество идентификаторов, предоставленных издателем, отправленных в запросе на загрузку для целевого ресурса. Включает все идентификаторы издателя, указанные в запросе, независимо от того, были ли они успешно добавлены. |
IngestUserDataStatus
Статус приема данных пользователя в целевой системе, содержащий статистику, связанную с приемом.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, отправленных в запросе на загрузку для целевого сервиса. Включает всех участников аудитории в запросе, независимо от того, были ли они успешно добавлены. |
user_identifier_count |
Общее количество идентификаторов пользователей, отправленных в запросе на загрузку для целевого сервиса. Включает все идентификаторы пользователей в запросе, независимо от того, были ли они успешно обработаны. |
upload_match_rate_range |
Диапазон коэффициента соответствия загрузки. |
IngestUserIdDataStatus
Статус приема данных идентификатора пользователя в целевой сервис, содержащий статистику, связанную с приемом.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, отправленных в запросе на загрузку для целевого сервиса. Включает всех участников аудитории в запросе, независимо от того, были ли они успешно добавлены. |
user_id_count |
Общее количество идентификаторов пользователей, отправленных в запросе на загрузку для целевого сервиса. Включает все идентификаторы пользователей в запросе, независимо от того, были ли они успешно добавлены. |
RemoveAllAudienceMembersStatus
У этого типа нет полей.
Статус запроса на удаление всех участников аудитории.
RemoveAudienceMembersStatus
Статус запроса на удаление участников аудитории.
| Поля | |
|---|---|
Объединенное поле status. Статус удаления участников аудитории из целевого сервиса. status может иметь одно из следующих значений: |
|
user_data_removal_status |
Статус удаления пользовательских данных из целевого аккаунта. |
mobile_data_removal_status |
Статус удаления мобильных данных из целевого сервиса. |
pair_data_removal_status |
Статус удаления данных пары из целевого сервиса. |
user_id_data_removal_status |
Статус удаления данных идентификатора пользователя из целевого сервиса. |
ppid_data_removal_status |
Статус удаления данных PPID из целевого сервиса. |
composite_data_removal_status |
Статус удаления составных данных из целевого местоположения. |
google_user_id_data_removal_status |
Статус удаления идентификатора пользователя Google из целевого сервиса. |
partner_provided_id_data_removal_status |
Статус удаления данных идентификатора, предоставленного партнером, из целевого сервиса. |
RemoveCompositeDataStatus
Статус удаления составных данных из целевого местоположения.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, указанных в запросе на удаление. Включает всех участников аудитории в запросе, независимо от того, были ли они успешно удалены. |
data_type_counts[] |
Общее количество типов данных, указанных в запросе на удаление, с разбивкой по типам. Включает все типы данных в запросе, независимо от того, были они успешно удалены или нет. |
RemoveGoogleUserIdDataStatus
Статус удаления идентификатора пользователя Google из целевого сервиса.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, указанных в запросе на удаление. Включает всех участников аудитории в запросе, независимо от того, были они успешно удалены или нет. |
google_user_id_count |
Общее количество идентификаторов пользователей Google, указанных в запросе на удаление. Включает все идентификаторы пользователей Google в запросе, независимо от того, были они успешно удалены или нет. |
RemoveMobileDataStatus
Статус удаления мобильных данных из целевого сервиса.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, указанных в запросе на удаление. Включает всех участников аудитории в запросе, независимо от того, были они успешно удалены или нет. |
mobile_id_count |
Общее количество идентификаторов мобильных устройств, указанных в запросе на удаление. Включает все идентификаторы мобильных устройств в запросе, независимо от того, были ли они успешно удалены. |
RemovePairDataStatus
Статус удаления данных пары из целевого сервиса.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, указанных в запросе на удаление. Включает всех участников аудитории в запросе, независимо от того, были они успешно удалены или нет. |
pair_id_count |
Общее количество идентификаторов пар, отправленных в запросе на удаление. Включает все идентификаторы пар в запросе, независимо от того, были они успешно удалены или нет. |
RemovePartnerProvidedIdDataStatus
Статус удаления данных идентификатора, предоставленного партнером, из целевого сервиса.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, указанных в запросе на удаление. Включает всех участников аудитории в запросе, независимо от того, были они успешно удалены или нет. |
partner_provided_id_count |
Общее количество идентификаторов, предоставленных партнером и отправленных в запросе на удаление. Включает все предоставленные партнером идентификаторы в запросе, независимо от того, были они успешно удалены или нет. |
RemovePpidDataStatus
Статус удаления данных PPID из целевого сервиса.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, указанных в запросе на удаление. Включает всех участников аудитории в запросе, независимо от того, были они успешно удалены или нет. |
ppid_count |
Общее количество идентификаторов, отправленных в запросе на удаление. Включает все идентификаторы, указанные в запросе, независимо от того, были они удалены или нет. |
RemoveUserDataStatus
Статус удаления пользовательских данных из целевого аккаунта.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, указанных в запросе на удаление. Включает всех участников аудитории в запросе, независимо от того, были они успешно удалены или нет. |
user_identifier_count |
Общее количество идентификаторов пользователей, отправленных в запросе на удаление. Включает все идентификаторы пользователей в запросе, независимо от того, были они успешно удалены или нет. |
RemoveUserIdDataStatus
Статус удаления данных идентификатора пользователя из целевого сервиса.
| Поля | |
|---|---|
record_count |
Общее количество участников аудитории, указанных в запросе на удаление. Включает всех участников аудитории в запросе, независимо от того, были они успешно удалены или нет. |
user_id_count |
Общее количество идентификаторов пользователей, отправленных в запросе на удаление. Содержит все идентификаторы пользователей в запросе, независимо от того, были ли они успешно удалены. |
RequestStatus
Статус запроса.
| Перечисления | |
|---|---|
REQUEST_STATUS_UNKNOWN |
Статус запроса неизвестен. |
SUCCESS |
Все записи были обработаны без ошибок. Однако в поле |
PROCESSING |
Запрос обрабатывается. |
FAILED |
Не удалось обработать все записи. Подробную информацию об ошибках можно найти в поле |
PARTIAL_SUCCESS |
Некоторые записи были обработаны успешно, а другие – с ошибками. Подробную информацию об ошибках можно найти в поле |
RetrieveInsightsRequest
Запрос сообщения для DM API MarketingDataInsightsService.RetrieveInsights
| Поля | |
|---|---|
parent |
Обязательно. Родительский аккаунт, которому принадлежит список пользователей. Формат: |
baseline |
Обязательно. Базовый уровень для запрошенных данных. |
user_list_id |
Обязательно. Идентификатор списка пользователей, для которого запрашивается статистика. |
RetrieveInsightsResponse
Сообщение ответа для DM API MarketingDataInsightsService.RetrieveInsights
| Поля | |
|---|---|
marketing_data_insights[] |
Содержит статистику маркетинговых данных. |
MarketingDataInsight
Статистика маркетинговых данных.
Эта функция доступна только партнерам по обработке данных.
| Поля | |
|---|---|
dimension |
Параметр, к которому относится статистика. |
attributes[] |
Статистика по значениям определенного параметра. |
AudienceInsightsDimension
Возможные параметры для создания статистики.
| Перечисления | |
|---|---|
AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED |
Не указано. |
AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN |
В этой версии значение неизвестно. |
AFFINITY_USER_INTEREST |
Категория интересов пользователей. |
IN_MARKET_USER_INTEREST |
Категория интересов пользователей, относящаяся к заинтересованным покупателям. |
AGE_RANGE |
Возрастной диапазон. |
GENDER |
Пол. |
MarketingDataInsightsAttribute
Статистика по набору связанных атрибутов одного параметра.
| Поля | |
|---|---|
user_interest_id |
Идентификатор интереса пользователя. |
lift |
Показатель роста, который аудитория обеспечивает для значения атрибута по сравнению с контрольным значением. Диапазон: [0–1]. |
age_range |
Возрастной диапазон аудитории, для которой указан рост. |
gender |
Пол аудитории, для которой рассчитывается рост. |
RetrieveRequestStatusRequest
Запрос на получение статуса запроса, отправленного в DM API, по идентификатору запроса. Возвращает RetrieveRequestStatusResponse.
| Поля | |
|---|---|
request_id |
Обязательно. Обязательно. Идентификатор запроса Data Manager API. |
RetrieveRequestStatusResponse
Ответ от RetrieveRequestStatusRequest.
| Поля | |
|---|---|
request_status_per_destination[] |
Список статусов запросов для каждого целевого сервиса. Порядок статусов соответствует порядку пунктов назначения в исходном запросе. |
SearchPartnerLinksRequest
Запрос на поиск ресурсов PartnerLink. Возвращает SearchPartnerLinksResponse.
| Поля | |
|---|---|
parent |
Обязательно. Аккаунт, в котором нужно искать партнерские ссылки. Если параметр Формат: |
page_size |
Максимальное количество ссылок партнеров, которые нужно вернуть. Сервис может вернуть меньше результатов. Если значение не указано, возвращается не более 50 ссылок на партнеров. Максимальное значение – 100. Если указать большее число, оно будет приведено к 100. |
page_token |
Токен страницы, полученный из предыдущего вызова При разбиении на страницы все остальные параметры, переданные в |
filter |
Необязательное поле. Строка фильтра. Все поля должны быть указаны слева от каждого условия (например, Поддерживаемые операции:
Поддерживаемые поля:
Для партнерских ссылок с набором функций
Пример: |
SearchPartnerLinksResponse
Ответ от SearchPartnerLinksRequest.
| Поля | |
|---|---|
partner_links[] |
Ссылки на партнеров для указанного аккаунта. |
next_page_token |
Токен, который можно отправить как |
SizeInfo
Расчетное количество пользователей в этом списке в разных целевых сетях.
| Поля | |
|---|---|
display_network_members_count |
Используется только для вывода. Оценочное количество пользователей из этого списка в контекстно-медийной сети Google. |
search_network_members_count |
Используется только для вывода. Приблизительное количество участников в этом списке пользователей в домене google.com. Именно эти пользователи доступны для таргетинга в поисковых кампаниях. |
youtube_members_count |
Используется только для вывода. Расчетное количество пользователей из этого списка на YouTube. |
gmail_members_count |
Используется только для вывода. Оценочное количество пользователей из этого списка, которые используют Gmail. |
TargetNetworkInfo
Информация о соответствии требованиям для разных целевых сетей.
| Поля | |
|---|---|
eligible_for_display |
Используется только для вывода. Указывает, что список пользователей подходит для контекстно-медийной сети Google. |
eligible_for_search |
Необязательное поле. Указывает, подходит ли этот список пользователей для поисковой сети Google. |
TargetingType
Тип таргетинга, использованный для показа объявления.
| Перечисления | |
|---|---|
TARGETING_TYPE_UNSPECIFIED |
Неуказанный тип таргетинга. |
TARGETING_TYPE_AUDIENCE |
Таргетинг на аудитории. |
TARGETING_TYPE_CONTEXTUAL |
Контекстный таргетинг. |
TARGETING_TYPE_DEMOGRAPHIC |
Демографический таргетинг. |
TARGETING_TYPE_DEVICE |
Таргетинг на устройства. |
TARGETING_TYPE_GEO |
Геотаргетинг. |
TARGETING_TYPE_INTEREST |
Таргетинг на интересы. |
TARGETING_TYPE_PURCHASE_INTENT |
Таргетинг на основе покупательского намерения. |
TARGETING_TYPE_REMARKETING |
Таргетинг на списки ремаркетинга. |
TermsOfService
Условия использования, которые пользователь принял или отклонил.
| Поля | |
|---|---|
customer_match_terms_of_service_status |
Необязательное поле. Условия использования списков электронных адресов: https://support.google.com/adspolicy/answer/6299717. Это условие необходимо принять при загрузке |
TermsOfServiceStatus
Решение вызывающего абонента принять или отклонить условия использования.
| Перечисления | |
|---|---|
TERMS_OF_SERVICE_STATUS_UNSPECIFIED |
Не указано. |
ACCEPTED |
Статус, указывающий, что звонящий принял условия использования. |
REJECTED |
Статус, указывающий, что вызывающий абонент решил отклонить условия использования. |
UpdateUserListDirectLicenseRequest
Запрос на обновление ресурса UserListDirectLicense.
| Поля | |
|---|---|
user_list_direct_license |
Обязательно. Поле |
update_mask |
Необязательное поле. Список полей, которые нужно обновить. Специальный символ |
UpdateUserListGlobalLicenseRequest
Запрос на обновление ресурса UserListGlobalLicense.
| Поля | |
|---|---|
user_list_global_license |
Обязательно. Поле |
update_mask |
Необязательное поле. Список полей, которые нужно обновить. Специальный символ |
UpdateUserListRequest
Запрос сообщения для UpdateUserList.
| Поля | |
|---|---|
user_list |
Обязательно. Список пользователей, который нужно обновить. Поле |
update_mask |
Необязательное поле. Список полей, которые нужно обновить. |
validate_only |
Необязательное поле. Если значение равно true, запрос проверяется, но не выполняется. |
Пользователь
Представляет одного пользователя и содержит идентификаторы, такие как персональная информация и идентификаторы мобильных устройств, которые относятся к одному и тому же пользователю.
| Поля | |
|---|---|
user_data |
Обязательно. Несколько фрагментов данных, предоставленных пользователем и используемых для его идентификации. |
mobile_data |
Обязательно. Несколько строк с идентификаторами мобильных устройств, относящихся к одному пользователю. |
UserData
Данные, идентифицирующие пользователя. Требуется указать хотя бы один идентификатор.
| Поля | |
|---|---|
user_identifiers[] |
Обязательно. Идентификаторы пользователя. Можно указать несколько экземпляров одного типа данных (например, несколько адресов электронной почты). Чтобы повысить вероятность успешного сопоставления, передавайте как можно больше идентификаторов. В одном файле |
UserIdData
Данные идентификатора User-ID, содержащие идентификатор пользователя.
| Поля | |
|---|---|
user_id |
Обязательно. Уникальный идентификатор пользователя, заданный рекламодателем. |
UserIdInfo
Дополнительная информация, если USER_ID является одним из upload_key_types.
| Поля | |
|---|---|
data_source_type |
Необязательное поле. Не меняется. Источник загруженных данных. |
UserIdentifier
Уникальный идентификатор пользователя.
| Поля | |
|---|---|
Объединенное поле identifier. Необходимо указать только один из них. identifier может иметь одно из следующих значений: |
|
email_address |
Хешированный адрес электронной почты с использованием хеш-функции SHA-256 после нормализации. |
phone_number |
Хешированный номер телефона с использованием хеш-функции SHA-256 после нормализации (стандарт E164). |
address |
Известные компоненты адреса пользователя. Содержит группу идентификаторов, которые сопоставляются одновременно. |
UserList
Ресурс списка пользователей.
| Поля | |
|---|---|
name |
Идентификатор. Название ресурса списка пользователей. Формат: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} |
id |
Используется только для вывода. Уникальный идентификатор списка пользователей. |
read_only |
Используется только для вывода. Параметр, указывающий, может ли пользователь редактировать список. |
membership_duration |
Необязательное поле. Время, в течение которого пользователь остается в списке. Допустимая продолжительность – это точное количество суток (86 400 секунд). Если указать значение, которое не является точным кратным 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 |
Необязательное поле. Представляет список пользователей, который заполняется на основе загруженных данных. |
AccessReason
Перечисление, описывающее возможные причины доступа.
| Перечисления | |
|---|---|
ACCESS_REASON_UNSPECIFIED |
Не указано. |
OWNED |
Ресурс принадлежит пользователю. |
SHARED |
Ресурс предоставлен пользователю. |
LICENSED |
У пользователя есть лицензия на ресурс. |
SUBSCRIBED |
Пользователь подписался на ресурс. |
AFFILIATED |
Ресурс доступен пользователю. |
AccessStatus
Показывает, есть ли у клиента доступ к списку.
| Перечисления | |
|---|---|
ACCESS_STATUS_UNSPECIFIED |
Не указано. |
ENABLED |
Доступ включен. |
DISABLED |
Доступ отключен. |
ClosingReason
Указывает причину, по которой список пользователей был закрыт. Это перечисление используется только в том случае, если список автоматически закрывается системой.
| Перечисления | |
|---|---|
CLOSING_REASON_UNSPECIFIED |
Не указано. |
UNUSED |
Список пользователей закрыт, поскольку он давно не использовался для таргетинга. Подробнее: https://support.google.com/google-ads/answer/2472738. |
MembershipStatus
Статус списка пользователей.
| Перечисления | |
|---|---|
MEMBERSHIP_STATUS_UNSPECIFIED |
Не указано. |
OPEN |
Открыт – в список пользователей добавляются участники, и на него можно настроить таргетинг. |
CLOSED |
Статус "Закрытый" означает, что новые участники не добавляются. |
UserListDirectLicense
Прямая лицензия на список пользователей.
Эта функция доступна только партнерам по обработке данных.
| Поля | |
|---|---|
name |
Идентификатор. Название ресурса прямой лицензии на список пользователей. |
user_list_display_name |
Используется только для вывода. Название списка пользователей, на который приобретается лицензия. Это поле доступно только для чтения. |
client_account_display_name |
Используется только для вывода. Название клиентского аккаунта, которому предоставляется лицензия на список пользователей. Это поле доступно только для чтения. |
pricing |
Необязательное поле. Цены на лицензии UserListDirectLicense. |
historical_pricings[] |
Используется только для вывода. История цен на лицензию для этого списка пользователей. Это поле доступно только для чтения. |
metrics |
Используется только для вывода. Показатели, связанные с этой лицензией Это поле доступно только для чтения и заполняется, только если даты начала и окончания заданы в вызове ListUserListDirectLicenses. |
user_list_id |
Не меняется. Идентификатор списка пользователей, для которого приобретается лицензия. |
client_account_type |
Не меняется. Тип аккаунта клиента, которому предоставляется лицензия на список пользователей. |
client_account_id |
Не меняется. Идентификатор клиентского аккаунта, которому предоставляется лицензия на список пользователей. |
status |
Необязательное поле. Статус UserListDirectLicense – ENABLED или DISABLED. |
UserListGlobalLicense
Глобальная лицензия на список пользователей.
Эта функция доступна только партнерам по обработке данных.
| Поля | |
|---|---|
name |
Идентификатор. Название ресурса глобальной лицензии на список пользователей. |
user_list_display_name |
Используется только для вывода. Название списка пользователей, на который приобретается лицензия. Это поле доступно только для чтения. |
pricing |
Необязательное поле. Цены на лицензии UserListGlobalLicense. |
historical_pricings[] |
Используется только для вывода. История цен на лицензию для этого списка пользователей. Это поле доступно только для чтения. |
metrics |
Используется только для вывода. Показатели, связанные с этой лицензией Это поле доступно только для чтения и заполняется, только если даты начала и окончания заданы в вызове ListUserListGlobalLicenses. |
user_list_id |
Не меняется. Идентификатор списка пользователей, для которого приобретается лицензия. |
license_type |
Не меняется. Тип продукта клиента, которому предоставляется лицензия на список пользователей. |
status |
Необязательное поле. Статус UserListGlobalLicense – ENABLED или DISABLED. |
UserListGlobalLicenseCustomerInfo
Информация о клиенте глобальной лицензии на список пользователей. Он будет создан автоматически, когда клиент приобретет глобальную лицензию.
| Поля | |
|---|---|
name |
Идентификатор. Название ресурса клиента с глобальной лицензией на список пользователей. |
user_list_id |
Используется только для вывода. Идентификатор списка пользователей, для которого приобретается лицензия. |
user_list_display_name |
Используется только для вывода. Название списка пользователей, на который приобретается лицензия. |
license_type |
Используется только для вывода. Тип продукта клиента, которому предоставляется лицензия на список пользователей. |
status |
Используется только для вывода. Статус UserListDirectLicense – ENABLED или DISABLED. |
pricing |
Используется только для вывода. Цены на лицензии UserListDirectLicense. |
client_account_type |
Используется только для вывода. Тип продукта клиента, которому предоставляется лицензия на список пользователей. |
client_account_id |
Используется только для вывода. Идентификатор клиентского аккаунта, которому предоставляется лицензия на список пользователей. |
client_account_display_name |
Используется только для вывода. Название клиентского аккаунта, которому предоставляется лицензия на список пользователей. |
historical_pricings[] |
Используется только для вывода. История цен на лицензию для этого списка пользователей. |
metrics |
Используется только для вывода. Показатели, связанные с этой лицензией Это поле заполняется, только если даты начала и окончания заданы в вызове ListUserListGlobalLicenseCustomerInfos. |
UserListGlobalLicenseType
Типы глобальных лицензий для списков пользователей.
| Перечисления | |
|---|---|
USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED |
Не указано. |
USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER |
Лицензия реселлера. |
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE |
Лицензия DataMart Sell Side. |
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE |
Лицензия DataMart Buy Side. |
UserListLicenseClientAccountType
Возможный продукт клиентского аккаунта для лицензии на список пользователей.
| Перечисления | |
|---|---|
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN |
Неизвестно. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS |
Клиент Google Рекламы. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER |
Партнер в Дисплее и Видео 360. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER |
Рекламодатель в Дисплее и Видео 360. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK |
Связь с аудиторией Google Менеджера рекламы. |
UserListLicenseMetrics
Показатели, связанные с лицензией на список пользователей.
| Поля | |
|---|---|
click_count |
Используется только для вывода. Количество кликов для лицензии на список пользователей. |
impression_count |
Используется только для вывода. Количество показов для лицензии на список пользователей. |
revenue_usd_micros |
Используется только для вывода. Доход от лицензии на список пользователей в микродолларах США. |
start_date |
Используется только для вывода. Дата начала периода (включительно) в формате ГГГГММДД. Например, 20260102 – это 2 января 2026 г. Если в фильтре используется параметр |
end_date |
Используется только для вывода. Дата окончания периода, за который собираются данные, в формате ГГГГММДД. Например, 20260102 – это 2 января 2026 г. Если в фильтре используется параметр |
UserListLicensePricing
Стоимость лицензии на список пользователей.
| Поля | |
|---|---|
pricing_id |
Используется только для вывода. Идентификатор цены. |
start_time |
Используется только для вывода. Время начала действия цены. |
end_time |
Необязательное поле. Время окончания действия цены. |
pricing_active |
Используется только для вывода. Активна ли эта цена. |
buyer_approval_state |
Используется только для вывода. Статус одобрения этой цены покупателем. Это поле доступно только для чтения. |
cost_micros |
Необязательное поле. Стоимость, связанная с моделью, в микроединицах (10^-6) в валюте, указанной в поле currency_code. Например, если |
currency_code |
Необязательное поле. Валюта, в которой указаны значения атрибутов "цена" и "максимальная цена". Трехбуквенный код валюты по стандарту ISO 4217. |
cost_type |
Не меняется. Тип цены. Можно задать только в операции |
max_cost_micros |
Необязательное поле. Максимальная цена за тысячу показов, которая может быть назначена торговой аудитории при использовании типа стоимости MEDIA_SHARE. Значение указывается в микроединицах (10^-6) и в валюте, заданной в поле currency_code. Например, если Этот параметр используется, только если cost_type имеет значение MEDIA_SHARE. Если cost_type не MEDIA_SHARE, а это поле задано, будет возвращена ошибка MAX_COST_NOT_ALLOWED. Если правило не настроено или для него задано значение |
UserListPricingBuyerApprovalState
Статус одобрения покупателем цены для списка пользователей.
| Перечисления | |
|---|---|
USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED |
Не указано. |
PENDING |
Клиент списка пользователей ещё не принял условия ценообразования, установленные владельцем списка пользователей. |
APPROVED |
Клиент списка пользователей принял условия ценообразования, заданные владельцем списка пользователей. |
REJECTED |
Клиент списка пользователей отклонил условия ценообразования, заданные владельцем списка пользователей. |
UserListPricingCostType
Тип стоимости списка пользователей.
| Перечисления | |
|---|---|
USER_LIST_PRICING_COST_TYPE_UNSPECIFIED |
Не указано. |
CPC |
Цена за клик. |
CPM |
Цена за тысячу показов. |
MEDIA_SHARE |
Поделиться медиаконтентом. |
UserListLicenseStatus
Статус лицензии на список пользователей.
| Перечисления | |
|---|---|
USER_LIST_LICENSE_STATUS_UNSPECIFIED |
Неизвестно. |
USER_LIST_LICENSE_STATUS_ENABLED |
Активный статус означает, что список пользователей лицензируется. |
USER_LIST_LICENSE_STATUS_DISABLED |
Неактивный статус – лицензирование списка пользователей прекращено. |
UserProperties
Информация о пользователе, полученная рекламодателем в момент события. Подробнее: https://support.google.com/google-ads/answer/14007601.
| Поля | |
|---|---|
customer_type |
Необязательное поле. Тип клиента, связанного с событием. |
customer_value_bucket |
Необязательное поле. Ценность клиента, определенная рекламодателем. |
additional_user_properties[] |
Необязательное поле. Контейнер для любых дополнительных свойств пользователя, связанных с этим событием. |
UserProperty
Контейнер для любых дополнительных свойств пользователя, связанных с этим событием.
| Поля | |
|---|---|
property_name |
Обязательно. Название свойства пользователя, которое нужно использовать. |
value |
Обязательно. Строковое представление значения свойства пользователя, которое нужно использовать. |
ViewType
Тип события.
| Перечисления | |
|---|---|
VIEW_TYPE_UNSPECIFIED |
Тип просмотра не указан. |
VIEW_TYPE_MRC_VIEWED |
Просмотрено по стандарту MRC. |
VIEW_TYPE_MRC_RENDERED |
Показ в видимой области экрана по стандартам MRC. |
ViewabilityInfo
Подробные сведения о видимости показанного объявления.
| Поля | |
|---|---|
view_type |
Обязательно. Тип события. |
viewable_percent |
Необязательное поле. Процент видимых пикселей (от 0 до 100). |
viewable_duration |
Необязательное поле. Время, в течение которого объявление было видно. |
media_skippable |
Необязательное поле. Возможность пропуска объявления. |
media_quartile |
Необязательное поле. Доля воспроизведенного медиаконтента в виде отдельных квартилей. |
media_duration |
Необязательное поле. Продолжительность медийного объявления. |
media_volume_percent |
Необязательное поле. Громкость воспроизведения медиаконтента в процентах (от 0 до 100). |
playback_duration |
Необязательное поле. Продолжительность воспроизведения медиаконтента объявления независимо от того, было ли оно показано в видимой области экрана. |
WarningCount
Количество предупреждений для определенной причины.
| Поля | |
|---|---|
record_count |
Количество записей с предупреждением. |
reason |
Причина предупреждения. |
WarningInfo
Количество предупреждений каждого типа.
| Поля | |
|---|---|
warning_counts[] |
Список предупреждений и их количество по каждой причине. |
WarningReason
Причины предупреждений, не блокирующих загрузку, которые были возвращены во время загрузки.
| Перечисления | |
|---|---|
WARNING_REASON_UNSPECIFIED |
Причина предупреждения не указана. |
WARNING_REASON_CUSTOM_VARIABLE_NOT_ENABLED |
В аккаунте не включена пользовательская переменная |
WARNING_REASON_CUSTOM_VARIABLE_NOT_PREDEFINED |
Значение пользовательской переменной в |
WARNING_REASON_CART_DATA_NOT_SUPPORTED_WITH_GBRAID_OR_WBRAID |
|
WARNING_REASON_CART_DATA_ITEM_MERCHANT_PRODUCT_ID_MISSING |
В товаре корзины отсутствует значение |
WARNING_REASON_CART_DATA_ITEM_UNIT_PRICE_MISSING |
В товаре корзины отсутствует значение |
WARNING_REASON_GENERIC |
Общая причина предупреждения для проблем, которые не относятся к другим категориям. |
WARNING_REASON_INVALID_CLIENT_ID |
Недопустимое значение |
WARNING_REASON_INVALID_SUBDIVISION_CODE |
Недопустимое значение |
WARNING_REASON_INVALID_REGION_CODE |
Недопустимое значение |
WARNING_REASON_INVALID_SUBCONTINENT_CODE |
Недопустимое значение |
WARNING_REASON_INVALID_CONTINENT_CODE |
Недопустимое значение |
WARNING_REASON_INVALID_DEVICE_CATEGORY |
Устройство |
WARNING_REASON_INVALID_DEVICE_SCREEN_RESOLUTION |
Устройство |
WARNING_REASON_INVALID_MERCHANT_ID |
Недопустимое значение |