Skip to content

Commit a82e554

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
fix(googleads): fix typos and minor description updates
PiperOrigin-RevId: 415296290
1 parent 85ffeed commit a82e554

83 files changed

Lines changed: 530 additions & 511 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎google/ads/googleads/v7/common/ad_type_infos.proto‎

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ message CallOnlyAdInfo {
109109

110110
// The conversion action to attribute a call conversion to. If not set a
111111
// default conversion action is used. This field only has effect if
112-
// call_tracked is set to true. Otherwise this field is ignored.
112+
// `call_tracked` is set to `true`. Otherwise this field is ignored.
113113
optional string conversion_action = 23;
114114

115115
// The call conversion behavior of this call only ad. It can use its own call
@@ -210,8 +210,8 @@ message DisplayCallToAction {
210210
// white.
211211
optional string text_color = 6;
212212

213-
// Identifies the url collection in the ad.url_collections field. If not set
214-
// the url defaults to final_url.
213+
// Identifies the URL collection in the `ad.url_collections` field. If not
214+
// set, the URL defaults to `final_url`.
215215
optional string url_collection_id = 7;
216216
}
217217

@@ -402,11 +402,11 @@ message ResponsiveSearchAdInfo {
402402
// will be selected from this list.
403403
repeated AdTextAsset descriptions = 2;
404404

405-
// First part of text that may appear appended to the url displayed in the ad.
405+
// First part of text that can be appended to the URL in the ad.
406406
optional string path1 = 5;
407407

408-
// Second part of text that may appear appended to the url displayed in the
409-
// ad. This field can only be set when path1 is also set.
408+
// Second part of text that can be appended to the URL in the ad. This field
409+
// can only be set when `path1` is also set.
410410
optional string path2 = 6;
411411
}
412412

@@ -428,17 +428,17 @@ message LegacyResponsiveDisplayAdInfo {
428428
// Advertiser's consent to allow flexible color. When true, the ad may be
429429
// served with different color if necessary. When false, the ad will be served
430430
// with the specified colors or a neutral color.
431-
// The default value is true.
432-
// Must be true if main_color and accent_color are not set.
431+
// The default value is `true`.
432+
// Must be true if `main_color` and `accent_color` are not set.
433433
optional bool allow_flexible_color = 20;
434434

435435
// The accent color of the ad in hexadecimal, e.g. #ffffff for white.
436-
// If one of main_color and accent_color is set, the other is required as
436+
// If one of `main_color` and `accent_color` is set, the other is required as
437437
// well.
438438
optional string accent_color = 21;
439439

440440
// The main color of the ad in hexadecimal, e.g. #ffffff for white.
441-
// If one of main_color and accent_color is set, the other is required as
441+
// If one of `main_color` and `accent_color` is set, the other is required as
442442
// well.
443443
optional string main_color = 22;
444444

@@ -463,7 +463,7 @@ message LegacyResponsiveDisplayAdInfo {
463463
// Prefix before price. E.g. 'as low as'.
464464
optional string price_prefix = 28;
465465

466-
// Promotion text used for dyanmic formats of responsive ads. For example
466+
// Promotion text used for dynamic formats of responsive ads. For example
467467
// 'Free two-day shipping'.
468468
optional string promo_text = 29;
469469
}
@@ -513,7 +513,7 @@ message AppEngagementAdInfo {
513513

514514
// A legacy app install ad that only can be used by a few select customers.
515515
message LegacyAppInstallAdInfo {
516-
// The id of the mobile app.
516+
// The ID of the mobile app.
517517
optional string app_id = 6;
518518

519519
// The app store the mobile app is available in.
@@ -533,24 +533,24 @@ message LegacyAppInstallAdInfo {
533533
message ResponsiveDisplayAdInfo {
534534
// Marketing images to be used in the ad. Valid image types are GIF,
535535
// JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must
536-
// be 1.91:1 (+-1%). At least one marketing_image is required. Combined with
537-
// square_marketing_images the maximum is 15.
536+
// be 1.91:1 (+-1%). At least one `marketing_image` is required. Combined
537+
// with `square_marketing_images`, the maximum is 15.
538538
repeated AdImageAsset marketing_images = 1;
539539

540540
// Square marketing images to be used in the ad. Valid image types are GIF,
541541
// JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must
542-
// be 1:1 (+-1%). At least one square marketing_image is required. Combined
543-
// with marketing_images the maximum is 15.
542+
// be 1:1 (+-1%). At least one square `marketing_image` is required. Combined
543+
// with `marketing_images`, the maximum is 15.
544544
repeated AdImageAsset square_marketing_images = 2;
545545

546546
// Logo images to be used in the ad. Valid image types are GIF,
547547
// JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must
548-
// be 4:1 (+-1%). Combined with square_logo_images the maximum is 5.
548+
// be 4:1 (+-1%). Combined with `square_logo_images`, the maximum is 5.
549549
repeated AdImageAsset logo_images = 3;
550550

551551
// Square logo images to be used in the ad. Valid image types are GIF,
552552
// JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must
553-
// be 1:1 (+-1%). Combined with square_logo_images the maximum is 5.
553+
// be 1:1 (+-1%). Combined with `square_logo_images`, the maximum is 5.
554554
repeated AdImageAsset square_logo_images = 4;
555555

556556
// Short format headlines for the ad. The maximum length is 30 characters.
@@ -571,20 +571,20 @@ message ResponsiveDisplayAdInfo {
571571
optional string business_name = 17;
572572

573573
// The main color of the ad in hexadecimal, e.g. #ffffff for white.
574-
// If one of main_color and accent_color is set, the other is required as
574+
// If one of `main_color` and `accent_color` is set, the other is required as
575575
// well.
576576
optional string main_color = 18;
577577

578578
// The accent color of the ad in hexadecimal, e.g. #ffffff for white.
579-
// If one of main_color and accent_color is set, the other is required as
579+
// If one of `main_color` and `accent_color` is set, the other is required as
580580
// well.
581581
optional string accent_color = 19;
582582

583583
// Advertiser's consent to allow flexible color. When true, the ad may be
584584
// served with different color if necessary. When false, the ad will be served
585585
// with the specified colors or a neutral color.
586-
// The default value is true.
587-
// Must be true if main_color and accent_color are not set.
586+
// The default value is `true`.
587+
// Must be true if `main_color` and `accent_color` are not set.
588588
optional bool allow_flexible_color = 20;
589589

590590
// The call-to-action text for the ad. Maximum display width is 30.
@@ -593,7 +593,7 @@ message ResponsiveDisplayAdInfo {
593593
// Prefix before price. E.g. 'as low as'.
594594
optional string price_prefix = 22;
595595

596-
// Promotion text used for dyanmic formats of responsive ads. For example
596+
// Promotion text used for dynamic formats of responsive ads. For example
597597
// 'Free two-day shipping'.
598598
optional string promo_text = 23;
599599

@@ -635,17 +635,16 @@ message LocalAdInfo {
635635
// are optional and at most 20 can be specified.
636636
repeated AdVideoAsset videos = 6;
637637

638-
// First part of optional text that may appear appended to the url displayed
639-
// in the ad.
638+
// First part of optional text that can be appended to the URL in the ad.
640639
optional string path1 = 9;
641640

642-
// Second part of optional text that may appear appended to the url displayed
643-
// in the ad. This field can only be set when path1 is also set.
641+
// Second part of optional text that can be appended to the URL in the ad.
642+
// This field can only be set when `path1` is also set.
644643
optional string path2 = 10;
645644
}
646645

647646
// A generic type of display ad. The exact ad format is controlled by the
648-
// display_upload_product_type field, which determines what kinds of data
647+
// `display_upload_product_type` field, which determines what kinds of data
649648
// need to be included with the ad.
650649
message DisplayUploadAdInfo {
651650
// The product type of this ad. See comments on the enum for details.
@@ -654,7 +653,7 @@ message DisplayUploadAdInfo {
654653
// The asset data that makes up the ad.
655654
oneof media_asset {
656655
// A media bundle asset to be used in the ad. For information about the
657-
// media bundle for HTML5_UPLOAD_AD see
656+
// media bundle for HTML5_UPLOAD_AD, see
658657
// https://support.google.com/google-ads/answer/1722096
659658
// Media bundles that are part of dynamic product types use a special format
660659
// that needs to be created through the Google Web Designer. See

‎google/ads/googleads/v7/common/asset_types.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ message LeadFormAsset {
138138
// and the aspect ratio must be 1.91:1 (+-1%).
139139
optional string background_image_asset = 20;
140140

141-
// Desired intent for the lead form, e.g. more volume or higher intent.
141+
// Desired intent for the lead form, e.g. more volume or more qualified.
142142
google.ads.googleads.v7.enums.LeadFormDesiredIntentEnum.LeadFormDesiredIntent desired_intent = 21;
143143

144144
// Custom disclosure shown along with Google disclaimer on the lead form.

‎google/ads/googleads/v7/common/bidding.proto‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,11 @@ message ManualCpv {
6666
// An automated bidding strategy to help get the most conversions for your
6767
// campaigns while spending your budget.
6868
message MaximizeConversions {
69-
// The target cost per acquisition (CPA) option. This is the average amount
70-
// that you would like to spend per acquisition.
71-
//
72-
// This field is read-only.
69+
// The target cost-per-action (CPA) option. This is the average amount that
70+
// you would like to spend per conversion action. If set, the bid strategy
71+
// will get as many conversions as possible at or below the target
72+
// cost-per-action. If the target CPA is not set, the bid strategy will
73+
// aim to achieve the lowest possible CPA given the budget.
7374
int64 target_cpa = 1;
7475
}
7576

@@ -94,10 +95,12 @@ message TargetCpa {
9495

9596
// Maximum bid limit that can be set by the bid strategy.
9697
// The limit applies to all keywords managed by the strategy.
98+
// This should only be set for portfolio bid strategies.
9799
optional int64 cpc_bid_ceiling_micros = 5;
98100

99101
// Minimum bid limit that can be set by the bid strategy.
100102
// The limit applies to all keywords managed by the strategy.
103+
// This should only be set for portfolio bid strategies.
101104
optional int64 cpc_bid_floor_micros = 6;
102105
}
103106

@@ -133,10 +136,12 @@ message TargetRoas {
133136

134137
// Maximum bid limit that can be set by the bid strategy.
135138
// The limit applies to all keywords managed by the strategy.
139+
// This should only be set for portfolio bid strategies.
136140
optional int64 cpc_bid_ceiling_micros = 5;
137141

138142
// Minimum bid limit that can be set by the bid strategy.
139143
// The limit applies to all keywords managed by the strategy.
144+
// This should only be set for portfolio bid strategies.
140145
optional int64 cpc_bid_floor_micros = 6;
141146
}
142147

‎google/ads/googleads/v7/common/offline_user_data.proto‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,10 @@ message TransactionAttribute {
9191
optional string transaction_date_time = 8;
9292

9393
// Transaction amount in micros. Required.
94+
// Transaction amount in micros needs to be greater than 1000.
95+
// If item Attributes are provided, it represents the total value of the
96+
// items, after multiplying the unit price per item by the quantity provided
97+
// in the ItemAttributes.
9498
optional double transaction_amount_micros = 9;
9599

96100
// Transaction currency code. ISO 4217 three-letter code is used. Required.

‎google/ads/googleads/v7/common/user_lists.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ message SimilarUserListInfo {
4848
// UserList of CRM users provided by the advertiser.
4949
message CrmBasedUserListInfo {
5050
// A string that uniquely identifies a mobile application from which the data
51-
// was collected to the Google Ads API.
51+
// was collected.
5252
// For iOS, the ID string is the 9 digit string that appears at the end of an
5353
// App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is
5454
// http://itunes.apple.com/us/app/flood-it!-2/id476943146).

‎google/ads/googleads/v7/common/value.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ option objc_class_prefix = "GAA";
2727
option php_namespace = "Google\\Ads\\GoogleAds\\V7\\Common";
2828
option ruby_package = "Google::Ads::GoogleAds::V7::Common";
2929

30-
// Proto file describing value types
30+
// Proto file describing value types.
3131

3232
// A generic data container.
3333
message Value {

‎google/ads/googleads/v7/enums/google_ads_field_category.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ option objc_class_prefix = "GAA";
2727
option php_namespace = "Google\\Ads\\GoogleAds\\V7\\Enums";
2828
option ruby_package = "Google::Ads::GoogleAds::V7::Enums";
2929

30-
// Proto file describing GoogleAdsField categories
30+
// Proto file describing GoogleAdsField categories.
3131

3232
// Container for enum that determines if the described artifact is a resource
3333
// or a field, and if it is a field, when it segments search queries.

‎google/ads/googleads/v7/enums/google_ads_field_data_type.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ option objc_class_prefix = "GAA";
2727
option php_namespace = "Google\\Ads\\GoogleAds\\V7\\Enums";
2828
option ruby_package = "Google::Ads::GoogleAds::V7::Enums";
2929

30-
// Proto file describing GoogleAdsField data types
30+
// Proto file describing GoogleAdsField data types.
3131

3232
// Container holding the various data types.
3333
message GoogleAdsFieldDataTypeEnum {

‎google/ads/googleads/v7/enums/lead_form_desired_intent.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ message LeadFormDesiredIntentEnum {
4040
// Deliver more leads at a potentially lower quality.
4141
LOW_INTENT = 2;
4242

43-
// Only leads with a high level of intent are desired.
43+
// Deliver leads that are more qualified.
4444
HIGH_INTENT = 3;
4545
}
4646

‎google/ads/googleads/v7/enums/location_source_type.proto‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@ message LocationSourceTypeEnum {
3939
// Used for return value only. Represents value unknown in this version.
4040
UNKNOWN = 1;
4141

42-
// Locations associated with the customer's linked Google My Business
43-
// account.
42+
// Locations associated with the customer's linked Business Profile.
4443
GOOGLE_MY_BUSINESS = 2;
4544

4645
// Affiliate (chain) store locations. For example, Best Buy store locations.

0 commit comments

Comments
 (0)