google-ads-googleads 24.0.0 → 25.0.0

data/lib/google/ads/google_ads/v15/services/keyword_plan_campaign_service/paths.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     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 V15
+        module Services
+          module KeywordPlanCampaignService
+            # Path helper methods for the KeywordPlanCampaignService API.
+            module Paths
+              ##
+              # Create a fully-qualified GeoTargetConstant resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `geoTargetConstants/{criterion_id}`
+              #
+              # @param criterion_id [String]
+              #
+              # @return [::String]
+              def geo_target_constant_path criterion_id:
+                "geoTargetConstants/#{criterion_id}"
+              end
+
+              ##
+              # Create a fully-qualified KeywordPlan resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `customers/{customer_id}/keywordPlans/{keyword_plan_id}`
+              #
+              # @param customer_id [String]
+              # @param keyword_plan_id [String]
+              #
+              # @return [::String]
+              def keyword_plan_path customer_id:, keyword_plan_id:
+                raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
+
+                "customers/#{customer_id}/keywordPlans/#{keyword_plan_id}"
+              end
+
+              ##
+              # Create a fully-qualified KeywordPlanCampaign resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `customers/{customer_id}/keywordPlanCampaigns/{keyword_plan_campaign_id}`
+              #
+              # @param customer_id [String]
+              # @param keyword_plan_campaign_id [String]
+              #
+              # @return [::String]
+              def keyword_plan_campaign_path customer_id:, keyword_plan_campaign_id:
+                raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
+
+                "customers/#{customer_id}/keywordPlanCampaigns/#{keyword_plan_campaign_id}"
+              end
+
+              ##
+              # Create a fully-qualified LanguageConstant resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `languageConstants/{criterion_id}`
+              #
+              # @param criterion_id [String]
+              #
+              # @return [::String]
+              def language_constant_path criterion_id:
+                "languageConstants/#{criterion_id}"
+              end
+
+              extend self
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/google_ads/v15/services/keyword_plan_campaign_service.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     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/v15/services/keyword_plan_campaign_service/credentials"
+require "google/ads/google_ads/v15/services/keyword_plan_campaign_service/paths"
+require "google/ads/google_ads/v15/services/keyword_plan_campaign_service/client"
+
+module Google
+  module Ads
+    module GoogleAds
+      module V15
+        module Services
+          ##
+          # Service to manage Keyword Plan campaigns.
+          #
+          # @example Load this service and instantiate a gRPC client
+          #
+          #     require "google/ads/google_ads/v15/services/keyword_plan_campaign_service"
+          #     client = ::Google::Ads::GoogleAds::V15::Services::KeywordPlanCampaignService::Client.new
+          #
+          module KeywordPlanCampaignService
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "keyword_plan_campaign_service", "helpers.rb"
+require "google/ads/google_ads/v15/services/keyword_plan_campaign_service/helpers" if ::File.file? helper_path

data/lib/google/ads/google_ads/v15/services/keyword_plan_campaign_service_pb.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/ads/googleads/v15/services/keyword_plan_campaign_service.proto
+
+require 'google/protobuf'
+
+require 'google/ads/google_ads/v15/resources/keyword_plan_campaign_pb'
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/protobuf/field_mask_pb'
+require 'google/rpc/status_pb'
+
+
+descriptor_data = "\nEgoogle/ads/googleads/v15/services/keyword_plan_campaign_service.proto\x12!google.ads.googleads.v15.services\x1a>google/ads/googleads/v15/resources/keyword_plan_campaign.proto\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a google/protobuf/field_mask.proto\x1a\x17google/rpc/status.proto\"\xc7\x01\n!MutateKeywordPlanCampaignsRequest\x12\x18\n\x0b\x63ustomer_id\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12X\n\noperations\x18\x02 \x03(\x0b\x32?.google.ads.googleads.v15.services.KeywordPlanCampaignOperationB\x03\xe0\x41\x02\x12\x17\n\x0fpartial_failure\x18\x03 \x01(\x08\x12\x15\n\rvalidate_only\x18\x04 \x01(\x08\"\xb7\x02\n\x1cKeywordPlanCampaignOperation\x12/\n\x0bupdate_mask\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\x12I\n\x06\x63reate\x18\x01 \x01(\x0b\x32\x37.google.ads.googleads.v15.resources.KeywordPlanCampaignH\x00\x12I\n\x06update\x18\x02 \x01(\x0b\x32\x37.google.ads.googleads.v15.resources.KeywordPlanCampaignH\x00\x12\x43\n\x06remove\x18\x03 \x01(\tB1\xfa\x41.\n,googleads.googleapis.com/KeywordPlanCampaignH\x00\x42\x0b\n\toperation\"\xac\x01\n\"MutateKeywordPlanCampaignsResponse\x12\x31\n\x15partial_failure_error\x18\x03 \x01(\x0b\x32\x12.google.rpc.Status\x12S\n\x07results\x18\x02 \x03(\x0b\x32\x42.google.ads.googleads.v15.services.MutateKeywordPlanCampaignResult\"k\n\x1fMutateKeywordPlanCampaignResult\x12H\n\rresource_name\x18\x01 \x01(\tB1\xfa\x41.\n,googleads.googleapis.com/KeywordPlanCampaign2\xef\x02\n\x1aKeywordPlanCampaignService\x12\x89\x02\n\x1aMutateKeywordPlanCampaigns\x12\x44.google.ads.googleads.v15.services.MutateKeywordPlanCampaignsRequest\x1a\x45.google.ads.googleads.v15.services.MutateKeywordPlanCampaignsResponse\"^\x82\xd3\xe4\x93\x02?\":/v15/customers/{customer_id=*}/keywordPlanCampaigns:mutate:\x01*\xda\x41\x16\x63ustomer_id,operations\x1a\x45\xca\x41\x18googleads.googleapis.com\xd2\x41\'https://www.googleapis.com/auth/adwordsB\x8b\x02\n%com.google.ads.googleads.v15.servicesB\x1fKeywordPlanCampaignServiceProtoP\x01ZIgoogle.golang.org/genproto/googleapis/ads/googleads/v15/services;services\xa2\x02\x03GAA\xaa\x02!Google.Ads.GoogleAds.V15.Services\xca\x02!Google\\Ads\\GoogleAds\\V15\\Services\xea\x02%Google::Ads::GoogleAds::V15::Servicesb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+
+begin
+  pool.add_serialized_file(descriptor_data)
+rescue TypeError => e
+  # 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.v15.resources.KeywordPlanCampaign", "google/ads/googleads/v15/resources/keyword_plan_campaign.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 V15
+        module Services
+          MutateKeywordPlanCampaignsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v15.services.MutateKeywordPlanCampaignsRequest").msgclass
+          KeywordPlanCampaignOperation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v15.services.KeywordPlanCampaignOperation").msgclass
+          MutateKeywordPlanCampaignsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v15.services.MutateKeywordPlanCampaignsResponse").msgclass
+          MutateKeywordPlanCampaignResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v15.services.MutateKeywordPlanCampaignResult").msgclass
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/google_ads/v15/services/keyword_plan_campaign_service_services_pb.rb

@@ -0,0 +1,67 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/ads/googleads/v15/services/keyword_plan_campaign_service.proto for package 'Google.Ads.GoogleAds.V15.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/v15/services/keyword_plan_campaign_service_pb'
+
+module Google
+  module Ads
+    module GoogleAds
+      module V15
+        module Services
+          module KeywordPlanCampaignService
+            # Proto file describing the keyword plan campaign service.
+            #
+            # Service to manage Keyword Plan campaigns.
+            class Service
+
+              include ::GRPC::GenericService
+
+              self.marshal_class_method = :encode
+              self.unmarshal_class_method = :decode
+              self.service_name = 'google.ads.googleads.v15.services.KeywordPlanCampaignService'
+
+              # Creates, updates, or removes Keyword Plan campaigns. Operation statuses are
+              # returned.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [DatabaseError]()
+              #   [FieldError]()
+              #   [FieldMaskError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [KeywordPlanCampaignError]()
+              #   [KeywordPlanError]()
+              #   [ListOperationError]()
+              #   [MutateError]()
+              #   [QuotaError]()
+              #   [RangeError]()
+              #   [RequestError]()
+              #   [ResourceCountLimitExceededError]()
+              rpc :MutateKeywordPlanCampaigns, ::Google::Ads::GoogleAds::V15::Services::MutateKeywordPlanCampaignsRequest, ::Google::Ads::GoogleAds::V15::Services::MutateKeywordPlanCampaignsResponse
+            end
+
+            Stub = Service.rpc_stub_class
+          end
+        end
+      end
+    end
+  end
+end