google-ads-googleads 0.3.0 → 0.4.0

data/lib/google/ads/googleads/v0/services/doc/google/rpc/status.rb

@@ -0,0 +1,83 @@
+# Copyright 2018 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.
+
+module Google
+  module Rpc
+    # The +Status+ type defines a logical error model that is suitable for different
+    # programming environments, including REST APIs and RPC APIs. It is used by
+    # [gRPC](https://github.com/grpc). The error model is designed to be:
+    #
+    # * Simple to use and understand for most users
+    # * Flexible enough to meet unexpected needs
+    #
+    # = Overview
+    #
+    # The +Status+ message contains three pieces of data: error code, error message,
+    # and error details. The error code should be an enum value of
+    # {Google::Rpc::Code}, but it may accept additional error codes if needed.  The
+    # error message should be a developer-facing English message that helps
+    # developers *understand* and *resolve* the error. If a localized user-facing
+    # error message is needed, put the localized message in the error details or
+    # localize it in the client. The optional error details may contain arbitrary
+    # information about the error. There is a predefined set of error detail types
+    # in the package +google.rpc+ that can be used for common error conditions.
+    #
+    # = Language mapping
+    #
+    # The +Status+ message is the logical representation of the error model, but it
+    # is not necessarily the actual wire format. When the +Status+ message is
+    # exposed in different client libraries and different wire protocols, it can be
+    # mapped differently. For example, it will likely be mapped to some exceptions
+    # in Java, but more likely mapped to some error codes in C.
+    #
+    # = Other uses
+    #
+    # The error model and the +Status+ message can be used in a variety of
+    # environments, either with or without APIs, to provide a
+    # consistent developer experience across different environments.
+    #
+    # Example uses of this error model include:
+    #
+    # * Partial errors. If a service needs to return partial errors to the client,
+    #   it may embed the +Status+ in the normal response to indicate the partial
+    #   errors.
+    #
+    # * Workflow errors. A typical workflow has multiple steps. Each step may
+    #   have a +Status+ message for error reporting.
+    #
+    # * Batch operations. If a client uses batch request and batch response, the
+    #   +Status+ message should be used directly inside batch response, one for
+    #   each error sub-response.
+    #
+    # * Asynchronous operations. If an API call embeds asynchronous operation
+    #   results in its response, the status of those operations should be
+    #   represented directly using the +Status+ message.
+    #
+    # * Logging. If some API errors are stored in logs, the message +Status+ could
+    #   be used directly after any stripping needed for security/privacy reasons.
+    # @!attribute [rw] code
+    #   @return [Integer]
+    #     The status code, which should be an enum value of {Google::Rpc::Code}.
+    # @!attribute [rw] message
+    #   @return [String]
+    #     A developer-facing error message, which should be in English. Any
+    #     user-facing error message should be localized and sent in the
+    #     {Google::Rpc::Status#details} field, or localized by the client.
+    # @!attribute [rw] details
+    #   @return [Array<Google::Protobuf::Any>]
+    #     A list of messages that carry the error details.  There is a common set of
+    #     message types for APIs to use.
+    class Status; end
+  end
+end

data/lib/google/ads/googleads/v0/services/doc/overview.rb

@@ -0,0 +1,82 @@
+# Copyright 2018 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.
+
+module Google
+  module Ads
+    # rubocop:disable LineLength
+
+    ##
+    # # Ruby Client for Google Ads API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+    #
+    # [Google Ads API][Product Documentation]:
+    # Manage your AdWords accounts, campaigns, and reports with this REST-based
+    # API.
+    # - [Product Documentation][]
+    #
+    # ## Quick Start
+    # In order to use this library, you first need to go through the following
+    # steps:
+    #
+    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+    # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+    # 3. [Enable the Google Ads API.](https://console.cloud.google.com/apis/library/googleads.googleapis.com)
+    # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+    #
+    # ### Installation
+    # ```
+    # $ gem install google-ads-googleads
+    # ```
+    #
+    # ### Next Steps
+    # - Read the [Google Ads API Product documentation][Product Documentation]
+    #   to learn more about the product and see How-to Guides.
+    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+    #   to see the full list of Cloud APIs that we cover.
+    #
+    # [Product Documentation]: https://cloud.google.com/googleads
+    #
+    # ## Enabling Logging
+    #
+    # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+    # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
+    # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+    # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+    # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+    #
+    # Configuring a Ruby stdlib logger:
+    #
+    # ```ruby
+    # require "logger"
+    #
+    # module MyLogger
+    #   LOGGER = Logger.new $stderr, level: Logger::WARN
+    #   def logger
+    #     LOGGER
+    #   end
+    # end
+    #
+    # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+    # module GRPC
+    #   extend MyLogger
+    # end
+    # ```
+    #
+    module Googleads
+      module V0
+        module Services
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/googleads/v0/services/geo_target_constant_service_client.rb

@@ -195,9 +195,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Resources::GeoTargetConstant]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   geo_target_constant_service_client = Google::Ads::Googleads::V0::Services::GeoTargetConstant.new
+            #   geo_target_constant_service_client = Google::Ads::Googleads::GeoTargetConstant.new(version: :v0)
             #   formatted_resource_name = Google::Ads::Googleads::V0::Services::GeoTargetConstantServiceClient.geo_target_constant_path("[GEO_TARGET_CONSTANT]")
             #   response = geo_target_constant_service_client.get_geo_target_constant(formatted_resource_name)
 

data/lib/google/ads/googleads/v0/services/geo_target_constant_service_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/ads/googleads/v0/services/geo_target_constant_service.proto for package 'google.ads.googleads.v0.services'
 # Original file comments:
-# Copyright 2018 Google Inc.
+# Copyright 2018 Google LLC.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+#
 
 require 'grpc'
 require 'google/ads/googleads/v0/services/geo_target_constant_service_pb'
@@ -25,8 +26,6 @@ module Google
       module V0
         module Services
           module GeoTargetConstantService
-            # Proto file describing the Geo target constant service.
-            #
             # Service to fetch geo target constants.
             class Service
 

data/lib/google/ads/googleads/v0/services/google_ads_field_service_client.rb

@@ -210,9 +210,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Resources::GoogleAdsField]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   google_ads_field_service_client = Google::Ads::Googleads::V0::Services::GoogleAdsField.new
+            #   google_ads_field_service_client = Google::Ads::Googleads::GoogleAdsField.new(version: :v0)
             #   formatted_resource_name = Google::Ads::Googleads::V0::Services::GoogleAdsFieldServiceClient.google_ads_field_path("[GOOGLE_ADS_FIELD]")
             #   response = google_ads_field_service_client.get_google_ads_field(formatted_resource_name)
 
@@ -250,9 +250,9 @@ module Google
             #   object.
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   google_ads_field_service_client = Google::Ads::Googleads::V0::Services::GoogleAdsField.new
+            #   google_ads_field_service_client = Google::Ads::Googleads::GoogleAdsField.new(version: :v0)
             #
             #   # TODO: Initialize +query+:
             #   query = ''

data/lib/google/ads/googleads/v0/services/google_ads_field_service_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/ads/googleads/v0/services/google_ads_field_service.proto for package 'google.ads.googleads.v0.services'
 # Original file comments:
-# Copyright 2018 Google Inc.
+# Copyright 2018 Google LLC.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+#
 
 require 'grpc'
 require 'google/ads/googleads/v0/services/google_ads_field_service_pb'
@@ -25,8 +26,6 @@ module Google
       module V0
         module Services
           module GoogleAdsFieldService
-            # Proto file describing the GoogleAdsFieldService
-            #
             # Service to fetch Google Ads API fields.
             class Service
 

data/lib/google/ads/googleads/v0/services/google_ads_service_client.rb

@@ -202,9 +202,9 @@ module Google
             #   object.
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   google_ads_service_client = Google::Ads::Googleads::V0::Services::GoogleAds.new
+            #   google_ads_service_client = Google::Ads::Googleads::GoogleAds.new(version: :v0)
             #
             #   # TODO: Initialize +customer_id+:
             #   customer_id = ''

data/lib/google/ads/googleads/v0/services/google_ads_service_pb.rb

@@ -7,6 +7,7 @@ require 'google/ads/googleads/v0/common/metrics_pb'
 require 'google/ads/googleads/v0/enums/ad_network_type_pb'
 require 'google/ads/googleads/v0/enums/day_of_week_pb'
 require 'google/ads/googleads/v0/enums/device_pb'
+require 'google/ads/googleads/v0/enums/month_of_year_pb'
 require 'google/ads/googleads/v0/enums/slot_pb'
 require 'google/ads/googleads/v0/resources/ad_group_pb'
 require 'google/ads/googleads/v0/resources/ad_group_ad_pb'
@@ -14,12 +15,17 @@ require 'google/ads/googleads/v0/resources/ad_group_bid_modifier_pb'
 require 'google/ads/googleads/v0/resources/ad_group_criterion_pb'
 require 'google/ads/googleads/v0/resources/bidding_strategy_pb'
 require 'google/ads/googleads/v0/resources/campaign_pb'
+require 'google/ads/googleads/v0/resources/campaign_bid_modifier_pb'
 require 'google/ads/googleads/v0/resources/campaign_budget_pb'
 require 'google/ads/googleads/v0/resources/campaign_criterion_pb'
+require 'google/ads/googleads/v0/resources/campaign_group_pb'
+require 'google/ads/googleads/v0/resources/campaign_shared_set_pb'
 require 'google/ads/googleads/v0/resources/customer_pb'
 require 'google/ads/googleads/v0/resources/geo_target_constant_pb'
 require 'google/ads/googleads/v0/resources/keyword_view_pb'
 require 'google/ads/googleads/v0/resources/recommendation_pb'
+require 'google/ads/googleads/v0/resources/shared_criterion_pb'
+require 'google/ads/googleads/v0/resources/shared_set_pb'
 require 'google/api/annotations_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/wrappers_pb'
@@ -44,11 +50,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :bidding_strategy, :message, 18, "google.ads.googleads.v0.resources.BiddingStrategy"
     optional :campaign_budget, :message, 19, "google.ads.googleads.v0.resources.CampaignBudget"
     optional :campaign, :message, 2, "google.ads.googleads.v0.resources.Campaign"
+    optional :campaign_bid_modifier, :message, 26, "google.ads.googleads.v0.resources.CampaignBidModifier"
     optional :campaign_criterion, :message, 20, "google.ads.googleads.v0.resources.CampaignCriterion"
+    optional :campaign_group, :message, 25, "google.ads.googleads.v0.resources.CampaignGroup"
+    optional :campaign_shared_set, :message, 30, "google.ads.googleads.v0.resources.CampaignSharedSet"
     optional :customer, :message, 1, "google.ads.googleads.v0.resources.Customer"
     optional :geo_target_constant, :message, 23, "google.ads.googleads.v0.resources.GeoTargetConstant"
     optional :keyword_view, :message, 21, "google.ads.googleads.v0.resources.KeywordView"
     optional :recommendation, :message, 22, "google.ads.googleads.v0.resources.Recommendation"
+    optional :shared_criterion, :message, 29, "google.ads.googleads.v0.resources.SharedCriterion"
+    optional :shared_set, :message, 27, "google.ads.googleads.v0.resources.SharedSet"
     optional :metrics, :message, 4, "google.ads.googleads.v0.common.Metrics"
     optional :ad_network_type, :enum, 5, "google.ads.googleads.v0.enums.AdNetworkTypeEnum.AdNetworkType"
     optional :date, :message, 6, "google.protobuf.StringValue"
@@ -56,6 +67,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :device, :enum, 8, "google.ads.googleads.v0.enums.DeviceEnum.Device"
     optional :hour, :message, 9, "google.protobuf.Int32Value"
     optional :month, :message, 10, "google.protobuf.StringValue"
+    optional :month_of_year, :enum, 28, "google.ads.googleads.v0.enums.MonthOfYearEnum.MonthOfYear"
     optional :quarter, :message, 12, "google.protobuf.StringValue"
     optional :slot, :enum, 13, "google.ads.googleads.v0.enums.SlotEnum.Slot"
     optional :week, :message, 14, "google.protobuf.StringValue"

data/lib/google/ads/googleads/v0/services/google_ads_service_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/ads/googleads/v0/services/google_ads_service.proto for package 'google.ads.googleads.v0.services'
 # Original file comments:
-# Copyright 2018 Google Inc.
+# Copyright 2018 Google LLC.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+#
 
 require 'grpc'
 require 'google/ads/googleads/v0/services/google_ads_service_pb'
@@ -25,8 +26,6 @@ module Google
       module V0
         module Services
           module GoogleAdsService
-            # Proto file describing the GoogleAdsService.
-            #
             # Service to fetch data and metrics across resources.
             class Service
 

data/lib/google/ads/googleads/v0/services/keyword_view_service_client.rb

@@ -197,9 +197,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Resources::KeywordView]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   keyword_view_service_client = Google::Ads::Googleads::V0::Services::KeywordView.new
+            #   keyword_view_service_client = Google::Ads::Googleads::KeywordView.new(version: :v0)
             #   formatted_resource_name = Google::Ads::Googleads::V0::Services::KeywordViewServiceClient.keyword_view_path("[CUSTOMER]", "[KEYWORD_VIEW]")
             #   response = keyword_view_service_client.get_keyword_view(formatted_resource_name)
 

data/lib/google/ads/googleads/v0/services/keyword_view_service_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/ads/googleads/v0/services/keyword_view_service.proto for package 'google.ads.googleads.v0.services'
 # Original file comments:
-# Copyright 2018 Google Inc.
+# Copyright 2018 Google LLC.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+#
 
 require 'grpc'
 require 'google/ads/googleads/v0/services/keyword_view_service_pb'
@@ -25,8 +26,6 @@ module Google
       module V0
         module Services
           module KeywordViewService
-            # Proto file describing the Keyword View service.
-            #
             # Service to manage keyword views.
             class Service
 

data/lib/google/ads/googleads/v0/services/recommendation_service_client.rb

@@ -202,9 +202,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Resources::Recommendation]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   recommendation_service_client = Google::Ads::Googleads::V0::Services::Recommendation.new
+            #   recommendation_service_client = Google::Ads::Googleads::Recommendation.new(version: :v0)
             #   formatted_resource_name = Google::Ads::Googleads::V0::Services::RecommendationServiceClient.recommendation_path("[CUSTOMER]", "[RECOMMENDATION]")
             #   response = recommendation_service_client.get_recommendation(formatted_resource_name)
 
@@ -236,9 +236,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Services::ApplyRecommendationResponse]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   recommendation_service_client = Google::Ads::Googleads::V0::Services::Recommendation.new
+            #   recommendation_service_client = Google::Ads::Googleads::Recommendation.new(version: :v0)
             #
             #   # TODO: Initialize +customer_id+:
             #   customer_id = ''

data/lib/google/ads/googleads/v0/services/recommendation_service_pb.rb

@@ -3,8 +3,8 @@
 
 require 'google/protobuf'
 
-require 'google/ads/googleads/v0/common/ad_pb'
 require 'google/ads/googleads/v0/enums/keyword_match_type_pb'
+require 'google/ads/googleads/v0/resources/ad_pb'
 require 'google/ads/googleads/v0/resources/recommendation_pb'
 require 'google/api/annotations_pb'
 require 'google/protobuf/wrappers_pb'
@@ -30,7 +30,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :new_budget_amount_micros, :message, 1, "google.protobuf.Int64Value"
   end
   add_message "google.ads.googleads.v0.services.ApplyRecommendationOperation.TextAdParameters" do
-    optional :ad, :message, 1, "google.ads.googleads.v0.common.Ad"
+    optional :ad, :message, 1, "google.ads.googleads.v0.resources.Ad"
   end
   add_message "google.ads.googleads.v0.services.ApplyRecommendationOperation.KeywordParameters" do
     optional :ad_group, :message, 1, "google.protobuf.StringValue"

data/lib/google/ads/googleads/v0/services/recommendation_service_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/ads/googleads/v0/services/recommendation_service.proto for package 'google.ads.googleads.v0.services'
 # Original file comments:
-# Copyright 2018 Google Inc.
+# Copyright 2018 Google LLC.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+#
 
 require 'grpc'
 require 'google/ads/googleads/v0/services/recommendation_service_pb'
@@ -25,8 +26,6 @@ module Google
       module V0
         module Services
           module RecommendationService
-            # Proto file describing the Recommendation service.
-            #
             # Service to manage recommendations.
             class Service