google-ads-ad_manager-v1 0.a → 0.2.0

data/proto_docs/google/ads/admanager/v1/role_enums.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 AdManager
+      module V1
+        # Wrapper message for
+        # {::Google::Ads::AdManager::V1::RoleStatusEnum::RoleStatus RoleStatus}
+        class RoleStatusEnum
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The status of the role.
+          module RoleStatus
+            # No value specified.
+            ROLE_STATUS_UNSPECIFIED = 0
+
+            # Role is active.
+            ACTIVE = 1
+
+            # Role is inactive.
+            INACTIVE = 2
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/admanager/v1/role_messages.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 AdManager
+      module V1
+        # The `Role` resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the `Role`.
+        #     Format: `networks/{network_code}/roles/{role_id}`
+        # @!attribute [r] role_id
+        #   @return [::Integer]
+        #     Output only. `Role` ID.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the `Role`.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. The description of the `Role`.
+        # @!attribute [r] built_in
+        #   @return [::Boolean]
+        #     Output only. Whether the `Role` is a built-in or custom user role.
+        # @!attribute [r] status
+        #   @return [::Google::Ads::AdManager::V1::RoleStatusEnum::RoleStatus]
+        #     Output only. The status of the `Role`.
+        class Role
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/admanager/v1/role_service.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 AdManager
+      module V1
+        # Request object for `GetRole` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the Role.
+        #     Format: `networks/{network_code}/roles/{role_id}`
+        class GetRoleRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request object for `ListRoles` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent, which owns this collection of Roles.
+        #     Format: `networks/{network_code}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of `Roles` to return. The service may return
+        #     fewer than this value. If unspecified, at most 50 `Roles` 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 `ListRoles` call.
+        #     Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to `ListRoles` must match
+        #     the call that provided the page token.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Expression to filter the response.
+        #     See syntax details at
+        #     https://developers.google.com/ad-manager/api/beta/filters
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Expression to specify sorting order.
+        #     See syntax details at
+        #     https://developers.google.com/ad-manager/api/beta/filters#order
+        # @!attribute [rw] skip
+        #   @return [::Integer]
+        #     Optional. Number of individual resources to skip while paginating.
+        class ListRolesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response object for `ListRolesRequest` containing matching `Role` objects.
+        # @!attribute [rw] roles
+        #   @return [::Array<::Google::Ads::AdManager::V1::Role>]
+        #     The `Role` objects from the specified network.
+        # @!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.
+        # @!attribute [rw] total_size
+        #   @return [::Integer]
+        #     Total number of `Role` objects.
+        #     If a filter was included in the request, this reflects the total number
+        #     after the filtering is applied.
+        #
+        #     `total_size` will not be calculated in the response unless it has been
+        #     included in a response field mask. The response field mask can be provided
+        #     to the method by using the URL parameter `$fields` or `fields`, or by using
+        #     the HTTP/gRPC header `X-Goog-FieldMask`.
+        #
+        #     For more information, see
+        #     https://developers.google.com/ad-manager/api/beta/field-masks
+        class ListRolesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/admanager/v1/size.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 AdManager
+      module V1
+        # Represents the dimensions of an AdUnit, LineItem, or Creative.
+        # @!attribute [rw] width
+        #   @return [::Integer]
+        #     Required. The width of the [Creative](google.ads.admanager.v1.Creative),
+        #     [AdUnit](google.ads.admanager.v1.AdUnit), or
+        #     [LineItem](google.ads.admanager.v1.LineItem).
+        # @!attribute [rw] height
+        #   @return [::Integer]
+        #     Required. The height of the [Creative](google.ads.admanager.v1.Creative),
+        #     [AdUnit](google.ads.admanager.v1.AdUnit), or
+        #     [LineItem](google.ads.admanager.v1.LineItem).
+        # @!attribute [rw] size_type
+        #   @return [::Google::Ads::AdManager::V1::SizeTypeEnum::SizeType]
+        #     Required. The SizeType of the
+        #     [Creative](google.ads.admanager.v1.Creative),
+        #     [AdUnit](google.ads.admanager.v1.AdUnit), or
+        #     [LineItem](google.ads.admanager.v1.LineItem).
+        class Size
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/admanager/v1/size_type_enum.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 AdManager
+      module V1
+        # Wrapper message for
+        # {::Google::Ads::AdManager::V1::SizeTypeEnum::SizeType SizeType}.
+        class SizeTypeEnum
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The different Size types for an ad.
+          module SizeType
+            # Default value. This value is unused.
+            SIZE_TYPE_UNSPECIFIED = 0
+
+            # Dimension based size, an actual height and width in pixels.
+            PIXEL = 1
+
+            # Size is expressed as a ratio. For example, 4:1 could be
+            # met by a 100 x 25 sized image.
+            ASPECT_RATIO = 2
+
+            # Out-of-page (Interstitial) size that is not related to the slot it is
+            # served. This must be used with 1x1 size.
+            INTERSTITIAL = 3
+
+            # Size is ignored. This must be used with 1x1
+            # size.
+            IGNORED = 4
+
+            # Native size, which is a function of the how the client renders the
+            # creative. This must be used with 1x1 size.
+            NATIVE = 5
+
+            # Fluid size. Automatically sizes the ad by filling the width of the
+            # enclosing column and adjusting the height as appropriate. This must be
+            # used with 1x1 size.
+            FLUID = 6
+
+            # Audio size. Used with audio ads. This must be used with 1x1 size.
+            AUDIO = 7
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/admanager/v1/taxonomy_category_messages.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 AdManager
+      module V1
+        # The `TaxonomyCategory` resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the `TaxonomyCategory`.
+        #     Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}`
+        # @!attribute [r] taxonomy_category_id
+        #   @return [::Integer]
+        #     Output only. `TaxonomyCategory` ID.
+        # @!attribute [r] display_name
+        #   @return [::String]
+        #     Output only. Display name of the `TaxonomyCategory`.
+        # @!attribute [r] grouping_only
+        #   @return [::Boolean]
+        #     Output only. Whether this `TaxonomyCategory` only serves to group its
+        #     children.
+        # @!attribute [r] parent_taxonomy_category_id
+        #   @return [::Integer]
+        #     Output only. The ID of the parent category this `TaxonomyCategory` descends
+        #     from.
+        # @!attribute [r] taxonomy_type
+        #   @return [::Google::Ads::AdManager::V1::TaxonomyTypeEnum::TaxonomyType]
+        #     Output only. The taxonomy that this `TaxonomyCategory` belongs to.
+        # @!attribute [r] ancestor_names
+        #   @return [::Array<::String>]
+        #     Output only. The list of names of the ancestors of this `TaxonomyCategory`.
+        # @!attribute [r] ancestor_taxonomy_category_ids
+        #   @return [::Array<::Integer>]
+        #     Output only. The list of IDs of the ancestors of this `TaxonomyCategory`.
+        class TaxonomyCategory
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/admanager/v1/taxonomy_category_service.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 AdManager
+      module V1
+        # Request object for `GetTaxonomyCategory` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the TaxonomyCategory.
+        #     Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}`
+        class GetTaxonomyCategoryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request object for `ListTaxonomyCategories` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent, which owns this collection of TaxonomyCategories.
+        #     Format: `networks/{network_code}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of `TaxonomyCategories` to return. The service
+        #     may return fewer than this value. If unspecified, at most 50
+        #     `TaxonomyCategories` 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 `ListTaxonomyCategories`
+        #     call. Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to `ListTaxonomyCategories`
+        #     must match the call that provided the page token.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Expression to filter the response.
+        #     See syntax details at
+        #     https://developers.google.com/ad-manager/api/beta/filters
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Expression to specify sorting order.
+        #     See syntax details at
+        #     https://developers.google.com/ad-manager/api/beta/filters#order
+        # @!attribute [rw] skip
+        #   @return [::Integer]
+        #     Optional. Number of individual resources to skip while paginating.
+        class ListTaxonomyCategoriesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response object for `ListTaxonomyCategoriesRequest` containing matching
+        # `TaxonomyCategory` objects.
+        # @!attribute [rw] taxonomy_categories
+        #   @return [::Array<::Google::Ads::AdManager::V1::TaxonomyCategory>]
+        #     The `TaxonomyCategory` objects.
+        # @!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.
+        # @!attribute [rw] total_size
+        #   @return [::Integer]
+        #     Total number of `TaxonomyCategory` objects.
+        #     If a filter was included in the request, this reflects the total number
+        #     after the filtering is applied.
+        #
+        #     `total_size` will not be calculated in the response unless it has been
+        #     included in a response field mask. The response field mask can be provided
+        #     to the method by using the URL parameter `$fields` or `fields`, or by using
+        #     the HTTP/gRPC header `X-Goog-FieldMask`.
+        #
+        #     For more information, see
+        #     https://developers.google.com/ad-manager/api/beta/field-masks
+        class ListTaxonomyCategoriesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/admanager/v1/taxonomy_type_enum.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 AdManager
+      module V1
+        # Wrapper for
+        # {::Google::Ads::AdManager::V1::TaxonomyTypeEnum::TaxonomyType TaxonomyType}
+        class TaxonomyTypeEnum
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The taxonomy type of the IAB defined taxonomies.
+          # Used for Publisher provided signals.
+          module TaxonomyType
+            # Unspecified/not present
+            TAXONOMY_TYPE_UNSPECIFIED = 0
+
+            # The IAB Audience Taxonomy v1.1.
+            TAXONOMY_IAB_AUDIENCE_1_1 = 3
+
+            # The IAB Content Taxonomy v2.1.
+            TAXONOMY_IAB_CONTENT_2_1 = 4
+
+            # The IAB Content Taxonomy v2.2.
+            TAXONOMY_IAB_CONTENT_2_2 = 6
+
+            # The IAB Content Taxonomy v3.0.
+            TAXONOMY_IAB_CONTENT_3_0 = 5
+
+            # The PPS structured video signals taxonomy.
+            TAXONOMY_GOOGLE_STRUCTURED_VIDEO_1_0 = 7
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/admanager/v1/team_messages.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 AdManager
+      module V1
+        # A Team defines a grouping of users and what entities they have access to.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the `Team`.
+        #     Format: `networks/{network_code}/teams/{team_id}`
+        # @!attribute [r] team_id
+        #   @return [::Integer]
+        #     Output only. The unique ID of the Team. This value is assigned by Google.
+        #     Teams that are created by Google will have negative IDs.
+        class Team
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/admanager/v1/time_unit_enum.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 AdManager
+      module V1
+        # Wrapper message for TimeUnit.
+        class TimeUnitEnum
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Unit of time for the frequency cap.
+          module TimeUnit
+            # Default value. This value is unused.
+            TIME_UNIT_UNSPECIFIED = 0
+
+            # Minute
+            MINUTE = 1
+
+            # Hour
+            HOUR = 2
+
+            # Day
+            DAY = 3
+
+            # Week
+            WEEK = 4
+
+            # Month
+            MONTH = 5
+
+            # Lifetime
+            LIFETIME = 6
+
+            # Per pod of ads in a video stream. Only valid for entities in a
+            # VIDEO_PLAYER environment.
+            POD = 7
+
+            # Per video stream. Only valid for entities in a VIDEO_PLAYER environment.
+            STREAM = 8
+          end
+        end
+      end
+    end
+  end
+end