google-ads-data_manager-v1 0.a → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +154 -8
  5. data/lib/google/ads/data_manager/v1/ingestion_service/client.rb +787 -0
  6. data/lib/google/ads/data_manager/v1/ingestion_service/credentials.rb +47 -0
  7. data/lib/google/ads/data_manager/v1/ingestion_service/rest/client.rb +748 -0
  8. data/lib/google/ads/data_manager/v1/ingestion_service/rest/service_stub.rb +320 -0
  9. data/lib/google/ads/data_manager/v1/ingestion_service/rest.rb +51 -0
  10. data/lib/google/ads/data_manager/v1/ingestion_service.rb +54 -0
  11. data/lib/google/ads/data_manager/v1/rest.rb +37 -0
  12. data/lib/google/ads/data_manager/v1/version.rb +7 -2
  13. data/lib/google/ads/data_manager/v1.rb +45 -0
  14. data/lib/google/ads/datamanager/v1/audience_pb.rb +50 -0
  15. data/lib/google/ads/datamanager/v1/cart_data_pb.rb +45 -0
  16. data/lib/google/ads/datamanager/v1/consent_pb.rb +45 -0
  17. data/lib/google/ads/datamanager/v1/destination_pb.rb +47 -0
  18. data/lib/google/ads/datamanager/v1/device_info_pb.rb +44 -0
  19. data/lib/google/ads/datamanager/v1/encryption_info_pb.rb +46 -0
  20. data/lib/google/ads/datamanager/v1/error_pb.rb +42 -0
  21. data/lib/google/ads/datamanager/v1/event_pb.rb +61 -0
  22. data/lib/google/ads/datamanager/v1/experimental_field_pb.rb +44 -0
  23. data/lib/google/ads/datamanager/v1/ingestion_service_pb.rb +68 -0
  24. data/lib/google/ads/datamanager/v1/ingestion_service_services_pb.rb +57 -0
  25. data/lib/google/ads/datamanager/v1/match_rate_pb.rb +42 -0
  26. data/lib/google/ads/datamanager/v1/processing_errors_pb.rb +47 -0
  27. data/lib/google/ads/datamanager/v1/request_status_per_destination_pb.rb +58 -0
  28. data/lib/google/ads/datamanager/v1/terms_of_service_pb.rb +45 -0
  29. data/lib/google/ads/datamanager/v1/user_data_pb.rb +46 -0
  30. data/lib/google/ads/datamanager/v1/user_properties_pb.rb +46 -0
  31. data/lib/google-ads-data_manager-v1.rb +21 -0
  32. data/proto_docs/README.md +4 -0
  33. data/proto_docs/google/ads/datamanager/v1/audience.rb +81 -0
  34. data/proto_docs/google/ads/datamanager/v1/cart_data.rb +65 -0
  35. data/proto_docs/google/ads/datamanager/v1/consent.rb +52 -0
  36. data/proto_docs/google/ads/datamanager/v1/destination.rb +124 -0
  37. data/proto_docs/google/ads/datamanager/v1/device_info.rb +48 -0
  38. data/proto_docs/google/ads/datamanager/v1/encryption_info.rb +68 -0
  39. data/proto_docs/google/ads/datamanager/v1/error.rb +151 -0
  40. data/proto_docs/google/ads/datamanager/v1/event.rb +157 -0
  41. data/proto_docs/google/ads/datamanager/v1/experimental_field.rb +38 -0
  42. data/proto_docs/google/ads/datamanager/v1/ingestion_service.rb +201 -0
  43. data/proto_docs/google/ads/datamanager/v1/match_rate.rb +63 -0
  44. data/proto_docs/google/ads/datamanager/v1/processing_errors.rb +196 -0
  45. data/proto_docs/google/ads/datamanager/v1/request_status_per_destination.rb +234 -0
  46. data/proto_docs/google/ads/datamanager/v1/terms_of_service.rb +52 -0
  47. data/proto_docs/google/ads/datamanager/v1/user_data.rb +84 -0
  48. data/proto_docs/google/ads/datamanager/v1/user_properties.rb +70 -0
  49. data/proto_docs/google/api/client.rb +473 -0
  50. data/proto_docs/google/api/field_behavior.rb +85 -0
  51. data/proto_docs/google/api/launch_stage.rb +71 -0
  52. data/proto_docs/google/api/resource.rb +227 -0
  53. data/proto_docs/google/protobuf/duration.rb +98 -0
  54. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  55. metadata +88 -9
@@ -0,0 +1,151 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Ads
22
+ module DataManager
23
+ module V1
24
+ # Error reasons for Data Manager API.
25
+ module ErrorReason
26
+ # Do not use this default value.
27
+ ERROR_REASON_UNSPECIFIED = 0
28
+
29
+ # An internal error has occurred.
30
+ INTERNAL_ERROR = 1
31
+
32
+ # The request took too long to respond.
33
+ DEADLINE_EXCEEDED = 2
34
+
35
+ # Too many requests.
36
+ RESOURCE_EXHAUSTED = 3
37
+
38
+ # Resource not found.
39
+ NOT_FOUND = 4
40
+
41
+ # The user does not have permission or the resource is not found.
42
+ PERMISSION_DENIED = 5
43
+
44
+ # There was a problem with the request.
45
+ INVALID_ARGUMENT = 6
46
+
47
+ # Required field is missing.
48
+ REQUIRED_FIELD_MISSING = 7
49
+
50
+ # Format is invalid.
51
+ INVALID_FORMAT = 8
52
+
53
+ # The HEX encoded value is malformed.
54
+ INVALID_HEX_ENCODING = 9
55
+
56
+ # The base64 encoded value is malformed.
57
+ INVALID_BASE64_ENCODING = 10
58
+
59
+ # The SHA256 encoded value is malformed.
60
+ INVALID_SHA256_FORMAT = 11
61
+
62
+ # Postal code is not valid.
63
+ INVALID_POSTAL_CODE = 12
64
+
65
+ # Country code is not valid.
66
+ INVALID_COUNTRY_CODE = 13
67
+
68
+ # Enum value cannot be used.
69
+ INVALID_ENUM_VALUE = 14
70
+
71
+ # Type of the user list is not applicable for this request.
72
+ INVALID_USER_LIST_TYPE = 15
73
+
74
+ # This audience member is not valid.
75
+ INVALID_AUDIENCE_MEMBER = 16
76
+
77
+ # Maximum number of audience members allowed per request is 10,000.
78
+ TOO_MANY_AUDIENCE_MEMBERS = 17
79
+
80
+ # Maximum number of user identifiers allowed per audience member is 10.
81
+ TOO_MANY_USER_IDENTIFIERS = 18
82
+
83
+ # Maximum number of destinations allowed per request is 10.
84
+ TOO_MANY_DESTINATIONS = 19
85
+
86
+ # This Destination is not valid.
87
+ INVALID_DESTINATION = 20
88
+
89
+ # Data Partner does not have access to the operating account owned userlist.
90
+ DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED = 21
91
+
92
+ # Mobile ID format is not valid.
93
+ INVALID_MOBILE_ID_FORMAT = 22
94
+
95
+ # User list is not valid.
96
+ INVALID_USER_LIST_ID = 23
97
+
98
+ # Multiple data types are not allowed to be ingested in a single request.
99
+ MULTIPLE_DATA_TYPES_NOT_ALLOWED = 24
100
+
101
+ # Destination configs containing a DataPartner login account must have the
102
+ # same login account across all destination configs.
103
+ DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER = 25
104
+
105
+ # Required terms and conditions are not accepted.
106
+ TERMS_AND_CONDITIONS_NOT_SIGNED = 26
107
+
108
+ # Invalid number format.
109
+ INVALID_NUMBER_FORMAT = 27
110
+
111
+ # Conversion action ID is not valid.
112
+ INVALID_CONVERSION_ACTION_ID = 28
113
+
114
+ # The conversion action type is not valid.
115
+ INVALID_CONVERSION_ACTION_TYPE = 29
116
+
117
+ # The currency code is not supported.
118
+ INVALID_CURRENCY_CODE = 30
119
+
120
+ # This event is not valid.
121
+ INVALID_EVENT = 31
122
+
123
+ # Maximum number of events allowed per request is 10,000.
124
+ TOO_MANY_EVENTS = 32
125
+
126
+ # The destination account is not enabled for enhanced conversions for leads.
127
+ DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS = 33
128
+
129
+ # Enhanced conversions can't be used for the destination account because of
130
+ # Google customer data policies. Contact your Google representative..
131
+ DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS = 34
132
+
133
+ # The destination account hasn't agreed to the terms for enhanced
134
+ # conversions.
135
+ DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED = 35
136
+
137
+ # Two or more destinations in the request have the same reference.
138
+ DUPLICATE_DESTINATION_REFERENCE = 36
139
+
140
+ # Events data contains no user identifiers or ad identifiers.
141
+ NO_IDENTIFIERS_PROVIDED = 39
142
+
143
+ # The request ID used to retrieve the status of a request is not valid.
144
+ # Status can only be retrieved for requests that succeed and don't have
145
+ # `validate_only=true`.
146
+ INVALID_REQUEST_ID = 48
147
+ end
148
+ end
149
+ end
150
+ end
151
+ end
@@ -0,0 +1,157 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Ads
22
+ module DataManager
23
+ module V1
24
+ # An event representing a user interaction with an advertiser's website or app.
25
+ # @!attribute [rw] destination_references
26
+ # @return [::Array<::String>]
27
+ # Optional. Reference string used to determine the destination. If empty, the
28
+ # event will be sent to all
29
+ # {::Google::Ads::DataManager::V1::IngestEventsRequest#destinations destinations}
30
+ # in the request.
31
+ # @!attribute [rw] transaction_id
32
+ # @return [::String]
33
+ # Optional. The unique identifier for this event. Required for conversions
34
+ # using multiple data sources.
35
+ # @!attribute [rw] event_timestamp
36
+ # @return [::Google::Protobuf::Timestamp]
37
+ # Required. The time the event occurred.
38
+ # @!attribute [rw] last_updated_timestamp
39
+ # @return [::Google::Protobuf::Timestamp]
40
+ # Optional. The last time the event was updated.
41
+ # @!attribute [rw] user_data
42
+ # @return [::Google::Ads::DataManager::V1::UserData]
43
+ # Optional. Pieces of user provided data, representing the user the event is
44
+ # associated with.
45
+ # @!attribute [rw] consent
46
+ # @return [::Google::Ads::DataManager::V1::Consent]
47
+ # Optional. Information about whether the associated user has provided
48
+ # different types of consent.
49
+ # @!attribute [rw] ad_identifiers
50
+ # @return [::Google::Ads::DataManager::V1::AdIdentifiers]
51
+ # Optional. Identifiers and other information used to match the conversion
52
+ # event with other online activity (such as ad clicks).
53
+ # @!attribute [rw] currency
54
+ # @return [::String]
55
+ # Optional. The currency code associated with all monetary values within this
56
+ # event.
57
+ # @!attribute [rw] conversion_value
58
+ # @return [::Float]
59
+ # Optional. The conversion value associated with the event, for value-based
60
+ # conversions.
61
+ # @!attribute [rw] event_source
62
+ # @return [::Google::Ads::DataManager::V1::EventSource]
63
+ # Optional. Signal for where the event happened (web, app, in-store, etc.).
64
+ # @!attribute [rw] event_device_info
65
+ # @return [::Google::Ads::DataManager::V1::DeviceInfo]
66
+ # Optional. Information gathered about the device being used (if any) when
67
+ # the event happened.
68
+ # @!attribute [rw] cart_data
69
+ # @return [::Google::Ads::DataManager::V1::CartData]
70
+ # Optional. Information about the transaction and items associated with the
71
+ # event.
72
+ # @!attribute [rw] custom_variables
73
+ # @return [::Array<::Google::Ads::DataManager::V1::CustomVariable>]
74
+ # Optional. Additional key/value pair information to send to the conversion
75
+ # containers (conversion action or FL activity).
76
+ # @!attribute [rw] experimental_fields
77
+ # @return [::Array<::Google::Ads::DataManager::V1::ExperimentalField>]
78
+ # Optional. A list of key/value pairs for experimental fields that may
79
+ # eventually be promoted to be part of the API.
80
+ # @!attribute [rw] user_properties
81
+ # @return [::Google::Ads::DataManager::V1::UserProperties]
82
+ # Optional. Advertiser-assessed information about the user at the time that
83
+ # the event happened.
84
+ class Event
85
+ include ::Google::Protobuf::MessageExts
86
+ extend ::Google::Protobuf::MessageExts::ClassMethods
87
+ end
88
+
89
+ # Identifiers and other information used to match the conversion event with
90
+ # other online activity (such as ad clicks).
91
+ # @!attribute [rw] session_attributes
92
+ # @return [::String]
93
+ # Optional. Session attributes for event attribution and modeling.
94
+ # @!attribute [rw] gclid
95
+ # @return [::String]
96
+ # Optional. The Google click ID (gclid) associated with this event.
97
+ # @!attribute [rw] gbraid
98
+ # @return [::String]
99
+ # Optional. The click identifier for clicks associated with app events and
100
+ # originating from iOS devices starting with iOS14.
101
+ # @!attribute [rw] wbraid
102
+ # @return [::String]
103
+ # Optional. The click identifier for clicks associated with web events and
104
+ # originating from iOS devices starting with iOS14.
105
+ # @!attribute [rw] landing_page_device_info
106
+ # @return [::Google::Ads::DataManager::V1::DeviceInfo]
107
+ # Optional. Information gathered about the device being used (if any) at the
108
+ # time of landing onto the advertiser’s site after interacting with the ad.
109
+ class AdIdentifiers
110
+ include ::Google::Protobuf::MessageExts
111
+ extend ::Google::Protobuf::MessageExts::ClassMethods
112
+ end
113
+
114
+ # Custom variable for ads conversions.
115
+ # @!attribute [rw] variable
116
+ # @return [::String]
117
+ # Optional. The name of the custom variable to set. If the variable is not
118
+ # found for the given destination, it will be ignored.
119
+ # @!attribute [rw] value
120
+ # @return [::String]
121
+ # Optional. The value to store for the custom variable.
122
+ # @!attribute [rw] destination_references
123
+ # @return [::Array<::String>]
124
+ # Optional. Reference string used to determine which of the
125
+ # {::Google::Ads::DataManager::V1::Event#destination_references Event.destination_references}
126
+ # the custom variable should be sent to. If empty, the
127
+ # {::Google::Ads::DataManager::V1::Event#destination_references Event.destination_references}
128
+ # will be used.
129
+ class CustomVariable
130
+ include ::Google::Protobuf::MessageExts
131
+ extend ::Google::Protobuf::MessageExts::ClassMethods
132
+ end
133
+
134
+ # The source of the event.
135
+ module EventSource
136
+ # Unspecified EventSource. Should never be used.
137
+ EVENT_SOURCE_UNSPECIFIED = 0
138
+
139
+ # The event was generated from a web browser.
140
+ WEB = 1
141
+
142
+ # The event was generated from an app.
143
+ APP = 2
144
+
145
+ # The event was generated from an in-store transaction.
146
+ IN_STORE = 3
147
+
148
+ # The event was generated from a phone call.
149
+ PHONE = 4
150
+
151
+ # The event was generated from other sources.
152
+ OTHER = 5
153
+ end
154
+ end
155
+ end
156
+ end
157
+ end
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Ads
22
+ module DataManager
23
+ module V1
24
+ # Experimental field representing unofficial fields.
25
+ # @!attribute [rw] field
26
+ # @return [::String]
27
+ # Optional. The name of the field to use.
28
+ # @!attribute [rw] value
29
+ # @return [::String]
30
+ # Optional. The value the field to set.
31
+ class ExperimentalField
32
+ include ::Google::Protobuf::MessageExts
33
+ extend ::Google::Protobuf::MessageExts::ClassMethods
34
+ end
35
+ end
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,201 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Ads
22
+ module DataManager
23
+ module V1
24
+ # Request to upload audience members to the provided destinations. Returns an
25
+ # {::Google::Ads::DataManager::V1::IngestAudienceMembersResponse IngestAudienceMembersResponse}.
26
+ # @!attribute [rw] destinations
27
+ # @return [::Array<::Google::Ads::DataManager::V1::Destination>]
28
+ # Required. The list of destinations to send the audience members to.
29
+ # @!attribute [rw] audience_members
30
+ # @return [::Array<::Google::Ads::DataManager::V1::AudienceMember>]
31
+ # Required. The list of users to send to the specified destinations. At most
32
+ # 10000 {::Google::Ads::DataManager::V1::AudienceMember AudienceMember} resources
33
+ # can be sent in a single request.
34
+ # @!attribute [rw] consent
35
+ # @return [::Google::Ads::DataManager::V1::Consent]
36
+ # Optional. Request-level consent to apply to all users in the request.
37
+ # User-level consent overrides request-level consent, and can be specified in
38
+ # each {::Google::Ads::DataManager::V1::AudienceMember AudienceMember}.
39
+ # @!attribute [rw] validate_only
40
+ # @return [::Boolean]
41
+ # Optional. For testing purposes. If `true`, the request is validated but not
42
+ # executed. Only errors are returned, not results.
43
+ # @!attribute [rw] encoding
44
+ # @return [::Google::Ads::DataManager::V1::Encoding]
45
+ # Optional. Required for {::Google::Ads::DataManager::V1::UserData UserData}
46
+ # uploads. The encoding type of the user identifiers. For hashed user
47
+ # identifiers, this is the encoding type of the hashed string. For encrypted
48
+ # hashed user identifiers, this is the encoding type of the outer encrypted
49
+ # string, but not necessarily the inner hashed string, meaning the inner
50
+ # hashed string could be encoded in a different way than the outer encrypted
51
+ # string. For non `UserData` uploads, this field is ignored.
52
+ # @!attribute [rw] encryption_info
53
+ # @return [::Google::Ads::DataManager::V1::EncryptionInfo]
54
+ # Optional. Encryption information for
55
+ # {::Google::Ads::DataManager::V1::UserData UserData} uploads. If not set, it's
56
+ # assumed that uploaded identifying information is hashed but not encrypted.
57
+ # For non `UserData` uploads, this field is ignored.
58
+ # @!attribute [rw] terms_of_service
59
+ # @return [::Google::Ads::DataManager::V1::TermsOfService]
60
+ # Optional. The terms of service that the user has accepted/rejected.
61
+ class IngestAudienceMembersRequest
62
+ include ::Google::Protobuf::MessageExts
63
+ extend ::Google::Protobuf::MessageExts::ClassMethods
64
+ end
65
+
66
+ # Response from the
67
+ # {::Google::Ads::DataManager::V1::IngestAudienceMembersRequest IngestAudienceMembersRequest}.
68
+ # @!attribute [rw] request_id
69
+ # @return [::String]
70
+ # The auto-generated ID of the request.
71
+ class IngestAudienceMembersResponse
72
+ include ::Google::Protobuf::MessageExts
73
+ extend ::Google::Protobuf::MessageExts::ClassMethods
74
+ end
75
+
76
+ # Request to remove users from an audience in the provided destinations.
77
+ # Returns a
78
+ # {::Google::Ads::DataManager::V1::RemoveAudienceMembersResponse RemoveAudienceMembersResponse}.
79
+ # @!attribute [rw] destinations
80
+ # @return [::Array<::Google::Ads::DataManager::V1::Destination>]
81
+ # Required. The list of destinations to remove the users from.
82
+ # @!attribute [rw] audience_members
83
+ # @return [::Array<::Google::Ads::DataManager::V1::AudienceMember>]
84
+ # Required. The list of users to remove.
85
+ # @!attribute [rw] validate_only
86
+ # @return [::Boolean]
87
+ # Optional. For testing purposes. If `true`, the request is validated but not
88
+ # executed. Only errors are returned, not results.
89
+ # @!attribute [rw] encoding
90
+ # @return [::Google::Ads::DataManager::V1::Encoding]
91
+ # Optional. Required for {::Google::Ads::DataManager::V1::UserData UserData}
92
+ # uploads. The encoding type of the user identifiers. Applies to only the
93
+ # outer encoding for encrypted user identifiers. For non `UserData` uploads,
94
+ # this field is ignored.
95
+ # @!attribute [rw] encryption_info
96
+ # @return [::Google::Ads::DataManager::V1::EncryptionInfo]
97
+ # Optional. Encryption information for
98
+ # {::Google::Ads::DataManager::V1::UserData UserData} uploads. If not set, it's
99
+ # assumed that uploaded identifying information is hashed but not encrypted.
100
+ # For non `UserData` uploads, this field is ignored.
101
+ class RemoveAudienceMembersRequest
102
+ include ::Google::Protobuf::MessageExts
103
+ extend ::Google::Protobuf::MessageExts::ClassMethods
104
+ end
105
+
106
+ # Response from the
107
+ # {::Google::Ads::DataManager::V1::RemoveAudienceMembersRequest RemoveAudienceMembersRequest}.
108
+ # @!attribute [rw] request_id
109
+ # @return [::String]
110
+ # The auto-generated ID of the request.
111
+ class RemoveAudienceMembersResponse
112
+ include ::Google::Protobuf::MessageExts
113
+ extend ::Google::Protobuf::MessageExts::ClassMethods
114
+ end
115
+
116
+ # Request to upload audience members to the provided destinations. Returns an
117
+ # {::Google::Ads::DataManager::V1::IngestEventsResponse IngestEventsResponse}.
118
+ # @!attribute [rw] destinations
119
+ # @return [::Array<::Google::Ads::DataManager::V1::Destination>]
120
+ # Required. The list of destinations to send the events to.
121
+ # @!attribute [rw] events
122
+ # @return [::Array<::Google::Ads::DataManager::V1::Event>]
123
+ # Required. The list of events to send to the specified destinations. At most
124
+ # 2000 {::Google::Ads::DataManager::V1::Event Event} resources
125
+ # can be sent in a single request.
126
+ # @!attribute [rw] consent
127
+ # @return [::Google::Ads::DataManager::V1::Consent]
128
+ # Optional. Request-level consent to apply to all users in the request.
129
+ # User-level consent overrides request-level consent, and can be specified in
130
+ # each {::Google::Ads::DataManager::V1::Event Event}.
131
+ # @!attribute [rw] validate_only
132
+ # @return [::Boolean]
133
+ # Optional. For testing purposes. If `true`, the request is validated but not
134
+ # executed. Only errors are returned, not results.
135
+ # @!attribute [rw] encoding
136
+ # @return [::Google::Ads::DataManager::V1::Encoding]
137
+ # Optional. Required for {::Google::Ads::DataManager::V1::UserData UserData}
138
+ # uploads. The encoding type of the user identifiers. For hashed user
139
+ # identifiers, this is the encoding type of the hashed string. For encrypted
140
+ # hashed user identifiers, this is the encoding type of the outer encrypted
141
+ # string, but not necessarily the inner hashed string, meaning the inner
142
+ # hashed string could be encoded in a different way than the outer encrypted
143
+ # string. For non `UserData` uploads, this field is ignored.
144
+ # @!attribute [rw] encryption_info
145
+ # @return [::Google::Ads::DataManager::V1::EncryptionInfo]
146
+ # Optional. Encryption information for
147
+ # {::Google::Ads::DataManager::V1::UserData UserData} uploads. If not set, it's
148
+ # assumed that uploaded identifying information is hashed but not encrypted.
149
+ # For non `UserData` uploads, this field is ignored.
150
+ class IngestEventsRequest
151
+ include ::Google::Protobuf::MessageExts
152
+ extend ::Google::Protobuf::MessageExts::ClassMethods
153
+ end
154
+
155
+ # Response from the
156
+ # {::Google::Ads::DataManager::V1::IngestEventsRequest IngestEventsRequest}.
157
+ # @!attribute [rw] request_id
158
+ # @return [::String]
159
+ # The auto-generated ID of the request.
160
+ class IngestEventsResponse
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+ end
164
+
165
+ # Request to get the status of request made to the DM API for a given request
166
+ # ID. Returns a
167
+ # {::Google::Ads::DataManager::V1::RetrieveRequestStatusResponse RetrieveRequestStatusResponse}.
168
+ # @!attribute [rw] request_id
169
+ # @return [::String]
170
+ # Required. Required. The request ID of the Data Manager API request.
171
+ class RetrieveRequestStatusRequest
172
+ include ::Google::Protobuf::MessageExts
173
+ extend ::Google::Protobuf::MessageExts::ClassMethods
174
+ end
175
+
176
+ # Response from the
177
+ # {::Google::Ads::DataManager::V1::RetrieveRequestStatusRequest RetrieveRequestStatusRequest}.
178
+ # @!attribute [rw] request_status_per_destination
179
+ # @return [::Array<::Google::Ads::DataManager::V1::RequestStatusPerDestination>]
180
+ # A list of request statuses per destination. The order of the statuses
181
+ # matches the order of the destinations in the original request.
182
+ class RetrieveRequestStatusResponse
183
+ include ::Google::Protobuf::MessageExts
184
+ extend ::Google::Protobuf::MessageExts::ClassMethods
185
+ end
186
+
187
+ # The encoding type of the hashed identifying information.
188
+ module Encoding
189
+ # Unspecified Encoding type. Should never be used.
190
+ ENCODING_UNSPECIFIED = 0
191
+
192
+ # Hex encoding.
193
+ HEX = 1
194
+
195
+ # Base 64 encoding.
196
+ BASE64 = 2
197
+ end
198
+ end
199
+ end
200
+ end
201
+ end
@@ -0,0 +1,63 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Ads
22
+ module DataManager
23
+ module V1
24
+ # The match rate range of the upload or userlist.
25
+ module MatchRateRange
26
+ # The match rate range is unknown.
27
+ MATCH_RATE_RANGE_UNKNOWN = 0
28
+
29
+ # The match rate range is not eligible.
30
+ MATCH_RATE_RANGE_NOT_ELIGIBLE = 1
31
+
32
+ # The match rate range is less than 20% (in the interval `[0, 20)`).
33
+ MATCH_RATE_RANGE_LESS_THAN_20 = 2
34
+
35
+ # The match rate range is between 20% and 30% (in the interval `[20, 31)`).
36
+ MATCH_RATE_RANGE_20_TO_30 = 3
37
+
38
+ # The match rate range is between 31% and 40% (in the interval `[31, 41)`).
39
+ MATCH_RATE_RANGE_31_TO_40 = 4
40
+
41
+ # The match rate range is between 41% and 50% (in the interval `[41, 51)`).
42
+ MATCH_RATE_RANGE_41_TO_50 = 5
43
+
44
+ # The match rate range is between 51% and 60% (in the interval `[51, 61)`.
45
+ MATCH_RATE_RANGE_51_TO_60 = 6
46
+
47
+ # The match rate range is between 61% and 70% (in the interval `[61, 71)`).
48
+ MATCH_RATE_RANGE_61_TO_70 = 7
49
+
50
+ # The match rate range is between 71% and 80% (in the interval `[71, 81)`).
51
+ MATCH_RATE_RANGE_71_TO_80 = 8
52
+
53
+ # The match rate range is between 81% and 90% (in the interval `[81, 91)`).
54
+ MATCH_RATE_RANGE_81_TO_90 = 9
55
+
56
+ # The match rate range is between 91% and 100% (in the interval `[91,
57
+ # 100]`).
58
+ MATCH_RATE_RANGE_91_TO_100 = 10
59
+ end
60
+ end
61
+ end
62
+ end
63
+ end