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

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

@@ -0,0 +1,149 @@
+# 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 `Order` resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the `Order`.
+        #     Format: `networks/{network_code}/orders/{order_id}`
+        # @!attribute [r] order_id
+        #   @return [::Integer]
+        #     Output only. Order ID.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the Order.  This value has a maximum length
+        #     of 255 characters.
+        # @!attribute [rw] programmatic
+        #   @return [::Boolean]
+        #     Optional. Specifies whether or not the Order is a programmatic order.
+        # @!attribute [rw] trafficker
+        #   @return [::String]
+        #     Required. The resource name of the User responsible for trafficking the
+        #     Order. Format: "networks/\\{network_code}/users/\\{user_id}"
+        # @!attribute [rw] advertiser_contacts
+        #   @return [::Array<::String>]
+        #     Optional. The resource names of Contacts from the advertiser of this Order.
+        #     Format: "networks/\\{network_code}/contacts/\\{contact_id}"
+        # @!attribute [rw] advertiser
+        #   @return [::String]
+        #     Required. The resource name of the Company, which is of type
+        #     Company.Type.ADVERTISER, to which this order belongs. Format:
+        #     "networks/\\{network_code}/companies/\\{company_id}"
+        # @!attribute [rw] agency_contacts
+        #   @return [::Array<::String>]
+        #     Optional. The resource names of Contacts from the advertising Agency of
+        #     this Order. Format: "networks/\\{network_code}/contacts/\\{contact_id}"
+        # @!attribute [rw] agency
+        #   @return [::String]
+        #     Optional. The resource name of the Company, which is of type
+        #     Company.Type.AGENCY, with which this order is associated. Format:
+        #     "networks/\\{network_code}/companies/\\{company_id}"
+        # @!attribute [rw] applied_teams
+        #   @return [::Array<::String>]
+        #     Optional. The resource names of Teams directly applied to this Order.
+        #     Format: "networks/\\{network_code}/teams/\\{team_id}"
+        # @!attribute [r] effective_teams
+        #   @return [::Array<::String>]
+        #     Output only. The resource names of Teams applied to this Order including
+        #     inherited values. Format: "networks/\\{network_code}/teams/\\{team_id}"
+        # @!attribute [r] creator
+        #   @return [::String]
+        #     Output only. The resource name of the User who created the Order on behalf
+        #     of the advertiser. This value is assigned by Google. Format:
+        #     "networks/\\{network_code}/users/\\{user_id}"
+        # @!attribute [r] currency_code
+        #   @return [::String]
+        #     Output only. The ISO 4217 3-letter currency code for the currency used by
+        #     the Order. This value is the network's currency code.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The instant at which the Order and its associated line items
+        #     are eligible to begin serving. This attribute is derived from the line item
+        #     of the order that has the earliest LineItem.start_time.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The instant at which the Order and its associated line items
+        #     stop being served. This attribute is derived from the line item of the
+        #     order that has the latest LineItem.end_time.
+        # @!attribute [r] unlimited_end_time
+        #   @return [::Boolean]
+        #     Output only. Indicates whether or not this Order has an end time.
+        # @!attribute [rw] external_order_id
+        #   @return [::Integer]
+        #     Optional. An arbitrary ID to associate to the Order, which can be used as a
+        #     key to an external system.
+        # @!attribute [r] archived
+        #   @return [::Boolean]
+        #     Output only. The archival status of the Order.
+        # @!attribute [r] last_modified_by_app
+        #   @return [::String]
+        #     Output only. The application which modified this order. This attribute is
+        #     assigned by Google.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The instant this Order was last modified.
+        # @!attribute [rw] notes
+        #   @return [::String]
+        #     Optional. Provides any additional notes that may annotate the Order. This
+        #     attribute has a maximum length of 65,535 characters.
+        # @!attribute [rw] po_number
+        #   @return [::String]
+        #     Optional. The purchase order number for the Order. This value has a maximum
+        #     length of 63 characters.
+        # @!attribute [r] status
+        #   @return [::Google::Ads::AdManager::V1::OrderStatusEnum::OrderStatus]
+        #     Output only. The status of the Order.
+        # @!attribute [rw] salesperson
+        #   @return [::String]
+        #     Optional. The resource name of the User responsible for the sales of the
+        #     Order. Format: "networks/\\{network_code}/users/\\{user_id}"
+        # @!attribute [rw] secondary_salespeople
+        #   @return [::Array<::String>]
+        #     Optional. Unordered list. The resource names of the secondary salespeople
+        #     associated with the order. Format:
+        #     "networks/\\{network_code}/users/\\{user_id}"
+        # @!attribute [rw] secondary_traffickers
+        #   @return [::Array<::String>]
+        #     Optional. Unordered list. The resource names of the secondary traffickers
+        #     associated with the order. Format:
+        #     "networks/\\{network_code}/users/\\{user_id}"
+        # @!attribute [rw] applied_labels
+        #   @return [::Array<::Google::Ads::AdManager::V1::AppliedLabel>]
+        #     Optional. The set of labels applied directly to this order.
+        # @!attribute [r] effective_applied_labels
+        #   @return [::Array<::Google::Ads::AdManager::V1::AppliedLabel>]
+        #     Output only. Contains the set of labels applied directly to the order as
+        #     well as those inherited from the company that owns the order. If a label
+        #     has been negated, only the negated label is returned. This field is
+        #     assigned by Google.
+        # @!attribute [rw] custom_field_values
+        #   @return [::Array<::Google::Ads::AdManager::V1::CustomFieldValue>]
+        #     Optional. The set of custom field values to this order.
+        class Order
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/admanager/v1/order_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 `GetOrder` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the Order.
+        #     Format: `networks/{network_code}/orders/{order_id}`
+        class GetOrderRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request object for `ListOrders` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent, which owns this collection of Orders.
+        #     Format: `networks/{network_code}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of `Orders` to return. The service may return
+        #     fewer than this value. If unspecified, at most 50 `Orders` 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 `ListOrders` call.
+        #     Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to `ListOrders` 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 ListOrdersRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response object for `ListOrdersRequest` containing matching `Order`
+        # resources.
+        # @!attribute [rw] orders
+        #   @return [::Array<::Google::Ads::AdManager::V1::Order>]
+        #     The `Order` 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 `Orders`.
+        #     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 ListOrdersResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/admanager/v1/placement_enums.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
+        # Wrapper message for
+        # {::Google::Ads::AdManager::V1::PlacementStatusEnum::PlacementStatus PlacementStatus}
+        class PlacementStatusEnum
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Status of the placement.
+          module PlacementStatus
+            # Not specified value.
+            PLACEMENT_STATUS_UNSPECIFIED = 0
+
+            # Stats are collected, user-visible.
+            ACTIVE = 1
+
+            # No stats collected, not user-visible.
+            INACTIVE = 2
+
+            # No stats collected, user-visible.
+            ARCHIVED = 3
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# 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 `Placement` resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the `Placement`.
+        #     Format: `networks/{network_code}/placements/{placement_id}`
+        # @!attribute [r] placement_id
+        #   @return [::Integer]
+        #     Output only. `Placement` ID.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the placement. Its maximum length is 255
+        #     characters.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. A description of the Placement. This value is optional and its
+        #     maximum length is 65,535 characters.
+        # @!attribute [r] placement_code
+        #   @return [::String]
+        #     Output only. A string used to uniquely identify the Placement for purposes
+        #     of serving the ad. This attribute is read-only and is assigned by Google
+        #     when a placement is created.
+        # @!attribute [r] status
+        #   @return [::Google::Ads::AdManager::V1::PlacementStatusEnum::PlacementStatus]
+        #     Output only. The status of the Placement. This attribute is read-only.
+        # @!attribute [rw] targeted_ad_units
+        #   @return [::Array<::String>]
+        #     Optional. The resource names of AdUnits that constitute the Placement.
+        #     Format: "networks/\\{network_code}/adUnits/\\{ad_unit_id}"
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The instant this Placement was last modified.
+        class Placement
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/ads/admanager/v1/placement_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 `GetPlacement` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the Placement.
+        #     Format: `networks/{network_code}/placements/{placement_id}`
+        class GetPlacementRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request object for `ListPlacements` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent, which owns this collection of Placements.
+        #     Format: `networks/{network_code}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of `Placements` to return. The service may
+        #     return fewer than this value. If unspecified, at most 50 `Placements` 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 `ListPlacements` call.
+        #     Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to `ListPlacements` 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 ListPlacementsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response object for `ListPlacementsRequest` containing matching `Placement`
+        # objects.
+        # @!attribute [rw] placements
+        #   @return [::Array<::Google::Ads::AdManager::V1::Placement>]
+        #     The `Placement` 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 `Placement` 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 ListPlacementsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end