Namespace Google.Ads.DataManager.V1

Classes

AccountName

Resource name for the Account resource.

AdIdentifiers

Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).

AddressInfo

Address information for the user.

AudienceMember

The audience member to be operated on.

AwsWrappedKeyInfo

A data encryption key wrapped by an AWS KMS key.

AwsWrappedKeyInfo.Types

Container for nested types declared in the AwsWrappedKeyInfo message type.

Baseline

Baseline criteria against which insights are compared.

Baseline.Types

Container for nested types declared in the Baseline message type.

Baseline.Types.Location

The baseline location of the request. Baseline location is on OR-list of ISO 3166-1 alpha-2 region codes of the requested regions.

CartData

The cart data associated with the event.

Consent

Digital Markets Act (DMA) consent settings for the user.

ContactIdInfo

Additional information when CONTACT_ID is one of the upload_key_types.

CreatePartnerLinkRequest

Request to create a [PartnerLink][google.ads.datamanager.v1.PartnerLink] resource. Returns a [PartnerLink][google.ads.datamanager.v1.PartnerLink].

CreateUserListDirectLicenseRequest

Request to create a [UserListDirectLicense][google.ads.datamanager.v1.UserListDirectLicense] resource.

CreateUserListGlobalLicenseRequest

Request to create a [UserListGlobalLicense][google.ads.datamanager.v1.UserListGlobalLicense] resource.

CreateUserListRequest

Request message for CreateUserList.

CustomVariable

Custom variable for ads conversions.

DeletePartnerLinkRequest

Request to delete a [PartnerLink][google.ads.datamanager.v1.PartnerLink] resource. Returns a [google.protobuf.Empty][google.protobuf.Empty].

DeleteUserListRequest

Request message for DeleteUserList.

Destination

The Google product you're sending data to. For example, a Google Ads account.

DeviceInfo

Information about the device being used (if any) when the event happened.

EncryptionInfo

Encryption information for the data being ingested.

ErrorCount

The error count for a given error reason.

ErrorInfo

Error counts for each type of error.

Event

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

EventParameter

Event parameter for GA4 events.

ExperimentalField

Experimental field representing unofficial fields.

GcpWrappedKeyInfo

Information about the Google Cloud Platform wrapped key.

GcpWrappedKeyInfo.Types

Container for nested types declared in the GcpWrappedKeyInfo message type.

GetUserListDirectLicenseRequest

Request to get a [UserListDirectLicense][google.ads.datamanager.v1.UserListDirectLicense] resource.

GetUserListGlobalLicenseRequest

Request to get a [UserListGlobalLicense][google.ads.datamanager.v1.UserListGlobalLicense] resource.

GetUserListRequest

Request message for GetUserList.

IngestAudienceMembersRequest

Request to upload audience members to the provided destinations. Returns an [IngestAudienceMembersResponse][google.ads.datamanager.v1.IngestAudienceMembersResponse].

IngestAudienceMembersResponse

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

IngestEventsRequest

Request to upload audience members to the provided destinations. Returns an [IngestEventsResponse][google.ads.datamanager.v1.IngestEventsResponse].

IngestEventsResponse

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

IngestedUserListInfo

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

IngestedUserListInfo.Types

Container for nested types declared in the IngestedUserListInfo message type.

IngestionService

Service for sending audience data to supported destinations.

IngestionService.IngestionServiceBase

Base class for server-side implementations of IngestionService

IngestionService.IngestionServiceClient

Client for IngestionService

IngestionServiceClient

IngestionService client wrapper, for convenient use.

IngestionServiceClientBuilder

Builder class for IngestionServiceClient to provide simple configuration of credentials, endpoint etc.

IngestionServiceClientImpl

IngestionService client wrapper implementation, for convenient use.

IngestionServiceSettings

Settings for IngestionServiceClient instances.

Item

Represents an item in the cart associated with the event.

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.

ListUserListDirectLicensesRequest

Request to list all [UserListDirectLicense][google.ads.datamanager.v1.UserListDirectLicense] resources for a given account.

ListUserListDirectLicensesResponse

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

ListUserListGlobalLicenseCustomerInfosRequest

Request to list all [UserListGlobalLicenseCustomerInfo][google.ads.datamanager.v1.UserListGlobalLicenseCustomerInfo] resources for a given user list global license.

ListUserListGlobalLicenseCustomerInfosResponse

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

ListUserListGlobalLicensesRequest

Request to list all [UserListGlobalLicense][google.ads.datamanager.v1.UserListGlobalLicense] resources for a given account.

ListUserListGlobalLicensesResponse

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

ListUserListsRequest

Request message for ListUserLists.

ListUserListsResponse

Response message for ListUserLists.

MarketingDataInsightsService

Service to return insights on marketing data.

This feature is only available to data partners.

MarketingDataInsightsService.MarketingDataInsightsServiceBase

Base class for server-side implementations of MarketingDataInsightsService

MarketingDataInsightsService.MarketingDataInsightsServiceClient

Client for MarketingDataInsightsService

MarketingDataInsightsServiceClient

MarketingDataInsightsService client wrapper, for convenient use.

MarketingDataInsightsServiceClientBuilder

Builder class for MarketingDataInsightsServiceClient to provide simple configuration of credentials, endpoint etc.

MarketingDataInsightsServiceClientImpl

MarketingDataInsightsService client wrapper implementation, for convenient use.

MarketingDataInsightsServiceSettings

Settings for MarketingDataInsightsServiceClient instances.

MobileData

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

MobileIdInfo

Additional information when MOBILE_ID is one of the upload_key_types.

MobileIdInfo.Types

Container for nested types declared in the MobileIdInfo message type.

PairData

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

This feature is only available to data partners.

PairIdInfo

Additional information when PAIR_ID is one of the upload_key_types.

This feature is only available to data partners.

PartnerAudienceInfo

Additional information for partner audiences.

This feature is only available to data partners.

PartnerAudienceInfo.Types

Container for nested types declared in the PartnerAudienceInfo message type.

PartnerLink

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

PartnerLinkName

Resource name for the PartnerLink resource.

PartnerLinkService

Service for managing partner links.

PartnerLinkService.PartnerLinkServiceBase

Base class for server-side implementations of PartnerLinkService

PartnerLinkService.PartnerLinkServiceClient

Client for PartnerLinkService

PartnerLinkServiceClient

PartnerLinkService client wrapper, for convenient use.

PartnerLinkServiceClientBuilder

Builder class for PartnerLinkServiceClient to provide simple configuration of credentials, endpoint etc.

PartnerLinkServiceClientImpl

PartnerLinkService client wrapper implementation, for convenient use.

PartnerLinkServiceSettings

Settings for PartnerLinkServiceClient instances.

PpidData

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

This feature is only available to data partners.

ProductAccount

Represents a specific account.

ProductAccount.Types

Container for nested types declared in the ProductAccount message type.

PseudonymousIdInfo

Additional information when PSEUDONYMOUS_ID is one of the upload_key_types.

PseudonymousIdInfo.Types

Container for nested types declared in the PseudonymousIdInfo message type.

RemoveAudienceMembersRequest

Request to remove users from an audience in the provided destinations. Returns a [RemoveAudienceMembersResponse][google.ads.datamanager.v1.RemoveAudienceMembersResponse].

RemoveAudienceMembersResponse

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

RequestStatusPerDestination

A request status per destination.

RequestStatusPerDestination.Types

Container for nested types declared in the RequestStatusPerDestination message type.

RequestStatusPerDestination.Types.IngestAudienceMembersStatus

The status of the ingest audience members request.

RequestStatusPerDestination.Types.IngestEventsStatus

The status of the events ingestion to the destination.

RequestStatusPerDestination.Types.IngestMobileDataStatus

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

RequestStatusPerDestination.Types.IngestPairDataStatus

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

RequestStatusPerDestination.Types.IngestPpidDataStatus

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

RequestStatusPerDestination.Types.IngestUserDataStatus

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

RequestStatusPerDestination.Types.IngestUserIdDataStatus

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

RequestStatusPerDestination.Types.RemoveAudienceMembersStatus

The status of the remove audience members request.

RequestStatusPerDestination.Types.RemoveMobileDataStatus

The status of the mobile data removal from the destination.

RequestStatusPerDestination.Types.RemovePairDataStatus

The status of the pair data removal from the destination.

RequestStatusPerDestination.Types.RemovePpidDataStatus

The status of the ppid data removal from the destination.

RequestStatusPerDestination.Types.RemoveUserDataStatus

The status of the user data removal from the destination.

RequestStatusPerDestination.Types.RemoveUserIdDataStatus

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

RetrieveInsightsRequest

Request message for DM API MarketingDataInsightsService.RetrieveInsights

RetrieveInsightsResponse

Response message for DM API MarketingDataInsightsService.RetrieveInsights

RetrieveInsightsResponse.Types

Container for nested types declared in the RetrieveInsightsResponse message type.

RetrieveInsightsResponse.Types.MarketingDataInsight

Insights for marketing data.

This feature is only available to data partners.

RetrieveInsightsResponse.Types.MarketingDataInsight.Types

Container for nested types declared in the MarketingDataInsight message type.

RetrieveInsightsResponse.Types.MarketingDataInsight.Types.MarketingDataInsightsAttribute

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

RetrieveRequestStatusRequest

Request to get the status of request made to the DM API for a given request ID. Returns a [RetrieveRequestStatusResponse][google.ads.datamanager.v1.RetrieveRequestStatusResponse].

RetrieveRequestStatusResponse

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

SearchPartnerLinksRequest

Request to search for [PartnerLink][google.ads.datamanager.v1.PartnerLink] resources. Returns a [SearchPartnerLinksResponse][google.ads.datamanager.v1.SearchPartnerLinksResponse].

SearchPartnerLinksResponse

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

SizeInfo

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

TargetNetworkInfo

Eligibility information for different target networks.

TermsOfService

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

UpdateUserListDirectLicenseRequest

Request to update a [UserListDirectLicense][google.ads.datamanager.v1.UserListDirectLicense] resource.

UpdateUserListGlobalLicenseRequest

Request to update a [UserListGlobalLicense][google.ads.datamanager.v1.UserListGlobalLicense] resource.

UpdateUserListRequest

Request message for UpdateUserList.

UserData

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

UserIdData

User id data holding the user id.

UserIdInfo

Additional information when USER_ID is one of the upload_key_types.

UserIdentifier

A single identifier for the user.

UserList

A user list resource.

UserList.Types

Container for nested types declared in the UserList message type.

UserListDirectLicense

A user list direct license.

This feature is only available to data partners.

UserListDirectLicenseName

Resource name for the UserListDirectLicense resource.

UserListDirectLicenseService

Service for managing user list direct licenses. Delete is not a supported operation for UserListDirectLicenses. Callers should update the license status to DISABLED to instead to deactivate a license.

This feature is only available to data partners.

UserListDirectLicenseService.UserListDirectLicenseServiceBase

Base class for server-side implementations of UserListDirectLicenseService

UserListDirectLicenseService.UserListDirectLicenseServiceClient

Client for UserListDirectLicenseService

UserListDirectLicenseServiceClient

UserListDirectLicenseService client wrapper, for convenient use.

UserListDirectLicenseServiceClientBuilder

Builder class for UserListDirectLicenseServiceClient to provide simple configuration of credentials, endpoint etc.

UserListDirectLicenseServiceClientImpl

UserListDirectLicenseService client wrapper implementation, for convenient use.

UserListDirectLicenseServiceSettings

Settings for UserListDirectLicenseServiceClient instances.

UserListGlobalLicense

A user list global license.

This feature is only available to data partners.

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.

UserListGlobalLicenseCustomerInfoName

Resource name for the UserListGlobalLicenseCustomerInfo resource.

UserListGlobalLicenseName

Resource name for the UserListGlobalLicense resource.

UserListGlobalLicenseService

Service for managing user list global licenses. Delete is not a supported operation for UserListGlobalLicenses. Callers should update the license status to DISABLED to instead to deactivate a license.

This feature is only available to data partners.

UserListGlobalLicenseService.UserListGlobalLicenseServiceBase

Base class for server-side implementations of UserListGlobalLicenseService

UserListGlobalLicenseService.UserListGlobalLicenseServiceClient

Client for UserListGlobalLicenseService

UserListGlobalLicenseServiceClient

UserListGlobalLicenseService client wrapper, for convenient use.

UserListGlobalLicenseServiceClientBuilder

Builder class for UserListGlobalLicenseServiceClient to provide simple configuration of credentials, endpoint etc.

UserListGlobalLicenseServiceClientImpl

UserListGlobalLicenseService client wrapper implementation, for convenient use.

UserListGlobalLicenseServiceSettings

Settings for UserListGlobalLicenseServiceClient instances.

UserListLicenseMetrics

Metrics related to a user list license.

UserListLicensePricing

A user list license pricing.

UserListLicensePricing.Types

Container for nested types declared in the UserListLicensePricing message type.

UserListName

Resource name for the UserList resource.

UserListService

Service for managing UserList resources.

UserListService.UserListServiceBase

Base class for server-side implementations of UserListService

UserListService.UserListServiceClient

Client for UserListService

UserListServiceClient

UserListService client wrapper, for convenient use.

UserListServiceClientBuilder

Builder class for UserListServiceClient to provide simple configuration of credentials, endpoint etc.

UserListServiceClientImpl

UserListService client wrapper implementation, for convenient use.

UserListServiceSettings

Settings for UserListServiceClient instances.

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.

UserProperty

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

WarningCount

The warning count for a given warning reason.

WarningInfo

Warning counts for each type of warning.

Enums

AccountName.ResourceNameType

The possible contents of AccountName.

AgeRange

The demographic age ranges

AudienceMember.DataOneofCase

Enum of possible cases for the "data" oneof.

AwsWrappedKeyInfo.Types.KeyType

The type of algorithm used to encrypt the data.

Baseline.BaselineOneofCase

Enum of possible cases for the "baseline" oneof.

ConsentStatus

Represents if the user granted, denied, or hasn't specified consent.

CustomerType

Type of the customer associated with the event.

CustomerValueBucket

The advertiser-assessed value of the customer.

DataSourceType

Indicates source of upload data.

Encoding

The encoding type of the hashed identifying information.

EncryptionInfo.WrappedKeyOneofCase

Enum of possible cases for the "wrapped_key" oneof.

ErrorReason

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

EventSource

The source of the event.

GcpWrappedKeyInfo.Types.KeyType

The type of algorithm used to encrypt the data.

Gender

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

IngestedUserListInfo.Types.UploadKeyType

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

MatchRateRange

The match rate range of the upload or userlist.

MobileIdInfo.Types.KeySpace

Key space for mobile ID.

PartnerAudienceInfo.Types.PartnerAudienceSource

Partner audience source.

PartnerLinkName.ResourceNameType

The possible contents of PartnerLinkName.

ProcessingErrorReason

The processing error reason.

ProcessingWarningReason

The processing warning reason.

Product

Deprecated. Use [AccountType][google.ads.datamanager.v1.ProductAccount.AccountType] instead. Represents a specific Google product.

ProductAccount.Types.AccountType

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

PseudonymousIdInfo.Types.SyncStatus

Sync status of the user list.

RequestStatusPerDestination.StatusOneofCase

Enum of possible cases for the "status" oneof.

RequestStatusPerDestination.Types.IngestAudienceMembersStatus.StatusOneofCase

Enum of possible cases for the "status" oneof.

RequestStatusPerDestination.Types.RemoveAudienceMembersStatus.StatusOneofCase

Enum of possible cases for the "status" oneof.

RequestStatusPerDestination.Types.RequestStatus

The request status.

RetrieveInsightsResponse.Types.MarketingDataInsight.Types.AudienceInsightsDimension

Possible dimensions for use in generating insights.

TermsOfServiceStatus

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

UserIdentifier.IdentifierOneofCase

Enum of possible cases for the "identifier" oneof.

UserList.Types.AccessReason

Enum describing possible access reasons.

UserList.Types.AccessStatus

Indicates if this client still has access to the list.

UserList.Types.ClosingReason

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

UserList.Types.MembershipStatus

Status of the user list.

UserList.UserListInfoOneofCase

Enum of possible cases for the "user_list_info" oneof.

UserListDirectLicenseName.ResourceNameType

The possible contents of UserListDirectLicenseName.

UserListGlobalLicenseCustomerInfoName.ResourceNameType

The possible contents of UserListGlobalLicenseCustomerInfoName.

UserListGlobalLicenseName.ResourceNameType

The possible contents of UserListGlobalLicenseName.

UserListGlobalLicenseType

User list global license types.

UserListLicenseClientAccountType

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

UserListLicensePricing.Types.UserListPricingBuyerApprovalState

User list pricing buyer approval state.

UserListLicensePricing.Types.UserListPricingCostType

User list pricing cost type.

UserListLicenseStatus

User list license status.

UserListName.ResourceNameType

The possible contents of UserListName.