From eb1a043852e0894c135201a4917b8210ad7bb4fc Mon Sep 17 00:00:00 2001 From: Google APIs Date: Wed, 24 Apr 2024 12:38:30 -0700 Subject: feat: Updated protos and build files for Google Ads API v16 Committer: @Raibaz PiperOrigin-RevId: 627817854 --- google/ads/googleads/v16/common/criteria.proto | 18 +++++++ google/ads/googleads/v16/common/metrics.proto | 36 +++++++------- .../v16/enums/ad_group_primary_status_reason.proto | 4 ++ .../ads/googleads/v16/enums/asset_field_type.proto | 3 ++ .../v16/enums/brand_request_rejection_reason.proto | 53 ++++++++++++++++++++ .../ads/googleads/v16/enums/criterion_type.proto | 3 ++ .../enums/local_services_lead_credit_state.proto | 44 ++++++++++++++++ .../googleads/v16/enums/resource_limit_type.proto | 3 ++ .../v16/enums/response_content_type.proto | 5 +- .../v16/errors/campaign_criterion_error.proto | 7 +++ .../ads/googleads/v16/errors/campaign_error.proto | 4 ++ ..._ad_network_conversion_value_schema_error.proto | 6 +++ google/ads/googleads/v16/errors/errors.proto | 4 ++ .../googleads/v16/errors/experiment_error.proto | 3 ++ .../googleads/v16/errors/product_link_error.proto | 3 ++ .../v16/errors/product_link_invitation_error.proto | 3 ++ .../v16/errors/video_campaign_error.proto | 44 ++++++++++++++++ .../v16/resources/ad_group_criterion.proto | 5 +- google/ads/googleads/v16/resources/campaign.proto | 5 +- .../v16/resources/campaign_criterion.proto | 3 -- .../v16/resources/campaign_simulation.proto | 1 + .../v16/resources/conversion_value_rule.proto | 3 -- google/ads/googleads/v16/resources/customer.proto | 9 ++++ .../resources/customer_negative_criterion.proto | 4 ++ ...mer_sk_ad_network_conversion_value_schema.proto | 58 ++++++++++++++++++++++ .../ads/googleads/v16/resources/gender_view.proto | 3 ++ .../v16/resources/local_services_lead.proto | 18 +++++++ .../local_services_lead_conversation.proto | 5 ++ .../googleads/v16/resources/location_view.proto | 6 ++- ...d_network_conversion_value_schema_service.proto | 11 ++++ 30 files changed, 343 insertions(+), 31 deletions(-) create mode 100644 google/ads/googleads/v16/enums/brand_request_rejection_reason.proto create mode 100644 google/ads/googleads/v16/enums/local_services_lead_credit_state.proto create mode 100644 google/ads/googleads/v16/errors/video_campaign_error.proto diff --git a/google/ads/googleads/v16/common/criteria.proto b/google/ads/googleads/v16/common/criteria.proto index 4e245fc78..371dfd758 100644 --- a/google/ads/googleads/v16/common/criteria.proto +++ b/google/ads/googleads/v16/common/criteria.proto @@ -18,6 +18,8 @@ package google.ads.googleads.v16.common; import "google/ads/googleads/v16/enums/age_range_type.proto"; import "google/ads/googleads/v16/enums/app_payment_model_type.proto"; +import "google/ads/googleads/v16/enums/brand_request_rejection_reason.proto"; +import "google/ads/googleads/v16/enums/brand_state.proto"; import "google/ads/googleads/v16/enums/content_label_type.proto"; import "google/ads/googleads/v16/enums/day_of_week.proto"; import "google/ads/googleads/v16/enums/device.proto"; @@ -39,6 +41,7 @@ import "google/ads/googleads/v16/enums/product_type_level.proto"; import "google/ads/googleads/v16/enums/proximity_radius_units.proto"; import "google/ads/googleads/v16/enums/webpage_condition_operand.proto"; import "google/ads/googleads/v16/enums/webpage_condition_operator.proto"; +import "google/api/field_behavior.proto"; import "google/api/resource.proto"; option csharp_namespace = "Google.Ads.GoogleAds.V16.Common"; @@ -821,8 +824,23 @@ message SearchThemeInfo { // Represents a Brand Criterion used for targeting based on commercial knowledge // graph. message BrandInfo { + // Output only. A text representation of a brand. + optional string display_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + // The Commercial KG MID for the brand. optional string entity_id = 1; + + // Output only. The primary url of a brand. + optional string primary_url = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The rejection reason when a brand status is REJECTED. + optional google.ads.googleads.v16.enums.BrandRequestRejectionReasonEnum + .BrandRequestRejectionReason rejection_reason = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The status of a brand. + optional google.ads.googleads.v16.enums.BrandStateEnum.BrandState status = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // A Brand List Criterion is used to specify a list of brands. The list is diff --git a/google/ads/googleads/v16/common/metrics.proto b/google/ads/googleads/v16/common/metrics.proto index 887ac2add..d5846b81f 100644 --- a/google/ads/googleads/v16/common/metrics.proto +++ b/google/ads/googleads/v16/common/metrics.proto @@ -32,8 +32,8 @@ option ruby_package = "Google::Ads::GoogleAds::V16::Common"; // Metrics data. message Metrics { - // The percent of your ad impressions that are shown as the very first ad - // above the organic search results. + // Search absolute top impression share is the percentage of your Search ad + // impressions that are shown in the most prominent Search position. optional double absolute_top_impression_percentage = 183; // Average cost of viewable impressions (`active_view_impressions`). @@ -147,8 +147,8 @@ message Metrics { optional double all_conversions_from_store_website = 202; // This metric is part of the Auction Insights report, and tells how often - // the ads of another participant showed as the very first ad above the - // organic search results. + // the ads of another participant showed in the most prominent position on the + // search results page. // This percentage is computed only over the auctions that you appeared in // the page. // @@ -188,9 +188,9 @@ message Metrics { optional double auction_insight_search_position_above_rate = 262; // This metric is part of the Auction Insights report, and tells how often - // the ads of another participant showed above the organic search results. - // This percentage is computed only over the auctions that you appeared in - // the page. + // the ads of another participant showed adjacent to the top organic search + // results. This percentage is computed only over the auctions that you + // appeared in the page. // // This metric is not publicly available. optional double auction_insight_search_top_impression_percentage = 263; @@ -581,8 +581,8 @@ message Metrics { // for details. Any value below 0.1 is reported as 0.0999. optional double search_absolute_top_impression_share = 136; - // The number estimating how often your ad wasn't the very first ad above the - // organic search results due to a low budget. Note: Search + // The number estimating how often your ad wasn't the very first ad among the + // top ads in the search results due to a low budget. Note: Search // budget lost absolute top impression share is reported in the range of 0 to // 0.9. Any value above 0.9 is reported as 0.9001. optional double search_budget_lost_absolute_top_impression_share = 137; @@ -593,7 +593,7 @@ message Metrics { // value above 0.9 is reported as 0.9001. optional double search_budget_lost_impression_share = 138; - // The number estimating how often your ad didn't show anywhere above the + // The number estimating how often your ad didn't show adjacent to the top // organic search results due to a low budget. Note: Search // budget lost top impression share is reported in the range of 0 to 0.9. Any // value above 0.9 is reported as 0.9001. @@ -619,8 +619,8 @@ message Metrics { // value below 0.1 is reported as 0.0999. optional double search_impression_share = 142; - // The number estimating how often your ad wasn't the very first ad above the - // organic search results due to poor Ad Rank. + // The number estimating how often your ad wasn't the very first ad among the + // top ads in the search results due to poor Ad Rank. // Note: Search rank lost absolute top impression share is reported in the // range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. optional double search_rank_lost_absolute_top_impression_share = 143; @@ -631,17 +631,19 @@ message Metrics { // 0.9. Any value above 0.9 is reported as 0.9001. optional double search_rank_lost_impression_share = 144; - // The number estimating how often your ad didn't show anywhere above the + // The number estimating how often your ad didn't show adjacent to the top // organic search results due to poor Ad Rank. // Note: Search rank lost top impression share is reported in the range of 0 // to 0.9. Any value above 0.9 is reported as 0.9001. optional double search_rank_lost_top_impression_share = 145; - // The impressions you've received in the top location (anywhere above the - // organic search results) compared to the estimated number of impressions you - // were eligible to receive in the top location. + // The impressions you've received among the top ads compared to the estimated + // number of impressions you were eligible to receive among the top ads. // Note: Search top impression share is reported in the range of 0.1 to 1. Any // value below 0.1 is reported as 0.0999. + // + // Top ads are generally above the top organic results, although they may show + // below the top organic results on certain queries. optional double search_top_impression_share = 146; // Search volume range for a search term insight category. @@ -659,7 +661,7 @@ message Metrics { // campaigns that had traffic from portfolio bidding strategies or non-tROAS). optional double average_target_roas = 250; - // The percent of your ad impressions that are shown anywhere above the + // The percent of your ad impressions that are shown adjacent to the top // organic search results. optional double top_impression_percentage = 148; diff --git a/google/ads/googleads/v16/enums/ad_group_primary_status_reason.proto b/google/ads/googleads/v16/enums/ad_group_primary_status_reason.proto index f112a0f2a..79763ed5b 100644 --- a/google/ads/googleads/v16/enums/ad_group_primary_status_reason.proto +++ b/google/ads/googleads/v16/enums/ad_group_primary_status_reason.proto @@ -98,5 +98,9 @@ message AdGroupPrimaryStatusReasonEnum { // The AdGroup belongs to a Draft campaign. Contributes to // AdGroupPrimaryStatus.NOT_ELIGIBLE. CAMPAIGN_DRAFT = 16; + + // Ad group has been paused due to prolonged low activity in serving. + // Contributes to AdGroupPrimaryStatus.PAUSED. + AD_GROUP_PAUSED_DUE_TO_LOW_ACTIVITY = 19; } } diff --git a/google/ads/googleads/v16/enums/asset_field_type.proto b/google/ads/googleads/v16/enums/asset_field_type.proto index 8a67e20bb..6b135af8c 100644 --- a/google/ads/googleads/v16/enums/asset_field_type.proto +++ b/google/ads/googleads/v16/enums/asset_field_type.proto @@ -119,5 +119,8 @@ message AssetFieldTypeEnum { // The asset is linked for use as a hotel property in a Performance Max for // travel goals campaign. HOTEL_PROPERTY = 28; + + // The asset is linked for use as a discovery carousel card. + DISCOVERY_CAROUSEL_CARD = 29; } } diff --git a/google/ads/googleads/v16/enums/brand_request_rejection_reason.proto b/google/ads/googleads/v16/enums/brand_request_rejection_reason.proto new file mode 100644 index 000000000..3c967dadd --- /dev/null +++ b/google/ads/googleads/v16/enums/brand_request_rejection_reason.proto @@ -0,0 +1,53 @@ +// Copyright 2023 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. + +syntax = "proto3"; + +package google.ads.googleads.v16.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V16.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "BrandRequestRejectionReasonProto"; +option java_package = "com.google.ads.googleads.v16.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V16::Enums"; + +// Proto file describing the brand request rejection reason for the criterion. + +// Container for enum describing rejection reasons for the customer brand +// requests. +message BrandRequestRejectionReasonEnum { + // Enumeration of different brand request rejection reasons. + enum BrandRequestRejectionReason { + // No value has been specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Brand is already present in the commercial brand set. + EXISTING_BRAND = 2; + + // Brand is already present in the commercial brand set, but is a variant. + EXISTING_BRAND_VARIANT = 3; + + // Brand information is not correct (eg: URL and name don't match). + INCORRECT_INFORMATION = 4; + + // Not a valid brand as per Google policy. + NOT_A_BRAND = 5; + } +} diff --git a/google/ads/googleads/v16/enums/criterion_type.proto b/google/ads/googleads/v16/enums/criterion_type.proto index 64f7a1979..80da17a12 100644 --- a/google/ads/googleads/v16/enums/criterion_type.proto +++ b/google/ads/googleads/v16/enums/criterion_type.proto @@ -153,5 +153,8 @@ message CriterionTypeEnum { // Brand List BRAND_LIST = 40; + + // Life Event + LIFE_EVENT = 41; } } diff --git a/google/ads/googleads/v16/enums/local_services_lead_credit_state.proto b/google/ads/googleads/v16/enums/local_services_lead_credit_state.proto new file mode 100644 index 000000000..addb614f8 --- /dev/null +++ b/google/ads/googleads/v16/enums/local_services_lead_credit_state.proto @@ -0,0 +1,44 @@ +// Copyright 2023 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. + +syntax = "proto3"; + +package google.ads.googleads.v16.enums; + +option csharp_namespace = "Google.Ads.GoogleAds.V16.Enums"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/enums;enums"; +option java_multiple_files = true; +option java_outer_classname = "LocalServicesLeadCreditStateProto"; +option java_package = "com.google.ads.googleads.v16.enums"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Enums"; +option ruby_package = "Google::Ads::GoogleAds::V16::Enums"; + +// Container for enum describing possible credit states of a lead. +message LocalServicesCreditStateEnum { + // Possible credit states of a lead. + enum CreditState { + // Not specified. + UNSPECIFIED = 0; + + // Used for return value only. Represents value unknown in this version. + UNKNOWN = 1; + + // Credit is pending. + PENDING = 2; + + // Credit request is complete. + CREDITED = 3; + } +} diff --git a/google/ads/googleads/v16/enums/resource_limit_type.proto b/google/ads/googleads/v16/enums/resource_limit_type.proto index 432b195a3..17e8b7f1c 100644 --- a/google/ads/googleads/v16/enums/resource_limit_type.proto +++ b/google/ads/googleads/v16/enums/resource_limit_type.proto @@ -489,5 +489,8 @@ message ResourceLimitTypeEnum { // Maximum number of shared sets of brand type for an account. SHARED_SETS_PER_ACCOUNT_FOR_BRAND = 185; + + // Maximum number of lookalike lists per customer. + LOOKALIKE_USER_LISTS_PER_CUSTOMER = 186; } } diff --git a/google/ads/googleads/v16/enums/response_content_type.proto b/google/ads/googleads/v16/enums/response_content_type.proto index 29b9e924d..a091fade1 100644 --- a/google/ads/googleads/v16/enums/response_content_type.proto +++ b/google/ads/googleads/v16/enums/response_content_type.proto @@ -37,8 +37,9 @@ message ResponseContentTypeEnum { // The mutate response will be the resource name. RESOURCE_NAME_ONLY = 1; - // The mutate response will be the resource name and the resource with - // all mutable fields. + // The mutate response will contain the resource name and the resource with + // mutable fields if possible. Otherwise, only the resource name will be + // returned. MUTABLE_RESOURCE = 2; } } diff --git a/google/ads/googleads/v16/errors/campaign_criterion_error.proto b/google/ads/googleads/v16/errors/campaign_criterion_error.proto index be0a9e880..d358ba931 100644 --- a/google/ads/googleads/v16/errors/campaign_criterion_error.proto +++ b/google/ads/googleads/v16/errors/campaign_criterion_error.proto @@ -124,5 +124,12 @@ message CampaignCriterionErrorEnum { // exclusive targeting, broad match campaigns for inclusive targeting or // PMax generated campaigns. CANNOT_ATTACH_BRAND_LIST_TO_NON_QUALIFIED_SEARCH_CAMPAIGN = 26; + + // Campaigns that target all countries and territories are limited to a + // certain number of top-level location exclusions. If removing a criterion + // causes the campaign to target all countries and territories and the + // campaign has more top-level location exclusions than the limit allows, + // then this error is returned. + CANNOT_REMOVE_ALL_LOCATIONS_DUE_TO_TOO_MANY_COUNTRY_EXCLUSIONS = 27; } } diff --git a/google/ads/googleads/v16/errors/campaign_error.proto b/google/ads/googleads/v16/errors/campaign_error.proto index aa60cde22..5966dfb1e 100644 --- a/google/ads/googleads/v16/errors/campaign_error.proto +++ b/google/ads/googleads/v16/errors/campaign_error.proto @@ -299,5 +299,9 @@ message CampaignErrorEnum { // active Performance Max optimization automatically created assets // experiment. End the experiment to modify these settings. CANNOT_MODIFY_TEXT_ASSET_AUTOMATION_WITH_ENABLED_TRIAL = 88; + + // Dynamic text asset cannot be opted out when final URL expansion is opted + // in. + DYNAMIC_TEXT_ASSET_CANNOT_OPT_OUT_WITH_FINAL_URL_EXPANSION_OPT_IN = 89; } } diff --git a/google/ads/googleads/v16/errors/customer_sk_ad_network_conversion_value_schema_error.proto b/google/ads/googleads/v16/errors/customer_sk_ad_network_conversion_value_schema_error.proto index 8cd380d0f..e0bb1b9d4 100644 --- a/google/ads/googleads/v16/errors/customer_sk_ad_network_conversion_value_schema_error.proto +++ b/google/ads/googleads/v16/errors/customer_sk_ad_network_conversion_value_schema_error.proto @@ -49,5 +49,11 @@ message CustomerSkAdNetworkConversionValueSchemaErrorEnum { // The customer link id provided could not be found. LINK_CODE_NOT_FOUND = 5; + + // The SkAdNetwork event counter provided is invalid. + INVALID_EVENT_COUNTER = 7; + + // The SkAdNetwork event name provided is invalid. + INVALID_EVENT_NAME = 8; } } diff --git a/google/ads/googleads/v16/errors/errors.proto b/google/ads/googleads/v16/errors/errors.proto index 50d74615a..4e3a0db8d 100644 --- a/google/ads/googleads/v16/errors/errors.proto +++ b/google/ads/googleads/v16/errors/errors.proto @@ -169,6 +169,7 @@ import "google/ads/googleads/v16/errors/time_zone_error.proto"; import "google/ads/googleads/v16/errors/url_field_error.proto"; import "google/ads/googleads/v16/errors/user_data_error.proto"; import "google/ads/googleads/v16/errors/user_list_error.proto"; +import "google/ads/googleads/v16/errors/video_campaign_error.proto"; import "google/ads/googleads/v16/errors/youtube_video_registration_error.proto"; import "google/protobuf/duration.proto"; @@ -258,6 +259,9 @@ message ErrorCode { // An error with a Campaign mutate. CampaignErrorEnum.CampaignError campaign_error = 15; + // An error with a Video Campaign mutate. + VideoCampaignErrorEnum.VideoCampaignError video_campaign_error = 182; + // Indicates failure to properly authenticate user. AuthenticationErrorEnum.AuthenticationError authentication_error = 17; diff --git a/google/ads/googleads/v16/errors/experiment_error.proto b/google/ads/googleads/v16/errors/experiment_error.proto index 8157088ae..a134ed7aa 100644 --- a/google/ads/googleads/v16/errors/experiment_error.proto +++ b/google/ads/googleads/v16/errors/experiment_error.proto @@ -129,5 +129,8 @@ message ExperimentErrorEnum { // experiment types: SEARCH_CUSTOM, DISPLAY_CUSTOM, // DISPLAY_AUTOMATED_BIDDING_STRATEGY, SEARCH_AUTOMATED_BIDDING_STRATEGY. CANNOT_ENABLE_SYNC_FOR_UNSUPPORTED_EXPERIMENT_TYPE = 29; + + // Experiment length cannot be longer than max length. + INVALID_DURATION_FOR_AN_EXPERIMENT = 30; } } diff --git a/google/ads/googleads/v16/errors/product_link_error.proto b/google/ads/googleads/v16/errors/product_link_error.proto index 3f225368c..96a7637b1 100644 --- a/google/ads/googleads/v16/errors/product_link_error.proto +++ b/google/ads/googleads/v16/errors/product_link_error.proto @@ -46,5 +46,8 @@ message ProductLinkErrorEnum { // A link cannot be created because a pending link already exists. INVITATION_EXISTS = 4; + + // A link cannot be created because an active link already exists. + LINK_EXISTS = 5; } } diff --git a/google/ads/googleads/v16/errors/product_link_invitation_error.proto b/google/ads/googleads/v16/errors/product_link_invitation_error.proto index 83ec7284c..0ea8f9d10 100644 --- a/google/ads/googleads/v16/errors/product_link_invitation_error.proto +++ b/google/ads/googleads/v16/errors/product_link_invitation_error.proto @@ -47,5 +47,8 @@ message ProductLinkInvitationErrorEnum { // access to the invited account. Use the ProductLinkService to directly // create an active link. NO_INVITATION_REQUIRED = 4; + + // The customer is not permitted to create the invitation. + CUSTOMER_NOT_PERMITTED_TO_CREATE_INVITATION = 5; } } diff --git a/google/ads/googleads/v16/errors/video_campaign_error.proto b/google/ads/googleads/v16/errors/video_campaign_error.proto new file mode 100644 index 000000000..e06c606d9 --- /dev/null +++ b/google/ads/googleads/v16/errors/video_campaign_error.proto @@ -0,0 +1,44 @@ +// Copyright 2023 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. + +syntax = "proto3"; + +package google.ads.googleads.v16.errors; + +option csharp_namespace = "Google.Ads.GoogleAds.V16.Errors"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/errors;errors"; +option java_multiple_files = true; +option java_outer_classname = "VideoCampaignErrorProto"; +option java_package = "com.google.ads.googleads.v16.errors"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Errors"; +option ruby_package = "Google::Ads::GoogleAds::V16::Errors"; + +// Proto file describing video campaign errors. + +// Container for enum describing possible video campaign errors. +message VideoCampaignErrorEnum { + // Enum describing possible video campaign errors. + enum VideoCampaignError { + // Enum unspecified. + UNSPECIFIED = 0; + + // The received error code is not known in this version. + UNKNOWN = 1; + + // Cannot modify the video campaign without reservation. + // See https://support.google.com/google-ads/answer/9547606. + MUTATE_REQUIRES_RESERVATION = 2; + } +} diff --git a/google/ads/googleads/v16/resources/ad_group_criterion.proto b/google/ads/googleads/v16/resources/ad_group_criterion.proto index 4f23b5822..c35bced71 100644 --- a/google/ads/googleads/v16/resources/ad_group_criterion.proto +++ b/google/ads/googleads/v16/resources/ad_group_criterion.proto @@ -39,6 +39,8 @@ option ruby_package = "Google::Ads::GoogleAds::V16::Resources"; // Proto file describing the ad group criterion resource. // An ad group criterion. +// The ad_group_criterion report only returns criteria that were explicitly +// added to the ad group. message AdGroupCriterion { option (google.api.resource) = { type: "googleads.googleapis.com/AdGroupCriterion" @@ -295,9 +297,6 @@ message AdGroupCriterion { [(google.api.field_behavior) = IMMUTABLE]; // Immutable. User List. - // The Similar Audiences sunset starts May 2023. Refer to - // https://ads-developers.googleblog.com/2022/11/announcing-deprecation-and-sunset-of.html - // for other options. google.ads.googleads.v16.common.UserListInfo user_list = 42 [(google.api.field_behavior) = IMMUTABLE]; diff --git a/google/ads/googleads/v16/resources/campaign.proto b/google/ads/googleads/v16/resources/campaign.proto index fbe324baf..2a3c41361 100644 --- a/google/ads/googleads/v16/resources/campaign.proto +++ b/google/ads/googleads/v16/resources/campaign.proto @@ -524,7 +524,10 @@ message Campaign { repeated google.ads.googleads.v16.common.FrequencyCapEntry frequency_caps = 40; - // Output only. 3-Tier Brand Safety setting for the campaign. + // Output only. Brand Safety setting at the individual campaign level. Allows + // for selecting an inventory type to show your ads on content that is the + // right fit for your brand. See + // https://support.google.com/google-ads/answer/7515513. google.ads.googleads.v16.enums.BrandSafetySuitabilityEnum .BrandSafetySuitability video_brand_safety_suitability = 42 [(google.api.field_behavior) = OUTPUT_ONLY]; diff --git a/google/ads/googleads/v16/resources/campaign_criterion.proto b/google/ads/googleads/v16/resources/campaign_criterion.proto index c85fab99f..1da73358d 100644 --- a/google/ads/googleads/v16/resources/campaign_criterion.proto +++ b/google/ads/googleads/v16/resources/campaign_criterion.proto @@ -134,9 +134,6 @@ message CampaignCriterion { [(google.api.field_behavior) = IMMUTABLE]; // Immutable. User List. - // The Similar Audiences sunset starts May 2023. Refer to - // https://ads-developers.googleblog.com/2022/11/announcing-deprecation-and-sunset-of.html - // for other options. google.ads.googleads.v16.common.UserListInfo user_list = 22 [(google.api.field_behavior) = IMMUTABLE]; diff --git a/google/ads/googleads/v16/resources/campaign_simulation.proto b/google/ads/googleads/v16/resources/campaign_simulation.proto index 8714e4b16..42c85ba6f 100644 --- a/google/ads/googleads/v16/resources/campaign_simulation.proto +++ b/google/ads/googleads/v16/resources/campaign_simulation.proto @@ -47,6 +47,7 @@ option ruby_package = "Google::Ads::GoogleAds::V16::Resources"; // * SHOPPING - BUDGET - UNIFORM // * SHOPPING - TARGET_ROAS - UNIFORM // * MULTI_CHANNEL - TARGET_CPA - UNIFORM +// * MULTI_CHANNEL - TARGET_ROAS - UNIFORM // * DISCOVERY - TARGET_CPA - DEFAULT // * DISPLAY - TARGET_CPA - UNIFORM // * PERFORMANCE_MAX - TARGET_CPA - UNIFORM diff --git a/google/ads/googleads/v16/resources/conversion_value_rule.proto b/google/ads/googleads/v16/resources/conversion_value_rule.proto index 9b6698d1c..2c9dc40fc 100644 --- a/google/ads/googleads/v16/resources/conversion_value_rule.proto +++ b/google/ads/googleads/v16/resources/conversion_value_rule.proto @@ -84,9 +84,6 @@ message ConversionValueRule { // Condition on Audience dimension. message ValueRuleAudienceCondition { // User Lists. - // The Similar Audiences sunset starts May 2023. Refer to - // https://ads-developers.googleblog.com/2022/11/announcing-deprecation-and-sunset-of.html - // for other options. repeated string user_lists = 1 [(google.api.resource_reference) = { type: "googleads.googleapis.com/UserList" }]; diff --git a/google/ads/googleads/v16/resources/customer.proto b/google/ads/googleads/v16/resources/customer.proto index dfb16670d..e8b0132c9 100644 --- a/google/ads/googleads/v16/resources/customer.proto +++ b/google/ads/googleads/v16/resources/customer.proto @@ -16,6 +16,7 @@ syntax = "proto3"; package google.ads.googleads.v16.resources; +import "google/ads/googleads/v16/enums/brand_safety_suitability.proto"; import "google/ads/googleads/v16/enums/conversion_tracking_status_enum.proto"; import "google/ads/googleads/v16/enums/customer_pay_per_conversion_eligibility_failure_reason.proto"; import "google/ads/googleads/v16/enums/customer_status.proto"; @@ -168,6 +169,14 @@ message Customer { // Output only. Settings for Local Services customer. LocalServicesSettings local_services_settings = 45 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Brand Safety setting at the account level. Allows for + // selecting an inventory type to show your ads on content that is the right + // fit for your brand. See + // https://support.google.com/google-ads/answer/7515513. + google.ads.googleads.v16.enums.BrandSafetySuitabilityEnum + .BrandSafetySuitability video_brand_safety_suitability = 46 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Call reporting setting for a customer. Only mutable in an `update` operation. diff --git a/google/ads/googleads/v16/resources/customer_negative_criterion.proto b/google/ads/googleads/v16/resources/customer_negative_criterion.proto index 1b1c6c65c..6ea73627d 100644 --- a/google/ads/googleads/v16/resources/customer_negative_criterion.proto +++ b/google/ads/googleads/v16/resources/customer_negative_criterion.proto @@ -88,5 +88,9 @@ message CustomerNegativeCriterion { // Immutable. NegativeKeywordList. google.ads.googleads.v16.common.NegativeKeywordListInfo negative_keyword_list = 11 [(google.api.field_behavior) = IMMUTABLE]; + + // Immutable. IPBLock + google.ads.googleads.v16.common.IpBlockInfo ip_block = 12 + [(google.api.field_behavior) = IMMUTABLE]; } } diff --git a/google/ads/googleads/v16/resources/customer_sk_ad_network_conversion_value_schema.proto b/google/ads/googleads/v16/resources/customer_sk_ad_network_conversion_value_schema.proto index 1c6a3950b..09fca8945 100644 --- a/google/ads/googleads/v16/resources/customer_sk_ad_network_conversion_value_schema.proto +++ b/google/ads/googleads/v16/resources/customer_sk_ad_network_conversion_value_schema.proto @@ -16,6 +16,7 @@ syntax = "proto3"; package google.ads.googleads.v16.resources; +import "google/ads/googleads/v16/enums/sk_ad_network_coarse_conversion_value.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; @@ -52,6 +53,54 @@ message CustomerSkAdNetworkConversionValueSchema { [(google.api.field_behavior) = OUTPUT_ONLY]; } + // Mappings for each postback in multiple conversion windows. + message PostbackMapping { + // Output only. 0-based index that indicates the order of postback. Valid + // values are in the inclusive range [0,2]. + int32 postback_sequence_index = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Conversion value mappings for all coarse grained + // conversion values. + CoarseGrainedConversionValueMappings + coarse_grained_conversion_value_mappings = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Event or conversion value used for locking conversion window. + oneof lock_window_trigger { + // Output only. Coarse grained conversion value that triggers conversion + // window lock. + google.ads.googleads.v16.enums.SkAdNetworkCoarseConversionValueEnum + .SkAdNetworkCoarseConversionValue + lock_window_coarse_conversion_value = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Fine grained conversion value that triggers conversion + // window lock. + int32 lock_window_fine_conversion_value = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Event name that triggers conversion window lock. + string lock_window_event = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; + } + } + + // Mappings for coarse grained conversion values. + message CoarseGrainedConversionValueMappings { + // Output only. Mapping for "low" coarse conversion value. + ConversionValueMapping low_conversion_value_mapping = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Mapping for "medium" coarse conversion value. + ConversionValueMapping medium_conversion_value_mapping = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Mapping for "high" coarse conversion value. + ConversionValueMapping high_conversion_value_mapping = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; + } + // Represents mapping from one conversion value to one or more conversion // events. message ConversionValueMapping { @@ -142,9 +191,18 @@ message CustomerSkAdNetworkConversionValueSchema { [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Fine grained conversion value mappings. + // For SkAdNetwork versions >= 4.0 that support multiple conversion + // windows, fine grained conversion value mappings are only applicable to + // the first postback. repeated FineGrainedConversionValueMappings fine_grained_conversion_value_mappings = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Per-postback conversion value mappings for postbacks in + // multiple conversion windows. Only applicable for SkAdNetwork versions + // >= 4.0. + repeated PostbackMapping postback_mappings = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Output only. The resource name of the schema. diff --git a/google/ads/googleads/v16/resources/gender_view.proto b/google/ads/googleads/v16/resources/gender_view.proto index 15559b888..fdcfaf6a8 100644 --- a/google/ads/googleads/v16/resources/gender_view.proto +++ b/google/ads/googleads/v16/resources/gender_view.proto @@ -31,6 +31,9 @@ option ruby_package = "Google::Ads::GoogleAds::V16::Resources"; // Proto file describing the gender view resource. // A gender view. +// The gender_view resource reflects the effective serving state, rather than +// what criteria were added. An ad group without gender criteria by default +// shows to all genders, so all genders appear in gender_view with stats. message GenderView { option (google.api.resource) = { type: "googleads.googleapis.com/GenderView" diff --git a/google/ads/googleads/v16/resources/local_services_lead.proto b/google/ads/googleads/v16/resources/local_services_lead.proto index 9cf854a01..e538f3996 100644 --- a/google/ads/googleads/v16/resources/local_services_lead.proto +++ b/google/ads/googleads/v16/resources/local_services_lead.proto @@ -16,6 +16,7 @@ syntax = "proto3"; package google.ads.googleads.v16.resources; +import "google/ads/googleads/v16/enums/local_services_lead_credit_state.proto"; import "google/ads/googleads/v16/enums/local_services_lead_status.proto"; import "google/ads/googleads/v16/enums/local_services_lead_type.proto"; import "google/api/field_behavior.proto"; @@ -94,6 +95,10 @@ message LocalServicesLead { // Output only. True if the advertiser was charged for the lead. bool lead_charged = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Credit details of the lead. + optional CreditDetails credit_details = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Fields containing consumer contact details. @@ -120,3 +125,16 @@ message Note { // Output only. Content of lead note. string description = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } + +// Represents the credit details of a lead. +message CreditDetails { + // Output only. Credit state of the lead. + google.ads.googleads.v16.enums.LocalServicesCreditStateEnum.CreditState + credit_state = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The date time when the credit state of the lead was last + // updated. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's + // timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30" + string credit_state_last_update_date_time = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/google/ads/googleads/v16/resources/local_services_lead_conversation.proto b/google/ads/googleads/v16/resources/local_services_lead_conversation.proto index 8cd107d57..f0d11e72e 100644 --- a/google/ads/googleads/v16/resources/local_services_lead_conversation.proto +++ b/google/ads/googleads/v16/resources/local_services_lead_conversation.proto @@ -105,4 +105,9 @@ message PhoneCallDetails { message MessageDetails { // Output only. Textual content of the message. string text = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. URL to the SMS or email attachments. These URLs can be used to + // download the contents of the attachment by using the developer token. + repeated string attachment_urls = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/google/ads/googleads/v16/resources/location_view.proto b/google/ads/googleads/v16/resources/location_view.proto index c7b542607..919fd855d 100644 --- a/google/ads/googleads/v16/resources/location_view.proto +++ b/google/ads/googleads/v16/resources/location_view.proto @@ -30,8 +30,10 @@ option ruby_package = "Google::Ads::GoogleAds::V16::Resources"; // Proto file describing the location view resource. -// A location view summarizes the performance of campaigns by -// Location criteria. +// A location view summarizes the performance of campaigns by a Location +// criterion. +// If no Location criterion is set, no results are returned; instead, use +// geographic_view or user_location_view for visitor location data. message LocationView { option (google.api.resource) = { type: "googleads.googleapis.com/LocationView" diff --git a/google/ads/googleads/v16/services/customer_sk_ad_network_conversion_value_schema_service.proto b/google/ads/googleads/v16/services/customer_sk_ad_network_conversion_value_schema_service.proto index c60f9ba81..8c70b933b 100644 --- a/google/ads/googleads/v16/services/customer_sk_ad_network_conversion_value_schema_service.proto +++ b/google/ads/googleads/v16/services/customer_sk_ad_network_conversion_value_schema_service.proto @@ -19,7 +19,9 @@ package google.ads.googleads.v16.services; import "google/ads/googleads/v16/resources/customer_sk_ad_network_conversion_value_schema.proto"; import "google/api/annotations.proto"; import "google/api/client.proto"; +import "google/api/field_behavior.proto"; import "google/api/resource.proto"; +import "google/rpc/status.proto"; option csharp_namespace = "Google.Ads.GoogleAds.V16.Services"; option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/services;services"; @@ -74,6 +76,11 @@ message MutateCustomerSkAdNetworkConversionValueSchemaRequest { // If true, the request is validated but not executed. Only errors are // returned, not results. bool validate_only = 3; + + // Optional. If true, enables returning warnings. Warnings return error + // messages and error codes without blocking the execution of the mutate + // operation. + bool enable_warnings = 4 [(google.api.field_behavior) = OPTIONAL]; } // The result for the CustomerSkAdNetworkConversionValueSchema mutate. @@ -91,4 +98,8 @@ message MutateCustomerSkAdNetworkConversionValueSchemaResult { message MutateCustomerSkAdNetworkConversionValueSchemaResponse { // All results for the mutate. MutateCustomerSkAdNetworkConversionValueSchemaResult result = 1; + + // Non blocking errors that provides schema validation failure details. + // Returned only when enable_warnings = true. + google.rpc.Status warning = 2; } -- cgit v1.2.3