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

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

@@ -0,0 +1,53 @@
+# 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 `EntitySignalsMapping` resource.
+        # @!attribute [rw] audience_segment_id
+        #   @return [::Integer]
+        #     ID of an AudienceSegment that this mapping belongs to.
+        # @!attribute [rw] content_bundle_id
+        #   @return [::Integer]
+        #     ID of a ContentBundle that this mapping belongs to.
+        # @!attribute [rw] custom_targeting_value_id
+        #   @return [::Integer]
+        #     ID of a CustomValue that this mapping belongs to.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the `EntitySignalsMapping`.
+        #     Format:
+        #     `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}`
+        # @!attribute [r] entity_signals_mapping_id
+        #   @return [::Integer]
+        #     Output only. `EntitySignalsMapping` ID.
+        # @!attribute [rw] taxonomy_category_ids
+        #   @return [::Array<::Integer>]
+        #     Required. The IDs of the categories that are associated with the
+        #     referencing entity.
+        class EntitySignalsMapping
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,180 @@
+# 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 `GetEntitySignalsMapping` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the EntitySignalsMapping.
+        #     Format:
+        #     `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}`
+        class GetEntitySignalsMappingRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request object for `ListEntitySignalsMappings` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent, which owns this collection of EntitySignalsMappings.
+        #     Format: `networks/{network_code}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of `EntitySignalsMappings` to return. The
+        #     service may return fewer than this value. If unspecified, at most 50
+        #     `EntitySignalsMappings` 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
+        #     `ListEntitySignalsMappings` call. Provide this to retrieve the subsequent
+        #     page.
+        #
+        #     When paginating, all other parameters provided to
+        #     `ListEntitySignalsMappings` 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 ListEntitySignalsMappingsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request object for 'CreateEntitySignalsMapping' method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource where this EntitySignalsMapping will be
+        #     created. Format: `networks/{network_code}`
+        # @!attribute [rw] entity_signals_mapping
+        #   @return [::Google::Ads::AdManager::V1::EntitySignalsMapping]
+        #     Required. The EntitySignalsMapping object to create.
+        class CreateEntitySignalsMappingRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request object for 'UpdateEntitySignalsMapping' method.
+        # @!attribute [rw] entity_signals_mapping
+        #   @return [::Google::Ads::AdManager::V1::EntitySignalsMapping]
+        #     Required. The `EntitySignalsMapping` to update.
+        #
+        #     The EntitySignalsMapping's name is used to identify the
+        #     EntitySignalsMapping to update.
+        #     Format:
+        #     `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}`
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. The list of fields to update.
+        class UpdateEntitySignalsMappingRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response object for `ListEntitySignalsMappingsRequest` containing matching
+        # `EntitySignalsMapping` resources.
+        # @!attribute [rw] entity_signals_mappings
+        #   @return [::Array<::Google::Ads::AdManager::V1::EntitySignalsMapping>]
+        #     The `EntitySignalsMapping` 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 `EntitySignalsMappings`.
+        #     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 ListEntitySignalsMappingsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request object for `BatchCreateEntitySignalsMappings` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource where `EntitySignalsMappings` will be
+        #     created. Format: `networks/{network_code}` The parent field in the
+        #     CreateEntitySignalsMappingRequest must match this field.
+        # @!attribute [rw] requests
+        #   @return [::Array<::Google::Ads::AdManager::V1::CreateEntitySignalsMappingRequest>]
+        #     Required. The `EntitySignalsMapping` objects to create.
+        #     A maximum of 100 objects can be created in a batch.
+        class BatchCreateEntitySignalsMappingsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response object for `BatchCreateEntitySignalsMappings` method.
+        # @!attribute [rw] entity_signals_mappings
+        #   @return [::Array<::Google::Ads::AdManager::V1::EntitySignalsMapping>]
+        #     The `EntitySignalsMapping` objects created.
+        class BatchCreateEntitySignalsMappingsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request object for `BatchUpdateEntitySignalsMappings` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource where `EntitySignalsMappings` will be
+        #     updated. Format: `networks/{network_code}` The parent field in the
+        #     UpdateEntitySignalsMappingRequest must match this field.
+        # @!attribute [rw] requests
+        #   @return [::Array<::Google::Ads::AdManager::V1::UpdateEntitySignalsMappingRequest>]
+        #     Required. The `EntitySignalsMapping` objects to update.
+        #     A maximum of 100 objects can be updated in a batch.
+        class BatchUpdateEntitySignalsMappingsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response object for `BatchUpdateEntitySignalsMappings` method.
+        # @!attribute [rw] entity_signals_mappings
+        #   @return [::Array<::Google::Ads::AdManager::V1::EntitySignalsMapping>]
+        #     The `EntitySignalsMapping` objects updated.
+        class BatchUpdateEntitySignalsMappingsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/admanager/v1/environment_type_enum.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::EnvironmentTypeEnum::EnvironmentType EnvironmentType}.
+        class EnvironmentTypeEnum
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The different environments in which an ad can be shown.
+          module EnvironmentType
+            # No value specified
+            ENVIRONMENT_TYPE_UNSPECIFIED = 0
+
+            # A regular web browser.
+            BROWSER = 1
+
+            # Video players.
+            VIDEO_PLAYER = 2
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# 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 a Frequency Cap that can be applied to an entity.
+        # @!attribute [rw] max_impressions
+        #   @return [::Integer]
+        #     The maximum number of impressions for this frequency cap.
+        # @!attribute [rw] time_amount
+        #   @return [::Integer]
+        #     The number of time units over which the frequency cap is effective.
+        # @!attribute [rw] time_unit
+        #   @return [::Google::Ads::AdManager::V1::TimeUnitEnum::TimeUnit]
+        #     The units of time of this frequency cap.
+        class FrequencyCap
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# 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 Label is additional information that can be added to an entity.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the `Label`.
+        #     Format: `networks/{network_code}/labels/{label_id}`
+        class Label
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# 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 Network resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the Network.
+        #     Format: networks/\\{network_code}
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional. Display name for Network.
+        # @!attribute [r] network_code
+        #   @return [::String]
+        #     Output only. Network Code.
+        # @!attribute [r] property_code
+        #   @return [::String]
+        #     Output only. Property code.
+        # @!attribute [r] time_zone
+        #   @return [::String]
+        #     Output only. Time zone associated with the delivery of orders and
+        #     reporting.
+        # @!attribute [r] currency_code
+        #   @return [::String]
+        #     Output only. Primary currency code, in ISO-4217 format.
+        # @!attribute [rw] secondary_currency_codes
+        #   @return [::Array<::String>]
+        #     Optional. Currency codes that can be used as an alternative to the primary
+        #     currency code for trafficking Line Items.
+        # @!attribute [r] effective_root_ad_unit
+        #   @return [::String]
+        #     Output only. Top most [Ad Unit](google.ads.admanager.v1.AdUnit) to which
+        #     descendant Ad Units can be added.
+        #     Format: networks/\\{network_code}/adUnit/\\{ad_unit_id}
+        # @!attribute [r] test_network
+        #   @return [::Boolean]
+        #     Output only. Whether this is a test network.
+        # @!attribute [r] network_id
+        #   @return [::Integer]
+        #     Output only. Network ID.
+        class Network
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/admanager/v1/network_service.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
+        # Request to get Network
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Resource name of Network.
+        #     Format: networks/\\{network_code}
+        class GetNetworkRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request object for `ListNetworks` method.
+        class ListNetworksRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response object for `ListNetworks` method.
+        # @!attribute [rw] networks
+        #   @return [::Array<::Google::Ads::AdManager::V1::Network>]
+        #     The `Network`s a user has access to.
+        class ListNetworksResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/admanager/v1/order_enums.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
+        # {::Google::Ads::AdManager::V1::OrderStatusEnum::OrderStatus OrderStatus}.
+        class OrderStatusEnum
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The status of an Order.
+          module OrderStatus
+            # Default value. This value is unused.
+            ORDER_STATUS_UNSPECIFIED = 0
+
+            # Indicates that the Order has just been created but no approval has been
+            # requested yet.
+            DRAFT = 2
+
+            # Indicates that a request for approval for the Order has been made.
+            PENDING_APPROVAL = 3
+
+            # Indicates that the Order has been approved and is ready to serve.
+            APPROVED = 4
+
+            # Indicates that the Order has been disapproved and is not eligible to
+            # serve.
+            DISAPPROVED = 5
+
+            # This is a legacy state. Paused status should be checked on LineItems
+            # within the order.
+            PAUSED = 6
+
+            # Indicates that the Order has been canceled and cannot serve.
+            CANCELED = 7
+
+            # Indicates that the Order has been deleted.
+            DELETED = 8
+          end
+        end
+      end
+    end
+  end
+end