google-ads-googleads 0.3.0 → 0.4.0

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

@@ -0,0 +1,225 @@
+# 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 keyword criterion.
+          # @!attribute [rw] text
+          #   @return [Google::Protobuf::StringValue]
+          #     The text of the keyword (at most 80 characters and 10 words).
+          # @!attribute [rw] match_type
+          #   @return [Google::Ads::Googleads::V0::Enums::KeywordMatchTypeEnum::KeywordMatchType]
+          #     The match type of the keyword.
+          class KeywordInfo; end
+
+          # A location criterion.
+          # @!attribute [rw] geo_target_constant
+          #   @return [Google::Protobuf::StringValue]
+          #     The geo target constant resource name.
+          class LocationInfo; end
+
+          # A device criterion.
+          # @!attribute [rw] type
+          #   @return [Google::Ads::Googleads::V0::Enums::DeviceEnum::Device]
+          #     Type of the device.
+          class DeviceInfo; end
+
+          # A listing group criterion.
+          # @!attribute [rw] type
+          #   @return [Google::Ads::Googleads::V0::Enums::ListingGroupTypeEnum::ListingGroupType]
+          #     Type of the listing group.
+          # @!attribute [rw] case_value
+          #   @return [Google::Ads::Googleads::V0::Common::ListingDimensionInfo]
+          #     Dimension value with which this listing group is refining its parent.
+          #     Undefined for the root group.
+          # @!attribute [rw] parent_ad_group_criterion
+          #   @return [Google::Protobuf::StringValue]
+          #     Resource name of ad group criterion which is the parent listing group
+          #     subdivision. Null for the root group.
+          class ListingGroupInfo; end
+
+          # Listing dimensions for listing group criterion.
+          # @!attribute [rw] listing_brand
+          #   @return [Google::Ads::Googleads::V0::Common::ListingBrandInfo]
+          #     Brand of the listing.
+          # @!attribute [rw] hotel_id
+          #   @return [Google::Ads::Googleads::V0::Common::HotelIdInfo]
+          #     Advertiser-specific hotel ID.
+          # @!attribute [rw] hotel_class
+          #   @return [Google::Ads::Googleads::V0::Common::HotelClassInfo]
+          #     Class of the hotel as a number of stars 1 to 5.
+          # @!attribute [rw] hotel_country_region
+          #   @return [Google::Ads::Googleads::V0::Common::HotelCountryRegionInfo]
+          #     Country or Region the hotel is located in.
+          # @!attribute [rw] hotel_state
+          #   @return [Google::Ads::Googleads::V0::Common::HotelStateInfo]
+          #     State the hotel is located in.
+          # @!attribute [rw] hotel_city
+          #   @return [Google::Ads::Googleads::V0::Common::HotelCityInfo]
+          #     City the hotel is located in.
+          # @!attribute [rw] listing_custom_attribute
+          #   @return [Google::Ads::Googleads::V0::Common::ListingCustomAttributeInfo]
+          #     Listing custom attribute.
+          # @!attribute [rw] product_condition
+          #   @return [Google::Ads::Googleads::V0::Common::ProductConditionInfo]
+          #     Condition of a product offer.
+          # @!attribute [rw] product_type
+          #   @return [Google::Ads::Googleads::V0::Common::ProductTypeInfo]
+          #     Type of a product offer.
+          class ListingDimensionInfo; end
+
+          # Brand of the listing.
+          # @!attribute [rw] value
+          #   @return [Google::Protobuf::StringValue]
+          #     String value of the listing brand.
+          class ListingBrandInfo; end
+
+          # Advertiser-specific hotel ID.
+          # @!attribute [rw] value
+          #   @return [Google::Protobuf::StringValue]
+          #     String value of the hotel ID.
+          class HotelIdInfo; end
+
+          # Class of the hotel as a number of stars 1 to 5.
+          # @!attribute [rw] value
+          #   @return [Google::Protobuf::Int64Value]
+          #     Long value of the hotel class.
+          class HotelClassInfo; end
+
+          # Country or Region the hotel is located in.
+          # @!attribute [rw] country_region_criterion
+          #   @return [Google::Protobuf::StringValue]
+          #     The Geo Target Constant resource name.
+          class HotelCountryRegionInfo; end
+
+          # State the hotel is located in.
+          # @!attribute [rw] state_criterion
+          #   @return [Google::Protobuf::StringValue]
+          #     The Geo Target Constant resource name.
+          class HotelStateInfo; end
+
+          # City the hotel is located in.
+          # @!attribute [rw] city_criterion
+          #   @return [Google::Protobuf::StringValue]
+          #     The Geo Target Constant resource name.
+          class HotelCityInfo; end
+
+          # Listing custom attribute.
+          # @!attribute [rw] value
+          #   @return [Google::Protobuf::StringValue]
+          #     String value of the listing custom attribute.
+          # @!attribute [rw] index
+          #   @return [Google::Ads::Googleads::V0::Enums::ListingCustomAttributeIndexEnum::ListingCustomAttributeIndex]
+          #     Indicates the index of the custom attribute.
+          class ListingCustomAttributeInfo; end
+
+          # Condition of a product offer.
+          # @!attribute [rw] condition
+          #   @return [Google::Ads::Googleads::V0::Enums::ProductConditionEnum::ProductCondition]
+          #     Value of the condition.
+          class ProductConditionInfo; end
+
+          # Type of a product offer.
+          # @!attribute [rw] value
+          #   @return [Google::Protobuf::StringValue]
+          #     Value of the type.
+          # @!attribute [rw] level
+          #   @return [Google::Ads::Googleads::V0::Enums::ProductTypeLevelEnum::ProductTypeLevel]
+          #     Level of the type.
+          class ProductTypeInfo; end
+
+          # Criterion for hotel date selection (default dates vs. user selected).
+          # @!attribute [rw] type
+          #   @return [Google::Ads::Googleads::V0::Enums::HotelDateSelectionTypeEnum::HotelDateSelectionType]
+          #     Type of the hotel date selection
+          class HotelDateSelectionTypeInfo; end
+
+          # Criterion for number of days prior to the stay the booking is being made.
+          # @!attribute [rw] min_days
+          #   @return [Google::Protobuf::Int64Value]
+          #     Low end of the number of days prior to the stay.
+          # @!attribute [rw] max_days
+          #   @return [Google::Protobuf::Int64Value]
+          #     High end of the number of days prior to the stay.
+          class HotelAdvanceBookingWindowInfo; end
+
+          # Criterion for length of hotel stay in nights.
+          # @!attribute [rw] min_nights
+          #   @return [Google::Protobuf::Int64Value]
+          #     Low end of the number of nights in the stay.
+          # @!attribute [rw] max_nights
+          #   @return [Google::Protobuf::Int64Value]
+          #     High end of the number of nights in the stay.
+          class HotelLengthOfStayInfo; end
+
+          # Criterion for day of the week the booking is for.
+          # @!attribute [rw] day_of_week
+          #   @return [Google::Ads::Googleads::V0::Enums::DayOfWeekEnum::DayOfWeek]
+          #     The day of the week.
+          class HotelCheckInDayInfo; end
+
+          # Criterion for Interaction Type.
+          # @!attribute [rw] type
+          #   @return [Google::Ads::Googleads::V0::Enums::InteractionTypeEnum::InteractionType]
+          #     The interaction type.
+          class InteractionTypeInfo; end
+
+          # Represents an AdSchedule criterion.
+          #
+          # AdSchedule is specified as the day of the week and a time interval
+          # within which ads will be shown.
+          #
+          # No more than six AdSchedules can be added for the same day.
+          # @!attribute [rw] start_minute
+          #   @return [Google::Ads::Googleads::V0::Enums::MinuteOfHourEnum::MinuteOfHour]
+          #     Minutes after the start hour at which this schedule starts.
+          #
+          #     This field is required for CREATE operations and is prohibited on UPDATE
+          #     operations.
+          # @!attribute [rw] end_minute
+          #   @return [Google::Ads::Googleads::V0::Enums::MinuteOfHourEnum::MinuteOfHour]
+          #     Minutes after the end hour at which this schedule ends. The schedule is
+          #     exclusive of the end minute.
+          #
+          #     This field is required for CREATE operations and is prohibited on UPDATE
+          #     operations.
+          # @!attribute [rw] start_hour
+          #   @return [Google::Protobuf::Int32Value]
+          #     Starting hour in 24 hour time.
+          #     This field must be between 0 and 23, inclusive.
+          #
+          #     This field is required for CREATE operations and is prohibited on UPDATE
+          #     operations.
+          # @!attribute [rw] end_hour
+          #   @return [Google::Protobuf::Int32Value]
+          #     Ending hour in 24 hour time; 24 signifies end of the day.
+          #     This field must be between 0 and 24, inclusive.
+          #
+          #     This field is required for CREATE operations and is prohibited on UPDATE
+          #     operations.
+          # @!attribute [rw] day_of_week
+          #   @return [Google::Ads::Googleads::V0::Enums::DayOfWeekEnum::DayOfWeek]
+          #     Day of the week the schedule applies to.
+          #
+          #     This field is required for CREATE operations and is prohibited on UPDATE
+          #     operations.
+          class AdScheduleInfo; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# 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 mapping that can be used by custom parameter tags in a
+          # +tracking_url_template+, +final_urls+, or +mobile_final_urls+.
+          # @!attribute [rw] key
+          #   @return [Google::Protobuf::StringValue]
+          #     The key matching the parameter tag name.
+          # @!attribute [rw] value
+          #   @return [Google::Protobuf::StringValue]
+          #     The value to be substituted.
+          class CustomParameter; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,208 @@
+# 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
+          # Metrics data.
+          # @!attribute [rw] all_conversions_from_interactions_rate
+          #   @return [Google::Protobuf::DoubleValue]
+          #     All conversions from interactions (as oppose to view through conversions)
+          #     divided by the number of ad interactions.
+          # @!attribute [rw] all_conversions_value
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The total value of all conversions.
+          # @!attribute [rw] all_conversions
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The total number of conversions. This includes "Conversions" plus
+          #     conversions that have their "Include in Conversions" setting unchecked.
+          # @!attribute [rw] all_conversions_value_per_cost
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The value of all conversions divided by the total cost of ad interactions
+          #     (such as clicks for text ads or views for video ads).
+          # @!attribute [rw] all_conversions_from_interactions_value_per_interaction
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The value of all conversions from interactions divided by the total number
+          #     of interactions.
+          # @!attribute [rw] average_cost
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The average amount you pay per interaction. This amount is the total cost
+          #     of your ads divided by the total number of interactions.
+          # @!attribute [rw] average_cpc
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The total cost of all clicks divided by the total number of clicks
+          #     received.
+          # @!attribute [rw] average_cpm
+          #   @return [Google::Protobuf::DoubleValue]
+          #     Average cost-per-thousand impressions (CPM).
+          # @!attribute [rw] average_position
+          #   @return [Google::Protobuf::DoubleValue]
+          #     Your ad's position relative to those of other advertisers.
+          # @!attribute [rw] bounce_rate
+          #   @return [Google::Protobuf::DoubleValue]
+          #     Percentage of clicks where the user only visited a single page on your
+          #     site. Imported from Google Analytics.
+          # @!attribute [rw] clicks
+          #   @return [Google::Protobuf::Int64Value]
+          #     The number of clicks.
+          # @!attribute [rw] content_budget_lost_impression_share
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The estimated percent of times that your ad was eligible to show
+          #     on the Display Network but didn't because your budget was too low.
+          #     Note: Content budget lost impression share is reported in the range of 0
+          #     to 0.9. Any value above 0.9 is reported as 0.9001.
+          # @!attribute [rw] content_impression_share
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The impressions you've received on the Display Network divided
+          #     by the estimated number of impressions you were eligible to receive.
+          #     Note: Content impression share is reported in the range of 0.1 to 1. Any
+          #     value below 0.1 is reported as 0.0999.
+          # @!attribute [rw] content_rank_lost_impression_share
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The estimated percentage of impressions on the Display Network
+          #     that your ads didn't receive due to poor Ad Rank.
+          #     Note: Content rank lost impression share is reported in the range of 0
+          #     to 0.9. Any value above 0.9 is reported as 0.9001.
+          # @!attribute [rw] conversions_from_interactions_rate
+          #   @return [Google::Protobuf::DoubleValue]
+          #     Conversions from interactions divided by the number of ad interactions
+          #     (such as clicks for text ads or views for video ads).
+          # @!attribute [rw] conversions_value
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The total value of conversions.
+          # @!attribute [rw] conversions_value_per_cost
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The value of conversions divided by the cost of ad interactions.
+          # @!attribute [rw] conversions_from_interactions_value_per_interaction
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The value of conversions from interactions divided by the number of ad
+          #     interactions.
+          # @!attribute [rw] conversions
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The number of conversions. This only includes conversion actions which have
+          #     "Include in Conversions" checked.
+          # @!attribute [rw] cost_micros
+          #   @return [Google::Protobuf::Int64Value]
+          #     The sum of your cost-per-click (CPC) and cost-per-thousand impressions
+          #     (CPM) costs during this period.
+          # @!attribute [rw] cost_per_all_conversions
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The cost of ad interactions divided by all conversions.
+          # @!attribute [rw] cost_per_conversion
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The cost of ad interactions divided by conversions.
+          # @!attribute [rw] cross_device_conversions
+          #   @return [Google::Protobuf::DoubleValue]
+          #     Conversions from when a customer clicks on a Google Ads ad on one device,
+          #     then converts on a different device or browser.
+          #     Cross-device conversions are already included in all_conversions.
+          # @!attribute [rw] ctr
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The number of clicks your ad receives (Clicks) divided by the number
+          #     of times your ad is shown (Impressions).
+          # @!attribute [rw] engagement_rate
+          #   @return [Google::Protobuf::DoubleValue]
+          #     How often people engage with your ad after it's shown to them. This is the
+          #     number of ad expansions divided by the number of times your ad is shown.
+          # @!attribute [rw] engagements
+          #   @return [Google::Protobuf::Int64Value]
+          #     The number of engagements.
+          #     An engagement occurs when a viewer expands your Lightbox ad. Also, in the
+          #     future, other ad types may support engagement metrics.
+          # @!attribute [rw] impressions
+          #   @return [Google::Protobuf::Int64Value]
+          #     Count of how often your ad has appeared on a search results page or
+          #     website on the Google Network.
+          # @!attribute [rw] interaction_rate
+          #   @return [Google::Protobuf::DoubleValue]
+          #     How often people interact with your ad after it is shown to them.
+          #     This is the number of interactions divided by the number of times your ad
+          #     is shown.
+          # @!attribute [rw] interactions
+          #   @return [Google::Protobuf::Int64Value]
+          #     The number of interactions.
+          #     An interaction is the main user action associated with an ad format-clicks
+          #     for text and shopping ads, views for video ads, and so on.
+          # @!attribute [rw] invalid_click_rate
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The percentage of clicks filtered out of your total number of clicks
+          #     (filtered + non-filtered clicks) during the reporting period.
+          # @!attribute [rw] invalid_clicks
+          #   @return [Google::Protobuf::Int64Value]
+          #     Number of clicks Google considers illegitimate and doesn't charge you for.
+          # @!attribute [rw] percent_new_visitors
+          #   @return [Google::Protobuf::DoubleValue]
+          #     Percentage of first-time sessions (from people who had never visited your
+          #     site before). Imported from Google Analytics.
+          # @!attribute [rw] phone_calls
+          #   @return [Google::Protobuf::Int64Value]
+          #     Number of offline phone calls.
+          # @!attribute [rw] phone_impressions
+          #   @return [Google::Protobuf::Int64Value]
+          #     Number of offline phone impressions.
+          # @!attribute [rw] phone_through_rate
+          #   @return [Google::Protobuf::DoubleValue]
+          #     Number of phone calls received (phone_calls) divided by the number of
+          #     times your phone number is shown (phone_impressions).
+          # @!attribute [rw] relative_ctr
+          #   @return [Google::Protobuf::DoubleValue]
+          #     Your clickthrough rate (Ctr) divided by the average clickthrough rate of
+          #     all advertisers on the websites that show your ads. Measures how your ads
+          #     perform on Display Network sites compared to other ads on the same sites.
+          # @!attribute [rw] search_budget_lost_impression_share
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The estimated percent of times that your ad was eligible to show on the
+          #     Search Network but didn't because your budget was too low. Note: Search
+          #     budget lost impression share is reported in the range of 0 to 0.9. Any
+          #     value above 0.9 is reported as 0.9001.
+          # @!attribute [rw] search_exact_match_impression_share
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The impressions you've received divided by the estimated number of
+          #     impressions you were eligible to receive on the Search Network for search
+          #     terms that matched your keywords exactly (or were close variants of your
+          #     keyword), regardless of your keyword match types. Note: Search exact match
+          #     impression share is reported in the range of 0.1 to 1. Any value below 0.1
+          #     is reported as 0.0999.
+          # @!attribute [rw] search_impression_share
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The impressions you've received on the Search Network divided
+          #     by the estimated number of impressions you were eligible to receive.
+          #     Note: Search impression share is reported in the range of 0.1 to 1. Any
+          #     value below 0.1 is reported as 0.0999.
+          # @!attribute [rw] search_rank_lost_impression_share
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The estimated percentage of impressions on the Search Network
+          #     that your ads didn't receive due to poor Ad Rank.
+          #     Note: Search rank lost impression share is reported in the range of 0 to
+          #     0.9. Any value above 0.9 is reported as 0.9001.
+          # @!attribute [rw] value_per_all_conversions
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The value of all conversions divided by the number of all conversions.
+          # @!attribute [rw] value_per_conversion
+          #   @return [Google::Protobuf::DoubleValue]
+          #     The value of conversions divided by the number of conversions.
+          # @!attribute [rw] view_through_conversions
+          #   @return [Google::Protobuf::Int64Value]
+          #     The total number of view-through conversions.
+          #     These happen when a customer sees an image or rich media ad, then later
+          #     completes a conversion on your site without interacting with (e.g.,
+          #     clicking on) another ad.
+          class Metrics; end
+        end
+      end
+    end
+  end
+end