google-ads-googleads 24.0.0 → 25.0.0

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

@@ -0,0 +1,66 @@
+# 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 CustomerService
+            # Path helper methods for the CustomerService API.
+            module Paths
+              ##
+              # Create a fully-qualified ConversionAction resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `customers/{customer_id}/conversionActions/{conversion_action_id}`
+              #
+              # @param customer_id [String]
+              # @param conversion_action_id [String]
+              #
+              # @return [::String]
+              def conversion_action_path customer_id:, conversion_action_id:
+                raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
+
+                "customers/#{customer_id}/conversionActions/#{conversion_action_id}"
+              end
+
+              ##
+              # Create a fully-qualified Customer resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `customers/{customer_id}`
+              #
+              # @param customer_id [String]
+              #
+              # @return [::String]
+              def customer_path customer_id:
+                "customers/#{customer_id}"
+              end
+
+              extend self
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/google_ads/v15/services/customer_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/customer_service/credentials"
+require "google/ads/google_ads/v15/services/customer_service/paths"
+require "google/ads/google_ads/v15/services/customer_service/client"
+
+module Google
+  module Ads
+    module GoogleAds
+      module V15
+        module Services
+          ##
+          # Service to manage customers.
+          #
+          # @example Load this service and instantiate a gRPC client
+          #
+          #     require "google/ads/google_ads/v15/services/customer_service"
+          #     client = ::Google::Ads::GoogleAds::V15::Services::CustomerService::Client.new
+          #
+          module CustomerService
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "customer_service", "helpers.rb"
+require "google/ads/google_ads/v15/services/customer_service/helpers" if ::File.file? helper_path

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/ads/googleads/v15/services/customer_service.proto
+
+require 'google/protobuf'
+
+require 'google/ads/google_ads/v15/enums/access_role_pb'
+require 'google/ads/google_ads/v15/enums/response_content_type_pb'
+require 'google/ads/google_ads/v15/resources/customer_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'
+
+
+descriptor_data = "\n8google/ads/googleads/v15/services/customer_service.proto\x12!google.ads.googleads.v15.services\x1a\x30google/ads/googleads/v15/enums/access_role.proto\x1a:google/ads/googleads/v15/enums/response_content_type.proto\x1a\x31google/ads/googleads/v15/resources/customer.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\"\x82\x02\n\x15MutateCustomerRequest\x12\x18\n\x0b\x63ustomer_id\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12L\n\toperation\x18\x04 \x01(\x0b\x32\x34.google.ads.googleads.v15.services.CustomerOperationB\x03\xe0\x41\x02\x12\x15\n\rvalidate_only\x18\x05 \x01(\x08\x12j\n\x15response_content_type\x18\x06 \x01(\x0e\x32K.google.ads.googleads.v15.enums.ResponseContentTypeEnum.ResponseContentType\"\x98\x02\n\x1b\x43reateCustomerClientRequest\x12\x18\n\x0b\x63ustomer_id\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12J\n\x0f\x63ustomer_client\x18\x02 \x01(\x0b\x32,.google.ads.googleads.v15.resources.CustomerB\x03\xe0\x41\x02\x12\x1a\n\remail_address\x18\x05 \x01(\tH\x00\x88\x01\x01\x12N\n\x0b\x61\x63\x63\x65ss_role\x18\x04 \x01(\x0e\x32\x39.google.ads.googleads.v15.enums.AccessRoleEnum.AccessRole\x12\x15\n\rvalidate_only\x18\x06 \x01(\x08\x42\x10\n\x0e_email_address\"\x82\x01\n\x11\x43ustomerOperation\x12<\n\x06update\x18\x01 \x01(\x0b\x32,.google.ads.googleads.v15.resources.Customer\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\"v\n\x1c\x43reateCustomerClientResponse\x12=\n\rresource_name\x18\x02 \x01(\tB&\xfa\x41#\n!googleads.googleapis.com/Customer\x12\x17\n\x0finvitation_link\x18\x03 \x01(\t\"a\n\x16MutateCustomerResponse\x12G\n\x06result\x18\x02 \x01(\x0b\x32\x37.google.ads.googleads.v15.services.MutateCustomerResult\"\x95\x01\n\x14MutateCustomerResult\x12=\n\rresource_name\x18\x01 \x01(\tB&\xfa\x41#\n!googleads.googleapis.com/Customer\x12>\n\x08\x63ustomer\x18\x02 \x01(\x0b\x32,.google.ads.googleads.v15.resources.Customer\" \n\x1eListAccessibleCustomersRequest\"9\n\x1fListAccessibleCustomersResponse\x12\x16\n\x0eresource_names\x18\x01 \x03(\t2\xf5\x05\n\x0f\x43ustomerService\x12\xcf\x01\n\x0eMutateCustomer\x12\x38.google.ads.googleads.v15.services.MutateCustomerRequest\x1a\x39.google.ads.googleads.v15.services.MutateCustomerResponse\"H\x82\xd3\xe4\x93\x02*\"%/v15/customers/{customer_id=*}:mutate:\x01*\xda\x41\x15\x63ustomer_id,operation\x12\xd0\x01\n\x17ListAccessibleCustomers\x12\x41.google.ads.googleads.v15.services.ListAccessibleCustomersRequest\x1a\x42.google.ads.googleads.v15.services.ListAccessibleCustomersResponse\".\x82\xd3\xe4\x93\x02(\x12&/v15/customers:listAccessibleCustomers\x12\xf5\x01\n\x14\x43reateCustomerClient\x12>.google.ads.googleads.v15.services.CreateCustomerClientRequest\x1a?.google.ads.googleads.v15.services.CreateCustomerClientResponse\"\\\x82\xd3\xe4\x93\x02\x38\"3/v15/customers/{customer_id=*}:createCustomerClient:\x01*\xda\x41\x1b\x63ustomer_id,customer_client\x1a\x45\xca\x41\x18googleads.googleapis.com\xd2\x41\'https://www.googleapis.com/auth/adwordsB\x80\x02\n%com.google.ads.googleads.v15.servicesB\x14\x43ustomerServiceProtoP\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.ads.googleads.v15.resources.Customer", "google/ads/googleads/v15/resources/customer.proto"],
+    ["google.protobuf.FieldMask", "google/protobuf/field_mask.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
+          MutateCustomerRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v15.services.MutateCustomerRequest").msgclass
+          CreateCustomerClientRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v15.services.CreateCustomerClientRequest").msgclass
+          CustomerOperation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v15.services.CustomerOperation").msgclass
+          CreateCustomerClientResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v15.services.CreateCustomerClientResponse").msgclass
+          MutateCustomerResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v15.services.MutateCustomerResponse").msgclass
+          MutateCustomerResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v15.services.MutateCustomerResult").msgclass
+          ListAccessibleCustomersRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v15.services.ListAccessibleCustomersRequest").msgclass
+          ListAccessibleCustomersResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v15.services.ListAccessibleCustomersResponse").msgclass
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/ads/googleads/v15/services/customer_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/customer_service_pb'
+
+module Google
+  module Ads
+    module GoogleAds
+      module V15
+        module Services
+          module CustomerService
+            # Proto file describing the Customer service.
+            #
+            # Service to manage customers.
+            class Service
+
+              include ::GRPC::GenericService
+
+              self.marshal_class_method = :encode
+              self.unmarshal_class_method = :decode
+              self.service_name = 'google.ads.googleads.v15.services.CustomerService'
+
+              # Updates a customer. Operation statuses are returned.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [DatabaseError]()
+              #   [FieldMaskError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              #   [UrlFieldError]()
+              rpc :MutateCustomer, ::Google::Ads::GoogleAds::V15::Services::MutateCustomerRequest, ::Google::Ads::GoogleAds::V15::Services::MutateCustomerResponse
+              # Returns resource names of customers directly accessible by the
+              # user authenticating the call.
+              #
+              # List of thrown errors:
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              rpc :ListAccessibleCustomers, ::Google::Ads::GoogleAds::V15::Services::ListAccessibleCustomersRequest, ::Google::Ads::GoogleAds::V15::Services::ListAccessibleCustomersResponse
+              # Creates a new client under manager. The new client customer is returned.
+              #
+              # List of thrown errors:
+              #   [AccessInvitationError]()
+              #   [AuthenticationError]()
+              #   [AuthorizationError]()
+              #   [CurrencyCodeError]()
+              #   [HeaderError]()
+              #   [InternalError]()
+              #   [ManagerLinkError]()
+              #   [QuotaError]()
+              #   [RequestError]()
+              #   [StringLengthError]()
+              #   [TimeZoneError]()
+              rpc :CreateCustomerClient, ::Google::Ads::GoogleAds::V15::Services::CreateCustomerClientRequest, ::Google::Ads::GoogleAds::V15::Services::CreateCustomerClientResponse
+            end
+
+            Stub = Service.rpc_stub_class
+          end
+        end
+      end
+    end
+  end
+end