Firebase Update

This commit is contained in:
Lukas Nowy
2018-12-22 23:30:39 +01:00
parent befb44764d
commit acffe619b3
11523 changed files with 1614327 additions and 930246 deletions

View File

@ -0,0 +1,192 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the ad type.
syntax = "proto3";
package google.ads.googleads.v0.common;
import "google/ads/googleads/v0/common/custom_parameter.proto";
import "google/ads/googleads/v0/enums/ad_type.proto";
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.common";
option java_outer_classname = "AdProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Common";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Common";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Common";
// An ad.
message Ad {
// The ID of the ad.
google.protobuf.Int64Value id = 1;
// The list of possible final URLs after all cross-domain redirects for the
// ad.
repeated google.protobuf.StringValue final_urls = 2;
// The list of possible final mobile URLs after all cross-domain redirects
// for the ad.
repeated google.protobuf.StringValue final_mobile_urls = 16;
// The URL template for constructing a tracking URL.
google.protobuf.StringValue tracking_url_template = 12;
// The list of mappings that can be used to substitute custom parameter tags
// in a
// `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
repeated CustomParameter url_custom_parameters = 10;
// The URL that appears in the ad description for some ad formats.
google.protobuf.StringValue display_url = 4;
// The type of ad.
enums.AdTypeEnum.AdType type = 5;
// Details pertinent to the ad type. Exactly one value must be set.
oneof ad_data {
// Details pertaining to a text ad.
TextAdInfo text_ad = 6;
// Details pertaining to an expanded text ad.
ExpandedTextAdInfo expanded_text_ad = 7;
// Details pertaining to a Dynamic Search Ad.
DynamicSearchAdInfo dynamic_search_ad = 8;
// Details pertaining to a responsive display ad.
ResponsiveDisplayAdInfo responsive_display_ad = 9;
// Details pertaining to a call-only ad.
CallOnlyAdInfo call_only_ad = 13;
// 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.
ExpandedDynamicSearchAdInfo expanded_dynamic_search_ad = 14;
// Details pertaining to a hotel ad.
HotelAdInfo hotel_ad = 15;
}
}
// A text ad.
message TextAdInfo {
// The headline of the ad.
google.protobuf.StringValue headline = 1;
// The first line of the ad's description.
google.protobuf.StringValue description1 = 2;
// The second line of the ad's description.
google.protobuf.StringValue description2 = 3;
}
// An expanded text ad.
message ExpandedTextAdInfo {
// The first part of the ad's headline.
google.protobuf.StringValue headline_part1 = 1;
// The second part of the ad's headline.
google.protobuf.StringValue headline_part2 = 2;
// The description of the ad.
google.protobuf.StringValue description = 3;
// The text that can appear alongside the ad's displayed URL.
google.protobuf.StringValue path1 = 4;
// Additional text that can appear alongside the ad's displayed URL.
google.protobuf.StringValue path2 = 5;
}
// A dynamic search ad.
message DynamicSearchAdInfo {
// The first line of the ad's description.
google.protobuf.StringValue description1 = 1;
// The second line of the ad's description.
google.protobuf.StringValue description2 = 2;
}
// A responsive display ad.
message ResponsiveDisplayAdInfo {
// The short version of the ad's headline.
google.protobuf.StringValue short_headline = 1;
// The long version of the ad's headline.
google.protobuf.StringValue long_headline = 2;
// The description of the ad.
google.protobuf.StringValue description = 3;
// The business name in the ad.
google.protobuf.StringValue business_name = 4;
}
// A call-only ad.
message CallOnlyAdInfo {
// The country code in the ad.
google.protobuf.StringValue country_code = 1;
// The phone number in the ad.
google.protobuf.StringValue phone_number = 2;
// The business name in the ad.
google.protobuf.StringValue business_name = 3;
// The first line of the ad's description.
google.protobuf.StringValue description1 = 4;
// The second line of the ad's description.
google.protobuf.StringValue description2 = 5;
// Whether to enable call tracking for the creative. Enabling call
// tracking also enables call conversions.
google.protobuf.BoolValue call_tracked = 6;
// Whether to disable call conversion for the creative.
// If set to `true`, disables call conversions even when `call_tracked` is
// `true`.
// If `call_tracked` is `false`, this field is ignored.
google.protobuf.BoolValue disable_call_conversion = 7;
// The URL to be used for phone number verification.
google.protobuf.StringValue phone_number_verification_url = 8;
}
// An expanded dynamic search ad.
message ExpandedDynamicSearchAdInfo {
// The description of the ad.
google.protobuf.StringValue description = 1;
}
// A hotel ad.
message HotelAdInfo {
}

View File

@ -0,0 +1,197 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing bidding schemes.
syntax = "proto3";
package google.ads.googleads.v0.common;
import "google/ads/googleads/v0/enums/page_one_promoted_strategy_goal.proto";
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.common";
option java_outer_classname = "BiddingProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Common";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Common";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Common";
// An automated bidding strategy that raises bids for clicks
// that seem more likely to lead to a conversion and lowers
// them for clicks where they seem less likely.
message EnhancedCpc {
}
// Manual click-based bidding where user pays per click.
message ManualCpc {
// Whether bids are to be enhanced based on conversion optimizer data.
google.protobuf.BoolValue enhanced_cpc_enabled = 1;
}
// Manual impression-based bidding where user pays per thousand impressions.
message ManualCpm {
}
// An automated bidding strategy that sets bids to help get the most conversions
// for your campaign while spending your budget.
message MaximizeConversions {
}
// An automated bidding strategy which tries to maximize conversion value
// given a daily budget.
message MaximizeConversionValue {
// The target return on ad spend (ROAS) option. If set, the bid strategy will
// maximize revenue while averaging the target return on ad spend. If the
// target ROAS is high, the bid strategy may not be able to spend the full
// budget. If the target ROAS is not set, the bid strategy will aim to
// achieve the highest possible ROAS for the budget.
google.protobuf.DoubleValue target_roas = 1;
}
// An automated bidding strategy which sets CPC bids to target impressions on
// page one, or page one promoted slots on google.com.
message PageOnePromoted {
// The strategy goal of where impressions are desired to be shown on
// search result pages.
enums.PageOnePromotedStrategyGoalEnum.PageOnePromotedStrategyGoal
strategy_goal = 1;
// Maximum bid limit that can be set by the bid strategy.
// The limit applies to all keywords managed by the strategy.
google.protobuf.Int64Value cpc_bid_ceiling_micros = 2;
// Bid multiplier to be applied to the relevant bid estimate (depending on
// the `strategy_goal`) in determining a keyword's new CPC bid.
google.protobuf.DoubleValue bid_modifier = 3;
// Whether the strategy should always follow bid estimate changes, or only
// increase.
// If false, always sets a keyword's new bid to the current bid estimate.
// If true, only updates a keyword's bid if the current bid estimate is
// greater than the current bid.
google.protobuf.BoolValue only_raise_cpc_bids = 4;
// Whether the strategy is allowed to raise bids when the throttling
// rate of the budget it is serving out of rises above a threshold.
google.protobuf.BoolValue raise_cpc_bid_when_budget_constrained = 5;
// Whether the strategy is allowed to raise bids on keywords with
// lower-range quality scores.
google.protobuf.BoolValue raise_cpc_bid_when_quality_score_is_low = 6;
}
// An automated bid strategy that sets bids to help get as many conversions as
// possible at the target cost-per-acquisition (CPA) you set.
message TargetCpa {
// Average CPA target.
// This target should be greater than or equal to minimum billable unit based
// on the currency for the account.
google.protobuf.Int64Value target_cpa_micros = 1;
// Maximum bid limit that can be set by the bid strategy.
// The limit applies to all keywords managed by the strategy.
google.protobuf.Int64Value cpc_bid_ceiling_micros = 2;
// Minimum bid limit that can be set by the bid strategy.
// The limit applies to all keywords managed by the strategy.
google.protobuf.Int64Value cpc_bid_floor_micros = 3;
}
// An automated bidding strategy that sets bids based on the target fraction of
// auctions where the advertiser should outrank a specific competitor.
message TargetOutrankShare {
// The target fraction of auctions where the advertiser should outrank the
// competitor.
// The advertiser outranks the competitor in an auction if either the
// advertiser appears above the competitor in the search results, or appears
// in the search results when the competitor does not.
// Value must be between 1 and 1000000, inclusive.
google.protobuf.Int32Value target_outrank_share_micros = 1;
// Competitor's visible domain URL.
google.protobuf.StringValue competitor_domain = 2;
// Maximum bid limit that can be set by the bid strategy.
// The limit applies to all keywords managed by the strategy.
google.protobuf.Int64Value cpc_bid_ceiling_micros = 3;
// Whether the strategy should always follow bid estimate changes,
// or only increase.
// If false, always set a keyword's new bid to the current bid estimate.
// If true, only updates a keyword's bid if the current bid estimate is
// greater than the current bid.
google.protobuf.BoolValue only_raise_cpc_bids = 4;
// Whether the strategy is allowed to raise bids on keywords with
// lower-range quality scores.
google.protobuf.BoolValue raise_cpc_bid_when_quality_score_is_low = 5;
}
// An automated bidding strategy that helps you maximize revenue while
// averaging a specific target return on ad spend (ROAS).
message TargetRoas {
// Required. The desired revenue (based on conversion data) per unit of spend.
// Value must be between 0.01 and 1000.0, inclusive.
google.protobuf.DoubleValue target_roas = 1;
// Maximum bid limit that can be set by the bid strategy.
// The limit applies to all keywords managed by the strategy.
google.protobuf.Int64Value cpc_bid_ceiling_micros = 2;
// Minimum bid limit that can be set by the bid strategy.
// The limit applies to all keywords managed by the strategy.
google.protobuf.Int64Value cpc_bid_floor_micros = 3;
}
// An automated bid strategy that sets your bids to help get as many clicks
// as possible within your budget.
message TargetSpend {
// The spend target under which to maximize clicks.
// A TargetSpend bidder will attempt to spend the smaller of this value
// or the natural throttling spend amount.
// If not specified, the budget is used as the spend target.
google.protobuf.Int64Value target_spend_micros = 1;
// Maximum bid limit that can be set by the bid strategy.
// The limit applies to all keywords managed by the strategy.
google.protobuf.Int64Value cpc_bid_ceiling_micros = 2;
}
// A bidding strategy where bids are a fraction of the advertised price for
// some good or service.
message PercentCpc {
// Maximum bid limit that can be set by the bid strategy. This is
// an optional field entered by the advertiser and specified in local micros.
// Note: A zero value is interpreted in the same way as having bid_ceiling
// undefined.
google.protobuf.Int64Value cpc_bid_ceiling_micros = 1;
// Adjusts the bid for each auction upward or downward, depending on the
// likelihood of a conversion. Individual bids may exceed
// cpc_bid_ceiling_micros, but the average bid amount for a campaign should
// not.
google.protobuf.BoolValue enhanced_cpc_enabled = 2;
}

View File

@ -0,0 +1,175 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing criteria types.
syntax = "proto3";
package google.ads.googleads.v0.common;
import "google/ads/googleads/v0/enums/keyword_match_type.proto";
import "google/ads/googleads/v0/enums/listing_custom_attribute_index.proto";
import "google/ads/googleads/v0/enums/listing_group_type.proto";
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.common";
option java_outer_classname = "CriteriaProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Common";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Common";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Common";
// A keyword criterion.
message KeywordInfo {
// The text of the keyword (at most 80 characters and 10 words).
google.protobuf.StringValue text = 1;
// The match type of the keyword.
enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 2;
}
// A location criterion.
message LocationInfo {
}
// A platform criterion.
message PlatformInfo {
}
// A listing group criterion.
message ListingGroupInfo {
// Type of the listing group.
enums.ListingGroupTypeEnum.ListingGroupType type = 1;
// Dimension value with which this listing group is refining its parent.
// Undefined for the root group.
ListingDimensionInfo case_value = 2;
// ID of the parent listing group subdivision. Undefined for the root group.
google.protobuf.Int64Value parent_criterion_id = 3;
}
// Listing dimensions for listing group criterion.
message ListingDimensionInfo {
// Dimension of one of the types below is always present.
oneof dimension {
// Brand of the listing.
ListingBrandInfo listing_brand = 1;
// Advertiser-specific hotel ID.
HotelIdInfo hotel_id = 2;
// Class of the hotel as a number of stars 1 to 5.
HotelClassInfo hotel_class = 3;
// Country or Region the hotel is located in.
HotelCountryRegionInfo hotel_country_region = 4;
// State the hotel is located in.
HotelStateInfo hotel_state = 5;
// City the hotel is located in.
HotelCityInfo hotel_city = 6;
// Listing custom attribute.
ListingCustomAttributeInfo listing_custom_attribute = 7;
}
}
// Brand of the listing.
message ListingBrandInfo {
// String value of the listing brand.
google.protobuf.StringValue value = 1;
}
// Advertiser-specific hotel ID.
message HotelIdInfo {
// String value of the hotel ID.
google.protobuf.StringValue value = 1;
}
// Class of the hotel as a number of stars 1 to 5.
message HotelClassInfo {
// Long value of the hotel class.
google.protobuf.Int64Value value = 1;
}
// Country or Region the hotel is located in.
message HotelCountryRegionInfo {
// The Geo Target Constant resource name.
google.protobuf.StringValue country_region_criterion = 1;
}
// State the hotel is located in.
message HotelStateInfo {
// The Geo Target Constant resource name.
google.protobuf.StringValue state_criterion = 1;
}
// City the hotel is located in.
message HotelCityInfo {
// The Geo Target Constant resource name.
google.protobuf.StringValue city_criterion = 1;
}
// Listing custom attribute.
message ListingCustomAttributeInfo {
// String value of the listing custom attribute.
google.protobuf.StringValue value = 1;
// Indicates the index of the custom attribute.
enums.ListingCustomAttributeIndexEnum.ListingCustomAttributeIndex index = 2;
}
// Criterion for hotel date selection (default dates vs. user selected).
message HotelDateSelectionTypeInfo {
}
// Criterion for number of days prior to the stay the booking is being made.
message HotelAdvanceBookingWindowInfo {
// Low end of the number of days prior to the stay.
google.protobuf.Int64Value min_days = 1;
// High end of the number of days prior to the stay.
google.protobuf.Int64Value max_days = 2;
}
// Criterion for length of hotel stay in nights.
message HotelLengthOfStayInfo {
// Low end of the number of nights in the stay.
google.protobuf.Int64Value min_nights = 1;
// High end of the number of nights in the stay.
google.protobuf.Int64Value max_nights = 2;
}
// Criterion for day of the week the booking is for.
message HotelCheckInDayInfo {
}

View File

@ -0,0 +1,42 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing CustomParameter and operation
syntax = "proto3";
package google.ads.googleads.v0.common;
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.common";
option java_outer_classname = "CustomParameterProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Common";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Common";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Common";
// A mapping that can be used by custom parameter tags in a
// `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
message CustomParameter {
// The key matching the parameter tag name.
google.protobuf.StringValue key = 1;
// The value to be substituted.
google.protobuf.StringValue value = 2;
}

View File

@ -0,0 +1,214 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing metrics.
syntax = "proto3";
package google.ads.googleads.v0.common;
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.common";
option java_outer_classname = "MetricsProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Common";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Common";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Common";
// Metrics data.
message Metrics {
// All conversions divided by the number of ad interactions.
google.protobuf.DoubleValue all_conversion_rate = 5;
// The total value of all conversions.
google.protobuf.DoubleValue all_conversion_value = 6;
// The total number of conversions. This includes "Conversions" plus
// conversions that have their "Include in Conversions" setting unchecked.
google.protobuf.DoubleValue all_conversions = 7;
// The value of all conversions divided by the total cost of ad interactions
// (such as clicks for text ads or views for video ads).
google.protobuf.DoubleValue all_conversions_value_per_cost = 62;
// The value of all conversions divided by the total number of interactions.
google.protobuf.DoubleValue all_conversions_value_per_interaction = 61;
// The average amount you pay per interaction. This amount is the total cost
// of your ads divided by the total number of interactions.
google.protobuf.DoubleValue average_cost = 8;
// The total cost of all clicks divided by the total number of clicks
// received.
google.protobuf.DoubleValue average_cpc = 9;
// Average cost-per-thousand impressions (CPM).
google.protobuf.DoubleValue average_cpm = 10;
// Your ad's position relative to those of other advertisers.
google.protobuf.DoubleValue average_position = 13;
// Percentage of clicks where the user only visited a single page on your
// site. Imported from Google Analytics.
google.protobuf.DoubleValue bounce_rate = 15;
// The number of clicks.
google.protobuf.Int64Value clicks = 19;
// 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.
google.protobuf.DoubleValue content_budget_lost_impression_share = 20;
// 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.
google.protobuf.DoubleValue content_impression_share = 21;
// 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.
google.protobuf.DoubleValue content_rank_lost_impression_share = 22;
// Conversions divided by the number of ad interactions (such as clicks for
// text ads or views for video ads).
google.protobuf.DoubleValue conversion_rate = 23;
// The total value of conversions.
google.protobuf.DoubleValue conversion_value = 24;
// The value of conversions divided by the cost of ad interactions.
google.protobuf.DoubleValue conversion_value_per_cost = 64;
// The value of conversions divided by the number of ad interactions.
google.protobuf.DoubleValue conversion_value_per_interaction = 63;
// The number of conversions. This only includes conversion actions which have
// "Include in Conversions" checked.
google.protobuf.DoubleValue conversions = 25;
// The sum of your cost-per-click (CPC) and cost-per-thousand impressions
// (CPM) costs during this period.
google.protobuf.Int64Value cost_micros = 26;
// The cost of ad interactions divided by all conversions.
google.protobuf.DoubleValue cost_per_all_conversion = 27;
// The cost of ad interactions divided by conversions.
google.protobuf.DoubleValue cost_per_conversion = 28;
// Conversions from when a customer clicks on an AdWords ad on one device,
// then converts on a different device or browser.
// Cross-device conversions are already included in all_conversions.
google.protobuf.DoubleValue cross_device_conversions = 29;
// The number of clicks your ad receives (Clicks) divided by the number
// of times your ad is shown (Impressions).
google.protobuf.DoubleValue ctr = 30;
// 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.
google.protobuf.DoubleValue engagement_rate = 31;
// 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.
google.protobuf.Int64Value engagements = 32;
// Count of how often your ad has appeared on a search results page or
// website on the Google Network.
google.protobuf.Int64Value impressions = 37;
// 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.
google.protobuf.DoubleValue interaction_rate = 38;
// 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.
google.protobuf.Int64Value interactions = 39;
// The percentage of clicks filtered out of your total number of clicks
// (filtered + non-filtered clicks) during the reporting period.
google.protobuf.DoubleValue invalid_click_rate = 40;
// Number of clicks Google considers illegitimate and doesn't charge you for.
google.protobuf.Int64Value invalid_clicks = 41;
// Percentage of first-time sessions (from people who had never visited your
// site before). Imported from Google Analytics.
google.protobuf.DoubleValue percent_new_visitors = 42;
// Number of offline phone calls.
google.protobuf.Int64Value phone_calls = 43;
// Number of offline phone impressions.
google.protobuf.Int64Value phone_impressions = 44;
// Number of phone calls received (phone_calls) divided by the number of
// times your phone number is shown (phone_impressions).
google.protobuf.DoubleValue phone_through_rate = 45;
// 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.
google.protobuf.DoubleValue relative_ctr = 46;
// 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.
google.protobuf.DoubleValue search_budget_lost_impression_share = 47;
// 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.
google.protobuf.DoubleValue search_exact_match_impression_share = 49;
// 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.
google.protobuf.DoubleValue search_impression_share = 50;
// 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.
google.protobuf.DoubleValue search_rank_lost_impression_share = 51;
// The value of all conversions divided by the number of all conversions.
google.protobuf.DoubleValue value_per_all_conversions = 52;
// The value of conversions divided by the number of conversions.
google.protobuf.DoubleValue value_per_conversion = 53;
// 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.
google.protobuf.Int64Value view_through_conversions = 60;
}

View File

@ -0,0 +1,46 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing policy violation key.
syntax = "proto3";
package google.ads.googleads.v0.common;
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.common";
option java_outer_classname = "PolicyProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Common";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Common";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Common";
// Key of the violation. The key is used for referring to a violation
// when filing an exemption request.
message PolicyViolationKey {
// Unique ID of the violated policy.
google.protobuf.StringValue policy_name = 1;
// The text that violates the policy if specified.
// Otherwise, refers to the policy in general
// (e.g., when requesting to be exempt from the whole policy).
// If not specified for criterion exemptions, the whole policy is implied.
// Must be specified for ad exemptions.
google.protobuf.StringValue violating_text = 2;
}

View File

@ -0,0 +1,52 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing value types
syntax = "proto3";
package google.ads.googleads.v0.common;
option java_package = "com.google.ads.googleads.v0.common";
option java_outer_classname = "ValueProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Common";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Common";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Common";
// A generic data container.
message Value {
// A value.
oneof value {
// A boolean.
bool boolean_value = 1;
// An int64.
int64 int64_value = 2;
// A float.
float float_value = 3;
// A double.
double double_value = 4;
// A string.
string string_value = 5;
}
}

View File

@ -0,0 +1,49 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing ad group status.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "AdGroupAdStatusProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enum describing possible statuses of an AdGroupAd.
message AdGroupAdStatusEnum {
// The possible statuses of an AdGroupAd.
enum AdGroupAdStatus {
// No value has been specified.
UNSPECIFIED = 0;
// The received value is not known in this version.
//
// This is a response-only value.
UNKNOWN = 1;
// The ad group ad is enabled.
ENABLED = 2;
// The ad group ad is paused.
PAUSED = 3;
// The ad group ad is removed.
REMOVED = 4;
}
}

View File

@ -0,0 +1,49 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing AdGroupCriterion statuses.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "AdGroupCriterionStatusProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Message describing AdGroupCriterion statuses.
message AdGroupCriterionStatusEnum {
// The possible statuses of an AdGroupCriterion.
enum AdGroupCriterionStatus {
// No value has been specified.
UNSPECIFIED = 0;
// The received value is not known in this version.
//
// This is a response-only value.
UNKNOWN = 1;
// The ad group criterion is enabled.
ENABLED = 2;
// The ad group criterion is paused.
PAUSED = 3;
// The ad group criterion is removed.
REMOVED = 4;
}
}

View File

@ -0,0 +1,49 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing ad group status.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "AdGroupStatusProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enum describing possible statuses of an ad group.
message AdGroupStatusEnum {
// The possible statuses of an ad group.
enum AdGroupStatus {
// The status has not been specified.
UNSPECIFIED = 0;
// The received value is not known in this version.
//
// This is a response-only value.
UNKNOWN = 1;
// The ad group is enabled.
ENABLED = 2;
// The ad group is paused.
PAUSED = 3;
// The ad group is removed.
REMOVED = 4;
}
}

View File

@ -0,0 +1,49 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing ad group types.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "AdGroupTypeProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Defines types of an ad group, specific to a particular campaign channel
// type. This type drives validations that restrict which entities can be
// added to the ad group.
message AdGroupTypeEnum {
// Enum listing the possible types of an ad group.
enum AdGroupType {
// The type has not been specified.
UNSPECIFIED = 0;
// The received value is not known in this version.
//
// This is a response-only value.
UNKNOWN = 1;
// The default ad group type for Search campaigns.
SEARCH_STANDARD = 2;
// The default ad group type for Hotel campaigns.
HOTEL_ADS = 6;
}
}

View File

@ -0,0 +1,51 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing ad network types.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "AdNetworkTypeProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enumeration of AdWords network types.
message AdNetworkTypeEnum {
// Enumerates AdWords network types.
enum AdNetworkType {
// Not specified.
UNSPECIFIED = 0;
// The value is unknown in this version.
UNKNOWN = 1;
// Google search.
SEARCH = 2;
// Search partners.
SEARCH_PARTNERS = 3;
// Display Network.
CONTENT = 4;
// YouTube Search.
YOUTUBE_SEARCH = 5;
// YouTube Videos
YOUTUBE_WATCH = 6;
}
}

View File

@ -0,0 +1,56 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing ad serving statuses.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "AdServingOptimizationStatusProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Possible ad serving statuses of a campaign.
message AdServingOptimizationStatusEnum {
// Enum describing possible serving statuses.
enum AdServingOptimizationStatus {
// No value has been specified.
UNSPECIFIED = 0;
// The received value is not known in this version.
//
// This is a response-only value.
UNKNOWN = 1;
// Ad serving is optimized based on CTR for the campaign.
OPTIMIZE = 2;
// Ad serving is optimized based on CTR * Conversion for the campaign. If
// the campaign is not in the conversion optimizer bidding strategy, it will
// default to OPTIMIZED.
CONVERSION_OPTIMIZE = 3;
// Ads are rotated evenly for 90 days, then optimized for clicks.
ROTATE = 4;
// Show lower performing ads more evenly with higher performing ads, and do
// not optimize.
ROTATE_INDEFINITELY = 5;
// Ad serving optimization status is not available.
UNAVAILABLE = 6;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the ad type.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "AdTypeProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enum describing possible types of an ad.
message AdTypeEnum {
// The possible types of an ad.
enum AdType {
// No value has been specified.
UNSPECIFIED = 0;
// The received value is not known in this version.
//
// This is a response-only value.
UNKNOWN = 1;
// The ad is a text ad.
TEXT_AD = 2;
// The ad is an expanded text ad.
EXPANDED_TEXT_AD = 3;
// The ad is a dynamic search ad.
DYNAMIC_SEARCH_AD = 4;
// The ad is a responsive display ad.
RESPONSIVE_DISPLAY_AD = 5;
// The ad is a call only ad.
CALL_ONLY_AD = 6;
// The ad is an expanded dynamic search ad.
EXPANDED_DYNAMIC_SEARCH_AD = 7;
// The ad is a hotel ad.
HOTEL_AD = 8;
}
}

View File

@ -0,0 +1,45 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing advertising channel subtypes.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "AdvertisingChannelSubTypeProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// An immutable specialization of an Advertising Channel.
message AdvertisingChannelSubTypeEnum {
// Enum describing the different channel subtypes.
enum AdvertisingChannelSubType {
// Not specified.
UNSPECIFIED = 0;
// Used as a return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Mobile app campaigns for Search.
SEARCH_MOBILE_APP = 2;
// AdWords express campaigns for search.
SEARCH_EXPRESS = 4;
}
}

View File

@ -0,0 +1,45 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing advertising channel types
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "AdvertisingChannelTypeProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// The channel type a campaign may target to serve on.
message AdvertisingChannelTypeEnum {
// Enum describing the various advertising channel types.
enum AdvertisingChannelType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Search Network. Includes display bundled, and Search+ campaigns.
SEARCH = 2;
// Hotel Ads campaigns.
HOTEL = 5;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing bidding schemes.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "BiddingSourceProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enum describing possible bidding sources.
message BiddingSourceEnum {
// Enum describing possible bidding sources.
enum BiddingSource {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Bidding entity is defined on the ad group.
ADGROUP = 2;
// Bidding entity is defined on the ad group criterion.
CRITERION = 3;
// Effective bidding entity is inherited from campaign bidding strategy.
CAMPAIGN_BIDDING_STRATEGY = 5;
}
}

View File

@ -0,0 +1,77 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing bidding schemes.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "BiddingStrategyTypeProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enum describing possible bidding strategy types.
message BiddingStrategyTypeEnum {
// Enum describing possible bidding strategy types.
enum BiddingStrategyType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Enhanced CPC is 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.
ENHANCED_CPC = 2;
// Manual click based bidding where user pays per click.
MANUAL_CPC = 3;
// Manual impression based bidding
// where user pays per thousand impressions.
MANUAL_CPM = 4;
// A bidding strategy that automatically maximizes number of conversions
// given a daily budget.
MAXIMIZE_CONVERSIONS = 10;
// An automated bidding strategy that automatically sets bids to maximize
// revenue while spending your budget.
MAXIMIZE_CONVERSION_VALUE = 11;
// Page-One Promoted bidding scheme, which sets max cpc bids to
// target impressions on page one or page one promoted slots on google.com.
PAGE_ONE_PROMOTED = 5;
// Percent Cpc is bidding strategy where bids are a fraction of the
// advertised price for some good or service.
PERCENT_CPC = 12;
// Target CPA is an automated bid strategy that sets bids
// to help get as many conversions as possible
// at the target cost-per-acquisition (CPA) you set.
TARGET_CPA = 6;
// Target Outrank Share is an automated bidding strategy that sets bids
// based on the target fraction of auctions where the advertiser
// should outrank a specific competitor.
TARGET_OUTRANK_SHARE = 7;
// Target ROAS is an automated bidding strategy
// that helps you maximize revenue while averaging
// a specific target Return On Average Spend (ROAS).
TARGET_ROAS = 8;
// Target Spend is an automated bid strategy that sets your bids
// to help get as many clicks as possible within your budget.
TARGET_SPEND = 9;
}
}

View File

@ -0,0 +1,48 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing Budget delivery methods.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "BudgetDeliveryMethodProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Message describing Budget delivery methods. A delivery method determines the
// rate at which the Budget is spent.
message BudgetDeliveryMethodEnum {
// Possible delivery methods of a Budget.
enum BudgetDeliveryMethod {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The budget server will throttle serving evenly across
// the entire time period.
STANDARD = 2;
// The budget server will not throttle serving,
// and ads will serve as fast as possible.
ACCELERATED = 3;
}
}

View File

@ -0,0 +1,45 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing Budget statuses
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "BudgetStatusProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Message describing a Budget status
message BudgetStatusEnum {
// Possible statuses of a Budget.
enum BudgetStatus {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Budget is enabled.
ENABLED = 2;
// Budget is removed.
REMOVED = 3;
}
}

View File

@ -0,0 +1,53 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing Campaign serving statuses.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "CampaignServingStatusProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Message describing Campaign serving statuses.
message CampaignServingStatusEnum {
// Possible serving statuses of a campaign.
enum CampaignServingStatus {
// No value has been specified.
UNSPECIFIED = 0;
// The received value is not known in this version.
//
// This is a response-only value.
UNKNOWN = 1;
// Serving.
SERVING = 2;
// None.
NONE = 3;
// Ended.
ENDED = 4;
// Pending.
PENDING = 5;
// Suspended.
SUSPENDED = 6;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing campaign status.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "CampaignStatusProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enum describing possible statuses of a campaign.
message CampaignStatusEnum {
// Possible statuses of a campaign.
enum CampaignStatus {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Campaign is currently serving ads depending on budget information.
ENABLED = 2;
// Campaign has been paused by the user.
PAUSED = 3;
// Campaign has been removed.
REMOVED = 4;
}
}

View File

@ -0,0 +1,49 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing criteria types.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "CriterionTypeProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// The possible types of a criterion.
message CriterionTypeEnum {
// Enum describing possible criterion types.
enum CriterionType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Keyword. e.g. 'mars cruise'.
KEYWORD = 2;
// Platforms to target.
PLATFORM = 6;
// Locations to target.
LOCATION = 7;
// Listing groups to target.
LISTING_GROUP = 8;
}
}

View File

@ -0,0 +1,55 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing days of week.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "DayOfWeekProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enumeration of days of the week, e.g., "Monday".
message DayOfWeekEnum {
// Enumerates days of the week, e.g., "Monday".
enum DayOfWeek {
// Not specified.
UNSPECIFIED = 0;
// The value is unknown in this version.
UNKNOWN = 1;
// Monday.
MONDAY = 2;
// Tuesday.
TUESDAY = 3;
// Wednesday.
WEDNESDAY = 4;
// Thursday.
THURSDAY = 5;
// Friday.
FRIDAY = 6;
// Saturday.
SATURDAY = 7;
// Sunday.
SUNDAY = 8;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing devices.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "DeviceProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enumeration of AdWords platforms available for targeting.
message DeviceEnum {
// Enumerates AdWords platforms available for targeting.
enum Device {
// Not specified.
UNSPECIFIED = 0;
// The value is unknown in this version.
UNKNOWN = 1;
// Mobile devices with full browsers.
MOBILE = 2;
// Tablets with full browsers.
TABLET = 3;
// Computers.
DESKTOP = 4;
}
}

View File

@ -0,0 +1,54 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing GoogleAdsField categories
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "GoogleAdsFieldCategoryProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enum that determines if the described artifact is a resource
// or a field, and if it is a field, when it segments search queries.
message GoogleAdsFieldCategoryEnum {
// The category of the artifact.
enum GoogleAdsFieldCategory {
// Unspecified
UNSPECIFIED = 0;
// Unknown
UNKNOWN = 1;
// The described artifact is a resource.
RESOURCE = 2;
// The described artifact is a field and is an attribute of a resource.
// Including a resource attribute field in a query may segment the query if
// the resource to which it is attributed segments the resource found in
// the FROM clause.
ATTRIBUTE = 3;
// The described artifact is a field and always segments search queries.
SEGMENT = 5;
// The described artifact is a field and is a metric. It never segments
// search queries.
METRIC = 6;
}
}

View File

@ -0,0 +1,84 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing GoogleAdsField data types
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "GoogleAdsFieldDataTypeProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container holding the various data types.
message GoogleAdsFieldDataTypeEnum {
// These are the various types a GoogleAdsService artifact may take on.
enum GoogleAdsFieldDataType {
// Unspecified
UNSPECIFIED = 0;
// Unknown
UNKNOWN = 1;
// Maps to google.protobuf.BoolValue
//
// Applicable operators: =, !=
BOOLEAN = 2;
// Maps to google.protobuf.StringValue. It can be compared using the set of
// operators specific to dates however.
//
// Applicable operators: =, <, >, <=, >=, BETWEEN, DURING, and IN
DATE = 3;
// Maps to google.protobuf.DoubleValue
//
// Applicable operators: =, !=, <, >, IN, NOT IN
DOUBLE = 4;
// Maps to an enum. It's specific definition can be found at type_url.
//
// Applicable operators: =, !=, IN, NOT IN
ENUM = 5;
// Maps to google.protobuf.FloatValue
//
// Applicable operators: =, !=, <, >, IN, NOT IN
FLOAT = 6;
// Maps to google.protobuf.Int32Value
//
// Applicable operators: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN
INT32 = 7;
// Maps to google.protobuf.Int64Value
//
// Applicable operators: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN
INT64 = 8;
// Maps to a protocol buffer message type. The data type's details can be
// found in type_url.
//
// No operators work with MESSAGE fields.
MESSAGE = 9;
// Maps to google.protobuf.StringValue. Represents the resource name
// (unique id) of a resource or one of its foreign keys.
//
// No operators work with RESOURCE_NAME fields.
RESOURCE_NAME = 10;
// Maps to google.protobuf.StringValue.
//
// Applicable operators: =, !=, LIKE, NOT LIKE, IN, NOT IN
STRING = 11;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing Keyword match types.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "KeywordMatchTypeProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Message describing Keyword match types.
message KeywordMatchTypeEnum {
// Possible Keyword match types.
enum KeywordMatchType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Exact match.
EXACT = 2;
// Phrase match.
PHRASE = 3;
// Broad match.
BROAD = 4;
}
}

View File

@ -0,0 +1,51 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing listing custom attributes.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "ListingCustomAttributeIndexProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enum describing the index of the listing custom attribute.
message ListingCustomAttributeIndexEnum {
// The index of the listing custom attribute.
enum ListingCustomAttributeIndex {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// First listing custom attribute.
CUSTOM_ATTRIBUTE_0 = 2;
// Second listing custom attribute.
CUSTOM_ATTRIBUTE_1 = 3;
// Third listing custom attribute.
CUSTOM_ATTRIBUTE_2 = 4;
// Fourth listing custom attribute.
CUSTOM_ATTRIBUTE_3 = 5;
// Fifth listing custom attribute.
CUSTOM_ATTRIBUTE_4 = 6;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing listing groups.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "ListingGroupTypeProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enum describing the type of the listing group.
message ListingGroupTypeEnum {
// The type of the listing group.
enum ListingGroupType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Subdivision of products along some listing dimension. These nodes
// are not used by serving to target listing entries, but is purely
// to define the structure of the tree.
SUBDIVISION = 2;
// Listing group unit that defines a bid.
UNIT = 3;
}
}

View File

@ -0,0 +1,46 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing bidding schemes.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "PageOnePromotedStrategyGoalProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enum describing possible strategy goals: where impressions are
// desired to be shown on search result pages.
message PageOnePromotedStrategyGoalEnum {
// Enum describing possible strategy goals.
enum PageOnePromotedStrategyGoal {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// First page on google.com.
FIRST_PAGE = 2;
// Top slots of the first page on google.com.
FIRST_PAGE_PROMOTED = 3;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing quality score buckets.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "QualityScoreBucketProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// The relative performance compared to other advertisers.
message QualityScoreBucketEnum {
// Enum listing the possible quality score buckets.
enum QualityScoreBucket {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Quality of the creative is below average.
BELOW_AVERAGE = 2;
// Quality of the creative is average.
AVERAGE = 3;
// Quality of the creative is above average.
ABOVE_AVERAGE = 4;
}
}

View File

@ -0,0 +1,49 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing Recommendation types.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "RecommendationTypeProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enum describing types of recommendations.
message RecommendationTypeEnum {
// Types of recommendations.
enum RecommendationType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Budget recommendation for budget constrained campaigns.
CAMPAIGN_BUDGET = 2;
// Keyword recommendation.
KEYWORD = 3;
// Recommendation to add a new text ad.
TEXT_AD = 4;
// Recommendation to update a campaign to use a Target CPA bidding strategy.
TARGET_CPA_OPT_IN = 5;
}
}

View File

@ -0,0 +1,53 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing slots.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "SlotProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enumeration of possible positions of the Ad.
message SlotEnum {
// Enumerates possible positions of the Ad.
enum Slot {
// Not specified.
UNSPECIFIED = 0;
// The value is unknown in this version.
UNKNOWN = 1;
// Google search: Side.
SEARCH_SIDE = 2;
// Google search: Top.
SEARCH_TOP = 3;
// Google search: Other.
SEARCH_OTHER = 4;
// Google Display Network.
CONTENT = 5;
// Search partners: Top.
SEARCH_PARTNER_TOP = 6;
// Search partners: Other.
SEARCH_PARTNER_OTHER = 7;
}
}

View File

@ -0,0 +1,50 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing TargetCpaOptIn recommendation goals.
syntax = "proto3";
package google.ads.googleads.v0.enums;
option java_package = "com.google.ads.googleads.v0.enums";
option java_outer_classname = "TargetCpaOptInRecommendationGoalProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Enums";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Enums";
// Container for enum describing goals for TargetCpaOptIn recommendation.
message TargetCpaOptInRecommendationGoalEnum {
// Goal of TargetCpaOptIn recommendation.
enum TargetCpaOptInRecommendationGoal {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Recommendation to set Target CPA to maintain the same cost.
SAME_COST = 2;
// Recommendation to set Target CPA to maintain the same conversions.
SAME_CONVERSIONS = 3;
// Recommendation to set Target CPA to maintain the same CPA.
SAME_CPA = 4;
// Recommendation to set Target CPA to a value that is as close as possible
// to, yet lower than, the actual CPA (computed for past 28 days).
CLOSEST_CPA = 5;
}
}

View File

@ -0,0 +1,51 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing ad customizer errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "AdCustomizerErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible ad customizer errors.
message AdCustomizerErrorEnum {
// Enum describing possible ad customizer errors.
enum AdCustomizerError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Invalid date argument in countdown function.
COUNTDOWN_INVALID_DATE_FORMAT = 2;
// Countdown end date is in the past.
COUNTDOWN_DATE_IN_PAST = 3;
// Invalid locale string in countdown function.
COUNTDOWN_INVALID_LOCALE = 4;
// Days-before argument to countdown function is not positive.
COUNTDOWN_INVALID_START_DAYS_BEFORE = 5;
// A user list referenced in an IF function does not exist.
UNKNOWN_USER_LIST = 6;
}
}

View File

@ -0,0 +1,323 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing ad errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "AdErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible ad errors.
message AdErrorEnum {
// Enum describing possible ad errors.
enum AdError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Ad customizers are not supported for ad type.
AD_CUSTOMIZERS_NOT_SUPPORTED_FOR_AD_TYPE = 2;
// Estimating character sizes the string is too long.
APPROXIMATELY_TOO_LONG = 3;
// Estimating character sizes the string is too short.
APPROXIMATELY_TOO_SHORT = 4;
// There is a problem with the snippet.
BAD_SNIPPET = 5;
// Cannot modify an ad.
CANNOT_MODIFY_AD = 6;
// business name and url cannot be set at the same time
CANNOT_SET_BUSINESS_NAME_IF_URL_SET = 7;
// The specified field is incompatible with this ad's type or settings.
CANNOT_SET_FIELD = 8;
// Cannot set field when originAdId is set.
CANNOT_SET_FIELD_WITH_ORIGIN_AD_ID_SET = 9;
// Cannot set field when an existing ad id is set for sharing.
CANNOT_SET_FIELD_WITH_AD_ID_SET_FOR_SHARING = 10;
// Cannot set allowFlexibleColor false if no color is provided by user.
CANNOT_SET_ALLOW_FLEXIBLE_COLOR_FALSE = 11;
// When user select native, no color control is allowed because we will
// always respect publisher color for native format serving.
CANNOT_SET_COLOR_CONTROL_WHEN_NATIVE_FORMAT_SETTING = 12;
// Cannot specify a url for the ad type
CANNOT_SET_URL = 13;
// Cannot specify a tracking or mobile url without also setting final urls
CANNOT_SET_WITHOUT_FINAL_URLS = 14;
// Cannot specify a legacy url and a final url simultaneously
CANNOT_SET_WITH_FINAL_URLS = 15;
// Cannot specify a legacy url and a tracking url template simultaneously in
// a DSA.
CANNOT_SET_WITH_TRACKING_URL_TEMPLATE = 16;
// Cannot specify a urls in UrlData and in template fields simultaneously.
CANNOT_SET_WITH_URL_DATA = 17;
// This operator cannot be used with a subclass of Ad.
CANNOT_USE_AD_SUBCLASS_FOR_OPERATOR = 18;
// Customer is not approved for mobile ads.
CUSTOMER_NOT_APPROVED_MOBILEADS = 19;
// Customer is not approved for 3PAS richmedia ads.
CUSTOMER_NOT_APPROVED_THIRDPARTY_ADS = 20;
// Customer is not approved for 3PAS redirect richmedia (Ad Exchange) ads.
CUSTOMER_NOT_APPROVED_THIRDPARTY_REDIRECT_ADS = 21;
// Not an eligible customer
CUSTOMER_NOT_ELIGIBLE = 22;
// Customer is not eligible for updating beacon url
CUSTOMER_NOT_ELIGIBLE_FOR_UPDATING_BEACON_URL = 23;
// There already exists an ad with the same dimensions in the union.
DIMENSION_ALREADY_IN_UNION = 24;
// Ad's dimension must be set before setting union dimension.
DIMENSION_MUST_BE_SET = 25;
// Ad's dimension must be included in the union dimensions.
DIMENSION_NOT_IN_UNION = 26;
// Display Url cannot be specified (applies to Ad Exchange Ads)
DISPLAY_URL_CANNOT_BE_SPECIFIED = 27;
// Telephone number contains invalid characters or invalid format. Please
// re-enter your number using digits (0-9), dashes (-), and parentheses
// only.
DOMESTIC_PHONE_NUMBER_FORMAT = 28;
// Emergency telephone numbers are not allowed. Please enter a valid
// domestic phone number to connect customers to your business.
EMERGENCY_PHONE_NUMBER = 29;
// A required field was not specified or is an empty string.
EMPTY_FIELD = 30;
// A feed attribute referenced in an ad customizer tag is not in the ad
// customizer mapping for the feed.
FEED_ATTRIBUTE_MUST_HAVE_MAPPING_FOR_TYPE_ID = 31;
// The ad customizer field mapping for the feed attribute does not match the
// expected field type.
FEED_ATTRIBUTE_MAPPING_TYPE_MISMATCH = 32;
// The use of ad customizer tags in the ad text is disallowed. Details in
// trigger.
ILLEGAL_AD_CUSTOMIZER_TAG_USE = 33;
// Tags of the form {PH_x}, where x is a number, are disallowed in ad text.
ILLEGAL_TAG_USE = 34;
// The dimensions of the ad are specified or derived in multiple ways and
// are not consistent.
INCONSISTENT_DIMENSIONS = 35;
// The status cannot differ among template ads of the same union.
INCONSISTENT_STATUS_IN_TEMPLATE_UNION = 36;
// The length of the string is not valid.
INCORRECT_LENGTH = 37;
// The ad is ineligible for upgrade.
INELIGIBLE_FOR_UPGRADE = 38;
// User cannot create mobile ad for countries targeted in specified
// campaign.
INVALID_AD_ADDRESS_CAMPAIGN_TARGET = 39;
// Invalid Ad type. A specific type of Ad is required.
INVALID_AD_TYPE = 40;
// Headline, description or phone cannot be present when creating mobile
// image ad.
INVALID_ATTRIBUTES_FOR_MOBILE_IMAGE = 41;
// Image cannot be present when creating mobile text ad.
INVALID_ATTRIBUTES_FOR_MOBILE_TEXT = 42;
// Invalid call to action text.
INVALID_CALL_TO_ACTION_TEXT = 43;
// Invalid character in URL.
INVALID_CHARACTER_FOR_URL = 44;
// Creative's country code is not valid.
INVALID_COUNTRY_CODE = 45;
// Invalid use of Dynamic Search Ads tags ({lpurl} etc.)
INVALID_DSA_URL_TAG = 46;
// Invalid use of Expanded Dynamic Search Ads tags ({lpurl} etc.)
INVALID_EXPANDED_DYNAMIC_SEARCH_AD_TAG = 47;
// An input error whose real reason was not properly mapped (should not
// happen).
INVALID_INPUT = 48;
// An invalid markup language was entered.
INVALID_MARKUP_LANGUAGE = 49;
// An invalid mobile carrier was entered.
INVALID_MOBILE_CARRIER = 50;
// Specified mobile carriers target a country not targeted by the campaign.
INVALID_MOBILE_CARRIER_TARGET = 51;
// Wrong number of elements for given element type
INVALID_NUMBER_OF_ELEMENTS = 52;
// The format of the telephone number is incorrect. Please re-enter the
// number using the correct format.
INVALID_PHONE_NUMBER_FORMAT = 53;
// The certified vendor format id is incorrect.
INVALID_RICH_MEDIA_CERTIFIED_VENDOR_FORMAT_ID = 54;
// The template ad data contains validation errors.
INVALID_TEMPLATE_DATA = 55;
// The template field doesn't have have the correct type.
INVALID_TEMPLATE_ELEMENT_FIELD_TYPE = 56;
// Invalid template id.
INVALID_TEMPLATE_ID = 57;
// After substituting replacement strings, the line is too wide.
LINE_TOO_WIDE = 58;
// The feed referenced must have ad customizer mapping to be used in a
// customizer tag.
MISSING_AD_CUSTOMIZER_MAPPING = 59;
// Missing address component in template element address field.
MISSING_ADDRESS_COMPONENT = 60;
// An ad name must be entered.
MISSING_ADVERTISEMENT_NAME = 61;
// Business name must be entered.
MISSING_BUSINESS_NAME = 62;
// Description (line 2) must be entered.
MISSING_DESCRIPTION1 = 63;
// Description (line 3) must be entered.
MISSING_DESCRIPTION2 = 64;
// The destination url must contain at least one tag (e.g. {lpurl})
MISSING_DESTINATION_URL_TAG = 65;
// The tracking url template of ExpandedDynamicSearchAd must contain at
// least one tag. (e.g. {lpurl})
MISSING_LANDING_PAGE_URL_TAG = 66;
// A valid dimension must be specified for this ad.
MISSING_DIMENSION = 67;
// A display URL must be entered.
MISSING_DISPLAY_URL = 68;
// Headline must be entered.
MISSING_HEADLINE = 69;
// A height must be entered.
MISSING_HEIGHT = 70;
// An image must be entered.
MISSING_IMAGE = 71;
// Marketing image or product videos are required.
MISSING_MARKETING_IMAGE_OR_PRODUCT_VIDEOS = 72;
// The markup language in which your site is written must be entered.
MISSING_MARKUP_LANGUAGES = 73;
// A mobile carrier must be entered.
MISSING_MOBILE_CARRIER = 74;
// Phone number must be entered.
MISSING_PHONE = 75;
// Missing required template fields
MISSING_REQUIRED_TEMPLATE_FIELDS = 76;
// Missing a required field value
MISSING_TEMPLATE_FIELD_VALUE = 77;
// The ad must have text.
MISSING_TEXT = 78;
// A visible URL must be entered.
MISSING_VISIBLE_URL = 79;
// A width must be entered.
MISSING_WIDTH = 80;
// Only 1 feed can be used as the source of ad customizer substitutions in a
// single ad.
MULTIPLE_DISTINCT_FEEDS_UNSUPPORTED = 81;
// TempAdUnionId must be use when adding template ads.
MUST_USE_TEMP_AD_UNION_ID_ON_ADD = 82;
// The string has too many characters.
TOO_LONG = 83;
// The string has too few characters.
TOO_SHORT = 84;
// Ad union dimensions cannot change for saved ads.
UNION_DIMENSIONS_CANNOT_CHANGE = 85;
// Address component is not {country, lat, lng}.
UNKNOWN_ADDRESS_COMPONENT = 86;
// Unknown unique field name
UNKNOWN_FIELD_NAME = 87;
// Unknown unique name (template element type specifier)
UNKNOWN_UNIQUE_NAME = 88;
// Unsupported ad dimension
UNSUPPORTED_DIMENSIONS = 89;
// URL starts with an invalid scheme.
URL_INVALID_SCHEME = 90;
// URL ends with an invalid top-level domain name.
URL_INVALID_TOP_LEVEL_DOMAIN = 91;
// URL contains illegal characters.
URL_MALFORMED = 92;
// URL must contain a host name.
URL_NO_HOST = 93;
// URL not equivalent during upgrade.
URL_NOT_EQUIVALENT = 94;
// URL host name too long to be stored as visible URL (applies to Ad
// Exchange ads)
URL_HOST_NAME_TOO_LONG = 95;
// URL must start with a scheme.
URL_NO_SCHEME = 96;
// URL should end in a valid domain extension, such as .com or .net.
URL_NO_TOP_LEVEL_DOMAIN = 97;
// URL must not end with a path.
URL_PATH_NOT_ALLOWED = 98;
// URL must not specify a port.
URL_PORT_NOT_ALLOWED = 99;
// URL must not contain a query.
URL_QUERY_NOT_ALLOWED = 100;
// A url scheme is not allowed in front of tag in dest url (e.g.
// http://{lpurl})
URL_SCHEME_BEFORE_DSA_TAG = 101;
// A url scheme is not allowed in front of tag in tracking url template
// (e.g. http://{lpurl})
URL_SCHEME_BEFORE_EXPANDED_DYNAMIC_SEARCH_AD_TAG = 102;
// The user does not have permissions to create a template ad for the given
// template.
USER_DOES_NOT_HAVE_ACCESS_TO_TEMPLATE = 103;
// Expandable setting is inconsistent/wrong. For example, an AdX ad is
// invalid if it has a expandable vendor format but no expanding directions
// specified, or expanding directions is specified, but the vendor format is
// not expandable.
INCONSISTENT_EXPANDABLE_SETTINGS = 104;
// Format is invalid
INVALID_FORMAT = 105;
// The text of this field did not match a pattern of allowed values.
INVALID_FIELD_TEXT = 106;
// Template element is mising
ELEMENT_NOT_PRESENT = 107;
// Error occurred during image processing
IMAGE_ERROR = 108;
// The value is not within the valid range
VALUE_NOT_IN_RANGE = 109;
// Template element field is not present
FIELD_NOT_PRESENT = 110;
// Address is incomplete
ADDRESS_NOT_COMPLETE = 111;
// Invalid address
ADDRESS_INVALID = 112;
// Error retrieving specified video
VIDEO_RETRIEVAL_ERROR = 113;
// Error processing audio
AUDIO_ERROR = 114;
// Display URL is incorrect for YouTube PYV ads
INVALID_YOUTUBE_DISPLAY_URL = 115;
// Too many product Images in GmailAd
TOO_MANY_PRODUCT_IMAGES = 116;
// Too many product Videos in GmailAd
TOO_MANY_PRODUCT_VIDEOS = 117;
// The device preference is not compatible with the ad type
INCOMPATIBLE_AD_TYPE_AND_DEVICE_PREFERENCE = 118;
// Call tracking is not supported for specified country.
CALLTRACKING_NOT_SUPPORTED_FOR_COUNTRY = 119;
// Carrier specific short number is not allowed.
CARRIER_SPECIFIC_SHORT_NUMBER_NOT_ALLOWED = 120;
// Specified phone number type is disallowed.
DISALLOWED_NUMBER_TYPE = 121;
// Phone number not supported for country.
PHONE_NUMBER_NOT_SUPPORTED_FOR_COUNTRY = 122;
// Phone number not supported with call tracking enabled for country.
PHONE_NUMBER_NOT_SUPPORTED_WITH_CALLTRACKING_FOR_COUNTRY = 123;
// Premium rate phone number is not allowed.
PREMIUM_RATE_NUMBER_NOT_ALLOWED = 124;
// Vanity phone number is not allowed.
VANITY_PHONE_NUMBER_NOT_ALLOWED = 125;
// Invalid call conversion type id.
INVALID_CALL_CONVERSION_TYPE_ID = 126;
// Cannot disable call conversion and set conversion type id.
CANNOT_DISABLE_CALL_CONVERSION_AND_SET_CONVERSION_TYPE_ID = 127;
// Cannot set path2 without path1.
CANNOT_SET_PATH2_WITHOUT_PATH1 = 128;
// Missing domain name in campaign setting when adding expanded dynamic
// search ad.
MISSING_DYNAMIC_SEARCH_ADS_SETTING_DOMAIN_NAME = 129;
// The associated ad is not compatible with restriction type.
INCOMPATIBLE_WITH_RESTRICTION_TYPE = 130;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing ad group ad errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "AdGroupAdErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible ad group ad errors.
message AdGroupAdErrorEnum {
// Enum describing possible ad group ad errors.
enum AdGroupAdError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// No link found between the adgroup ad and the label.
AD_GROUP_AD_LABEL_DOES_NOT_EXIST = 2;
// The label has already been attached to the adgroup ad.
AD_GROUP_AD_LABEL_ALREADY_EXISTS = 3;
// The specified ad was not found in the adgroup
AD_NOT_UNDER_ADGROUP = 4;
// Removed ads may not be modified
CANNOT_OPERATE_ON_REMOVED_ADGROUPAD = 5;
// An ad of this type is deprecated and cannot be created. Only deletions
// are permitted.
CANNOT_CREATE_DEPRECATED_ADS = 6;
// Text ads are deprecated and cannot be created. Use expanded text ads
// instead.
CANNOT_CREATE_TEXT_ADS = 7;
// A required field was not specified or is an empty string.
EMPTY_FIELD = 8;
// An ad may only be modified once per call
RESOURCE_REFERENCED_IN_MULTIPLE_OPS = 9;
}
}

View File

@ -0,0 +1,46 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing ad group bid modifier errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "AdGroupBidModifierErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible ad group bid modifier errors.
message AdGroupBidModifierErrorEnum {
// Enum describing possible ad group bid modifier errors.
enum AdGroupBidModifierError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// The criterion ID does not support bid modification.
CRITERION_ID_NOT_SUPPORTED = 2;
// Cannot override the bid modifier for the given criterion ID if the parent
// campaign is opted out of the same criterion.
CANNOT_OVERRIDE_OPTED_OUT_CAMPAIGN_CRITERION_BID_MODIFIER = 3;
}
}

View File

@ -0,0 +1,125 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing ad group criterion errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "AdGroupCriterionErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible ad group criterion errors.
message AdGroupCriterionErrorEnum {
// Enum describing possible ad group criterion errors.
enum AdGroupCriterionError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// No link found between the AdGroupCriterion and the label.
AD_GROUP_CRITERION_LABEL_DOES_NOT_EXIST = 2;
// The label has already been attached to the AdGroupCriterion.
AD_GROUP_CRITERION_LABEL_ALREADY_EXISTS = 3;
// Negative AdGroupCriterion cannot have labels.
CANNOT_ADD_LABEL_TO_NEGATIVE_CRITERION = 4;
// Too many operations for a single call.
TOO_MANY_OPERATIONS = 5;
// Negative ad group criteria are not updateable.
CANT_UPDATE_NEGATIVE = 6;
// Concrete type of criterion (keyword v.s. placement) is required for ADD
// and SET operations.
CONCRETE_TYPE_REQUIRED = 7;
// Bid is incompatible with ad group's bidding settings.
BID_INCOMPATIBLE_WITH_ADGROUP = 8;
// Cannot target and exclude the same criterion at once.
CANNOT_TARGET_AND_EXCLUDE = 9;
// The URL of a placement is invalid.
ILLEGAL_URL = 10;
// Keyword text was invalid.
INVALID_KEYWORD_TEXT = 11;
// Destination URL was invalid.
INVALID_DESTINATION_URL = 12;
// The destination url must contain at least one tag (e.g. {lpurl})
MISSING_DESTINATION_URL_TAG = 13;
// Keyword-level cpm bid is not supported
KEYWORD_LEVEL_BID_NOT_SUPPORTED_FOR_MANUALCPM = 14;
// For example, cannot add a biddable ad group criterion that had been
// removed.
INVALID_USER_STATUS = 15;
// Criteria type cannot be targeted for the ad group. Either the account is
// restricted to keywords only, the criteria type is incompatible with the
// campaign's bidding strategy, or the criteria type can only be applied to
// campaigns.
CANNOT_ADD_CRITERIA_TYPE = 16;
// Criteria type cannot be excluded for the ad group. Refer to the
// documentation for a specific criterion to check if it is excludable.
CANNOT_EXCLUDE_CRITERIA_TYPE = 17;
// Partial failure is not supported for shopping campaign mutate operations.
CAMPAIGN_TYPE_NOT_COMPATIBLE_WITH_PARTIAL_FAILURE = 27;
// Operations in the mutate request changes too many shopping ad groups.
// Please split requests for multiple shopping ad groups across multiple
// requests.
OPERATIONS_FOR_TOO_MANY_SHOPPING_ADGROUPS = 28;
// Not allowed to modify url fields of an ad group criterion if there are
// duplicate elements for that ad group criterion in the request.
CANNOT_MODIFY_URL_FIELDS_WITH_DUPLICATE_ELEMENTS = 29;
// Cannot set url fields without also setting final urls.
CANNOT_SET_WITHOUT_FINAL_URLS = 30;
// Cannot clear final urls if final mobile urls exist.
CANNOT_CLEAR_FINAL_URLS_IF_FINAL_MOBILE_URLS_EXIST = 31;
// Cannot clear final urls if final app urls exist.
CANNOT_CLEAR_FINAL_URLS_IF_FINAL_APP_URLS_EXIST = 32;
// Cannot clear final urls if tracking url template exists.
CANNOT_CLEAR_FINAL_URLS_IF_TRACKING_URL_TEMPLATE_EXISTS = 33;
// Cannot clear final urls if url custom parameters exist.
CANNOT_CLEAR_FINAL_URLS_IF_URL_CUSTOM_PARAMETERS_EXIST = 34;
// Cannot set both destination url and final urls.
CANNOT_SET_BOTH_DESTINATION_URL_AND_FINAL_URLS = 35;
// Cannot set both destination url and tracking url template.
CANNOT_SET_BOTH_DESTINATION_URL_AND_TRACKING_URL_TEMPLATE = 36;
// Final urls are not supported for this criterion type.
FINAL_URLS_NOT_SUPPORTED_FOR_CRITERION_TYPE = 37;
// Final mobile urls are not supported for this criterion type.
FINAL_MOBILE_URLS_NOT_SUPPORTED_FOR_CRITERION_TYPE = 38;
// Ad group is invalid due to the listing groups it contains.
INVALID_LISTING_GROUP_HIERARCHY = 39;
// Listing group unit cannot have children.
LISTING_GROUP_UNIT_CANNOT_HAVE_CHILDREN = 40;
// Subdivided listing groups must have an "others" case.
LISTING_GROUP_SUBDIVISION_REQUIRES_OTHERS_CASE = 41;
// Dimension type of listing group must be the same as that of its siblings.
LISTING_GROUP_REQUIRES_SAME_DIMENSION_TYPE_AS_SIBLINGS = 42;
// Listing group cannot be added to the ad group because it already exists.
LISTING_GROUP_ALREADY_EXISTS = 43;
// Listing group referenced in the operation was not found in the ad group.
LISTING_GROUP_DOES_NOT_EXIST = 44;
// Recursive removal failed because listing group subdivision is being
// created or modified in this request.
LISTING_GROUP_CANNOT_BE_REMOVED = 45;
// Listing group type is not allowed for specified ad group criterion type.
INVALID_LISTING_GROUP_TYPE = 46;
// Listing group in an ADD operation specifies a non temporary criterion id.
LISTING_GROUP_ADD_MAY_ONLY_USE_TEMP_ID = 47;
}
}

View File

@ -0,0 +1,68 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing ad group errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "AdGroupErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible ad group errors.
message AdGroupErrorEnum {
// Enum describing possible ad group errors.
enum AdGroupError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// AdGroup with the same name already exists for the campaign.
DUPLICATE_ADGROUP_NAME = 2;
// AdGroup name is not valid.
INVALID_ADGROUP_NAME = 3;
// Advertiser is not allowed to target sites or set site bids that are not
// on the Google Search Network.
ADVERTISER_NOT_ON_CONTENT_NETWORK = 5;
// Bid amount is too big.
BID_TOO_BIG = 6;
// AdGroup bid does not match the campaign's bidding strategy.
BID_TYPE_AND_BIDDING_STRATEGY_MISMATCH = 7;
// AdGroup name is required for Add.
MISSING_ADGROUP_NAME = 8;
// No link found between the ad group and the label.
ADGROUP_LABEL_DOES_NOT_EXIST = 9;
// The label has already been attached to the ad group.
ADGROUP_LABEL_ALREADY_EXISTS = 10;
// The CriterionTypeGroup is not supported for the content bid dimension.
INVALID_CONTENT_BID_CRITERION_TYPE_GROUP = 11;
// The ad group type is not compatible with the campaign channel type.
AD_GROUP_TYPE_NOT_VALID_FOR_ADVERTISING_CHANNEL_TYPE = 12;
// The ad group type is not supported in the country of sale of the
// campaign.
ADGROUP_TYPE_NOT_SUPPORTED_FOR_CAMPAIGN_SALES_COUNTRY = 13;
// Ad groups of AdGroupType.SEARCH_DYNAMIC_ADS can only be added to
// campaigns that have DynamicSearchAdsSetting attached.
CANNOT_ADD_ADGROUP_OF_TYPE_DSA_TO_CAMPAIGN_WITHOUT_DSA_SETTING = 14;
}
}

View File

@ -0,0 +1,48 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing ad sharing errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "AdSharingErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible ad sharing errors.
message AdSharingErrorEnum {
// Enum describing possible ad sharing errors.
enum AdSharingError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Error resulting in attempting to add an Ad to an AdGroup that already
// contains the Ad.
AD_GROUP_ALREADY_CONTAINS_AD = 2;
// Ad is not compatible with the AdGroup it is being shared with.
INCOMPATIBLE_AD_UNDER_AD_GROUP = 3;
// Cannot add AdGroupAd on inactive Ad.
CANNOT_SHARE_INACTIVE_AD = 4;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing adx errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "AdxErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible adx errors.
message AdxErrorEnum {
// Enum describing possible adx errors.
enum AdxError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Attempt to use non-AdX feature by AdX customer.
UNSUPPORTED_FEATURE = 2;
}
}

View File

@ -0,0 +1,76 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing authentication errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "AuthenticationErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible authentication errors.
message AuthenticationErrorEnum {
// Enum describing possible authentication errors.
enum AuthenticationError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Authentication of the request failed.
AUTHENTICATION_ERROR = 2;
// Client customer Id is not a number.
CLIENT_CUSTOMER_ID_INVALID = 5;
// No customer found for the customer id provided in the header.
CUSTOMER_NOT_FOUND = 8;
// Client's Google Account is deleted.
GOOGLE_ACCOUNT_DELETED = 9;
// Google account login token in the cookie is invalid.
GOOGLE_ACCOUNT_COOKIE_INVALID = 10;
// A problem occurred during Google account authentication.
FAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT = 11;
// The user in the google account login token does not match the UserId in
// the cookie.
GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH = 12;
// Login cookie is required for authentication.
LOGIN_COOKIE_REQUIRED = 13;
// User in the cookie is not a valid Ads user.
NOT_ADS_USER = 14;
// Oauth token in the header is not valid.
OAUTH_TOKEN_INVALID = 15;
// Oauth token in the header has expired.
OAUTH_TOKEN_EXPIRED = 16;
// Oauth token in the header has been disabled.
OAUTH_TOKEN_DISABLED = 17;
// Oauth token in the header has been revoked.
OAUTH_TOKEN_REVOKED = 18;
// Oauth token HTTP header is malformed.
OAUTH_TOKEN_HEADER_INVALID = 19;
// Login cookie is not valid.
LOGIN_COOKIE_INVALID = 20;
// Failed to decrypt the login cookie.
FAILED_TO_RETRIEVE_LOGIN_COOKIE = 21;
// User Id in the header is not a valid id.
USER_ID_INVALID = 22;
}
}

View File

@ -0,0 +1,52 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing authorization errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "AuthorizationErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible authorization errors.
message AuthorizationErrorEnum {
// Enum describing possible authorization errors.
enum AuthorizationError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// User doesn't have permission to access customer.
USER_PERMISSION_DENIED = 2;
// The developer token is not whitelisted.
DEVELOPER_TOKEN_NOT_WHITELISTED = 3;
// The developer token is not allowed with the project sent in the request.
DEVELOPER_TOKEN_PROHIBITED = 4;
// The Google Cloud project sent in the request does not have permission to
// access the api.
PROJECT_DISABLED = 5;
// Authorization of the client failed.
AUTHORIZATION_ERROR = 6;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing bidding errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "BiddingErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible bidding errors.
message BiddingErrorEnum {
// Enum describing possible bidding errors.
enum BiddingError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Cannot transition to new bidding strategy.
BIDDING_STRATEGY_TRANSITION_NOT_ALLOWED = 2;
// Cannot attach bidding strategy to campaign.
CANNOT_ATTACH_BIDDING_STRATEGY_TO_CAMPAIGN = 7;
// Bidding strategy is not supported or cannot be used as anonymous.
INVALID_ANONYMOUS_BIDDING_STRATEGY_TYPE = 10;
// The type does not match the named strategy's type.
INVALID_BIDDING_STRATEGY_TYPE = 14;
// The bid is invalid.
INVALID_BID = 17;
// Bidding strategy is not available for the account type.
BIDDING_STRATEGY_NOT_AVAILABLE_FOR_ACCOUNT_TYPE = 18;
// Conversion tracking is not enabled for the campaign for VBB transition.
CONVERSION_TRACKING_NOT_ENABLED = 19;
// Not enough conversions tracked for VBB transitions.
NOT_ENOUGH_CONVERSIONS = 20;
// Campaign can not be created with given bidding strategy. It can be
// transitioned to the strategy, once eligible.
CANNOT_CREATE_CAMPAIGN_WITH_BIDDING_STRATEGY = 21;
// Cannot target content network only as campaign uses Page One Promoted
// bidding strategy.
CANNOT_TARGET_CONTENT_NETWORK_ONLY_WITH_CAMPAIGN_LEVEL_POP_BIDDING_STRATEGY
= 23;
// Budget Optimizer and Target Spend bidding strategies are not supported
// for campaigns with AdSchedule targeting.
BIDDING_STRATEGY_NOT_SUPPORTED_WITH_AD_SCHEDULE = 24;
// Pay per conversion is not available to all the customer, only few
// whitelisted customers can use this.
PAY_PER_CONVERSION_NOT_AVAILABLE_FOR_CUSTOMER = 25;
// Pay per conversion is not allowed with Target CPA.
PAY_PER_CONVERSION_NOT_ALLOWED_WITH_TARGET_CPA = 26;
// Cannot set bidding strategy to Manual CPM for search network only
// campaigns.
BIDDING_STRATEGY_NOT_ALLOWED_FOR_SEARCH_ONLY_CAMPAIGNS = 27;
// The bidding strategy is not supported for use in drafts or experiments.
BIDDING_STRATEGY_NOT_SUPPORTED_IN_DRAFTS_OR_EXPERIMENTS = 28;
// Bidding strategy type does not support product type ad group criterion.
BIDDING_STRATEGY_TYPE_DOES_NOT_SUPPORT_PRODUCT_TYPE_ADGROUP_CRITERION = 29;
// Bid amount is too small.
BID_TOO_SMALL = 30;
// Bid amount is too big.
BID_TOO_BIG = 31;
// Bid has too many fractional digit precision.
BID_TOO_MANY_FRACTIONAL_DIGITS = 32;
// Invalid domain name specified.
INVALID_DOMAIN_NAME = 33;
}
}

View File

@ -0,0 +1,50 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing bidding strategy errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "BiddingStrategyErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible bidding strategy errors.
message BiddingStrategyErrorEnum {
// Enum describing possible bidding strategy errors.
enum BiddingStrategyError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Each bidding strategy must have a unique name.
DUPLICATE_NAME = 2;
// Bidding strategy type is immutable.
CANNOT_CHANGE_BIDDING_STRATEGY_TYPE = 3;
// Only bidding strategies not linked to campaigns, adgroups or adgroup
// criteria can be removed.
CANNOT_REMOVE_ASSOCIATED_STRATEGY = 4;
// The specified bidding strategy is not supported.
BIDDING_STRATEGY_NOT_SUPPORTED = 5;
}
}

View File

@ -0,0 +1,74 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing campaign budget errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "CampaignBudgetErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible campaign budget errors.
message CampaignBudgetErrorEnum {
// Enum describing possible campaign budget errors.
enum CampaignBudgetError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// The requested campaign budget no longer exists.
CAMPAIGN_BUDGET_REMOVED = 2;
// The campaign budget is associated with at least one campaign, and so the
// campaign budget cannot be removed.
CAMPAIGN_BUDGET_IN_USE = 3;
// Customer is not whitelisted for this campaign budget period.
CAMPAIGN_BUDGET_PERIOD_NOT_AVAILABLE = 4;
// This field is not mutable on implicitly shared campaign budgets
CANNOT_MODIFY_FIELD_OF_IMPLICITLY_SHARED_CAMPAIGN_BUDGET = 6;
// Cannot change explicitly shared campaign budgets back to implicitly
// shared ones.
CANNOT_UPDATE_CAMPAIGN_BUDGET_TO_IMPLICITLY_SHARED = 7;
// An implicit campaign budget without a name cannot be changed to
// explicitly shared campaign budget.
CANNOT_UPDATE_CAMPAIGN_BUDGET_TO_EXPLICITLY_SHARED_WITHOUT_NAME = 8;
// Cannot change an implicitly shared campaign budget to an explicitly
// shared one.
CANNOT_UPDATE_CAMPAIGN_BUDGET_TO_EXPLICITLY_SHARED = 9;
// Only explicitly shared campaign budgets can be used with multiple
// campaigns.
CANNOT_USE_IMPLICITLY_SHARED_CAMPAIGN_BUDGET_WITH_MULTIPLE_CAMPAIGNS = 10;
// A campaign budget with this name already exists.
DUPLICATE_NAME = 11;
// A money amount was not in the expected currency.
MONEY_AMOUNT_IN_WRONG_CURRENCY = 12;
// A money amount was less than the minimum CPC for currency.
MONEY_AMOUNT_LESS_THAN_CURRENCY_MINIMUM_CPC = 13;
// A money amount was greater than the maximum allowed.
MONEY_AMOUNT_TOO_LARGE = 14;
// A money amount was negative.
NEGATIVE_MONEY_AMOUNT = 15;
// A money amount was not a multiple of a minimum unit.
NON_MULTIPLE_OF_MINIMUM_CURRENCY_UNIT = 16;
}
}

View File

@ -0,0 +1,65 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing campaign criterion errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "CampaignCriterionErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible campaign criterion errors.
message CampaignCriterionErrorEnum {
// Enum describing possible campaign criterion errors.
enum CampaignCriterionError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Concrete type of criterion (keyword v.s. placement) is required for
// CREATE and UPDATE operations.
CONCRETE_TYPE_REQUIRED = 2;
// Invalid placement URL.
INVALID_PLACEMENT_URL = 3;
// Criteria type can not be excluded for the campaign by the customer. like
// AOL account type cannot target site type criteria
CANNOT_EXCLUDE_CRITERIA_TYPE = 4;
// Cannot set the campaign criterion status for this criteria type.
CANNOT_SET_STATUS_FOR_CRITERIA_TYPE = 5;
// Cannot set the campaign criterion status for an excluded criteria.
CANNOT_SET_STATUS_FOR_EXCLUDED_CRITERIA = 6;
// Cannot target and exclude the same criterion.
CANNOT_TARGET_AND_EXCLUDE = 7;
// The mutate contained too many operations.
TOO_MANY_OPERATIONS = 8;
// This operator cannot be applied to a criterion of this type.
OPERATOR_NOT_SUPPORTED_FOR_CRITERION_TYPE = 9;
// The Shopping campaign sales country is not supported for
// ProductSalesChannel targeting.
SHOPPING_CAMPAIGN_SALES_COUNTRY_NOT_SUPPORTED_FOR_SALES_CHANNEL = 10;
// The existing field can't be updated with CREATE operation. It can be
// updated with UPDATE operation only.
CANNOT_ADD_EXISTING_FIELD = 11;
}
}

View File

@ -0,0 +1,127 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing campaign errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "CampaignErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible campaign errors.
message CampaignErrorEnum {
// Enum describing possible campaign errors.
enum CampaignError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Cannot target content network.
CANNOT_TARGET_CONTENT_NETWORK = 3;
// Cannot target search network.
CANNOT_TARGET_SEARCH_NETWORK = 4;
// Cannot cover search network without google search network.
CANNOT_TARGET_SEARCH_NETWORK_WITHOUT_GOOGLE_SEARCH = 5;
// Cannot target Google Search network for a CPM campaign.
CANNOT_TARGET_GOOGLE_SEARCH_FOR_CPM_CAMPAIGN = 6;
// Must target at least one network.
CAMPAIGN_MUST_TARGET_AT_LEAST_ONE_NETWORK = 7;
// Only some Google partners are allowed to target partner search network.
CANNOT_TARGET_PARTNER_SEARCH_NETWORK = 8;
// Cannot target content network only as campaign has criteria-level bidding
// strategy.
CANNOT_TARGET_CONTENT_NETWORK_ONLY_WITH_CRITERIA_LEVEL_BIDDING_STRATEGY = 9;
// Cannot modify the start or end date such that the campaign duration would
// not contain the durations of all runnable trials.
CAMPAIGN_DURATION_MUST_CONTAIN_ALL_RUNNABLE_TRIALS = 10;
// Cannot modify dates, budget or campaign name of a trial campaign.
CANNOT_MODIFY_FOR_TRIAL_CAMPAIGN = 11;
// Trying to modify the name of an active or paused campaign, where the name
// is already assigned to another active or paused campaign.
DUPLICATE_CAMPAIGN_NAME = 12;
// Two fields are in conflicting modes.
INCOMPATIBLE_CAMPAIGN_FIELD = 13;
// Campaign name cannot be used.
INVALID_CAMPAIGN_NAME = 14;
// Given status is invalid.
INVALID_AD_SERVING_OPTIMIZATION_STATUS = 15;
// Error in the campaign level tracking url.
INVALID_TRACKING_URL = 16;
// Cannot set both tracking url template and tracking setting. An user has
// to clear legacy tracking setting in order to add tracking url template.
CANNOT_SET_BOTH_TRACKING_URL_TEMPLATE_AND_TRACKING_SETTING = 17;
// The maximum number of impressions for Frequency Cap should be an integer
// greater than 0.
MAX_IMPRESSIONS_NOT_IN_RANGE = 18;
// Only the Day, Week and Month time units are supported.
TIME_UNIT_NOT_SUPPORTED = 19;
// Operation not allowed on a campaign whose serving status has ended
INVALID_OPERATION_IF_SERVING_STATUS_HAS_ENDED = 20;
// This budget is exclusively linked to a Campaign that is using experiments
// so it cannot be shared.
BUDGET_CANNOT_BE_SHARED = 21;
// Campaigns using experiments cannot use a shared budget.
CAMPAIGN_CANNOT_USE_SHARED_BUDGET = 22;
// A different budget cannot be assigned to a campaign when there are
// running or scheduled trials.
CANNOT_CHANGE_BUDGET_ON_CAMPAIGN_WITH_TRIALS = 23;
// No link found between the campaign and the label.
CAMPAIGN_LABEL_DOES_NOT_EXIST = 24;
// The label has already been attached to the campaign.
CAMPAIGN_LABEL_ALREADY_EXISTS = 25;
// A ShoppingSetting was not found when creating a shopping campaign.
MISSING_SHOPPING_SETTING = 26;
// The country in shopping setting is not an allowed country.
INVALID_SHOPPING_SALES_COUNTRY = 27;
// Shopping merchant is not enabled for Purchases on Google.
SHOPPING_MERCHANT_NOT_ALLOWED_FOR_PURCHASES_ON_GOOGLE = 28;
// Purchases on Google not enabled for the shopping campaign's sales
// country.
PURCHASES_ON_GOOGLE_NOT_SUPPORTED_FOR_SHOPPING_SALES_COUNTRY = 29;
// A Campaign with channel sub type UNIVERSAL_APP_CAMPAIGN must have a
// UniversalAppCampaignSetting specified.
MISSING_UNIVERSAL_APP_CAMPAIGN_SETTING = 30;
// The requested channel type is not available according to the customer's
// account setting.
ADVERTISING_CHANNEL_TYPE_NOT_AVAILABLE_FOR_ACCOUNT_TYPE = 31;
// The AdvertisingChannelSubType is not a valid subtype of the primary
// channel type.
INVALID_ADVERTISING_CHANNEL_SUB_TYPE = 32;
// At least one conversion must be selected.
AT_LEAST_ONE_CONVERSION_MUST_BE_SELECTED = 33;
// Setting ad rotation mode for a campaign is not allowed. Ad rotation mode
// at campaign is deprecated.
CANNOT_SET_AD_ROTATION_MODE = 34;
// Trying to change start date on a campaign that has started.
CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED = 35;
// Trying to modify a date into the past.
CANNOT_SET_DATE_TO_PAST = 36;
// Hotel center id in the hotel setting does not match any customer links.
MISSING_HOTEL_CUSTOMER_LINK = 37;
// Hotel center id in the hotel setting must match an active customer link.
INVALID_HOTEL_CUSTOMER_LINK = 38;
// Hotel setting was not found when creating a hotel ads campaign.
MISSING_HOTEL_SETTING = 39;
}
}

View File

@ -0,0 +1,45 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing collection size errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "CollectionSizeErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible collection size errors.
message CollectionSizeErrorEnum {
// Enum describing possible collection size errors.
enum CollectionSizeError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Too few.
TOO_FEW = 2;
// Too many.
TOO_MANY = 3;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing context errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "ContextErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible context errors.
message ContextErrorEnum {
// Enum describing possible context errors.
enum ContextError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// The operation is not allowed for the given context.
OPERATION_NOT_PERMITTED_FOR_CONTEXT = 2;
}
}

View File

@ -0,0 +1,239 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing criterion errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "CriterionErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible criterion errors.
message CriterionErrorEnum {
// Enum describing possible criterion errors.
enum CriterionError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Concrete type of criterion is required for CREATE and UPDATE operations.
CONCRETE_TYPE_REQUIRED = 2;
// The category requested for exclusion is invalid.
INVALID_EXCLUDED_CATEGORY = 3;
// Invalid keyword criteria text.
INVALID_KEYWORD_TEXT = 4;
// Keyword text should be less than 80 chars.
KEYWORD_TEXT_TOO_LONG = 5;
// Keyword text has too many words.
KEYWORD_HAS_TOO_MANY_WORDS = 6;
// Keyword text has invalid characters or symbols.
KEYWORD_HAS_INVALID_CHARS = 7;
// Invalid placement URL.
INVALID_PLACEMENT_URL = 8;
// Invalid user list criterion.
INVALID_USER_LIST = 9;
// Invalid user interest criterion.
INVALID_USER_INTEREST = 10;
// Placement URL has wrong format.
INVALID_FORMAT_FOR_PLACEMENT_URL = 11;
// Placement URL is too long.
PLACEMENT_URL_IS_TOO_LONG = 12;
// Indicates the URL contains an illegal character.
PLACEMENT_URL_HAS_ILLEGAL_CHAR = 13;
// Indicates the URL contains multiple comma separated URLs.
PLACEMENT_URL_HAS_MULTIPLE_SITES_IN_LINE = 14;
// Indicates the domain is blacklisted.
PLACEMENT_IS_NOT_AVAILABLE_FOR_TARGETING_OR_EXCLUSION = 15;
// Invalid vertical path.
INVALID_VERTICAL_PATH = 16;
// The YouTube Channel Id is invalid.
INVALID_YOUTUBE_CHANNEL_ID = 17;
// The YouTube Video Id is invalid.
INVALID_YOUTUBE_VIDEO_ID = 18;
// Indicates the placement is a YouTube vertical channel, which is no longer
// supported.
YOUTUBE_VERTICAL_CHANNEL_DEPRECATED = 19;
// Indicates the placement is a YouTube demographic channel, which is no
// longer supported.
YOUTUBE_DEMOGRAPHIC_CHANNEL_DEPRECATED = 20;
// YouTube urls are not supported in Placement criterion. Use YouTubeChannel
// and YouTubeVideo criterion instead.
YOUTUBE_URL_UNSUPPORTED = 21;
// Criteria type can not be excluded by the customer, like AOL account type
// cannot target site type criteria.
CANNOT_EXCLUDE_CRITERIA_TYPE = 22;
// Criteria type can not be targeted.
CANNOT_ADD_CRITERIA_TYPE = 23;
// Product filter in the product criteria has invalid characters. Operand
// and the argument in the filter can not have "==" or "&+".
INVALID_PRODUCT_FILTER = 24;
// Product filter in the product criteria is translated to a string as
// operand1==argument1&+operand2==argument2, maximum allowed length for the
// string is 255 chars.
PRODUCT_FILTER_TOO_LONG = 25;
// Not allowed to exclude similar user list.
CANNOT_EXCLUDE_SIMILAR_USER_LIST = 26;
// Not allowed to target a closed user list.
CANNOT_ADD_CLOSED_USER_LIST = 27;
// Not allowed to add display only UserLists to search only campaigns.
CANNOT_ADD_DISPLAY_ONLY_LISTS_TO_SEARCH_ONLY_CAMPAIGNS = 28;
// Not allowed to add display only UserLists to search plus campaigns.
CANNOT_ADD_DISPLAY_ONLY_LISTS_TO_SEARCH_CAMPAIGNS = 29;
// Not allowed to add display only UserLists to shopping campaigns.
CANNOT_ADD_DISPLAY_ONLY_LISTS_TO_SHOPPING_CAMPAIGNS = 30;
// Not allowed to add User interests to search only campaigns.
CANNOT_ADD_USER_INTERESTS_TO_SEARCH_CAMPAIGNS = 31;
// Not allowed to set bids for this criterion type in search campaigns
CANNOT_SET_BIDS_ON_CRITERION_TYPE_IN_SEARCH_CAMPAIGNS = 32;
// Final URLs, URL Templates and CustomParameters cannot be set for the
// criterion types of Gender, AgeRange, UserList, Placement, MobileApp, and
// MobileAppCategory in search campaigns and shopping campaigns.
CANNOT_ADD_URLS_TO_CRITERION_TYPE_FOR_CAMPAIGN_TYPE = 33;
// IP address is not valid.
INVALID_IP_ADDRESS = 34;
// IP format is not valid.
INVALID_IP_FORMAT = 35;
// Mobile application is not valid.
INVALID_MOBILE_APP = 36;
// Mobile application category is not valid.
INVALID_MOBILE_APP_CATEGORY = 37;
// The CriterionId does not exist or is of the incorrect type.
INVALID_CRITERION_ID = 38;
// The Criterion is not allowed to be targeted.
CANNOT_TARGET_CRITERION = 39;
// The criterion is not allowed to be targeted as it is deprecated.
CANNOT_TARGET_OBSOLETE_CRITERION = 40;
// The CriterionId is not valid for the type.
CRITERION_ID_AND_TYPE_MISMATCH = 41;
// Distance for the radius for the proximity criterion is invalid.
INVALID_PROXIMITY_RADIUS = 42;
// Units for the distance for the radius for the proximity criterion is
// invalid.
INVALID_PROXIMITY_RADIUS_UNITS = 43;
// Street address is too short.
INVALID_STREETADDRESS_LENGTH = 44;
// City name in the address is too short.
INVALID_CITYNAME_LENGTH = 45;
// Region code in the address is too short.
INVALID_REGIONCODE_LENGTH = 46;
// Region name in the address is not valid.
INVALID_REGIONNAME_LENGTH = 47;
// Postal code in the address is not valid.
INVALID_POSTALCODE_LENGTH = 48;
// Country code in the address is not valid.
INVALID_COUNTRY_CODE = 49;
// Latitude for the GeoPoint is not valid.
INVALID_LATITUDE = 50;
// Longitude for the GeoPoint is not valid.
INVALID_LONGITUDE = 51;
// The Proximity input is not valid. Both address and geoPoint cannot be
// null.
PROXIMITY_GEOPOINT_AND_ADDRESS_BOTH_CANNOT_BE_NULL = 52;
// The Proximity address cannot be geocoded to a valid lat/long.
INVALID_PROXIMITY_ADDRESS = 53;
// User domain name is not valid.
INVALID_USER_DOMAIN_NAME = 54;
// Length of serialized criterion parameter exceeded size limit.
CRITERION_PARAMETER_TOO_LONG = 55;
// Time interval in the AdSchedule overlaps with another AdSchedule.
AD_SCHEDULE_TIME_INTERVALS_OVERLAP = 56;
// AdSchedule time interval cannot span multiple days.
AD_SCHEDULE_INTERVAL_CANNOT_SPAN_MULTIPLE_DAYS = 57;
// AdSchedule time interval specified is invalid, endTime cannot be earlier
// than startTime.
AD_SCHEDULE_INVALID_TIME_INTERVAL = 58;
// The number of AdSchedule entries in a day exceeds the limit.
AD_SCHEDULE_EXCEEDED_INTERVALS_PER_DAY_LIMIT = 59;
// CriteriaId does not match the interval of the AdSchedule specified.
AD_SCHEDULE_CRITERION_ID_MISMATCHING_FIELDS = 60;
// Cannot set bid modifier for this criterion type.
CANNOT_BID_MODIFY_CRITERION_TYPE = 61;
// Cannot bid modify criterion, since it is opted out of the campaign.
CANNOT_BID_MODIFY_CRITERION_CAMPAIGN_OPTED_OUT = 62;
// Cannot set bid modifier for a negative criterion.
CANNOT_BID_MODIFY_NEGATIVE_CRITERION = 63;
// Bid Modifier already exists. Use SET operation to update.
BID_MODIFIER_ALREADY_EXISTS = 64;
// Feed Id is not allowed in these Location Groups.
FEED_ID_NOT_ALLOWED = 65;
// The account may not use the requested criteria type. For example, some
// accounts are restricted to keywords only.
ACCOUNT_INELIGIBLE_FOR_CRITERIA_TYPE = 66;
// The requested criteria type cannot be used with campaign or ad group
// bidding strategy.
CRITERIA_TYPE_INVALID_FOR_BIDDING_STRATEGY = 67;
// The Criterion is not allowed to be excluded.
CANNOT_EXCLUDE_CRITERION = 68;
// The criterion is not allowed to be removed. For example, we cannot remove
// any of the platform criterion.
CANNOT_REMOVE_CRITERION = 69;
// The combined length of product dimension values of the product scope
// criterion is too long.
PRODUCT_SCOPE_TOO_LONG = 70;
// Product scope contains too many dimensions.
PRODUCT_SCOPE_TOO_MANY_DIMENSIONS = 71;
// The combined length of product dimension values of the product partition
// criterion is too long.
PRODUCT_PARTITION_TOO_LONG = 72;
// Product partition contains too many dimensions.
PRODUCT_PARTITION_TOO_MANY_DIMENSIONS = 73;
// The product dimension is invalid (e.g. dimension contains illegal value,
// dimension type is represented with wrong class, etc). Product dimension
// value can not contain "==" or "&+".
INVALID_PRODUCT_DIMENSION = 74;
// Product dimension type is either invalid for campaigns of this type or
// cannot be used in the current context. BIDDING_CATEGORY_Lx and
// PRODUCT_TYPE_Lx product dimensions must be used in ascending order of
// their levels: L1, L2, L3, L4, L5... The levels must be specified
// sequentially and start from L1. Furthermore, an "others" product
// partition cannot be subdivided with a dimension of the same type but of a
// higher level ("others" BIDDING_CATEGORY_L3 can be subdivided with BRAND
// but not with BIDDING_CATEGORY_L4).
INVALID_PRODUCT_DIMENSION_TYPE = 75;
// Bidding categories do not form a valid path in the Shopping bidding
// category taxonomy.
INVALID_PRODUCT_BIDDING_CATEGORY = 76;
// ShoppingSetting must be added to the campaign before ProductScope
// criteria can be added.
MISSING_SHOPPING_SETTING = 77;
// Matching function is invalid.
INVALID_MATCHING_FUNCTION = 78;
// Filter parameters not allowed for location groups targeting.
LOCATION_FILTER_NOT_ALLOWED = 79;
// Given location filter parameter is invalid for location groups targeting.
LOCATION_FILTER_INVALID = 80;
// Criteria type cannot be associated with a campaign and its ad group(s)
// simultaneously.
CANNOT_ATTACH_CRITERIA_AT_CAMPAIGN_AND_ADGROUP = 81;
// Range represented by hotel length of stay's min nights and max nights
// overlaps with an existing criterion.
HOTEL_LENGTH_OF_STAY_OVERLAPS_WITH_EXISTING_CRITERION = 82;
// Range represented by hotel advance booking window's min days and max days
// overlaps with an existing criterion.
HOTEL_ADVANCE_BOOKING_WINDOW_OVERLAPS_WITH_EXISTING_CRITERION = 83;
// The field is not allowed to be set when the negative field is set to
// true, e.g. we don't allow bids in negative ad group or campaign criteria.
FIELD_INCOMPATIBLE_WITH_NEGATIVE_TARGETING = 84;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing date errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "DateErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible date errors.
message DateErrorEnum {
// Enum describing possible date errors.
enum DateError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Given field values do not correspond to a valid date.
INVALID_FIELD_VALUES_IN_DATE = 2;
// Given field values do not correspond to a valid date time.
INVALID_FIELD_VALUES_IN_DATE_TIME = 3;
// The string date's format should be yyyymmdd.
INVALID_STRING_DATE = 4;
// The string date time's format should be yyyymmdd hhmmss [tz].
INVALID_STRING_DATE_TIME = 6;
// Date is before allowed minimum.
EARLIER_THAN_MINIMUM_DATE = 7;
// Date is after allowed maximum.
LATER_THAN_MAXIMUM_DATE = 8;
// Date range bounds are not in order.
DATE_RANGE_MINIMUM_DATE_LATER_THAN_MAXIMUM_DATE = 9;
// Both dates in range are null.
DATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL = 10;
}
}

View File

@ -0,0 +1,51 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing date range errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "DateRangeErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible date range errors.
message DateRangeErrorEnum {
// Enum describing possible date range errors.
enum DateRangeError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Invalid date.
INVALID_DATE = 2;
// The start date was after the end date.
START_DATE_AFTER_END_DATE = 3;
// Cannot set date to past time
CANNOT_SET_DATE_TO_PAST = 4;
// A date was used that is past the system "last" date.
AFTER_MAXIMUM_ALLOWABLE_DATE = 5;
// Trying to change start date on a campaign that has started.
CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED = 6;
}
}

View File

@ -0,0 +1,45 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing distinct errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "DistinctErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible distinct errors.
message DistinctErrorEnum {
// Enum describing possible distinct errors.
enum DistinctError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Duplicate element.
DUPLICATE_ELEMENT = 2;
// Duplicate type.
DUPLICATE_TYPE = 3;
}
}

View File

@ -0,0 +1,333 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the common error protos
syntax = "proto3";
package google.ads.googleads.v0.errors;
import "google/ads/googleads/v0/common/policy.proto";
import "google/ads/googleads/v0/common/value.proto";
import "google/ads/googleads/v0/errors/ad_customizer_error.proto";
import "google/ads/googleads/v0/errors/ad_error.proto";
import "google/ads/googleads/v0/errors/ad_group_ad_error.proto";
import "google/ads/googleads/v0/errors/ad_group_bid_modifier_error.proto";
import "google/ads/googleads/v0/errors/ad_group_criterion_error.proto";
import "google/ads/googleads/v0/errors/ad_group_error.proto";
import "google/ads/googleads/v0/errors/ad_sharing_error.proto";
import "google/ads/googleads/v0/errors/adx_error.proto";
import "google/ads/googleads/v0/errors/authentication_error.proto";
import "google/ads/googleads/v0/errors/authorization_error.proto";
import "google/ads/googleads/v0/errors/bidding_error.proto";
import "google/ads/googleads/v0/errors/bidding_strategy_error.proto";
import "google/ads/googleads/v0/errors/campaign_budget_error.proto";
import "google/ads/googleads/v0/errors/campaign_criterion_error.proto";
import "google/ads/googleads/v0/errors/campaign_error.proto";
import "google/ads/googleads/v0/errors/collection_size_error.proto";
import "google/ads/googleads/v0/errors/context_error.proto";
import "google/ads/googleads/v0/errors/criterion_error.proto";
import "google/ads/googleads/v0/errors/date_error.proto";
import "google/ads/googleads/v0/errors/date_range_error.proto";
import "google/ads/googleads/v0/errors/distinct_error.proto";
import "google/ads/googleads/v0/errors/feed_attribute_reference_error.proto";
import "google/ads/googleads/v0/errors/field_error.proto";
import "google/ads/googleads/v0/errors/field_mask_error.proto";
import "google/ads/googleads/v0/errors/function_error.proto";
import "google/ads/googleads/v0/errors/function_parsing_error.proto";
import "google/ads/googleads/v0/errors/id_error.proto";
import "google/ads/googleads/v0/errors/image_error.proto";
import "google/ads/googleads/v0/errors/internal_error.proto";
import "google/ads/googleads/v0/errors/list_operation_error.proto";
import "google/ads/googleads/v0/errors/media_bundle_error.proto";
import "google/ads/googleads/v0/errors/media_error.proto";
import "google/ads/googleads/v0/errors/multiplier_error.proto";
import "google/ads/googleads/v0/errors/mutate_error.proto";
import "google/ads/googleads/v0/errors/new_resource_creation_error.proto";
import "google/ads/googleads/v0/errors/not_empty_error.proto";
import "google/ads/googleads/v0/errors/null_error.proto";
import "google/ads/googleads/v0/errors/operation_access_denied_error.proto";
import "google/ads/googleads/v0/errors/operator_error.proto";
import "google/ads/googleads/v0/errors/query_error.proto";
import "google/ads/googleads/v0/errors/quota_error.proto";
import "google/ads/googleads/v0/errors/range_error.proto";
import "google/ads/googleads/v0/errors/recommendation_error.proto";
import "google/ads/googleads/v0/errors/region_code_error.proto";
import "google/ads/googleads/v0/errors/request_error.proto";
import "google/ads/googleads/v0/errors/resource_access_denied_error.proto";
import
"google/ads/googleads/v0/errors/resource_count_limit_exceeded_error.proto";
import "google/ads/googleads/v0/errors/setting_error.proto";
import "google/ads/googleads/v0/errors/string_format_error.proto";
import "google/ads/googleads/v0/errors/string_length_error.proto";
import "google/ads/googleads/v0/errors/url_field_error.proto";
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "ErrorsProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Describes how a GoogleAds API call failed. It's returned inside
// google.rpc.Status.details when a call fails.
message GoogleAdsFailure {
// The list of errors that occurred.
repeated GoogleAdsError errors = 1;
}
// GoogleAds-specific error.
message GoogleAdsError {
// An enum value that indicates which error occurred.
ErrorCode error_code = 1;
// A human-readable description of the error.
string message = 2;
// The value that triggered the error.
common.Value trigger = 3;
// Describes the part of the request proto that caused the error.
ErrorLocation location = 4;
// Additional error details, which are returned by certain error codes. Most
// error codes do not include details.
ErrorDetails details = 5;
}
// The error reason represented by type and enum.
message ErrorCode {
// The list of error enums
oneof error_code {
// An error caused by the request
RequestErrorEnum.RequestError request_error = 1;
// An error with a Bidding Strategy mutate.
BiddingStrategyErrorEnum.BiddingStrategyError bidding_strategy_error = 2;
// An error with a URL field mutate.
UrlFieldErrorEnum.UrlFieldError url_field_error = 3;
// An error with a list operation.
ListOperationErrorEnum.ListOperationError list_operation_error = 4;
// An error with an AWQL query
QueryErrorEnum.QueryError query_error = 5;
// An error with a mutate
MutateErrorEnum.MutateError mutate_error = 7;
// An error with a field mask
FieldMaskErrorEnum.FieldMaskError field_mask_error = 8;
// An error encountered when trying to authorize a user.
AuthorizationErrorEnum.AuthorizationError authorization_error = 9;
// An unexpected server-side error.
InternalErrorEnum.InternalError internal_error = 10;
// An error with the amonut of quota remaining.
QuotaErrorEnum.QuotaError quota_error = 11;
// An error with an Ad Group Ad mutate.
AdErrorEnum.AdError ad_error = 12;
// An error with an Ad Group mutate.
AdGroupErrorEnum.AdGroupError ad_group_error = 13;
// An error with a Campaign Budget mutate.
CampaignBudgetErrorEnum.CampaignBudgetError campaign_budget_error = 14;
// An error with a Campaign mutate.
CampaignErrorEnum.CampaignError campaign_error = 15;
// Indicates failure to properly authenticate user.
AuthenticationErrorEnum.AuthenticationError authentication_error = 17;
// Indicates failure to properly authenticate user.
AdGroupCriterionErrorEnum.AdGroupCriterionError ad_group_criterion_error =
18;
// The reasons for the ad customizer error
AdCustomizerErrorEnum.AdCustomizerError ad_customizer_error = 19;
// The reasons for the ad group ad error
AdGroupAdErrorEnum.AdGroupAdError ad_group_ad_error = 21;
// The reasons for the ad sharing error
AdSharingErrorEnum.AdSharingError ad_sharing_error = 24;
// The reasons for the adx error
AdxErrorEnum.AdxError adx_error = 25;
// The reasons for the bidding errors
BiddingErrorEnum.BiddingError bidding_error = 26;
// The reasons for the campaign criterion error
CampaignCriterionErrorEnum.CampaignCriterionError campaign_criterion_error =
29;
// The reasons for the collection size error
CollectionSizeErrorEnum.CollectionSizeError collection_size_error = 31;
// The reasons for the criterion error
CriterionErrorEnum.CriterionError criterion_error = 32;
// The reasons for the date error
DateErrorEnum.DateError date_error = 33;
// The reasons for the date range error
DateRangeErrorEnum.DateRangeError date_range_error = 34;
// The reasons for the distinct error
DistinctErrorEnum.DistinctError distinct_error = 35;
// The reasons for the feed attribute reference error
FeedAttributeReferenceErrorEnum.FeedAttributeReferenceError
feed_attribute_reference_error = 36;
// The reasons for the function error
FunctionErrorEnum.FunctionError function_error = 37;
// The reasons for the function parsing error
FunctionParsingErrorEnum.FunctionParsingError function_parsing_error = 38;
// The reasons for the id error
IdErrorEnum.IdError id_error = 39;
// The reasons for the image error
ImageErrorEnum.ImageError image_error = 40;
// The reasons for the media bundle error
MediaBundleErrorEnum.MediaBundleError media_bundle_error = 42;
// The reasons for the media error
MediaErrorEnum.MediaError media_error = 43;
// The reasons for the multiplier error
MultiplierErrorEnum.MultiplierError multiplier_error = 44;
// The reasons for the new resource creation error
NewResourceCreationErrorEnum.NewResourceCreationError
new_resource_creation_error = 45;
// The reasons for the not empty error
NotEmptyErrorEnum.NotEmptyError not_empty_error = 46;
// The reasons for the null error
NullErrorEnum.NullError null_error = 47;
// The reasons for the operator error
OperatorErrorEnum.OperatorError operator_error = 48;
// The reasons for the range error
RangeErrorEnum.RangeError range_error = 49;
// The reasons for error in applying a recommendation
RecommendationErrorEnum.RecommendationError recommendation_error = 58;
// The reasons for the region code error
RegionCodeErrorEnum.RegionCodeError region_code_error = 51;
// The reasons for the setting error
SettingErrorEnum.SettingError setting_error = 52;
// The reasons for the string format error
StringFormatErrorEnum.StringFormatError string_format_error = 53;
// The reasons for the string length error
StringLengthErrorEnum.StringLengthError string_length_error = 54;
// The reasons for the operation access denied error
OperationAccessDeniedErrorEnum.OperationAccessDeniedError
operation_access_denied_error = 55;
// The reasons for the resource access denied error
ResourceAccessDeniedErrorEnum.ResourceAccessDeniedError
resource_access_denied_error = 56;
// The reasons for the resource count limit exceeded error
ResourceCountLimitExceededErrorEnum.ResourceCountLimitExceededError
resource_count_limit_exceeded_error = 57;
// The reasons for the ad group bid modifier error
AdGroupBidModifierErrorEnum.AdGroupBidModifierError
ad_group_bid_modifier_error = 59;
// The reasons for the context error
ContextErrorEnum.ContextError context_error = 60;
// The reasons for the field error
FieldErrorEnum.FieldError field_error = 61;
}
}
// Describes the part of the request proto that caused the error.
message ErrorLocation {
// The mutate operation that failed
google.protobuf.Int64Value operation_index = 1;
// A field path that indicates which field was invalid in the resource being
// mutated.
repeated FieldPathElement field_path_elements = 2;
// A part of a field path.
message FieldPathElement {
// The name of a field
string field_name = 1;
// If field_name is a list, this is the element that failed
google.protobuf.Int64Value index = 2;
}
}
// Additional error details.
message ErrorDetails {
// The error code that should have been returned, but wasn't. This is used
// when the error code is InternalError.ERROR_CODE_NOT_PUBLISHED.
string unpublished_error_code = 1;
// Describes an ad policy violation.
PolicyViolationDetails policy_violation_details = 2;
}
// Error returned as part of a mutate response.
// This error indicates single policy violation by some text
// in one of the fields.
message PolicyViolationDetails {
// Human readable description of policy violation.
string external_policy_description = 2;
// Unique identifier for this violation.
// If policy is exemptible, this key may be used to request exemption.
common.PolicyViolationKey key = 4;
// Human readable name of the policy.
string external_policy_name = 5;
// Whether user can file an exemption request for this violation.
bool is_exemptible = 6;
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing feed attribute reference errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "FeedAttributeReferenceErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible feed attribute reference errors.
message FeedAttributeReferenceErrorEnum {
// Enum describing possible feed attribute reference errors.
enum FeedAttributeReferenceError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// A feed referenced by ID has been deleted.
CANNOT_REFERENCE_DELETED_FEED = 2;
// There is no active feed with the given name.
INVALID_FEED_NAME = 3;
// There is no feed attribute in an active feed with the given name.
INVALID_FEED_ATTRIBUTE_NAME = 4;
}
}

View File

@ -0,0 +1,51 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing field errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "FieldErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible field errors.
message FieldErrorEnum {
// Enum describing possible field errors.
enum FieldError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// The required field was not present in the resource.
REQUIRED = 2;
// The field attempted to be mutated is immutable.
IMMUTABLE_FIELD = 3;
// The field's value is invalid.
INVALID_VALUE = 4;
// The field cannot be set.
VALUE_MUST_BE_UNSET = 5;
// The required repeated field was empty.
REQUIRED_NONEMPTY_LIST = 6;
}
}

View File

@ -0,0 +1,51 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing field mask errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "FieldMaskErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible field mask errors.
message FieldMaskErrorEnum {
// Enum describing possible field mask errors.
enum FieldMaskError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// The field mask must be provided for update operations.
FIELD_MASK_MISSING = 5;
// The field mask must be empty for create and remove operations.
FIELD_MASK_NOT_ALLOWED = 4;
// The field mask contained an invalid field.
FIELD_NOT_FOUND = 2;
// The field mask updated a field with subfields. Fields with subfields may
// be cleared, but not updated. To fix this, the field mask should select
// all the subfields of the invalid field.
FIELD_HAS_SUBFIELDS = 3;
}
}

View File

@ -0,0 +1,74 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing function errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "FunctionErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible function errors.
message FunctionErrorEnum {
// Enum describing possible function errors.
enum FunctionError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// The format of the function is not recognized as a supported function
// format.
INVALID_FUNCTION_FORMAT = 2;
// Operand data types do not match.
DATA_TYPE_MISMATCH = 3;
// The operands cannot be used together in a conjunction.
INVALID_CONJUNCTION_OPERANDS = 4;
// Invalid numer of Operands.
INVALID_NUMBER_OF_OPERANDS = 5;
// Operand Type not supported.
INVALID_OPERAND_TYPE = 6;
// Operator not supported.
INVALID_OPERATOR = 7;
// Request context type not supported.
INVALID_REQUEST_CONTEXT_TYPE = 8;
// The matching function is not allowed for call placeholders
INVALID_FUNCTION_FOR_CALL_PLACEHOLDER = 9;
// The matching function is not allowed for the specified placeholder
INVALID_FUNCTION_FOR_PLACEHOLDER = 10;
// Invalid operand.
INVALID_OPERAND = 11;
// Missing value for the constant operand.
MISSING_CONSTANT_OPERAND_VALUE = 12;
// The value of the constant operand is invalid.
INVALID_CONSTANT_OPERAND_VALUE = 13;
// Invalid function nesting.
INVALID_NESTING = 14;
// The Feed ID was different from another Feed ID in the same function.
MULTIPLE_FEED_IDS_NOT_SUPPORTED = 15;
// The matching function is invalid for use with a feed with a fixed schema.
INVALID_FUNCTION_FOR_FEED_WITH_FIXED_SCHEMA = 16;
// Invalid attribute name.
INVALID_ATTRIBUTE_NAME = 17;
}
}

View File

@ -0,0 +1,63 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing function parsing errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "FunctionParsingErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible function parsing errors.
message FunctionParsingErrorEnum {
// Enum describing possible function parsing errors.
enum FunctionParsingError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Unexpected end of function string.
NO_MORE_INPUT = 2;
// Could not find an expected character.
EXPECTED_CHARACTER = 3;
// Unexpected separator character.
UNEXPECTED_SEPARATOR = 4;
// Unmatched left bracket or parenthesis.
UNMATCHED_LEFT_BRACKET = 5;
// Unmatched right bracket or parenthesis.
UNMATCHED_RIGHT_BRACKET = 6;
// Functions are nested too deeply.
TOO_MANY_NESTED_FUNCTIONS = 7;
// Missing right-hand-side operand.
MISSING_RIGHT_HAND_OPERAND = 8;
// Invalid operator/function name.
INVALID_OPERATOR_NAME = 9;
// Feed attribute operand's argument is not an integer.
FEED_ATTRIBUTE_OPERAND_ARGUMENT_NOT_INTEGER = 10;
// Missing function operands.
NO_OPERANDS = 11;
// Function had too many operands.
TOO_MANY_OPERANDS = 12;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing id errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "IdErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible id errors.
message IdErrorEnum {
// Enum describing possible id errors.
enum IdError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Id not found
NOT_FOUND = 2;
}
}

View File

@ -0,0 +1,116 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing image errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "ImageErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible image errors.
message ImageErrorEnum {
// Enum describing possible image errors.
enum ImageError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// The image is not valid.
INVALID_IMAGE = 2;
// The image could not be stored.
STORAGE_ERROR = 3;
// There was a problem with the request.
BAD_REQUEST = 4;
// The image is not of legal dimensions.
UNEXPECTED_SIZE = 5;
// Animated image are not permitted.
ANIMATED_NOT_ALLOWED = 6;
// Animation is too long.
ANIMATION_TOO_LONG = 7;
// There was an error on the server.
SERVER_ERROR = 8;
// Image cannot be in CMYK color format.
CMYK_JPEG_NOT_ALLOWED = 9;
// Flash images are not permitted.
FLASH_NOT_ALLOWED = 10;
// Flash images must support clickTag.
FLASH_WITHOUT_CLICKTAG = 11;
// A flash error has occurred after fixing the click tag.
FLASH_ERROR_AFTER_FIXING_CLICK_TAG = 12;
// Unacceptable visual effects.
ANIMATED_VISUAL_EFFECT = 13;
// There was a problem with the flash image.
FLASH_ERROR = 14;
// Incorrect image layout.
LAYOUT_PROBLEM = 15;
// There was a problem reading the image file.
PROBLEM_READING_IMAGE_FILE = 16;
// There was an error storing the image.
ERROR_STORING_IMAGE = 17;
// The aspect ratio of the image is not allowed.
ASPECT_RATIO_NOT_ALLOWED = 18;
// Flash cannot have network objects.
FLASH_HAS_NETWORK_OBJECTS = 19;
// Flash cannot have network methods.
FLASH_HAS_NETWORK_METHODS = 20;
// Flash cannot have a Url.
FLASH_HAS_URL = 21;
// Flash cannot use mouse tracking.
FLASH_HAS_MOUSE_TRACKING = 22;
// Flash cannot have a random number.
FLASH_HAS_RANDOM_NUM = 23;
// Ad click target cannot be '_self'.
FLASH_SELF_TARGETS = 24;
// GetUrl method should only use '_blank'.
FLASH_BAD_GETURL_TARGET = 25;
// Flash version is not supported.
FLASH_VERSION_NOT_SUPPORTED = 26;
// Flash movies need to have hard coded click URL or clickTAG
FLASH_WITHOUT_HARD_CODED_CLICK_URL = 27;
// Uploaded flash file is corrupted.
INVALID_FLASH_FILE = 28;
// Uploaded flash file can be parsed, but the click tag can not be fixed
// properly.
FAILED_TO_FIX_CLICK_TAG_IN_FLASH = 29;
// Flash movie accesses network resources
FLASH_ACCESSES_NETWORK_RESOURCES = 30;
// Flash movie attempts to call external javascript code
FLASH_EXTERNAL_JS_CALL = 31;
// Flash movie attempts to call flash system commands
FLASH_EXTERNAL_FS_CALL = 32;
// Image file is too large.
FILE_TOO_LARGE = 33;
// Image data is too large.
IMAGE_DATA_TOO_LARGE = 34;
// Error while processing the image.
IMAGE_PROCESSING_ERROR = 35;
// Image is too small.
IMAGE_TOO_SMALL = 36;
// Input was invalid.
INVALID_INPUT = 37;
// There was a problem reading the image file.
PROBLEM_READING_FILE = 38;
}
}

View File

@ -0,0 +1,49 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing internal errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "InternalErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible internal errors.
message InternalErrorEnum {
// Enum describing possible internal errors.
enum InternalError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Google Ads API encountered unexpected internal error.
INTERNAL_ERROR = 2;
// The intended error code doesn't exist in any API version. This will be
// fixed by adding a new error code as soon as possible.
ERROR_CODE_NOT_PUBLISHED = 3;
// Google Ads API encountered an unexpected transient error. The user
// should retry their request in these cases.
TRANSIENT_ERROR = 4;
}
}

View File

@ -0,0 +1,45 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing list operation errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "ListOperationErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible list operation errors.
message ListOperationErrorEnum {
// Enum describing possible list operation errors.
enum ListOperationError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Field required in value is missing.
REQUIRED_FIELD_MISSING = 7;
// Duplicate or identical value is sent in multiple list operations.
DUPLICATE_VALUES = 8;
}
}

View File

@ -0,0 +1,85 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing media bundle errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "MediaBundleErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible media bundle errors.
message MediaBundleErrorEnum {
// Enum describing possible media bundle errors.
enum MediaBundleError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// There was a problem with the request.
BAD_REQUEST = 3;
// HTML5 ads using DoubleClick Studio created ZIP files are not supported.
DOUBLECLICK_BUNDLE_NOT_ALLOWED = 4;
// Cannot reference URL external to the media bundle.
EXTERNAL_URL_NOT_ALLOWED = 5;
// Media bundle file is too large.
FILE_TOO_LARGE = 6;
// ZIP file from Google Web Designer is not published.
GOOGLE_WEB_DESIGNER_ZIP_FILE_NOT_PUBLISHED = 7;
// Input was invalid.
INVALID_INPUT = 8;
// There was a problem with the media bundle.
INVALID_MEDIA_BUNDLE = 9;
// There was a problem with one or more of the media bundle entries.
INVALID_MEDIA_BUNDLE_ENTRY = 10;
// The media bundle contains a file with an unknown mime type
INVALID_MIME_TYPE = 11;
// The media bundle contain an invalid asset path.
INVALID_PATH = 12;
// HTML5 ad is trying to reference an asset not in .ZIP file
INVALID_URL_REFERENCE = 13;
// Media data is too large.
MEDIA_DATA_TOO_LARGE = 14;
// The media bundle contains no primary entry.
MISSING_PRIMARY_MEDIA_BUNDLE_ENTRY = 15;
// There was an error on the server.
SERVER_ERROR = 16;
// The image could not be stored.
STORAGE_ERROR = 17;
// Media bundle created with the Swiffy tool is not allowed.
SWIFFY_BUNDLE_NOT_ALLOWED = 18;
// The media bundle contains too many files.
TOO_MANY_FILES = 19;
// The media bundle is not of legal dimensions.
UNEXPECTED_SIZE = 20;
// Google Web Designer not created for "AdWords" environment.
UNSUPPORTED_GOOGLE_WEB_DESIGNER_ENVIRONMENT = 21;
// Unsupported HTML5 feature in HTML5 asset.
UNSUPPORTED_HTML5_FEATURE = 22;
// URL in HTML5 entry is not ssl compliant.
URL_IN_MEDIA_BUNDLE_NOT_SSL_COMPLIANT = 23;
// Custom exits not allowed in HTML5 entry.
CUSTOM_EXIT_NOT_ALLOWED = 24;
}
}

View File

@ -0,0 +1,90 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing media errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "MediaErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible media errors.
message MediaErrorEnum {
// Enum describing possible media errors.
enum MediaError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Cannot add a standard icon type
CANNOT_ADD_STANDARD_ICON = 2;
// May only select Standard Icons alone
CANNOT_SELECT_STANDARD_ICON_WITH_OTHER_TYPES = 3;
// Image contains both a media ID and media data.
CANNOT_SPECIFY_MEDIA_ID_AND_DATA = 4;
// A media with given type and reference id already exists
DUPLICATE_MEDIA = 5;
// A required field was not specified or is an empty string.
EMPTY_FIELD = 6;
// A media may only be modified once per call
RESOURCE_REFERENCED_IN_MULTIPLE_OPS = 7;
// Field is not supported for the media sub type.
FIELD_NOT_SUPPORTED_FOR_MEDIA_SUB_TYPE = 8;
// The media id is invalid
INVALID_MEDIA_ID = 9;
// The media subtype is invalid
INVALID_MEDIA_SUB_TYPE = 10;
// The media type is invalid
INVALID_MEDIA_TYPE = 11;
// The mimetype is invalid
INVALID_MIME_TYPE = 12;
// The media reference id is invalid
INVALID_REFERENCE_ID = 13;
// The YouTube video id is invalid
INVALID_YOU_TUBE_ID = 14;
// Media has failed transcoding
MEDIA_FAILED_TRANSCODING = 15;
// Media has not been transcoded
MEDIA_NOT_TRANSCODED = 16;
// The MediaType does not match the actual media object's type
MEDIA_TYPE_DOES_NOT_MATCH_OBJECT_TYPE = 17;
// None of the fields have been specified.
NO_FIELDS_SPECIFIED = 18;
// One of reference Id or media Id must be specified
NULL_REFERENCE_ID_AND_MEDIA_ID = 19;
// The string has too many characters.
TOO_LONG = 20;
// The specified operation is not supported. Only ADD, SET, and REMOVE are
// supported
UNSUPPORTED_OPERATION = 21;
// The specified type is not supported.
UNSUPPORTED_TYPE = 22;
// YouTube is unavailable for requesting video data.
YOU_TUBE_SERVICE_UNAVAILABLE = 23;
// The YouTube video has a non positive duration.
YOU_TUBE_VIDEO_HAS_NON_POSITIVE_DURATION = 24;
// The YouTube video id is syntactically valid but the video was not found.
YOU_TUBE_VIDEO_NOT_FOUND = 25;
}
}

View File

@ -0,0 +1,66 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing multiplier errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "MultiplierErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible multiplier errors.
message MultiplierErrorEnum {
// Enum describing possible multiplier errors.
enum MultiplierError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Multiplier value is too high
MULTIPLIER_TOO_HIGH = 2;
// Multiplier value is too low
MULTIPLIER_TOO_LOW = 3;
// Too many fractional digits
TOO_MANY_FRACTIONAL_DIGITS = 4;
// A multiplier cannot be set for this bidding strategy
MULTIPLIER_NOT_ALLOWED_FOR_BIDDING_STRATEGY = 5;
// A multiplier cannot be set when there is no base bid (e.g., content max
// cpc)
MULTIPLIER_NOT_ALLOWED_WHEN_BASE_BID_IS_MISSING = 6;
// A bid multiplier must be specified
NO_MULTIPLIER_SPECIFIED = 7;
// Multiplier causes bid to exceed daily budget
MULTIPLIER_CAUSES_BID_TO_EXCEED_DAILY_BUDGET = 8;
// Multiplier causes bid to exceed monthly budget
MULTIPLIER_CAUSES_BID_TO_EXCEED_MONTHLY_BUDGET = 9;
// Multiplier causes bid to exceed custom budget
MULTIPLIER_CAUSES_BID_TO_EXCEED_CUSTOM_BUDGET = 10;
// Multiplier causes bid to exceed maximum allowed bid
MULTIPLIER_CAUSES_BID_TO_EXCEED_MAX_ALLOWED_BID = 11;
// Multiplier causes bid to become less than the minimum bid allowed
BID_LESS_THAN_MIN_ALLOWED_BID_WITH_MULTIPLIER = 12;
// Multiplier type (cpc vs. cpm) needs to match campaign's bidding strategy
MULTIPLIER_AND_BIDDING_STRATEGY_TYPE_MISMATCH = 13;
}
}

View File

@ -0,0 +1,45 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing mutate errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "MutateErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible mutate errors.
message MutateErrorEnum {
// Enum describing possible mutate errors.
enum MutateError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Requested resource was not found.
RESOURCE_NOT_FOUND = 3;
// Cannot mutate the same resource twice in one request.
ID_EXISTS_IN_MULTIPLE_MUTATES = 7;
}
}

View File

@ -0,0 +1,48 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing new resource creation errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "NewResourceCreationErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible new resource creation errors.
message NewResourceCreationErrorEnum {
// Enum describing possible new resource creation errors.
enum NewResourceCreationError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Do not set the id field while creating new entities.
CANNOT_SET_ID_FOR_ADD = 2;
// Creating more than one resource with the same temp ID is not allowed.
DUPLICATE_TEMP_IDS = 3;
// Parent object with specified temp id failed validation, so no deep
// validation will be done for this child resource.
TEMP_ID_RESOURCE_HAD_ERRORS = 4;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing not empty errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "NotEmptyErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible not empty errors.
message NotEmptyErrorEnum {
// Enum describing possible not empty errors.
enum NotEmptyError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Empty list.
EMPTY_LIST = 2;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing null errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "NullErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible null errors.
message NullErrorEnum {
// Enum describing possible null errors.
enum NullError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Specified list/container must not contain any null elements
NULL_CONTENT = 2;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing operation access denied errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "OperationAccessDeniedErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible operation access denied errors.
message OperationAccessDeniedErrorEnum {
// Enum describing possible operation access denied errors.
enum OperationAccessDeniedError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Unauthorized invocation of a service's method (get, mutate, etc.)
ACTION_NOT_PERMITTED = 2;
// Unauthorized CREATE operation in invoking a service's mutate method.
CREATE_OPERATION_NOT_PERMITTED = 3;
// Unauthorized REMOVE operation in invoking a service's mutate method.
REMOVE_OPERATION_NOT_PERMITTED = 4;
// Unauthorized UPDATE operation in invoking a service's mutate method.
UPDATE_OPERATION_NOT_PERMITTED = 5;
// A mutate action is not allowed on this campaign, from this client.
MUTATE_ACTION_NOT_PERMITTED_FOR_CLIENT = 6;
// This operation is not permitted on this campaign type
OPERATION_NOT_PERMITTED_FOR_CAMPAIGN_TYPE = 7;
// A CREATE operation may not set status to REMOVED.
CREATE_AS_REMOVED_NOT_PERMITTED = 8;
// This operation is not allowed because the campaign or adgroup is removed.
OPERATION_NOT_PERMITTED_FOR_REMOVED_RESOURCE = 9;
// This operation is not permitted on this ad group type.
OPERATION_NOT_PERMITTED_FOR_AD_GROUP_TYPE = 10;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing operator errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "OperatorErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible operator errors.
message OperatorErrorEnum {
// Enum describing possible operator errors.
enum OperatorError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Operator not supported.
OPERATOR_NOT_SUPPORTED = 2;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing query errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "QueryErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible query errors.
message QueryErrorEnum {
// Enum describing possible query errors.
enum QueryError {
// Name unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Returned if all other query error reasons are not applicable.
QUERY_ERROR = 50;
// A condition used in the query references an invalid enum constant.
BAD_ENUM_CONSTANT = 18;
// Query contains an invalid escape sequence.
BAD_ESCAPE_SEQUENCE = 7;
// Field name is invalid.
BAD_FIELD_NAME = 12;
// Limit value is invalid (i.e. not a number)
BAD_LIMIT_VALUE = 15;
// Encountered number can not be parsed.
BAD_NUMBER = 5;
// Invalid operator encountered.
BAD_OPERATOR = 3;
// Invalid resource type was specified in the FROM clause.
BAD_RESOURCE_TYPE_IN_FROM_CLAUSE = 45;
// Non-ASCII symbol encountered outside of strings.
BAD_SYMBOL = 2;
// Value is invalid.
BAD_VALUE = 4;
// Date filters fail to restrict date to a range smaller than 31 days.
// Applicable if the query is segmented by date.
DATE_RANGE_TOO_WIDE = 36;
// Expected AND between values with BETWEEN operator.
EXPECTED_AND = 30;
// Expecting ORDER BY to have BY.
EXPECTED_BY = 14;
// There was no dimension field selected.
EXPECTED_DIMENSION_FIELD_IN_SELECT_CLAUSE = 37;
// Missing filters on date related fields.
EXPECTED_FILTERS_ON_DATE_RANGE = 55;
// Missing FROM clause.
EXPECTED_FROM = 44;
// The operator used in the conditions requires the value to be a list.
EXPECTED_LIST = 41;
// Fields used in WHERE or ORDER BY clauses are missing from the SELECT
// clause.
EXPECTED_REFERENCED_FIELD_IN_SELECT_CLAUSE = 16;
// SELECT is missing at the beginning of query.
EXPECTED_SELECT = 13;
// A list was passed as a value to a condition whose operator expects a
// single value.
EXPECTED_SINGLE_VALUE = 42;
// Missing one or both values with BETWEEN operator.
EXPECTED_VALUE_WITH_BETWEEN_OPERATOR = 29;
// Invalid date format. Expected 'YYYY-MM-DD'.
INVALID_DATE_FORMAT = 38;
// Value passed was not a string when it should have been. I.e., it was a
// number or unquoted literal.
INVALID_STRING_VALUE = 57;
// A String value passed to the BETWEEN operator does not parse as a date.
INVALID_VALUE_WITH_BETWEEN_OPERATOR = 26;
// The value passed to the DURING operator is not a Date range literal
INVALID_VALUE_WITH_DURING_OPERATOR = 22;
// A non-string value was passed to the LIKE operator.
INVALID_VALUE_WITH_LIKE_OPERATOR = 56;
// An operator was provided that is inapplicable to the field being
// filtered.
OPERATOR_FIELD_MISMATCH = 35;
// A Condition was found with an empty list.
PROHIBITED_EMPTY_LIST_IN_CONDITION = 28;
// A condition used in the query references an unsupported enum constant.
PROHIBITED_ENUM_CONSTANT = 54;
// Fields that are not allowed to be selected together were included in
// the SELECT clause.
PROHIBITED_FIELD_COMBINATION_IN_SELECT_CLAUSE = 31;
// A field that is not orderable was included in the ORDER BY clause.
PROHIBITED_FIELD_IN_ORDER_BY_CLAUSE = 40;
// A field that is not selectable was included in the SELECT clause.
PROHIBITED_FIELD_IN_SELECT_CLAUSE = 23;
// A field that is not filterable was included in the WHERE clause.
PROHIBITED_FIELD_IN_WHERE_CLAUSE = 24;
// Resource type specified in the FROM clause is not supported by this
// service.
PROHIBITED_RESOURCE_TYPE_IN_FROM_CLAUSE = 43;
// A field that comes from an incompatible resource was included in the
// SELECT clause.
PROHIBITED_RESOURCE_TYPE_IN_SELECT_CLAUSE = 48;
// A metric incompatible with the main resource or other selected
// segmenting resources was included in the SELECT or WHERE clause.
PROHIBITED_METRIC_IN_SELECT_OR_WHERE_CLAUSE = 49;
// A segment incompatible with the main resource or other selected
// segmenting resources was included in the SELECT or WHERE clause.
PROHIBITED_SEGMENT_IN_SELECT_OR_WHERE_CLAUSE = 51;
// A segment in the SELECT clause is incompatible with a metric in the
// SELECT or WHERE clause.
PROHIBITED_SEGMENT_WITH_METRIC_IN_SELECT_OR_WHERE_CLAUSE = 53;
// The value passed to the limit clause is too low.
LIMIT_VALUE_TOO_LOW = 25;
// Query has a string containing a newline character.
PROHIBITED_NEWLINE_IN_STRING = 8;
// List contains values of different types.
PROHIBITED_VALUE_COMBINATION_IN_LIST = 10;
// The values passed to the BETWEEN operator are not of the same type.
PROHIBITED_VALUE_COMBINATION_WITH_BETWEEN_OPERATOR = 21;
// Query contains unterminated string.
STRING_NOT_TERMINATED = 6;
// Too many segments are specified in SELECT clause.
TOO_MANY_SEGMENTS = 34;
// Query is incomplete and cannot be parsed.
UNEXPECTED_END_OF_QUERY = 9;
// FROM clause cannot be specified in this query.
UNEXPECTED_FROM_CLAUSE = 47;
// Query contains one or more unrecognized fields.
UNRECOGNIZED_FIELD = 32;
// Query has an unexpected extra part.
UNEXPECTED_INPUT = 11;
}
}

View File

@ -0,0 +1,45 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing quota errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "QuotaErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible quota errors.
message QuotaErrorEnum {
// Enum describing possible quota errors.
enum QuotaError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Too many requests.
RESOURCE_EXHAUSTED = 2;
// Access is prohibited.
ACCESS_PROHIBITED = 3;
}
}

View File

@ -0,0 +1,45 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing range errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "RangeErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible range errors.
message RangeErrorEnum {
// Enum describing possible range errors.
enum RangeError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Too low.
TOO_LOW = 2;
// Too high.
TOO_HIGH = 3;
}
}

View File

@ -0,0 +1,56 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing errors from applying a recommendation.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "RecommendationErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible errors from applying a recommendation.
message RecommendationErrorEnum {
// Enum describing possible errors from applying a recommendation.
enum RecommendationError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// The specified budget amount is too low e.g. lower than minimum currency
// unit or lower than ad group minimum cost-per-click.
BUDGET_AMOUNT_TOO_SMALL = 2;
// The specified budget amount is too large.
BUDGET_AMOUNT_TOO_LARGE = 3;
// The specified budget amount is not a valid amount. e.g. not a multiple
// of minimum currency unit.
INVALID_BUDGET_AMOUNT = 4;
// The specified keyword or ad violates ad policy.
POLICY_ERROR = 5;
// The specified bid amount is not valid. e.g. too many fractional digits,
// or negative amount.
INVALID_BID_AMOUNT = 6;
// The number of keywords in ad group have reached the maximum allowed.
ADGROUP_KEYWORD_LIMIT = 7;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing region code errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "RegionCodeErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible region code errors.
message RegionCodeErrorEnum {
// Enum describing possible region code errors.
enum RegionCodeError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Invalid region code.
INVALID_REGION_CODE = 2;
}
}

View File

@ -0,0 +1,74 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing request errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "RequestErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible request errors.
message RequestErrorEnum {
// Enum describing possible request errors.
enum RequestError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Resource name is required for this request.
RESOURCE_NAME_MISSING = 3;
// Resource name provided is malformed.
RESOURCE_NAME_MALFORMED = 4;
// Resource name provided is malformed.
BAD_RESOURCE_ID = 17;
// Customer ID is invalid.
INVALID_CUSTOMER_ID = 16;
// Mutate operation should have either create, update, or remove specified.
OPERATION_REQUIRED = 5;
// Requested resource not found.
RESOURCE_NOT_FOUND = 6;
// Next page token specified in user request is invalid.
INVALID_PAGE_TOKEN = 7;
// Next page token specified in user request has expired.
EXPIRED_PAGE_TOKEN = 8;
// Required field is missing.
REQUIRED_FIELD_MISSING = 9;
// The field cannot be modified because it's immutable. It's also possible
// that the field can be modified using 'create' operation but not 'update'.
IMMUTABLE_FIELD = 11;
// Received too many entries in request.
TOO_MANY_MUTATE_OPERATIONS = 13;
// Request cannot be executed by a manager account.
CANNOT_BE_EXECUTED_BY_MANAGER_ACCOUNT = 14;
// Mutate request was attempting to modify a readonly field.
// For instance, Budget fields can be requested for Ad Group,
// but are read-only for adGroups:mutate.
CANNOT_MODIFY_FOREIGN_FIELD = 15;
// Enum value is not permitted.
INVALID_ENUM_VALUE = 18;
// The developer-token parameter is required for all requests.
DEVELOPER_TOKEN_PARAMETER_MISSING = 19;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing resource access denied errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "ResourceAccessDeniedErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible resource access denied errors.
message ResourceAccessDeniedErrorEnum {
// Enum describing possible resource access denied errors.
enum ResourceAccessDeniedError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// User did not have write access.
WRITE_ACCESS_DENIED = 3;
}
}

View File

@ -0,0 +1,74 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing resource count limit exceeded errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "ResourceCountLimitExceededErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible resource count limit exceeded errors.
message ResourceCountLimitExceededErrorEnum {
// Enum describing possible resource count limit exceeded errors.
enum ResourceCountLimitExceededError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Indicates that this request would exceed the number of allowed resources
// for the AdWords account. The exact resource type and limit being checked
// can be inferred from accountLimitType.
ACCOUNT_LIMIT = 2;
// Indicates that this request would exceed the number of allowed resources
// in a Campaign. The exact resource type and limit being checked can be
// inferred from accountLimitType, and the numeric id of the
// Campaign involved is given by enclosingId.
CAMPAIGN_LIMIT = 3;
// Indicates that this request would exceed the number of allowed resources
// in an ad group. The exact resource type and limit being checked can be
// inferred from accountLimitType, and the numeric id of the
// ad group involved is given by enclosingId.
ADGROUP_LIMIT = 4;
// Indicates that this request would exceed the number of allowed resources
// in an ad group ad. The exact resource type and limit being checked can
// be inferred from accountLimitType, and the enclosingId
// contains the ad group id followed by the ad id, separated by a single
// comma (,).
AD_GROUP_AD_LIMIT = 5;
// Indicates that this request would exceed the number of allowed resources
// in an ad group criterion. The exact resource type and limit being checked
// can be inferred from accountLimitType, and the
// enclosingId contains the ad group id followed by the
// criterion id, separated by a single comma (,).
AD_GROUP_CRITERION_LIMIT = 6;
// Indicates that this request would exceed the number of allowed resources
// in this shared set. The exact resource type and limit being checked can
// be inferred from accountLimitType, and the numeric id of the
// shared set involved is given by enclosingId.
SHARED_SET_LIMIT = 7;
// Exceeds a limit related to a matching function.
MATCHING_FUNCTION_LIMIT = 8;
}
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing setting errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "SettingErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible setting errors.
message SettingErrorEnum {
// Enum describing possible setting errors.
enum SettingError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// The campaign setting is not available for this AdWords account.
SETTING_TYPE_IS_NOT_AVAILABLE = 3;
// The setting is not compatible with the campaign.
SETTING_TYPE_IS_NOT_COMPATIBLE_WITH_CAMPAIGN = 4;
// The supplied TargetingSetting contains an invalid CriterionTypeGroup. See
// CriterionTypeGroup documentation for CriterionTypeGroups allowed
// in Campaign or AdGroup TargetingSettings.
TARGETING_SETTING_CONTAINS_INVALID_CRITERION_TYPE_GROUP = 5;
// TargetingSetting must not explicitly
// set any of the Demographic CriterionTypeGroups (AGE_RANGE, GENDER,
// PARENT, INCOME_RANGE) to false (it's okay to not set them at all, in
// which case the system will set them to true automatically).
TARGETING_SETTING_DEMOGRAPHIC_CRITERION_TYPE_GROUPS_MUST_BE_SET_TO_TARGET_ALL
= 6;
// TargetingSetting cannot change any of
// the Demographic CriterionTypeGroups (AGE_RANGE, GENDER, PARENT,
// INCOME_RANGE) from true to false.
TARGETING_SETTING_CANNOT_CHANGE_TARGET_ALL_TO_FALSE_FOR_DEMOGRAPHIC_CRITERION_TYPE_GROUP
= 7;
// At least one feed id should be present.
DYNAMIC_SEARCH_ADS_SETTING_AT_LEAST_ONE_FEED_ID_MUST_BE_PRESENT = 8;
// The supplied DynamicSearchAdsSetting contains an invalid domain name.
DYNAMIC_SEARCH_ADS_SETTING_CONTAINS_INVALID_DOMAIN_NAME = 9;
// The supplied DynamicSearchAdsSetting contains a subdomain name.
DYNAMIC_SEARCH_ADS_SETTING_CONTAINS_SUBDOMAIN_NAME = 10;
// The supplied DynamicSearchAdsSetting contains an invalid language code.
DYNAMIC_SEARCH_ADS_SETTING_CONTAINS_INVALID_LANGUAGE_CODE = 11;
// TargetingSettings in search campaigns should not have
// CriterionTypeGroup.PLACEMENT set to targetAll.
TARGET_ALL_IS_NOT_ALLOWED_FOR_PLACEMENT_IN_SEARCH_CAMPAIGN = 12;
// Duplicate description in universal app setting description field.
UNIVERSAL_APP_CAMPAIGN_SETTING_DUPLICATE_DESCRIPTION = 13;
// Description line width is too long in universal app setting description
// field.
UNIVERSAL_APP_CAMPAIGN_SETTING_DESCRIPTION_LINE_WIDTH_TOO_LONG = 14;
// Universal app setting appId field cannot be modified for COMPLETE
// campaigns.
UNIVERSAL_APP_CAMPAIGN_SETTING_APP_ID_CANNOT_BE_MODIFIED = 15;
// YoutubeVideoMediaIds in universal app setting cannot exceed size limit.
TOO_MANY_YOUTUBE_MEDIA_IDS_IN_UNIVERSAL_APP_CAMPAIGN = 16;
// ImageMediaIds in universal app setting cannot exceed size limit.
TOO_MANY_IMAGE_MEDIA_IDS_IN_UNIVERSAL_APP_CAMPAIGN = 17;
// Media is incompatible for universal app campaign.
MEDIA_INCOMPATIBLE_FOR_UNIVERSAL_APP_CAMPAIGN = 18;
// Too many exclamation marks in universal app campaign ad text ideas.
TOO_MANY_EXCLAMATION_MARKS = 19;
}
}

View File

@ -0,0 +1,45 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing string format errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "StringFormatErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible string format errors.
message StringFormatErrorEnum {
// Enum describing possible string format errors.
enum StringFormatError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// The input string value contains disallowed characters.
ILLEGAL_CHARS = 2;
// The input string value is invalid for the associated field.
INVALID_FORMAT = 3;
}
}

View File

@ -0,0 +1,45 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing string length errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "StringLengthErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible string length errors.
message StringLengthErrorEnum {
// Enum describing possible string length errors.
enum StringLengthError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// Too short.
TOO_SHORT = 2;
// Too long.
TOO_LONG = 3;
}
}

View File

@ -0,0 +1,142 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing url field errors.
syntax = "proto3";
package google.ads.googleads.v0.errors;
option java_package = "com.google.ads.googleads.v0.errors";
option java_outer_classname = "UrlFieldErrorProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Errors";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Errors";
// Container for enum describing possible url field errors.
message UrlFieldErrorEnum {
// Enum describing possible url field errors.
enum UrlFieldError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
// The tracking url template is invalid.
INVALID_TRACKING_URL_TEMPLATE = 2;
// The tracking url template contains invalid tag.
INVALID_TAG_IN_TRACKING_URL_TEMPLATE = 3;
// The tracking url template must contain at least one tag (e.g. {lpurl}),
// This applies only to tracking url template associated with website ads or
// product ads.
MISSING_TRACKING_URL_TEMPLATE_TAG = 4;
// The tracking url template must start with a valid protocol (or lpurl
// tag).
MISSING_PROTOCOL_IN_TRACKING_URL_TEMPLATE = 5;
// The tracking url template starts with an invalid protocol.
INVALID_PROTOCOL_IN_TRACKING_URL_TEMPLATE = 6;
// The tracking url template contains illegal characters.
MALFORMED_TRACKING_URL_TEMPLATE = 7;
// The tracking url template must contain a host name (or lpurl tag).
MISSING_HOST_IN_TRACKING_URL_TEMPLATE = 8;
// The tracking url template has an invalid or missing top level domain
// extension.
INVALID_TLD_IN_TRACKING_URL_TEMPLATE = 9;
// The tracking url template contains nested occurrences of the same
// conditional tag (i.e. {ifmobile:{ifmobile:x}}).
REDUNDANT_NESTED_TRACKING_URL_TEMPLATE_TAG = 10;
// The final url is invalid.
INVALID_FINAL_URL = 11;
// The final url contains invalid tag.
INVALID_TAG_IN_FINAL_URL = 12;
// The final url contains nested occurrences of the same conditional tag
// (i.e. {ifmobile:{ifmobile:x}}).
REDUNDANT_NESTED_FINAL_URL_TAG = 13;
// The final url must start with a valid protocol.
MISSING_PROTOCOL_IN_FINAL_URL = 14;
// The final url starts with an invalid protocol.
INVALID_PROTOCOL_IN_FINAL_URL = 15;
// The final url contains illegal characters.
MALFORMED_FINAL_URL = 16;
// The final url must contain a host name.
MISSING_HOST_IN_FINAL_URL = 17;
// The tracking url template has an invalid or missing top level domain
// extension.
INVALID_TLD_IN_FINAL_URL = 18;
// The final mobile url is invalid.
INVALID_FINAL_MOBILE_URL = 19;
// The final mobile url contains invalid tag.
INVALID_TAG_IN_FINAL_MOBILE_URL = 20;
// The final mobile url contains nested occurrences of the same conditional
// tag (i.e. {ifmobile:{ifmobile:x}}).
REDUNDANT_NESTED_FINAL_MOBILE_URL_TAG = 21;
// The final mobile url must start with a valid protocol.
MISSING_PROTOCOL_IN_FINAL_MOBILE_URL = 22;
// The final mobile url starts with an invalid protocol.
INVALID_PROTOCOL_IN_FINAL_MOBILE_URL = 23;
// The final mobile url contains illegal characters.
MALFORMED_FINAL_MOBILE_URL = 24;
// The final mobile url must contain a host name.
MISSING_HOST_IN_FINAL_MOBILE_URL = 25;
// The tracking url template has an invalid or missing top level domain
// extension.
INVALID_TLD_IN_FINAL_MOBILE_URL = 26;
// The final app url is invalid.
INVALID_FINAL_APP_URL = 27;
// The final app url contains invalid tag.
INVALID_TAG_IN_FINAL_APP_URL = 28;
// The final app url contains nested occurrences of the same conditional tag
// (i.e. {ifmobile:{ifmobile:x}}).
REDUNDANT_NESTED_FINAL_APP_URL_TAG = 29;
// More than one app url found for the same OS type.
MULTIPLE_APP_URLS_FOR_OSTYPE = 30;
// The OS type given for an app url is not valid.
INVALID_OSTYPE = 31;
// The protocol given for an app url is not valid. (E.g. "android-app://")
INVALID_PROTOCOL_FOR_APP_URL = 32;
// The package id (app id) given for an app url is not valid.
INVALID_PACKAGE_ID_FOR_APP_URL = 33;
// The number of url custom parameters for an resource exceeds the maximum
// limit allowed.
URL_CUSTOM_PARAMETERS_COUNT_EXCEEDS_LIMIT = 34;
// An invalid character appears in the parameter key.
INVALID_CHARACTERS_IN_URL_CUSTOM_PARAMETER_KEY = 39;
// An invalid character appears in the parameter value.
INVALID_CHARACTERS_IN_URL_CUSTOM_PARAMETER_VALUE = 40;
// The url custom parameter value fails url tag validation.
INVALID_TAG_IN_URL_CUSTOM_PARAMETER_VALUE = 41;
// The custom parameter contains nested occurrences of the same conditional
// tag (i.e. {ifmobile:{ifmobile:x}}).
REDUNDANT_NESTED_URL_CUSTOM_PARAMETER_TAG = 42;
// The protocol (http:// or https://) is missing.
MISSING_PROTOCOL = 43;
// The url is invalid.
INVALID_URL = 44;
// Destination Url is deprecated.
DESTINATION_URL_DEPRECATED = 45;
// The url contains invalid tag.
INVALID_TAG_IN_URL = 46;
// The url must contain at least one tag (e.g. {lpurl}), This applies only
// to urls associated with website ads or product ads.
MISSING_URL_TAG = 47;
// Duplicate url id.
DUPLICATE_URL_ID = 48;
// Invalid url id.
INVALID_URL_ID = 49;
}
}

View File

@ -0,0 +1,99 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the ad group resource.
syntax = "proto3";
package google.ads.googleads.v0.resources;
import "google/ads/googleads/v0/common/custom_parameter.proto";
import "google/ads/googleads/v0/enums/ad_group_status.proto";
import "google/ads/googleads/v0/enums/ad_group_type.proto";
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.resources";
option java_outer_classname = "AdGroupProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
// An ad group.
message AdGroup {
// The resource name of the ad group.
// Ad group resource names have the form:
//
// `customers/{customer_id}/adGroups/{ad_group_id}`
string resource_name = 1;
// The ID of the ad group.
google.protobuf.Int64Value id = 3;
// 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.
google.protobuf.StringValue name = 4;
// The status of the ad group.
enums.AdGroupStatusEnum.AdGroupStatus status = 5;
// The type of the ad group.
enums.AdGroupTypeEnum.AdGroupType type = 12;
// The URL template for constructing a tracking URL.
google.protobuf.StringValue tracking_url_template = 13;
// The list of mappings used to substitute custom parameter tags in a
// `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
repeated common.CustomParameter url_custom_parameters = 6;
// The campaign to which the ad group belongs.
//
// This field must not be used in WHERE clauses.
google.protobuf.StringValue campaign = 10;
// The maximum CPC (cost-per-click) bid.
google.protobuf.Int64Value cpc_bid_micros = 14;
// The maximum CPM (cost-per-thousand viewable impressions) bid.
google.protobuf.Int64Value cpm_bid_micros = 15;
// The target cost-per-acquisition (conversion) bid.
google.protobuf.Int64Value cpa_bid_micros = 16;
// The CPV (cost-per-view) bid.
google.protobuf.Int64Value cpv_bid_micros = 17;
// 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.
google.protobuf.DoubleValue target_roas_override = 19;
// 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].
google.protobuf.Int64Value percent_cpc_bid_micros = 20;
}

View File

@ -0,0 +1,54 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the ad group ad resource.
syntax = "proto3";
package google.ads.googleads.v0.resources;
import "google/ads/googleads/v0/common/ad.proto";
import "google/ads/googleads/v0/enums/ad_group_ad_status.proto";
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.resources";
option java_outer_classname = "AdGroupAdProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
// An ad group ad.
message AdGroupAd {
// The resource name of the ad.
// Ad group ad resource names have the form:
//
// `customers/{customer_id}/adGroupAds/{ad_group_id}_{ad_id}`
string resource_name = 1;
// The status of the ad.
enums.AdGroupAdStatusEnum.AdGroupAdStatus status = 3;
// The ad group to which the ad belongs.
//
// This field must not be used in WHERE clauses.
google.protobuf.StringValue ad_group = 4;
// The ad.
common.Ad ad = 5;
}

View File

@ -0,0 +1,71 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the ad group bid modifier resource.
syntax = "proto3";
package google.ads.googleads.v0.resources;
import "google/ads/googleads/v0/common/criteria.proto";
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.resources";
option java_outer_classname = "AdGroupBidModifierProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
// Represents an ad group bid modifier.
message AdGroupBidModifier {
// 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}`
string resource_name = 1;
// The ad group to which this criterion belongs.
//
// This field must not be used in WHERE clauses.
google.protobuf.StringValue ad_group = 2;
// The ID of the criterion to bid modify.
//
// This field is ignored for mutates.
google.protobuf.Int64Value criterion_id = 3;
// The modifier for the bid when the criterion matches.
google.protobuf.DoubleValue bid_modifier = 4;
// The criterion of this ad group bid modifier.
oneof criterion {
// Criterion for hotel date selection (default dates vs. user selected).
common.HotelDateSelectionTypeInfo hotel_date_selection_type = 5;
// Criterion for number of days prior to the stay the booking is being made.
common.HotelAdvanceBookingWindowInfo hotel_advance_booking_window = 6;
// Criterion for length of hotel stay in nights.
common.HotelLengthOfStayInfo hotel_length_of_stay = 7;
// Criterion for day of the week the booking is for.
common.HotelCheckInDayInfo hotel_check_in_day = 8;
}
}

View File

@ -0,0 +1,172 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the ad group criterion resource.
syntax = "proto3";
package google.ads.googleads.v0.resources;
import "google/ads/googleads/v0/common/criteria.proto";
import "google/ads/googleads/v0/common/custom_parameter.proto";
import "google/ads/googleads/v0/enums/ad_group_criterion_status.proto";
import "google/ads/googleads/v0/enums/bidding_source.proto";
import "google/ads/googleads/v0/enums/criterion_type.proto";
import "google/ads/googleads/v0/enums/quality_score_bucket.proto";
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.resources";
option java_outer_classname = "AdGroupCriterionProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
// An ad group criterion.
message AdGroupCriterion {
// 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}`
string resource_name = 1;
// The ID of the criterion.
//
// This field is ignored for mutates.
google.protobuf.Int64Value criterion_id = 26;
// The status of the criterion.
enums.AdGroupCriterionStatusEnum.AdGroupCriterionStatus status = 3;
// Information regarding the quality of the criterion.
QualityInfo quality_info = 4;
// The ad group to which the criterion belongs.
//
// This field must not be used in WHERE clauses.
google.protobuf.StringValue ad_group = 5;
// The type of the criterion.
enums.CriterionTypeEnum.CriterionType type = 25;
// 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.
google.protobuf.BoolValue negative = 31;
// The CPC (cost-per-click) bid.
google.protobuf.Int64Value cpc_bid_micros = 16;
// The CPM (cost-per-thousand viewable impressions) bid.
google.protobuf.Int64Value cpm_bid_micros = 17;
// The CPV (cost-per-view) bid.
google.protobuf.Int64Value cpv_bid_micros = 24;
// 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].
google.protobuf.Int64Value percent_cpc_bid_micros = 33;
// The effective CPC (cost-per-click) bid.
google.protobuf.Int64Value effective_cpc_bid_micros = 18;
// The effective CPM (cost-per-thousand viewable impressions) bid.
google.protobuf.Int64Value effective_cpm_bid_micros = 19;
// The effective CPV (cost-per-view) bid.
google.protobuf.Int64Value effective_cpv_bid_micros = 20;
// The effective Percent CPC bid amount.
google.protobuf.Int64Value effective_percent_cpc_bid_micros = 34;
// Source of the effective CPC bid.
enums.BiddingSourceEnum.BiddingSource effective_cpc_bid_source = 21;
// Source of the effective CPM bid.
enums.BiddingSourceEnum.BiddingSource effective_cpm_bid_source = 22;
// Source of the effective CPV bid.
enums.BiddingSourceEnum.BiddingSource effective_cpv_bid_source = 23;
// Source of the effective Percent CPC bid.
enums.BiddingSourceEnum.BiddingSource effective_percent_cpc_bid_source = 35;
// Estimates for criterion bids at various positions.
PositionEstimates position_estimates = 10;
// The list of possible final URLs after all cross-domain redirects for the
// ad.
repeated google.protobuf.StringValue final_urls = 11;
// The URL template for constructing a tracking URL.
google.protobuf.StringValue tracking_url_template = 13;
// The list of mappings used to substitute custom parameter tags in a
// `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
repeated common.CustomParameter url_custom_parameters = 14;
// The ad group criterion.
//
// Exactly one must be set.
oneof criterion {
// Keyword.
common.KeywordInfo keyword = 27;
// Listing group.
common.ListingGroupInfo listing_group = 32;
}
// A container for ad group criterion quality information.
message QualityInfo {
// The quality score.
//
// This field may not be populated if Google does not have enough
// information to determine a value.
google.protobuf.Int32Value quality_score = 1;
// The performance of the ad compared to other advertisers.
enums.QualityScoreBucketEnum.QualityScoreBucket creative_quality_score = 2;
// The quality score of the landing page.
enums.QualityScoreBucketEnum.QualityScoreBucket post_click_quality_score =
3;
// The click-through rate compared to that of other advertisers.
enums.QualityScoreBucketEnum.QualityScoreBucket search_predicted_ctr = 4;
}
// Estimates for criterion bids at various positions.
message PositionEstimates {
// The estimate of the CPC bid required for ad to be shown on first
// page of search results.
google.protobuf.Int64Value first_page_cpc_micros = 1;
// 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.
google.protobuf.Int64Value first_position_cpc_micros = 2;
// The estimate of the CPC bid required for ad to be displayed at the top
// of the first page of search results.
google.protobuf.Int64Value top_of_page_cpc_micros = 3;
}
}

View File

@ -0,0 +1,90 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the BiddingStrategy resource
syntax = "proto3";
package google.ads.googleads.v0.resources;
import "google/ads/googleads/v0/common/bidding.proto";
import "google/ads/googleads/v0/enums/bidding_strategy_type.proto";
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.resources";
option java_outer_classname = "BiddingStrategyProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
// A bidding strategy.
message BiddingStrategy {
// The resource name of the bidding strategy.
// Bidding strategy resource names have the form:
//
// `customers/{customer_id}/biddingStrategies/{bidding_strategy_id}`
string resource_name = 1;
// The ID of the bidding strategy.
google.protobuf.Int64Value id = 3;
// 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).
google.protobuf.StringValue name = 4;
// The type of the bidding strategy.
// Create a bidding strategy by setting the bidding scheme.
//
// This field is read-only.
enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 5;
// The bidding scheme.
//
// Only one can be set.
oneof scheme {
// 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.
common.EnhancedCpc enhanced_cpc = 7;
// A bidding strategy that sets max CPC bids to target impressions on
// page one or page one promoted slots on google.com.
common.PageOnePromoted page_one_promoted = 8;
// A bidding strategy that sets bids to help get as many conversions as
// possible at the target cost-per-acquisition (CPA) you set.
common.TargetCpa target_cpa = 9;
// A bidding strategy that sets bids based on the target fraction of
// auctions where the advertiser should outrank a specific competitor.
common.TargetOutrankShare target_outrank_share = 10;
// A bidding strategy that helps you maximize revenue while averaging a
// specific target Return On Ad Spend (ROAS).
common.TargetRoas target_roas = 11;
// A bid strategy that sets your bids to help get as many clicks as
// possible within your budget.
common.TargetSpend target_spend = 12;
}
}

View File

@ -0,0 +1,218 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the Campaign resource.
syntax = "proto3";
package google.ads.googleads.v0.resources;
import "google/ads/googleads/v0/common/bidding.proto";
import "google/ads/googleads/v0/common/custom_parameter.proto";
import "google/ads/googleads/v0/enums/ad_serving_optimization_status.proto";
import "google/ads/googleads/v0/enums/advertising_channel_sub_type.proto";
import "google/ads/googleads/v0/enums/advertising_channel_type.proto";
import "google/ads/googleads/v0/enums/bidding_strategy_type.proto";
import "google/ads/googleads/v0/enums/campaign_serving_status.proto";
import "google/ads/googleads/v0/enums/campaign_status.proto";
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.resources";
option java_outer_classname = "CampaignProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
// A campaign.
message Campaign {
// The resource name of the campaign.
// Campaign resource names have the form:
//
// `customers/{customer_id}/campaigns/{campaign_id}`
string resource_name = 1;
// The ID of the campaign.
google.protobuf.Int64Value id = 3;
// The name of the campaign.
//
// This field is required and should not be empty when creating new
// campaigns.
//
// It must not contain any null (code point 0x0), NL line feed
// (code point 0xA) or carriage return (code point 0xD) characters.
google.protobuf.StringValue name = 4;
// The status of the campaign.
//
// When a new campaign is added, the status defaults to ENABLED.
enums.CampaignStatusEnum.CampaignStatus status = 5;
// The ad serving status of the campaign.
enums.CampaignServingStatusEnum.CampaignServingStatus serving_status = 21;
// The ad serving optimization status of the campaign.
enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus
ad_serving_optimization_status = 8;
// The primary serving target for ads within the campaign.
// The targeting options can be refined in `network_settings`.
//
// Can be set only when creating campaigns.
// After the campaign is created, the field can not be changed.
enums.AdvertisingChannelTypeEnum.AdvertisingChannelType
advertising_channel_type = 9;
// Optional refinement to `advertising_channel_type`.
// Must be a valid sub-type of the parent channel type.
//
// Can be set only when creating campaigns.
// After campaign is created, the field can not be changed.
enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType
advertising_channel_sub_type = 10;
// The URL template for constructing a tracking URL.
google.protobuf.StringValue tracking_url_template = 11;
// The list of mappings used to substitute custom parameter tags in a
// `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
repeated common.CustomParameter url_custom_parameters = 12;
// The network settings for the campaign.
NetworkSettings network_settings = 14;
// The hotel setting for the campaign.
HotelSettingInfo hotel_setting = 32;
// The setting for controlling Dynamic Search Ads (DSA).
DynamicSearchAdsSetting dynamic_search_ads_setting = 33;
// The budget of the campaign.
//
// This field must not be used in WHERE clauses.
google.protobuf.StringValue campaign_budget = 6;
// The type of bidding strategy.
//
// A bidding strategy can be created by setting either the bidding scheme to
// create a standard bidding strategy or the `bidding_strategy` field to
// create a portfolio bidding strategy.
//
// This field is read-only.
enums.BiddingStrategyTypeEnum.BiddingStrategyType bidding_strategy_type = 22;
// The date when campaign started.
//
// This field must not be used in WHERE clauses.
google.protobuf.StringValue start_date = 19;
// The date when campaign ended.
//
// This field must not be used in WHERE clauses.
google.protobuf.StringValue end_date = 20;
// The bidding strategy for the campaign.
//
// Must be either portfolio (created via BiddingStrategy service) or
// standard, that is embedded into the campaign.
oneof campaign_bidding_strategy {
// Portfolio bidding strategy used by campaign.
//
// This field must not be used in WHERE clauses.
google.protobuf.StringValue bidding_strategy = 23;
// Standard Manual CPC bidding strategy.
// Manual click-based bidding where user pays per click.
common.ManualCpc manual_cpc = 24;
// Standard Manual CPM bidding strategy.
// Manual impression-based bidding where user pays per thousand
// impressions.
common.ManualCpm manual_cpm = 25;
// Standard Maximize Conversions bidding strategy that automatically
// maximizes number of conversions given a daily budget.
common.MaximizeConversions maximize_conversions = 30;
// Standard Maximize Conversion Value bidding strategy that automatically
// sets bids to maximize revenue while spending your budget.
common.MaximizeConversionValue maximize_conversion_value = 31;
// Standard Target CPA bidding strategy that automatically sets bids to
// help get as many conversions as possible at the target
// cost-per-acquisition (CPA) you set.
common.TargetCpa target_cpa = 26;
// Standard Target ROAS bidding strategy that automatically maximizes
// revenue while averaging a specific target return on ad spend (ROAS).
common.TargetRoas target_roas = 29;
// Standard Target Spend bidding strategy that automatically sets your bids
// to help get as many clicks as possible within your budget.
common.TargetSpend target_spend = 27;
// Standard Percent Cpc bidding strategy where bids are a fraction of the
// advertised price for some good or service.
common.PercentCpc percent_cpc = 34;
}
// The network settings for the campaign.
message NetworkSettings {
// Whether ads will be served with google.com search results.
google.protobuf.BoolValue target_google_search = 1;
// Whether ads will be served on partner sites in the Google Search Network
// (requires `target_google_search` to also be `true`).
google.protobuf.BoolValue target_search_network = 2;
// Whether ads will be served on specified placements in the Google Display
// Network. Placements are specified using the Placement criterion.
google.protobuf.BoolValue target_content_network = 3;
// Whether ads will be served on the Google Partner Network.
// This is available only to some select Google partner accounts.
google.protobuf.BoolValue target_partner_search_network = 4;
}
// Campaign-level settings for hotel ads.
message HotelSettingInfo {
// The linked Hotel Center account.
google.protobuf.Int64Value hotel_center_id = 1;
}
// The setting for controlling Dynamic Search Ads (DSA).
message DynamicSearchAdsSetting {
// The Internet domain name that this setting represents, e.g., "google.com"
// or "www.google.com".
google.protobuf.StringValue domain_name = 1;
// The language code specifying the language of the domain, e.g., "en".
google.protobuf.StringValue language_code = 2;
// Whether the campaign uses advertiser supplied URLs exclusively.
google.protobuf.BoolValue use_supplied_urls_only = 3;
// The list of page feeds associated with the campaign.
repeated google.protobuf.Int64Value feed_ids = 4;
}
}

View File

@ -0,0 +1,99 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the Budget resource.
syntax = "proto3";
package google.ads.googleads.v0.resources;
import "google/ads/googleads/v0/enums/budget_delivery_method.proto";
import "google/ads/googleads/v0/enums/budget_status.proto";
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.resources";
option java_outer_classname = "CampaignBudgetProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
// A campaign budget.
message CampaignBudget {
// The resource name of the campaign budget.
// Campaign budget resource names have the form:
//
// `customers/{customer_id}/campaignBudgets/{budget_id}`
string resource_name = 1;
// The ID of the campaign budget.
//
// A campaign budget is created using the CampaignBudgetService create
// operation and is assigned a budget ID. A budget ID can be shared across
// different campaigns; the system will then allocate the campaign budget
// among different campaigns to get optimum results.
google.protobuf.Int64Value id = 3;
// The name of the campaign budget.
//
// When creating a campaign budget through CampaignBudgetService, every
// explicitly shared campaign budget must have a non-null, non-empty name.
// Campaign budgets that are not explicitly shared derive their name from the
// attached campaign's name.
//
// The length of this string must be between 1 and 255, inclusive,
// in UTF-8 bytes, (trimmed).
google.protobuf.StringValue name = 4;
// The amount of the budget, in the local currency for the account.
// Amount is specified in micros, where one million is equivalent to one
// currency unit.
google.protobuf.Int64Value amount_micros = 5;
// The status of this campaign budget. This field is read-only.
enums.BudgetStatusEnum.BudgetStatus status = 6;
// The delivery method that determines the rate at which the campaign budget
// is spent.
//
// Defaults to STANDARD if unspecified in a create operation.
enums.BudgetDeliveryMethodEnum.BudgetDeliveryMethod delivery_method = 7;
// Whether the budget is explicitly shared. This field is set to false by
// default.
//
// If true, the budget was created with the purpose of sharing
// across one or more campaigns.
//
// If false, the budget was created with the intention of only being used
// with a single campaign. The budget's name and status will stay in sync
// with the campaign's name and status. Attempting to share the budget with a
// second campaign will result in an error.
//
// A non-shared budget can become an explicitly shared. The same operation
// must
// also assign the budget a name.
//
// A shared campaign budget can never become non-shared.
google.protobuf.BoolValue explicitly_shared = 8;
// The number of campaigns actively using the budget.
//
// This field is read-only.
google.protobuf.Int64Value reference_count = 9;
}

View File

@ -0,0 +1,80 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the Campaign Criterion resource.
syntax = "proto3";
package google.ads.googleads.v0.resources;
import "google/ads/googleads/v0/common/criteria.proto";
import "google/ads/googleads/v0/enums/criterion_type.proto";
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.resources";
option java_outer_classname = "CampaignCriterionProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
// A campaign criterion.
message CampaignCriterion {
// The resource name of the campaign criterion.
// Campaign criterion resource names have the form:
//
// `customers/{customer_id}/campaignCriteria/{campaign_id}_{criterion_id}
string resource_name = 1;
// The campaign to which the criterion belongs.
//
// This field must not be used in WHERE clauses.
google.protobuf.StringValue campaign = 4;
// The ID of the criterion.
//
// This field is ignored during mutate.
google.protobuf.Int64Value criterion_id = 5;
// The modifier for the bids when the criterion matches.
// Allowable modifier values depend on the criterion:
// - 0.1 - 10.0: Location
// - 0.1 - 4.0: Platform (mobile). Use 0 to opt out of mobile.
google.protobuf.FloatValue bid_modifier = 14;
// Whether to target (`false`) or exclude (`true`) the criterion.
google.protobuf.BoolValue negative = 7;
// The type of the criterion.
enums.CriterionTypeEnum.CriterionType type = 6;
// The campaign criterion.
//
// Exactly one must be set.
oneof criterion {
// Keyword.
common.KeywordInfo keyword = 8;
// Location.
common.LocationInfo location = 12;
// Platform.
common.PlatformInfo platform = 13;
}
}

View File

@ -0,0 +1,66 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the Customer resource.
syntax = "proto3";
package google.ads.googleads.v0.resources;
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.resources";
option java_outer_classname = "CustomerProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
// A customer.
message Customer {
// The resource name of the customer.
// Customer resource names have the form:
//
// `customers/{customer_id}`
string resource_name = 1;
// The ID of the customer.
google.protobuf.Int64Value id = 3;
// Optional, non-unique descriptive name of the customer.
google.protobuf.StringValue descriptive_name = 4;
// The currency in which the account operates.
// A subset of the currency codes from the ISO 4217 standard is
// supported.
google.protobuf.StringValue currency_code = 5;
// The local timezone ID of the customer.
google.protobuf.StringValue time_zone = 6;
// The URL template for constructing a tracking URL out of parameters.
google.protobuf.StringValue tracking_url_template = 7;
// Whether auto-tagging is enabled for the customer.
google.protobuf.BoolValue auto_tagging_enabled = 8;
// 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
google.protobuf.BoolValue has_partners_badge = 9;
}

View File

@ -0,0 +1,53 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the geo target constant resource.
syntax = "proto3";
package google.ads.googleads.v0.resources;
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.resources";
option java_outer_classname = "GeoTargetConstantProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
// A geo target constant.
message GeoTargetConstant {
// The resource name of the geo target constant.
// Geo target constant resource names have the form:
//
// `geoTargetConstants/{geo_target_constant_id}`
string resource_name = 1;
// The ID of the geo target constant.
google.protobuf.Int64Value id = 3;
// Geo target constant English name.
google.protobuf.StringValue name = 4;
// The ISO-3166-1 alpha-2 country code that is associated with the target.
google.protobuf.StringValue country_code = 5;
// Geo target constant target type.
google.protobuf.StringValue target_type = 6;
}

View File

@ -0,0 +1,100 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the Google Ads Field resource.
syntax = "proto3";
package google.ads.googleads.v0.resources;
import "google/ads/googleads/v0/enums/google_ads_field_category.proto";
import "google/ads/googleads/v0/enums/google_ads_field_data_type.proto";
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.resources";
option java_outer_classname = "GoogleAdsFieldProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
// A field or resource (artifact) used by GoogleAdsService.
message GoogleAdsField {
// The resource name of the artifact.
// Artifact resource names have the form:
//
// `googleAdsFields/{name}`
string resource_name = 1;
// The name of the artifact.
google.protobuf.StringValue name = 2;
// The category of the artifact.
enums.GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory category = 3;
// Whether the artifact can be used in a SELECT clause in search
// queries.
google.protobuf.BoolValue selectable = 4;
// Whether the artifact can be used in a WHERE clause in search
// queries.
google.protobuf.BoolValue filterable = 5;
// Whether the artifact can be used in a ORDER BY clause in search
// queries.
google.protobuf.BoolValue sortable = 6;
// The names of all resources, segments, and metrics that are selectable with
// the described artifact.
repeated google.protobuf.StringValue selectable_with = 7;
// 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.
repeated google.protobuf.StringValue attribute_resources = 8;
// 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.
repeated google.protobuf.StringValue metrics = 9;
// 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.
repeated google.protobuf.StringValue segments = 10;
// 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.
repeated google.protobuf.StringValue enum_values = 11;
// This field determines the operators that can be used with the artifact
// in WHERE clauses.
enums.GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType data_type = 12;
// The URL of proto describing the artifact's data type.
google.protobuf.StringValue type_url = 13;
// Whether the field artifact is repeated.
google.protobuf.BoolValue is_repeated = 14;
}

View File

@ -0,0 +1,39 @@
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the keyword view resource.
syntax = "proto3";
package google.ads.googleads.v0.resources;
option java_package = "com.google.ads.googleads.v0.resources";
option java_outer_classname = "KeywordViewProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
// A keyword view.
message KeywordView {
// The resource name of the keyword view.
// Keyword view resource names have the form:
//
// `customers/{customer_id}/keywordViews/{ad_group_id}_{criterion_id}`
string resource_name = 1;
}

View File

@ -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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
// Proto file describing the Recommendation resource.
syntax = "proto3";
package google.ads.googleads.v0.resources;
import "google/ads/googleads/v0/common/ad.proto";
import "google/ads/googleads/v0/common/criteria.proto";
import "google/ads/googleads/v0/enums/recommendation_type.proto";
import
"google/ads/googleads/v0/enums/target_cpa_opt_in_recommendation_goal.proto";
import "google/protobuf/wrappers.proto";
option java_package = "com.google.ads.googleads.v0.resources";
option java_outer_classname = "RecommendationProto";
option java_multiple_files = true;
// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
// A recommendation.
message Recommendation {
// The resource name of the recommendation.
//
// `customers/{customer_id}/recommendations/{recommendation_id}`
string resource_name = 1;
// The type of recommendation.
enums.RecommendationTypeEnum.RecommendationType type = 2;
// The impact on account performance as a result of applying the
// recommendation.
RecommendationImpact impact = 3;
// 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
google.protobuf.StringValue campaign_budget = 5;
// 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:
// KEYWORD, TEXT_AD, TARGET_CPA_OPT_IN
google.protobuf.StringValue campaign = 6;
// 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, TEXT_AD
google.protobuf.StringValue ad_group = 7;
// The details of recommendation.
oneof recommendation {
// The campaign budget recommendation.
CampaignBudgetRecommendation campaign_budget_recommendation = 4;
// The keyword recommendation.
KeywordRecommendation keyword_recommendation = 8;
// Add expanded text ad recommendation.
TextAdRecommendation text_ad_recommendation = 9;
// The TargetCPA opt-in recommendation.
TargetCpaOptInRecommendation target_cpa_opt_in_recommendation = 10;
}
// The impact of making the change as described in the recommendation.
// Some types of recommendations may not have impact information.
message RecommendationImpact {
// Base metrics at the time the recommendation was generated.
RecommendationMetrics base_metrics = 1;
// Estimated metrics if the recommendation is applied.
RecommendationMetrics potential_metrics = 2;
}
// Weekly account performance metrics. For some recommendation types, these
// are averaged over the past 90-day period and hence can be fractional.
message RecommendationMetrics {
// Number of ad impressions.
google.protobuf.DoubleValue impressions = 1;
// Number of ad clicks.
google.protobuf.DoubleValue clicks = 2;
// Cost (in micros) for advertising, in the local currency for the account.
google.protobuf.Int64Value cost_micros = 3;
// Number of conversions.
google.protobuf.DoubleValue conversions = 4;
// Number of video views for a video ad campaign.
google.protobuf.DoubleValue video_views = 5;
}
// The budget recommendation for budget constrained campaigns.
message CampaignBudgetRecommendation {
// The current budget amount in micros.
google.protobuf.Int64Value current_budget_amount_micros = 1;
// The recommended budget amount in micros.
google.protobuf.Int64Value recommended_budget_amount_micros = 2;
// The budget amounts and associated impact estimates for some values of
// possible budget amounts.
repeated CampaignBudgetRecommendationOption budget_options = 3;
// The impact estimates for a given budget amount.
message CampaignBudgetRecommendationOption {
// The budget amount for this option.
google.protobuf.Int64Value budget_amount_micros = 1;
// The impact estimate if budget is changed to amount specified in this
// option.
RecommendationImpact impact = 2;
}
}
// The keyword recommendation.
message KeywordRecommendation {
// The recommended keyword.
common.KeywordInfo keyword = 1;
// The recommended CPC (cost-per-click) bid.
google.protobuf.Int64Value recommended_cpc_bid_micros = 2;
}
// The text ad recommendation.
message TextAdRecommendation {
// Recommended ad.
common.Ad ad = 1;
// Creation date of the recommended ad.
// YYYY-MM-DD format, e.g., 2018-04-17.
google.protobuf.StringValue creation_date = 2;
// Date, if present, is the earliest when the recommendation will be auto
// applied.
// YYYY-MM-DD format, e.g., 2018-04-17.
google.protobuf.StringValue auto_apply_date = 3;
}
// The Target CPA opt-in recommendation.
message TargetCpaOptInRecommendation {
// The available goals and corresponding options for Target CPA strategy.
repeated TargetCpaOptInRecommendationOption options = 1;
// The recommended average CPA target. See required budget amount and impact
// of using this recommendation in options list.
google.protobuf.Int64Value recommended_target_cpa_micros = 2;
// The Target CPA opt-in option with impact estimate.
message TargetCpaOptInRecommendationOption {
// The goal achieved by this option.
enums.TargetCpaOptInRecommendationGoalEnum.TargetCpaOptInRecommendationGoal
goal = 1;
// Average CPA target.
google.protobuf.Int64Value target_cpa_micros = 2;
// 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.
google.protobuf.Int64Value required_campaign_budget_amount_micros = 3;
// The impact estimate if this option is selected.
RecommendationImpact impact = 4;
}
}
}

Some files were not shown because too many files have changed in this diff Show More