google-ads-googleads 0.3.0 → 0.4.0

data/lib/google/ads/googleads/v0/services/doc/google/ads/googleads/v0/resources/campaign_shared_set.rb

@@ -0,0 +1,47 @@
+# 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 Resources
+          # CampaignSharedSets are used for managing the shared sets associated with a
+          # campaign.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the campaign shared set.
+          #     Campaign shared set resource names have the form:
+          #
+          #     +customers/{customer_id}/campaignSharedSets/{campaign_id}_{shared_set_id}+
+          # @!attribute [rw] campaign
+          #   @return [Google::Protobuf::StringValue]
+          #     The campaign to which the campaign shared set belongs.
+          # @!attribute [rw] shared_set
+          #   @return [Google::Protobuf::StringValue]
+          #     The shared set associated with the campaign. This may be a negative keyword
+          #     shared set of another customer. This customer should be a manager of the
+          #     other customer, otherwise the campaign shared set will exist but have no
+          #     serving effect. Only negative keyword shared sets can be associated with
+          #     Shopping campaigns. Only negative placement shared sets can be associated
+          #     with Display mobile app campaigns.
+          # @!attribute [rw] status
+          #   @return [Google::Ads::Googleads::V0::Enums::CampaignSharedSetStatusEnum::CampaignSharedSetStatus]
+          #     The status of this campaign shared set. Read only.
+          class CampaignSharedSet; end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/googleads/v0/services/doc/google/ads/googleads/v0/resources/customer.rb

@@ -0,0 +1,57 @@
+# 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 Resources
+          # A customer.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the customer.
+          #     Customer resource names have the form:
+          #
+          #     +customers/{customer_id}+
+          # @!attribute [rw] id
+          #   @return [Google::Protobuf::Int64Value]
+          #     The ID of the customer.
+          # @!attribute [rw] descriptive_name
+          #   @return [Google::Protobuf::StringValue]
+          #     Optional, non-unique descriptive name of the customer.
+          # @!attribute [rw] currency_code
+          #   @return [Google::Protobuf::StringValue]
+          #     The currency in which the account operates.
+          #     A subset of the currency codes from the ISO 4217 standard is
+          #     supported.
+          # @!attribute [rw] time_zone
+          #   @return [Google::Protobuf::StringValue]
+          #     The local timezone ID of the customer.
+          # @!attribute [rw] tracking_url_template
+          #   @return [Google::Protobuf::StringValue]
+          #     The URL template for constructing a tracking URL out of parameters.
+          # @!attribute [rw] auto_tagging_enabled
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether auto-tagging is enabled for the customer.
+          # @!attribute [rw] has_partners_badge
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether the Customer has a Partners program badge. If the Customer is not
+          #     associated with the Partners program, this will be false. For more
+          #     information, see https://support.google.com/partners/answer/3125774
+          class Customer; end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/googleads/v0/services/doc/google/ads/googleads/v0/resources/geo_target_constant.rb

@@ -0,0 +1,44 @@
+# 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 Resources
+          # A geo target constant.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the geo target constant.
+          #     Geo target constant resource names have the form:
+          #
+          #     +geoTargetConstants/{geo_target_constant_id}+
+          # @!attribute [rw] id
+          #   @return [Google::Protobuf::Int64Value]
+          #     The ID of the geo target constant.
+          # @!attribute [rw] name
+          #   @return [Google::Protobuf::StringValue]
+          #     Geo target constant English name.
+          # @!attribute [rw] country_code
+          #   @return [Google::Protobuf::StringValue]
+          #     The ISO-3166-1 alpha-2 country code that is associated with the target.
+          # @!attribute [rw] target_type
+          #   @return [Google::Protobuf::StringValue]
+          #     Geo target constant target type.
+          class GeoTargetConstant; end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/googleads/v0/services/doc/google/ads/googleads/v0/resources/google_ads_field.rb

@@ -0,0 +1,89 @@
+# 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 Resources
+          # A field or resource (artifact) used by GoogleAdsService.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the artifact.
+          #     Artifact resource names have the form:
+          #
+          #     +googleAdsFields/{name}+
+          # @!attribute [rw] name
+          #   @return [Google::Protobuf::StringValue]
+          #     The name of the artifact.
+          # @!attribute [rw] category
+          #   @return [Google::Ads::Googleads::V0::Enums::GoogleAdsFieldCategoryEnum::GoogleAdsFieldCategory]
+          #     The category of the artifact.
+          # @!attribute [rw] selectable
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether the artifact can be used in a SELECT clause in search
+          #     queries.
+          # @!attribute [rw] filterable
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether the artifact can be used in a WHERE clause in search
+          #     queries.
+          # @!attribute [rw] sortable
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether the artifact can be used in a ORDER BY clause in search
+          #     queries.
+          # @!attribute [rw] selectable_with
+          #   @return [Array<Google::Protobuf::StringValue>]
+          #     The names of all resources, segments, and metrics that are selectable with
+          #     the described artifact.
+          # @!attribute [rw] attribute_resources
+          #   @return [Array<Google::Protobuf::StringValue>]
+          #     The names of all resources that are selectable with the described
+          #     artifact. Fields from these resources do not segment metrics when included
+          #     in search queries.
+          #
+          #     This field is only set for artifacts whose category is RESOURCE.
+          # @!attribute [rw] metrics
+          #   @return [Array<Google::Protobuf::StringValue>]
+          #     The names of all metrics that are selectable with the described artifact.
+          #
+          #     This field is only set for artifacts whose category is either RESOURCE or
+          #     SEGMENT.
+          # @!attribute [rw] segments
+          #   @return [Array<Google::Protobuf::StringValue>]
+          #     The names of all artifacts, whether a segment or another resource, that
+          #     segment metrics when included in search queries.
+          #
+          #     This field is only set for artifacts of category RESOURCE, SEGMENT or
+          #     METRIC.
+          # @!attribute [rw] enum_values
+          #   @return [Array<Google::Protobuf::StringValue>]
+          #     Values the artifact can assume if it is a field of type ENUM.
+          #
+          #     This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
+          # @!attribute [rw] data_type
+          #   @return [Google::Ads::Googleads::V0::Enums::GoogleAdsFieldDataTypeEnum::GoogleAdsFieldDataType]
+          #     This field determines the operators that can be used with the artifact
+          #     in WHERE clauses.
+          # @!attribute [rw] type_url
+          #   @return [Google::Protobuf::StringValue]
+          #     The URL of proto describing the artifact's data type.
+          # @!attribute [rw] is_repeated
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether the field artifact is repeated.
+          class GoogleAdsField; end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/googleads/v0/services/doc/google/ads/googleads/v0/resources/keyword_view.rb

@@ -0,0 +1,32 @@
+# 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 Resources
+          # A keyword view.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the keyword view.
+          #     Keyword view resource names have the form:
+          #
+          #     +customers/{customer_id}/keywordViews/{ad_group_id}_{criterion_id}+
+          class KeywordView; end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/googleads/v0/services/doc/google/ads/googleads/v0/resources/recommendation.rb

@@ -0,0 +1,223 @@
+# 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 Resources
+          # A recommendation.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the recommendation.
+          #
+          #     +customers/{customer_id}/recommendations/{recommendation_id}+
+          # @!attribute [rw] type
+          #   @return [Google::Ads::Googleads::V0::Enums::RecommendationTypeEnum::RecommendationType]
+          #     The type of recommendation.
+          # @!attribute [rw] impact
+          #   @return [Google::Ads::Googleads::V0::Resources::Recommendation::RecommendationImpact]
+          #     The impact on account performance as a result of applying the
+          #     recommendation.
+          # @!attribute [rw] campaign_budget
+          #   @return [Google::Protobuf::StringValue]
+          #     The budget targeted by this recommendation. This will be set only when
+          #     the recommendation affects a single campaign budget.
+          #
+          #     This field must not be used in WHERE clauses.
+          #
+          #     This field will be set for the following recommendation types:
+          #     CAMPAIGN_BUDGET
+          # @!attribute [rw] campaign
+          #   @return [Google::Protobuf::StringValue]
+          #     The campaign targeted by this recommendation. This will be set only when
+          #     the recommendation affects a single campaign.
+          #
+          #     This field must not be used in WHERE clauses.
+          #
+          #     This field will be set for the following recommendation types:
+          #     ENHANCED_CPC_OPT_IN, KEYWORD, MAXIMIZE_CLICKS_OPT_IN,
+          #     MAXIMIZE_CONVERSIONS_OPT_IN, OPTIMIZE_AD_ROTATION, SEARCH_PARTNERS_OPT_IN,
+          #     TARGET_CPA_OPT_IN, TEXT_AD
+          # @!attribute [rw] ad_group
+          #   @return [Google::Protobuf::StringValue]
+          #     The ad group targeted by this recommendation. This will be set only when
+          #     the recommendation affects a single ad group.
+          #
+          #     This field must not be used in WHERE clauses.
+          #
+          #     This field will be set for the following recommendation types:
+          #     KEYWORD, OPTIMIZE_AD_ROTATION, TEXT_AD
+          # @!attribute [rw] dismissed
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether the recommendation is dismissed or not.
+          # @!attribute [rw] campaign_budget_recommendation
+          #   @return [Google::Ads::Googleads::V0::Resources::Recommendation::CampaignBudgetRecommendation]
+          #     The campaign budget recommendation.
+          # @!attribute [rw] keyword_recommendation
+          #   @return [Google::Ads::Googleads::V0::Resources::Recommendation::KeywordRecommendation]
+          #     The keyword recommendation.
+          # @!attribute [rw] text_ad_recommendation
+          #   @return [Google::Ads::Googleads::V0::Resources::Recommendation::TextAdRecommendation]
+          #     Add expanded text ad recommendation.
+          # @!attribute [rw] target_cpa_opt_in_recommendation
+          #   @return [Google::Ads::Googleads::V0::Resources::Recommendation::TargetCpaOptInRecommendation]
+          #     The TargetCPA opt-in recommendation.
+          # @!attribute [rw] maximize_conversions_opt_in_recommendation
+          #   @return [Google::Ads::Googleads::V0::Resources::Recommendation::MaximizeConversionsOptInRecommendation]
+          #     The MaximizeConversions Opt-In recommendation.
+          # @!attribute [rw] enhanced_cpc_opt_in_recommendation
+          #   @return [Google::Ads::Googleads::V0::Resources::Recommendation::EnhancedCpcOptInRecommendation]
+          #     The Enhanced Cost-Per-Click Opt-In recommendation.
+          # @!attribute [rw] search_partners_opt_in_recommendation
+          #   @return [Google::Ads::Googleads::V0::Resources::Recommendation::SearchPartnersOptInRecommendation]
+          #     The Search Partners Opt-In recommendation.
+          # @!attribute [rw] maximize_clicks_opt_in_recommendation
+          #   @return [Google::Ads::Googleads::V0::Resources::Recommendation::MaximizeClicksOptInRecommendation]
+          #     The MaximizeClicks Opt-In recommendation.
+          # @!attribute [rw] optimize_ad_rotation_recommendation
+          #   @return [Google::Ads::Googleads::V0::Resources::Recommendation::OptimizeAdRotationRecommendation]
+          #     The Optimize Ad Rotation recommendation.
+          class Recommendation
+            # The impact of making the change as described in the recommendation.
+            # Some types of recommendations may not have impact information.
+            # @!attribute [rw] base_metrics
+            #   @return [Google::Ads::Googleads::V0::Resources::Recommendation::RecommendationMetrics]
+            #     Base metrics at the time the recommendation was generated.
+            # @!attribute [rw] potential_metrics
+            #   @return [Google::Ads::Googleads::V0::Resources::Recommendation::RecommendationMetrics]
+            #     Estimated metrics if the recommendation is applied.
+            class RecommendationImpact; end
+
+            # Weekly account performance metrics. For some recommendation types, these
+            # are averaged over the past 90-day period and hence can be fractional.
+            # @!attribute [rw] impressions
+            #   @return [Google::Protobuf::DoubleValue]
+            #     Number of ad impressions.
+            # @!attribute [rw] clicks
+            #   @return [Google::Protobuf::DoubleValue]
+            #     Number of ad clicks.
+            # @!attribute [rw] cost_micros
+            #   @return [Google::Protobuf::Int64Value]
+            #     Cost (in micros) for advertising, in the local currency for the account.
+            # @!attribute [rw] conversions
+            #   @return [Google::Protobuf::DoubleValue]
+            #     Number of conversions.
+            # @!attribute [rw] video_views
+            #   @return [Google::Protobuf::DoubleValue]
+            #     Number of video views for a video ad campaign.
+            class RecommendationMetrics; end
+
+            # The budget recommendation for budget constrained campaigns.
+            # @!attribute [rw] current_budget_amount_micros
+            #   @return [Google::Protobuf::Int64Value]
+            #     The current budget amount in micros.
+            # @!attribute [rw] recommended_budget_amount_micros
+            #   @return [Google::Protobuf::Int64Value]
+            #     The recommended budget amount in micros.
+            # @!attribute [rw] budget_options
+            #   @return [Array<Google::Ads::Googleads::V0::Resources::Recommendation::CampaignBudgetRecommendation::CampaignBudgetRecommendationOption>]
+            #     The budget amounts and associated impact estimates for some values of
+            #     possible budget amounts.
+            class CampaignBudgetRecommendation
+              # The impact estimates for a given budget amount.
+              # @!attribute [rw] budget_amount_micros
+              #   @return [Google::Protobuf::Int64Value]
+              #     The budget amount for this option.
+              # @!attribute [rw] impact
+              #   @return [Google::Ads::Googleads::V0::Resources::Recommendation::RecommendationImpact]
+              #     The impact estimate if budget is changed to amount specified in this
+              #     option.
+              class CampaignBudgetRecommendationOption; end
+            end
+
+            # The keyword recommendation.
+            # @!attribute [rw] keyword
+            #   @return [Google::Ads::Googleads::V0::Common::KeywordInfo]
+            #     The recommended keyword.
+            # @!attribute [rw] recommended_cpc_bid_micros
+            #   @return [Google::Protobuf::Int64Value]
+            #     The recommended CPC (cost-per-click) bid.
+            class KeywordRecommendation; end
+
+            # The text ad recommendation.
+            # @!attribute [rw] ad
+            #   @return [Google::Ads::Googleads::V0::Resources::Ad]
+            #     Recommended ad.
+            # @!attribute [rw] creation_date
+            #   @return [Google::Protobuf::StringValue]
+            #     Creation date of the recommended ad.
+            #     YYYY-MM-DD format, e.g., 2018-04-17.
+            # @!attribute [rw] auto_apply_date
+            #   @return [Google::Protobuf::StringValue]
+            #     Date, if present, is the earliest when the recommendation will be auto
+            #     applied.
+            #     YYYY-MM-DD format, e.g., 2018-04-17.
+            class TextAdRecommendation; end
+
+            # The Target CPA opt-in recommendation.
+            # @!attribute [rw] options
+            #   @return [Array<Google::Ads::Googleads::V0::Resources::Recommendation::TargetCpaOptInRecommendation::TargetCpaOptInRecommendationOption>]
+            #     The available goals and corresponding options for Target CPA strategy.
+            # @!attribute [rw] recommended_target_cpa_micros
+            #   @return [Google::Protobuf::Int64Value]
+            #     The recommended average CPA target. See required budget amount and impact
+            #     of using this recommendation in options list.
+            class TargetCpaOptInRecommendation
+              # The Target CPA opt-in option with impact estimate.
+              # @!attribute [rw] goal
+              #   @return [Google::Ads::Googleads::V0::Enums::TargetCpaOptInRecommendationGoalEnum::TargetCpaOptInRecommendationGoal]
+              #     The goal achieved by this option.
+              # @!attribute [rw] target_cpa_micros
+              #   @return [Google::Protobuf::Int64Value]
+              #     Average CPA target.
+              # @!attribute [rw] required_campaign_budget_amount_micros
+              #   @return [Google::Protobuf::Int64Value]
+              #     The minimum campaign budget, in local currency for the account,
+              #     required to achieve the target CPA.
+              #     Amount is specified in micros, where one million is equivalent to one
+              #     currency unit.
+              # @!attribute [rw] impact
+              #   @return [Google::Ads::Googleads::V0::Resources::Recommendation::RecommendationImpact]
+              #     The impact estimate if this option is selected.
+              class TargetCpaOptInRecommendationOption; end
+            end
+
+            # The Maximize Conversions Opt-In recommendation.
+            # @!attribute [rw] recommended_budget_amount_micros
+            #   @return [Google::Protobuf::Int64Value]
+            #     The recommended new budget amount.
+            class MaximizeConversionsOptInRecommendation; end
+
+            # The Enhanced Cost-Per-Click Opt-In recommendation.
+            class EnhancedCpcOptInRecommendation; end
+
+            # The Search Partners Opt-In recommendation.
+            class SearchPartnersOptInRecommendation; end
+
+            # The Maximize Clicks opt-in recommendation.
+            # @!attribute [rw] recommended_budget_amount_micros
+            #   @return [Google::Protobuf::Int64Value]
+            #     The recommended new budget amount.
+            #     Only set if the current budget is too high.
+            class MaximizeClicksOptInRecommendation; end
+
+            # The Optimize Ad Rotation recommendation.
+            class OptimizeAdRotationRecommendation; end
+          end
+        end
+      end
+    end
+  end
+end