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

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

@@ -0,0 +1,101 @@
+# 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::CompanyCreditStatusEnum::CompanyCreditStatus CompanyCreditStatus}
+        class CompanyCreditStatusEnum
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The credit status of a company.
+          #
+          # Credit statuses specify the credit-worthiness of a company and affect the
+          # ad serving of campaigns belonging to the company.
+          #
+          # In basic settings, only the
+          # {::Google::Ads::AdManager::V1::CompanyCreditStatusEnum::CompanyCreditStatus::ACTIVE ACTIVE}
+          # and
+          # {::Google::Ads::AdManager::V1::CompanyCreditStatusEnum::CompanyCreditStatus::INACTIVE INACTIVE}
+          # credit statuses are applicable. In advance settings, all credit statuses
+          # are applicable.
+          module CompanyCreditStatus
+            # No value specified
+            COMPANY_CREDIT_STATUS_UNSPECIFIED = 0
+
+            # The company's credit status is active.
+            #
+            # Line items belonging to the company can serve.
+            #
+            # This credit status is the default for basic settings and is available in
+            # both basic and advance settings.
+            ACTIVE = 1
+
+            # The company's credit status is inactive.
+            #
+            # Line items belonging to the company cannot be activated. However, line
+            # items that were activated before the credit status changed will remain
+            # active. New orders or line items belonging to the company cannot be
+            # created.
+            #
+            # Companies with this credit status will be hidden by default in company
+            # search results.
+            #
+            # This credit status is available in both basic and advance settings.
+            INACTIVE = 2
+
+            # The company's credit status is on hold.
+            #
+            # Line items belonging to the company cannot be activated. However, line
+            # items that were activated before the credit status changed will remain
+            # active. New orders or line items belonging to the company can be
+            # created.
+            #
+            # This credit status is the default in advance settings and is only
+            # available in advance settings.
+            ON_HOLD = 3
+
+            # The company's credit status is stopped.
+            #
+            # Line items belonging to the company cannot be activated. However, line
+            # items that were activated before the credit status changed will remain
+            # active. New orders or line items belonging to the company cannot be
+            # created.
+            #
+            # This credit status is only available in advance settings.
+            STOP = 4
+
+            # The company's credit status is blocked.
+            #
+            # All active line items belonging to the company will stop serving with
+            # immediate effect. Line items belonging to the company cannot be
+            # activated, and new orders or line items belonging to the company cannot
+            # be created.
+            #
+            # This credit status is only available in advance settings.
+            BLOCKED = 5
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,101 @@
+# 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 `Company` resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the `Company`.
+        #     Format: `networks/{network_code}/companies/{company_id}`
+        # @!attribute [r] company_id
+        #   @return [::Integer]
+        #     Output only. `Company` ID.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the `Company`.
+        #
+        #     This value has a maximum length of 127 characters.
+        # @!attribute [rw] type
+        #   @return [::Google::Ads::AdManager::V1::CompanyTypeEnum::CompanyType]
+        #     Required. The type of the `Company`.
+        # @!attribute [rw] address
+        #   @return [::String]
+        #     Optional. The address for the `Company`.
+        #
+        #     This value has a maximum length of 1024 characters.
+        # @!attribute [rw] email
+        #   @return [::String]
+        #     Optional. The email for the `Company`.
+        #
+        #     This value has a maximum length of 128 characters.
+        # @!attribute [rw] fax
+        #   @return [::String]
+        #     Optional. The fax number for the `Company`.
+        #
+        #     This value has a maximum length of 63 characters.
+        # @!attribute [rw] phone
+        #   @return [::String]
+        #     Optional. The phone number for the `Company`.
+        #
+        #     This value has a maximum length of 63 characters.
+        # @!attribute [rw] external_id
+        #   @return [::String]
+        #     Optional. The external ID for the `Company`.
+        #
+        #     This value has a maximum length of 255 characters.
+        # @!attribute [rw] comment
+        #   @return [::String]
+        #     Optional. Comments about the `Company`.
+        #
+        #     This value has a maximum length of 1024 characters.
+        # @!attribute [rw] credit_status
+        #   @return [::Google::Ads::AdManager::V1::CompanyCreditStatusEnum::CompanyCreditStatus]
+        #     Optional. The credit status of the `Company`.
+        #
+        #     This attribute defaults to `ACTIVE` if basic settings are enabled and
+        #     `ON_HOLD` if advance settings are enabled.
+        # @!attribute [rw] applied_labels
+        #   @return [::Array<::Google::Ads::AdManager::V1::AppliedLabel>]
+        #     Optional. The labels that are directly applied to the `Company`.
+        # @!attribute [rw] primary_contact
+        #   @return [::String]
+        #     Optional. The resource names of primary Contact of the `Company`.
+        #     Format: "networks/\\{network_code}/contacts/\\{contact_id}"
+        # @!attribute [rw] applied_teams
+        #   @return [::Array<::String>]
+        #     Optional. The resource names of Teams that are directly associated with the
+        #     `Company`. Format: "networks/\\{network_code}/teams/\\{team_id}"
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the `Company` was last modified.
+        # @!attribute [rw] third_party_company_id
+        #   @return [::Integer]
+        #     Optional. The ID of the Google-recognized canonicalized form of the
+        #     `Company`.
+        class Company
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

data/proto_docs/google/ads/admanager/v1/company_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 message for
+        # {::Google::Ads::AdManager::V1::CompanyTypeEnum::CompanyType CompanyType}
+        class CompanyTypeEnum
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The type of a company.
+          module CompanyType
+            # No value specified
+            COMPANY_TYPE_UNSPECIFIED = 0
+
+            # A business entity that purchases ad inventory.
+            ADVERTISER = 1
+
+            # A company representing the publisher's own advertiser for house ads.
+            HOUSE_ADVERTISER = 2
+
+            # An organization that manages ad accounts and offers services, such as ad
+            # creation, placement, and management to advertisers.
+            AGENCY = 3
+
+            # A company representing the publisher's own agency.
+            HOUSE_AGENCY = 4
+
+            # A company representing multiple advertisers and agencies.
+            AD_NETWORK = 5
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# 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 contact represents a person who is affiliated with a single company. A
+        # contact can have a variety of contact information associated to it, and can
+        # be invited to view their company's orders, line items, creatives, and
+        # reports.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the `Contact`.
+        #     Format: `networks/{network_code}/contacts/{contact_id}`
+        # @!attribute [r] contact_id
+        #   @return [::Integer]
+        #     Output only. The unique ID of the contact. This value is readonly and is
+        #     assigned by Google.
+        class Contact
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,123 @@
+# 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::CustomFieldDataTypeEnum::CustomFieldDataType CustomFieldDataType}
+        class CustomFieldDataTypeEnum
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The data type for a CustomField.
+          module CustomFieldDataType
+            # No value specified
+            CUSTOM_FIELD_DATA_TYPE_UNSPECIFIED = 0
+
+            # A string field
+            #
+            # The max length is 255 characters.
+            STRING = 1
+
+            # A number field.
+            NUMBER = 2
+
+            # A "Yes" or "No" toggle field.
+            TOGGLE = 3
+
+            # A drop-down field.
+            DROP_DOWN = 4
+          end
+        end
+
+        # Wrapper message for
+        # {::Google::Ads::AdManager::V1::CustomFieldEntityTypeEnum::CustomFieldEntityType CustomFieldEntityType}
+        class CustomFieldEntityTypeEnum
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The types of entities that a CustomField can be applied to.
+          module CustomFieldEntityType
+            # No value specified
+            CUSTOM_FIELD_ENTITY_TYPE_UNSPECIFIED = 0
+
+            # The CustomField is applied to LineItems.
+            LINE_ITEM = 1
+
+            # The CustomField is applied to Orders.
+            ORDER = 2
+
+            # The CustomField is applied to Creatives.
+            CREATIVE = 3
+
+            # The CustomField is applied to Proposals.
+            PROPOSAL = 4
+
+            # The CustomField is applied to ProposalLineItems.
+            PROPOSAL_LINE_ITEM = 5
+          end
+        end
+
+        # Wrapper message for
+        # {::Google::Ads::AdManager::V1::CustomFieldStatusEnum::CustomFieldStatus CustomFieldStatus}
+        class CustomFieldStatusEnum
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The status of the CustomField.
+          module CustomFieldStatus
+            # No value specified
+            CUSTOM_FIELD_STATUS_UNSPECIFIED = 0
+
+            # The CustomField is active.
+            ACTIVE = 1
+
+            # The CustomField is inactive.
+            INACTIVE = 2
+          end
+        end
+
+        # Wrapper message for
+        # {::Google::Ads::AdManager::V1::CustomFieldVisibilityEnum::CustomFieldVisibility CustomFieldVisibility}
+        class CustomFieldVisibilityEnum
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The visibility level of a CustomField.
+          module CustomFieldVisibility
+            # No value specified
+            CUSTOM_FIELD_VISIBILITY_UNSPECIFIED = 0
+
+            # The CustomField is not visible in the UI and only visible through the
+            # API.
+            HIDDEN = 1
+
+            # The CustomField is visible in the UI and only editable through the API.
+            READ_ONLY = 2
+
+            # The CustomField is visible and editable in both the API and UI.
+            EDITABLE = 3
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# 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
+        # An additional, user-created field on an entity.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the `CustomField`.
+        #     Format: `networks/{network_code}/customFields/{custom_field_id}`
+        # @!attribute [r] custom_field_id
+        #   @return [::Integer]
+        #     Output only. Unique ID of the CustomField. This value is readonly and is
+        #     assigned by Google.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. Name of the CustomField. The max length is 127 characters.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. A description of the custom field. The maximum length is 511
+        #     characters.
+        # @!attribute [r] status
+        #   @return [::Google::Ads::AdManager::V1::CustomFieldStatusEnum::CustomFieldStatus]
+        #     Output only. The status of the `CustomField`.
+        # @!attribute [rw] entity_type
+        #   @return [::Google::Ads::AdManager::V1::CustomFieldEntityTypeEnum::CustomFieldEntityType]
+        #     Required. The type of entity the `CustomField` can be applied to.
+        # @!attribute [rw] data_type
+        #   @return [::Google::Ads::AdManager::V1::CustomFieldDataTypeEnum::CustomFieldDataType]
+        #     Required. The data type of the `CustomField`.
+        # @!attribute [rw] visibility
+        #   @return [::Google::Ads::AdManager::V1::CustomFieldVisibilityEnum::CustomFieldVisibility]
+        #     Required. The visibility of the `CustomField`.
+        # @!attribute [rw] options
+        #   @return [::Array<::Google::Ads::AdManager::V1::CustomFieldOption>]
+        #     Optional. The drop-down options for the `CustomField`.
+        #
+        #     Only applicable for `CustomField` with the drop-down data type.
+        class CustomField
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An option for a drop-down `CustomField`.
+        # @!attribute [r] custom_field_option_id
+        #   @return [::Integer]
+        #     Output only. `CustomFieldOption` ID.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the `CustomFieldOption`.
+        #
+        #     This value has a maximum length of 127 characters.
+        class CustomFieldOption
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end