google-ads-ad_manager-v1 2.3.0 → 3.0.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 (49) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/ads/ad_manager/v1/ad_review_center_ad_service/rest/client.rb +3 -2
  3. data/lib/google/ads/ad_manager/v1/ad_unit_service/paths.rb +34 -0
  4. data/lib/google/ads/ad_manager/v1/ad_unit_service/rest/client.rb +624 -0
  5. data/lib/google/ads/ad_manager/v1/ad_unit_service/rest/service_stub.rb +434 -0
  6. data/lib/google/ads/ad_manager/v1/cms_metadata_value_service/rest/client.rb +2 -2
  7. data/lib/google/ads/ad_manager/v1/custom_targeting_key_service/rest/client.rb +538 -0
  8. data/lib/google/ads/ad_manager/v1/custom_targeting_key_service/rest/service_stub.rb +372 -0
  9. data/lib/google/ads/ad_manager/v1/line_item_service/credentials.rb +47 -0
  10. data/lib/google/ads/ad_manager/v1/line_item_service/paths.rb +64 -0
  11. data/lib/google/ads/ad_manager/v1/line_item_service/rest/client.rb +538 -0
  12. data/lib/google/ads/ad_manager/v1/line_item_service/rest/service_stub.rb +203 -0
  13. data/lib/google/ads/ad_manager/v1/line_item_service/rest.rb +52 -0
  14. data/lib/google/ads/ad_manager/v1/line_item_service.rb +48 -0
  15. data/lib/google/ads/ad_manager/v1/network_service/rest/client.rb +29 -4
  16. data/lib/google/ads/ad_manager/v1/rest.rb +1 -0
  17. data/lib/google/ads/ad_manager/v1/version.rb +1 -1
  18. data/lib/google/ads/ad_manager/v1.rb +1 -0
  19. data/lib/google/ads/admanager/v1/ad_review_center_ad_service_pb.rb +1 -1
  20. data/lib/google/ads/admanager/v1/ad_unit_service_pb.rb +15 -1
  21. data/lib/google/ads/admanager/v1/ad_unit_service_services_pb.rb +14 -0
  22. data/lib/google/ads/admanager/v1/cms_metadata_value_service_services_pb.rb +1 -1
  23. data/lib/google/ads/admanager/v1/custom_targeting_key_service_pb.rb +13 -1
  24. data/lib/google/ads/admanager/v1/custom_targeting_key_service_services_pb.rb +12 -0
  25. data/lib/google/ads/admanager/v1/goal_enums_pb.rb +45 -0
  26. data/lib/google/ads/admanager/v1/goal_pb.rb +44 -0
  27. data/lib/google/ads/admanager/v1/line_item_enums_pb.rb +43 -0
  28. data/lib/google/ads/admanager/v1/line_item_messages_pb.rb +54 -0
  29. data/lib/google/ads/admanager/v1/line_item_service_pb.rb +51 -0
  30. data/lib/google/ads/admanager/v1/line_item_service_services_pb.rb +47 -0
  31. data/lib/google/ads/admanager/v1/network_messages_pb.rb +1 -1
  32. data/lib/google/ads/admanager/v1/network_service_pb.rb +1 -1
  33. data/lib/google/ads/admanager/v1/order_messages_pb.rb +1 -1
  34. data/lib/google/ads/admanager/v1/report_definition_pb.rb +1 -1
  35. data/lib/google/ads/admanager/v1/report_messages_pb.rb +1 -1
  36. data/proto_docs/google/ads/admanager/v1/ad_review_center_ad_service.rb +3 -2
  37. data/proto_docs/google/ads/admanager/v1/ad_unit_service.rb +135 -0
  38. data/proto_docs/google/ads/admanager/v1/cms_metadata_value_service.rb +1 -1
  39. data/proto_docs/google/ads/admanager/v1/custom_targeting_key_service.rb +118 -0
  40. data/proto_docs/google/ads/admanager/v1/goal.rb +59 -0
  41. data/proto_docs/google/ads/admanager/v1/goal_enums.rb +136 -0
  42. data/proto_docs/google/ads/admanager/v1/line_item_enums.rb +90 -0
  43. data/proto_docs/google/ads/admanager/v1/line_item_messages.rb +74 -0
  44. data/proto_docs/google/ads/admanager/v1/line_item_service.rb +99 -0
  45. data/proto_docs/google/ads/admanager/v1/network_service.rb +31 -0
  46. data/proto_docs/google/ads/admanager/v1/order_messages.rb +3 -2
  47. data/proto_docs/google/ads/admanager/v1/report_definition.rb +926 -57
  48. data/proto_docs/google/ads/admanager/v1/report_messages.rb +4 -1
  49. metadata +18 -1
@@ -94,6 +94,124 @@ module Google
94
94
  include ::Google::Protobuf::MessageExts
95
95
  extend ::Google::Protobuf::MessageExts::ClassMethods
96
96
  end
97
+
98
+ # Request object for `CreateCustomTargetingKey` method.
99
+ # @!attribute [rw] parent
100
+ # @return [::String]
101
+ # Required. The parent resource where this `CustomTargetingKey` will be
102
+ # created. Format: `networks/{network_code}`
103
+ # @!attribute [rw] custom_targeting_key
104
+ # @return [::Google::Ads::AdManager::V1::CustomTargetingKey]
105
+ # Required. The `CustomTargetingKey` to create.
106
+ class CreateCustomTargetingKeyRequest
107
+ include ::Google::Protobuf::MessageExts
108
+ extend ::Google::Protobuf::MessageExts::ClassMethods
109
+ end
110
+
111
+ # Request object for `BatchCreateCustomTargetingKeys` method.
112
+ # @!attribute [rw] parent
113
+ # @return [::String]
114
+ # Required. The parent resource where `CustomTargetingKeys` will be created.
115
+ # Format: `networks/{network_code}`
116
+ # The parent field in the CreateCustomTargetingKeyRequest must match this
117
+ # field.
118
+ # @!attribute [rw] requests
119
+ # @return [::Array<::Google::Ads::AdManager::V1::CreateCustomTargetingKeyRequest>]
120
+ # Required. The `CustomTargetingKey` objects to create.
121
+ # A maximum of 100 objects can be created in a batch.
122
+ class BatchCreateCustomTargetingKeysRequest
123
+ include ::Google::Protobuf::MessageExts
124
+ extend ::Google::Protobuf::MessageExts::ClassMethods
125
+ end
126
+
127
+ # Response object for `BatchCreateCustomTargetingKeys` method.
128
+ # @!attribute [rw] custom_targeting_keys
129
+ # @return [::Array<::Google::Ads::AdManager::V1::CustomTargetingKey>]
130
+ # The `CustomTargetingKey` objects created.
131
+ class BatchCreateCustomTargetingKeysResponse
132
+ include ::Google::Protobuf::MessageExts
133
+ extend ::Google::Protobuf::MessageExts::ClassMethods
134
+ end
135
+
136
+ # Request object for `UpdateCustomTargetingKey` method.
137
+ # @!attribute [rw] custom_targeting_key
138
+ # @return [::Google::Ads::AdManager::V1::CustomTargetingKey]
139
+ # Required. The `CustomTargetingKey` to update.
140
+ #
141
+ # The `CustomTargetingKey`'s `name` is used to identify the
142
+ # `CustomTargetingKey` to update.
143
+ # @!attribute [rw] update_mask
144
+ # @return [::Google::Protobuf::FieldMask]
145
+ # Required. The list of fields to update.
146
+ class UpdateCustomTargetingKeyRequest
147
+ include ::Google::Protobuf::MessageExts
148
+ extend ::Google::Protobuf::MessageExts::ClassMethods
149
+ end
150
+
151
+ # Request object for `BatchUpdateCustomTargetingKeys` method.
152
+ # @!attribute [rw] parent
153
+ # @return [::String]
154
+ # Required. The parent resource where `CustomTargetingKeys` will be updated.
155
+ # Format: `networks/{network_code}`
156
+ # The parent field in the UpdateCustomTargetingKeyRequest must match this
157
+ # field.
158
+ # @!attribute [rw] requests
159
+ # @return [::Array<::Google::Ads::AdManager::V1::UpdateCustomTargetingKeyRequest>]
160
+ # Required. The `CustomTargetingKey` objects to update.
161
+ # A maximum of 100 objects can be updated in a batch.
162
+ class BatchUpdateCustomTargetingKeysRequest
163
+ include ::Google::Protobuf::MessageExts
164
+ extend ::Google::Protobuf::MessageExts::ClassMethods
165
+ end
166
+
167
+ # Response object for `BatchUpdateCustomTargetingKeys` method.
168
+ # @!attribute [rw] custom_targeting_keys
169
+ # @return [::Array<::Google::Ads::AdManager::V1::CustomTargetingKey>]
170
+ # The `CustomTargetingKey` objects updated.
171
+ class BatchUpdateCustomTargetingKeysResponse
172
+ include ::Google::Protobuf::MessageExts
173
+ extend ::Google::Protobuf::MessageExts::ClassMethods
174
+ end
175
+
176
+ # Request object for `BatchActivateCustomTargetingKeys` method.
177
+ # @!attribute [rw] parent
178
+ # @return [::String]
179
+ # Required. Format: `networks/{network_code}`
180
+ # @!attribute [rw] names
181
+ # @return [::Array<::String>]
182
+ # Required. The resource names of the `CustomTargetingKey`s to activate.
183
+ # Format:
184
+ # `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`
185
+ class BatchActivateCustomTargetingKeysRequest
186
+ include ::Google::Protobuf::MessageExts
187
+ extend ::Google::Protobuf::MessageExts::ClassMethods
188
+ end
189
+
190
+ # Response object for `BatchActivateCustomTargetingKeys` method.
191
+ class BatchActivateCustomTargetingKeysResponse
192
+ include ::Google::Protobuf::MessageExts
193
+ extend ::Google::Protobuf::MessageExts::ClassMethods
194
+ end
195
+
196
+ # Request message for `BatchDeactivateCustomTargetingKeys` method.
197
+ # @!attribute [rw] parent
198
+ # @return [::String]
199
+ # Required. Format: `networks/{network_code}`
200
+ # @!attribute [rw] names
201
+ # @return [::Array<::String>]
202
+ # Required. The resource names of the `CustomTargetingKey`s to deactivate.
203
+ # Format:
204
+ # `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`
205
+ class BatchDeactivateCustomTargetingKeysRequest
206
+ include ::Google::Protobuf::MessageExts
207
+ extend ::Google::Protobuf::MessageExts::ClassMethods
208
+ end
209
+
210
+ # Response object for `BatchDeactivateCustomTargetingKeys` method.
211
+ class BatchDeactivateCustomTargetingKeysResponse
212
+ include ::Google::Protobuf::MessageExts
213
+ extend ::Google::Protobuf::MessageExts::ClassMethods
214
+ end
97
215
  end
98
216
  end
99
217
  end
@@ -0,0 +1,59 @@
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 AdManager
23
+ module V1
24
+ # Defines the criteria a {::Google::Ads::AdManager::V1::LineItem LineItem} needs to
25
+ # satisfy to meet its delivery goal.
26
+ # @!attribute [rw] goal_type
27
+ # @return [::Google::Ads::AdManager::V1::GoalTypeEnum::GoalType]
28
+ # The type of the goal for the LineItem. It defines the period over which the
29
+ # goal should be reached.
30
+ # @!attribute [rw] unit_type
31
+ # @return [::Google::Ads::AdManager::V1::UnitTypeEnum::UnitType]
32
+ # The type of the goal unit for the LineItem.
33
+ # @!attribute [rw] units
34
+ # @return [::Integer]
35
+ # If this is a primary goal, it represents the number or percentage of
36
+ # impressions or clicks that will be reserved. If the line item is of type
37
+ # {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::SPONSORSHIP LineItemTypeEnum.LineItemType.SPONSORSHIP},
38
+ # it represents the percentage of available impressions reserved. If the line
39
+ # item is of type
40
+ # {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::BULK LineItemTypeEnum.LineItemType.BULK}
41
+ # or
42
+ # {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::PRICE_PRIORITY LineItemTypeEnum.LineItemType.PRICE_PRIORITY},
43
+ # it represents the number of remaining impressions reserved. If the line
44
+ # item is of type
45
+ # {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::NETWORK LineItemTypeEnum.LineItemType.NETWORK}
46
+ # or
47
+ # {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::HOUSE LineItemTypeEnum.LineItemType.HOUSE},
48
+ # it represents the percentage of remaining impressions reserved. <p>If this
49
+ # is an impression cap goal, it represents the number of impressions or
50
+ # conversions that the line item will stop serving at if reached. For valid
51
+ # line item types, see [LineItem.impressions_cap][].
52
+ class Goal
53
+ include ::Google::Protobuf::MessageExts
54
+ extend ::Google::Protobuf::MessageExts::ClassMethods
55
+ end
56
+ end
57
+ end
58
+ end
59
+ end
@@ -0,0 +1,136 @@
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 AdManager
23
+ module V1
24
+ # Wrapper message for
25
+ # {::Google::Ads::AdManager::V1::GoalTypeEnum::GoalType GoalType}.
26
+ class GoalTypeEnum
27
+ include ::Google::Protobuf::MessageExts
28
+ extend ::Google::Protobuf::MessageExts::ClassMethods
29
+
30
+ # Specifies the type of the goal for a LineItem.
31
+ module GoalType
32
+ # Default value. This value is unused.
33
+ GOAL_TYPE_UNSPECIFIED = 0
34
+
35
+ # No goal is specified for the number of ads delivered.
36
+ # The line item {::Google::Ads::AdManager::V1::LineItem#line_item_type type}
37
+ # must be one of:
38
+ #
39
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::PRICE_PRIORITY LineItemTypeEnum.LineItemType.PRICE_PRIORITY}
40
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::AD_EXCHANGE LineItemTypeEnum.LineItemType.AD_EXCHANGE}
41
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::CLICK_TRACKING LineItemTypeEnum.LineItemType.CLICK_TRACKING}
42
+ NONE = 1
43
+
44
+ # There is a goal on the number of ads delivered for this line item during
45
+ # its entire lifetime.
46
+ # The line item {::Google::Ads::AdManager::V1::LineItem#line_item_type type}
47
+ # must be one of:
48
+ #
49
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::STANDARD LineItemTypeEnum.LineItemType.STANDARD}
50
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::BULK LineItemTypeEnum.LineItemType.BULK}
51
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::PRICE_PRIORITY LineItemTypeEnum.LineItemType.PRICE_PRIORITY}
52
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::ADSENSE LineItemTypeEnum.LineItemType.ADSENSE}
53
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::AD_EXCHANGE LineItemTypeEnum.LineItemType.AD_EXCHANGE}
54
+ # * [LineItemTypeEnum.LineItemType.ADMOB][]
55
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::CLICK_TRACKING LineItemTypeEnum.LineItemType.CLICK_TRACKING}
56
+ LIFETIME = 2
57
+
58
+ # There is a daily goal on the number of ads delivered for this line item.
59
+ # The line item {::Google::Ads::AdManager::V1::LineItem#line_item_type type}
60
+ # must be one of:
61
+ #
62
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::SPONSORSHIP LineItemTypeEnum.LineItemType.SPONSORSHIP}
63
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::NETWORK LineItemTypeEnum.LineItemType.NETWORK}
64
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::PRICE_PRIORITY LineItemTypeEnum.LineItemType.PRICE_PRIORITY}
65
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::HOUSE LineItemTypeEnum.LineItemType.HOUSE}
66
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::ADSENSE LineItemTypeEnum.LineItemType.ADSENSE}
67
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::AD_EXCHANGE LineItemTypeEnum.LineItemType.AD_EXCHANGE}
68
+ # * [LineItemTypeEnum.LineItemType.ADMOB][]
69
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::BUMPER LineItemTypeEnum.LineItemType.BUMPER}
70
+ DAILY = 3
71
+ end
72
+ end
73
+
74
+ # Wrapper message for
75
+ # {::Google::Ads::AdManager::V1::UnitTypeEnum::UnitType UnitType}.
76
+ class UnitTypeEnum
77
+ include ::Google::Protobuf::MessageExts
78
+ extend ::Google::Protobuf::MessageExts::ClassMethods
79
+
80
+ # Indicates the type of unit used for defining a reservation. The
81
+ # [LineItem.cost_type][] can differ from the UnitType - an
82
+ # ad can have an impression goal, but be billed by its click. Usually
83
+ # CostType and UnitType will refer to the same unit.
84
+ module UnitType
85
+ # Default value. This value is unused.
86
+ UNIT_TYPE_UNSPECIFIED = 0
87
+
88
+ # The number of impressions served by creatives associated with the line
89
+ # item.
90
+ IMPRESSIONS = 1
91
+
92
+ # The number of clicks reported by creatives associated with the line item.
93
+ # The line item {::Google::Ads::AdManager::V1::LineItem#line_item_type type}
94
+ # must be one of:
95
+ #
96
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::STANDARD LineItemTypeEnum.LineItemType.STANDARD}
97
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::BULK LineItemTypeEnum.LineItemType.BULK}
98
+ # * {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::PRICE_PRIORITY LineItemTypeEnum.LineItemType.PRICE_PRIORITY}
99
+ CLICKS = 2
100
+
101
+ # The number of click-through Cost-Per-Action (CPA) conversions from
102
+ # creatives associated with the line item. This is only supported as
103
+ # secondary goal and the [LineItem.cost_type][] must be
104
+ # [CostTypeEnum.CostType.CPA][].
105
+ CLICK_THROUGH_CPA_CONVERSIONS = 3
106
+
107
+ # The number of view-through Cost-Per-Action (CPA) conversions from
108
+ # creatives associated with the line item. This is only supported as
109
+ # secondary goal and the [LineItem.cost_type][] must be
110
+ # [CostTypeEnum.CostType.CPA}.
111
+ VIEW_THROUGH_CPA_CONVERSIONS = 4
112
+
113
+ # The number of total Cost-Per-Action (CPA) conversions from creatives
114
+ # associated with the line item. This is only supported as secondary goal
115
+ # and the [LineItem.cost_type} must be [CostTypeEnum.CostType.CPA}.
116
+ TOTAL_CPA_CONVERSIONS = 5
117
+
118
+ # The number of viewable impressions reported by creatives associated with
119
+ # the line item. The
120
+ # {::Google::Ads::AdManager::V1::LineItem#line_item_type LineItem.line_item_type}
121
+ # must be
122
+ # {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::STANDARD LineItemTypeEnum.LineItemType.STANDARD}.
123
+ VIEWABLE_IMPRESSIONS = 6
124
+
125
+ # The number of in-target impressions reported by third party measurements.
126
+ # The
127
+ # {::Google::Ads::AdManager::V1::LineItem#line_item_type LineItem.line_item_type}
128
+ # must be
129
+ # {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType::STANDARD LineItemTypeEnum.LineItemType.STANDARD}.
130
+ IN_TARGET_IMPRESSIONS = 7
131
+ end
132
+ end
133
+ end
134
+ end
135
+ end
136
+ end
@@ -0,0 +1,90 @@
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 AdManager
23
+ module V1
24
+ # Wrapper message for
25
+ # {::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType LineItemType}.
26
+ class LineItemTypeEnum
27
+ include ::Google::Protobuf::MessageExts
28
+ extend ::Google::Protobuf::MessageExts::ClassMethods
29
+
30
+ # Indicates the priority of a LineItem, determined by the way in which
31
+ # impressions are reserved to be served for it.
32
+ module LineItemType
33
+ # Not specified value.
34
+ LINE_ITEM_TYPE_UNSPECIFIED = 0
35
+
36
+ # The type of LineItem for which a percentage of all the impressions that
37
+ # are being sold are reserved.
38
+ SPONSORSHIP = 12
39
+
40
+ # The type of LineItem for which a fixed quantity of impressions or
41
+ # clicks are reserved.
42
+ STANDARD = 13
43
+
44
+ # The type of LineItem most commonly used to fill a site's unsold
45
+ # inventory if not contractually obligated to deliver a requested number
46
+ # of impressions. Uses daily percentage of unsold impressions or clicks.
47
+ NETWORK = 9
48
+
49
+ # The type of LineItem for which a fixed quantity of impressions or
50
+ # clicks will be delivered at a priority lower than the STANDARD type.
51
+ BULK = 4
52
+
53
+ # The type of LineItem most commonly used to fill a site's unsold
54
+ # inventory if not contractually obligated to deliver a requested number
55
+ # of impressions. Uses fixed quantity percentage of unsold impressions or
56
+ # clicks.
57
+ PRICE_PRIORITY = 11
58
+
59
+ # The type of LineItem typically used for ads that promote products and
60
+ # services chosen by the publisher.
61
+ HOUSE = 7
62
+
63
+ # The type of LineItem used for ads that track ads being served
64
+ # externally of Ad Manager.
65
+ CLICK_TRACKING = 6
66
+
67
+ # Targets the LineItem to specific inventory available to AdSense buyers.
68
+ ADSENSE = 2
69
+
70
+ # Targets the LineItem to specific inventory available to Authorized Buyers
71
+ # and the Open Auction.
72
+ AD_EXCHANGE = 3
73
+
74
+ # Represents a non-monetizable video LineItem that targets one or more
75
+ # bumper positions, which are short house video messages used by
76
+ # publishers to separate content from ad breaks.
77
+ BUMPER = 5
78
+
79
+ # The type of LineItem for which there are no impressions reserved, and
80
+ # will serve for a second price bid.
81
+ PREFERRED_DEAL = 10
82
+
83
+ # The type of LineItem used for configuring audience extension campaigns.
84
+ AUDIENCE_EXTENSION = 14
85
+ end
86
+ end
87
+ end
88
+ end
89
+ end
90
+ end
@@ -0,0 +1,74 @@
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 AdManager
23
+ module V1
24
+ # A LineItem contains information about how specific ad creatives are intended
25
+ # to serve to your website or app along with pricing and other delivery
26
+ # details.
27
+ # @!attribute [rw] name
28
+ # @return [::String]
29
+ # Identifier. The resource name of the `LineItem`.
30
+ # Format: `networks/{network_code}/lineItems/{line_item_id}`
31
+ # @!attribute [r] order
32
+ # @return [::String]
33
+ # Output only. The ID of the Order to which the LineItem belongs. This
34
+ # attribute is required. Format: `networks/{network_code}/orders/{order}`
35
+ # @!attribute [rw] display_name
36
+ # @return [::String]
37
+ # Required. The name of the line item. This attribute is required and has a
38
+ # maximum length of 255 characters.
39
+ # @!attribute [rw] start_time
40
+ # @return [::Google::Protobuf::Timestamp]
41
+ # Required. The date and time on which the LineItem is enabled to begin
42
+ # serving. This attribute is required and must be in the future.
43
+ # @!attribute [r] end_time
44
+ # @return [::Google::Protobuf::Timestamp]
45
+ # Output only. The timestamp when the LineItem will stop serving. This
46
+ # attribute is read-only and includes auto extension days.
47
+ # @!attribute [rw] line_item_type
48
+ # @return [::Google::Ads::AdManager::V1::LineItemTypeEnum::LineItemType]
49
+ # Required. Indicates the line item type of a LineItem. This attribute is
50
+ # required. The line item type determines the default priority of the line
51
+ # item. More information can be found at
52
+ # https://support.google.com/admanager/answer/177279.
53
+ # @!attribute [rw] rate
54
+ # @return [::Google::Type::Money]
55
+ # Required. The amount of money to spend per impression or click.
56
+ # @!attribute [r] budget
57
+ # @return [::Google::Type::Money]
58
+ # Output only. The amount of money allocated to the LineItem. This attribute
59
+ # is readonly and is populated by Google. The currency code is readonly.
60
+ # @!attribute [rw] custom_field_values
61
+ # @return [::Array<::Google::Ads::AdManager::V1::CustomFieldValue>]
62
+ # Optional. The values of the custom fields associated with this line item.
63
+ # @!attribute [rw] goal
64
+ # @return [::Google::Ads::AdManager::V1::Goal]
65
+ # Optional. The primary goal that this LineItem is associated with, which is
66
+ # used in its pacing and budgeting.
67
+ class LineItem
68
+ include ::Google::Protobuf::MessageExts
69
+ extend ::Google::Protobuf::MessageExts::ClassMethods
70
+ end
71
+ end
72
+ end
73
+ end
74
+ end
@@ -0,0 +1,99 @@
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 AdManager
23
+ module V1
24
+ # Request object for `GetLineItem` method.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Required. The resource name of the LineItem.
28
+ # Format: `networks/{network_code}/lineItems/{line_item_id}`
29
+ class GetLineItemRequest
30
+ include ::Google::Protobuf::MessageExts
31
+ extend ::Google::Protobuf::MessageExts::ClassMethods
32
+ end
33
+
34
+ # Request object for `ListLineItems` method.
35
+ # @!attribute [rw] parent
36
+ # @return [::String]
37
+ # Required. The parent, which owns this collection of LineItems.
38
+ # Format: `networks/{network_code}`
39
+ # @!attribute [rw] page_size
40
+ # @return [::Integer]
41
+ # Optional. The maximum number of `LineItems` to return. The service may
42
+ # return fewer than this value. If unspecified, at most 50 `LineItems` will
43
+ # be returned. The maximum value is 1000; values greater than 1000 will be
44
+ # coerced to 1000.
45
+ # @!attribute [rw] page_token
46
+ # @return [::String]
47
+ # Optional. A page token, received from a previous `ListLineItems` call.
48
+ # Provide this to retrieve the subsequent page.
49
+ #
50
+ # When paginating, all other parameters provided to `ListLineItems` must
51
+ # match the call that provided the page token.
52
+ # @!attribute [rw] filter
53
+ # @return [::String]
54
+ # Optional. Expression to filter the response.
55
+ # See syntax details at
56
+ # https://developers.google.com/ad-manager/api/beta/filters
57
+ # @!attribute [rw] order_by
58
+ # @return [::String]
59
+ # Optional. Expression to specify sorting order.
60
+ # See syntax details at
61
+ # https://developers.google.com/ad-manager/api/beta/filters#order
62
+ # @!attribute [rw] skip
63
+ # @return [::Integer]
64
+ # Optional. Number of individual resources to skip while paginating.
65
+ class ListLineItemsRequest
66
+ include ::Google::Protobuf::MessageExts
67
+ extend ::Google::Protobuf::MessageExts::ClassMethods
68
+ end
69
+
70
+ # Response object for `ListLineItemsRequest` containing matching `LineItem`
71
+ # objects.
72
+ # @!attribute [rw] line_items
73
+ # @return [::Array<::Google::Ads::AdManager::V1::LineItem>]
74
+ # The `LineItem` objects from the specified network.
75
+ # @!attribute [rw] next_page_token
76
+ # @return [::String]
77
+ # A token, which can be sent as `page_token` to retrieve the next page.
78
+ # If this field is omitted, there are no subsequent pages.
79
+ # @!attribute [rw] total_size
80
+ # @return [::Integer]
81
+ # Total number of `LineItem` objects.
82
+ # If a filter was included in the request, this reflects the total number
83
+ # after the filtering is applied.
84
+ #
85
+ # `total_size` won't be calculated in the response unless it has been
86
+ # included in a response field mask. The response field mask can be provided
87
+ # to the method by using the URL parameter `$fields` or `fields`, or by using
88
+ # the HTTP/gRPC header `X-Goog-FieldMask`.
89
+ #
90
+ # For more information, see
91
+ # https://developers.google.com/ad-manager/api/beta/field-masks
92
+ class ListLineItemsResponse
93
+ include ::Google::Protobuf::MessageExts
94
+ extend ::Google::Protobuf::MessageExts::ClassMethods
95
+ end
96
+ end
97
+ end
98
+ end
99
+ end
@@ -32,6 +32,22 @@ module Google
32
32
  end
33
33
 
34
34
  # Request object for `ListNetworks` method.
35
+ # @!attribute [rw] page_size
36
+ # @return [::Integer]
37
+ # Optional. The maximum number of `Network`s to return. The service may
38
+ # return fewer than this value. If unspecified, at most 50 `Network`s will be
39
+ # returned. The maximum value is 1000; values greater than 1000 will be
40
+ # coerced to 1000.
41
+ # @!attribute [rw] page_token
42
+ # @return [::String]
43
+ # Optional. A page token, received from a previous `ListNetworks` call.
44
+ # Provide this to retrieve the subsequent page.
45
+ #
46
+ # When paginating, all other parameters provided to `ListNetworks` must match
47
+ # the call that provided the page token.
48
+ # @!attribute [rw] skip
49
+ # @return [::Integer]
50
+ # Optional. Number of individual resources to skip while paginating.
35
51
  class ListNetworksRequest
36
52
  include ::Google::Protobuf::MessageExts
37
53
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -41,6 +57,21 @@ module Google
41
57
  # @!attribute [rw] networks
42
58
  # @return [::Array<::Google::Ads::AdManager::V1::Network>]
43
59
  # The `Network`s a user has access to.
60
+ # @!attribute [rw] next_page_token
61
+ # @return [::String]
62
+ # A token, which can be sent as `page_token` to retrieve the next page.
63
+ # If this field is omitted, there are no subsequent pages.
64
+ # @!attribute [rw] total_size
65
+ # @return [::Integer]
66
+ # Total number of `Network`s.
67
+ #
68
+ # `total_size` won't be calculated in the response unless it has been
69
+ # included in a response field mask. The response field mask can be provided
70
+ # to the method by using the URL parameter `$fields` or `fields`, or by using
71
+ # the HTTP/gRPC header `X-Goog-FieldMask`.
72
+ #
73
+ # For more information, see
74
+ # https://developers.google.com/ad-manager/api/beta/field-masks
44
75
  class ListNetworksResponse
45
76
  include ::Google::Protobuf::MessageExts
46
77
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -42,8 +42,9 @@ module Google
42
42
  # Order. Format: "networks/\\{network_code}/users/\\{user_id}"
43
43
  # @!attribute [rw] advertiser_contacts
44
44
  # @return [::Array<::String>]
45
- # Optional. The resource names of Contacts from the advertiser of this Order.
46
- # Format: "networks/\\{network_code}/contacts/\\{contact_id}"
45
+ # Optional. Unordered list. The resource names of Contacts from the
46
+ # advertiser of this Order. Format:
47
+ # "networks/\\{network_code}/contacts/\\{contact_id}"
47
48
  # @!attribute [rw] advertiser
48
49
  # @return [::String]
49
50
  # Required. The resource name of the Company, which is of type