google-ads-googleads 0.3.0 → 0.4.0

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

@@ -0,0 +1,79 @@
+# 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
+          # An ad.
+          # @!attribute [rw] id
+          #   @return [Google::Protobuf::Int64Value]
+          #     The ID of the ad.
+          # @!attribute [rw] final_urls
+          #   @return [Array<Google::Protobuf::StringValue>]
+          #     The list of possible final URLs after all cross-domain redirects for the
+          #     ad.
+          # @!attribute [rw] final_mobile_urls
+          #   @return [Array<Google::Protobuf::StringValue>]
+          #     The list of possible final mobile URLs after all cross-domain redirects
+          #     for the ad.
+          # @!attribute [rw] tracking_url_template
+          #   @return [Google::Protobuf::StringValue]
+          #     The URL template for constructing a tracking URL.
+          # @!attribute [rw] url_custom_parameters
+          #   @return [Array<Google::Ads::Googleads::V0::Common::CustomParameter>]
+          #     The list of mappings that can be used to substitute custom parameter tags
+          #     in a
+          #     +tracking_url_template+, +final_urls+, or +mobile_final_urls+.
+          # @!attribute [rw] display_url
+          #   @return [Google::Protobuf::StringValue]
+          #     The URL that appears in the ad description for some ad formats.
+          # @!attribute [rw] type
+          #   @return [Google::Ads::Googleads::V0::Enums::AdTypeEnum::AdType]
+          #     The type of ad.
+          # @!attribute [rw] text_ad
+          #   @return [Google::Ads::Googleads::V0::Common::TextAdInfo]
+          #     Details pertaining to a text ad.
+          # @!attribute [rw] expanded_text_ad
+          #   @return [Google::Ads::Googleads::V0::Common::ExpandedTextAdInfo]
+          #     Details pertaining to an expanded text ad.
+          # @!attribute [rw] dynamic_search_ad
+          #   @return [Google::Ads::Googleads::V0::Common::DynamicSearchAdInfo]
+          #     Details pertaining to a Dynamic Search Ad.
+          # @!attribute [rw] responsive_display_ad
+          #   @return [Google::Ads::Googleads::V0::Common::ResponsiveDisplayAdInfo]
+          #     Details pertaining to a responsive display ad.
+          # @!attribute [rw] call_only_ad
+          #   @return [Google::Ads::Googleads::V0::Common::CallOnlyAdInfo]
+          #     Details pertaining to a call-only ad.
+          # @!attribute [rw] expanded_dynamic_search_ad
+          #   @return [Google::Ads::Googleads::V0::Common::ExpandedDynamicSearchAdInfo]
+          #     Details pertaining to an Expanded Dynamic Search Ad.
+          #     This type of ad has its headline, final URLs, and display URL
+          #     auto-generated at serving time according to domain name specific
+          #     information provided by +dynamic_search_ads_setting+ linked at the
+          #     campaign level.
+          # @!attribute [rw] hotel_ad
+          #   @return [Google::Ads::Googleads::V0::Common::HotelAdInfo]
+          #     Details pertaining to a hotel ad.
+          # @!attribute [rw] shopping_smart_ad
+          #   @return [Google::Ads::Googleads::V0::Common::ShoppingSmartAdInfo]
+          #     Details pertaining to a Smart Shopping ad.
+          class Ad; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+# 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
+          # An ad group.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the ad group.
+          #     Ad group resource names have the form:
+          #
+          #     +customers/{customer_id}/adGroups/{ad_group_id}+
+          # @!attribute [rw] id
+          #   @return [Google::Protobuf::Int64Value]
+          #     The ID of the ad group.
+          # @!attribute [rw] name
+          #   @return [Google::Protobuf::StringValue]
+          #     The name of the ad group.
+          #
+          #     This field is required and should not be empty when creating new ad
+          #     groups.
+          #
+          #     It must contain fewer than 255 UTF-8 full-width characters.
+          #
+          #     It must not contain any null (code point 0x0), NL line feed
+          #     (code point 0xA) or carriage return (code point 0xD) characters.
+          # @!attribute [rw] status
+          #   @return [Google::Ads::Googleads::V0::Enums::AdGroupStatusEnum::AdGroupStatus]
+          #     The status of the ad group.
+          # @!attribute [rw] type
+          #   @return [Google::Ads::Googleads::V0::Enums::AdGroupTypeEnum::AdGroupType]
+          #     The type of the ad group.
+          # @!attribute [rw] tracking_url_template
+          #   @return [Google::Protobuf::StringValue]
+          #     The URL template for constructing a tracking URL.
+          # @!attribute [rw] url_custom_parameters
+          #   @return [Array<Google::Ads::Googleads::V0::Common::CustomParameter>]
+          #     The list of mappings used to substitute custom parameter tags in a
+          #     +tracking_url_template+, +final_urls+, or +mobile_final_urls+.
+          # @!attribute [rw] campaign
+          #   @return [Google::Protobuf::StringValue]
+          #     The campaign to which the ad group belongs.
+          #
+          #     This field must not be used in WHERE clauses.
+          # @!attribute [rw] cpc_bid_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     The maximum CPC (cost-per-click) bid.
+          # @!attribute [rw] cpm_bid_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     The maximum CPM (cost-per-thousand viewable impressions) bid.
+          # @!attribute [rw] cpa_bid_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     The target cost-per-acquisition (conversion) bid.
+          # @!attribute [rw] cpv_bid_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     The CPV (cost-per-view) bid.
+          # @!attribute [rw] target_roas_override
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The target return on ad spend (ROAS) override. If the ad group's campaign
+          #     bidding strategy is a standard Target ROAS strategy, then this field
+          #     overrides the target ROAS specified in the campaign's bidding strategy.
+          #     Otherwise, this value is ignored.
+          # @!attribute [rw] percent_cpc_bid_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     The percent cpc bid amount, expressed as a fraction of the advertised price
+          #     for some good or service. The valid range for the fraction is [0,1) and the
+          #     value stored here is 1,000,000 * [fraction].
+          class AdGroup; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# 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
+          # An ad group ad.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the ad.
+          #     Ad group ad resource names have the form:
+          #
+          #     +customers/{customer_id}/adGroupAds/{ad_group_id}_{ad_id}+
+          # @!attribute [rw] status
+          #   @return [Google::Ads::Googleads::V0::Enums::AdGroupAdStatusEnum::AdGroupAdStatus]
+          #     The status of the ad.
+          # @!attribute [rw] ad_group
+          #   @return [Google::Protobuf::StringValue]
+          #     The ad group to which the ad belongs.
+          #
+          #     This field must not be used in WHERE clauses.
+          # @!attribute [rw] ad
+          #   @return [Google::Ads::Googleads::V0::Resources::Ad]
+          #     The ad.
+          class AdGroupAd; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# 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
+          # Represents an ad group bid modifier.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the ad group bid modifier.
+          #     Ad group bid modifier resource names have the form:
+          #
+          #     +customers/{customer_id}/adGroupBidModifiers/{ad_group_id}_{criterion_id}+
+          # @!attribute [rw] ad_group
+          #   @return [Google::Protobuf::StringValue]
+          #     The ad group to which this criterion belongs.
+          #
+          #     This field must not be used in WHERE clauses.
+          # @!attribute [rw] criterion_id
+          #   @return [Google::Protobuf::Int64Value]
+          #     The ID of the criterion to bid modify.
+          #
+          #     This field is ignored for mutates.
+          # @!attribute [rw] bid_modifier
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The modifier for the bid when the criterion matches.
+          # @!attribute [rw] base_ad_group
+          #   @return [Google::Protobuf::StringValue]
+          #     The base ad group from which this draft/trial adgroup bid modifier was
+          #     created. If ad_group is a base ad group then this field will be equal to
+          #     ad_group. If the ad group was created in the draft or trial and has no
+          #     corresponding base ad group, then this field will be null.
+          #     This field is readonly.
+          # @!attribute [rw] bid_modifier_source
+          #   @return [Google::Ads::Googleads::V0::Enums::BidModifierSourceEnum::BidModifierSource]
+          #     Bid modifier source.
+          # @!attribute [rw] hotel_date_selection_type
+          #   @return [Google::Ads::Googleads::V0::Common::HotelDateSelectionTypeInfo]
+          #     Criterion for hotel date selection (default dates vs. user selected).
+          # @!attribute [rw] hotel_advance_booking_window
+          #   @return [Google::Ads::Googleads::V0::Common::HotelAdvanceBookingWindowInfo]
+          #     Criterion for number of days prior to the stay the booking is being made.
+          # @!attribute [rw] hotel_length_of_stay
+          #   @return [Google::Ads::Googleads::V0::Common::HotelLengthOfStayInfo]
+          #     Criterion for length of hotel stay in nights.
+          # @!attribute [rw] hotel_check_in_day
+          #   @return [Google::Ads::Googleads::V0::Common::HotelCheckInDayInfo]
+          #     Criterion for day of the week the booking is for.
+          # @!attribute [rw] device
+          #   @return [Google::Ads::Googleads::V0::Common::DeviceInfo]
+          #     A device criterion.
+          class AdGroupBidModifier; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,148 @@
+# 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
+          # An ad group criterion.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the ad group criterion.
+          #     Ad group criterion resource names have the form:
+          #
+          #     +customers/{customer_id}/adGroupCriteria/{ad_group_id}_{criterion_id}+
+          # @!attribute [rw] criterion_id
+          #   @return [Google::Protobuf::Int64Value]
+          #     The ID of the criterion.
+          #
+          #     This field is ignored for mutates.
+          # @!attribute [rw] status
+          #   @return [Google::Ads::Googleads::V0::Enums::AdGroupCriterionStatusEnum::AdGroupCriterionStatus]
+          #     The status of the criterion.
+          # @!attribute [rw] quality_info
+          #   @return [Google::Ads::Googleads::V0::Resources::AdGroupCriterion::QualityInfo]
+          #     Information regarding the quality of the criterion.
+          # @!attribute [rw] ad_group
+          #   @return [Google::Protobuf::StringValue]
+          #     The ad group to which the criterion belongs.
+          #
+          #     This field must not be used in WHERE clauses.
+          # @!attribute [rw] type
+          #   @return [Google::Ads::Googleads::V0::Enums::CriterionTypeEnum::CriterionType]
+          #     The type of the criterion.
+          # @!attribute [rw] negative
+          #   @return [Google::Protobuf::BoolValue]
+          #     Whether to target (+false+) or exclude (+true+) the criterion.
+          #
+          #     This field is immutable. To switch a criterion from positive to negative,
+          #     remove then re-add it.
+          # @!attribute [rw] cpc_bid_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     The CPC (cost-per-click) bid.
+          # @!attribute [rw] cpm_bid_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     The CPM (cost-per-thousand viewable impressions) bid.
+          # @!attribute [rw] cpv_bid_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     The CPV (cost-per-view) bid.
+          # @!attribute [rw] percent_cpc_bid_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     The CPC bid amount, expressed as a fraction of the advertised price
+          #     for some good or service. The valid range for the fraction is [0,1) and the
+          #     value stored here is 1,000,000 * [fraction].
+          # @!attribute [rw] effective_cpc_bid_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     The effective CPC (cost-per-click) bid.
+          # @!attribute [rw] effective_cpm_bid_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     The effective CPM (cost-per-thousand viewable impressions) bid.
+          # @!attribute [rw] effective_cpv_bid_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     The effective CPV (cost-per-view) bid.
+          # @!attribute [rw] effective_percent_cpc_bid_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     The effective Percent CPC bid amount.
+          # @!attribute [rw] effective_cpc_bid_source
+          #   @return [Google::Ads::Googleads::V0::Enums::BiddingSourceEnum::BiddingSource]
+          #     Source of the effective CPC bid.
+          # @!attribute [rw] effective_cpm_bid_source
+          #   @return [Google::Ads::Googleads::V0::Enums::BiddingSourceEnum::BiddingSource]
+          #     Source of the effective CPM bid.
+          # @!attribute [rw] effective_cpv_bid_source
+          #   @return [Google::Ads::Googleads::V0::Enums::BiddingSourceEnum::BiddingSource]
+          #     Source of the effective CPV bid.
+          # @!attribute [rw] effective_percent_cpc_bid_source
+          #   @return [Google::Ads::Googleads::V0::Enums::BiddingSourceEnum::BiddingSource]
+          #     Source of the effective Percent CPC bid.
+          # @!attribute [rw] position_estimates
+          #   @return [Google::Ads::Googleads::V0::Resources::AdGroupCriterion::PositionEstimates]
+          #     Estimates for criterion bids at various positions.
+          # @!attribute [rw] final_urls
+          #   @return [Array<Google::Protobuf::StringValue>]
+          #     The list of possible final URLs after all cross-domain redirects for the
+          #     ad.
+          # @!attribute [rw] tracking_url_template
+          #   @return [Google::Protobuf::StringValue]
+          #     The URL template for constructing a tracking URL.
+          # @!attribute [rw] url_custom_parameters
+          #   @return [Array<Google::Ads::Googleads::V0::Common::CustomParameter>]
+          #     The list of mappings used to substitute custom parameter tags in a
+          #     +tracking_url_template+, +final_urls+, or +mobile_final_urls+.
+          # @!attribute [rw] keyword
+          #   @return [Google::Ads::Googleads::V0::Common::KeywordInfo]
+          #     Keyword.
+          # @!attribute [rw] listing_group
+          #   @return [Google::Ads::Googleads::V0::Common::ListingGroupInfo]
+          #     Listing group.
+          class AdGroupCriterion
+            # A container for ad group criterion quality information.
+            # @!attribute [rw] quality_score
+            #   @return [Google::Protobuf::Int32Value]
+            #     The quality score.
+            #
+            #     This field may not be populated if Google does not have enough
+            #     information to determine a value.
+            # @!attribute [rw] creative_quality_score
+            #   @return [Google::Ads::Googleads::V0::Enums::QualityScoreBucketEnum::QualityScoreBucket]
+            #     The performance of the ad compared to other advertisers.
+            # @!attribute [rw] post_click_quality_score
+            #   @return [Google::Ads::Googleads::V0::Enums::QualityScoreBucketEnum::QualityScoreBucket]
+            #     The quality score of the landing page.
+            # @!attribute [rw] search_predicted_ctr
+            #   @return [Google::Ads::Googleads::V0::Enums::QualityScoreBucketEnum::QualityScoreBucket]
+            #     The click-through rate compared to that of other advertisers.
+            class QualityInfo; end
+
+            # Estimates for criterion bids at various positions.
+            # @!attribute [rw] first_page_cpc_micros
+            #   @return [Google::Protobuf::Int64Value]
+            #     The estimate of the CPC bid required for ad to be shown on first
+            #     page of search results.
+            # @!attribute [rw] first_position_cpc_micros
+            #   @return [Google::Protobuf::Int64Value]
+            #     The estimate of the CPC bid required for ad to be displayed in first
+            #     position, at the top of the first page of search results.
+            # @!attribute [rw] top_of_page_cpc_micros
+            #   @return [Google::Protobuf::Int64Value]
+            #     The estimate of the CPC bid required for ad to be displayed at the top
+            #     of the first page of search results.
+            class PositionEstimates; end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# 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 bidding strategy.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the bidding strategy.
+          #     Bidding strategy resource names have the form:
+          #
+          #     +customers/{customer_id}/biddingStrategies/{bidding_strategy_id}+
+          # @!attribute [rw] id
+          #   @return [Google::Protobuf::Int64Value]
+          #     The ID of the bidding strategy.
+          # @!attribute [rw] name
+          #   @return [Google::Protobuf::StringValue]
+          #     The name of the bidding strategy.
+          #     All bidding strategies within an account must be named distinctly.
+          #
+          #     The length of this string should be between 1 and 255, inclusive,
+          #     in UTF-8 bytes, (trimmed).
+          # @!attribute [rw] type
+          #   @return [Google::Ads::Googleads::V0::Enums::BiddingStrategyTypeEnum::BiddingStrategyType]
+          #     The type of the bidding strategy.
+          #     Create a bidding strategy by setting the bidding scheme.
+          #
+          #     This field is read-only.
+          # @!attribute [rw] enhanced_cpc
+          #   @return [Google::Ads::Googleads::V0::Common::EnhancedCpc]
+          #     A 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.
+          # @!attribute [rw] page_one_promoted
+          #   @return [Google::Ads::Googleads::V0::Common::PageOnePromoted]
+          #     A bidding strategy that sets max CPC bids to target impressions on
+          #     page one or page one promoted slots on google.com.
+          # @!attribute [rw] target_cpa
+          #   @return [Google::Ads::Googleads::V0::Common::TargetCpa]
+          #     A bidding strategy that sets bids to help get as many conversions as
+          #     possible at the target cost-per-acquisition (CPA) you set.
+          # @!attribute [rw] target_outrank_share
+          #   @return [Google::Ads::Googleads::V0::Common::TargetOutrankShare]
+          #     A bidding strategy that sets bids based on the target fraction of
+          #     auctions where the advertiser should outrank a specific competitor.
+          # @!attribute [rw] target_roas
+          #   @return [Google::Ads::Googleads::V0::Common::TargetRoas]
+          #     A bidding strategy that helps you maximize revenue while averaging a
+          #     specific target Return On Ad Spend (ROAS).
+          # @!attribute [rw] target_spend
+          #   @return [Google::Ads::Googleads::V0::Common::TargetSpend]
+          #     A bid strategy that sets your bids to help get as many clicks as
+          #     possible within your budget.
+          class BiddingStrategy; end
+        end
+      end
+    end
+  end
+end