google-ads-googleads 25.0.2 → 27.0.0

data/lib/google/ads/google_ads/v16/services/experiment_service/paths.rb

@@ -0,0 +1,86 @@
+# 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 GoogleAds
+      module V16
+        module Services
+          module ExperimentService
+            # Path helper methods for the ExperimentService API.
+            module Paths
+              ##
+              # Create a fully-qualified Campaign resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `customers/{customer_id}/campaigns/{campaign_id}`
+              #
+              # @param customer_id [String]
+              # @param campaign_id [String]
+              #
+              # @return [::String]
+              def campaign_path customer_id:, campaign_id:
+                raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
+
+                "customers/#{customer_id}/campaigns/#{campaign_id}"
+              end
+
+              ##
+              # Create a fully-qualified CampaignBudget resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `customers/{customer_id}/campaignBudgets/{campaign_budget_id}`
+              #
+              # @param customer_id [String]
+              # @param campaign_budget_id [String]
+              #
+              # @return [::String]
+              def campaign_budget_path customer_id:, campaign_budget_id:
+                raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
+
+                "customers/#{customer_id}/campaignBudgets/#{campaign_budget_id}"
+              end
+
+              ##
+              # Create a fully-qualified Experiment resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `customers/{customer_id}/experiments/{trial_id}`
+              #
+              # @param customer_id [String]
+              # @param trial_id [String]
+              #
+              # @return [::String]
+              def experiment_path customer_id:, trial_id:
+                raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
+
+                "customers/#{customer_id}/experiments/#{trial_id}"
+              end
+
+              extend self
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/google_ads/v16/services/experiment_service.rb

@@ -0,0 +1,52 @@
+# 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!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/ads/google_ads/version"
+
+require "google/ads/google_ads/v16/services/experiment_service/credentials"
+require "google/ads/google_ads/v16/services/experiment_service/paths"
+require "google/ads/google_ads/v16/services/experiment_service/operations"
+require "google/ads/google_ads/v16/services/experiment_service/client"
+
+module Google
+  module Ads
+    module GoogleAds
+      module V16
+        module Services
+          ##
+          # Service to manage experiments.
+          #
+          # @example Load this service and instantiate a gRPC client
+          #
+          #     require "google/ads/google_ads/v16/services/experiment_service"
+          #     client = ::Google::Ads::GoogleAds::V16::Services::ExperimentService::Client.new
+          #
+          module ExperimentService
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "experiment_service", "helpers.rb"
+require "google/ads/google_ads/v16/services/experiment_service/helpers" if ::File.file? helper_path

data/lib/google/ads/google_ads/v16/services/experiment_service_pb.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/ads/googleads/v16/services/experiment_service.proto
+
+require 'google/protobuf'
+
+require 'google/ads/google_ads/v16/resources/experiment_pb'
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/longrunning/operations_pb'
+require 'google/protobuf/empty_pb'
+require 'google/protobuf/field_mask_pb'
+require 'google/rpc/status_pb'
+
+
+descriptor_data = "\n:google/ads/googleads/v16/services/experiment_service.proto\x12!google.ads.googleads.v16.services\x1a\x33google/ads/googleads/v16/resources/experiment.proto\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a#google/longrunning/operations.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\x1a\x17google/rpc/status.proto\"\xb5\x01\n\x18MutateExperimentsRequest\x12\x18\n\x0b\x63ustomer_id\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12O\n\noperations\x18\x02 \x03(\x0b\x32\x36.google.ads.googleads.v16.services.ExperimentOperationB\x03\xe0\x41\x02\x12\x17\n\x0fpartial_failure\x18\x03 \x01(\x08\x12\x15\n\rvalidate_only\x18\x04 \x01(\x08\"\x93\x02\n\x13\x45xperimentOperation\x12/\n\x0bupdate_mask\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\x12@\n\x06\x63reate\x18\x01 \x01(\x0b\x32..google.ads.googleads.v16.resources.ExperimentH\x00\x12@\n\x06update\x18\x02 \x01(\x0b\x32..google.ads.googleads.v16.resources.ExperimentH\x00\x12:\n\x06remove\x18\x03 \x01(\tB(\xfa\x41%\n#googleads.googleapis.com/ExperimentH\x00\x42\x0b\n\toperation\"\x9a\x01\n\x19MutateExperimentsResponse\x12\x31\n\x15partial_failure_error\x18\x01 \x01(\x0b\x32\x12.google.rpc.Status\x12J\n\x07results\x18\x02 \x03(\x0b\x32\x39.google.ads.googleads.v16.services.MutateExperimentResult\"Y\n\x16MutateExperimentResult\x12?\n\rresource_name\x18\x01 \x01(\tB(\xfa\x41%\n#googleads.googleapis.com/Experiment\"n\n\x14\x45ndExperimentRequest\x12?\n\nexperiment\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#googleads.googleapis.com/Experiment\x12\x15\n\rvalidate_only\x18\x02 \x01(\x08\"\x8d\x01\n ListExperimentAsyncErrorsRequest\x12\x42\n\rresource_name\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#googleads.googleapis.com/Experiment\x12\x12\n\npage_token\x18\x02 \x01(\t\x12\x11\n\tpage_size\x18\x03 \x01(\x05\"`\n!ListExperimentAsyncErrorsResponse\x12\"\n\x06\x65rrors\x18\x01 \x03(\x0b\x32\x12.google.rpc.Status\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"\xd4\x01\n\x19GraduateExperimentRequest\x12?\n\nexperiment\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#googleads.googleapis.com/Experiment\x12_\n\x18\x63\x61mpaign_budget_mappings\x18\x02 \x03(\x0b\x32\x38.google.ads.googleads.v16.services.CampaignBudgetMappingB\x03\xe0\x41\x02\x12\x15\n\rvalidate_only\x18\x03 \x01(\x08\"\xa9\x01\n\x15\x43\x61mpaignBudgetMapping\x12\x46\n\x13\x65xperiment_campaign\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\n!googleads.googleapis.com/Campaign\x12H\n\x0f\x63\x61mpaign_budget\x18\x02 \x01(\tB/\xe0\x41\x02\xfa\x41)\n\'googleads.googleapis.com/CampaignBudget\"v\n\x19ScheduleExperimentRequest\x12\x42\n\rresource_name\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#googleads.googleapis.com/Experiment\x12\x15\n\rvalidate_only\x18\x02 \x01(\x08\"]\n\x1aScheduleExperimentMetadata\x12?\n\nexperiment\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#googleads.googleapis.com/Experiment\"u\n\x18PromoteExperimentRequest\x12\x42\n\rresource_name\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#googleads.googleapis.com/Experiment\x12\x15\n\rvalidate_only\x18\x02 \x01(\x08\"\\\n\x19PromoteExperimentMetadata\x12?\n\nexperiment\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#googleads.googleapis.com/Experiment2\xb3\x0c\n\x11\x45xperimentService\x12\xe5\x01\n\x11MutateExperiments\x12;.google.ads.googleads.v16.services.MutateExperimentsRequest\x1a<.google.ads.googleads.v16.services.MutateExperimentsResponse\"U\xda\x41\x16\x63ustomer_id,operations\x82\xd3\xe4\x93\x02\x36\"1/v16/customers/{customer_id=*}/experiments:mutate:\x01*\x12\xb3\x01\n\rEndExperiment\x12\x37.google.ads.googleads.v16.services.EndExperimentRequest\x1a\x16.google.protobuf.Empty\"Q\xda\x41\nexperiment\x82\xd3\xe4\x93\x02>\"9/v16/{experiment=customers/*/experiments/*}:endExperiment:\x01*\x12\x88\x02\n\x19ListExperimentAsyncErrors\x12\x43.google.ads.googleads.v16.services.ListExperimentAsyncErrorsRequest\x1a\x44.google.ads.googleads.v16.services.ListExperimentAsyncErrorsResponse\"`\xda\x41\rresource_name\x82\xd3\xe4\x93\x02J\x12H/v16/{resource_name=customers/*/experiments/*}:listExperimentAsyncErrors\x12\xdb\x01\n\x12GraduateExperiment\x12<.google.ads.googleads.v16.services.GraduateExperimentRequest\x1a\x16.google.protobuf.Empty\"o\xda\x41#experiment,campaign_budget_mappings\x82\xd3\xe4\x93\x02\x43\">/v16/{experiment=customers/*/experiments/*}:graduateExperiment:\x01*\x12\xa8\x02\n\x12ScheduleExperiment\x12<.google.ads.googleads.v16.services.ScheduleExperimentRequest\x1a\x1d.google.longrunning.Operation\"\xb4\x01\xca\x41U\n\x15google.protobuf.Empty\x12<google.ads.googleads.v16.services.ScheduleExperimentMetadata\xda\x41\rresource_name\x82\xd3\xe4\x93\x02\x46\"A/v16/{resource_name=customers/*/experiments/*}:scheduleExperiment:\x01*\x12\xa4\x02\n\x11PromoteExperiment\x12;.google.ads.googleads.v16.services.PromoteExperimentRequest\x1a\x1d.google.longrunning.Operation\"\xb2\x01\xca\x41T\n\x15google.protobuf.Empty\x12;google.ads.googleads.v16.services.PromoteExperimentMetadata\xda\x41\rresource_name\x82\xd3\xe4\x93\x02\x45\"@/v16/{resource_name=customers/*/experiments/*}:promoteExperiment:\x01*\x1a\x45\xca\x41\x18googleads.googleapis.com\xd2\x41\'https://www.googleapis.com/auth/adwordsB\x82\x02\n%com.google.ads.googleads.v16.servicesB\x16\x45xperimentServiceProtoP\x01ZIgoogle.golang.org/genproto/googleapis/ads/googleads/v16/services;services\xa2\x02\x03GAA\xaa\x02!Google.Ads.GoogleAds.V16.Services\xca\x02!Google\\Ads\\GoogleAds\\V16\\Services\xea\x02%Google::Ads::GoogleAds::V16::Servicesb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+
+begin
+  pool.add_serialized_file(descriptor_data)
+rescue TypeError
+  # Compatibility code: will be removed in the next major version.
+  require 'google/protobuf/descriptor_pb'
+  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
+  parsed.clear_dependency
+  serialized = parsed.class.encode(parsed)
+  file = pool.add_serialized_file(serialized)
+  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
+  imports = [
+    ["google.protobuf.FieldMask", "google/protobuf/field_mask.proto"],
+    ["google.ads.googleads.v16.resources.Experiment", "google/ads/googleads/v16/resources/experiment.proto"],
+    ["google.rpc.Status", "google/rpc/status.proto"],
+  ]
+  imports.each do |type_name, expected_filename|
+    import_file = pool.lookup(type_name).file_descriptor
+    if import_file.name != expected_filename
+      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
+    end
+  end
+  warn "Each proto file must use a consistent fully-qualified name."
+  warn "This will become an error in the next major version."
+end
+
+module Google
+  module Ads
+    module GoogleAds
+      module V16
+        module Services
+          MutateExperimentsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v16.services.MutateExperimentsRequest").msgclass
+          ExperimentOperation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v16.services.ExperimentOperation").msgclass
+          MutateExperimentsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v16.services.MutateExperimentsResponse").msgclass
+          MutateExperimentResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v16.services.MutateExperimentResult").msgclass
+          EndExperimentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v16.services.EndExperimentRequest").msgclass
+          ListExperimentAsyncErrorsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v16.services.ListExperimentAsyncErrorsRequest").msgclass
+          ListExperimentAsyncErrorsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v16.services.ListExperimentAsyncErrorsResponse").msgclass
+          GraduateExperimentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v16.services.GraduateExperimentRequest").msgclass
+          CampaignBudgetMapping = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v16.services.CampaignBudgetMapping").msgclass
+          ScheduleExperimentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v16.services.ScheduleExperimentRequest").msgclass
+          ScheduleExperimentMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v16.services.ScheduleExperimentMetadata").msgclass
+          PromoteExperimentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v16.services.PromoteExperimentRequest").msgclass
+          PromoteExperimentMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v16.services.PromoteExperimentMetadata").msgclass
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/google_ads/v16/services/experiment_service_services_pb.rb

@@ -0,0 +1,137 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/ads/googleads/v16/services/experiment_service.proto for package 'Google.Ads.GoogleAds.V16.Services'
+# Original file comments:
+# Copyright 2023 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
+#
+#     http://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.
+#
+
+require 'grpc'
+require 'google/ads/google_ads/v16/services/experiment_service_pb'
+
+module Google
+  module Ads
+    module GoogleAds
+      module V16
+        module Services
+          module ExperimentService
+            # Proto file describing the Experiment service.
+            #
+            # Service to manage experiments.
+            class Service
+
+              include ::GRPC::GenericService
+
+              self.marshal_class_method = :encode
+              self.unmarshal_class_method = :decode
+              self.service_name = 'google.ads.googleads.v16.services.ExperimentService'
+
+              # Creates, updates, or removes experiments. Operation statuses are returned.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [ExperimentError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              rpc :MutateExperiments, ::Google::Ads::GoogleAds::V16::Services::MutateExperimentsRequest, ::Google::Ads::GoogleAds::V16::Services::MutateExperimentsResponse
+              # Immediately ends an experiment, changing the experiment's scheduled
+              # end date and without waiting for end of day. End date is updated to be the
+              # time of the request.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [ExperimentError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              rpc :EndExperiment, ::Google::Ads::GoogleAds::V16::Services::EndExperimentRequest, ::Google::Protobuf::Empty
+              # Returns all errors that occurred during the last Experiment update (either
+              # scheduling or promotion).
+              # Supports standard list paging.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              rpc :ListExperimentAsyncErrors, ::Google::Ads::GoogleAds::V16::Services::ListExperimentAsyncErrorsRequest, ::Google::Ads::GoogleAds::V16::Services::ListExperimentAsyncErrorsResponse
+              # Graduates an experiment to a full campaign.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [ExperimentError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [MutateError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              rpc :GraduateExperiment, ::Google::Ads::GoogleAds::V16::Services::GraduateExperimentRequest, ::Google::Protobuf::Empty
+              # Schedule an experiment. The in design campaign
+              # will be converted into a real campaign (called the experiment campaign)
+              # that will begin serving ads if successfully created.
+              #
+              # The experiment is scheduled immediately with status INITIALIZING.
+              # This method returns a long running operation that tracks the forking of the
+              # in design campaign. If the forking fails, a list of errors can be retrieved
+              # using the ListExperimentAsyncErrors method. The operation's
+              # metadata will be a string containing the resource name of the created
+              # experiment.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [ExperimentError]()
+              #   [DatabaseError]()
+              #   [DateError]()
+              #   [DateRangeError]()
+              #   [FieldError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [QuotaError]()
+              #   [RangeError]()
+              #   [RequestError]()
+              rpc :ScheduleExperiment, ::Google::Ads::GoogleAds::V16::Services::ScheduleExperimentRequest, ::Google::Longrunning::Operation
+              # Promotes the trial campaign thus applying changes in the trial campaign
+              # to the base campaign.
+              # This method returns a long running operation that tracks the promotion of
+              # the experiment campaign. If it fails, a list of errors can be retrieved
+              # using the ListExperimentAsyncErrors method. The operation's
+              # metadata will be a string containing the resource name of the created
+              # experiment.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [ExperimentError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              rpc :PromoteExperiment, ::Google::Ads::GoogleAds::V16::Services::PromoteExperimentRequest, ::Google::Longrunning::Operation
+            end
+
+            Stub = Service.rpc_stub_class
+          end
+        end
+      end
+    end
+  end
+end