Skip to content

Commit

Permalink
feat: Long Pole Launch
Browse files Browse the repository at this point in the history
feat: Enable Custom Column and Custom Floodlight Variable

PiperOrigin-RevId: 606758989
  • Loading branch information
Google APIs authored and Copybara-Service committed Feb 13, 2024
1 parent fc767d4 commit 3b3206a
Show file tree
Hide file tree
Showing 10 changed files with 472 additions and 1 deletion.
7 changes: 7 additions & 0 deletions google/ads/searchads360/v0/common/metrics.proto
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ syntax = "proto3";

package google.ads.searchads360.v0.common;

import "google/ads/searchads360/v0/common/value.proto";
import "google/ads/searchads360/v0/enums/interaction_event_type.proto";
import "google/ads/searchads360/v0/enums/quality_score_bucket.proto";

Expand Down Expand Up @@ -145,6 +146,9 @@ message Metrics {
// value below 0.1 is reported as 0.0999.
optional double content_impression_share = 160;

// The conversion custom metrics.
repeated Value conversion_custom_metrics = 336;

// 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
Expand Down Expand Up @@ -277,6 +281,9 @@ message Metrics {
// The percentage of mobile clicks that go to a mobile-friendly page.
optional double mobile_friendly_clicks_percentage = 229;

// The raw event conversion metrics.
repeated Value raw_event_conversion_metrics = 337;

// The percentage of the customer's Shopping or Search ad impressions that are
// shown in the most prominent Shopping position. See
// https://support.google.com/sa360/answer/9566729
Expand Down
7 changes: 7 additions & 0 deletions google/ads/searchads360/v0/common/segments.proto
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ syntax = "proto3";
package google.ads.searchads360.v0.common;

import "google/ads/searchads360/v0/common/criteria.proto";
import "google/ads/searchads360/v0/common/value.proto";
import "google/ads/searchads360/v0/enums/ad_network_type.proto";
import "google/ads/searchads360/v0/enums/conversion_action_category.proto";
import "google/ads/searchads360/v0/enums/day_of_week.proto";
Expand Down Expand Up @@ -55,6 +56,9 @@ message Segments {
// Conversion action name.
optional string conversion_action_name = 114;

// The conversion custom dimensions.
repeated Value conversion_custom_dimensions = 188;

// Date to which metrics apply.
// yyyy-MM-dd format, for example, 2018-04-17.
optional string date = 79;
Expand Down Expand Up @@ -211,6 +215,9 @@ message Segments {
// 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
optional string quarter = 128;

// The raw event conversion dimensions.
repeated Value raw_event_conversion_dimensions = 189;

// Week as defined as Monday through Sunday, and represented by the date of
// Monday. Formatted as yyyy-MM-dd.
optional string week = 130;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
// 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.searchads360.v0.enums;

option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionCustomVariableCardinalityProto";
option java_package = "com.google.ads.searchads360.v0.enums";
option objc_class_prefix = "GASA360";
option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums";
option ruby_package = "Google::Ads::SearchAds360::V0::Enums";

// Proto file describing conversion custom variable status.

// Container for enum describing the family of a conversion custom variable.
message ConversionCustomVariableCardinalityEnum {
// Cardinality of a conversion custom variable.
enum ConversionCustomVariableCardinality {
// Not specified.
UNSPECIFIED = 0;

// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;

// The conversion custom variable has cardinality below all limits. The
// variable can be used for segmentation, and stats can accrue for
// new values if the variable is enabled.
BELOW_ALL_LIMITS = 2;

// The conversion custom variable has cardinality that exceeds the
// segmentation limit, but does not exceed the stats limit. Segmentation
// will be disabled, but stats can accrue for new values if the variable is
// enabled.
EXCEEDS_SEGMENTATION_LIMIT_BUT_NOT_STATS_LIMIT = 3;

// The conversion custom variable has exceeded the segmentation limits, and
// is approaching the stats limits (> 90%). Segmentation will be disabled,
// but stats can accrue for new values if the variable is enabled.
APPROACHES_STATS_LIMIT = 4;

// The conversion custom variable has exceeded both the segmentation limits
// and stats limits. Segmentation will be disabled, and stats for enabled
// variables can accrue only if the existing values do not increase the
// cardinality of the variable any further.
EXCEEDS_STATS_LIMIT = 5;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
// 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.searchads360.v0.enums;

option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionCustomVariableFamilyProto";
option java_package = "com.google.ads.searchads360.v0.enums";
option objc_class_prefix = "GASA360";
option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums";
option ruby_package = "Google::Ads::SearchAds360::V0::Enums";

// Proto file describing conversion custom variable status.

// Container for enum describing the family of a conversion custom variable.
message ConversionCustomVariableFamilyEnum {
// Family of a conversion custom variable.
enum ConversionCustomVariableFamily {
// Not specified.
UNSPECIFIED = 0;

// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;

// The standard conversion custom variable. Customers are required to
// activate before use.
STANDARD = 2;

// The conversion custom variable imported from a custom floodlight
// variable.
FLOODLIGHT = 3;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
// 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.searchads360.v0.enums;

option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionCustomVariableStatusProto";
option java_package = "com.google.ads.searchads360.v0.enums";
option objc_class_prefix = "GASA360";
option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums";
option ruby_package = "Google::Ads::SearchAds360::V0::Enums";

// Proto file describing conversion custom variable status.

// Container for enum describing possible statuses of a conversion custom
// variable.
message ConversionCustomVariableStatusEnum {
// Possible statuses of a conversion custom variable.
enum ConversionCustomVariableStatus {
// Not specified.
UNSPECIFIED = 0;

// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;

// The conversion custom variable is pending activation and will not
// accrue stats until set to ENABLED.
//
// This status can't be used in CREATE and UPDATE requests.
ACTIVATION_NEEDED = 2;

// The conversion custom variable is enabled and will accrue stats.
ENABLED = 3;

// The conversion custom variable is paused and will not accrue stats
// until set to ENABLED again.
PAUSED = 4;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
// 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.searchads360.v0.enums;

option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FloodlightVariableDataTypeProto";
option java_package = "com.google.ads.searchads360.v0.enums";
option objc_class_prefix = "GASA360";
option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums";
option ruby_package = "Google::Ads::SearchAds360::V0::Enums";

// Proto file describing conversion custom variable status.

// Container for enum describing Floodlight variable type defined in Search Ads
// 360.
message FloodlightVariableDataTypeEnum {
// The data type of the floodlight variable, as defined in Search Ads 360. See
// https://support.google.com/searchads/answer/4397154?hl=en to learn more.
enum FloodlightVariableDataType {
// Not specified.
UNSPECIFIED = 0;

// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;

// Represents a floodlight variable of "Number" type. This variable may be
// assigned to floodlight variables of DIMENSION or METRIC types.
NUMBER = 2;

// Represents a floodlight variable of "String" type. This variable may be
// assigned to floodlight variables of DIMENSION type.
STRING = 3;
}
}
51 changes: 51 additions & 0 deletions google/ads/searchads360/v0/enums/floodlight_variable_type.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
// 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.searchads360.v0.enums;

option csharp_namespace = "Google.Ads.SearchAds360.V0.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FloodlightVariableTypeProto";
option java_package = "com.google.ads.searchads360.v0.enums";
option objc_class_prefix = "GASA360";
option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Enums";
option ruby_package = "Google::Ads::SearchAds360::V0::Enums";

// Proto file describing conversion custom variable status.

// Container for enum describing Floodlight variable type defined in Search Ads
// 360.
message FloodlightVariableTypeEnum {
// Type of the floodlight variable, as defined in the Search Ads 360. See
// https://support.google.com/searchads/answer/4397154?hl=en to learn more.
enum FloodlightVariableType {
// Not specified.
UNSPECIFIED = 0;

// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;

// Dimension floodlight variable type.
DIMENSION = 2;

// Metric floodlight variable type.
METRIC = 3;

// Floodlight variable type is unset.
UNSET = 4;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ message ListingGroupFilterVerticalEnum {
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;

// Represents the shopping vertical.
// Represents the shopping vertical. The vertical is allowed only in
// Performance Max for Retail campaigns.
SHOPPING = 2;
}
}

0 comments on commit 3b3206a

Please sign in to comment.