google-ads-googleads 0.3.0 → 0.4.0

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

@@ -0,0 +1,29 @@
+# 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 Services
+          # Request message for {Google::Ads::Googleads::V0::Services::GeoTargetConstantService::GetGeoTargetConstant GeoTargetConstantService::GetGeoTargetConstant}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the geo target constant to fetch.
+          class GetGeoTargetConstantRequest; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# 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 Services
+          # Request message for {Google::Ads::Googleads::V0::Services::GoogleAdsFieldService::GetGoogleAdsField GoogleAdsFieldService::GetGoogleAdsField}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the field to get.
+          class GetGoogleAdsFieldRequest; end
+
+          # Request message for {Google::Ads::Googleads::V0::Services::GoogleAdsFieldService::SearchGoogleAdsFields GoogleAdsFieldService::SearchGoogleAdsFields}.
+          # @!attribute [rw] query
+          #   @return [String]
+          #     The query string.
+          # @!attribute [rw] page_token
+          #   @return [String]
+          #     Token of the page to retrieve. If not specified, the first page of
+          #     results will be returned. Use the value obtained from +next_page_token+
+          #     in the previous response in order to request the next page of results.
+          # @!attribute [rw] page_size
+          #   @return [Integer]
+          #     Number of elements to retrieve in a single page.
+          #     When too large a page is requested, the server may decide to further
+          #     limit the number of returned resources.
+          class SearchGoogleAdsFieldsRequest; end
+
+          # Response message for {Google::Ads::Googleads::V0::Services::GoogleAdsFieldService::SearchGoogleAdsFields GoogleAdsFieldService::SearchGoogleAdsFields}.
+          # @!attribute [rw] results
+          #   @return [Array<Google::Ads::Googleads::V0::Resources::GoogleAdsField>]
+          #     The list of fields that matched the query.
+          # @!attribute [rw] next_page_token
+          #   @return [String]
+          #     Pagination token used to retrieve the next page of results. Pass the
+          #     content of this string as the +page_token+ attribute of the next request.
+          #     +next_page_token+ is not returned for the last page.
+          # @!attribute [rw] total_results_count
+          #   @return [Integer]
+          #     Total number of results that match the query ignoring the LIMIT clause.
+          class SearchGoogleAdsFieldsResponse; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,156 @@
+# 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 Services
+          # Request message for {Google::Ads::Googleads::V0::Services::GoogleAdsService::Search GoogleAdsService::Search}.
+          # @!attribute [rw] customer_id
+          #   @return [String]
+          #     The ID of the customer being queried.
+          # @!attribute [rw] query
+          #   @return [String]
+          #     The query string.
+          # @!attribute [rw] page_token
+          #   @return [String]
+          #     Token of the page to retrieve. If not specified, the first
+          #     page of results will be returned. Use the value obtained from
+          #     +next_page_token+ in the previous response in order to request
+          #     the next page of results.
+          # @!attribute [rw] page_size
+          #   @return [Integer]
+          #     Number of elements to retrieve in a single page.
+          #     When too large a page is requested, the server may decide to
+          #     further limit the number of returned resources.
+          class SearchGoogleAdsRequest; end
+
+          # Response message for {Google::Ads::Googleads::V0::Services::GoogleAdsService::Search GoogleAdsService::Search}.
+          # @!attribute [rw] results
+          #   @return [Array<Google::Ads::Googleads::V0::Services::GoogleAdsRow>]
+          #     The list of rows that matched the query.
+          # @!attribute [rw] next_page_token
+          #   @return [String]
+          #     Pagination token used to retrieve the next page of results.
+          #     Pass the content of this string as the +page_token+ attribute of
+          #     the next request. +next_page_token+ is not returned for the last
+          #     page.
+          # @!attribute [rw] total_results_count
+          #   @return [Integer]
+          #     Total number of results that match the query ignoring the LIMIT
+          #     clause.
+          # @!attribute [rw] field_mask
+          #   @return [Google::Protobuf::FieldMask]
+          #     FieldMask that represents what fields were requested by the user.
+          class SearchGoogleAdsResponse; end
+
+          # A returned row from the query.
+          # @!attribute [rw] ad_group
+          #   @return [Google::Ads::Googleads::V0::Resources::AdGroup]
+          #     The ad group referenced in the query.
+          # @!attribute [rw] ad_group_ad
+          #   @return [Google::Ads::Googleads::V0::Resources::AdGroupAd]
+          #     The ad referenced in the query.
+          # @!attribute [rw] ad_group_bid_modifier
+          #   @return [Google::Ads::Googleads::V0::Resources::AdGroupBidModifier]
+          #     The bid modifier referenced in the query.
+          # @!attribute [rw] ad_group_criterion
+          #   @return [Google::Ads::Googleads::V0::Resources::AdGroupCriterion]
+          #     The criterion referenced in the query.
+          # @!attribute [rw] bidding_strategy
+          #   @return [Google::Ads::Googleads::V0::Resources::BiddingStrategy]
+          #     The bidding strategy referenced in the query.
+          # @!attribute [rw] campaign_budget
+          #   @return [Google::Ads::Googleads::V0::Resources::CampaignBudget]
+          #     The campaign budget referenced in the query.
+          # @!attribute [rw] campaign
+          #   @return [Google::Ads::Googleads::V0::Resources::Campaign]
+          #     The campaign referenced in the query.
+          # @!attribute [rw] campaign_bid_modifier
+          #   @return [Google::Ads::Googleads::V0::Resources::CampaignBidModifier]
+          #     The campaign bid modifier referenced in the query.
+          # @!attribute [rw] campaign_criterion
+          #   @return [Google::Ads::Googleads::V0::Resources::CampaignCriterion]
+          #     The campaign criterion referenced in the query.
+          # @!attribute [rw] campaign_group
+          #   @return [Google::Ads::Googleads::V0::Resources::CampaignGroup]
+          #     Campaign Group referenced in AWQL query.
+          # @!attribute [rw] campaign_shared_set
+          #   @return [Google::Ads::Googleads::V0::Resources::CampaignSharedSet]
+          #     Campaign Shared Set referenced in AWQL query.
+          # @!attribute [rw] customer
+          #   @return [Google::Ads::Googleads::V0::Resources::Customer]
+          #     The customer referenced in the query.
+          # @!attribute [rw] geo_target_constant
+          #   @return [Google::Ads::Googleads::V0::Resources::GeoTargetConstant]
+          #     The geo target constant referenced in the query.
+          # @!attribute [rw] keyword_view
+          #   @return [Google::Ads::Googleads::V0::Resources::KeywordView]
+          #     The keyword view referenced in the query.
+          # @!attribute [rw] recommendation
+          #   @return [Google::Ads::Googleads::V0::Resources::Recommendation]
+          #     The recommendation referenced in the query.
+          # @!attribute [rw] shared_criterion
+          #   @return [Google::Ads::Googleads::V0::Resources::SharedCriterion]
+          #     The shared set referenced in the query.
+          # @!attribute [rw] shared_set
+          #   @return [Google::Ads::Googleads::V0::Resources::SharedSet]
+          #     The shared set referenced in the query.
+          # @!attribute [rw] metrics
+          #   @return [Google::Ads::Googleads::V0::Common::Metrics]
+          #     The metrics.
+          # @!attribute [rw] ad_network_type
+          #   @return [Google::Ads::Googleads::V0::Enums::AdNetworkTypeEnum::AdNetworkType]
+          #     Ad network type.
+          # @!attribute [rw] date
+          #   @return [Google::Protobuf::StringValue]
+          #     Date to which metrics apply.
+          #     YYYY-MM-DD format, e.g., 2018-04-17.
+          # @!attribute [rw] day_of_week
+          #   @return [Google::Ads::Googleads::V0::Enums::DayOfWeekEnum::DayOfWeek]
+          #     Day of the week, e.g., MONDAY.
+          # @!attribute [rw] device
+          #   @return [Google::Ads::Googleads::V0::Enums::DeviceEnum::Device]
+          #     Device to which metrics apply.
+          # @!attribute [rw] hour
+          #   @return [Google::Protobuf::Int32Value]
+          #     Hour of day as a number between 0 and 23, inclusive.
+          # @!attribute [rw] month
+          #   @return [Google::Protobuf::StringValue]
+          #     Month as represented by the date of the first day of a month.
+          # @!attribute [rw] month_of_year
+          #   @return [Google::Ads::Googleads::V0::Enums::MonthOfYearEnum::MonthOfYear]
+          #     Month of the year, e.g., January.
+          # @!attribute [rw] quarter
+          #   @return [Google::Protobuf::StringValue]
+          #     Quarter as represented by the date of the first day of a quarter.
+          #     Uses the calendar year for quarters,
+          #     e.g., the second quarter of 2018 starts on 2018-04-01.
+          # @!attribute [rw] slot
+          #   @return [Google::Ads::Googleads::V0::Enums::SlotEnum::Slot]
+          #     Position of the ad.
+          # @!attribute [rw] week
+          #   @return [Google::Protobuf::StringValue]
+          #     Week as defined as Monday through Sunday, and represented by the date of
+          #     Monday.
+          # @!attribute [rw] year
+          #   @return [Google::Protobuf::Int32Value]
+          #     Year, formatted as yyyy.
+          class GoogleAdsRow; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# 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 Services
+          # Request message for {Google::Ads::Googleads::V0::Services::KeywordViewService::GetKeywordView KeywordViewService::GetKeywordView}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the keyword view to fetch.
+          class GetKeywordViewRequest; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+# 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 Services
+          # Request message for {Google::Ads::Googleads::V0::Services::RecommendationService::GetRecommendation RecommendationService::GetRecommendation}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the recommendation to fetch.
+          class GetRecommendationRequest; end
+
+          # Request message for {Google::Ads::Googleads::V0::Services::RecommendationService::ApplyRecommendation RecommendationService::ApplyRecommendation}.
+          # @!attribute [rw] customer_id
+          #   @return [String]
+          #     The ID of the customer with the recommendation.
+          # @!attribute [rw] operations
+          #   @return [Array<Google::Ads::Googleads::V0::Services::ApplyRecommendationOperation>]
+          #     The list of operations to apply recommendations.
+          class ApplyRecommendationRequest; end
+
+          # Information about the operation to apply a recommendation and any parameters
+          # to
+          # customize it.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the recommendation to apply.
+          # @!attribute [rw] campaign_budget
+          #   @return [Google::Ads::Googleads::V0::Services::ApplyRecommendationOperation::CampaignBudgetParameters]
+          #     Optional parameters to use when applying a campaign budget
+          #     recommendation.
+          # @!attribute [rw] text_ad
+          #   @return [Google::Ads::Googleads::V0::Services::ApplyRecommendationOperation::TextAdParameters]
+          #     Optional parameters to use when applying a text ad recommendation.
+          # @!attribute [rw] keyword
+          #   @return [Google::Ads::Googleads::V0::Services::ApplyRecommendationOperation::KeywordParameters]
+          #     Optional parameters to use when applying keyword recommendation.
+          # @!attribute [rw] target_cpa_opt_in
+          #   @return [Google::Ads::Googleads::V0::Services::ApplyRecommendationOperation::TargetCpaOptInParameters]
+          #     Optional parameters to use when applying target CPA opt-in
+          #     recommendation.
+          class ApplyRecommendationOperation
+            # Parameters to use when applying a campaign budget recommendation.
+            # @!attribute [rw] new_budget_amount_micros
+            #   @return [Google::Protobuf::Int64Value]
+            #     New budget amount to set for target budget resource. This is a required
+            #     field.
+            class CampaignBudgetParameters; end
+
+            # Parameters to use when applying a text ad recommendation.
+            # @!attribute [rw] ad
+            #   @return [Google::Ads::Googleads::V0::Resources::Ad]
+            #     New ad to add to recommended ad group. All necessary fields need to be
+            #     set in this message. This is a required field.
+            class TextAdParameters; end
+
+            # Parameters to use when applying keyword recommendation.
+            # @!attribute [rw] ad_group
+            #   @return [Google::Protobuf::StringValue]
+            #     The ad group resource to add keyword to. This is a required field.
+            # @!attribute [rw] match_type
+            #   @return [Google::Ads::Googleads::V0::Enums::KeywordMatchTypeEnum::KeywordMatchType]
+            #     The match type of the keyword. This is a required field.
+            # @!attribute [rw] cpc_bid_micros
+            #   @return [Google::Protobuf::Int64Value]
+            #     Optional, CPC bid to set for the keyword. If not set, keyword will use
+            #     bid based on bidding strategy used by target ad group.
+            class KeywordParameters; end
+
+            # Parameters to use when applying Target CPA recommendation.
+            # @!attribute [rw] target_cpa_micros
+            #   @return [Google::Protobuf::Int64Value]
+            #     Average CPA to use for Target CPA bidding strategy. This is a required
+            #     field.
+            # @!attribute [rw] new_campaign_budget_amount_micros
+            #   @return [Google::Protobuf::Int64Value]
+            #     Optional, budget amount to set for the campaign.
+            class TargetCpaOptInParameters; end
+          end
+
+          # Response message for {Google::Ads::Googleads::V0::Services::RecommendationService::ApplyRecommendation RecommendationService::ApplyRecommendation}.
+          # @!attribute [rw] results
+          #   @return [Array<Google::Ads::Googleads::V0::Services::ApplyRecommendationResult>]
+          #     Results of operations to apply recommendations.
+          class ApplyRecommendationResponse; end
+
+          # The result of applying a recommendation.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     Returned for successful applies.
+          # @!attribute [rw] status
+          #   @return [Google::Rpc::Status]
+          #     Returned for failed operations.
+          class ApplyRecommendationResult; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# 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 Services
+          # Request message for {Google::Ads::Googleads::V0::Services::SharedCriterionService::GetSharedCriterion SharedCriterionService::GetSharedCriterion}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the shared criterion to fetch.
+          class GetSharedCriterionRequest; end
+
+          # Request message for {Google::Ads::Googleads::V0::Services::SharedCriterionService::MutateSharedCriteria SharedCriterionService::MutateSharedCriteria}.
+          # @!attribute [rw] customer_id
+          #   @return [String]
+          #     The ID of the customer whose shared criteria are being modified.
+          # @!attribute [rw] operations
+          #   @return [Array<Google::Ads::Googleads::V0::Services::SharedCriterionOperation>]
+          #     The list of operations to perform on individual shared criteria.
+          class MutateSharedCriteriaRequest; end
+
+          # A single operation (create, remove) on an shared criterion.
+          # @!attribute [rw] create
+          #   @return [Google::Ads::Googleads::V0::Resources::SharedCriterion]
+          #     Create operation: No resource name is expected for the new shared
+          #     criterion.
+          # @!attribute [rw] remove
+          #   @return [String]
+          #     Remove operation: A resource name for the removed shared criterion is
+          #     expected,
+          #     in this format:
+          #
+          #     +customers/{customer_id}/sharedCriteria/{shared_set_id}_{criterion_id}+
+          class SharedCriterionOperation; end
+
+          # Response message for a shared criterion mutate.
+          # @!attribute [rw] results
+          #   @return [Array<Google::Ads::Googleads::V0::Services::MutateSharedCriterionResult>]
+          #     All results for the mutate.
+          class MutateSharedCriteriaResponse; end
+
+          # The result for the shared criterion mutate.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     Returned for successful operations.
+          class MutateSharedCriterionResult; end
+        end
+      end
+    end
+  end
+end