Package google.ads.datamanager.v1

Индекс

• IngestionService (интерфейс)
• MarketingDataInsightsService (интерфейс)
• PartnerLinkService (интерфейс)
• UserListDirectLicenseService (интерфейс)
• UserListGlobalLicenseService (интерфейс)
• UserListService (интерфейс)
• AdEvent (сообщение)
• AdEvent.EventSubtype (enum)
• AdEvent.EventType (enum)
• AdFormat (enum)
• AdIdentifiers (сообщение)
• AdPlacement (enum)
• AdType (перечисление)
• AddressInfo (message)
• AgeRange (перечисление)
• AttributionHint (enum)
• AudienceMember (сообщение)
• AwsWrappedKeyInfo (message)
• AwsWrappedKeyInfo.KeyType (enum)
• Baseline (сообщение)
• Baseline.Location (message)
• CartData (message)
• CompositeData (message)
• Consent (сообщение)
• ConsentStatus (enum)
• ContactIdInfo (message)
• CoordinatorKeyInfo (message)
• CreatePartnerLinkRequest (message)
• CreateUserListDirectLicenseRequest (message)
• CreateUserListGlobalLicenseRequest (message)
• CreateUserListRequest (message)
• CustomVariable (message)
• CustomerType (перечисление)
• CustomerValueBucket (enum)
• DataSourceType (перечисление)
• DeletePartnerLinkRequest (message)
• DeleteUserListRequest (message)
• Destination (сообщение)
• DeviceInfo (сообщение)
• Encoding (перечисление)
• EncryptedUserId (message)
• EncryptedUserId.EncryptionEntityType (enum)
• EncryptedUserId.EncryptionSource (enum)
• EncryptionInfo (message)
• ErrorCount (message)
• ErrorInfo (message)
• ErrorReason (enum)
• Event (сообщение)
• EventLocation (message)
• EventParameter (message)
• EventSource (enum)
• ExperimentalField (message)
• FeatureSet (enum)
• GcpWrappedKeyInfo (message)
• GcpWrappedKeyInfo.KeyType (enum)
• Gender (перечисление)
• GetUserListDirectLicenseRequest (message)
• GetUserListGlobalLicenseRequest (message)
• GetUserListRequest (message)
• IngestAdEventsRequest (message)
• IngestAdEventsResponse (message)
• IngestAudienceMembersRequest (message)
• IngestAudienceMembersResponse (message)
• IngestEventsRequest (message)
• IngestEventsResponse (message)
• IngestedUserListInfo (message)
• IngestedUserListInfo.UploadKeyType (enum)
• IpData (сообщение)
• Item (сообщение)
• ItemCustomVariable (message)
• ItemParameter (message)
• ListUserListDirectLicensesRequest (message)
• ListUserListDirectLicensesResponse (сообщение)
• ListUserListGlobalLicenseCustomerInfosRequest (message)
• ListUserListGlobalLicenseCustomerInfosResponse (message)
• ListUserListGlobalLicensesRequest (message)
• ListUserListGlobalLicensesResponse (сообщение)
• ListUserListsRequest (message)
• ListUserListsResponse (message)
• MatchRateRange (enum)
• MediaQuartile (enum)
• MobileData (сообщение)
• MobileIdInfo (message)
• MobileIdInfo.KeySpace (enum)
• PairData (message)
• PairIdInfo (message)
• PartnerAudienceInfo (message)
• PartnerAudienceInfo.PartnerAudienceSource (enum)
• PartnerCustomerAccount (message)
• PartnerLink (сообщение)
• PartnerLinkMetadata (сообщение)
• Platform (перечисление)
• PlatformType (enum)
• PpidData (message)
• ProcessingErrorReason (enum)
• ProcessingWarningReason (enum)
• Product (перечисление) (устарело)
• ProductAccount (message)
• ProductAccount.AccountType (enum)
• PseudonymousIdInfo (message)
• PseudonymousIdInfo.SyncStatus (enum)
• RemoveAudienceMembersRequest (message)
• RemoveAudienceMembersResponse (message)
• RequestStatusPerDestination (message)
• RequestStatusPerDestination.DataType (enum)
• RequestStatusPerDestination.DataTypeCount (message)
• RequestStatusPerDestination.IngestAudienceMembersStatus (message)
• RequestStatusPerDestination.IngestCompositeDataStatus (message)
• RequestStatusPerDestination.IngestEventsStatus (message)
• RequestStatusPerDestination.IngestMobileDataStatus (message)
• RequestStatusPerDestination.IngestPairDataStatus (message)
• RequestStatusPerDestination.IngestPpidDataStatus (message)
• RequestStatusPerDestination.IngestUserDataStatus (message)
• RequestStatusPerDestination.IngestUserIdDataStatus (message)
• RequestStatusPerDestination.RemoveAudienceMembersStatus (message)
• RequestStatusPerDestination.RemoveCompositeDataStatus (message)
• RequestStatusPerDestination.RemoveMobileDataStatus (message)
• RequestStatusPerDestination.RemovePairDataStatus (message)
• RequestStatusPerDestination.RemovePpidDataStatus (message)
• RequestStatusPerDestination.RemoveUserDataStatus (message)
• RequestStatusPerDestination.RemoveUserIdDataStatus (message)
• RequestStatusPerDestination.RequestStatus (enum)
• RetrieveInsightsRequest (message)
• RetrieveInsightsResponse (message)
• RetrieveInsightsResponse.MarketingDataInsight (message)
• RetrieveInsightsResponse.MarketingDataInsight.AudienceInsightsDimension (enum)
• RetrieveInsightsResponse.MarketingDataInsight.MarketingDataInsightsAttribute (message)
• RetrieveRequestStatusRequest (message)
• RetrieveRequestStatusResponse (message)
• SearchPartnerLinksRequest (message)
• SearchPartnerLinksResponse (message)
• SizeInfo (message)
• TargetNetworkInfo (message)
• TargetingType (enum)
• TermsOfService (сообщение)
• TermsOfServiceStatus (enum)
• UpdateUserListDirectLicenseRequest (message)
• UpdateUserListGlobalLicenseRequest (message)
• UpdateUserListRequest (message)
• UserData (сообщение)
• UserIdData (message)
• UserIdInfo (message)
• UserIdentifier (сообщение)
• UserList (сообщение)
• UserList.AccessReason (enum)
• UserList.AccessStatus (enum)
• UserList.ClosingReason (enum)
• UserList.MembershipStatus (enum)
• UserListDirectLicense (message)
• UserListGlobalLicense (message)
• UserListGlobalLicenseCustomerInfo (message)
• UserListGlobalLicenseType (перечисление)
• UserListLicenseClientAccountType (enum)
• UserListLicenseMetrics (message)
• UserListLicensePricing (message)
• UserListLicensePricing.UserListPricingBuyerApprovalState (enum)
• UserListLicensePricing.UserListPricingCostType (enum)
• UserListLicenseStatus (enum)
• UserProperties (сообщение)
• UserProperty (message)
• ViewType (перечисление)
• ViewabilityInfo (message)
• WarningCount (message)
• WarningInfo (message)

Служба приема данных

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

IngestAdEvents
rpc IngestAdEvents( IngestAdEventsRequest ) returns ( IngestAdEventsResponse ) Загружает список ресурсов AdEvent в Google Analytics. Эта функция доступна только для учетных записей, включенных в список разрешенных. Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

IngestAudienceMembers
rpc IngestAudienceMembers( IngestAudienceMembersRequest ) returns ( IngestAudienceMembersResponse ) Загружает список ресурсов AudienceMember в указанное Destination . Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

IngestEvents
rpc IngestEvents( IngestEventsRequest ) returns ( IngestEventsResponse ) Загружает список ресурсов Event из указанного Destination . Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

RemoveAudienceMembers
rpc RemoveAudienceMembers( RemoveAudienceMembersRequest ) returns ( RemoveAudienceMembersResponse ) Удаляет список ресурсов AudienceMember из указанного Destination . Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

RetrieveRequestStatus
rpc RetrieveRequestStatus( RetrieveRequestStatusRequest ) returns ( RetrieveRequestStatusResponse ) Получает статус запроса по заданному идентификатору запроса. Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

MarketingDataInsightsService

Сервис для предоставления аналитической информации на основе маркетинговых данных.

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

RetrieveInsights

rpc RetrieveInsights( RetrieveInsightsRequest ) returns ( RetrieveInsightsResponse ) Получает маркетинговые данные и аналитику для заданного списка пользователей. Эта функция доступна только партнерам по передаче данных. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API: login-account : (Необязательно) Имя ресурса учетной записи, в которой находится учетная запись Google, для которой были предоставлены учетные данные. Если не указано, используется имя учетной записи из запроса. Формат: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account : (Необязательно) Имя ресурса учетной записи с установленной связью продукта с login-account . Формат: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

PartnerLinkService

Сервис для управления партнерскими ссылками.

CreatePartnerLink

rpc CreatePartnerLink( CreatePartnerLinkRequest ) returns ( PartnerLink ) Создает партнерскую ссылку для указанного аккаунта. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API: login-account : (Необязательно) Имя ресурса учетной записи, в которой находится учетная запись Google, для которой были предоставлены учетные данные. Если не указано, используется имя учетной записи из запроса. Формат: accountTypes/{loginAccountType}/accounts/{loginAccountId} Области полномочий Требуется один из следующих диапазонов аутентификации OAuth: https://www.googleapis.com/auth/datamanager https://www.googleapis.com/auth/datamanager.partnerlink

УдалитьПартнерскуюСсылку

rpc DeletePartnerLink( DeletePartnerLinkRequest ) returns ( Empty ) Удаляет партнерскую ссылку для указанного аккаунта. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API: login-account : (Необязательно) Имя ресурса учетной записи, в которой находится учетная запись Google, для которой были предоставлены учетные данные. Если не указано, используется имя учетной записи из запроса. Формат: accountTypes/{loginAccountType}/accounts/{loginAccountId} Области полномочий Требуется один из следующих диапазонов аутентификации OAuth: https://www.googleapis.com/auth/datamanager https://www.googleapis.com/auth/datamanager.partnerlink

SearchPartnerLinks

rpc SearchPartnerLinks( SearchPartnerLinksRequest ) returns ( SearchPartnerLinksResponse ) Выполняет поиск всех партнерских ссылок, ведущих к указанному аккаунту и исходящих от него. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API: login-account : (Необязательно) Имя ресурса учетной записи, в которой находится учетная запись Google, для которой были предоставлены учетные данные. Если не указано, используется имя учетной записи из запроса. Формат: accountTypes/{loginAccountType}/accounts/{loginAccountId} Области полномочий Требуется один из следующих диапазонов аутентификации OAuth: https://www.googleapis.com/auth/datamanager https://www.googleapis.com/auth/datamanager.partnerlink

UserListDirectLicenseService

Сервис для управления прямыми лицензиями списка пользователей. Удаление не поддерживается для UserListDirectLicenses. Для деактивации лицензии следует изменить статус лицензии на DISABLED.

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

CreateUserListDirectLicense
rpc CreateUserListDirectLicense( CreateUserListDirectLicenseRequest ) returns ( UserListDirectLicense ) Создает список пользователей и прямую лицензию. Эта функция доступна только партнерам по передаче данных. Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

GetUserListDirectLicense
rpc GetUserListDirectLicense( GetUserListDirectLicenseRequest ) returns ( UserListDirectLicense ) Получает список пользователей и прямую лицензию. Эта функция доступна только партнерам по передаче данных. Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

ListUserListDirectLicenses
rpc ListUserListDirectLicenses( ListUserListDirectLicensesRequest ) returns ( ListUserListDirectLicensesResponse ) Отображает список всех лицензий, принадлежащих родительской учетной записи. Эта функция доступна только партнерам по передаче данных. Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

UpdateUserListDirectLicense
rpc UpdateUserListDirectLicense( UpdateUserListDirectLicenseRequest ) returns ( UserListDirectLicense ) Обновляет список пользователей, предоставляя прямую лицензию. Эта функция доступна только партнерам по передаче данных. Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

UserListGlobalLicenseService

Сервис для управления глобальными лицензиями списка пользователей. Удаление не поддерживается для UserListGlobalLicenses. Для деактивации лицензии следует изменить статус лицензии на DISABLED.

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

CreateUserListGlobalLicense
rpc CreateUserListGlobalLicense( CreateUserListGlobalLicenseRequest ) returns ( UserListGlobalLicense ) Создает глобальную лицензию для списка пользователей. Эта функция доступна только партнерам по передаче данных. Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

GetUserListGlobalLicense
rpc GetUserListGlobalLicense( GetUserListGlobalLicenseRequest ) returns ( UserListGlobalLicense ) Получает список глобальных лицензий пользователей. Эта функция доступна только партнерам по передаче данных. Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

ListUserListGlobalLicenseCustomerInfos

rpc ListUserListGlobalLicenseCustomerInfos( ListUserListGlobalLicenseCustomerInfosRequest ) returns ( ListUserListGlobalLicenseCustomerInfosResponse ) Отображает всю информацию о клиенте для глобальной лицензии, содержащей список пользователей. Эта функция доступна только партнерам по передаче данных. Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

ListUserListGlobalLicenses
rpc ListUserListGlobalLicenses( ListUserListGlobalLicensesRequest ) returns ( ListUserListGlobalLicensesResponse ) Отображает список всех глобальных лицензий пользователей, принадлежащих родительской учетной записи. Эта функция доступна только партнерам по передаче данных. Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

UpdateUserListGlobalLicense
rpc UpdateUserListGlobalLicense( UpdateUserListGlobalLicenseRequest ) returns ( UserListGlobalLicense ) Обновляет глобальную лицензию списка пользователей. Эта функция доступна только партнерам по передаче данных. Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

UserListService

Сервис для управления ресурсами UserList.

CreateUserList

rpc CreateUserList( CreateUserListRequest ) returns ( UserList ) Создает список пользователей. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API: login-account : (Необязательно) Имя ресурса учетной записи, в которой находится учетная запись Google, для которой были предоставлены учетные данные. Если не указано, используется имя учетной записи из запроса. Формат: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account : (Необязательно) Имя ресурса учетной записи с установленной связью продукта с login-account . Формат: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

DeleteUserList

rpc DeleteUserList( DeleteUserListRequest ) returns ( Empty ) Удаляет список пользователей. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API: login-account : (Необязательно) Имя ресурса учетной записи, в которой находится учетная запись Google, для которой были предоставлены учетные данные. Если не указано, используется имя учетной записи из запроса. Формат: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account : (Необязательно) Имя ресурса учетной записи с установленной связью продукта с login-account . Формат: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

GetUserList

rpc GetUserList( GetUserListRequest ) returns ( UserList ) Получает список пользователей (UserList). Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API: login-account : (Необязательно) Имя ресурса учетной записи, в которой находится учетная запись Google, для которой были предоставлены учетные данные. Если не указано, используется имя учетной записи из запроса. Формат: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account : (Необязательно) Имя ресурса учетной записи с установленной связью продукта с login-account . Формат: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

ListUserLists

rpc ListUserLists( ListUserListsRequest ) returns ( ListUserListsResponse ) Отображает списки пользователей. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API: login-account : (Необязательно) Имя ресурса учетной записи, в которой находится учетная запись Google, для которой были предоставлены учетные данные. Если не указано, используется имя учетной записи из запроса. Формат: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account : (Необязательно) Имя ресурса учетной записи с установленной связью продукта с login-account . Формат: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

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

rpc UpdateUserList( UpdateUserListRequest ) returns ( UserList ) Обновляет список пользователей. Заголовки авторизации: Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API: login-account : (Необязательно) Имя ресурса учетной записи, в которой находится учетная запись Google, для которой были предоставлены учетные данные. Если не указано, используется имя учетной записи из запроса. Формат: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account : (Необязательно) Имя ресурса учетной записи с установленной связью продукта с login-account . Формат: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} Области полномочий Требуется следующая область действия OAuth: https://www.googleapis.com/auth/datamanager

AdEvent

Рекламное мероприятие.

Поля
advertiser_id	string Обязательно. Идентификатор рекламодателя для рекламного мероприятия. Этот идентификатор должен совпадать с идентификатором, отправленным в процессе связывания.
event_type	EventType Обязательно. Тип мероприятия.
timestamp	Timestamp Обязательно. Время, когда произошло событие.
event_id	string Необязательный параметр. Идентификатор, созданный и управляемый вызывающей стороной, который однозначно идентифицирует это событие. Этот параметр обязателен, если вы хотите удалить дубликаты рекламных событий, включенных в несколько запросов. В противном случае, это поле необязательно.
user_data	UserData Необязательно. Несколько предоставленных пользователем данных, представляющих пользователя, с которым связано событие. Можно указать несколько экземпляров данных одного типа (например, адрес электронной почты). Чем больше данных, тем выше вероятность обнаружения совпадения.
device_info	DeviceInfo Необязательно. Информация, собранная об устройстве, использовавшемся во время показа рекламы.
mobile_device_id	string Необязательно. Идентификатор устройства, на которое была показана реклама.
campaign_id	string Обязательно. Идентификатор соответствующей кампании.
campaign_name	string Обязательно. Название соответствующей кампании.
ad_group_id	string Необязательно. Идентификатор соответствующей группы объявлений.
ad_id	string Необязательно. Идентификатор соответствующего объявления в группе.
ad_height	int32 Необязательно. Высота объявления в пикселях.
ad_width	int32 Необязательно. Ширина объявления в пикселях.
region_code	string Обязательно. Страна, соответствующая стандарту ISO 3166-2, плюс подразделение.
source	string Обязательно. Источник платформы для показа рекламы, аналогичный источнику данных Google Analytics.
medium	string Обязательно. Тип рекламного объявления, аналогичный типу данных в Google Analytics.
attribution_hint	AttributionHint Необязательно. Предполагаемый статус атрибуции партнера для данного рекламного события. Это служит лишь сигналом того, как проявилось предполагаемое авторство партнера, и не обязывает к определенному результату в итоговых отчетах.
viewability_info	ViewabilityInfo Обязательно. Подробная информация о видимости показываемой рекламы.
Поле объединения event_subtype_oneof . Необязательно. Дополнительная классификация типа рекламного события. Для обработки значений, отличных от чистых перечислений, принимается необработанная строка. По возможности предпочтительнее использовать перечисление. event_subtype_oneof может принимать только одно из следующих значений:
event_subtype	EventSubtype Перечисляемое значение для подтипа события.
event_subtype_string	string Строковое значение для подтипа события.
Поле объединения ad_type_oneof . Необязательно. Тип показываемого объявления. Для обработки значений, отличных от чистых перечислений, принимается необработанная строка. По возможности предпочтительнее использовать перечисление. ad_type_oneof может принимать только одно из следующих значений:
ad_type	AdType Перечисляемое значение для типа объявления.
ad_type_string	string Строковое значение для типа объявления.
Поле объединения ad_format_oneof . Необязательно. Тип показываемого объявления. Для обработки значений, отличных от чистых перечислений, принимается необработанная строка. По возможности предпочтительнее использовать перечисление. ad_format_oneof может принимать только одно из следующих значений:
ad_format	AdFormat Перечисляемое значение для формата объявления.
ad_format_string	string Строковое значение для формата объявления.
Поле объединения ad_placement_oneof . Необязательно. Место размещения показываемой рекламы. Для обработки значений, отличных от чистых перечислений, принимается необработанная строка. По возможности предпочтительнее использовать перечисление. ad_placement_oneof может принимать только одно из следующих значений:
ad_placement	AdPlacement Перечисляемое значение для размещения рекламы.
ad_placement_string	string Строковое значение для размещения рекламы.
Поле объединения targeting_type_oneof . Необязательно. Тип таргетинга, используемый для показа рекламы. Для обработки значений, отличных от чистых перечислений, принимается необработанная строка. По возможности предпочтительнее использовать перечисление. targeting_type_oneof может принимать только одно из следующих значений:
targeting_type	TargetingType Перечисляемое значение для типа таргетинга.
targeting_type_string	string Строковое значение для типа целевого объекта.
Поле объединения platform_type_oneof . Необязательно. Тип платформы, на которой было показано объявление. Для обработки значений, отличных от чистых перечислений, принимается необработанная строка. По возможности предпочтительнее использовать перечисление. platform_type_oneof может принимать только одно из следующих значений:
platform_type	PlatformType Перечисляемое значение для типа платформы.
platform_type_string	string Строковое значение для типа платформы.
Поле объединения platform_oneof . Необязательно. Дополнительная информация о платформе, на которой было показано объявление. Для обработки значений, отличных от чистых перечислений, принимается необработанная строка. По возможности предпочтительнее использовать перечисление. platform_oneof может принимать только одно из следующих значений:
platform	Platform Перечисляемое значение для платформы.
platform_string	string Строковое значение для платформы.
measurement_allowed	bool Необязательный параметр. Указывает, разрешено ли использование данной строки в целях измерения в соответствии с применимыми законами о защите персональных данных в пределах региональной юрисдикции.

Подтип события

Дополнительная классификация по типу рекламного события.

Перечисления
EVENT_SUBTYPE_UNSPECIFIED	Неуказанный подтип события.
EVENT_SUBTYPE_IMPRESSION	Мероприятие, призванное произвести впечатление.
EVENT_SUBTYPE_ENGAGED_VIEW	Событие активного просмотра.
EVENT_SUBTYPE_ONSITE_CLICK	Событие клика на сайте.
EVENT_SUBTYPE_OUTBOUND_CLICK	Событие исходящего клика.

Тип события

Тип мероприятия.

Перечисления
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	Реклама в потоке.
AD_FORMAT_IN_STREAM_SKIPPABLE	Встроенная реклама, которую можно пропустить.
AD_FORMAT_IN_STREAM_NON_SKIPPABLE	Неотключаемая реклама в потоке видео.
AD_FORMAT_NATIVE	Нативная реклама.
AD_FORMAT_SHORTS	Реклама шорт.
AD_FORMAT_STORY	Рекламное объявление.
AD_FORMAT_SPONSORED	Рекламное объявление.
AD_FORMAT_VIDEO	Видеореклама.

AdIdentifiers

Идентификаторы и другая информация, используемая для сопоставления события конверсии с другой онлайн-активностью (например, кликами по рекламе).

Поля
session_attributes	string Необязательно. Атрибуты сессии для атрибуции событий и моделирования.
gclid	string Необязательно. Идентификатор клика Google (gclid), связанный с этим событием.
gbraid	string Необязательный параметр. Идентификатор клика для кликов, связанных с событиями приложения и исходящих с устройств iOS, начиная с iOS 14.
wbraid	string Необязательный параметр. Идентификатор клика для кликов, связанных с веб-событиями и происходящих на устройствах iOS, начиная с iOS 14.
landing_page_device_info	DeviceInfo Необязательно. Информация, собираемая об используемом устройстве (если таковое имелось) в момент перехода на сайт рекламодателя после взаимодействия с рекламой.
mobile_device_id	string Необязательно. Мобильный идентификатор для рекламодателей. В iOS это может быть IDFA, в Android — AdID, или идентификаторы рекламодателей других платформ.
dclid	string Необязательно. Идентификатор клика по экрану, связанный с этим событием.
impression_id	string Необязательно. Идентификатор показа, связанный с этим событием.
match_id	string Необязательно. Поле ID совпадения, используемое для объединения этого события с предыдущим событием.
encrypted_user_ids[]	EncryptedUserId Необязательно. Любое количество зашифрованных идентификаторов пользователей.

Размещение рекламы

Место размещения показанной рекламы.

Перечисления
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	Видеореклама.

Информация об адресе

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

Поля
given_name	string Обязательно. Укажите имя пользователя (в нижнем регистре), без знаков препинания, пробелов в начале и конце, хешированное как SHA-256.
family_name	string Обязательно. Фамилия пользователя, все строчные буквы, без знаков препинания, без пробелов в начале и конце, хешированная как SHA-256.
region_code	string Обязательно. Двухбуквенный региональный код адреса пользователя в формате ISO-3166-1 alpha-2.
postal_code	string Обязательно. Почтовый индекс адреса пользователя.

Возрастной диапазон

Демографические возрастные диапазоны

Перечисления
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	Статус не изменен.

Участник аудитории

Участника аудитории, которому будет проведена операция.

Поля
destination_references[]	string Необязательный параметр. Определяет, в какое Destination следует направить участника аудитории.
consent	Consent Необязательно. Настройки согласия пользователя.
data поля объединения. Тип идентификационных данных, с которыми необходимо выполнить операцию. data могут быть только одним из следующих типов:
user_data	UserData Данные, предоставленные пользователем, позволяющие идентифицировать пользователя.
pair_data	PairData Идентификаторы PAIR (Publisher Advertiser Identity Reconciliation) . Эта функция доступна только партнерам по передаче данных.
mobile_data	MobileData Данные, идентифицирующие мобильные устройства пользователя.
user_id_data	UserIdData Данные, относящиеся к уникальным идентификаторам пользователя, определенным рекламодателем.
ppid_data	PpidData Данные, относящиеся к идентификаторам, предоставленным издателем. Эта функция доступна только партнерам по передаче данных.
composite_data	CompositeData Группа из нескольких типов идентификаторов.

AwsWrappedKeyInfo

Ключ шифрования данных, упакованный в ключ AWS KMS.

Поля
key_type	KeyType Обязательно. Тип алгоритма, используемого для шифрования данных.
role_arn	string Обязательно. Имя ресурса Amazon для роли IAM, которая будет использоваться для доступа к расшифровке KMS. Должно быть в формате arn:{partition}:iam::{account_id}:role/{role_name}
kek_uri	string Обязательно. URI ключа AWS KMS, используемого для расшифровки DEK. Должен быть в формате arn:{partition}:kms:{region}:{account_id}:key/{key_id} или aws-kms://arn:{partition}:kms:{region}:{account_id}:key/{key_id}
encrypted_dek	string Обязательно. Ключ шифрования данных, закодированных в base64.

KeyType

Тип алгоритма, используемого для шифрования данных.

Перечисления
KEY_TYPE_UNSPECIFIED	Тип ключа не указан. Использовать его не следует.
XCHACHA20_POLY1305	Алгоритм XChaCha20-Poly1305

Исходный уровень

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

Поля
baseline поля объединения. Базовое местоположение, с которым сравниваются полученные данные. baseline может быть только одной из следующих:
baseline_location	Location Базовое местоположение запроса. Базовое местоположение представляет собой список запрашиваемых регионов, заданный оператором ИЛИ.
location_auto_detection_enabled	bool Если установить значение true, сервис попытается автоматически определить базовое местоположение для получения аналитических данных.

Расположение

Базовое местоположение запроса. Базовое местоположение указано в списке кодов регионов ISO 3166-1 alpha-2 (OR-list) для запрашиваемых регионов.

Поля
region_codes[]	string Список кодов регионов ISO 3166-1 alpha-2.

CartData

Данные корзины, связанные с событием.

Поля
merchant_id	string Необязательно. Идентификатор торгового центра, связанный с товарами.
merchant_feed_label	string Необязательно. Метка фида Merchant Center, связанная с фидом товаров.
merchant_feed_language_code	string Необязательно. Код языка в ISO 639-1, связанный с фидом товаров в Merchant Center, куда загружаются ваши товары.
transaction_discount	double Необязательно. Сумма всех скидок, связанных с данной транзакцией.
items[]	Item Необязательно. Список предметов, связанных с мероприятием.
coupon_codes[]	string Необязательно. Список промокодов, примененных к корзине. Промокоды на уровне корзины и на уровне товара независимы друг от друга. Если мероприятие предназначено для использования в Google Analytics, укажите только один промокод. Google Analytics игнорирует дополнительные промокоды.

CompositeData

Составные данные, содержащие идентификаторы и связанные с ними данные пользователя. Необходимо наличие хотя бы одного из значений user_data или ip_data .

Поля
user_data	UserData Необязательно. Предоставляемые пользователем данные, идентифицирующие пользователя.
ip_data[]	IpData Необязательно. Данные IP-адреса, отражающие взаимодействие с клиентом, используются для формирования целевой аудитории.

Согласие

Настройки согласия пользователя в соответствии с Законом о цифровых рынках (DMA) .

Поля
ad_user_data	ConsentStatus Необязательный параметр. Указывает, согласен ли пользователь на предоставление данных о пользователе рекламной сети.
ad_personalization	ConsentStatus Необязательный параметр. Указывает, согласен ли пользователь на персонализацию рекламы.

Статус согласия

Указывает, дал ли пользователь согласие, отклонил его или не указал явно.

Перечисления
CONSENT_STATUS_UNSPECIFIED	Не указан.
CONSENT_GRANTED	Предоставленный.
CONSENT_DENIED	Отклонен.

ContactIdInfo

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

Поля
match_rate_percentage	int32 Только для вывода. Коэффициент совпадения для списков пользователей, соответствующих требованиям клиента.
data_source_type	DataSourceType Необязательный. Неизменяемый. Источник данных для загрузки.

КоординаторКлючеваяИнформация

Информация о ключе координатора.

Поля
key_id	string Обязательно. Идентификатор выбранного ключа координатора.

CreatePartnerLinkRequest

Запрос на создание ресурса PartnerLink . Возвращает объект PartnerLink .

Вы можете попробовать этот метод в обозревателе REST API:

Попробуйте с REST.

Поля
parent	string Обязательно. Родительский ресурс, которому принадлежит эта коллекция партнерских ссылок. Формат: accountTypes/{account_type}/accounts/{account}
partner_link	PartnerLink Обязательно. Партнерская ссылка для создания.

CreateUserListDirectLicenseRequest

Запрос на создание ресурса UserListDirectLicense .

Вы можете попробовать этот метод в обозревателе REST API:

Попробуйте с REST.

Поля
parent	string Обязательно. Учетная запись, которой принадлежит лицензируемый список пользователей. Формат должен быть accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}.
user_list_direct_license	UserListDirectLicense Обязательно. Для создания списка пользователей требуется прямая лицензия.

CreateUserListGlobalLicenseRequest

Запрос на создание ресурса UserListGlobalLicense .

Вы можете попробовать этот метод в обозревателе REST API:

Попробуйте с REST.

Поля
parent	string Обязательно. Учетная запись, которой принадлежит лицензируемый список пользователей. Формат должен быть accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}.
user_list_global_license	UserListGlobalLicense Обязательно. Необходимо создать глобальную лицензию для списка пользователей.

CreateUserListRequest

Сообщение запроса для функции CreateUserList.

Вы можете попробовать этот метод в обозревателе REST API:

Попробуйте с REST.

Поля
parent	string Обязательно. Родительская учетная запись, в которой будет создан этот список пользователей. Формат: accountTypes/{account_type}/accounts/{account}
user_list	UserList Обязательно. Список пользователей для создания.
validate_only	bool Необязательный параметр. Если значение равно true, запрос проверяется, но не выполняется.

Пользовательская переменная

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

Поля
variable	string Необязательно. Имя пользовательской переменной для установки. Если переменная не найдена для указанного места назначения, она будет проигнорирована.
value	string Необязательный параметр. Значение, которое будет сохранено для пользовательской переменной.
destination_references[]	string Необязательный параметр. Строка-ссылка, используемая для определения того, в какой из объектов Event.destination_references следует отправить пользовательскую переменную. Если строка пустая, будет использован объект Event.destination_references .

Тип клиента

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

Перечисления
CUSTOMER_TYPE_UNSPECIFIED	Тип клиента не указан. Использовать его не следует.
NEW	Клиент впервые обращается к рекламодателю.
RETURNING	Клиент возвращается к рекламодателю.
REENGAGED	Клиент возобновил взаимодействие с рекламодателем.

CustomerValueBucket

Оценочная стоимость клиента, определяемая рекламодателем.

Перечисления
CUSTOMER_VALUE_BUCKET_UNSPECIFIED	Неуказанный CustomerValueBucket. Использовать его не следует.
LOW	Клиент имеет низкую ценность.
MEDIUM	Клиент относится к категории средней ценности.
HIGH	Клиент имеет высокую ценность.

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

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

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

DeletePartnerLinkRequest

Запрос на удаление ресурса PartnerLink . Возвращает google.protobuf.Empty .

Вы можете попробовать этот метод в обозревателе REST API:

Попробуйте с REST.

Поля
name	string Обязательно. Имя ресурса партнерской ссылки для удаления. Формат: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

DeleteUserListRequest

Сообщение запроса для удаления списка пользователей (DeleteUserList).

Вы можете попробовать этот метод в обозревателе REST API:

Попробуйте с REST.

Поля
name	string Обязательно. Название списка пользователей для удаления. Формат: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
validate_only	bool Необязательный параметр. Если значение равно true, запрос проверяется, но не выполняется.

Место назначения

Продукт Google, в который вы отправляете данные. Например, аккаунт Google Ads.

Поля
reference	string Необязательный параметр. Идентификатор для этого ресурса Destination , уникальный в рамках запроса. Используется для ссылки на этот Destination в запросах IngestEventsRequest и IngestAudienceMembersRequest .
login_account	ProductAccount Необязательно. Учетная запись, используемая для выполнения этого вызова API. Для добавления или удаления данных из operating_account эта login_account должна иметь права на запись в operating_account . Например, учетная запись менеджера operating_account или учетная запись с установленной связью с operating_account .
linked_account	ProductAccount Необязательно. Учетная запись, к которой имеет доступ login_account пользователя, осуществляющего вход, через установленную связь учетных записей. Например, login_account партнера по данным может иметь доступ к linked_account клиента. Партнер может использовать это поле для отправки данных из linked_account в другую operating_account .
operating_account	ProductAccount Обязательно. Учетная запись, на которую следует отправить данные или с которой следует удалить данные.
product_destination_id	string Обязательно. Объект в аккаунте продукта, в который необходимо импортировать данные. Например, идентификатор аудитории Google Ads, идентификатор аудитории Display & Video 360 или идентификатор действия конверсии Google Ads.

Информация об устройстве

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

Поля
user_agent	string Необязательный параметр. Строка user-gent устройства для данного контекста.
ip_address	string Необязательный параметр. IP-адрес устройства для данного контекста. Примечание: Google Ads не поддерживает сопоставление IP-адресов конечных пользователей из Европейской экономической зоны (ЕЭЗ), Великобритании (UK) или Швейцарии (CH). Добавьте логику для условного исключения обмена IP-адресами пользователей из этих регионов и убедитесь, что вы предоставляете пользователям четкую и исчерпывающую информацию о данных, которые вы собираете на своих сайтах, в приложениях и других ресурсах, а также получаете согласие там, где это требуется по закону или в соответствии с применимыми политиками Google. Дополнительные сведения см. на странице «Об импорте данных о конверсиях в офлайн-режиме» .
category	string Необязательно. Категория устройства. Например, «настольный компьютер», «планшет», «мобильный телефон», «смарт-телевизор».
language_code	string Необязательно. Язык, используемый устройством, в формате ISO 639-1.
screen_height	int32 Необязательно. Высота экрана в пикселях.
screen_width	int32 Необязательно. Ширина экрана в пикселях.
operating_system	string Необязательно. Операционная система или платформа устройства.
operating_system_version	string Необязательно. Версия операционной системы или платформы.
model	string Необязательно. Модель устройства.
brand	string Необязательно. Марка устройства.
browser	string Необязательно. Марка или тип браузера.
browser_version	string Необязательно. Версия браузера.

Кодирование

Тип кодирования хешированной идентификационной информации.

Перечисления
ENCODING_UNSPECIFIED	Тип кодировки не указан. Использовать его не следует.
HEX	Шестнадцатеричное кодирование.
BASE64	Кодирование Base64.

EncryptedUserId

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

Поля
encrypted_id	string Обязательно. Зашифрованный буквенно-цифровой идентификатор.
entity_type	EncryptionEntityType Обязательно. Тип объекта шифрования. Он должен соответствовать конфигурации шифрования для показа рекламы или передачи данных.
entity_id	int64 Обязательно. Идентификатор объекта шифрования. Он должен соответствовать конфигурации шифрования для показа рекламы или передачи данных.
source	EncryptionSource Обязательно. Указывает, был ли зашифрованный cookie получен от показа рекламы (макрос %m) или от передачи данных.

EncryptionEntityType

Тип объекта шифрования.

Перечисления
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED	Тип объекта шифрования не указан.
CAMPAIGN_MANAGER_ACCOUNT	Аккаунт Campaign Manager 360.
CAMPAIGN_MANAGER_ADVERTISER	Менеджер кампаний 360 для рекламодателей.
DISPLAY_VIDEO_PARTNER	Партнер Display & Video 360.
DISPLAY_VIDEO_ADVERTISER	Рекламодатель, использующий 360-градусную рекламу в формате Display & Video.
GOOGLE_ADS_CUSTOMER	Клиент Google Ads.
GOOGLE_AD_MANAGER_NETWORK_CODE	Сетевой код Google Ad Manager.

EncryptionSource

Источник шифрования.

Перечисления
ENCRYPTION_SOURCE_UNSPECIFIED	Источник шифрования не указан.
AD_SERVING	Источник шифрования при показе рекламы.
DATA_TRANSFER	Источник шифрования при передаче данных.

EncryptionInfo

Информация для шифрования обрабатываемых данных.

Поля
Поле объединения wrapped_key . Зашифрованный ключ, используемый для шифрования данных. wrapped_key может принимать только одно из следующих значений:
gcp_wrapped_key_info	GcpWrappedKeyInfo Платформа Google Cloud Platform скрыла ключевую информацию.
aws_wrapped_key_info	AwsWrappedKeyInfo Amazon Web Services скрыла ключевую информацию.
coordinator_key_info	CoordinatorKeyInfo Ключевая информация для выбранного координатного ключа. Эта функция не поддерживается для методов IngestEvents , IngestAudienceMembers и RemoveAudienceMembers .

ErrorCount

Количество ошибок по указанной причине.

Поля
record_count	int64 Количество записей, которые не удалось загрузить по указанной причине.
reason	ProcessingErrorReason The error reason of the failed records.

ErrorInfo

Error counts for each type of error.

Поля
error_counts[]	ErrorCount A list of errors and counts per error reason. May not be populated in all cases.

ErrorReason

Error reasons for Data Manager API. NOTE: This enum is not frozen and new values may be added in the future.

Перечисления
ERROR_REASON_UNSPECIFIED	Do not use this default value.
INTERNAL_ERROR	Произошла внутренняя ошибка.
DEADLINE_EXCEEDED	The request took too long to respond.
RESOURCE_EXHAUSTED	Too many requests.
NOT_FOUND	Ресурс не найден.
PERMISSION_DENIED	The user does not have permission or the resource is not found.
INVALID_ARGUMENT	There was a problem with the request.
REQUIRED_FIELD_MISSING	Required field is missing.
INVALID_FORMAT	Format is invalid.
INVALID_HEX_ENCODING	The HEX encoded value is malformed.
INVALID_BASE64_ENCODING	The base64 encoded value is malformed.
INVALID_SHA256_FORMAT	The SHA256 encoded value is malformed.
INVALID_POSTAL_CODE	Postal code is not valid.
INVALID_COUNTRY_CODE	Deprecated: Enum is unused in the Data Manager API. This item is deprecated!
INVALID_ENUM_VALUE	Enum value cannot be used.
INVALID_USER_LIST_TYPE	Type of the user list is not applicable for this request.
INVALID_AUDIENCE_MEMBER	This audience member is not valid.
TOO_MANY_AUDIENCE_MEMBERS	Maximum number of audience members allowed per request is 10,000.
TOO_MANY_USER_IDENTIFIERS	Maximum number of user identifiers allowed per audience member is 10.
TOO_MANY_DESTINATIONS	Maximum number of destinations allowed per request is 10.
INVALID_DESTINATION	This Destination is not valid.
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED	Data Partner does not have access to the operating account owned userlist.
INVALID_MOBILE_ID_FORMAT	Mobile ID format is not valid.
INVALID_USER_LIST_ID	User list is not valid.
MULTIPLE_DATA_TYPES_NOT_ALLOWED	Multiple data types are not allowed to be ingested in a single request.
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER	Destination configs containing a DataPartner login account must have the same login account across all destination configs.
TERMS_AND_CONDITIONS_NOT_SIGNED	Required terms and conditions are not accepted.
INVALID_NUMBER_FORMAT	Invalid number format.
INVALID_CONVERSION_ACTION_ID	Conversion action ID is not valid.
INVALID_CONVERSION_ACTION_TYPE	The conversion action type is not valid.
INVALID_CURRENCY_CODE	The currency code is not supported.
INVALID_EVENT	This event is not valid.
TOO_MANY_EVENTS	Maximum number of events allowed per request is 10,000.
DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS	The destination account is not enabled for enhanced conversions for leads.
DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS	Enhanced conversions can't be used for the destination account because of Google customer data policies. Contact your Google representative..
DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED	The destination account hasn't agreed to the terms for enhanced conversions.
DUPLICATE_DESTINATION_REFERENCE	Two or more destinations in the request have the same reference.
UNSUPPORTED_OPERATING_ACCOUNT_FOR_DATA_PARTNER	Unsupported operating account for data partner authorization.
UNSUPPORTED_LINKED_ACCOUNT_FOR_DATA_PARTNER	Unsupported linked account for data partner authorization.
NO_IDENTIFIERS_PROVIDED	Events data contains no user identifiers or ad identifiers. For Floodlight Event ingestion this error indicates requests contains no ad identifiers.
INVALID_PROPERTY_TYPE	The property type is not supported.
INVALID_STREAM_TYPE	The stream type is not supported.
LINKED_ACCOUNT_ONLY_ALLOWED_WITH_DATA_PARTNER_LOGIN_ACCOUNT	Linked account is only supported when the login account is a DATA_PARTNER account.
OPERATING_ACCOUNT_LOGIN_ACCOUNT_MISMATCH	The login account must be the same as the operating account for the given use case.
EVENT_TIME_INVALID	Event did not occur within the acceptable time window.
RESERVED_NAME_USED	Parameter uses a reserved name.
INVALID_EVENT_NAME	The event name is not supported.
NOT_ALLOWLISTED	The account is not allowlisted for the given feature.
INVALID_REQUEST_ID	The request ID used to retrieve the status of a request is not valid. Status can only be retrieved for requests that succeed and don't have validate_only=true .
MULTIPLE_DESTINATIONS_FOR_GOOGLE_ANALYTICS_EVENT	An event had 2 or more Google Analytics destinations.
FIELD_VALUE_TOO_LONG	Length of the field value is too long.
FIELD_VALUE_TOO_SHORT	Length of the field value is too short.
TOO_MANY_ELEMENTS	Too many elements in a list in the request.
TOO_FEW_ELEMENTS	Too few elements in a list in the request.
ALREADY_EXISTS	The resource already exists.
IMMUTABLE_FIELD_FOR_UPDATE	Attempted to set an immutable field for an update request.
INVALID_RESOURCE_NAME	The resource name is invalid.
INVALID_FILTER	The query filter is invalid.
INVALID_UPDATE_MASK	The update mask is invalid.
INVALID_PAGE_TOKEN	The page token is invalid.
CANNOT_UPDATE_DISABLED_LICENSE	Cannot update a license that has been disabled.
CANNOT_CREATE_LICENSE_FOR_SENSITIVE_USERLIST	Sensitive user lists cannot be licensed to this client.
INSUFFICIENT_COST	Cost too low for this license.
CANNOT_DISABLE_LICENSE	Reseller license cannot be disabled since it is in use.
INVALID_CLIENT_ACCOUNT_ID	Invalid client account id.
PRICING_ONLY_ZERO_COST_ALLOWED	Non-zero cost not allowed for this client account.
PRICE_TOO_HIGH	Cost too high for this license.
CUSTOMER_NOT_ALLOWED_TO_CREATE_LICENSE	Customer not allowed to create license.
INVALID_PRICING_END_DATE	Pricing end date is invalid for this license.
CANNOT_LICENSE_LOGICAL_LIST_WITH_LICENSED_OR_SHARED_SEGMENT	Logical user list with shared or licensed segment cannot be licensed.
MISMATCHED_ACCOUNT_TYPE	Client customer's account type in the request does not match the customer's actual account type.
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_LICENSE_TYPE	License type does not support media share cost.
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_CLIENT_CUSTOMER	Client customer type does not support media share cost.
INVALID_MEDIA_SHARE_COST	Invalid media share cost.
INVALID_COST_TYPE	Invalid cost type.
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_NON_COMMERCE_USER_LIST	UserList type does not support media share cost.
MAX_COST_NOT_ALLOWED	Max cost is only allowed for cost_type MEDIA_SHARE.
COMMERCE_AUDIENCE_CAN_ONLY_BE_DIRECTLY_LICENSED	Commerce audience can only be directly licensed.
INVALID_DESCRIPTION	The description is not valid.
INVALID_DISPLAY_NAME	The display name is not valid.
DISPLAY_NAME_ALREADY_USED	The display name is already being used for another user list for the account.
OWNERSHIP_REQUIRED_FOR_UPDATE	Ownership is required to modify the user list.
USER_LIST_MUTATION_NOT_SUPPORTED	The user list type is read-only and does not support mutation.
SENSITIVE_USER_LIST_IMMUTABLE	A user list which is privacy sensitive or legal rejected cannot be mutated by external users.
BILLABLE_RECORD_COUNT_IMMUTABLE	The remarketing user list's billable record field cannot be modified once it is set.
USER_LIST_NAME_RESERVED	The user list name is reserved for system lists.
ADVERTISER_NOT_ALLOWLISTED_FOR_UPLOADED_DATA	The advertiser needs to be allowlisted to use remarketing lists created from advertiser uploaded data.
UNSUPPORTED_PARTNER_AUDIENCE_SOURCE	The partner audience source is not supported for the user list type.
COMMERCE_PARTNER_NOT_ALLOWED	Setting the commerce_partner field is only supported if the partner_audience_source is COMMERCE_AUDIENCE .
UNSUPPORTED_PARTNER_AUDIENCE_INFO	The partner_audience_info field is not supported for the user list type.
PARTNER_MATCH_FOR_MANAGER_ACCOUNT_DISALLOWED	Partner Match user lists cannot be created by manager accounts.
DATA_PARTNER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA	The data partner is not allowlisted for THIRD_PARTY_PARTNER_DATA.
ADVERTISER_TOS_NOT_ACCEPTED	The advertiser has not accepted the partner's terms of service.
ADVERTISER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA	The advertiser is not allowlisted for THIRD_PARTY_PARTNER_DATA.
USER_LIST_TYPE_NOT_SUPPORTED_FOR_ACCOUNT	This user list type is not supported for this account.
INVALID_COMMERCE_PARTNER	The commerce_partner field is invalid.
CUSTOMER_NOT_ALLOWLISTED_FOR_COMMERCE_AUDIENCE	The data provider is not allowlisted to create commerce audiences.
UNSUPPORTED_USER_LIST_UPLOAD_KEY_TYPES	The user list upload key types are not supported.
UNSUPPORTED_INGESTED_USER_LIST_INFO_CONFIG	The ingested user list info config is not supported.
UNSUPPORTED_ACCOUNT_TYPES_FOR_USER_LIST_TYPE	The account types are not supported for the user list type.
UNSUPPORTED_ACCOUNT_TYPE_FOR_PARTNER_LINK	The account types are not supported for the partner link.
MEMBERSHIP_DURATION_TOO_LONG	The user list membership duration is too long.
INVALID_MERCHANT_ID	The merchant_id field is not valid.
EU_POLITICAL_ADVERTISING_DECLARATION_REQUIRED	The customer contains non-exempt campaigns without the EU political advertising declaration.
ACCOUNT_INELIGIBLE_FOR_STORE_SALES	Account is not eligible for Store Sales.
INVALID_MERCHANT_FEED_LANGUAGE_CODE	The merchant feed language code is not valid.
INVALID_REGION_CODE	The region code is not valid.
INVALID_SUBDIVISION_CODE	The subdivision code is not valid.
INVALID_SUBCONTINENT_CODE	The subcontinent code is not valid.
INVALID_CONTINENT_CODE	The continent code is not valid.
INVALID_DEVICE_CATEGORY	The device category is not valid.
BOTH_CLIENT_ID_AND_APP_INSTANCE_ID_NOT_ALLOWED	Both app_instance_id and client_id are set.
GOOGLE_ANALYTICS_SUBPROPERTY_OR_ROLLUP_PROPERTY_NOT_ALLOWED	The Google Analytics property is a subproperty or rollup property.
THIRD_PARTY_USER_DATA_NOT_ALLOWED	Third party user data can only be set by data partners.
INVALID_COUPON_CODE	The coupon code is not valid.
EVENT_SOURCE_AND_DESTINATION_MISMATCH	The event source type does not match the destination type.
DESTINATION_ACCOUNT_TYPE_MISMATCH	The destination account type does not match the specified account id.
CUSTOM_VARIABLE_VALUE_CONTAINS_PII	The custom variable value contains personally identifiable information (PII).
CUSTOM_VARIABLE_NOT_ENABLED	The custom variable is not enabled.
INVALID_CUSTOM_VARIABLE_VALUE	The custom variable's value is invalid.
CUSTOM_VARIABLE_NOT_FOUND	The destination does not have a custom variable with a name that matches the specified variable .
BASELINE_LOCATION_AUTO_DETECTION_FAILED	The location_auto_detection_enabled field of the request was set to true , but auto detection of baseline location failed.
INSIGHTS_MISSING_FOR_DIMENSION	Insights missing for this dimension.

Событие

An event representing a user interaction with an advertiser's website or app.

Поля
destination_references[]	string Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.
transaction_id	string Optional. The unique identifier for this event. Required for events sent as an additional data source for tag conversions.
event_timestamp	Timestamp Required. The time the event occurred.
last_updated_timestamp	Timestamp Optional. The last time the event was updated.
user_data	UserData Optional. Pieces of user provided data, representing the user the event is associated with.
consent	Consent Optional. Information about whether the associated user has provided different types of consent.
ad_identifiers	AdIdentifiers Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).
currency	string Optional. The currency code associated with all monetary values within this event.
event_source	EventSource Optional. Signal for where the event happened (web, app, in-store, etc.).
event_device_info	DeviceInfo Optional. Information gathered about the device being used (if any) when the event happened.
cart_data	CartData Optional. Information about the transaction and items associated with the event.
custom_variables[]	CustomVariable Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).
experimental_fields[]	ExperimentalField Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.
user_properties	UserProperties Optional. Advertiser-assessed information about the user at the time that the event happened.
event_name	string Optional. The name of the event. Required for GA4 events.
client_id	string Optional. A unique identifier for the user instance of a web client for this GA4 web stream.
user_id	string Optional. A unique identifier for a user, as defined by the advertiser.
additional_event_parameters[]	EventParameter Optional. A bucket of any event parameters to be included within the event that were not already specified using other structured fields.
third_party_user_data	UserData Optional. The same type of data provided in user_data, but explicitly flagged as being provided as owned by a third-party and not first-party advertiser data.
event_location	EventLocation Optional. Information gathered about the location of the user when this event occurred.
app_instance_id	string Optional. A unique identifier for the user instance of an app client for this GA4 app stream.
conversion_value	double Optional. The conversion value associated with the event, for value-based conversions.
conversion_count	double Optional. The conversion quantity associated with the event, for counting-based conversions.

EventLocation

The location where the event occurred.

Поля
store_id	string Optional. Required for Store Sales. The identifier to represent a physical store where the event happened.
city	string Optional. The name of the city where the event occurred.
subdivision_code	string Optional. The ISO 3166-2 subdivision code where the event occurred.
region_code	string Optional. The 2-letter CLDR region code of the user's address.
subcontinent_code	string Optional. The subcontinent code in UN M49 format where the event occurred.
continent_code	string Optional. The continent code in UN M49 format where the event occurred.

EventParameter

Event parameter for GA4 events.

Поля
parameter_name	string Required. The name of the parameter to use.
value	string Required. The string representation of the value of the parameter to set.

EventSource

The source of the event.

Перечисления
EVENT_SOURCE_UNSPECIFIED	Unspecified EventSource. Should never be used.
WEB	The event was generated from a web browser.
APP	The event was generated from an app.
IN_STORE	The event was generated from an in-store transaction.
PHONE	The event was generated from a phone call.
MESSAGE	The event was generated from a message.
OTHER	The event was generated from other sources.

ExperimentalField

Experimental field representing unofficial fields.

Поля
field	string Optional. The name of the field to use.
value	string Optional. The value the field to set.

Набор функций

The set of supported features for a partner link.

Перечисления
FEATURE_SET_UNSPECIFIED	Unspecified feature set. If unspecified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT .
FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT	Indicates a link used for audience and event management.
FEATURE_SET_AD_EVENT_MANAGEMENT	Indicates a link used for ad event management.

GcpWrappedKeyInfo

Information about the Google Cloud Platform wrapped key.

Поля
key_type	KeyType Required. The type of algorithm used to encrypt the data.
wip_provider	string Required. The Workload Identity pool provider required to use KEK.
kek_uri	string Required. Google Cloud Platform Cloud Key Management Service resource ID . Should be in the format of projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key} or gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}
encrypted_dek	string Required. The base64 encoded encrypted data encryption key.

KeyType

The type of algorithm used to encrypt the data.

Перечисления
KEY_TYPE_UNSPECIFIED	Unspecified key type. Should never be used.
XCHACHA20_POLY1305	Algorithm XChaCha20-Poly1305

Пол

The type of demographic genders (for example, female).

Перечисления
GENDER_UNSPECIFIED	Не указан.
GENDER_UNKNOWN	Неизвестный.
GENDER_MALE	Мужской.
GENDER_FEMALE	Женский.

GetUserListDirectLicenseRequest

Request to get a UserListDirectLicense resource.

You can try this method in the REST APIs explorer:

Try it with REST

Поля
name	string Required. The resource name of the user list direct license.

GetUserListGlobalLicenseRequest

Request to get a UserListGlobalLicense resource.

You can try this method in the REST APIs explorer:

Try it with REST

Поля
name	string Required. The resource name of the user list global license.

GetUserListRequest

Request message for GetUserList.

You can try this method in the REST APIs explorer:

Try it with REST

Поля
name	string Required. The resource name of the UserList to retrieve. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

IngestAdEventsRequest

Request to upload ad events.

You can try this method in the REST APIs explorer:

Try it with REST

Поля
ad_events[]	AdEvent Required. Required (at least 1). A list of ad events.
encryption_info	EncryptionInfo Optional. Information about encryption keys which are used to encrypt the data.
validate_only	bool Optional. If true, the request is validated, but not executed.

IngestAdEventsResponse

This type has no fields.

Response from an ad event ingestion operation.

IngestAudienceMembersRequest

Request to upload audience members to the provided destinations. Returns an IngestAudienceMembersResponse .

You can try this method in the REST APIs explorer:

Try it with REST

Поля
destinations[]	Destination Required. The list of destinations to send the audience members to.
audience_members[]	AudienceMember Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request.
consent	Consent Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each AudienceMember .
validate_only	bool Optional. For testing purposes. If true , the request is validated but not executed. Only errors are returned, not results.
encoding	Encoding Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non UserData uploads, this field is ignored.
encryption_info	EncryptionInfo Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.
terms_of_service	TermsOfService Optional. The terms of service that the user has accepted/rejected.

IngestAudienceMembersResponse

Response from the IngestAudienceMembersRequest .

Поля
request_id	string The auto-generated ID of the request.

IngestEventsRequest

Request to upload audience members to the provided destinations. Returns an IngestEventsResponse .

You can try this method in the REST APIs explorer:

Try it with REST

Поля
destinations[]	Destination Required. The list of destinations to send the events to.
events[]	Event Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request.
consent	Consent Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each Event .
validate_only	bool Optional. For testing purposes. If true , the request is validated but not executed. Only errors are returned, not results.
encoding	Encoding Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non UserData uploads, this field is ignored.
encryption_info	EncryptionInfo Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.

IngestEventsResponse

Response from the IngestEventsRequest .

Поля
request_id	string The auto-generated ID of the request.

IngestedUserListInfo

Represents a user list that is populated by user provided data.

Поля
upload_key_types[]	UploadKeyType Required. Immutable. Upload key types of this user list.
contact_id_info	ContactIdInfo Optional. Additional information when CONTACT_ID is one of the upload_key_types .
mobile_id_info	MobileIdInfo Optional. Additional information when MOBILE_ID is one of the upload_key_types .
user_id_info	UserIdInfo Optional. Additional information when USER_ID is one of the upload_key_types .
pair_id_info	PairIdInfo Optional. Additional information when PAIR_ID is one of the upload_key_types . This feature is only available to data partners.
pseudonymous_id_info	PseudonymousIdInfo Optional. Additional information for PSEUDONYMOUS_ID is one of the upload_key_types .
partner_audience_info	PartnerAudienceInfo Optional. Additional information for partner audiences. This feature is only available to data partners.

UploadKeyType

Enum containing the possible upload key types of a user list.

Перечисления
UPLOAD_KEY_TYPE_UNSPECIFIED	Не указан.
CONTACT_ID	Customer info such as email address, phone number or physical address.
MOBILE_ID	Mobile advertising ids.
USER_ID	Third party provided user ids.
PAIR_ID	Publisher advertiser identity reconciliation ids.
PSEUDONYMOUS_ID	Data Management Platform IDs: - Google User ID - Partner Provided ID - Publisher Provided ID - iOS IDFA - Android advertising ID - Roku ID - Amazon Fire TV ID - Xbox or Microsoft ID

IpData

IP address information for a user. We recommend including observe_start_time and observe_end_time to help improve Customer Match match rates.

Поля
ip_address	string Required. IP address captured at the time of customer interaction. Accepts standard string formats for both IPv4 and IPv6.
observe_start_time	Timestamp Optional. First recorded interaction time from this IP address in a session.
observe_end_time	Timestamp Optional. Last recorded interaction time from this IP address in a session.

Элемент

Represents an item in the cart associated with the event.

Поля
merchant_product_id	string Optional. The product ID within the Merchant Center account.
quantity	int64 Optional. The number of this item associated with the event.
unit_price	double Optional. The unit price excluding tax, shipping, and any transaction level discounts.
item_id	string Optional. A unique identifier to reference the item.
additional_item_parameters[]	ItemParameter Optional. A bucket of any event parameters related to an item to be included within the event that were not already specified using other structured fields.
merchant_id	string Optional. The Merchant Center ID associated with the item. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.
merchant_feed_label	string Optional. The feed label of the Merchant Center feed. If countries are still being used, the 2-letter country code in ISO-3166-1 alpha-2 can be used instead. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.
merchant_feed_language_code	string Optional. The language code in ISO 639-1 associated with the Merchant Center feed where your items are uploaded.
custom_variables[]	ItemCustomVariable Optional. Additional key/value pair information to send to the conversion containers (conversion action or Floodlight activity), when tracking per-item conversions.
conversion_value	double Optional. The conversion value associated with this item within the event, for cases where the conversion value is different for each item.

ItemCustomVariable

Item-level custom variable for ads conversions.

Поля
variable	string Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored.
value	string Optional. The value to store for the custom variable.
destination_references[]	string Optional. Reference string used to determine which of the Event.destination_references the custom variable should be sent to. If empty, the Event.destination_references will be used.

ItemParameter

A bucket of any event parameters related to an item to be included within the event that were not already specified using other structured fields.

Поля
parameter_name	string Required. The name of the parameter to use.
value	string Required. The string representation of the value of the parameter to set.

ListUserListDirectLicensesRequest

Request to list all UserListDirectLicense resources for a given account.

You can try this method in the REST APIs explorer:

Try it with REST

Поля
parent	string Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
filter	string Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123 ). Fields must be specified using either all camel case or all snake case . Don't use a combination of camel case and snake case. Supported Operations: AND = != > >= < <= Supported Functions: - IN(field, value1, value2, ...) : returns true if the field matches any of the values. Example: IN(user_list_id, 123, 456) Unsupported Fields: name (use get method instead) historical_pricings and all its subfields pricing.start_time pricing.end_time
page_size	int32 Optional. The maximum number of licenses to return per page. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string Optional. A page token, received from a previous ListUserListDirectLicense call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

ListUserListDirectLicensesResponse

Response from the ListUserListDirectLicensesRequest .

Поля
user_list_direct_licenses[]	UserListDirectLicense The licenses for the given user list in the request.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListUserListGlobalLicenseCustomerInfosRequest

Request to list all UserListGlobalLicenseCustomerInfo resources for a given user list global license.

You can try this method in the REST APIs explorer:

Try it with REST

Поля
parent	string Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID} . To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/- )
filter	string Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123 ). Fields must be specified using either all camel case or all snake case . Don't use a combination of camel case and snake case. Supported Operations: AND = != > >= < <= Supported Functions: - IN(field, value1, value2, ...) : returns true if the field matches any of the values. Example: IN(user_list_id, 123, 456) Unsupported Fields: name (use get method instead) historical_pricings and all its subfields pricing.start_time pricing.end_time
page_size	int32 Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string Optional. A page token, received from a previous ListUserListDirectLicense call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

ListUserListGlobalLicenseCustomerInfosResponse

Response from the [ListUserListGlobalLicensesCustomerInfoRequest][google.ads.datamanager.v1.ListUserListGlobalLicensesCustomerInfoRequest].

Поля
user_list_global_license_customer_infos[]	UserListGlobalLicenseCustomerInfo The customer information for the given license in the request.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListUserListGlobalLicensesRequest

Request to list all UserListGlobalLicense resources for a given account.

You can try this method in the REST APIs explorer:

Try it with REST

Поля
parent	string Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
filter	string Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123 ). Fields must be specified using either all camel case or all snake case . Don't use a combination of camel case and snake case. Supported Operations: AND = != > >= < <= Supported Functions: - IN(field, value1, value2, ...) : returns true if the field matches any of the values. Example: IN(user_list_id, 123, 456) Unsupported Fields: name (use get method instead) historical_pricings and all its subfields pricing.start_time pricing.end_time
page_size	int32 Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string Optional. A page token, received from a previous ListUserListGlobalLicense call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

ListUserListGlobalLicensesResponse

Response from the ListUserListGlobalLicensesRequest .

Поля
user_list_global_licenses[]	UserListGlobalLicense The licenses for the given user list in the request.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListUserListsRequest

Request message for ListUserLists.

You can try this method in the REST APIs explorer:

Try it with REST

Поля
parent	string Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account}
page_size	int32 Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string Optional. A page token, received from a previous ListUserLists call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserLists must match the call that provided the page token.
filter	string Optional. A filter string . All fields need to be on the left hand side of each condition (for example: display_name = "list 1" ). Fields must be specified using either all camel case or all snake case . Don't use a combination of camel case and snake case. Supported operations: AND = != > >= < <= : (имеет) Supported Functions: - IN(field, value1, value2, ...) : returns true if the field matches any of the values. Example: IN(display_name, "name1", "name2") Supported fields: id display_name description membership_status integration_code access_reason ingested_user_list_info.upload_key_types

ListUserListsResponse

Response message for ListUserLists.

Поля
user_lists[]	UserList The user lists from the specified account.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

MatchRateRange

The match rate range of the upload or userlist.

Перечисления
MATCH_RATE_RANGE_UNKNOWN	The match rate range is unknown.
MATCH_RATE_RANGE_NOT_ELIGIBLE	The match rate range is not eligible.
MATCH_RATE_RANGE_LESS_THAN_20	The match rate range is less than 20% (in the interval [0, 20) ).
MATCH_RATE_RANGE_20_TO_30	The match rate range is between 20% and 30% (in the interval [20, 31) ).
MATCH_RATE_RANGE_31_TO_40	The match rate range is between 31% and 40% (in the interval [31, 41) ).
MATCH_RATE_RANGE_41_TO_50	The match rate range is between 41% and 50% (in the interval [41, 51) ).
MATCH_RATE_RANGE_51_TO_60	The match rate range is between 51% and 60% (in the interval [51, 61) .
MATCH_RATE_RANGE_61_TO_70	The match rate range is between 61% and 70% (in the interval [61, 71) ).
MATCH_RATE_RANGE_71_TO_80	The match rate range is between 71% and 80% (in the interval [71, 81) ).
MATCH_RATE_RANGE_81_TO_90	The match rate range is between 81% and 90% (in the interval [81, 91) ).
MATCH_RATE_RANGE_91_TO_100	The match rate range is between 91% and 100% (in the interval [91, 100] ).

MediaQuartile

The amount of the media that was played as discrete quartiles.

Перечисления
MEDIA_QUARTILE_UNSPECIFIED	Unspecified media quartile.
MEDIA_QUARTILE_START	Начинать.
MEDIA_QUARTILE_FIRST_QUARTILE	First quartile.
MEDIA_QUARTILE_MIDPOINT	Midpoint.
MEDIA_QUARTILE_THIRD_QUARTILE	Third quartile.
MEDIA_QUARTILE_COMPLETE	Полный.

MobileData

Mobile IDs for the audience. At least one mobile ID is required.

Поля
mobile_ids[]	string Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 mobileIds can be provided in a single AudienceMember .

MobileIdInfo

Additional information when MOBILE_ID is one of the upload_key_types .

Поля
data_source_type	DataSourceType Optional. Immutable. Source of the upload data.
key_space	KeySpace Required. Immutable. The key space of mobile IDs.
app_id	string Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.

KeySpace

Key space for mobile ID.

Перечисления
KEY_SPACE_UNSPECIFIED	Не указан.
IOS	The iOS keyspace.
ANDROID	The Android keyspace.

PairData

PAIR IDs for the audience. At least one PAIR ID is required.

This feature is only available to data partners.

Поля
pair_ids[]	string Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with an EC commutative cipher using publisher key for the PAIR user list. At most 10 pairIds can be provided in a single AudienceMember .

PairIdInfo

Additional information when PAIR_ID is one of the upload_key_types .

This feature is only available to data partners.

Поля
publisher_id	int64 Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.
publisher_name	string Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
match_rate_percentage	int32 Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
advertiser_identifier_count	int64 Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
clean_room_identifier	string Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.

PartnerAudienceInfo

Additional information for partner audiences.

This feature is only available to data partners.

Поля
partner_audience_source	PartnerAudienceSource Required. Immutable. The source of the partner audience.
commerce_partner	string Optional. The commerce partner name. Only allowed if partner_audience_source is COMMERCE_AUDIENCE .

PartnerAudienceSource

Partner audience source.

Перечисления
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED	Не указан.
COMMERCE_AUDIENCE	Partner Audience source is commerce audience.
LINEAR_TV_AUDIENCE	Partner Audience source is linear TV audience.
AGENCY_PROVIDER_AUDIENCE	Partner Audience source is agency/provider audience.

PartnerCustomerAccount

Represents a customer account in the partner's system.

Поля
account_id	string Required. The identifier of the customer account in the partner's ID space.
account_name	string Optional. The name of the account.
account_type	string Optional. The type of the account. Can be used to distinguish between advertiser accounts and business level accounts, for example.

PartnerLink

A partner link between an owning account and a partner account.

Поля
name	string Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}
partner_link_id	string Output only. The partner link ID.
owning_account	ProductAccount Required. The owning account granting access to the partner account.
partner_account	ProductAccount Required. The partner account granted access by the owning account.
feature_set	FeatureSet Optional. Immutable. The set of features supported for the partner link. If not specified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT .
partner_customer_account	PartnerCustomerAccount Optional. The customer account in the partner system. This is required for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set.
partner_link_metadata	PartnerLinkMetadata Optional. Metadata associated with the partner link. This is optional and only accepted for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT .

PartnerLinkMetadata

Represents metadata associated with a partner link.

Поля
implicit_accounts[]	PartnerCustomerAccount Optional. The list of implicit accounts.

Платформа

Further detail of the platform on which the ad was served.

Перечисления
PLATFORM_UNSPECIFIED	Unspecified platform.
PLATFORM_IOS	iOS platform.
PLATFORM_ANDROID	Android platform.
PLATFORM_WEB	Web platform.

PlatformType

The type of the platform on which the ad was served.

Перечисления
PLATFORM_TYPE_UNSPECIFIED	Unspecified platform type.
PLATFORM_TYPE_MOBILE	Mobile platform.
PLATFORM_TYPE_DESKTOP	Desktop platform.
PLATFORM_TYPE_CTV	CTV platform.
PLATFORM_TYPE_PHONE	Phone platform.
PLATFORM_TYPE_TABLET	Tablet platform.

PpidData

Publisher provided identifiers data holding the ppids. At least one ppid is required.

This feature is only available to data partners.

Поля
ppids[]	string Required. The list of publisher provided identifiers for a user.

ProcessingErrorReason

The processing error reason. New reasons may be added in the future.

Перечисления
PROCESSING_ERROR_REASON_UNSPECIFIED	The processing error reason is unknown.
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE	The custom variable is invalid.
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED	The status of the custom variable is not enabled.
PROCESSING_ERROR_REASON_EVENT_TOO_OLD	The conversion is older than max supported age.
PROCESSING_ERROR_REASON_DENIED_CONSENT	The ad user data is denied, either by the user or in the advertiser default settings.
PROCESSING_ERROR_REASON_NO_CONSENT	Advertiser did not give 3P consent for the Ads core platform services.
PROCESSING_ERROR_REASON_UNKNOWN_CONSENT	The overall consent (determined from row level consent, request level consent, and account settings) could not be determined for this user
PROCESSING_ERROR_REASON_DUPLICATE_GCLID	A conversion with the same GCLID and conversion time already exists in the system.
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID	A conversion with the same order id and conversion action combination was already uploaded.
PROCESSING_ERROR_REASON_INVALID_GBRAID	The gbraid could not be decoded.
PROCESSING_ERROR_REASON_INVALID_GCLID	The google click ID could not be decoded.
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID	Merchant id contains non-digit characters.
PROCESSING_ERROR_REASON_INVALID_WBRAID	The wbraid could not be decoded.
PROCESSING_ERROR_REASON_INTERNAL_ERROR	Внутренняя ошибка.
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED	Enhanced conversions terms are not signed in the destination account.
PROCESSING_ERROR_REASON_INVALID_EVENT	The event is invalid.
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS	The matched transactions are less than the minimum threshold.
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS	The transactions are less than the minimum threshold.
PROCESSING_ERROR_REASON_INVALID_FORMAT	The event has format error.
PROCESSING_ERROR_REASON_DECRYPTION_ERROR	The event has a decryption error.
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR	The DEK failed to be decrypted.
PROCESSING_ERROR_REASON_INVALID_WIP	The WIP is formatted incorrectly or the WIP does not exist.
PROCESSING_ERROR_REASON_INVALID_KEK	The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED	The WIP could not be used because it was rejected by its attestation condition.
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED	The system did not have the permissions needed to access the KEK.
PROCESSING_ERROR_REASON_AWS_AUTH_FAILED	The system failed to authenticate with AWS.
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR	Failed to decrypt the UserIdentifier data using the DEK.
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER	The user attempted to ingest events with an ad identifier that isn't from the operating account's ads.
PROCESSING_ERROR_REASON_ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID	One-per-click conversion actions cannot be used with BRAIDs.
PROCESSING_ERROR_REASON_MATCH_ID_NOT_FOUND	The match ID can not be found.
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_MATCH_ID	The user ID can not be found for the match ID.
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_GCLID	The user ID can not be found for the GCLID.
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_DCLID	The user ID can not be found for the DCLID.
PROCESSING_ERROR_REASON_INVALID_AD_IDENTIFIERS	There are ad identifiers that are invalid.
PROCESSING_ERROR_REASON_INVALID_MOBILE_ID_FORMAT	The mobile ID format is invalid.
PROCESSING_ERROR_REASON_ORIGINAL_CONVERSIONS_NOT_FOUND	The original conversions can't be found.
PROCESSING_ERROR_REASON_EVENT_ID_DECODE_ERROR	The event ID (dclid or impression ID) cannot be decoded.
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_IMPRESSION_ID	The user ID cannot be found for the given impression ID.
PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND	The user ID cannot be found.
PROCESSING_ERROR_REASON_CONVERSION_PRECEDES_CLICK	The event timestamp on the event was earlier than the associated click.
PROCESSING_ERROR_REASON_TOO_RECENT_CLICK	The click occurred too recently.
PROCESSING_ERROR_REASON_INVALID_CLICK	The event can't be attributed to a click (GCLID). This may be because the click did not come from a Google Ads campaign, for example.
PROCESSING_ERROR_REASON_INVALID_OPERATING_ACCOUNT_FOR_CLICK	The click from the event isn't associated with the operating_account of the destination.
PROCESSING_ERROR_REASON_CLICK_NOT_FOUND	A corresponding click can't be found that matches the provided attributes.
PROCESSING_ERROR_REASON_EXTERNAL_ATTRIBUTION_DATA_MISSING	External attribution data is missing. Sending events to a destination for an external attribution conversion action isn't supported.

ProcessingWarningReason

The processing warning reason.

Перечисления
PROCESSING_WARNING_REASON_UNSPECIFIED	The processing warning reason is unknown.
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED	The system did not have the permissions needed to access the KEK.
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR	The DEK failed to be decrypted.
PROCESSING_WARNING_REASON_DECRYPTION_ERROR	The event has a decryption error.
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED	The WIP could not be used because it was rejected by its attestation condition.
PROCESSING_WARNING_REASON_INVALID_WIP	The WIP is formatted incorrectly or the WIP does not exist.
PROCESSING_WARNING_REASON_INVALID_KEK	The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR	Failed to decrypt the UserIdentifier data using the DEK.
PROCESSING_WARNING_REASON_INTERNAL_ERROR	Внутренняя ошибка.
PROCESSING_WARNING_REASON_AWS_AUTH_FAILED	The system failed to authenticate with AWS.

Продукт

This item is deprecated!

Deprecated. Use AccountType instead. Represents a specific Google product.

Перечисления
PRODUCT_UNSPECIFIED	Unspecified product. Should never be used.
GOOGLE_ADS	Google Ads.
DISPLAY_VIDEO_PARTNER	Display & Video 360 partner.
DISPLAY_VIDEO_ADVERTISER	Display & Video 360 advertiser.
DATA_PARTNER	Data Partner.

ProductAccount

Represents a specific account.

Поля
product (deprecated)	Product This item is deprecated! Deprecated. Use account_type instead.
account_id	string Required. The ID of the account. For example, your Google Ads account ID.
account_type	AccountType Required. The type of the account. For example, GOOGLE_ADS . Either account_type or the deprecated product is required. If both are set, the values must match.

AccountType

Represents Google account types. Used to locate accounts and destinations.

Перечисления
ACCOUNT_TYPE_UNSPECIFIED	Unspecified product. Should never be used.
GOOGLE_ADS	Google Ads.
DISPLAY_VIDEO_PARTNER	Display & Video 360 partner.
DISPLAY_VIDEO_ADVERTISER	Display & Video 360 advertiser.
DATA_PARTNER	Data Partner.
GOOGLE_ANALYTICS_PROPERTY	Google Analytics.
GOOGLE_AD_MANAGER_AUDIENCE_LINK	Google Ad Manager audience link.
FLOODLIGHT_CONFIG	Floodlight configuration.

PseudonymousIdInfo

Additional information when PSEUDONYMOUS_ID is one of the upload_key_types .

Поля
sync_status	SyncStatus Output only. Sync status of the user list.
billable_record_count	int64 Optional. Immutable. The number of billable records (eg uploaded or matched).

SyncStatus

Sync status of the user list.

Перечисления
SYNC_STATUS_UNSPECIFIED	Не указан.
CREATED	The user list has been created as a placeholder. List contents and/or metadata are still being synced. The user list is not ready for use.
READY_FOR_USE	The user list is ready for use. Contents and cookies have been synced correctly.
FAILED	An error has occurred syncing user list contents and/or metadata. The user list cannot be used.

RemoveAudienceMembersRequest

Request to remove users from an audience in the provided destinations. Returns a RemoveAudienceMembersResponse .

You can try this method in the REST APIs explorer:

Try it with REST

Поля
destinations[]	Destination Required. The list of destinations to remove the users from.
audience_members[]	AudienceMember Required. The list of users to remove.
validate_only	bool Optional. For testing purposes. If true , the request is validated but not executed. Only errors are returned, not results.
encoding	Encoding Optional. Required for UserData uploads. The encoding type of the user identifiers. Applies to only the outer encoding for encrypted user identifiers. For non UserData uploads, this field is ignored.
encryption_info	EncryptionInfo Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.

RemoveAudienceMembersResponse

Response from the RemoveAudienceMembersRequest .

Поля
request_id	string The auto-generated ID of the request.

RequestStatusPerDestination

A request status per destination.

Поля
destination	Destination A destination within a DM API request.
request_status	RequestStatus The request status of the destination.
error_info	ErrorInfo An error info error containing the error reason and error counts related to the upload. Only populated if the request_status is FAILED or PARTIAL_SUCCESS . This field isn't populated while the request has request_status of PROCESSING .
warning_info	WarningInfo A warning info containing the warning reason and warning counts related to the upload. This field isn't populated while the request has request_status of PROCESSING .
Union field status . The status of the destination. status can be only one of the following:
audience_members_ingestion_status	IngestAudienceMembersStatus The status of the ingest audience members request.
events_ingestion_status	IngestEventsStatus The status of the ingest events request.
audience_members_removal_status	RemoveAudienceMembersStatus The status of the remove audience members request.

Тип данных

The type of data.

Перечисления
DATA_TYPE_UNSPECIFIED	The data type is unspecified.
EMAIL	The data is an email address.
PHONE_NUMBER	The data is a phone number.
ADDRESS	The data is a physical address.
IP_ADDRESS	The data is an IP address.

DataTypeCount

The count for a specific data type.

Поля
type	DataType The type of data.
count	int64 The count for this data type.

IngestAudienceMembersStatus

The status of the ingest audience members request.

Поля
Union field status . The status of the audience members ingestion to the destination. status can be only one of the following:
user_data_ingestion_status	IngestUserDataStatus The status of the user data ingestion to the destination.
mobile_data_ingestion_status	IngestMobileDataStatus The status of the mobile data ingestion to the destination.
pair_data_ingestion_status	IngestPairDataStatus The status of the pair data ingestion to the destination.
user_id_data_ingestion_status	IngestUserIdDataStatus The status of the user id data ingestion to the destination.
ppid_data_ingestion_status	IngestPpidDataStatus The status of the ppid data ingestion to the destination.
composite_data_ingestion_status	IngestCompositeDataStatus The status of the composite data ingestion to the destination.

IngestCompositeDataStatus

The status of the composite data ingestion to the destination containing stats related to the ingestion.

Поля
record_count	int64 The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.
data_type_counts[]	DataTypeCount The total count of data types sent in the upload request for the destination, broken down by data type. Includes all data types in the request, regardless of whether they were successfully ingested or not.
upload_match_rate_range	MatchRateRange The match rate range of the upload.

IngestEventsStatus

The status of the events ingestion to the destination.

Поля
record_count	int64 The total count of events sent in the upload request. Includes all events in the request, regardless of whether they were successfully ingested or not.

IngestMobileDataStatus

The status of the mobile data ingestion to the destination containing stats related to the ingestion.

Поля
record_count	int64 The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.
mobile_id_count	int64 The total count of mobile ids sent in the upload request for the destination. Includes all mobile ids in the request, regardless of whether they were successfully ingested or not.

IngestPairDataStatus

The status of the pair data ingestion to the destination containing stats related to the ingestion.

Поля
record_count	int64 The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.
pair_id_count	int64 The total count of pair ids sent in the upload request for the destination. Includes all pair ids in the request, regardless of whether they were successfully ingested or not.

IngestPpidDataStatus

The status of the ppid data ingestion to the destination containing stats related to the ingestion.

Поля
record_count	int64 The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.
ppid_count	int64 The total count of ppids sent in the upload request for the destination. Includes all ppids in the request, regardless of whether they were successfully ingested or not.

IngestUserDataStatus

The status of the user data ingestion to the destination containing stats related to the ingestion.

Поля
record_count	int64 The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.
user_identifier_count	int64 The total count of user identifiers sent in the upload request for the destination. Includes all user identifiers in the request, regardless of whether they were successfully ingested or not.
upload_match_rate_range	MatchRateRange The match rate range of the upload.

IngestUserIdDataStatus

The status of the user id data ingestion to the destination containing stats related to the ingestion.

Поля
record_count	int64 The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.
user_id_count	int64 The total count of user ids sent in the upload request for the destination. Includes all user ids in the request, regardless of whether they were successfully ingested or not.

RemoveAudienceMembersStatus

The status of the remove audience members request.

Поля
Union field status . The status of the audience members removal from the destination. status can be only one of the following:
user_data_removal_status	RemoveUserDataStatus The status of the user data removal from the destination.
mobile_data_removal_status	RemoveMobileDataStatus The status of the mobile data removal from the destination.
pair_data_removal_status	RemovePairDataStatus The status of the pair data removal from the destination.
user_id_data_removal_status	RemoveUserIdDataStatus The status of the user id data removal from the destination.
ppid_data_removal_status	RemovePpidDataStatus The status of the ppid data removal from the destination.
composite_data_removal_status	RemoveCompositeDataStatus The status of the composite data removal from the destination.

RemoveCompositeDataStatus

The status of the composite data removal from the destination.

Поля
record_count	int64 The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.
data_type_counts[]	DataTypeCount The total count of data types sent in the removal request, broken down by data type. Includes all data types in the request, regardless of whether they were successfully removed or not.

RemoveMobileDataStatus

The status of the mobile data removal from the destination.

Поля
record_count	int64 The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.
mobile_id_count	int64 The total count of mobile Ids sent in the removal request. Includes all mobile ids in the request, regardless of whether they were successfully removed or not.

RemovePairDataStatus

The status of the pair data removal from the destination.

Поля
record_count	int64 The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.
pair_id_count	int64 The total count of pair ids sent in the removal request. Includes all pair ids in the request, regardless of whether they were successfully removed or not.

RemovePpidDataStatus

The status of the ppid data removal from the destination.

Поля
record_count	int64 The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.
ppid_count	int64 The total count of ppids sent in the removal request. Includes all ppids in the request, regardless of whether they were successfully removed or not.

RemoveUserDataStatus

The status of the user data removal from the destination.

Поля
record_count	int64 The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.
user_identifier_count	int64 The total count of user identifiers sent in the removal request. Includes all user identifiers in the request, regardless of whether they were successfully removed or not.

RemoveUserIdDataStatus

The status of the user id data removal from the destination.

Поля
record_count	int64 The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.
user_id_count	int64 The total count of user ids sent in the removal request. Includes all user ids in the request, regardless of whether they were successfully removed or not.

RequestStatus

The request status.

Перечисления
REQUEST_STATUS_UNKNOWN	The request status is unknown.
SUCCESS	Processing succeeded for all records without any errors. However, there may be warnings in the warning_info field.
PROCESSING	The request is processing.
FAILED	Processing failed for all records. Check the error_info field for error details, and check the warning_info field for warning details.
PARTIAL_SUCCESS	Processing completed successfully without errors for some records, but failed with errors for other records. Check the error_info field for error details, and check the warning_info field for warning details.

RetrieveInsightsRequest

Request message for DM API MarketingDataInsightsService.RetrieveInsights

You can try this method in the REST APIs explorer:

Try it with REST

Поля
parent	string Required. The parent account that owns the user list. Format: accountTypes/{account_type}/accounts/{account}
baseline	Baseline Required. Baseline for the insights requested.
user_list_id	string Required. The user list ID for which insights are requested.

RetrieveInsightsResponse

Response message for DM API MarketingDataInsightsService.RetrieveInsights

Поля
marketing_data_insights[]	MarketingDataInsight Contains the insights for the marketing data.

MarketingDataInsight

Insights for marketing data.

This feature is only available to data partners.

Поля
dimension	AudienceInsightsDimension The dimension to which the insight belongs.
attributes[]	MarketingDataInsightsAttribute Insights for values of a given dimension.

AudienceInsightsDimension

Possible dimensions for use in generating insights.

Перечисления
AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED	Не указан.
AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN	The value is unknown in this version.
AFFINITY_USER_INTEREST	An Affinity UserInterest.
IN_MARKET_USER_INTEREST	An In-Market UserInterest.
AGE_RANGE	An age range.
GENDER	A gender.

MarketingDataInsightsAttribute

Insights for a collection of related attributes of the same dimension.

Поля
user_interest_id	int64 The user interest ID.
lift	float Measure of lift that the audience has for the attribute value as compared to the baseline. Range [0-1].
age_range	AgeRange Age range of the audience for which the lift is provided.
gender	Gender Gender of the audience for which the lift is provided.

RetrieveRequestStatusRequest

Request to get the status of request made to the DM API for a given request ID. Returns a RetrieveRequestStatusResponse .

You can try this method in the REST APIs explorer:

Try it with REST

Поля
request_id	string Required. Required. The request ID of the Data Manager API request.

RetrieveRequestStatusResponse

Response from the RetrieveRequestStatusRequest .

Поля
request_status_per_destination[]	RequestStatusPerDestination A list of request statuses per destination. The order of the statuses matches the order of the destinations in the original request.

SearchPartnerLinksRequest

Request to search for PartnerLink resources. Returns a SearchPartnerLinksResponse .

You can try this method in the REST APIs explorer:

Try it with REST

Поля
parent	string Required. Account to search for partner links. If no filter is specified, all partner links where this account is either the owning_account or partner_account are returned. Format: accountTypes/{account_type}/accounts/{account}
page_size	int32 The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.
page_token	string A page token, received from a previous SearchPartnerLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchPartnerLinks must match the call that provided the page token.
filter	string Optional. A filter string . All fields need to be on the left hand side of each condition (for example: partner_link_id = 123456789 ). Fields must be specified using either all camel case or all snake case . Don't use a combination of camel case and snake case. Supported operations: AND = != Supported fields: partner_link_id owning_account.account_type owning_account.account_id partner_account.account_type partner_account.account_id Example: owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321

SearchPartnerLinksResponse

Response from the SearchPartnerLinksRequest .

Поля
partner_links[]	PartnerLink The partner links for the given account.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

SizeInfo

Estimated number of members in this user list in different target networks.

Поля
display_network_members_count	int64 Output only. Estimated number of members in this user list, on the Google Display Network.
search_network_members_count	int64 Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns.
youtube_members_count	int64 Output only. Estimated number of members in this user list on YouTube.
gmail_members_count	int64 Output only. Estimated number of members in this user list on Gmail.

TargetNetworkInfo

Eligibility information for different target networks.

Поля
eligible_for_display	bool Output only. Indicates this user list is eligible for Google Display Network.
eligible_for_search	bool Optional. Indicates if this user list is eligible for Google Search Network.

TargetingType

The type of targeting used to serve the ad.

Перечисления
TARGETING_TYPE_UNSPECIFIED	Unspecified targeting type.
TARGETING_TYPE_AUDIENCE	Audience targeting.
TARGETING_TYPE_CONTEXTUAL	Contextual targeting.
TARGETING_TYPE_DEMOGRAPHIC	Demographic targeting.
TARGETING_TYPE_DEVICE	Device targeting.
TARGETING_TYPE_GEO	Geo targeting.
TARGETING_TYPE_INTEREST	Interest targeting.
TARGETING_TYPE_PURCHASE_INTENT	Purchase intent targeting.
TARGETING_TYPE_REMARKETING	Remarketing targeting.

Условия предоставления услуг

The terms of service that the user has accepted/rejected.

Поля
customer_match_terms_of_service_status	TermsOfServiceStatus Optional. The Customer Match terms of service: https://support.google.com/adspolicy/answer/6299717 . This must be accepted when ingesting UserData or MobileData . This field is not required for Partner Match User list.

TermsOfServiceStatus

Represents the caller's decision to accept or reject the terms of service.

Перечисления
TERMS_OF_SERVICE_STATUS_UNSPECIFIED	Не указан.
ACCEPTED	Status indicating the caller has chosen to accept the terms of service.
REJECTED	Status indicating the caller has chosen to reject the terms of service.

UpdateUserListDirectLicenseRequest

Request to update a UserListDirectLicense resource.

You can try this method in the REST APIs explorer:

Try it with REST

Поля
user_list_direct_license	UserListDirectLicense Required. The licenses' name field is used to identify the license to update.
update_mask	FieldMask Optional. The list of fields to update. The special character * is not supported and an INVALID_UPDATE_MASK error will be thrown if used.

UpdateUserListGlobalLicenseRequest

Request to update a UserListGlobalLicense resource.

You can try this method in the REST APIs explorer:

Try it with REST

Поля
user_list_global_license	UserListGlobalLicense Required. The licenses' name field is used to identify the license to update.
update_mask	FieldMask Optional. The list of fields to update. The special character * is not supported and an INVALID_UPDATE_MASK error will be thrown if used.

UpdateUserListRequest

Request message for UpdateUserList.

You can try this method in the REST APIs explorer:

Try it with REST

Поля
user_list	UserList Required. The user list to update. The user list's name field is used to identify the user list to update. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
update_mask	FieldMask Optional. The list of fields to update.
validate_only	bool Optional. If true, the request is validated but not executed.

Пользовательские данные

Data that identifies the user. At least one identifier is required.

Поля
user_identifiers[]	UserIdentifier Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 userIdentifiers can be provided in a single AudienceMember or Event .

UserIdData

User id data holding the user id.

Поля
user_id	string Required. A unique identifier for a user, as defined by the advertiser.

UserIdInfo

Additional information when USER_ID is one of the upload_key_types .

Поля
data_source_type	DataSourceType Optional. Immutable. Source of the upload data.

UserIdentifier

A single identifier for the user.

Поля
Union field identifier . Exactly one must be specified. identifier can be only one of the following:
email_address	string Hashed email address using SHA-256 hash function after normalization.
phone_number	string Hashed phone number using SHA-256 hash function after normalization (E164 standard).
address	AddressInfo The known components of a user's address. Holds a grouping of identifiers that are matched all at once.

UserList

A user list resource.

Поля
name	string Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
id	int64 Output only. The unique ID of the user list.
read_only	bool Output only. An option that indicates if a user may edit a list.
membership_duration	Duration Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error.
access_reason	AccessReason Output only. The reason this account has been granted access to the list.
size_info	SizeInfo Output only. Estimated number of members in this user list in different target networks.
target_network_info	TargetNetworkInfo Optional. Eligibility information for different target networks.
display_name	string Required. The display name of the user list.
description	string Optional. A description of the user list.
membership_status	MembershipStatus Optional. Membership status of this user list.
integration_code	string Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
closing_reason	ClosingReason Output only. The reason why this user list membership status is closed.
account_access_status	AccessStatus Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to ENABLED . Later the user list owner can decide to revoke the share and make it DISABLED .
Union field user_list_info . Additional information about the user list. user_list_info can be only one of the following:
ingested_user_list_info	IngestedUserListInfo Optional. Represents a user list that is populated by user ingested data.

AccessReason

Enum describing possible access reasons.

Перечисления
ACCESS_REASON_UNSPECIFIED	Не указан.
OWNED	The resource is owned by the user.
SHARED	The resource is shared to the user.
LICENSED	The resource is licensed to the user.
SUBSCRIBED	The user subscribed to the resource.
AFFILIATED	The resource is accessible to the user.

AccessStatus

Indicates if this client still has access to the list.

Перечисления
ACCESS_STATUS_UNSPECIFIED	Не указан.
ENABLED	The access is enabled.
DISABLED	The access is disabled.

ClosingReason

Indicates the reason why the user list was closed. This enum is only used when a list is auto-closed by the system.

Перечисления
CLOSING_REASON_UNSPECIFIED	Не указан.
UNUSED	The user list was closed because it has not been used in targeting recently. See https://support.google.com/google-ads/answer/2472738 for details.

MembershipStatus

Status of the user list.

Перечисления
MEMBERSHIP_STATUS_UNSPECIFIED	Не указан.
OPEN	Open status - User list is accruing members and can be targeted to.
CLOSED	Closed status - No new members being added.

UserListDirectLicense

A user list direct license.

This feature is only available to data partners.

Поля
name	string Identifier. The resource name of the user list direct license.
user_list_display_name	string Output only. Name of the user list being licensed. This field is read-only.
client_account_display_name	string Output only. Name of client customer which the user list is being licensed to. This field is read-only.
pricing	UserListLicensePricing Optional. UserListDirectLicense pricing.
historical_pricings[]	UserListLicensePricing Output only. Pricing history of this user list license. This field is read-only.
metrics	UserListLicenseMetrics Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call
user_list_id	int64 Immutable. ID of the user list being licensed.
client_account_type	UserListLicenseClientAccountType Immutable. Account type of client customer which the user list is being licensed to.
client_account_id	int64 Immutable. ID of client customer which the user list is being licensed to.
status	UserListLicenseStatus Optional. Status of UserListDirectLicense - ENABLED or DISABLED.

UserListGlobalLicense

A user list global license.

This feature is only available to data partners.

Поля
name	string Identifier. The resource name of the user list global license.
user_list_display_name	string Output only. Name of the user list being licensed. This field is read-only.
pricing	UserListLicensePricing Optional. UserListGlobalLicense pricing.
historical_pricings[]	UserListLicensePricing Output only. Pricing history of this user list license. This field is read-only.
metrics	UserListLicenseMetrics Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call
user_list_id	int64 Immutable. ID of the user list being licensed.
license_type	UserListGlobalLicenseType Immutable. Product type of client customer which the user list is being licensed to.
status	UserListLicenseStatus Optional. Status of UserListGlobalLicense - ENABLED or DISABLED.

UserListGlobalLicenseCustomerInfo

Information about a customer of a user list global license. This will automatically be created by the system when a customer purchases a global license.

Поля
name	string Identifier. The resource name of the user list global license customer.
user_list_id	int64 Output only. ID of the user list being licensed.
user_list_display_name	string Output only. Name of the user list being licensed.
license_type	UserListGlobalLicenseType Output only. Product type of client customer which the user list is being licensed to.
status	UserListLicenseStatus Output only. Status of UserListDirectLicense - ENABLED or DISABLED.
pricing	UserListLicensePricing Output only. UserListDirectLicense pricing.
client_account_type	UserListLicenseClientAccountType Output only. Product type of client customer which the user list is being licensed to.
client_account_id	int64 Output only. ID of client customer which the user list is being licensed to.
client_account_display_name	string Output only. Name of client customer which the user list is being licensed to.
historical_pricings[]	UserListLicensePricing Output only. Pricing history of this user list license.
metrics	UserListLicenseMetrics Output only. Metrics related to this license This field is only populated if the start and end dates are set in the ListUserListGlobalLicenseCustomerInfos call.

UserListGlobalLicenseType

User list global license types.

Перечисления
USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED	UNSPECIFIED.
USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER	Reseller license.
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE	DataMart Sell Side license.
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE	DataMart Buy Side license.

UserListLicenseClientAccountType

Possible product of a client account for a user list license.

Перечисления
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN	Неизвестный.
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS	Google Ads customer.
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER	Display & Video 360 partner.
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER	Display & Video 360 advertiser.
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK	Google Ad Manager audience link.

UserListLicenseMetrics

Metrics related to a user list license.

Поля
click_count	int64 Output only. The number of clicks for the user list license.
impression_count	int64 Output only. The number of impressions for the user list license.
revenue_usd_micros	int64 Output only. The revenue for the user list license in USD micros.
start_date	int64 Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If end_date is used in the filter, start_date is also required. If neither start_date nor end_date are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.
end_date	int64 Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If start_date is used in the filter, end_date is also required. If neither start_date nor end_date are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.

UserListLicensePricing

A user list license pricing.

Поля
pricing_id	int64 Output only. The ID of this pricing.
start_time	Timestamp Output only. Start time of the pricing.
end_time	Timestamp Optional. End time of the pricing.
pricing_active	bool Output only. Whether this pricing is active.
buyer_approval_state	UserListPricingBuyerApprovalState Output only. The buyer approval state of this pricing. This field is read-only.
cost_micros	int64 Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD .
currency_code	string Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
cost_type	UserListPricingCostType Immutable. The cost type of this pricing. Can be set only in the create operation. Can't be updated for an existing license.
max_cost_micros	int64 Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD . This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to 0 , there is no cap.

UserListPricingBuyerApprovalState

User list pricing buyer approval state.

Перечисления
USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED	UNSPECIFIED.
PENDING	User list client has not yet accepted the pricing terms set by the user list owner.
APPROVED	User list client has accepted the pricing terms set by the user list owner.
REJECTED	User list client has rejected the pricing terms set by the user list owner.

UserListPricingCostType

User list pricing cost type.

Перечисления
USER_LIST_PRICING_COST_TYPE_UNSPECIFIED	Unspecified.
CPC	Cost per click.
CPM	Cost per mille (thousand impressions).
MEDIA_SHARE	Media share.

UserListLicenseStatus

User list license status.

Перечисления
USER_LIST_LICENSE_STATUS_UNSPECIFIED	Неизвестный.
USER_LIST_LICENSE_STATUS_ENABLED	Active status - user list is still being licensed.
USER_LIST_LICENSE_STATUS_DISABLED	Inactive status - user list is no longer being licensed.

UserProperties

Advertiser-assessed information about the user at the time that the event happened. See https://support.google.com/google-ads/answer/14007601 for more details.

Поля
customer_type	CustomerType Optional. Type of the customer associated with the event.
customer_value_bucket	CustomerValueBucket Optional. The advertiser-assessed value of the customer.
additional_user_properties[]	UserProperty Optional. A bucket of any additional user properties for the user associated with this event.

UserProperty

A bucket of any additional user properties for the user associated with this event.

Поля
property_name	string Required. The name of the user property to use.
value	string Required. The string representation of the value of the user property to use.

ViewType

The type of the event.

Перечисления
VIEW_TYPE_UNSPECIFIED	Unspecified view type.
VIEW_TYPE_MRC_VIEWED	MRC viewed.
VIEW_TYPE_MRC_RENDERED	MRC rendered.

ViewabilityInfo

Details of the viewability of the ad served.

Поля
view_type	ViewType Required. The type of the event.
viewable_percent	int32 Optional. The numerical percent (0-100) of the pixels that were viewable.
viewable_duration	Duration Optional. The amount of time the ad was viewable for.
media_skippable	bool Optional. Whether the ad media was skippable or not.
media_quartile	MediaQuartile Optional. The amount of the media that was played as discrete quartiles.
media_duration	Duration Optional. The duration of the ad media.
media_volume_percent	int32 Optional. The numerical percent (0-100) of the volume of the media playback.
playback_duration	Duration Optional. The duration of playback of the ad media, regardless of whether it was viewable or not.

WarningCount

The warning count for a given warning reason.

Поля
record_count	int64 The count of records that have a warning.
reason	ProcessingWarningReason The warning reason.

WarningInfo

Warning counts for each type of warning.

Поля
warning_counts[]	WarningCount A list of warnings and counts per warning reason.