Updated annotations!: Changing method signatures and 'REQUIRED' annot…

…ations to reflect the need to always include 'partial_failure' parameter in calls to certain conversion-related services. BREAKING CHANGE: Updated method signature and 'REQUIRED' annotations. PiperOrigin-RevId: 312675261
googleapis · May 21, 2020 · 747dfd1 · 747dfd1
1 parent d8a1793
commit 747dfd1
Show file tree

Hide file tree

Showing 27 changed files with 173 additions and 172 deletions.
diff --git a/google/ads/googleads/v1/common/bidding.proto b/google/ads/googleads/v1/common/bidding.proto
@@ -140,7 +140,7 @@ message TargetCpm {
 // An automated bidding strategy that sets bids so that a certain percentage of
 // search ads are shown at the top of the first page (or other targeted
 // location).
-// Next Id = 4
+// next tag = 4
 message TargetImpressionShare {
   // The targeted location on the search results page.
   google.ads.googleads.v1.enums.TargetImpressionShareLocationEnum.TargetImpressionShareLocation location = 1;

diff --git a/google/ads/googleads/v1/common/keyword_plan_common.proto b/google/ads/googleads/v1/common/keyword_plan_common.proto
@@ -31,9 +31,13 @@ option ruby_package = "Google::Ads::GoogleAds::V1::Common";
 
 // Proto file describing Keyword Planner messages.
 
-// Historical metrics.
+// Historical metrics specific to the targeting options selected.
+// Targeting options include geographies, network, etc.
+// Refer to https://support.google.com/google-ads/answer/3022575 for more
+// details.
 message KeywordPlanHistoricalMetrics {
-  // Average monthly searches for the past 12 months.
+  // Approximate number of monthly searches on this query averaged
+  // for the past 12 months.
   google.protobuf.Int64Value avg_monthly_searches = 1;
 
   // The competition level for the query.

diff --git a/google/ads/googleads/v1/common/metrics.proto b/google/ads/googleads/v1/common/metrics.proto
@@ -297,7 +297,7 @@ message Metrics {
   // future, other ad types may support engagement metrics.
   google.protobuf.Int64Value engagements = 32;
 
-  // Average lead value of hotel.
+  // Average lead value based on clicks.
   google.protobuf.DoubleValue hotel_average_lead_value_micros = 75;
 
   // The creative historical quality score.

diff --git a/google/ads/googleads/v1/enums/keyword_plan_competition_level.proto b/google/ads/googleads/v1/enums/keyword_plan_competition_level.proto
@@ -43,13 +43,13 @@ message KeywordPlanCompetitionLevelEnum {
     // The value is unknown in this version.
     UNKNOWN = 1;
 
-    // Low competition.
+    // Low competition. The Competition Index range for this is [0, 33].
     LOW = 2;
 
-    // Medium competition.
+    // Medium competition. The Competition Index range for this is [34, 66].
     MEDIUM = 3;
 
-    // High competition.
+    // High competition. The Competition Index range for this is [67, 100].
     HIGH = 4;
   }
 

diff --git a/google/ads/googleads/v1/errors/customer_error.proto b/google/ads/googleads/v1/errors/customer_error.proto
@@ -30,7 +30,6 @@ option ruby_package = "Google::Ads::GoogleAds::V1::Errors";
 // Container for enum describing possible customer errors.
 message CustomerErrorEnum {
   // Set of errors that are related to requests dealing with Customer.
-  // Next id: 26
   enum CustomerError {
     // Enum unspecified.
     UNSPECIFIED = 0;

diff --git a/google/ads/googleads/v1/resources/ad.proto b/google/ads/googleads/v1/resources/ad.proto
@@ -60,6 +60,7 @@ message Ad {
 
   // The list of mappings that can be used to substitute custom parameter tags
   // in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
+  // For mutates, please use url custom parameter operations.
   repeated google.ads.googleads.v1.common.CustomParameter url_custom_parameters = 10;
 
   // The URL that appears in the ad description for some ad formats.

diff --git a/google/ads/googleads/v1/resources/campaign.proto b/google/ads/googleads/v1/resources/campaign.proto
@@ -83,19 +83,6 @@ message Campaign {
     google.protobuf.Int64Value hotel_center_id = 1 [(google.api.field_behavior) = IMMUTABLE];
   }
 
-  // Campaign-level settings for App Campaigns.
-  message AppCampaignSetting {
-    // Represents the goal which the bidding strategy of this app campaign
-    // should optimize towards.
-    google.ads.googleads.v1.enums.AppCampaignBiddingStrategyGoalTypeEnum.AppCampaignBiddingStrategyGoalType bidding_strategy_goal_type = 1;
-
-    // Immutable. A string that uniquely identifies a mobile application.
-    google.protobuf.StringValue app_id = 2 [(google.api.field_behavior) = IMMUTABLE];
-
-    // Immutable. The application store that distributes this specific app.
-    google.ads.googleads.v1.enums.AppCampaignAppStoreEnum.AppCampaignAppStore app_store = 3 [(google.api.field_behavior) = IMMUTABLE];
-  }
-
   // The setting for controlling Dynamic Search Ads (DSA).
   message DynamicSearchAdsSetting {
     // The Internet domain name that this setting represents, e.g., "google.com"
@@ -117,16 +104,6 @@ message Campaign {
     ];
   }
 
-  // Describes how unbranded pharma ads will be displayed.
-  message VanityPharma {
-    // The display mode for vanity pharma URLs.
-    google.ads.googleads.v1.enums.VanityPharmaDisplayUrlModeEnum.VanityPharmaDisplayUrlMode vanity_pharma_display_url_mode = 1;
-
-    // The text that will be displayed in display URL of the text ad when
-    // website description is the selected display mode for vanity pharma URLs.
-    google.ads.googleads.v1.enums.VanityPharmaTextEnum.VanityPharmaText vanity_pharma_text = 2;
-  }
-
   // The setting for Shopping campaigns. Defines the universe of products that
   // can be advertised by the campaign, and how this campaign interacts with
   // other Shopping campaigns.
@@ -160,6 +137,15 @@ message Campaign {
     google.protobuf.StringValue tracking_url = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
   }
 
+  // Selective optimization setting for this campaign, which includes a set of
+  // conversion actions to optimize this campaign towards.
+  message SelectiveOptimization {
+    // The selected set of conversion actions for optimizing this campaign.
+    repeated google.protobuf.StringValue conversion_actions = 1 [(google.api.resource_reference) = {
+                                                                   type: "googleads.googleapis.com/ConversionAction"
+                                                                 }];
+  }
+
   // Represents a collection of settings related to ads geotargeting.
   message GeoTargetTypeSetting {
     // The setting used for positive geotargeting in this particular campaign.
@@ -169,13 +155,27 @@ message Campaign {
     google.ads.googleads.v1.enums.NegativeGeoTargetTypeEnum.NegativeGeoTargetType negative_geo_target_type = 2;
   }
 
-  // Selective optimization setting for this campaign, which includes a set of
-  // conversion actions to optimize this campaign towards.
-  message SelectiveOptimization {
-    // The selected set of conversion actions for optimizing this campaign.
-    repeated google.protobuf.StringValue conversion_actions = 1 [(google.api.resource_reference) = {
-                                                                   type: "googleads.googleapis.com/ConversionAction"
-                                                                 }];
+  // Campaign-level settings for App Campaigns.
+  message AppCampaignSetting {
+    // Represents the goal which the bidding strategy of this app campaign
+    // should optimize towards.
+    google.ads.googleads.v1.enums.AppCampaignBiddingStrategyGoalTypeEnum.AppCampaignBiddingStrategyGoalType bidding_strategy_goal_type = 1;
+
+    // Immutable. A string that uniquely identifies a mobile application.
+    google.protobuf.StringValue app_id = 2 [(google.api.field_behavior) = IMMUTABLE];
+
+    // Immutable. The application store that distributes this specific app.
+    google.ads.googleads.v1.enums.AppCampaignAppStoreEnum.AppCampaignAppStore app_store = 3 [(google.api.field_behavior) = IMMUTABLE];
+  }
+
+  // Describes how unbranded pharma ads will be displayed.
+  message VanityPharma {
+    // The display mode for vanity pharma URLs.
+    google.ads.googleads.v1.enums.VanityPharmaDisplayUrlModeEnum.VanityPharmaDisplayUrlMode vanity_pharma_display_url_mode = 1;
+
+    // The text that will be displayed in display URL of the text ad when
+    // website description is the selected display mode for vanity pharma URLs.
+    google.ads.googleads.v1.enums.VanityPharmaTextEnum.VanityPharmaText vanity_pharma_text = 2;
   }
 
   // Immutable. The resource name of the campaign.
@@ -298,12 +298,10 @@ message Campaign {
   google.ads.googleads.v1.enums.BiddingStrategyTypeEnum.BiddingStrategyType bidding_strategy_type = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // 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;
 

diff --git a/google/ads/googleads/v1/resources/keyword_plan_campaign.proto b/google/ads/googleads/v1/resources/keyword_plan_campaign.proto
@@ -91,7 +91,6 @@ message KeywordPlanCampaign {
 }
 
 // A geo target.
-// Next ID: 3
 message KeywordPlanGeoTarget {
   // Required. The resource name of the geo target.
   google.protobuf.StringValue geo_target_constant = 1 [(google.api.resource_reference) = {

diff --git a/google/ads/googleads/v1/resources/recommendation.proto b/google/ads/googleads/v1/resources/recommendation.proto
@@ -106,10 +106,15 @@ message Recommendation {
     google.protobuf.Int64Value recommended_cpc_bid_micros = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
   }
 
-  // The Call extension recommendation.
-  message CallExtensionRecommendation {
-    // Output only. Call extensions recommended to be added.
-    repeated google.ads.googleads.v1.common.CallFeedItem recommended_extensions = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  // The Optimize Ad Rotation recommendation.
+  message OptimizeAdRotationRecommendation {
+
+  }
+
+  // The Callout extension recommendation.
+  message CalloutExtensionRecommendation {
+    // Output only. Callout extensions recommended to be added.
+    repeated google.ads.googleads.v1.common.CalloutFeedItem recommended_extensions = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
   }
 
   // The text ad recommendation.
@@ -155,17 +160,10 @@ message Recommendation {
     google.protobuf.Int64Value recommended_target_cpa_micros = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
   }
 
-  // The Maximize Clicks opt-in recommendation.
-  message MaximizeClicksOptInRecommendation {
-    // Output only. The recommended new budget amount.
-    // Only set if the current budget is too high.
-    google.protobuf.Int64Value recommended_budget_amount_micros = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-  }
-
-  // The Maximize Conversions Opt-In recommendation.
-  message MaximizeConversionsOptInRecommendation {
-    // Output only. The recommended new budget amount.
-    google.protobuf.Int64Value recommended_budget_amount_micros = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  // The Sitelink extension recommendation.
+  message SitelinkExtensionRecommendation {
+    // Output only. Sitelink extensions recommended to be added.
+    repeated google.ads.googleads.v1.common.SitelinkFeedItem recommended_extensions = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
   }
 
   // The move unused budget recommendation.
@@ -177,25 +175,15 @@ message Recommendation {
     CampaignBudgetRecommendation budget_recommendation = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
   }
 
-  // The Enhanced Cost-Per-Click Opt-In recommendation.
-  message EnhancedCpcOptInRecommendation {
-
-  }
-
   // The Search Partners Opt-In recommendation.
   message SearchPartnersOptInRecommendation {
 
   }
 
-  // The Optimize Ad Rotation recommendation.
-  message OptimizeAdRotationRecommendation {
-
-  }
-
-  // The Callout extension recommendation.
-  message CalloutExtensionRecommendation {
-    // Output only. Callout extensions recommended to be added.
-    repeated google.ads.googleads.v1.common.CalloutFeedItem recommended_extensions = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  // The Maximize Conversions Opt-In recommendation.
+  message MaximizeConversionsOptInRecommendation {
+    // Output only. The recommended new budget amount.
+    google.protobuf.Int64Value recommended_budget_amount_micros = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
   }
 
   // The keyword match type recommendation.
@@ -207,10 +195,22 @@ message Recommendation {
     google.ads.googleads.v1.enums.KeywordMatchTypeEnum.KeywordMatchType recommended_match_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
   }
 
-  // The Sitelink extension recommendation.
-  message SitelinkExtensionRecommendation {
-    // Output only. Sitelink extensions recommended to be added.
-    repeated google.ads.googleads.v1.common.SitelinkFeedItem recommended_extensions = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  // The Enhanced Cost-Per-Click Opt-In recommendation.
+  message EnhancedCpcOptInRecommendation {
+
+  }
+
+  // The Maximize Clicks opt-in recommendation.
+  message MaximizeClicksOptInRecommendation {
+    // Output only. The recommended new budget amount.
+    // Only set if the current budget is too high.
+    google.protobuf.Int64Value recommended_budget_amount_micros = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  }
+
+  // The Call extension recommendation.
+  message CallExtensionRecommendation {
+    // Output only. Call extensions recommended to be added.
+    repeated google.ads.googleads.v1.common.CallFeedItem recommended_extensions = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
   }
 
   // Immutable. The resource name of the recommendation.

diff --git a/google/ads/googleads/v1/services/conversion_adjustment_upload_service.proto b/google/ads/googleads/v1/services/conversion_adjustment_upload_service.proto
@@ -42,7 +42,7 @@ service ConversionAdjustmentUploadService {
       post: "/v1/customers/{customer_id=*}:uploadConversionAdjustments"
       body: "*"
     };
-    option (google.api.method_signature) = "customer_id,conversion_adjustments";
+    option (google.api.method_signature) = "customer_id,conversion_adjustments,partial_failure";
   }
 }
 
@@ -55,11 +55,11 @@ message UploadConversionAdjustmentsRequest {
   // Required. The conversion adjustments that are being uploaded.
   repeated ConversionAdjustment conversion_adjustments = 2 [(google.api.field_behavior) = REQUIRED];
 
-  // If true, successful operations will be carried out and invalid
+  // Required. If true, successful operations will be carried out and invalid
   // operations will return errors. If false, all operations will be carried out
   // in one transaction if and only if they are all valid. This should always be
   // set to true.
-  bool partial_failure = 3;
+  bool partial_failure = 3 [(google.api.field_behavior) = REQUIRED];
 
   // If true, the request is validated but not executed. Only errors are
   // returned, not results.

diff --git a/google/ads/googleads/v1/services/conversion_upload_service.proto b/google/ads/googleads/v1/services/conversion_upload_service.proto
@@ -41,7 +41,7 @@ service ConversionUploadService {
       post: "/v1/customers/{customer_id=*}:uploadClickConversions"
       body: "*"
     };
-    option (google.api.method_signature) = "customer_id,conversions";
+    option (google.api.method_signature) = "customer_id,conversions,partial_failure";
   }
 
   // Processes the given call conversions.
@@ -50,7 +50,7 @@ service ConversionUploadService {
       post: "/v1/customers/{customer_id=*}:uploadCallConversions"
       body: "*"
     };
-    option (google.api.method_signature) = "customer_id,conversions";
+    option (google.api.method_signature) = "customer_id,conversions,partial_failure";
   }
 }
 
@@ -62,11 +62,11 @@ message UploadClickConversionsRequest {
   // Required. The conversions that are being uploaded.
   repeated ClickConversion conversions = 2 [(google.api.field_behavior) = REQUIRED];
 
-  // If true, successful operations will be carried out and invalid
+  // Required. If true, successful operations will be carried out and invalid
   // operations will return errors. If false, all operations will be carried
   // out in one transaction if and only if they are all valid.
   // This should always be set to true.
-  bool partial_failure = 3;
+  bool partial_failure = 3 [(google.api.field_behavior) = REQUIRED];
 
   // If true, the request is validated but not executed. Only errors are
   // returned, not results.
@@ -94,11 +94,11 @@ message UploadCallConversionsRequest {
   // Required. The conversions that are being uploaded.
   repeated CallConversion conversions = 2 [(google.api.field_behavior) = REQUIRED];
 
-  // If true, successful operations will be carried out and invalid
+  // Required. If true, successful operations will be carried out and invalid
   // operations will return errors. If false, all operations will be carried
   // out in one transaction if and only if they are all valid.
   // This should always be set to true.
-  bool partial_failure = 3;
+  bool partial_failure = 3 [(google.api.field_behavior) = REQUIRED];
 
   // If true, the request is validated but not executed. Only errors are
   // returned, not results.

diff --git a/google/ads/googleads/v1/services/customer_service.proto b/google/ads/googleads/v1/services/customer_service.proto
@@ -22,7 +22,6 @@ import "google/api/client.proto";
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/protobuf/field_mask.proto";
-import "google/protobuf/wrappers.proto";
 
 option csharp_namespace = "Google.Ads.GoogleAds.V1.Services";
 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/services;services";

diff --git a/google/ads/googleads/v1/services/keyword_plan_service.proto b/google/ads/googleads/v1/services/keyword_plan_service.proto
@@ -172,7 +172,7 @@ message GenerateForecastMetricsResponse {
 message KeywordPlanCampaignForecast {
   // The resource name of the Keyword Plan campaign related to the forecast.
   //
-  // `customers/{customer_id}/keywordPlanCampaigns/{keyword+plan_campaign_id}`
+  // `customers/{customer_id}/keywordPlanCampaigns/{keyword_plan_campaign_id}`
   google.protobuf.StringValue keyword_plan_campaign = 1;
 
   // The forecast for the Keyword Plan campaign.

diff --git a/google/ads/googleads/v2/common/bidding.proto b/google/ads/googleads/v2/common/bidding.proto
@@ -140,7 +140,7 @@ message TargetCpm {
 // An automated bidding strategy that sets bids so that a certain percentage of
 // search ads are shown at the top of the first page (or other targeted
 // location).
-// Next Id = 4
+// next tag = 4
 message TargetImpressionShare {
   // The targeted location on the search results page.
   google.ads.googleads.v2.enums.TargetImpressionShareLocationEnum.TargetImpressionShareLocation location = 1;

diff --git a/google/ads/googleads/v2/common/keyword_plan_common.proto b/google/ads/googleads/v2/common/keyword_plan_common.proto
@@ -31,9 +31,13 @@ option ruby_package = "Google::Ads::GoogleAds::V2::Common";
 
 // Proto file describing Keyword Planner messages.
 
-// Historical metrics.
+// Historical metrics specific to the targeting options selected.
+// Targeting options include geographies, network, etc.
+// Refer to https://support.google.com/google-ads/answer/3022575 for more
+// details.
 message KeywordPlanHistoricalMetrics {
-  // Average monthly searches for the past 12 months.
+  // Approximate number of monthly searches on this query averaged
+  // for the past 12 months.
   google.protobuf.Int64Value avg_monthly_searches = 1;
 
   // The competition level for the query.

diff --git a/google/ads/googleads/v2/common/metrics.proto b/google/ads/googleads/v2/common/metrics.proto
@@ -290,7 +290,7 @@ message Metrics {
   // future, other ad types may support engagement metrics.
   google.protobuf.Int64Value engagements = 32;
 
-  // Average lead value of hotel.
+  // Average lead value based on clicks.
   google.protobuf.DoubleValue hotel_average_lead_value_micros = 75;
 
   // The average price difference between the price offered by reporting hotel