google-ads-googleads 0.3.0 → 0.4.0

data/lib/google/ads/googleads/v0/services/campaign_shared_set_service_client_config.json

@@ -0,0 +1,36 @@
+{
+  "interfaces": {
+    "google.ads.googleads.v0.services.CampaignSharedSetService": {
+      "retry_codes": {
+        "idempotent": [
+          "DEADLINE_EXCEEDED",
+          "UNAVAILABLE"
+        ],
+        "non_idempotent": []
+      },
+      "retry_params": {
+        "default": {
+          "initial_retry_delay_millis": 100,
+          "retry_delay_multiplier": 1.3,
+          "max_retry_delay_millis": 60000,
+          "initial_rpc_timeout_millis": 20000,
+          "rpc_timeout_multiplier": 1.0,
+          "max_rpc_timeout_millis": 20000,
+          "total_timeout_millis": 600000
+        }
+      },
+      "methods": {
+        "GetCampaignSharedSet": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "MutateCampaignSharedSets": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,44 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/ads/googleads/v0/services/campaign_shared_set_service.proto
+
+require 'google/protobuf'
+
+require 'google/ads/googleads/v0/resources/campaign_shared_set_pb'
+require 'google/api/annotations_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.ads.googleads.v0.services.GetCampaignSharedSetRequest" do
+    optional :resource_name, :string, 1
+  end
+  add_message "google.ads.googleads.v0.services.MutateCampaignSharedSetsRequest" do
+    optional :customer_id, :string, 1
+    repeated :operations, :message, 2, "google.ads.googleads.v0.services.CampaignSharedSetOperation"
+  end
+  add_message "google.ads.googleads.v0.services.CampaignSharedSetOperation" do
+    oneof :operation do
+      optional :create, :message, 1, "google.ads.googleads.v0.resources.CampaignSharedSet"
+      optional :remove, :string, 3
+    end
+  end
+  add_message "google.ads.googleads.v0.services.MutateCampaignSharedSetsResponse" do
+    repeated :results, :message, 2, "google.ads.googleads.v0.services.MutateCampaignSharedSetResult"
+  end
+  add_message "google.ads.googleads.v0.services.MutateCampaignSharedSetResult" do
+    optional :resource_name, :string, 1
+  end
+end
+
+module Google
+  module Ads
+    module Googleads
+      module V0
+        module Services
+          GetCampaignSharedSetRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.GetCampaignSharedSetRequest").msgclass
+          MutateCampaignSharedSetsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.MutateCampaignSharedSetsRequest").msgclass
+          CampaignSharedSetOperation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.CampaignSharedSetOperation").msgclass
+          MutateCampaignSharedSetsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.MutateCampaignSharedSetsResponse").msgclass
+          MutateCampaignSharedSetResult = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.MutateCampaignSharedSetResult").msgclass
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/ads/googleads/v0/services/campaign_shared_set_service.proto for package 'google.ads.googleads.v0.services'
+# Original file comments:
+# 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
+#
+#     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/googleads/v0/services/campaign_shared_set_service_pb'
+
+module Google
+  module Ads
+    module Googleads
+      module V0
+        module Services
+          module CampaignSharedSetService
+            # Service to manage campaign shared sets.
+            class Service
+
+              include GRPC::GenericService
+
+              self.marshal_class_method = :encode
+              self.unmarshal_class_method = :decode
+              self.service_name = 'google.ads.googleads.v0.services.CampaignSharedSetService'
+
+              # Returns the requested campaign shared set in full detail.
+              rpc :GetCampaignSharedSet, GetCampaignSharedSetRequest, Google::Ads::Googleads::V0::Resources::CampaignSharedSet
+              # Creates or removes campaign shared sets. Operation statuses are returned.
+              rpc :MutateCampaignSharedSets, MutateCampaignSharedSetsRequest, MutateCampaignSharedSetsResponse
+            end
+
+            Stub = Service.rpc_stub_class
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -22,8 +22,16 @@ module Google
           class Credentials < Google::Auth::Credentials
             SCOPE = [
             ].freeze
-            PATH_ENV_VARS = %w(GOOGLEADS_KEYFILE GOOGLE_CLOUD_KEYFILE GCLOUD_KEYFILE)
-            JSON_ENV_VARS = %w(GOOGLEADS_KEYFILE_JSON GOOGLE_CLOUD_KEYFILE_JSON GCLOUD_KEYFILE_JSON)
+            PATH_ENV_VARS = %w(GOOGLEADS_CREDENTIALS
+                               GOOGLEADS_KEYFILE
+                               GOOGLE_CLOUD_CREDENTIALS
+                               GOOGLE_CLOUD_KEYFILE
+                               GCLOUD_KEYFILE)
+            JSON_ENV_VARS = %w(GOOGLEADS_CREDENTIALS_JSON
+                               GOOGLEADS_KEYFILE_JSON
+                               GOOGLE_CLOUD_CREDENTIALS_JSON
+                               GOOGLE_CLOUD_KEYFILE_JSON
+                               GCLOUD_KEYFILE_JSON)
             DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
           end
         end

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

@@ -195,9 +195,9 @@ module Google
             # @return [Google::Ads::Googleads::V0::Resources::Customer]
             # @raise [Google::Gax::GaxError] if the RPC is aborted.
             # @example
-            #   require "google/ads/googleads/v0/services"
+            #   require "google/ads/googleads"
             #
-            #   customer_service_client = Google::Ads::Googleads::V0::Services::Customer.new
+            #   customer_service_client = Google::Ads::Googleads::Customer.new(version: :v0)
             #   formatted_resource_name = Google::Ads::Googleads::V0::Services::CustomerServiceClient.customer_path("[CUSTOMER]")
             #   response = customer_service_client.get_customer(formatted_resource_name)
 

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

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/ads/googleads/v0/services/customer_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/customer_service_pb'
@@ -25,8 +26,6 @@ module Google
       module V0
         module Services
           module CustomerService
-            # Proto file describing the Customer service.
-            #
             # Service to manage customers.
             class Service
 

data/lib/google/ads/googleads/v0/services/doc/google/ads/googleads/v0/common/ad_type_infos.rb

@@ -0,0 +1,120 @@
+# 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
+    module Googleads
+      module V0
+        module Common
+          # A text ad.
+          # @!attribute [rw] headline
+          #   @return [Google::Protobuf::StringValue]
+          #     The headline of the ad.
+          # @!attribute [rw] description1
+          #   @return [Google::Protobuf::StringValue]
+          #     The first line of the ad's description.
+          # @!attribute [rw] description2
+          #   @return [Google::Protobuf::StringValue]
+          #     The second line of the ad's description.
+          class TextAdInfo; end
+
+          # An expanded text ad.
+          # @!attribute [rw] headline_part1
+          #   @return [Google::Protobuf::StringValue]
+          #     The first part of the ad's headline.
+          # @!attribute [rw] headline_part2
+          #   @return [Google::Protobuf::StringValue]
+          #     The second part of the ad's headline.
+          # @!attribute [rw] description
+          #   @return [Google::Protobuf::StringValue]
+          #     The description of the ad.
+          # @!attribute [rw] path1
+          #   @return [Google::Protobuf::StringValue]
+          #     The text that can appear alongside the ad's displayed URL.
+          # @!attribute [rw] path2
+          #   @return [Google::Protobuf::StringValue]
+          #     Additional text that can appear alongside the ad's displayed URL.
+          class ExpandedTextAdInfo; end
+
+          # A dynamic search ad.
+          # @!attribute [rw] description1
+          #   @return [Google::Protobuf::StringValue]
+          #     The first line of the ad's description.
+          # @!attribute [rw] description2
+          #   @return [Google::Protobuf::StringValue]
+          #     The second line of the ad's description.
+          class DynamicSearchAdInfo; end
+
+          # A responsive display ad.
+          # @!attribute [rw] short_headline
+          #   @return [Google::Protobuf::StringValue]
+          #     The short version of the ad's headline.
+          # @!attribute [rw] long_headline
+          #   @return [Google::Protobuf::StringValue]
+          #     The long version of the ad's headline.
+          # @!attribute [rw] description
+          #   @return [Google::Protobuf::StringValue]
+          #     The description of the ad.
+          # @!attribute [rw] business_name
+          #   @return [Google::Protobuf::StringValue]
+          #     The business name in the ad.
+          class ResponsiveDisplayAdInfo; end
+
+          # A call-only ad.
+          # @!attribute [rw] country_code
+          #   @return [Google::Protobuf::StringValue]
+          #     The country code in the ad.
+          # @!attribute [rw] phone_number
+          #   @return [Google::Protobuf::StringValue]
+          #     The phone number in the ad.
+          # @!attribute [rw] business_name
+          #   @return [Google::Protobuf::StringValue]
+          #     The business name in the ad.
+          # @!attribute [rw] description1
+          #   @return [Google::Protobuf::StringValue]
+          #     The first line of the ad's description.
+          # @!attribute [rw] description2
+          #   @return [Google::Protobuf::StringValue]
+          #     The second line of the ad's description.
+          # @!attribute [rw] call_tracked
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether to enable call tracking for the creative. Enabling call
+          #     tracking also enables call conversions.
+          # @!attribute [rw] disable_call_conversion
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether to disable call conversion for the creative.
+          #     If set to +true+, disables call conversions even when +call_tracked+ is
+          #     +true+.
+          #     If +call_tracked+ is +false+, this field is ignored.
+          # @!attribute [rw] phone_number_verification_url
+          #   @return [Google::Protobuf::StringValue]
+          #     The URL to be used for phone number verification.
+          class CallOnlyAdInfo; end
+
+          # An expanded dynamic search ad.
+          # @!attribute [rw] description
+          #   @return [Google::Protobuf::StringValue]
+          #     The description of the ad.
+          class ExpandedDynamicSearchAdInfo; end
+
+          # A hotel ad.
+          class HotelAdInfo; end
+
+          # A Smart Shopping ad.
+          class ShoppingSmartAdInfo; end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/googleads/v0/services/doc/google/ads/googleads/v0/common/bidding.rb

@@ -0,0 +1,176 @@
+# 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
+    module Googleads
+      module V0
+        module Common
+          # An automated bidding strategy that raises bids for clicks
+          # that seem more likely to lead to a conversion and lowers
+          # them for clicks where they seem less likely.
+          class EnhancedCpc; end
+
+          # Manual click-based bidding where user pays per click.
+          # @!attribute [rw] enhanced_cpc_enabled
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether bids are to be enhanced based on conversion optimizer data.
+          class ManualCpc; end
+
+          # Manual impression-based bidding where user pays per thousand impressions.
+          class ManualCpm; end
+
+          # An automated bidding strategy that sets bids to help get the most conversions
+          # for your campaign while spending your budget.
+          class MaximizeConversions; end
+
+          # An automated bidding strategy which tries to maximize conversion value
+          # given a daily budget.
+          # @!attribute [rw] target_roas
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The target return on ad spend (ROAS) option. If set, the bid strategy will
+          #     maximize revenue while averaging the target return on ad spend. If the
+          #     target ROAS is high, the bid strategy may not be able to spend the full
+          #     budget. If the target ROAS is not set, the bid strategy will aim to
+          #     achieve the highest possible ROAS for the budget.
+          class MaximizeConversionValue; end
+
+          # An automated bidding strategy which sets CPC bids to target impressions on
+          # page one, or page one promoted slots on google.com.
+          # @!attribute [rw] strategy_goal
+          #   @return [Google::Ads::Googleads::V0::Enums::PageOnePromotedStrategyGoalEnum::PageOnePromotedStrategyGoal]
+          #     The strategy goal of where impressions are desired to be shown on
+          #     search result pages.
+          # @!attribute [rw] cpc_bid_ceiling_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     Maximum bid limit that can be set by the bid strategy.
+          #     The limit applies to all keywords managed by the strategy.
+          # @!attribute [rw] bid_modifier
+          #   @return [Google::Protobuf::DoubleValue]
+          #     Bid multiplier to be applied to the relevant bid estimate (depending on
+          #     the +strategy_goal+) in determining a keyword's new CPC bid.
+          # @!attribute [rw] only_raise_cpc_bids
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether the strategy should always follow bid estimate changes, or only
+          #     increase.
+          #     If false, always sets a keyword's new bid to the current bid estimate.
+          #     If true, only updates a keyword's bid if the current bid estimate is
+          #     greater than the current bid.
+          # @!attribute [rw] raise_cpc_bid_when_budget_constrained
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether the strategy is allowed to raise bids when the throttling
+          #     rate of the budget it is serving out of rises above a threshold.
+          # @!attribute [rw] raise_cpc_bid_when_quality_score_is_low
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether the strategy is allowed to raise bids on keywords with
+          #     lower-range quality scores.
+          class PageOnePromoted; end
+
+          # An automated bid strategy that sets bids to help get as many conversions as
+          # possible at the target cost-per-acquisition (CPA) you set.
+          # @!attribute [rw] target_cpa_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     Average CPA target.
+          #     This target should be greater than or equal to minimum billable unit based
+          #     on the currency for the account.
+          # @!attribute [rw] cpc_bid_ceiling_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     Maximum bid limit that can be set by the bid strategy.
+          #     The limit applies to all keywords managed by the strategy.
+          # @!attribute [rw] cpc_bid_floor_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     Minimum bid limit that can be set by the bid strategy.
+          #     The limit applies to all keywords managed by the strategy.
+          class TargetCpa; end
+
+          # An automated bidding strategy that sets bids based on the target fraction of
+          # auctions where the advertiser should outrank a specific competitor.
+          # @!attribute [rw] target_outrank_share_micros
+          #   @return [Google::Protobuf::Int32Value]
+          #     The target fraction of auctions where the advertiser should outrank the
+          #     competitor.
+          #     The advertiser outranks the competitor in an auction if either the
+          #     advertiser appears above the competitor in the search results, or appears
+          #     in the search results when the competitor does not.
+          #     Value must be between 1 and 1000000, inclusive.
+          # @!attribute [rw] competitor_domain
+          #   @return [Google::Protobuf::StringValue]
+          #     Competitor's visible domain URL.
+          # @!attribute [rw] cpc_bid_ceiling_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     Maximum bid limit that can be set by the bid strategy.
+          #     The limit applies to all keywords managed by the strategy.
+          # @!attribute [rw] only_raise_cpc_bids
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether the strategy should always follow bid estimate changes,
+          #     or only increase.
+          #     If false, always set a keyword's new bid to the current bid estimate.
+          #     If true, only updates a keyword's bid if the current bid estimate is
+          #     greater than the current bid.
+          # @!attribute [rw] raise_cpc_bid_when_quality_score_is_low
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether the strategy is allowed to raise bids on keywords with
+          #     lower-range quality scores.
+          class TargetOutrankShare; end
+
+          # An automated bidding strategy that helps you maximize revenue while
+          # averaging a specific target return on ad spend (ROAS).
+          # @!attribute [rw] target_roas
+          #   @return [Google::Protobuf::DoubleValue]
+          #     Required. The desired revenue (based on conversion data) per unit of spend.
+          #     Value must be between 0.01 and 1000.0, inclusive.
+          # @!attribute [rw] cpc_bid_ceiling_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     Maximum bid limit that can be set by the bid strategy.
+          #     The limit applies to all keywords managed by the strategy.
+          # @!attribute [rw] cpc_bid_floor_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     Minimum bid limit that can be set by the bid strategy.
+          #     The limit applies to all keywords managed by the strategy.
+          class TargetRoas; end
+
+          # An automated bid strategy that sets your bids to help get as many clicks
+          # as possible within your budget.
+          # @!attribute [rw] target_spend_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     The spend target under which to maximize clicks.
+          #     A TargetSpend bidder will attempt to spend the smaller of this value
+          #     or the natural throttling spend amount.
+          #     If not specified, the budget is used as the spend target.
+          # @!attribute [rw] cpc_bid_ceiling_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     Maximum bid limit that can be set by the bid strategy.
+          #     The limit applies to all keywords managed by the strategy.
+          class TargetSpend; end
+
+          # A bidding strategy where bids are a fraction of the advertised price for
+          # some good or service.
+          # @!attribute [rw] cpc_bid_ceiling_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     Maximum bid limit that can be set by the bid strategy. This is
+          #     an optional field entered by the advertiser and specified in local micros.
+          #     Note: A zero value is interpreted in the same way as having bid_ceiling
+          #     undefined.
+          # @!attribute [rw] enhanced_cpc_enabled
+          #   @return [Google::Protobuf::BoolValue]
+          #     Adjusts the bid for each auction upward or downward, depending on the
+          #     likelihood of a conversion. Individual bids may exceed
+          #     cpc_bid_ceiling_micros, but the average bid amount for a campaign should
+          #     not.
+          class PercentCpc; end
+        end
+      end
+    end
+  end
+end