google-ads-data_manager-v1 0.2.0 → 0.3.0

data/proto_docs/google/ads/datamanager/v1/user_list.rb

@@ -0,0 +1,397 @@
+# frozen_string_literal: true
+
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Ads
+    module DataManager
+      module V1
+        # A user list resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the user list.
+        #     Format:
+        #     accountTypes/\\{account_type}/accounts/\\{account}/userLists/\\{user_list}
+        # @!attribute [r] id
+        #   @return [::Integer]
+        #     Output only. The unique ID of the user list.
+        # @!attribute [r] read_only
+        #   @return [::Boolean]
+        #     Output only. An option that indicates if a user may edit a list.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the user list.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. A description of the user list.
+        # @!attribute [rw] membership_status
+        #   @return [::Google::Ads::DataManager::V1::UserList::MembershipStatus]
+        #     Optional. Membership status of this user list.
+        # @!attribute [rw] integration_code
+        #   @return [::String]
+        #     Optional. An ID from external system. It is used by user list sellers to
+        #     correlate IDs on their systems.
+        # @!attribute [rw] membership_duration
+        #   @return [::Google::Protobuf::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.
+        # @!attribute [r] closing_reason
+        #   @return [::Google::Ads::DataManager::V1::UserList::ClosingReason]
+        #     Output only. The reason why this user list membership status is closed.
+        # @!attribute [r] access_reason
+        #   @return [::Google::Ads::DataManager::V1::UserList::AccessReason]
+        #     Output only. The reason this account has been granted access to the list.
+        # @!attribute [rw] account_access_status
+        #   @return [::Google::Ads::DataManager::V1::UserList::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`.
+        # @!attribute [r] size_info
+        #   @return [::Google::Ads::DataManager::V1::SizeInfo]
+        #     Output only. Estimated number of members in this user list in different
+        #     target networks.
+        # @!attribute [rw] target_network_info
+        #   @return [::Google::Ads::DataManager::V1::TargetNetworkInfo]
+        #     Optional. Eligibility information for different target networks.
+        # @!attribute [rw] ingested_user_list_info
+        #   @return [::Google::Ads::DataManager::V1::IngestedUserListInfo]
+        #     Optional. Represents a user list that is populated by user ingested data.
+        class UserList
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Status of the user list.
+          module MembershipStatus
+            # Not specified.
+            MEMBERSHIP_STATUS_UNSPECIFIED = 0
+
+            # Open status - User list is accruing members and can be targeted to.
+            OPEN = 1
+
+            # Closed status - No new members being added.
+            CLOSED = 2
+          end
+
+          # Indicates the reason why the user list was closed.
+          # This enum is only used when a list is auto-closed by the system.
+          module ClosingReason
+            # Not specified.
+            CLOSING_REASON_UNSPECIFIED = 0
+
+            # 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.
+            UNUSED = 1
+          end
+
+          # Enum describing possible access reasons.
+          module AccessReason
+            # Not specified.
+            ACCESS_REASON_UNSPECIFIED = 0
+
+            # The resource is owned by the user.
+            OWNED = 1
+
+            # The resource is shared to the user.
+            SHARED = 2
+
+            # The resource is licensed to the user.
+            LICENSED = 3
+
+            # The user subscribed to the resource.
+            SUBSCRIBED = 4
+
+            # The resource is accessible to the user.
+            AFFILIATED = 5
+          end
+
+          # Indicates if this client still has access to the list.
+          module AccessStatus
+            # Not specified.
+            ACCESS_STATUS_UNSPECIFIED = 0
+
+            # The access is enabled.
+            ENABLED = 1
+
+            # The access is disabled.
+            DISABLED = 2
+          end
+        end
+
+        # Estimated number of members in this user list in different target networks.
+        # @!attribute [r] display_network_members_count
+        #   @return [::Integer]
+        #     Output only. Estimated number of members in this user list, on the Google
+        #     Display Network.
+        # @!attribute [r] search_network_members_count
+        #   @return [::Integer]
+        #     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.
+        class SizeInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Eligibility information for different target networks.
+        # @!attribute [r] eligible_for_display
+        #   @return [::Boolean]
+        #     Output only. Indicates this user list is eligible for Google Display
+        #     Network.
+        # @!attribute [rw] eligible_for_search
+        #   @return [::Boolean]
+        #     Optional. Indicates if this user list is eligible for Google Search
+        #     Network.
+        class TargetNetworkInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents a user list that is populated by user provided data.
+        # @!attribute [rw] upload_key_types
+        #   @return [::Array<::Google::Ads::DataManager::V1::IngestedUserListInfo::UploadKeyType>]
+        #     Required. Immutable. Upload key types of this user list.
+        # @!attribute [rw] contact_id_info
+        #   @return [::Google::Ads::DataManager::V1::ContactIdInfo]
+        #     Optional. Additional information when `CONTACT_ID` is one of the
+        #     `upload_key_types`.
+        # @!attribute [rw] mobile_id_info
+        #   @return [::Google::Ads::DataManager::V1::MobileIdInfo]
+        #     Optional. Additional information when `MOBILE_ID` is one of the
+        #     `upload_key_types`.
+        # @!attribute [rw] user_id_info
+        #   @return [::Google::Ads::DataManager::V1::UserIdInfo]
+        #     Optional. Additional information when `USER_ID` is one of the
+        #     `upload_key_types`.
+        # @!attribute [rw] pair_id_info
+        #   @return [::Google::Ads::DataManager::V1::PairIdInfo]
+        #     Optional. Additional information when `PAIR_ID` is one of the
+        #     `upload_key_types`.
+        #
+        #     This feature is only available to data partners.
+        # @!attribute [rw] pseudonymous_id_info
+        #   @return [::Google::Ads::DataManager::V1::PseudonymousIdInfo]
+        #     Optional. Additional information for `PSEUDONYMOUS_ID` is one of the
+        #     `upload_key_types`.
+        # @!attribute [rw] partner_audience_info
+        #   @return [::Google::Ads::DataManager::V1::PartnerAudienceInfo]
+        #     Optional. Additional information for partner audiences.
+        #
+        #     This feature is only available to data partners.
+        class IngestedUserListInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Enum containing the possible upload key types of a user list.
+          module UploadKeyType
+            # Not specified.
+            UPLOAD_KEY_TYPE_UNSPECIFIED = 0
+
+            # Customer info such as email address, phone number or physical address.
+            CONTACT_ID = 1
+
+            # Mobile advertising ids.
+            MOBILE_ID = 2
+
+            # Third party provided user ids.
+            USER_ID = 3
+
+            # Publisher advertiser identity reconciliation ids.
+            PAIR_ID = 4
+
+            # 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
+            PSEUDONYMOUS_ID = 5
+          end
+        end
+
+        # Additional information when `CONTACT_ID` is one of the `upload_key_types`.
+        # @!attribute [rw] data_source_type
+        #   @return [::Google::Ads::DataManager::V1::DataSourceType]
+        #     Optional. Immutable. Source of the upload data
+        # @!attribute [r] match_rate_percentage
+        #   @return [::Integer]
+        #     Output only. Match rate for customer match user lists.
+        class ContactIdInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Additional information when `MOBILE_ID` is one of the `upload_key_types`.
+        # @!attribute [rw] data_source_type
+        #   @return [::Google::Ads::DataManager::V1::DataSourceType]
+        #     Optional. Immutable. Source of the upload data.
+        # @!attribute [rw] key_space
+        #   @return [::Google::Ads::DataManager::V1::MobileIdInfo::KeySpace]
+        #     Required. Immutable. The key space of mobile IDs.
+        # @!attribute [rw] app_id
+        #   @return [::String]
+        #     Required. Immutable. A string that uniquely identifies a mobile application
+        #     from which the data was collected.
+        class MobileIdInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Key space for mobile ID.
+          module KeySpace
+            # Not specified.
+            KEY_SPACE_UNSPECIFIED = 0
+
+            # The iOS keyspace.
+            IOS = 1
+
+            # The Android keyspace.
+            ANDROID = 2
+          end
+        end
+
+        # Additional information when `USER_ID` is one of the `upload_key_types`.
+        # @!attribute [rw] data_source_type
+        #   @return [::Google::Ads::DataManager::V1::DataSourceType]
+        #     Optional. Immutable. Source of the upload data.
+        class UserIdInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Additional information when `PAIR_ID` is one of the `upload_key_types`.
+        #
+        # This feature is only available to data partners.
+        # @!attribute [rw] publisher_id
+        #   @return [::Integer]
+        #     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.
+        # @!attribute [rw] publisher_name
+        #   @return [::String]
+        #     Required. Descriptive name of the publisher to be displayed in the UI for a
+        #     better targeting experience.
+        # @!attribute [rw] match_rate_percentage
+        #   @return [::Integer]
+        #     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.
+        # @!attribute [rw] advertiser_identifier_count
+        #   @return [::Integer]
+        #     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.
+        # @!attribute [rw] clean_room_identifier
+        #   @return [::String]
+        #     Required. Immutable. Identifies a unique advertiser to publisher
+        #     relationship with one clean room provider or across multiple clean room
+        #     providers.
+        class PairIdInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Additional information for partner audiences.
+        #
+        # This feature is only available to data partners.
+        # @!attribute [rw] partner_audience_source
+        #   @return [::Google::Ads::DataManager::V1::PartnerAudienceInfo::PartnerAudienceSource]
+        #     Required. Immutable. The source of the partner audience.
+        # @!attribute [rw] commerce_partner
+        #   @return [::String]
+        #     Optional. The commerce partner name.
+        #     Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
+        class PartnerAudienceInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Partner audience source.
+          module PartnerAudienceSource
+            # Not specified.
+            PARTNER_AUDIENCE_SOURCE_UNSPECIFIED = 0
+
+            # Partner Audience source is commerce audience.
+            COMMERCE_AUDIENCE = 1
+
+            # Partner Audience source is linear TV audience.
+            LINEAR_TV_AUDIENCE = 2
+
+            # Partner Audience source is agency/provider audience.
+            AGENCY_PROVIDER_AUDIENCE = 3
+          end
+        end
+
+        # Additional information when `PSEUDONYMOUS_ID` is one of the
+        # `upload_key_types`.
+        # @!attribute [r] sync_status
+        #   @return [::Google::Ads::DataManager::V1::PseudonymousIdInfo::SyncStatus]
+        #     Output only. Sync status of the user list.
+        # @!attribute [rw] billable_record_count
+        #   @return [::Integer]
+        #     Optional. Immutable. The number of billable records (e.g. uploaded or
+        #     matched).
+        class PseudonymousIdInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Sync status of the user list.
+          module SyncStatus
+            # Not specified.
+            SYNC_STATUS_UNSPECIFIED = 0
+
+            # 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.
+            CREATED = 1
+
+            # The user list is ready for use. Contents and cookies have been synced
+            # correctly.
+            READY_FOR_USE = 2
+
+            # An error has occurred syncing user list contents and/or metadata. The
+            # user list cannot be used.
+            FAILED = 3
+          end
+        end
+
+        # Indicates source of upload data.
+        module DataSourceType
+          # Not specified.
+          DATA_SOURCE_TYPE_UNSPECIFIED = 0
+
+          # The uploaded data is first-party data.
+          DATA_SOURCE_TYPE_FIRST_PARTY = 1
+
+          # The uploaded data is from a third-party credit bureau.
+          DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU = 2
+
+          # The uploaded data is from a third-party voter file.
+          DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE = 3
+
+          # The uploaded data is third party partner data.
+          DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA = 4
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/datamanager/v1/user_list_direct_license.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Ads
+    module DataManager
+      module V1
+        # A user list direct license.
+        #
+        # This feature is only available to data partners.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the user list direct license.
+        # @!attribute [rw] user_list_id
+        #   @return [::Integer]
+        #     Immutable. ID of the user list being licensed.
+        # @!attribute [r] user_list_display_name
+        #   @return [::String]
+        #     Output only. Name of the user list being licensed.
+        #
+        #     This field is read-only.
+        # @!attribute [rw] client_account_type
+        #   @return [::Google::Ads::DataManager::V1::UserListLicenseClientAccountType]
+        #     Immutable. Account type of client customer which the user list is being
+        #     licensed to.
+        # @!attribute [rw] client_account_id
+        #   @return [::Integer]
+        #     Immutable. ID of client customer which the user list is being licensed to.
+        # @!attribute [r] client_account_display_name
+        #   @return [::String]
+        #     Output only. Name of client customer which the user list is being licensed
+        #     to.
+        #
+        #     This field is read-only.
+        # @!attribute [rw] status
+        #   @return [::Google::Ads::DataManager::V1::UserListLicenseStatus]
+        #     Optional. Status of UserListDirectLicense - ENABLED or DISABLED.
+        # @!attribute [rw] pricing
+        #   @return [::Google::Ads::DataManager::V1::UserListLicensePricing]
+        #     Optional. UserListDirectLicense pricing.
+        # @!attribute [r] historical_pricings
+        #   @return [::Array<::Google::Ads::DataManager::V1::UserListLicensePricing>]
+        #     Output only. Pricing history of this user list license.
+        #
+        #     This field is read-only.
+        # @!attribute [r] metrics
+        #   @return [::Google::Ads::DataManager::V1::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
+        class UserListDirectLicense
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/datamanager/v1/user_list_direct_license_service.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Ads
+    module DataManager
+      module V1
+        # Request to create a
+        # {::Google::Ads::DataManager::V1::UserListDirectLicense UserListDirectLicense}
+        # resource.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The account that owns the user list being licensed. Should be in
+        #     the format accountTypes/\\{ACCOUNT_TYPE}/accounts/\\{ACCOUNT_ID}
+        # @!attribute [rw] user_list_direct_license
+        #   @return [::Google::Ads::DataManager::V1::UserListDirectLicense]
+        #     Required. The user list direct license to create.
+        class CreateUserListDirectLicenseRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request to get a
+        # {::Google::Ads::DataManager::V1::UserListDirectLicense UserListDirectLicense}
+        # resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the user list direct license.
+        class GetUserListDirectLicenseRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request to update a
+        # {::Google::Ads::DataManager::V1::UserListDirectLicense UserListDirectLicense}
+        # resource.
+        # @!attribute [rw] user_list_direct_license
+        #   @return [::Google::Ads::DataManager::V1::UserListDirectLicense]
+        #     Required. The licenses' `name` field is used to identify the license to
+        #     update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::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.
+        class UpdateUserListDirectLicenseRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request to list all
+        # {::Google::Ads::DataManager::V1::UserListDirectLicense UserListDirectLicense}
+        # resources for a given account.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The account whose licenses are being queried. Should be in the
+        #     format accountTypes/\\{ACCOUNT_TYPE}/accounts/\\{ACCOUNT_ID}
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. A [filter string](https://google.aip.dev/160) 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](https://en.wikipedia.org/wiki/Camel_case) or all [snake
+        #     case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of
+        #     camel case and snake case.
+        #
+        #     **Supported Operations:**
+        #
+        #     - `AND`
+        #     - `=`
+        #     - `!=`
+        #     - `>`
+        #     - `>=`
+        #     - `<`
+        #     - `<=`
+        #
+        #     **Unsupported Fields:**
+        #
+        #     - `name` (use get method instead)
+        #     - `historical_pricings` and all its subfields
+        #     - `pricing.start_time`
+        #     - `pricing.end_time`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     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.
+        # @!attribute [rw] page_token
+        #   @return [::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.
+        class ListUserListDirectLicensesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response from the
+        # {::Google::Ads::DataManager::V1::ListUserListDirectLicensesRequest ListUserListDirectLicensesRequest}.
+        # @!attribute [rw] user_list_direct_licenses
+        #   @return [::Array<::Google::Ads::DataManager::V1::UserListDirectLicense>]
+        #     The licenses for the given user list in the request.
+        # @!attribute [rw] next_page_token
+        #   @return [::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.
+        class ListUserListDirectLicensesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end