GlcoinCore/googleapis
1
0
Fork 0
mirror of https://github.com/googleapis/googleapis.git synced 2026-08-18 13:08:24 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(googleads)!: remove protos for v8, which has sunset

Browse source 
Committer: @aohren

BREAKING CHANGE: Removing the entire version 8 of the Google Ads API because it has sunset and is no longer available.

PiperOrigin-RevId: 462082162
This commit is contained in:
Google APIs 2022-07-20 01:41:57 -07:00 • committed by Copybara-Service
parent 90c21c04d5
commit d8e37bb043
689 changed files with 0 additions and 68801 deletions
Download patch file Download diff file Expand all files Collapse all files

267
google/ads/googleads/v8/BUILD.bazel
View file

@ -1,267 +0,0 @@
# Copyright 2020 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
#
# https://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.
package(default_visibility = ["//visibility:public"])
exports_files(["googleads_grpc_service_config.json"] + ["*.yaml"])
##############################################################################
# Common
##############################################################################
load("@rules_proto//proto:defs.bzl", "proto_library")
load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info")
proto_library(
name = "googleads_proto",
srcs = [],
deps = [
"//google/ads/googleads/v8/common:common_proto",
"//google/ads/googleads/v8/enums:enums_proto",
"//google/ads/googleads/v8/errors:errors_proto",
"//google/ads/googleads/v8/resources:resources_proto",
"//google/ads/googleads/v8/services:services_proto",
],
)
proto_library_with_info(
name = "googleads_proto_with_info",
deps = [
":googleads_proto",
],
)
##############################################################################
# Java
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"java_gapic_assembly_gradle_pkg",
"java_gapic_library",
"java_gapic_test",
)
java_gapic_library(
name = "googleads_java_gapic",
srcs = [
":googleads_proto_with_info",
],
gapic_yaml = "googleads_gapic.yaml",
grpc_service_config = ":googleads_grpc_service_config.json",
deps = [
"//google/ads/googleads/v8/common:common_java_proto",
"//google/ads/googleads/v8/enums:enums_java_proto",
"//google/ads/googleads/v8/resources:resources_java_proto",
"//google/ads/googleads/v8/services:services_java_grpc",
"//google/ads/googleads/v8/services:services_java_proto",
],
)
# TODO(ohren): Add more test classes when java_gapic_test is able to run more
# than a single test. Having at least one verifies proper compilation at least.
java_gapic_test(
name = "googleads_java_gapic_suite",
test_classes = [
"com.google.ads.googleads.v8.services.CampaignServiceClientTest",
],
runtime_deps = [":googleads_java_gapic_test"],
)
java_gapic_assembly_gradle_pkg(
name = "googleads-java",
deps = [
":googleads_java_gapic",
"//google/ads/googleads/v8:googleads_proto",
"//google/ads/googleads/v8/common:common_java_proto",
"//google/ads/googleads/v8/enums:enums_java_proto",
"//google/ads/googleads/v8/errors:errors_java_proto",
"//google/ads/googleads/v8/resources:resources_java_proto",
"//google/ads/googleads/v8/services:services_java_grpc",
"//google/ads/googleads/v8/services:services_java_proto",
],
)
##############################################################################
# PHP
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"php_gapic_assembly_pkg",
"php_gapic_library",
"php_grpc_library",
"php_proto_library",
)
php_proto_library(
name = "googleads_php_proto",
plugin_args = ["aggregate_metadata=google.ads.googleads"],
deps = [":googleads_proto"],
)
php_grpc_library(
name = "googleads_php_grpc",
srcs = [":googleads_proto"],
deps = [":googleads_php_proto"],
)
php_gapic_library(
name = "googleads_php_gapic",
srcs = [":googleads_proto"],
gapic_yaml = "googleads_gapic.yaml",
grpc_service_config = "googleads_grpc_service_config.json",
service_yaml = "googleads_v8.yaml",
deps = [
":googleads_php_grpc",
":googleads_php_proto",
],
)
php_gapic_assembly_pkg(
name = "googleads-php",
deps = [
":googleads_php_gapic",
":googleads_php_grpc",
":googleads_php_proto",
],
)
##############################################################################
# C#
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"csharp_gapic_assembly_pkg",
"csharp_gapic_library",
)
csharp_gapic_library(
name = "googleads_csharp_gapic",
generator_binary = "@gapic_generator_csharp_gax_v3//rules_csharp_gapic:csharp_gapic_generator_binary",
srcs = [
":googleads_proto_with_info",
],
grpc_service_config = "googleads_grpc_service_config.json",
deps = [
"//google/ads/googleads/v8/services:services_csharp_grpc",
],
)
csharp_gapic_assembly_pkg(
name = "googleads-csharp",
deps = [
":googleads_csharp_gapic",
"//google/ads/googleads/v8/common:common_csharp_proto",
"//google/ads/googleads/v8/enums:enums_csharp_proto",
"//google/ads/googleads/v8/errors:errors_csharp_proto",
"//google/ads/googleads/v8/resources:resources_csharp_proto",
"//google/ads/googleads/v8/services:services_csharp_grpc",
"//google/ads/googleads/v8/services:services_csharp_proto",
],
)
##############################################################################
# Ruby
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"ruby_ads_gapic_library",
"ruby_gapic_assembly_pkg",
)
ruby_ads_gapic_library(
name = "googleads_ruby_gapic",
srcs = ["googleads_proto_with_info"],
extra_protoc_parameters = [
":gem.:name=google-ads-googleads",
":defaults.:service.:default_host=googleads.googleapis.com",
":overrides.:namespace.Googleads=GoogleAds",
],
grpc_service_config = "googleads_grpc_service_config.json",
)
ruby_gapic_assembly_pkg(
name = "googleads-ruby",
deps = [
":googleads_ruby_gapic",
"//google/ads/googleads/v8/common:common_ruby_proto",
"//google/ads/googleads/v8/enums:enums_ruby_proto",
"//google/ads/googleads/v8/errors:errors_ruby_proto",
"//google/ads/googleads/v8/resources:resources_ruby_proto",
"//google/ads/googleads/v8/services:services_ruby_grpc",
"//google/ads/googleads/v8/services:services_ruby_proto",
],
)
##############################################################################
# Python
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"py_gapic_assembly_pkg",
"py_gapic_library",
)
py_gapic_library(
name = "googleads_py_gapic",
srcs = [":googleads_proto_with_info"],
grpc_service_config = "googleads_grpc_service_config.json",
opt_args = [
"old-naming",
"lazy-import",
"python-gapic-name=googleads",
"python-gapic-templates=ads-templates",
"warehouse-package-name=google-ads",
],
)
py_gapic_assembly_pkg(
name = "googleads-py",
deps = [
":googleads_py_gapic",
"//google/ads/googleads/v8/common:common_py_proto",
"//google/ads/googleads/v8/enums:enums_py_proto",
"//google/ads/googleads/v8/errors:errors_py_proto",
"//google/ads/googleads/v8/resources:resources_py_proto",
"//google/ads/googleads/v8/services:services_py_grpc",
"//google/ads/googleads/v8/services:services_py_proto",
],
)
##############################################################################
# Node.js
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"nodejs_gapic_assembly_pkg",
"nodejs_gapic_library",
)
nodejs_gapic_library(
name = "googleads_nodejs_gapic",
package_name = "google-ads",
src = ":googleads_proto_with_info",
extra_protoc_parameters = ["metadata"],
grpc_service_config = "googleads_grpc_service_config.json",
main_service = "GoogleAdsService",
package = "google.ads.googleads.v8",
service_yaml = "googleads_v8.yaml",
deps = [],
)
nodejs_gapic_assembly_pkg(
name = "googleads-nodejs",
deps = [
":googleads_nodejs_gapic",
":googleads_proto",
],
)

94
google/ads/googleads/v8/common/BUILD.bazel
View file

@ -1,94 +0,0 @@
# Copyright 2020 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
#
# https://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.
package(default_visibility = ["//visibility:public"])
##############################################################################
# Common
##############################################################################
load("@rules_proto//proto:defs.bzl", "proto_library")
# TODO(ohren): Change srcs to use an enumeration of each individual proto
# instead of *.proto globbing once the build file generator supports
# subpackages.
proto_library(
name = "common_proto",
srcs = glob(["*.proto"]),
deps = [
"//google/ads/googleads/v8/enums:enums_proto",
"//google/api:annotations_proto",
"//google/api:field_behavior_proto",
"//google/api:resource_proto",
"@com_google_protobuf//:wrappers_proto",
],
)
##############################################################################
# Java
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"java_proto_library",
)
java_proto_library(
name = "common_java_proto",
deps = [":common_proto"],
)
##############################################################################
# PHP
##############################################################################
# PHP targets are in the parent directory's BUILD.bazel file to facilitate
# aggregating metadata using a single underlying call to protoc.
##############################################################################
# C#
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"csharp_proto_library",
)
csharp_proto_library(
name = "common_csharp_proto",
deps = [":common_proto"],
)
##############################################################################
# Ruby
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"ruby_proto_library",
)
ruby_proto_library(
name = "common_ruby_proto",
deps = [":common_proto"],
)
##############################################################################
# Python
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"py_proto_library",
)
py_proto_library(
name = "common_py_proto",
deps = [":common_proto"],
)

69
google/ads/googleads/v8/common/ad_asset.proto
View file

@ -1,69 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/common/asset_policy.proto";
import "google/ads/googleads/v8/enums/asset_performance_label.proto";
import "google/ads/googleads/v8/enums/served_asset_field_type.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "AdAssetProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing assets used inside an ad.
// A text asset used inside an ad.
message AdTextAsset {
// Asset text.
optional string text = 4;
// The pinned field of the asset. This restricts the asset to only serve
// within this field. Multiple assets can be pinned to the same field. An
// asset that is unpinned or pinned to a different field will not serve in a
// field where some other asset has been pinned.
google.ads.googleads.v8.enums.ServedAssetFieldTypeEnum.ServedAssetFieldType pinned_field = 2;
// The performance label of this text asset.
google.ads.googleads.v8.enums.AssetPerformanceLabelEnum.AssetPerformanceLabel asset_performance_label = 5;
// The policy summary of this text asset.
AdAssetPolicySummary policy_summary_info = 6;
}
// An image asset used inside an ad.
message AdImageAsset {
// The Asset resource name of this image.
optional string asset = 2;
}
// A video asset used inside an ad.
message AdVideoAsset {
// The Asset resource name of this video.
optional string asset = 2;
}
// A media bundle asset used inside an ad.
message AdMediaBundleAsset {
// The Asset resource name of this media bundle.
optional string asset = 2;
}

691
google/ads/googleads/v8/common/ad_type_infos.proto
View file

@ -1,691 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/common/ad_asset.proto";
import "google/ads/googleads/v8/enums/call_conversion_reporting_state.proto";
import "google/ads/googleads/v8/enums/display_ad_format_setting.proto";
import "google/ads/googleads/v8/enums/display_upload_product_type.proto";
import "google/ads/googleads/v8/enums/legacy_app_install_ad_app_store.proto";
import "google/ads/googleads/v8/enums/mime_type.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "AdTypeInfosProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file containing info messages for specific ad types.
// A text ad.
message TextAdInfo {
// The headline of the ad.
optional string headline = 4;
// The first line of the ad's description.
optional string description1 = 5;
// The second line of the ad's description.
optional string description2 = 6;
}
// An expanded text ad.
message ExpandedTextAdInfo {
// The first part of the ad's headline.
optional string headline_part1 = 8;
// The second part of the ad's headline.
optional string headline_part2 = 9;
// The third part of the ad's headline.
optional string headline_part3 = 10;
// The description of the ad.
optional string description = 11;
// The second description of the ad.
optional string description2 = 12;
// The text that can appear alongside the ad's displayed URL.
optional string path1 = 13;
// Additional text that can appear alongside the ad's displayed URL.
optional string path2 = 14;
}
// An expanded dynamic search ad.
message ExpandedDynamicSearchAdInfo {
// The description of the ad.
optional string description = 3;
// The second description of the ad.
optional string description2 = 4;
}
// A hotel ad.
message HotelAdInfo {
}
// A Smart Shopping ad.
message ShoppingSmartAdInfo {
}
// A standard Shopping ad.
message ShoppingProductAdInfo {
}
// A Shopping Comparison Listing ad.
message ShoppingComparisonListingAdInfo {
// Headline of the ad. This field is required. Allowed length is between 25
// and 45 characters.
optional string headline = 2;
}
// A Gmail ad.
message GmailAdInfo {
// The Gmail teaser.
GmailTeaser teaser = 1;
// The MediaFile resource name of the header image. Valid image types are GIF,
// JPEG and PNG. The minimum size is 300x100 pixels and the aspect ratio must
// be between 3:1 and 5:1 (+-1%).
optional string header_image = 10;
// The MediaFile resource name of the marketing image. Valid image types are
// GIF, JPEG and PNG. The image must either be landscape with a minimum size
// of 600x314 pixels and aspect ratio of 600:314 (+-1%) or square with a
// minimum size of 300x300 pixels and aspect ratio of 1:1 (+-1%)
optional string marketing_image = 11;
// Headline of the marketing image.
optional string marketing_image_headline = 12;
// Description of the marketing image.
optional string marketing_image_description = 13;
// Display-call-to-action of the marketing image.
DisplayCallToAction marketing_image_display_call_to_action = 6;
// Product images. Up to 15 images are supported.
repeated ProductImage product_images = 7;
// Product videos. Up to 7 videos are supported. At least one product video
// or a marketing image must be specified.
repeated ProductVideo product_videos = 8;
}
// Gmail teaser data. The teaser is a small header that acts as an invitation
// to view the rest of the ad (the body).
message GmailTeaser {
// Headline of the teaser.
optional string headline = 5;
// Description of the teaser.
optional string description = 6;
// Business name of the advertiser.
optional string business_name = 7;
// The MediaFile resource name of the logo image. Valid image types are GIF,
// JPEG and PNG. The minimum size is 144x144 pixels and the aspect ratio must
// be 1:1 (+-1%).
optional string logo_image = 8;
}
// Data for display call to action. The call to action is a piece of the ad
// that prompts the user to do something. Like clicking a link or making a phone
// call.
message DisplayCallToAction {
// Text for the display-call-to-action.
optional string text = 5;
// Text color for the display-call-to-action in hexadecimal, e.g. #ffffff for
// white.
optional string text_color = 6;
// Identifies the URL collection in the `ad.url_collections` field. If not
// set, the URL defaults to `final_url`.
optional string url_collection_id = 7;
}
// Product image specific data.
message ProductImage {
// The MediaFile resource name of the product image. Valid image types are
// GIF, JPEG and PNG. The minimum size is 300x300 pixels and the aspect ratio
// must be 1:1 (+-1%).
optional string product_image = 4;
// Description of the product.
optional string description = 5;
// Display-call-to-action of the product image.
DisplayCallToAction display_call_to_action = 3;
}
// Product video specific data.
message ProductVideo {
// The MediaFile resource name of a video which must be hosted on YouTube.
optional string product_video = 2;
}
// An image ad.
message ImageAdInfo {
// Width in pixels of the full size image.
optional int64 pixel_width = 15;
// Height in pixels of the full size image.
optional int64 pixel_height = 16;
// URL of the full size image.
optional string image_url = 17;
// Width in pixels of the preview size image.
optional int64 preview_pixel_width = 18;
// Height in pixels of the preview size image.
optional int64 preview_pixel_height = 19;
// URL of the preview size image.
optional string preview_image_url = 20;
// The mime type of the image.
google.ads.googleads.v8.enums.MimeTypeEnum.MimeType mime_type = 10;
// The name of the image. If the image was created from a MediaFile, this is
// the MediaFile's name. If the image was created from bytes, this is empty.
optional string name = 21;
// The image to create the ImageAd from. This can be specified in one of
// two ways.
// 1. An existing MediaFile resource.
// 2. The raw image data as bytes.
oneof image {
// The MediaFile resource to use for the image.
string media_file = 12;
// Raw image data as bytes.
bytes data = 13;
// An ad ID to copy the image from.
int64 ad_id_to_copy_image_from = 14;
}
}
// Representation of video bumper in-stream ad format (very short in-stream
// non-skippable video ad).
message VideoBumperInStreamAdInfo {
// The MediaFile resource name of the companion banner used with the ad.
optional string companion_banner = 2;
}
// Representation of video non-skippable in-stream ad format (15 second
// in-stream non-skippable video ad).
message VideoNonSkippableInStreamAdInfo {
// The MediaFile resource name of the companion banner used with the ad.
optional string companion_banner = 2;
}
// Representation of video TrueView in-stream ad format (ad shown during video
// playback, often at beginning, which displays a skip button a few seconds into
// the video).
message VideoTrueViewInStreamAdInfo {
// Label on the CTA (call-to-action) button taking the user to the video ad's
// final URL.
// Required for TrueView for action campaigns, optional otherwise.
optional string action_button_label = 4;
// Additional text displayed with the CTA (call-to-action) button to give
// context and encourage clicking on the button.
optional string action_headline = 5;
// The MediaFile resource name of the companion banner used with the ad.
optional string companion_banner = 6;
}
// Representation of video out-stream ad format (ad shown alongside a feed
// with automatic playback, without sound).
message VideoOutstreamAdInfo {
// The headline of the ad.
optional string headline = 3;
// The description line.
optional string description = 4;
}
// Representation of video TrueView discovery ad format.
message VideoTrueViewDiscoveryAdInfo {
// The headline of the ad.
optional string headline = 4;
// First text line for a TrueView video discovery ad.
optional string description1 = 5;
// Second text line for a TrueView video discovery ad.
optional string description2 = 6;
}
// A video ad.
message VideoAdInfo {
// The MediaFile resource to use for the video.
optional string media_file = 7;
// Format-specific schema for the different video formats.
oneof format {
// Video TrueView in-stream ad format.
VideoTrueViewInStreamAdInfo in_stream = 2;
// Video bumper in-stream ad format.
VideoBumperInStreamAdInfo bumper = 3;
// Video out-stream ad format.
VideoOutstreamAdInfo out_stream = 4;
// Video non-skippable in-stream ad format.
VideoNonSkippableInStreamAdInfo non_skippable = 5;
// Video TrueView discovery ad format.
VideoTrueViewDiscoveryAdInfo discovery = 6;
}
}
// A video responsive ad.
message VideoResponsiveAdInfo {
// List of text assets used for the short headline, e.g. the "Call To Action"
// banner. Currently, only a single value for the short headline is supported.
repeated AdTextAsset headlines = 1;
// List of text assets used for the long headline.
// Currently, only a single value for the long headline is supported.
repeated AdTextAsset long_headlines = 2;
// List of text assets used for the description.
// Currently, only a single value for the description is supported.
repeated AdTextAsset descriptions = 3;
// List of text assets used for the button, e.g. the "Call To Action" button.
// Currently, only a single value for the button is supported.
repeated AdTextAsset call_to_actions = 4;
// List of YouTube video assets used for the ad.
// Currently, only a single value for the YouTube video asset is supported.
repeated AdVideoAsset videos = 5;
// List of image assets used for the companion banner.
// Currently, only a single value for the companion banner asset is supported.
repeated AdImageAsset companion_banners = 6;
}
// A responsive search ad.
//
// Responsive search ads let you create an ad that adapts to show more text, and
// more relevant messages, to your customers. Enter multiple headlines and
// descriptions when creating a responsive search ad, and over time, Google Ads
// will automatically test different combinations and learn which combinations
// perform best. By adapting your ad's content to more closely match potential
// customers' search terms, responsive search ads may improve your campaign's
// performance.
//
// More information at https://support.google.com/google-ads/answer/7684791
message ResponsiveSearchAdInfo {
// List of text assets for headlines. When the ad serves the headlines will
// be selected from this list.
repeated AdTextAsset headlines = 1;
// List of text assets for descriptions. When the ad serves the descriptions
// will be selected from this list.
repeated AdTextAsset descriptions = 2;
// First part of text that can be appended to the URL in the ad.
optional string path1 = 5;
// Second part of text that can be appended to the URL in the ad. This field
// can only be set when `path1` is also set.
optional string path2 = 6;
}
// A legacy responsive display ad. Ads of this type are labeled 'Responsive ads'
// in the Google Ads UI.
message LegacyResponsiveDisplayAdInfo {
// The short version of the ad's headline.
optional string short_headline = 16;
// The long version of the ad's headline.
optional string long_headline = 17;
// The description of the ad.
optional string description = 18;
// The business name in the ad.
optional string business_name = 19;
// Advertiser's consent to allow flexible color. When true, the ad may be
// served with different color if necessary. When false, the ad will be served
// with the specified colors or a neutral color.
// The default value is `true`.
// Must be true if `main_color` and `accent_color` are not set.
optional bool allow_flexible_color = 20;
// The accent color of the ad in hexadecimal, e.g. #ffffff for white.
// If one of `main_color` and `accent_color` is set, the other is required as
// well.
optional string accent_color = 21;
// The main color of the ad in hexadecimal, e.g. #ffffff for white.
// If one of `main_color` and `accent_color` is set, the other is required as
// well.
optional string main_color = 22;
// The call-to-action text for the ad.
optional string call_to_action_text = 23;
// The MediaFile resource name of the logo image used in the ad.
optional string logo_image = 24;
// The MediaFile resource name of the square logo image used in the ad.
optional string square_logo_image = 25;
// The MediaFile resource name of the marketing image used in the ad.
optional string marketing_image = 26;
// The MediaFile resource name of the square marketing image used in the ad.
optional string square_marketing_image = 27;
// Specifies which format the ad will be served in. Default is ALL_FORMATS.
google.ads.googleads.v8.enums.DisplayAdFormatSettingEnum.DisplayAdFormatSetting format_setting = 13;
// Prefix before price. E.g. 'as low as'.
optional string price_prefix = 28;
// Promotion text used for dynamic formats of responsive ads. For example
// 'Free two-day shipping'.
optional string promo_text = 29;
}
// An app ad.
message AppAdInfo {
// Mandatory ad text.
AdTextAsset mandatory_ad_text = 1;
// List of text assets for headlines. When the ad serves the headlines will
// be selected from this list.
repeated AdTextAsset headlines = 2;
// List of text assets for descriptions. When the ad serves the descriptions
// will be selected from this list.
repeated AdTextAsset descriptions = 3;
// List of image assets that may be displayed with the ad.
repeated AdImageAsset images = 4;
// List of YouTube video assets that may be displayed with the ad.
repeated AdVideoAsset youtube_videos = 5;
// List of media bundle assets that may be used with the ad.
repeated AdMediaBundleAsset html5_media_bundles = 6;
}
// App engagement ads allow you to write text encouraging a specific action in
// the app, like checking in, making a purchase, or booking a flight.
// They allow you to send users to a specific part of your app where they can
// find what they're looking for easier and faster.
message AppEngagementAdInfo {
// List of text assets for headlines. When the ad serves the headlines will
// be selected from this list.
repeated AdTextAsset headlines = 1;
// List of text assets for descriptions. When the ad serves the descriptions
// will be selected from this list.
repeated AdTextAsset descriptions = 2;
// List of image assets that may be displayed with the ad.
repeated AdImageAsset images = 3;
// List of video assets that may be displayed with the ad.
repeated AdVideoAsset videos = 4;
}
// A legacy app install ad that only can be used by a few select customers.
message LegacyAppInstallAdInfo {
// The ID of the mobile app.
optional string app_id = 6;
// The app store the mobile app is available in.
google.ads.googleads.v8.enums.LegacyAppInstallAdAppStoreEnum.LegacyAppInstallAdAppStore app_store = 2;
// The headline of the ad.
optional string headline = 7;
// The first description line of the ad.
optional string description1 = 8;
// The second description line of the ad.
optional string description2 = 9;
}
// A responsive display ad.
message ResponsiveDisplayAdInfo {
// Marketing images to be used in the ad. Valid image types are GIF,
// JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must
// be 1.91:1 (+-1%). At least one `marketing_image` is required. Combined
// with `square_marketing_images`, the maximum is 15.
repeated AdImageAsset marketing_images = 1;
// Square marketing images to be used in the ad. Valid image types are GIF,
// JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must
// be 1:1 (+-1%). At least one square `marketing_image` is required. Combined
// with `marketing_images`, the maximum is 15.
repeated AdImageAsset square_marketing_images = 2;
// Logo images to be used in the ad. Valid image types are GIF,
// JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must
// be 4:1 (+-1%). Combined with `square_logo_images`, the maximum is 5.
repeated AdImageAsset logo_images = 3;
// Square logo images to be used in the ad. Valid image types are GIF,
// JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must
// be 1:1 (+-1%). Combined with `square_logo_images`, the maximum is 5.
repeated AdImageAsset square_logo_images = 4;
// Short format headlines for the ad. The maximum length is 30 characters.
// At least 1 and max 5 headlines can be specified.
repeated AdTextAsset headlines = 5;
// A required long format headline. The maximum length is 90 characters.
AdTextAsset long_headline = 6;
// Descriptive texts for the ad. The maximum length is 90 characters. At
// least 1 and max 5 headlines can be specified.
repeated AdTextAsset descriptions = 7;
// Optional YouTube videos for the ad. A maximum of 5 videos can be specified.
repeated AdVideoAsset youtube_videos = 8;
// The advertiser/brand name. Maximum display width is 25.
optional string business_name = 17;
// The main color of the ad in hexadecimal, e.g. #ffffff for white.
// If one of `main_color` and `accent_color` is set, the other is required as
// well.
optional string main_color = 18;
// The accent color of the ad in hexadecimal, e.g. #ffffff for white.
// If one of `main_color` and `accent_color` is set, the other is required as
// well.
optional string accent_color = 19;
// Advertiser's consent to allow flexible color. When true, the ad may be
// served with different color if necessary. When false, the ad will be served
// with the specified colors or a neutral color.
// The default value is `true`.
// Must be true if `main_color` and `accent_color` are not set.
optional bool allow_flexible_color = 20;
// The call-to-action text for the ad. Maximum display width is 30.
optional string call_to_action_text = 21;
// Prefix before price. E.g. 'as low as'.
optional string price_prefix = 22;
// Promotion text used for dynamic formats of responsive ads. For example
// 'Free two-day shipping'.
optional string promo_text = 23;
// Specifies which format the ad will be served in. Default is ALL_FORMATS.
google.ads.googleads.v8.enums.DisplayAdFormatSettingEnum.DisplayAdFormatSetting format_setting = 16;
// Specification for various creative controls.
ResponsiveDisplayAdControlSpec control_spec = 24;
}
// A local ad.
message LocalAdInfo {
// List of text assets for headlines. When the ad serves the headlines will
// be selected from this list. At least 1 and at most 5 headlines must be
// specified.
repeated AdTextAsset headlines = 1;
// List of text assets for descriptions. When the ad serves the descriptions
// will be selected from this list. At least 1 and at most 5 descriptions must
// be specified.
repeated AdTextAsset descriptions = 2;
// List of text assets for call-to-actions. When the ad serves the
// call-to-actions will be selected from this list. Call-to-actions are
// optional and at most 5 can be specified.
repeated AdTextAsset call_to_actions = 3;
// List of marketing image assets that may be displayed with the ad. The
// images must be 314x600 pixels or 320x320 pixels. At least 1 and at most
// 20 image assets must be specified.
repeated AdImageAsset marketing_images = 4;
// List of logo image assets that may be displayed with the ad. The images
// must be 128x128 pixels and not larger than 120KB. At least 1 and at most 5
// image assets must be specified.
repeated AdImageAsset logo_images = 5;
// List of YouTube video assets that may be displayed with the ad. Videos
// are optional and at most 20 can be specified.
repeated AdVideoAsset videos = 6;
// First part of optional text that can be appended to the URL in the ad.
optional string path1 = 9;
// Second part of optional text that can be appended to the URL in the ad.
// This field can only be set when `path1` is also set.
optional string path2 = 10;
}
// A generic type of display ad. The exact ad format is controlled by the
// `display_upload_product_type` field, which determines what kinds of data
// need to be included with the ad.
message DisplayUploadAdInfo {
// The product type of this ad. See comments on the enum for details.
google.ads.googleads.v8.enums.DisplayUploadProductTypeEnum.DisplayUploadProductType display_upload_product_type = 1;
// The asset data that makes up the ad.
oneof media_asset {
// A media bundle asset to be used in the ad. For information about the
// media bundle for HTML5_UPLOAD_AD, see
// https://support.google.com/google-ads/answer/1722096
// Media bundles that are part of dynamic product types use a special format
// that needs to be created through the Google Web Designer. See
// https://support.google.com/webdesigner/answer/7543898 for more
// information.
AdMediaBundleAsset media_bundle = 2;
}
}
// Specification for various creative controls for a responsive display ad.
message ResponsiveDisplayAdControlSpec {
// Whether the advertiser has opted into the asset enhancements feature.
bool enable_asset_enhancements = 1;
// Whether the advertiser has opted into auto-gen video feature.
bool enable_autogen_video = 2;
}
// A Smart campaign ad.
message SmartCampaignAdInfo {
// List of text assets for headlines. When the ad serves the headlines will
// be selected from this list. 3 headlines must be specified.
repeated AdTextAsset headlines = 1;
// List of text assets for descriptions. When the ad serves the descriptions
// will be selected from this list. 2 descriptions must be specified.
repeated AdTextAsset descriptions = 2;
}
// A call ad.
message CallAdInfo {
// The country code in the ad.
string country_code = 1;
// The phone number in the ad.
string phone_number = 2;
// The business name in the ad.
string business_name = 3;
// First headline in the ad.
string headline1 = 11;
// Second headline in the ad.
string headline2 = 12;
// The first line of the ad's description.
string description1 = 4;
// The second line of the ad's description.
string description2 = 5;
// Whether to enable call tracking for the creative. Enabling call
// tracking also enables call conversions.
bool 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.
bool disable_call_conversion = 7;
// The URL to be used for phone number verification.
string phone_number_verification_url = 8;
// The conversion action to attribute a call conversion to. If not set a
// default conversion action is used. This field only has effect if
// `call_tracked` is set to `true`. Otherwise this field is ignored.
string conversion_action = 9;
// The call conversion behavior of this call ad. It can use its own call
// conversion setting, inherit the account level setting, or be disabled.
google.ads.googleads.v8.enums.CallConversionReportingStateEnum.CallConversionReportingState conversion_reporting_state = 10;
// First part of text that can be appended to the URL in the ad. Optional.
string path1 = 13;
// Second part of text that can be appended to the URL in the ad. This field
// can only be set when `path1` is also set. Optional.
string path2 = 14;
}

46
google/ads/googleads/v8/common/asset_policy.proto
View file

@ -1,46 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/common/policy.proto";
import "google/ads/googleads/v8/enums/policy_approval_status.proto";
import "google/ads/googleads/v8/enums/policy_review_status.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "AssetPolicyProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing asset policies.
// Contains policy information for an asset inside an ad.
message AdAssetPolicySummary {
// The list of policy findings for this asset.
repeated PolicyTopicEntry policy_topic_entries = 1;
// Where in the review process this asset.
google.ads.googleads.v8.enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2;
// The overall approval status of this asset, which is calculated based on
// the status of its individual policy topic entries.
google.ads.googleads.v8.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3;
}

325
google/ads/googleads/v8/common/asset_types.proto
View file

@ -1,325 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/common/criteria.proto";
import "google/ads/googleads/v8/common/feed_common.proto";
import "google/ads/googleads/v8/enums/lead_form_call_to_action_type.proto";
import "google/ads/googleads/v8/enums/lead_form_desired_intent.proto";
import "google/ads/googleads/v8/enums/lead_form_field_user_input_type.proto";
import "google/ads/googleads/v8/enums/lead_form_post_submit_call_to_action_type.proto";
import "google/ads/googleads/v8/enums/mime_type.proto";
import "google/ads/googleads/v8/enums/promotion_extension_discount_modifier.proto";
import "google/ads/googleads/v8/enums/promotion_extension_occasion.proto";
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "AssetTypesProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file containing info messages for specific asset types.
// A YouTube asset.
message YoutubeVideoAsset {
// YouTube video id. This is the 11 character string value used in the
// YouTube video URL.
optional string youtube_video_id = 2;
// YouTube video title.
string youtube_video_title = 3;
}
// A MediaBundle asset.
message MediaBundleAsset {
// Media bundle (ZIP file) asset data. The format of the uploaded ZIP file
// depends on the ad field where it will be used. For more information on the
// format, see the documentation of the ad field where you plan on using the
// MediaBundleAsset. This field is mutate only.
optional bytes data = 2;
}
// An Image asset.
message ImageAsset {
// The raw bytes data of an image. This field is mutate only.
optional bytes data = 5;
// File size of the image asset in bytes.
optional int64 file_size = 6;
// MIME type of the image asset.
google.ads.googleads.v8.enums.MimeTypeEnum.MimeType mime_type = 3;
// Metadata for this image at its original size.
ImageDimension full_size = 4;
}
// Metadata for an image at a certain size, either original or resized.
message ImageDimension {
// Height of the image.
optional int64 height_pixels = 4;
// Width of the image.
optional int64 width_pixels = 5;
// A URL that returns the image with this height and width.
optional string url = 6;
}
// A Text asset.
message TextAsset {
// Text content of the text asset.
optional string text = 2;
}
// A Lead Form asset.
message LeadFormAsset {
// Required. The name of the business being advertised.
string business_name = 10 [(google.api.field_behavior) = REQUIRED];
// Required. Pre-defined display text that encourages user to expand the form.
google.ads.googleads.v8.enums.LeadFormCallToActionTypeEnum.LeadFormCallToActionType call_to_action_type = 17 [(google.api.field_behavior) = REQUIRED];
// Required. Text giving a clear value proposition of what users expect once they expand
// the form.
string call_to_action_description = 18 [(google.api.field_behavior) = REQUIRED];
// Required. Headline of the expanded form to describe what the form is asking for or
// facilitating.
string headline = 12 [(google.api.field_behavior) = REQUIRED];
// Required. Detailed description of the expanded form to describe what the form is
// asking for or facilitating.
string description = 13 [(google.api.field_behavior) = REQUIRED];
// Required. Link to a page describing the policy on how the collected data is handled
// by the advertiser/business.
string privacy_policy_url = 14 [(google.api.field_behavior) = REQUIRED];
// Headline of text shown after form submission that describes how the
// advertiser will follow up with the user.
optional string post_submit_headline = 15;
// Detailed description shown after form submission that describes how the
// advertiser will follow up with the user.
optional string post_submit_description = 16;
// Ordered list of input fields.
repeated LeadFormField fields = 8;
// Configured methods for collected lead data to be delivered to advertiser.
// Only one method typed as WebhookDelivery can be configured.
repeated LeadFormDeliveryMethod delivery_methods = 9;
// Pre-defined display text that encourages user action after the form is
// submitted.
google.ads.googleads.v8.enums.LeadFormPostSubmitCallToActionTypeEnum.LeadFormPostSubmitCallToActionType post_submit_call_to_action_type = 19;
// Asset resource name of the background image. The minimum size is 600x314
// and the aspect ratio must be 1.91:1 (+-1%).
optional string background_image_asset = 20;
// Desired intent for the lead form, e.g. more volume or more qualified.
google.ads.googleads.v8.enums.LeadFormDesiredIntentEnum.LeadFormDesiredIntent desired_intent = 21;
// Custom disclosure shown along with Google disclaimer on the lead form.
// Accessible to allowed customers only.
optional string custom_disclosure = 22;
}
// One input field instance within a form.
message LeadFormField {
// Describes the input type, which may be a predefined type such as
// "full name" or a pre-vetted question like "Do you own a car?".
google.ads.googleads.v8.enums.LeadFormFieldUserInputTypeEnum.LeadFormFieldUserInputType input_type = 1;
// Defines answer configuration that this form field accepts. If oneof is not
// set, this is a free-text answer.
oneof answers {
// Answer configuration for a single choice question. Can be set only for
// pre-vetted question fields. Minimum of 2 answers required and maximum of
// 12 allowed.
LeadFormSingleChoiceAnswers single_choice_answers = 2;
}
}
// Defines possible answers for a single choice question, usually presented as
// a single-choice drop-down list.
message LeadFormSingleChoiceAnswers {
// List of choices for a single question field. The order of entries defines
// UI order. Minimum of 2 answers required and maximum of 12 allowed.
repeated string answers = 1;
}
// A configuration of how leads are delivered to the advertiser.
message LeadFormDeliveryMethod {
// Various subtypes of delivery.
oneof delivery_details {
// Webhook method of delivery.
WebhookDelivery webhook = 1;
}
}
// Google notifies the advertiser of leads by making HTTP calls to an
// endpoint they specify. The requests contain JSON matching a schema that
// Google publishes as part of form ads documentation.
message WebhookDelivery {
// Webhook url specified by advertiser to send the lead.
optional string advertiser_webhook_url = 4;
// Anti-spoofing secret set by the advertiser as part of the webhook payload.
optional string google_secret = 5;
// The schema version that this delivery instance will use.
optional int64 payload_schema_version = 6;
}
// A Book on Google asset. Used to redirect user to book through Google.
// Book on Google will change the redirect url to book directly through
// Google.
message BookOnGoogleAsset {
}
// A Promotion asset.
message PromotionAsset {
// Required. A freeform description of what the promotion is targeting.
string promotion_target = 1 [(google.api.field_behavior) = REQUIRED];
// A modifier for qualification of the discount.
google.ads.googleads.v8.enums.PromotionExtensionDiscountModifierEnum.PromotionExtensionDiscountModifier discount_modifier = 2;
// Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd
// format.
string redemption_start_date = 7;
// Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd
// format.
string redemption_end_date = 8;
// The occasion the promotion was intended for.
// If an occasion is set, the redemption window will need to fall within the
// date range associated with the occasion.
google.ads.googleads.v8.enums.PromotionExtensionOccasionEnum.PromotionExtensionOccasion occasion = 9;
// The language of the promotion.
// Represented as BCP 47 language tag.
string language_code = 10;
// Start date of when this asset is effective and can begin serving, in
// yyyy-MM-dd format.
string start_date = 11;
// Last date of when this asset is effective and still serving, in yyyy-MM-dd
// format.
string end_date = 12;
// List of non-overlapping schedules specifying all time intervals for which
// the asset may serve. There can be a maximum of 6 schedules per day, 42 in
// total.
repeated AdScheduleInfo ad_schedule_targets = 13;
// Discount type, can be percentage off or amount off.
oneof discount_type {
// Percentage off discount in the promotion. 1,000,000 = 100%.
// Either this or money_amount_off is required.
int64 percent_off = 3;
// Money amount off for discount in the promotion.
// Either this or percent_off is required.
Money money_amount_off = 4;
}
// Promotion trigger. Can be by promotion code or promo by eligible order
// amount.
oneof promotion_trigger {
// A code the user should use in order to be eligible for the promotion.
string promotion_code = 5;
// The amount the total order needs to be for the user to be eligible for
// the promotion.
Money orders_over_amount = 6;
}
}
// A Callout asset.
message CalloutAsset {
// Required. The callout text.
// The length of this string should be between 1 and 25, inclusive.
string callout_text = 1 [(google.api.field_behavior) = REQUIRED];
// Start date of when this asset is effective and can begin serving, in
// yyyy-MM-dd format.
string start_date = 2;
// Last date of when this asset is effective and still serving, in yyyy-MM-dd
// format.
string end_date = 3;
// List of non-overlapping schedules specifying all time intervals for which
// the asset may serve. There can be a maximum of 6 schedules per day, 42 in
// total.
repeated AdScheduleInfo ad_schedule_targets = 4;
}
// A Structured Snippet asset.
message StructuredSnippetAsset {
// Required. The header of the snippet.
// This string should be one of the predefined values at
// https://developers.google.com/google-ads/api/reference/data/structured-snippet-headers
string header = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The values in the snippet.
// The size of this collection should be between 3 and 10, inclusive.
// The length of each value should be between 1 and 25 characters, inclusive.
repeated string values = 2 [(google.api.field_behavior) = REQUIRED];
}
// A Sitelink asset.
message SitelinkAsset {
// Required. URL display text for the sitelink.
// The length of this string should be between 1 and 25, inclusive.
string link_text = 1 [(google.api.field_behavior) = REQUIRED];
// First line of the description for the sitelink.
// If set, the length should be between 1 and 35, inclusive, and description2
// must also be set.
string description1 = 2;
// Second line of the description for the sitelink.
// If set, the length should be between 1 and 35, inclusive, and description1
// must also be set.
string description2 = 3;
// Start date of when this asset is effective and can begin serving, in
// yyyy-MM-dd format.
string start_date = 4;
// Last date of when this asset is effective and still serving, in yyyy-MM-dd
// format.
string end_date = 5;
// List of non-overlapping schedules specifying all time intervals for which
// the asset may serve. There can be a maximum of 6 schedules per day, 42 in
// total.
repeated AdScheduleInfo ad_schedule_targets = 6;
}

179
google/ads/googleads/v8/common/bidding.proto
View file

@ -1,179 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/enums/target_impression_share_location.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "BiddingProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing bidding schemes.
// Commission is an automatic bidding strategy in which the advertiser pays a
// certain portion of the conversion value.
message Commission {
// Commission rate defines the portion of the conversion value that the
// advertiser will be billed. A commission rate of x should be passed into
// this field as (x * 1,000,000). For example, 106,000 represents a commission
// rate of 0.106 (10.6%).
optional int64 commission_rate_micros = 2;
}
// 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.
optional bool enhanced_cpc_enabled = 2;
}
// Manual impression-based bidding where user pays per thousand impressions.
message ManualCpm {
}
// View based bidding where user pays per video view.
message ManualCpv {
}
// An automated bidding strategy to help get the most conversions for your
// campaigns while spending your budget.
message MaximizeConversions {
// The target cost-per-action (CPA) option. This is the average amount that
// you would like to spend per conversion action. If set, the bid strategy
// will get as many conversions as possible at or below the target
// cost-per-action. If the target CPA is not set, the bid strategy will
// aim to achieve the lowest possible CPA given the budget.
int64 target_cpa = 1;
}
// An automated bidding strategy to help get the most conversion value for your
// campaigns while spending your 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.
double target_roas = 2;
}
// 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.
optional int64 target_cpa_micros = 4;
// Maximum bid limit that can be set by the bid strategy.
// The limit applies to all keywords managed by the strategy.
// This should only be set for portfolio bid strategies.
optional int64 cpc_bid_ceiling_micros = 5;
// Minimum bid limit that can be set by the bid strategy.
// The limit applies to all keywords managed by the strategy.
// This should only be set for portfolio bid strategies.
optional int64 cpc_bid_floor_micros = 6;
}
// Target CPM (cost per thousand impressions) is an automated bidding strategy
// that sets bids to optimize performance given the target CPM you set.
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).
message TargetImpressionShare {
// The targeted location on the search results page.
google.ads.googleads.v8.enums.TargetImpressionShareLocationEnum.TargetImpressionShareLocation location = 1;
// The desired fraction of ads to be shown in the targeted location in micros.
// E.g. 1% equals 10,000.
optional int64 location_fraction_micros = 4;
// The highest CPC bid the automated bidding system is permitted to specify.
// This is a required field entered by the advertiser that sets the ceiling
// and specified in local micros.
optional int64 cpc_bid_ceiling_micros = 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.
optional double target_roas = 4;
// Maximum bid limit that can be set by the bid strategy.
// The limit applies to all keywords managed by the strategy.
// This should only be set for portfolio bid strategies.
optional int64 cpc_bid_ceiling_micros = 5;
// Minimum bid limit that can be set by the bid strategy.
// The limit applies to all keywords managed by the strategy.
// This should only be set for portfolio bid strategies.
optional int64 cpc_bid_floor_micros = 6;
}
// 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.
// This field is deprecated and should no longer be used. See
// https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html
// for details.
optional int64 target_spend_micros = 3 [deprecated = true];
// Maximum bid limit that can be set by the bid strategy.
// The limit applies to all keywords managed by the strategy.
optional int64 cpc_bid_ceiling_micros = 4;
}
// 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.
optional int64 cpc_bid_ceiling_micros = 3;
// 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.
optional bool enhanced_cpc_enabled = 4;
}

48
google/ads/googleads/v8/common/click_location.proto
View file

@ -1,48 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "ClickLocationProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing a ClickLocation.
// Location criteria associated with a click.
message ClickLocation {
// The city location criterion associated with the impression.
optional string city = 6;
// The country location criterion associated with the impression.
optional string country = 7;
// The metro location criterion associated with the impression.
optional string metro = 8;
// The most specific location criterion associated with the impression.
optional string most_specific = 9;
// The region location criterion associated with the impression.
optional string region = 10;
}

651
google/ads/googleads/v8/common/criteria.proto
View file

@ -1,651 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/enums/age_range_type.proto";
import "google/ads/googleads/v8/enums/app_payment_model_type.proto";
import "google/ads/googleads/v8/enums/content_label_type.proto";
import "google/ads/googleads/v8/enums/day_of_week.proto";
import "google/ads/googleads/v8/enums/device.proto";
import "google/ads/googleads/v8/enums/gender_type.proto";
import "google/ads/googleads/v8/enums/hotel_date_selection_type.proto";
import "google/ads/googleads/v8/enums/income_range_type.proto";
import "google/ads/googleads/v8/enums/interaction_type.proto";
import "google/ads/googleads/v8/enums/keyword_match_type.proto";
import "google/ads/googleads/v8/enums/listing_group_type.proto";
import "google/ads/googleads/v8/enums/location_group_radius_units.proto";
import "google/ads/googleads/v8/enums/minute_of_hour.proto";
import "google/ads/googleads/v8/enums/parental_status_type.proto";
import "google/ads/googleads/v8/enums/preferred_content_type.proto";
import "google/ads/googleads/v8/enums/product_bidding_category_level.proto";
import "google/ads/googleads/v8/enums/product_channel.proto";
import "google/ads/googleads/v8/enums/product_channel_exclusivity.proto";
import "google/ads/googleads/v8/enums/product_condition.proto";
import "google/ads/googleads/v8/enums/product_custom_attribute_index.proto";
import "google/ads/googleads/v8/enums/product_type_level.proto";
import "google/ads/googleads/v8/enums/proximity_radius_units.proto";
import "google/ads/googleads/v8/enums/webpage_condition_operand.proto";
import "google/ads/googleads/v8/enums/webpage_condition_operator.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "CriteriaProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing criteria types.
// A keyword criterion.
message KeywordInfo {
// The text of the keyword (at most 80 characters and 10 words).
optional string text = 3;
// The match type of the keyword.
google.ads.googleads.v8.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 2;
}
// A placement criterion. This can be used to modify bids for sites when
// targeting the content network.
message PlacementInfo {
// URL of the placement.
//
// For example, "http://www.domain.com".
optional string url = 2;
}
// A mobile app category criterion.
message MobileAppCategoryInfo {
// The mobile app category constant resource name.
optional string mobile_app_category_constant = 2;
}
// A mobile application criterion.
message MobileApplicationInfo {
// A string that uniquely identifies a mobile application to Google Ads API.
// The format of this string is "{platform}-{platform_native_id}", where
// platform is "1" for iOS apps and "2" for Android apps, and where
// platform_native_id is the mobile application identifier native to the
// corresponding platform.
// For iOS, this native identifier is the 9 digit string that appears at the
// end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App
// Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146").
// For Android, this native identifier is the application's package name
// (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link
// "https://play.google.com/store/apps/details?id=com.labpixies.colordrips").
// A well formed app id for Google Ads API would thus be "1-476943146" for iOS
// and "2-com.labpixies.colordrips" for Android.
// This field is required and must be set in CREATE operations.
optional string app_id = 4;
// Name of this mobile application.
optional string name = 5;
}
// A location criterion.
message LocationInfo {
// The geo target constant resource name.
optional string geo_target_constant = 2;
}
// A device criterion.
message DeviceInfo {
// Type of the device.
google.ads.googleads.v8.enums.DeviceEnum.Device type = 1;
}
// A preferred content criterion.
message PreferredContentInfo {
// Type of the preferred content.
google.ads.googleads.v8.enums.PreferredContentTypeEnum.PreferredContentType type = 2;
}
// A listing group criterion.
message ListingGroupInfo {
// Type of the listing group.
google.ads.googleads.v8.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;
// Resource name of ad group criterion which is the parent listing group
// subdivision. Null for the root group.
optional string parent_ad_group_criterion = 4;
}
// A listing scope criterion.
message ListingScopeInfo {
// Scope of the campaign criterion.
repeated ListingDimensionInfo dimensions = 2;
}
// Listing dimensions for listing group criterion.
message ListingDimensionInfo {
// Dimension of one of the types below is always present.
oneof dimension {
// 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;
// Bidding category of a product offer.
ProductBiddingCategoryInfo product_bidding_category = 13;
// Brand of a product offer.
ProductBrandInfo product_brand = 15;
// Locality of a product offer.
ProductChannelInfo product_channel = 8;
// Availability of a product offer.
ProductChannelExclusivityInfo product_channel_exclusivity = 9;
// Condition of a product offer.
ProductConditionInfo product_condition = 10;
// Custom attribute of a product offer.
ProductCustomAttributeInfo product_custom_attribute = 16;
// Item id of a product offer.
ProductItemIdInfo product_item_id = 11;
// Type of a product offer.
ProductTypeInfo product_type = 12;
// Unknown dimension. Set when no other listing dimension is set.
UnknownListingDimensionInfo unknown_listing_dimension = 14;
}
}
// Advertiser-specific hotel ID.
message HotelIdInfo {
// String value of the hotel ID.
optional string value = 2;
}
// Class of the hotel as a number of stars 1 to 5.
message HotelClassInfo {
// Long value of the hotel class.
optional int64 value = 2;
}
// Country or Region the hotel is located in.
message HotelCountryRegionInfo {
// The Geo Target Constant resource name.
optional string country_region_criterion = 2;
}
// State the hotel is located in.
message HotelStateInfo {
// The Geo Target Constant resource name.
optional string state_criterion = 2;
}
// City the hotel is located in.
message HotelCityInfo {
// The Geo Target Constant resource name.
optional string city_criterion = 2;
}
// Bidding category of a product offer.
message ProductBiddingCategoryInfo {
// ID of the product bidding category.
//
// This ID is equivalent to the google_product_category ID as described in
// this article: https://support.google.com/merchants/answer/6324436
optional int64 id = 4;
// Two-letter upper-case country code of the product bidding category. It must
// match the campaign.shopping_setting.sales_country field.
optional string country_code = 5;
// Level of the product bidding category.
google.ads.googleads.v8.enums.ProductBiddingCategoryLevelEnum.ProductBiddingCategoryLevel level = 3;
}
// Brand of the product.
message ProductBrandInfo {
// String value of the product brand.
optional string value = 2;
}
// Locality of a product offer.
message ProductChannelInfo {
// Value of the locality.
google.ads.googleads.v8.enums.ProductChannelEnum.ProductChannel channel = 1;
}
// Availability of a product offer.
message ProductChannelExclusivityInfo {
// Value of the availability.
google.ads.googleads.v8.enums.ProductChannelExclusivityEnum.ProductChannelExclusivity channel_exclusivity = 1;
}
// Condition of a product offer.
message ProductConditionInfo {
// Value of the condition.
google.ads.googleads.v8.enums.ProductConditionEnum.ProductCondition condition = 1;
}
// Custom attribute of a product offer.
message ProductCustomAttributeInfo {
// String value of the product custom attribute.
optional string value = 3;
// Indicates the index of the custom attribute.
google.ads.googleads.v8.enums.ProductCustomAttributeIndexEnum.ProductCustomAttributeIndex index = 2;
}
// Item id of a product offer.
message ProductItemIdInfo {
// Value of the id.
optional string value = 2;
}
// Type of a product offer.
message ProductTypeInfo {
// Value of the type.
optional string value = 3;
// Level of the type.
google.ads.googleads.v8.enums.ProductTypeLevelEnum.ProductTypeLevel level = 2;
}
// Unknown listing dimension.
message UnknownListingDimensionInfo {
}
// Criterion for hotel date selection (default dates vs. user selected).
message HotelDateSelectionTypeInfo {
// Type of the hotel date selection
google.ads.googleads.v8.enums.HotelDateSelectionTypeEnum.HotelDateSelectionType type = 1;
}
// 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.
optional int64 min_days = 3;
// High end of the number of days prior to the stay.
optional int64 max_days = 4;
}
// Criterion for length of hotel stay in nights.
message HotelLengthOfStayInfo {
// Low end of the number of nights in the stay.
optional int64 min_nights = 3;
// High end of the number of nights in the stay.
optional int64 max_nights = 4;
}
// Criterion for a check-in date range.
message HotelCheckInDateRangeInfo {
// Start date in the YYYY-MM-DD format.
string start_date = 1;
// End date in the YYYY-MM-DD format.
string end_date = 2;
}
// Criterion for day of the week the booking is for.
message HotelCheckInDayInfo {
// The day of the week.
google.ads.googleads.v8.enums.DayOfWeekEnum.DayOfWeek day_of_week = 1;
}
// Criterion for Interaction Type.
message InteractionTypeInfo {
// The interaction type.
google.ads.googleads.v8.enums.InteractionTypeEnum.InteractionType type = 1;
}
// Represents an AdSchedule criterion.
//
// AdSchedule is specified as the day of the week and a time interval
// within which ads will be shown.
//
// No more than six AdSchedules can be added for the same day.
message AdScheduleInfo {
// Minutes after the start hour at which this schedule starts.
//
// This field is required for CREATE operations and is prohibited on UPDATE
// operations.
google.ads.googleads.v8.enums.MinuteOfHourEnum.MinuteOfHour start_minute = 1;
// Minutes after the end hour at which this schedule ends. The schedule is
// exclusive of the end minute.
//
// This field is required for CREATE operations and is prohibited on UPDATE
// operations.
google.ads.googleads.v8.enums.MinuteOfHourEnum.MinuteOfHour end_minute = 2;
// Starting hour in 24 hour time.
// This field must be between 0 and 23, inclusive.
//
// This field is required for CREATE operations and is prohibited on UPDATE
// operations.
optional int32 start_hour = 6;
// Ending hour in 24 hour time; 24 signifies end of the day.
// This field must be between 0 and 24, inclusive.
//
// This field is required for CREATE operations and is prohibited on UPDATE
// operations.
optional int32 end_hour = 7;
// Day of the week the schedule applies to.
//
// This field is required for CREATE operations and is prohibited on UPDATE
// operations.
google.ads.googleads.v8.enums.DayOfWeekEnum.DayOfWeek day_of_week = 5;
}
// An age range criterion.
message AgeRangeInfo {
// Type of the age range.
google.ads.googleads.v8.enums.AgeRangeTypeEnum.AgeRangeType type = 1;
}
// A gender criterion.
message GenderInfo {
// Type of the gender.
google.ads.googleads.v8.enums.GenderTypeEnum.GenderType type = 1;
}
// An income range criterion.
message IncomeRangeInfo {
// Type of the income range.
google.ads.googleads.v8.enums.IncomeRangeTypeEnum.IncomeRangeType type = 1;
}
// A parental status criterion.
message ParentalStatusInfo {
// Type of the parental status.
google.ads.googleads.v8.enums.ParentalStatusTypeEnum.ParentalStatusType type = 1;
}
// A YouTube Video criterion.
message YouTubeVideoInfo {
// YouTube video id as it appears on the YouTube watch page.
optional string video_id = 2;
}
// A YouTube Channel criterion.
message YouTubeChannelInfo {
// The YouTube uploader channel id or the channel code of a YouTube channel.
optional string channel_id = 2;
}
// A User List criterion. Represents a user list that is defined by the
// advertiser to be targeted.
message UserListInfo {
// The User List resource name.
optional string user_list = 2;
}
// A Proximity criterion. The geo point and radius determine what geographical
// area is included. The address is a description of the geo point that does
// not affect ad serving.
//
// There are two ways to create a proximity. First, by setting an address
// and radius. The geo point will be automatically computed. Second, by
// setting a geo point and radius. The address is an optional label that won't
// be validated.
message ProximityInfo {
// Latitude and longitude.
GeoPointInfo geo_point = 1;
// The radius of the proximity.
optional double radius = 5;
// The unit of measurement of the radius. Default is KILOMETERS.
google.ads.googleads.v8.enums.ProximityRadiusUnitsEnum.ProximityRadiusUnits radius_units = 3;
// Full address.
AddressInfo address = 4;
}
// Geo point for proximity criterion.
message GeoPointInfo {
// Micro degrees for the longitude.
optional int32 longitude_in_micro_degrees = 3;
// Micro degrees for the latitude.
optional int32 latitude_in_micro_degrees = 4;
}
// Address for proximity criterion.
message AddressInfo {
// Postal code.
optional string postal_code = 8;
// Province or state code.
optional string province_code = 9;
// Country code.
optional string country_code = 10;
// Province or state name.
optional string province_name = 11;
// Street address line 1.
optional string street_address = 12;
// Street address line 2. This field is write-only. It is only used for
// calculating the longitude and latitude of an address when geo_point is
// empty.
optional string street_address2 = 13;
// Name of the city.
optional string city_name = 14;
}
// A topic criterion. Use topics to target or exclude placements in the
// Google Display Network based on the category into which the placement falls
// (for example, "Pets & Animals/Pets/Dogs").
message TopicInfo {
// The Topic Constant resource name.
optional string topic_constant = 3;
// The category to target or exclude. Each subsequent element in the array
// describes a more specific sub-category. For example,
// "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs"
// category.
repeated string path = 4;
}
// A language criterion.
message LanguageInfo {
// The language constant resource name.
optional string language_constant = 2;
}
// An IpBlock criterion used for IP exclusions. We allow:
// - IPv4 and IPv6 addresses
// - individual addresses (192.168.0.1)
// - masks for individual addresses (192.168.0.1/32)
// - masks for Class C networks (192.168.0.1/24)
message IpBlockInfo {
// The IP address of this IP block.
optional string ip_address = 2;
}
// Content Label for category exclusion.
message ContentLabelInfo {
// Content label type, required for CREATE operations.
google.ads.googleads.v8.enums.ContentLabelTypeEnum.ContentLabelType type = 1;
}
// Represents a Carrier Criterion.
message CarrierInfo {
// The Carrier constant resource name.
optional string carrier_constant = 2;
}
// Represents a particular interest-based topic to be targeted.
message UserInterestInfo {
// The UserInterest resource name.
optional string user_interest_category = 2;
}
// Represents a criterion for targeting webpages of an advertiser's website.
message WebpageInfo {
// The name of the criterion that is defined by this parameter. The name value
// will be used for identifying, sorting and filtering criteria with this type
// of parameters.
//
// This field is required for CREATE operations and is prohibited on UPDATE
// operations.
optional string criterion_name = 3;
// Conditions, or logical expressions, for webpage targeting. The list of
// webpage targeting conditions are and-ed together when evaluated
// for targeting.
//
// This field is required for CREATE operations and is prohibited on UPDATE
// operations.
repeated WebpageConditionInfo conditions = 2;
// Website criteria coverage percentage. This is the computed percentage
// of website coverage based on the website target, negative website target
// and negative keywords in the ad group and campaign. For instance, when
// coverage returns as 1, it indicates it has 100% coverage. This field is
// read-only.
double coverage_percentage = 4;
// List of sample urls that match the website target. This field is read-only.
WebpageSampleInfo sample = 5;
}
// Logical expression for targeting webpages of an advertiser's website.
message WebpageConditionInfo {
// Operand of webpage targeting condition.
google.ads.googleads.v8.enums.WebpageConditionOperandEnum.WebpageConditionOperand operand = 1;
// Operator of webpage targeting condition.
google.ads.googleads.v8.enums.WebpageConditionOperatorEnum.WebpageConditionOperator operator = 2;
// Argument of webpage targeting condition.
optional string argument = 4;
}
// List of sample urls that match the website target
message WebpageSampleInfo {
// Webpage sample urls
repeated string sample_urls = 1;
}
// Represents an operating system version to be targeted.
message OperatingSystemVersionInfo {
// The operating system version constant resource name.
optional string operating_system_version_constant = 2;
}
// An app payment model criterion.
message AppPaymentModelInfo {
// Type of the app payment model.
google.ads.googleads.v8.enums.AppPaymentModelTypeEnum.AppPaymentModelType type = 1;
}
// A mobile device criterion.
message MobileDeviceInfo {
// The mobile device constant resource name.
optional string mobile_device_constant = 2;
}
// A custom affinity criterion.
// A criterion of this type is only targetable.
message CustomAffinityInfo {
// The CustomInterest resource name.
optional string custom_affinity = 2;
}
// A custom intent criterion.
// A criterion of this type is only targetable.
message CustomIntentInfo {
// The CustomInterest resource name.
optional string custom_intent = 2;
}
// A radius around a list of locations specified via a feed.
message LocationGroupInfo {
// Feed specifying locations for targeting.
// This is required and must be set in CREATE operations.
optional string feed = 5;
// Geo target constant(s) restricting the scope of the geographic area within
// the feed. Currently only one geo target constant is allowed.
repeated string geo_target_constants = 6;
// Distance in units specifying the radius around targeted locations.
// This is required and must be set in CREATE operations.
optional int64 radius = 7;
// Unit of the radius. Miles and meters are supported for geo target
// constants. Milli miles and meters are supported for feed item sets.
// This is required and must be set in CREATE operations.
google.ads.googleads.v8.enums.LocationGroupRadiusUnitsEnum.LocationGroupRadiusUnits radius_units = 4;
// FeedItemSets whose FeedItems are targeted. If multiple IDs are specified,
// then all items that appear in at least one set are targeted. This field
// cannot be used with geo_target_constants. This is optional and can only be
// set in CREATE operations.
repeated string feed_item_sets = 8;
}
// A custom audience criterion.
message CustomAudienceInfo {
// The CustomAudience resource name.
string custom_audience = 1;
}
// A combined audience criterion.
message CombinedAudienceInfo {
// The CombinedAudience resource name.
string combined_audience = 1;
}
// A Smart Campaign keyword theme.
message KeywordThemeInfo {
// Either a predefined keyword theme constant or free-form text may be
// specified.
oneof keyword_theme {
// The resource name of a Smart Campaign keyword theme constant.
// `keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}`
string keyword_theme_constant = 1;
// Free-form text to be matched to a Smart Campaign keyword theme constant
// on a best-effort basis.
string free_form_keyword_theme = 2;
}
}

82
google/ads/googleads/v8/common/criterion_category_availability.proto
View file

@ -1,82 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/enums/advertising_channel_sub_type.proto";
import "google/ads/googleads/v8/enums/advertising_channel_type.proto";
import "google/ads/googleads/v8/enums/criterion_category_channel_availability_mode.proto";
import "google/ads/googleads/v8/enums/criterion_category_locale_availability_mode.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "CriterionCategoryAvailabilityProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing criterion category availability information.
// Information of category availability, per advertising channel.
message CriterionCategoryAvailability {
// Channel types and subtypes that are available to the category.
CriterionCategoryChannelAvailability channel = 1;
// Locales that are available to the category for the channel.
repeated CriterionCategoryLocaleAvailability locale = 2;
}
// Information of advertising channel type and subtypes a category is available
// in.
message CriterionCategoryChannelAvailability {
// Format of the channel availability. Can be ALL_CHANNELS (the rest of the
// fields will not be set), CHANNEL_TYPE (only advertising_channel_type type
// will be set, the category is available to all sub types under it) or
// CHANNEL_TYPE_AND_SUBTYPES (advertising_channel_type,
// advertising_channel_sub_type, and include_default_channel_sub_type will all
// be set).
google.ads.googleads.v8.enums.CriterionCategoryChannelAvailabilityModeEnum.CriterionCategoryChannelAvailabilityMode availability_mode = 1;
// Channel type the category is available to.
google.ads.googleads.v8.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 2;
// Channel subtypes under the channel type the category is available to.
repeated google.ads.googleads.v8.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 3;
// Whether default channel sub type is included. For example,
// advertising_channel_type being DISPLAY and include_default_channel_sub_type
// being false means that the default display campaign where channel sub type
// is not set is not included in this availability configuration.
optional bool include_default_channel_sub_type = 5;
}
// Information about which locales a category is available in.
message CriterionCategoryLocaleAvailability {
// Format of the locale availability. Can be LAUNCHED_TO_ALL (both country and
// language will be empty), COUNTRY (only country will be set), LANGUAGE (only
// language wil be set), COUNTRY_AND_LANGUAGE (both country and language will
// be set).
google.ads.googleads.v8.enums.CriterionCategoryLocaleAvailabilityModeEnum.CriterionCategoryLocaleAvailabilityMode availability_mode = 1;
// Code of the country.
optional string country_code = 4;
// Code of the language.
optional string language_code = 5;
}

40
google/ads/googleads/v8/common/custom_parameter.proto
View file

@ -1,40 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "CustomParameterProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing CustomParameter and operation
// 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.
optional string key = 3;
// The value to be substituted.
optional string value = 4;
}

59
google/ads/googleads/v8/common/dates.proto
View file

@ -1,59 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/enums/month_of_year.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "DatesProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing date range message.
// A date range.
message DateRange {
// The start date, in yyyy-mm-dd format. This date is inclusive.
optional string start_date = 3;
// The end date, in yyyy-mm-dd format. This date is inclusive.
optional string end_date = 4;
}
// The year month range inclusive of the start and end months.
// Eg: A year month range to represent Jan 2020 would be: (Jan 2020, Jan 2020).
message YearMonthRange {
// The inclusive start year month.
YearMonth start = 1;
// The inclusive end year month.
YearMonth end = 2;
}
// Year month.
message YearMonth {
// The year (e.g. 2020).
int64 year = 1;
// The month of the year. (e.g. FEBRUARY).
google.ads.googleads.v8.enums.MonthOfYearEnum.MonthOfYear month = 2;
}

38
google/ads/googleads/v8/common/explorer_auto_optimizer_setting.proto
View file

@ -1,38 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "ExplorerAutoOptimizerSettingProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing ExplorerAutoOptimizerSetting
// Settings for the Display Campaign Optimizer, initially named "Explorer".
// Learn more about
// [automatic targeting](https://support.google.com/google-ads/answer/190596).
message ExplorerAutoOptimizerSetting {
// Indicates whether the optimizer is turned on.
optional bool opt_in = 2;
}

368
google/ads/googleads/v8/common/extensions.proto
View file

@ -1,368 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/common/custom_parameter.proto";
import "google/ads/googleads/v8/common/feed_common.proto";
import "google/ads/googleads/v8/enums/app_store.proto";
import "google/ads/googleads/v8/enums/call_conversion_reporting_state.proto";
import "google/ads/googleads/v8/enums/price_extension_price_qualifier.proto";
import "google/ads/googleads/v8/enums/price_extension_price_unit.proto";
import "google/ads/googleads/v8/enums/price_extension_type.proto";
import "google/ads/googleads/v8/enums/promotion_extension_discount_modifier.proto";
import "google/ads/googleads/v8/enums/promotion_extension_occasion.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "ExtensionsProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing extension types.
// Represents an App extension.
message AppFeedItem {
// The visible text displayed when the link is rendered in an ad.
// This string must not be empty, and the length of this string should
// be between 1 and 25, inclusive.
optional string link_text = 9;
// The store-specific ID for the target application.
// This string must not be empty.
optional string app_id = 10;
// The application store that the target application belongs to.
// This field is required.
google.ads.googleads.v8.enums.AppStoreEnum.AppStore app_store = 3;
// A list of possible final URLs after all cross domain redirects.
// This list must not be empty.
repeated string final_urls = 11;
// A list of possible final mobile URLs after all cross domain redirects.
repeated string final_mobile_urls = 12;
// URL template for constructing a tracking URL. Default value is "{lpurl}".
optional string tracking_url_template = 13;
// A list of mappings to be used for substituting URL custom parameter tags in
// the tracking_url_template, final_urls, and/or final_mobile_urls.
repeated CustomParameter url_custom_parameters = 7;
// URL template for appending params to landing page URLs served with parallel
// tracking.
optional string final_url_suffix = 14;
}
// Represents a Call extension.
message CallFeedItem {
// The advertiser's phone number to append to the ad.
// This string must not be empty.
optional string phone_number = 7;
// Uppercase two-letter country code of the advertiser's phone number.
// This string must not be empty.
optional string country_code = 8;
// Indicates whether call tracking is enabled. By default, call tracking is
// not enabled.
optional bool call_tracking_enabled = 9;
// The conversion action to attribute a call conversion to. If not set a
// default conversion action is used. This field only has effect if
// call_tracking_enabled is set to true. Otherwise this field is ignored.
optional string call_conversion_action = 10;
// If true, disable call conversion tracking. call_conversion_action should
// not be set if this is true. Optional.
optional bool call_conversion_tracking_disabled = 11;
// Enum value that indicates whether this call extension uses its own call
// conversion setting (or just have call conversion disabled), or following
// the account level setting.
google.ads.googleads.v8.enums.CallConversionReportingStateEnum.CallConversionReportingState call_conversion_reporting_state = 6;
}
// Represents a callout extension.
message CalloutFeedItem {
// The callout text.
// The length of this string should be between 1 and 25, inclusive.
optional string callout_text = 2;
}
// Represents a location extension.
message LocationFeedItem {
// The name of the business.
optional string business_name = 9;
// Line 1 of the business address.
optional string address_line_1 = 10;
// Line 2 of the business address.
optional string address_line_2 = 11;
// City of the business address.
optional string city = 12;
// Province of the business address.
optional string province = 13;
// Postal code of the business address.
optional string postal_code = 14;
// Country code of the business address.
optional string country_code = 15;
// Phone number of the business.
optional string phone_number = 16;
}
// Represents an affiliate location extension.
message AffiliateLocationFeedItem {
// The name of the business.
optional string business_name = 11;
// Line 1 of the business address.
optional string address_line_1 = 12;
// Line 2 of the business address.
optional string address_line_2 = 13;
// City of the business address.
optional string city = 14;
// Province of the business address.
optional string province = 15;
// Postal code of the business address.
optional string postal_code = 16;
// Country code of the business address.
optional string country_code = 17;
// Phone number of the business.
optional string phone_number = 18;
// Id of the retail chain that is advertised as a seller of your product.
optional int64 chain_id = 19;
// Name of chain.
optional string chain_name = 20;
}
// An extension that users can click on to send a text message to the
// advertiser.
message TextMessageFeedItem {
// The business name to prepend to the message text.
// This field is required.
optional string business_name = 6;
// Uppercase two-letter country code of the advertiser's phone number.
// This field is required.
optional string country_code = 7;
// The advertiser's phone number the message will be sent to. Required.
optional string phone_number = 8;
// The text to show in the ad.
// This field is required.
optional string text = 9;
// The message extension_text populated in the messaging app.
optional string extension_text = 10;
}
// Represents a Price extension.
message PriceFeedItem {
// Price extension type of this extension.
google.ads.googleads.v8.enums.PriceExtensionTypeEnum.PriceExtensionType type = 1;
// Price qualifier for all offers of this price extension.
google.ads.googleads.v8.enums.PriceExtensionPriceQualifierEnum.PriceExtensionPriceQualifier price_qualifier = 2;
// Tracking URL template for all offers of this price extension.
optional string tracking_url_template = 7;
// The code of the language used for this price extension.
optional string language_code = 8;
// The price offerings in this price extension.
repeated PriceOffer price_offerings = 5;
// Tracking URL template for all offers of this price extension.
optional string final_url_suffix = 9;
}
// Represents one price offer in a price extension.
message PriceOffer {
// Header text of this offer.
optional string header = 7;
// Description text of this offer.
optional string description = 8;
// Price value of this offer.
Money price = 3;
// Price unit for this offer.
google.ads.googleads.v8.enums.PriceExtensionPriceUnitEnum.PriceExtensionPriceUnit unit = 4;
// A list of possible final URLs after all cross domain redirects.
repeated string final_urls = 9;
// A list of possible final mobile URLs after all cross domain redirects.
repeated string final_mobile_urls = 10;
}
// Represents a Promotion extension.
message PromotionFeedItem {
// A freeform description of what the promotion is targeting.
// This field is required.
optional string promotion_target = 16;
// Enum that modifies the qualification of the discount.
google.ads.googleads.v8.enums.PromotionExtensionDiscountModifierEnum.PromotionExtensionDiscountModifier discount_modifier = 2;
// Start date of when the promotion is eligible to be redeemed.
optional string promotion_start_date = 19;
// Last date when the promotion is eligible to be redeemed.
optional string promotion_end_date = 20;
// The occasion the promotion was intended for.
// If an occasion is set, the redemption window will need to fall within
// the date range associated with the occasion.
google.ads.googleads.v8.enums.PromotionExtensionOccasionEnum.PromotionExtensionOccasion occasion = 9;
// A list of possible final URLs after all cross domain redirects.
// This field is required.
repeated string final_urls = 21;
// A list of possible final mobile URLs after all cross domain redirects.
repeated string final_mobile_urls = 22;
// URL template for constructing a tracking URL.
optional string tracking_url_template = 23;
// A list of mappings to be used for substituting URL custom parameter tags in
// the tracking_url_template, final_urls, and/or final_mobile_urls.
repeated CustomParameter url_custom_parameters = 13;
// URL template for appending params to landing page URLs served with parallel
// tracking.
optional string final_url_suffix = 24;
// The language of the promotion.
// Represented as BCP 47 language tag.
optional string language_code = 25;
// Discount type, can be percentage off or amount off.
oneof discount_type {
// Percentage off discount in the promotion in micros.
// One million is equivalent to one percent.
// Either this or money_off_amount is required.
int64 percent_off = 17;
// Money amount off for discount in the promotion.
// Either this or percent_off is required.
Money money_amount_off = 4;
}
// Promotion trigger. Can be by promotion code or promo by eligible order
// amount.
oneof promotion_trigger {
// A code the user should use in order to be eligible for the promotion.
string promotion_code = 18;
// The amount the total order needs to be for the user to be eligible for
// the promotion.
Money orders_over_amount = 6;
}
}
// Represents a structured snippet extension.
message StructuredSnippetFeedItem {
// The header of the snippet.
// This string must not be empty.
optional string header = 3;
// The values in the snippet.
// The maximum size of this collection is 10.
repeated string values = 4;
}
// Represents a sitelink extension.
message SitelinkFeedItem {
// URL display text for the sitelink.
// The length of this string should be between 1 and 25, inclusive.
optional string link_text = 9;
// First line of the description for the sitelink.
// If this value is set, line2 must also be set.
// The length of this string should be between 0 and 35, inclusive.
optional string line1 = 10;
// Second line of the description for the sitelink.
// If this value is set, line1 must also be set.
// The length of this string should be between 0 and 35, inclusive.
optional string line2 = 11;
// A list of possible final URLs after all cross domain redirects.
repeated string final_urls = 12;
// A list of possible final mobile URLs after all cross domain redirects.
repeated string final_mobile_urls = 13;
// URL template for constructing a tracking URL.
optional string tracking_url_template = 14;
// A list of mappings to be used for substituting URL custom parameter tags in
// the tracking_url_template, final_urls, and/or final_mobile_urls.
repeated CustomParameter url_custom_parameters = 7;
// Final URL suffix to be appended to landing page URLs served with
// parallel tracking.
optional string final_url_suffix = 15;
}
// Represents a hotel callout extension.
message HotelCalloutFeedItem {
// The callout text.
// The length of this string should be between 1 and 25, inclusive.
optional string text = 3;
// The language of the hotel callout text.
// IETF BCP 47 compliant language code.
optional string language_code = 4;
}
// Represents an advertiser provided image extension.
message ImageFeedItem {
// Required. Resource name of the image asset.
string image_asset = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "googleads.googleapis.com/Asset"
}
];
}

39
google/ads/googleads/v8/common/feed_common.proto
View file

@ -1,39 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "FeedCommonProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing common feed proto messages.
// Represents a price in a particular currency.
message Money {
// Three-character ISO 4217 currency code.
optional string currency_code = 3;
// Amount in micros. One million is equivalent to one unit.
optional int64 amount_micros = 4;
}

58
google/ads/googleads/v8/common/feed_item_set_filter_type_infos.proto
View file

@ -1,58 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/enums/feed_item_set_string_filter_type.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "FeedItemSetFilterTypeInfosProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Represents a filter on locations in a feed item set.
// Only applicable if the parent Feed of the FeedItemSet is a LOCATION feed.
message DynamicLocationSetFilter {
// If multiple labels are set, then only feeditems marked with all the labels
// will be added to the FeedItemSet.
repeated string labels = 1;
// Business name filter.
BusinessNameFilter business_name_filter = 2;
}
// Represents a business name filter on locations in a FeedItemSet.
message BusinessNameFilter {
// Business name string to use for filtering.
string business_name = 1;
// The type of string matching to use when filtering with business_name.
google.ads.googleads.v8.enums.FeedItemSetStringFilterTypeEnum.FeedItemSetStringFilterType filter_type = 2;
}
// Represents a filter on affiliate locations in a FeedItemSet.
// Only applicable if the parent Feed of the FeedItemSet is an
// AFFILIATE_LOCATION feed.
message DynamicAffiliateLocationSetFilter {
// Used to filter affiliate locations by chain ids. Only affiliate locations
// that belong to the specified chain(s) will be added to the FeedItemSet.
repeated int64 chain_ids = 1;
}

46
google/ads/googleads/v8/common/final_app_url.proto
View file

@ -1,46 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/enums/app_url_operating_system_type.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "FinalAppUrlProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file FinalAppUrl type.
// A URL for deep linking into an app for the given operating system.
message FinalAppUrl {
// The operating system targeted by this URL. Required.
google.ads.googleads.v8.enums.AppUrlOperatingSystemTypeEnum.AppUrlOperatingSystemType os_type = 1;
// The app deep link URL. Deep links specify a location in an app that
// corresponds to the content you'd like to show, and should be of the form
// {scheme}://{host_path}
// The scheme identifies which app to open. For your app, you can use a custom
// scheme that starts with the app's name. The host and path specify the
// unique location in the app where your content exists.
// Example: "exampleapp://productid_1234". Required.
optional string url = 3;
}

61
google/ads/googleads/v8/common/frequency_cap.proto
View file

@ -1,61 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/enums/frequency_cap_event_type.proto";
import "google/ads/googleads/v8/enums/frequency_cap_level.proto";
import "google/ads/googleads/v8/enums/frequency_cap_time_unit.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "FrequencyCapProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing frequency caps.
// A rule specifying the maximum number of times an ad (or some set of ads) can
// be shown to a user over a particular time period.
message FrequencyCapEntry {
// The key of a particular frequency cap. There can be no more
// than one frequency cap with the same key.
FrequencyCapKey key = 1;
// Maximum number of events allowed during the time range by this cap.
optional int32 cap = 3;
}
// A group of fields used as keys for a frequency cap.
// There can be no more than one frequency cap with the same key.
message FrequencyCapKey {
// The level on which the cap is to be applied (e.g. ad group ad, ad group).
// The cap is applied to all the entities of this level.
google.ads.googleads.v8.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1;
// The type of event that the cap applies to (e.g. impression).
google.ads.googleads.v8.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3;
// Unit of time the cap is defined at (e.g. day, week).
google.ads.googleads.v8.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2;
// Number of time units the cap lasts.
optional int32 time_length = 5;
}

139
google/ads/googleads/v8/common/keyword_plan_common.proto
View file

@ -1,139 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/common/dates.proto";
import "google/ads/googleads/v8/enums/device.proto";
import "google/ads/googleads/v8/enums/keyword_plan_aggregate_metric_type.proto";
import "google/ads/googleads/v8/enums/keyword_plan_competition_level.proto";
import "google/ads/googleads/v8/enums/keyword_plan_concept_group_type.proto";
import "google/ads/googleads/v8/enums/month_of_year.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanCommonProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing Keyword Planner messages.
// 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 {
// Approximate number of monthly searches on this query averaged
// for the past 12 months.
optional int64 avg_monthly_searches = 7;
// Approximate number of searches on this query for the past twelve months.
repeated MonthlySearchVolume monthly_search_volumes = 6;
// The competition level for the query.
google.ads.googleads.v8.enums.KeywordPlanCompetitionLevelEnum.KeywordPlanCompetitionLevel competition = 2;
// The competition index for the query in the range [0, 100].
// Shows how competitive ad placement is for a keyword.
// The level of competition from 0-100 is determined by the number of ad slots
// filled divided by the total number of ad slots available. If not enough
// data is available, null is returned.
optional int64 competition_index = 8;
// Top of page bid low range (20th percentile) in micros for the keyword.
optional int64 low_top_of_page_bid_micros = 9;
// Top of page bid high range (80th percentile) in micros for the keyword.
optional int64 high_top_of_page_bid_micros = 10;
}
// Historical metrics options.
message HistoricalMetricsOptions {
// The year month range for historical metrics. If not specified the searches
// will be returned for past 12 months.
// Searches data is available for the past 4 years. If the search volume is
// not available for the entire year_month_range provided, the subset of the
// year month range for which search volume is available will be returned.
optional YearMonthRange year_month_range = 1;
}
// Monthly search volume.
message MonthlySearchVolume {
// The year of the search volume (e.g. 2020).
optional int64 year = 4;
// The month of the search volume.
google.ads.googleads.v8.enums.MonthOfYearEnum.MonthOfYear month = 2;
// Approximate number of searches for the month.
// A null value indicates the search volume is unavailable for
// that month.
optional int64 monthly_searches = 5;
}
// The aggregate metrics specification of the request.
message KeywordPlanAggregateMetrics {
// The list of aggregate metrics to fetch data.
repeated google.ads.googleads.v8.enums.KeywordPlanAggregateMetricTypeEnum.KeywordPlanAggregateMetricType aggregate_metric_types = 1;
}
// The aggregated historical metrics for keyword plan keywords.
message KeywordPlanAggregateMetricResults {
// The aggregate searches for all the keywords segmented by device
// for the specified time.
// Supports the following device types: MOBILE, TABLET, DESKTOP.
//
// This is only set when KeywordPlanAggregateMetricTypeEnum.DEVICE is set
// in the KeywordPlanAggregateMetrics field in the request.
repeated KeywordPlanDeviceSearches device_searches = 1;
}
// The total searches for the device type during the specified time period.
message KeywordPlanDeviceSearches {
// The device type.
google.ads.googleads.v8.enums.DeviceEnum.Device device = 1;
// The total searches for the device.
optional int64 search_count = 2;
}
// The Annotations for the Keyword plan keywords.
message KeywordAnnotations {
// The list of concepts for the keyword.
repeated KeywordConcept concepts = 1;
}
// The concept for the keyword.
message KeywordConcept {
// The concept name for the keyword in the concept_group.
string name = 1;
// The concept group of the concept details.
ConceptGroup concept_group = 2;
}
// The concept group for the keyword concept.
message ConceptGroup {
// The concept group name.
string name = 1;
// The concept group type.
google.ads.googleads.v8.enums.KeywordPlanConceptGroupTypeEnum.KeywordPlanConceptGroupType type = 2;
}

126
google/ads/googleads/v8/common/matching_function.proto
View file

@ -1,126 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/enums/matching_function_context_type.proto";
import "google/ads/googleads/v8/enums/matching_function_operator.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "MatchingFunctionProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing a matching function.
// Matching function associated with a
// CustomerFeed, CampaignFeed, or AdGroupFeed. The matching function is used
// to filter the set of feed items selected.
message MatchingFunction {
// String representation of the Function.
//
// Examples:
//
// 1. IDENTITY(true) or IDENTITY(false). All or no feed items served.
// 2. EQUALS(CONTEXT.DEVICE,"Mobile")
// 3. IN(FEED_ITEM_ID,{1000001,1000002,1000003})
// 4. CONTAINS_ANY(FeedAttribute[12345678,0],{"Mars cruise","Venus cruise"})
// 5. AND(IN(FEED_ITEM_ID,{10001,10002}),EQUALS(CONTEXT.DEVICE,"Mobile"))
//
// For more details, visit
// https://developers.google.com/adwords/api/docs/guides/feed-matching-functions
//
// Note that because multiple strings may represent the same underlying
// function (whitespace and single versus double quotation marks, for
// example), the value returned may not be identical to the string sent in a
// mutate request.
optional string function_string = 5;
// Operator for a function.
google.ads.googleads.v8.enums.MatchingFunctionOperatorEnum.MatchingFunctionOperator operator = 4;
// The operands on the left hand side of the equation. This is also the
// operand to be used for single operand expressions such as NOT.
repeated Operand left_operands = 2;
// The operands on the right hand side of the equation.
repeated Operand right_operands = 3;
}
// An operand in a matching function.
message Operand {
// A constant operand in a matching function.
message ConstantOperand {
// Constant operand values. Required.
oneof constant_operand_value {
// String value of the operand if it is a string type.
string string_value = 5;
// Int64 value of the operand if it is a int64 type.
int64 long_value = 6;
// Boolean value of the operand if it is a boolean type.
bool boolean_value = 7;
// Double value of the operand if it is a double type.
double double_value = 8;
}
}
// A feed attribute operand in a matching function.
// Used to represent a feed attribute in feed.
message FeedAttributeOperand {
// The associated feed. Required.
optional int64 feed_id = 3;
// Id of the referenced feed attribute. Required.
optional int64 feed_attribute_id = 4;
}
// A function operand in a matching function.
// Used to represent nested functions.
message FunctionOperand {
// The matching function held in this operand.
MatchingFunction matching_function = 1;
}
// An operand in a function referring to a value in the request context.
message RequestContextOperand {
// Type of value to be referred in the request context.
google.ads.googleads.v8.enums.MatchingFunctionContextTypeEnum.MatchingFunctionContextType context_type = 1;
}
// Different operands that can be used in a matching function. Required.
oneof function_argument_operand {
// A constant operand in a matching function.
ConstantOperand constant_operand = 1;
// This operand specifies a feed attribute in feed.
FeedAttributeOperand feed_attribute_operand = 2;
// A function operand in a matching function.
// Used to represent nested functions.
FunctionOperand function_operand = 3;
// An operand in a function referring to a value in the request context.
RequestContextOperand request_context_operand = 4;
}
}

619
google/ads/googleads/v8/common/metrics.proto
View file

@ -1,619 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/enums/interaction_event_type.proto";
import "google/ads/googleads/v8/enums/quality_score_bucket.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "MetricsProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing metrics.
// Metrics data.
message Metrics {
// The percent of your ad impressions that are shown as the very first ad
// above the organic search results.
optional double absolute_top_impression_percentage = 183;
// Average cost of viewable impressions (`active_view_impressions`).
optional double active_view_cpm = 184;
// Active view measurable clicks divided by active view viewable impressions.
// This metric is reported only for display network.
optional double active_view_ctr = 185;
// A measurement of how often your ad has become viewable on a Display
// Network site.
optional int64 active_view_impressions = 186;
// The ratio of impressions that could be measured by Active View over the
// number of served impressions.
optional double active_view_measurability = 187;
// The cost of the impressions you received that were measurable by Active
// View.
optional int64 active_view_measurable_cost_micros = 188;
// The number of times your ads are appearing on placements in positions
// where they can be seen.
optional int64 active_view_measurable_impressions = 189;
// The percentage of time when your ad appeared on an Active View enabled site
// (measurable impressions) and was viewable (viewable impressions).
optional double active_view_viewability = 190;
// All conversions from interactions (as oppose to view through conversions)
// divided by the number of ad interactions.
optional double all_conversions_from_interactions_rate = 191;
// The value of all conversions.
optional double all_conversions_value = 192;
// The value of all conversions. When this column is selected with date, the
// values in date column means the conversion date. Details for the
// by_conversion_date columns are available at
// https://support.google.com/google-ads/answer/9549009.
double all_conversions_value_by_conversion_date = 240;
// The total number of conversions. This includes all conversions regardless
// of the value of include_in_conversions_metric.
optional double all_conversions = 193;
// The total number of conversions. This includes all conversions regardless
// of the value of include_in_conversions_metric. When this column is selected
// with date, the values in date column means the conversion date. Details for
// the by_conversion_date columns are available at
// https://support.google.com/google-ads/answer/9549009.
double all_conversions_by_conversion_date = 241;
// The value of all conversions divided by the total cost of ad interactions
// (such as clicks for text ads or views for video ads).
optional double all_conversions_value_per_cost = 194;
// The number of times people clicked the "Call" button to call a store during
// or after clicking an ad. This number doesn't include whether or not calls
// were connected, or the duration of any calls.
// This metric applies to feed items only.
optional double all_conversions_from_click_to_call = 195;
// The number of times people clicked a "Get directions" button to navigate to
// a store after clicking an ad.
// This metric applies to feed items only.
optional double all_conversions_from_directions = 196;
// The value of all conversions from interactions divided by the total number
// of interactions.
optional double all_conversions_from_interactions_value_per_interaction = 197;
// The number of times people clicked a link to view a store's menu after
// clicking an ad.
// This metric applies to feed items only.
optional double all_conversions_from_menu = 198;
// The number of times people placed an order at a store after clicking an ad.
// This metric applies to feed items only.
optional double all_conversions_from_order = 199;
// The number of other conversions (for example, posting a review or saving a
// location for a store) that occurred after people clicked an ad.
// This metric applies to feed items only.
optional double all_conversions_from_other_engagement = 200;
// Estimated number of times people visited a store after clicking an ad.
// This metric applies to feed items only.
optional double all_conversions_from_store_visit = 201;
// The number of times that people were taken to a store's URL after clicking
// an ad.
// This metric applies to feed items only.
optional double all_conversions_from_store_website = 202;
// The average amount you pay per interaction. This amount is the total cost
// of your ads divided by the total number of interactions.
optional double average_cost = 203;
// The total cost of all clicks divided by the total number of clicks
// received.
optional double average_cpc = 204;
// The average amount that you've been charged for an ad engagement. This
// amount is the total cost of all ad engagements divided by the total number
// of ad engagements.
optional double average_cpe = 205;
// Average cost-per-thousand impressions (CPM).
optional double average_cpm = 206;
// The average amount you pay each time someone views your ad.
// The average CPV is defined by the total cost of all ad views divided by
// the number of views.
optional double average_cpv = 207;
// Average number of pages viewed per session.
optional double average_page_views = 208;
// Total duration of all sessions (in seconds) / number of sessions. Imported
// from Google Analytics.
optional double average_time_on_site = 209;
// An indication of how other advertisers are bidding on similar products.
optional double benchmark_average_max_cpc = 210;
// An indication on how other advertisers' Shopping ads for similar products
// are performing based on how often people who see their ad click on it.
optional double benchmark_ctr = 211;
// Percentage of clicks where the user only visited a single page on your
// site. Imported from Google Analytics.
optional double bounce_rate = 212;
// The number of clicks.
optional int64 clicks = 131;
// The number of times your ad or your site's listing in the unpaid
// results was clicked. See the help page at
// https://support.google.com/google-ads/answer/3097241 for details.
optional int64 combined_clicks = 156;
// The number of times your ad or your site's listing in the unpaid
// results was clicked (combined_clicks) divided by combined_queries. See the
// help page at https://support.google.com/google-ads/answer/3097241 for
// details.
optional double combined_clicks_per_query = 157;
// The number of searches that returned pages from your site in the unpaid
// results or showed one of your text ads. See the help page at
// https://support.google.com/google-ads/answer/3097241 for details.
optional int64 combined_queries = 158;
// 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.
optional double content_budget_lost_impression_share = 159;
// 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.
optional double content_impression_share = 160;
// The last date/time a conversion tag for this conversion action successfully
// fired and was seen by Google Ads. This firing event may not have been the
// result of an attributable conversion (e.g. because the tag was fired from a
// browser that did not previously click an ad from an appropriate
// advertiser). The date/time is in the customer's time zone.
optional string conversion_last_received_request_date_time = 161;
// The date of the most recent conversion for this conversion action. The date
// is in the customer's time zone.
optional string conversion_last_conversion_date = 162;
// 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.
optional double content_rank_lost_impression_share = 163;
// Conversions from interactions divided by the number of ad interactions
// (such as clicks for text ads or views for video ads). This only includes
// conversion actions which include_in_conversions_metric attribute is set to
// true. If you use conversion-based bidding, your bid strategies will
// optimize for these conversions.
optional double conversions_from_interactions_rate = 164;
// The value of conversions. This only includes conversion actions which
// include_in_conversions_metric attribute is set to true. If you use
// conversion-based bidding, your bid strategies will optimize for these
// conversions.
optional double conversions_value = 165;
// The value of conversions. This only includes conversion actions which
// include_in_conversions_metric attribute is set to true. If you use
// conversion-based bidding, your bid strategies will optimize for these
// conversions. When this column is selected with date, the values in date
// column means the conversion date. Details for the by_conversion_date
// columns are available at
// https://support.google.com/google-ads/answer/9549009.
double conversions_value_by_conversion_date = 242;
// The value of conversions divided by the cost of ad interactions. This only
// includes conversion actions which include_in_conversions_metric attribute
// is set to true. If you use conversion-based bidding, your bid strategies
// will optimize for these conversions.
optional double conversions_value_per_cost = 166;
// The value of conversions from interactions divided by the number of ad
// interactions. This only includes conversion actions which
// include_in_conversions_metric attribute is set to true. If you use
// conversion-based bidding, your bid strategies will optimize for these
// conversions.
optional double conversions_from_interactions_value_per_interaction = 167;
// The number of conversions. This only includes conversion actions which
// include_in_conversions_metric attribute is set to true. If you use
// conversion-based bidding, your bid strategies will optimize for these
// conversions.
optional double conversions = 168;
// The number of conversions. This only includes conversion actions which
// include_in_conversions_metric attribute is set to true. If you use
// conversion-based bidding, your bid strategies will optimize for these
// conversions. When this column is selected with date, the values in date
// column means the conversion date. Details for the by_conversion_date
// columns are available at
// https://support.google.com/google-ads/answer/9549009.
double conversions_by_conversion_date = 243;
// The sum of your cost-per-click (CPC) and cost-per-thousand impressions
// (CPM) costs during this period.
optional int64 cost_micros = 169;
// The cost of ad interactions divided by all conversions.
optional double cost_per_all_conversions = 170;
// The cost of ad interactions divided by conversions. This only includes
// conversion actions which include_in_conversions_metric attribute is set to
// true. If you use conversion-based bidding, your bid strategies will
// optimize for these conversions.
optional double cost_per_conversion = 171;
// The cost of ad interactions divided by current model attributed
// conversions. This only includes conversion actions which
// include_in_conversions_metric attribute is set to true. If you use
// conversion-based bidding, your bid strategies will optimize for these
// conversions.
optional double cost_per_current_model_attributed_conversion = 172;
// Conversions from when a customer clicks on a Google Ads ad on one device,
// then converts on a different device or browser.
// Cross-device conversions are already included in all_conversions.
optional double cross_device_conversions = 173;
// The number of clicks your ad receives (Clicks) divided by the number
// of times your ad is shown (Impressions).
optional double ctr = 174;
// Shows how your historic conversions data would look under the attribution
// model you've currently selected. This only includes conversion actions
// which include_in_conversions_metric attribute is set to true. If you use
// conversion-based bidding, your bid strategies will optimize for these
// conversions.
optional double current_model_attributed_conversions = 175;
// Current model attributed conversions from interactions divided by the
// number of ad interactions (such as clicks for text ads or views for video
// ads). This only includes conversion actions which
// include_in_conversions_metric attribute is set to true. If you use
// conversion-based bidding, your bid strategies will optimize for these
// conversions.
optional double current_model_attributed_conversions_from_interactions_rate = 176;
// The value of current model attributed conversions from interactions divided
// by the number of ad interactions. This only includes conversion actions
// which include_in_conversions_metric attribute is set to true. If you use
// conversion-based bidding, your bid strategies will optimize for these
// conversions.
optional double current_model_attributed_conversions_from_interactions_value_per_interaction = 177;
// The value of current model attributed conversions. This only includes
// conversion actions which include_in_conversions_metric attribute is set to
// true. If you use conversion-based bidding, your bid strategies will
// optimize for these conversions.
optional double current_model_attributed_conversions_value = 178;
// The value of current model attributed conversions divided by the cost of ad
// interactions. This only includes conversion actions which
// include_in_conversions_metric attribute is set to true. If you use
// conversion-based bidding, your bid strategies will optimize for these
// conversions.
optional double current_model_attributed_conversions_value_per_cost = 179;
// 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.
optional double engagement_rate = 180;
// 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.
optional int64 engagements = 181;
// Average lead value based on clicks.
optional double hotel_average_lead_value_micros = 213;
// The average price difference between the price offered by reporting hotel
// advertiser and the cheapest price offered by the competing advertiser.
optional double hotel_price_difference_percentage = 214;
// The number of impressions that hotel partners could have had given their
// feed performance.
optional int64 hotel_eligible_impressions = 215;
// The creative historical quality score.
google.ads.googleads.v8.enums.QualityScoreBucketEnum.QualityScoreBucket historical_creative_quality_score = 80;
// The quality of historical landing page experience.
google.ads.googleads.v8.enums.QualityScoreBucketEnum.QualityScoreBucket historical_landing_page_quality_score = 81;
// The historical quality score.
optional int64 historical_quality_score = 216;
// The historical search predicted click through rate (CTR).
google.ads.googleads.v8.enums.QualityScoreBucketEnum.QualityScoreBucket historical_search_predicted_ctr = 83;
// The number of times the ad was forwarded to someone else as a message.
optional int64 gmail_forwards = 217;
// The number of times someone has saved your Gmail ad to their inbox as a
// message.
optional int64 gmail_saves = 218;
// The number of clicks to the landing page on the expanded state of Gmail
// ads.
optional int64 gmail_secondary_clicks = 219;
// The number of times a store's location-based ad was shown.
// This metric applies to feed items only.
optional int64 impressions_from_store_reach = 220;
// Count of how often your ad has appeared on a search results page or
// website on the Google Network.
optional int64 impressions = 221;
// 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.
optional double interaction_rate = 222;
// 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.
optional int64 interactions = 223;
// The types of payable and free interactions.
repeated google.ads.googleads.v8.enums.InteractionEventTypeEnum.InteractionEventType interaction_event_types = 100;
// The percentage of clicks filtered out of your total number of clicks
// (filtered + non-filtered clicks) during the reporting period.
optional double invalid_click_rate = 224;
// Number of clicks Google considers illegitimate and doesn't charge you for.
optional int64 invalid_clicks = 225;
// Number of message chats initiated for Click To Message impressions that
// were message tracking eligible.
optional int64 message_chats = 226;
// Number of Click To Message impressions that were message tracking eligible.
optional int64 message_impressions = 227;
// Number of message chats initiated (message_chats) divided by the number
// of message impressions (message_impressions).
// Rate at which a user initiates a message chat from an ad impression with
// a messaging option and message tracking enabled.
// Note that this rate can be more than 1.0 for a given message impression.
optional double message_chat_rate = 228;
// The percentage of mobile clicks that go to a mobile-friendly page.
optional double mobile_friendly_clicks_percentage = 229;
// Total optimization score uplift of all recommendations.
optional double optimization_score_uplift = 247;
// URL for the optimization score page in the Google Ads web interface.
// This metric can be selected from `customer` or `campaign`, and can be
// segmented by `segments.recommendation_type`. For example, `SELECT
// metrics.optimization_score_url, segments.recommendation_type FROM
// customer` will return a URL for each unique (customer, recommendation_type)
// combination.
optional string optimization_score_url = 248;
// The number of times someone clicked your site's listing in the unpaid
// results for a particular query. See the help page at
// https://support.google.com/google-ads/answer/3097241 for details.
optional int64 organic_clicks = 230;
// The number of times someone clicked your site's listing in the unpaid
// results (organic_clicks) divided by the total number of searches that
// returned pages from your site (organic_queries). See the help page at
// https://support.google.com/google-ads/answer/3097241 for details.
optional double organic_clicks_per_query = 231;
// The number of listings for your site in the unpaid search results. See the
// help page at https://support.google.com/google-ads/answer/3097241 for
// details.
optional int64 organic_impressions = 232;
// The number of times a page from your site was listed in the unpaid search
// results (organic_impressions) divided by the number of searches returning
// your site's listing in the unpaid results (organic_queries). See the help
// page at https://support.google.com/google-ads/answer/3097241 for details.
optional double organic_impressions_per_query = 233;
// The total number of searches that returned your site's listing in the
// unpaid results. See the help page at
// https://support.google.com/google-ads/answer/3097241 for details.
optional int64 organic_queries = 234;
// Percentage of first-time sessions (from people who had never visited your
// site before). Imported from Google Analytics.
optional double percent_new_visitors = 235;
// Number of offline phone calls.
optional int64 phone_calls = 236;
// Number of offline phone impressions.
optional int64 phone_impressions = 237;
// Number of phone calls received (phone_calls) divided by the number of
// times your phone number is shown (phone_impressions).
optional double phone_through_rate = 238;
// 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.
optional double relative_ctr = 239;
// 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/google-ads/answer/7501826
// 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
// 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;
// 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.
optional double search_budget_lost_impression_share = 138;
// The number estimating how often your ad didn't show anywhere above the
// 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.
optional double search_budget_lost_top_impression_share = 139;
// The number of clicks you've received on the Search Network
// divided by the estimated number of clicks you were eligible to receive.
// Note: Search click share is reported in the range of 0.1 to 1. Any value
// below 0.1 is reported as 0.0999.
optional double search_click_share = 140;
// 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.
optional double search_exact_match_impression_share = 141;
// 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.
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.
// 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;
// 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.
optional double search_rank_lost_impression_share = 144;
// The number estimating how often your ad didn't show anywhere above the
// 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.
// 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.
optional double search_top_impression_share = 146;
// A measure of how quickly your page loads after clicks on your mobile ads.
// The score is a range from 1 to 10, 10 being the fastest.
optional int64 speed_score = 147;
// The percent of your ad impressions that are shown anywhere above the
// organic search results.
optional double top_impression_percentage = 148;
// The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages
// that reach a valid AMP page.
optional double valid_accelerated_mobile_pages_clicks_percentage = 149;
// The value of all conversions divided by the number of all conversions.
optional double value_per_all_conversions = 150;
// The value of all conversions divided by the number of all conversions. When
// this column is selected with date, the values in date column means the
// conversion date. Details for the by_conversion_date columns are available
// at https://support.google.com/google-ads/answer/9549009.
optional double value_per_all_conversions_by_conversion_date = 244;
// The value of conversions divided by the number of conversions. This only
// includes conversion actions which include_in_conversions_metric attribute
// is set to true. If you use conversion-based bidding, your bid strategies
// will optimize for these conversions.
optional double value_per_conversion = 151;
// The value of conversions divided by the number of conversions. This only
// includes conversion actions which include_in_conversions_metric attribute
// is set to true. If you use conversion-based bidding, your bid strategies
// will optimize for these conversions. When this column is selected with
// date, the values in date column means the conversion date. Details for the
// by_conversion_date columns are available at
// https://support.google.com/google-ads/answer/9549009.
optional double value_per_conversions_by_conversion_date = 245;
// The value of current model attributed conversions divided by the number of
// the conversions. This only includes conversion actions which
// include_in_conversions_metric attribute is set to true. If you use
// conversion-based bidding, your bid strategies will optimize for these
// conversions.
optional double value_per_current_model_attributed_conversion = 152;
// Percentage of impressions where the viewer watched all of your video.
optional double video_quartile_p100_rate = 132;
// Percentage of impressions where the viewer watched 25% of your video.
optional double video_quartile_p25_rate = 133;
// Percentage of impressions where the viewer watched 50% of your video.
optional double video_quartile_p50_rate = 134;
// Percentage of impressions where the viewer watched 75% of your video.
optional double video_quartile_p75_rate = 135;
// The number of views your TrueView video ad receives divided by its number
// of impressions, including thumbnail impressions for TrueView in-display
// ads.
optional double video_view_rate = 153;
// The number of times your video ads were viewed.
optional int64 video_views = 154;
// 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.
optional int64 view_through_conversions = 155;
// The number of iOS Store Kit Ad Network conversions.
int64 sk_ad_network_conversions = 246;
}

284
google/ads/googleads/v8/common/offline_user_data.proto
View file

@ -1,284 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/enums/user_identifier_source.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "OfflineUserDataProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing offline user data.
// Address identifier of offline data.
message OfflineUserAddressInfo {
// First name of the user, which is hashed as SHA-256 after normalized
// (Lowercase all characters; Remove any extra spaces before, after, and in
// between).
optional string hashed_first_name = 7;
// Last name of the user, which is hashed as SHA-256 after normalized (lower
// case only and no punctuation).
optional string hashed_last_name = 8;
// City of the address. Only accepted for Store Sales and
// ConversionAdjustmentUploadService.
optional string city = 9;
// State code of the address. Only accepted for Store Sales and
// ConversionAdjustmentUploadService.
optional string state = 10;
// 2-letter country code in ISO-3166-1 alpha-2 of the user's address.
optional string country_code = 11;
// Postal code of the user's address.
optional string postal_code = 12;
// The street address of the user hashed using SHA-256 hash function after
// normalization (lower case only). Only accepted for
// ConversionAdjustmentUploadService.
optional string hashed_street_address = 13;
}
// User identifying information.
message UserIdentifier {
// Source of the user identifier when the upload is from Store Sales,
// ConversionUploadService, or ConversionAdjustmentUploadService. For
// ConversionUploadService and ConversionAdjustmentUploadService, the source
// of the user identifier must be specified as FIRST_PARTY, otherwise an error
// will be returned.
google.ads.googleads.v8.enums.UserIdentifierSourceEnum.UserIdentifierSource user_identifier_source = 6;
// Exactly one must be specified. For OfflineUserDataJobService, Customer
// Match accepts hashed_email, hashed_phone_number, mobile_id,
// third_party_user_id, and address_info; Store Sales accepts hashed_email,
// hashed_phone_number, third_party_user_id, and address_info.
// ConversionUploadService accepts hashed_email and hashed_phone_number.
// ConversionAdjustmentUploadService accepts hashed_email,
// hashed_phone_number, and address_info.
oneof identifier {
// Hashed email address using SHA-256 hash function after normalization.
// Accepted for Customer Match, Store Sales, ConversionUploadService, and
// ConversionAdjustmentUploadService.
string hashed_email = 7;
// Hashed phone number using SHA-256 hash function after normalization
// (E164 standard). Accepted for Customer Match, Store Sales,
// ConversionUploadService, and ConversionAdjustmentUploadService.
string hashed_phone_number = 8;
// Mobile device ID (advertising ID/IDFA). Accepted only for Customer Match.
string mobile_id = 9;
// Advertiser-assigned user ID for Customer Match upload, or
// third-party-assigned user ID for Store Sales. Accepted only for Customer
// Match and Store Sales.
string third_party_user_id = 10;
// Address information. Accepted only for Customer Match, Store Sales, and
// ConversionAdjustmentUploadService.
OfflineUserAddressInfo address_info = 5;
}
}
// Attribute of the store sales transaction.
message TransactionAttribute {
// Timestamp when transaction occurred. Required.
// The format is "YYYY-MM-DD HH:MM:SS[+/-HH:MM]", where [+/-HH:MM] is an
// optional timezone offset from UTC. If the offset is absent, the API will
// use the account's timezone as default.
// Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30+03:00"
optional string transaction_date_time = 8;
// Transaction amount in micros. Required.
// Transaction amount in micros needs to be greater than 1000.
// If item Attributes are provided, it represents the total value of the
// items, after multiplying the unit price per item by the quantity provided
// in the ItemAttributes.
optional double transaction_amount_micros = 9;
// Transaction currency code. ISO 4217 three-letter code is used. Required.
optional string currency_code = 10;
// The resource name of conversion action to report conversions to.
// Required.
optional string conversion_action = 11;
// Transaction order id.
// Accessible only to customers on the allow-list.
optional string order_id = 12;
// Store attributes of the transaction.
// Accessible only to customers on the allow-list.
StoreAttribute store_attribute = 6;
// Value of the custom variable for each transaction.
// Accessible only to customers on the allow-list.
optional string custom_value = 13;
// Item attributes of the transaction.
ItemAttribute item_attribute = 14;
}
// Store attributes of the transaction.
message StoreAttribute {
// Store code from
// https://support.google.com/business/answer/3370250#storecode
optional string store_code = 2;
}
// Item attributes of the transaction.
message ItemAttribute {
// A unique identifier of a product. It can be either the Merchant Center Item
// ID or GTIN (Global Trade Item Number).
string item_id = 1;
// ID of the Merchant Center Account.
optional int64 merchant_id = 2;
// Common Locale Data Repository (CLDR) territory code of the country
// associated with the feed where your items are uploaded. See
// https://developers.google.com/google-ads/api/reference/data/codes-formats#country-codes
// for more information.
string country_code = 3;
// ISO 639-1 code of the language associated with the feed where your items
// are uploaded
string language_code = 4;
// The number of items sold. Defaults to 1 if not set.
int64 quantity = 5;
}
// User data holding user identifiers and attributes.
message UserData {
// User identification info. Required.
repeated UserIdentifier user_identifiers = 1;
// Additional transactions/attributes associated with the user.
// Required when updating store sales data.
TransactionAttribute transaction_attribute = 2;
// Additional attributes associated with the user. Required when updating
// customer match attributes. These have an expiration of 540 days.
UserAttribute user_attribute = 3;
}
// User attribute, can only be used with CUSTOMER_MATCH_WITH_ATTRIBUTES job
// type.
message UserAttribute {
// Advertiser defined lifetime value for the user.
optional int64 lifetime_value_micros = 1;
// Advertiser defined lifetime value bucket for the user. The valid range for
// a lifetime value bucket is from 1 (low) to 10 (high), except for remove
// operation where 0 will also be accepted.
optional int32 lifetime_value_bucket = 2;
// Timestamp of the last purchase made by the user.
// The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
// optional timezone offset from UTC. If the offset is absent, the API will
// use the account's timezone as default.
string last_purchase_date_time = 3;
// Advertiser defined average number of purchases that are made by the user in
// a 30 day period.
int32 average_purchase_count = 4;
// Advertiser defined average purchase value in micros for the user.
int64 average_purchase_value_micros = 5;
// Timestamp when the user was acquired.
// The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
// optional timezone offset from UTC. If the offset is absent, the API will
// use the account's timezone as default.
string acquisition_date_time = 6;
}
// Metadata for customer match user list.
message CustomerMatchUserListMetadata {
// The resource name of remarketing list to update data.
// Required for job of CUSTOMER_MATCH_USER_LIST type.
optional string user_list = 2;
}
// Metadata for Store Sales Direct.
message StoreSalesMetadata {
// This is the fraction of all transactions that are identifiable (i.e.,
// associated with any form of customer information).
// Required.
// The fraction needs to be between 0 and 1 (excluding 0).
optional double loyalty_fraction = 5;
// This is the ratio of sales being uploaded compared to the overall sales
// that can be associated with a customer. Required.
// The fraction needs to be between 0 and 1 (excluding 0). For example, if you
// upload half the sales that you are able to associate with a customer, this
// would be 0.5.
optional double transaction_upload_fraction = 6;
// Name of the store sales custom variable key. A predefined key that
// can be applied to the transaction and then later used for custom
// segmentation in reporting.
// Accessible only to customers on the allow-list.
optional string custom_key = 7;
// Metadata for a third party Store Sales upload.
StoreSalesThirdPartyMetadata third_party_metadata = 3;
}
// Metadata for a third party Store Sales.
// This product is only for customers on the allow-list. Please contact your
// Google business development representative for details on the upload
// configuration.
message StoreSalesThirdPartyMetadata {
// Time the advertiser uploaded the data to the partner. Required.
// The format is "YYYY-MM-DD HH:MM:SS".
// Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
optional string advertiser_upload_date_time = 7;
// The fraction of transactions that are valid. Invalid transactions may
// include invalid formats or values.
// Required.
// The fraction needs to be between 0 and 1 (excluding 0).
optional double valid_transaction_fraction = 8;
// The fraction of valid transactions that are matched to a third party
// assigned user ID on the partner side.
// Required.
// The fraction needs to be between 0 and 1 (excluding 0).
optional double partner_match_fraction = 9;
// The fraction of valid transactions that are uploaded by the partner to
// Google.
// Required.
// The fraction needs to be between 0 and 1 (excluding 0).
optional double partner_upload_fraction = 10;
// Version of partner IDs to be used for uploads. Required.
optional string bridge_map_version_id = 11;
// ID of the third party partner updating the transaction feed.
optional int64 partner_id = 12;
}

220
google/ads/googleads/v8/common/policy.proto
View file

@ -1,220 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/enums/policy_topic_entry_type.proto";
import "google/ads/googleads/v8/enums/policy_topic_evidence_destination_mismatch_url_type.proto";
import "google/ads/googleads/v8/enums/policy_topic_evidence_destination_not_working_device.proto";
import "google/ads/googleads/v8/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "PolicyProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing policy information.
// 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.
optional string policy_name = 3;
// 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.
optional string violating_text = 4;
}
// Parameter for controlling how policy exemption is done.
message PolicyValidationParameter {
// The list of policy topics that should not cause a PolicyFindingError to
// be reported. This field is currently only compatible with Enhanced Text Ad.
// It corresponds to the PolicyTopicEntry.topic field.
//
// Resources violating these policies will be saved, but will not be eligible
// to serve. They may begin serving at a later time due to a change in
// policies, re-review of the resource, or a change in advertiser
// certificates.
repeated string ignorable_policy_topics = 3;
// The list of policy violation keys that should not cause a
// PolicyViolationError to be reported. Not all policy violations are
// exemptable, please refer to the is_exemptible field in the returned
// PolicyViolationError.
//
// Resources violating these polices will be saved, but will not be eligible
// to serve. They may begin serving at a later time due to a change in
// policies, re-review of the resource, or a change in advertiser
// certificates.
repeated PolicyViolationKey exempt_policy_violation_keys = 2;
}
// Policy finding attached to a resource (e.g. alcohol policy associated with
// a site that sells alcohol).
//
// Each PolicyTopicEntry has a topic that indicates the specific ads policy
// the entry is about and a type to indicate the effect that the entry will have
// on serving. It may optionally have one or more evidences that indicate the
// reason for the finding. It may also optionally have one or more constraints
// that provide details about how serving may be restricted.
message PolicyTopicEntry {
// Policy topic this finding refers to. For example, "ALCOHOL",
// "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible
// policy topics is not fixed for a particular API version and may change
// at any time.
optional string topic = 5;
// Describes the negative or positive effect this policy will have on serving.
google.ads.googleads.v8.enums.PolicyTopicEntryTypeEnum.PolicyTopicEntryType type = 2;
// Additional information that explains policy finding
// (e.g. the brand name for a trademark finding).
repeated PolicyTopicEvidence evidences = 3;
// Indicates how serving of this resource may be affected (e.g. not serving
// in a country).
repeated PolicyTopicConstraint constraints = 4;
}
// Additional information that explains a policy finding.
message PolicyTopicEvidence {
// A list of fragments of text that violated a policy.
message TextList {
// The fragments of text from the resource that caused the policy finding.
repeated string texts = 2;
}
// A list of websites that caused a policy finding. Used for
// ONE_WEBSITE_PER_AD_GROUP policy topic, for example. In case there are more
// than five websites, only the top five (those that appear in resources the
// most) will be listed here.
message WebsiteList {
// Websites that caused the policy finding.
repeated string websites = 2;
}
// A list of strings found in a destination page that caused a policy
// finding.
message DestinationTextList {
// List of text found in the resource's destination page.
repeated string destination_texts = 2;
}
// Evidence of mismatches between the URLs of a resource.
message DestinationMismatch {
// The set of URLs that did not match each other.
repeated google.ads.googleads.v8.enums.PolicyTopicEvidenceDestinationMismatchUrlTypeEnum.PolicyTopicEvidenceDestinationMismatchUrlType url_types = 1;
}
// Evidence details when the destination is returning an HTTP error
// code or isn't functional in all locations for commonly used devices.
message DestinationNotWorking {
// The full URL that didn't work.
optional string expanded_url = 7;
// The type of device that failed to load the URL.
google.ads.googleads.v8.enums.PolicyTopicEvidenceDestinationNotWorkingDeviceEnum.PolicyTopicEvidenceDestinationNotWorkingDevice device = 4;
// The time the URL was last checked.
// The format is "YYYY-MM-DD HH:MM:SS".
// Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
optional string last_checked_date_time = 8;
// Indicates the reason of the DESTINATION_NOT_WORKING policy finding.
oneof reason {
// The type of DNS error.
google.ads.googleads.v8.enums.PolicyTopicEvidenceDestinationNotWorkingDnsErrorTypeEnum.PolicyTopicEvidenceDestinationNotWorkingDnsErrorType dns_error_type = 1;
// The HTTP error code.
int64 http_error_code = 6;
}
}
// Specific evidence information depending on the evidence type.
oneof value {
// List of websites linked with this resource.
WebsiteList website_list = 3;
// List of evidence found in the text of a resource.
TextList text_list = 4;
// The language the resource was detected to be written in.
// This is an IETF language tag such as "en-US".
string language_code = 9;
// The text in the destination of the resource that is causing a policy
// finding.
DestinationTextList destination_text_list = 6;
// Mismatch between the destinations of a resource's URLs.
DestinationMismatch destination_mismatch = 7;
// Details when the destination is returning an HTTP error code or isn't
// functional in all locations for commonly used devices.
DestinationNotWorking destination_not_working = 8;
}
}
// Describes the effect on serving that a policy topic entry will have.
message PolicyTopicConstraint {
// A list of countries where a resource's serving is constrained.
message CountryConstraintList {
// Total number of countries targeted by the resource.
optional int32 total_targeted_countries = 3;
// Countries in which serving is restricted.
repeated CountryConstraint countries = 2;
}
// Indicates that a policy topic was constrained due to disapproval of the
// website for reseller purposes.
message ResellerConstraint {
}
// Indicates that a resource's ability to serve in a particular country is
// constrained.
message CountryConstraint {
// Geo target constant resource name of the country in which serving is
// constrained.
optional string country_criterion = 2;
}
// Specific information about the constraint.
oneof value {
// Countries where the resource cannot serve.
CountryConstraintList country_constraint_list = 1;
// Reseller constraint.
ResellerConstraint reseller_constraint = 2;
// Countries where a certificate is required for serving.
CountryConstraintList certificate_missing_in_country_list = 3;
// Countries where the resource's domain is not covered by the
// certificates associated with it.
CountryConstraintList certificate_domain_mismatch_in_country_list = 4;
}
}

37
google/ads/googleads/v8/common/real_time_bidding_setting.proto
View file

@ -1,37 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "RealTimeBiddingSettingProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing RealTimeBiddingSetting
// Settings for Real-Time Bidding, a feature only available for campaigns
// targeting the Ad Exchange network.
message RealTimeBiddingSetting {
// Whether the campaign is opted in to real-time bidding.
optional bool opt_in = 2;
}

369
google/ads/googleads/v8/common/segments.proto
View file

@ -1,369 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/common/criteria.proto";
import "google/ads/googleads/v8/enums/ad_destination_type.proto";
import "google/ads/googleads/v8/enums/ad_network_type.proto";
import "google/ads/googleads/v8/enums/budget_campaign_association_status.proto";
import "google/ads/googleads/v8/enums/click_type.proto";
import "google/ads/googleads/v8/enums/conversion_action_category.proto";
import "google/ads/googleads/v8/enums/conversion_attribution_event_type.proto";
import "google/ads/googleads/v8/enums/conversion_lag_bucket.proto";
import "google/ads/googleads/v8/enums/conversion_or_adjustment_lag_bucket.proto";
import "google/ads/googleads/v8/enums/conversion_value_rule_primary_dimension.proto";
import "google/ads/googleads/v8/enums/day_of_week.proto";
import "google/ads/googleads/v8/enums/device.proto";
import "google/ads/googleads/v8/enums/external_conversion_source.proto";
import "google/ads/googleads/v8/enums/hotel_date_selection_type.proto";
import "google/ads/googleads/v8/enums/hotel_price_bucket.proto";
import "google/ads/googleads/v8/enums/hotel_rate_type.proto";
import "google/ads/googleads/v8/enums/month_of_year.proto";
import "google/ads/googleads/v8/enums/placeholder_type.proto";
import "google/ads/googleads/v8/enums/product_channel.proto";
import "google/ads/googleads/v8/enums/product_channel_exclusivity.proto";
import "google/ads/googleads/v8/enums/product_condition.proto";
import "google/ads/googleads/v8/enums/recommendation_type.proto";
import "google/ads/googleads/v8/enums/search_engine_results_page_type.proto";
import "google/ads/googleads/v8/enums/search_term_match_type.proto";
import "google/ads/googleads/v8/enums/slot.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "SegmentsProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing segment only fields.
// Segment only fields.
message Segments {
// Ad Destination type.
google.ads.googleads.v8.enums.AdDestinationTypeEnum.AdDestinationType ad_destination_type = 136;
// Ad network type.
google.ads.googleads.v8.enums.AdNetworkTypeEnum.AdNetworkType ad_network_type = 3;
// Budget campaign association status.
BudgetCampaignAssociationStatus budget_campaign_association_status = 134;
// Click type.
google.ads.googleads.v8.enums.ClickTypeEnum.ClickType click_type = 26;
// Resource name of the conversion action.
optional string conversion_action = 113;
// Conversion action category.
google.ads.googleads.v8.enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_category = 53;
// Conversion action name.
optional string conversion_action_name = 114;
// This segments your conversion columns by the original conversion and
// conversion value vs. the delta if conversions were adjusted. False row has
// the data as originally stated; While true row has the delta between data
// now and the data as originally stated. Summing the two together results
// post-adjustment data.
optional bool conversion_adjustment = 115;
// Conversion attribution event type.
google.ads.googleads.v8.enums.ConversionAttributionEventTypeEnum.ConversionAttributionEventType conversion_attribution_event_type = 2;
// An enum value representing the number of days between the impression and
// the conversion.
google.ads.googleads.v8.enums.ConversionLagBucketEnum.ConversionLagBucket conversion_lag_bucket = 50;
// An enum value representing the number of days between the impression and
// the conversion or between the impression and adjustments to the conversion.
google.ads.googleads.v8.enums.ConversionOrAdjustmentLagBucketEnum.ConversionOrAdjustmentLagBucket conversion_or_adjustment_lag_bucket = 51;
// Date to which metrics apply.
// yyyy-MM-dd format, e.g., 2018-04-17.
optional string date = 79;
// Day of the week, e.g., MONDAY.
google.ads.googleads.v8.enums.DayOfWeekEnum.DayOfWeek day_of_week = 5;
// Device to which metrics apply.
google.ads.googleads.v8.enums.DeviceEnum.Device device = 1;
// External conversion source.
google.ads.googleads.v8.enums.ExternalConversionSourceEnum.ExternalConversionSource external_conversion_source = 55;
// Resource name of the geo target constant that represents an airport.
optional string geo_target_airport = 116;
// Resource name of the geo target constant that represents a canton.
optional string geo_target_canton = 117;
// Resource name of the geo target constant that represents a city.
optional string geo_target_city = 118;
// Resource name of the geo target constant that represents a country.
optional string geo_target_country = 119;
// Resource name of the geo target constant that represents a county.
optional string geo_target_county = 120;
// Resource name of the geo target constant that represents a district.
optional string geo_target_district = 121;
// Resource name of the geo target constant that represents a metro.
optional string geo_target_metro = 122;
// Resource name of the geo target constant that represents the most
// specific location.
optional string geo_target_most_specific_location = 123;
// Resource name of the geo target constant that represents a postal code.
optional string geo_target_postal_code = 124;
// Resource name of the geo target constant that represents a province.
optional string geo_target_province = 125;
// Resource name of the geo target constant that represents a region.
optional string geo_target_region = 126;
// Resource name of the geo target constant that represents a state.
optional string geo_target_state = 127;
// Hotel booking window in days.
optional int64 hotel_booking_window_days = 135;
// Hotel center ID.
optional int64 hotel_center_id = 80;
// Hotel check-in date. Formatted as yyyy-MM-dd.
optional string hotel_check_in_date = 81;
// Hotel check-in day of week.
google.ads.googleads.v8.enums.DayOfWeekEnum.DayOfWeek hotel_check_in_day_of_week = 9;
// Hotel city.
optional string hotel_city = 82;
// Hotel class.
optional int32 hotel_class = 83;
// Hotel country.
optional string hotel_country = 84;
// Hotel date selection type.
google.ads.googleads.v8.enums.HotelDateSelectionTypeEnum.HotelDateSelectionType hotel_date_selection_type = 13;
// Hotel length of stay.
optional int32 hotel_length_of_stay = 85;
// Hotel rate rule ID.
optional string hotel_rate_rule_id = 86;
// Hotel rate type.
google.ads.googleads.v8.enums.HotelRateTypeEnum.HotelRateType hotel_rate_type = 74;
// Hotel price bucket.
google.ads.googleads.v8.enums.HotelPriceBucketEnum.HotelPriceBucket hotel_price_bucket = 78;
// Hotel state.
optional string hotel_state = 87;
// Hour of day as a number between 0 and 23, inclusive.
optional int32 hour = 88;
// Only used with feed item metrics.
// Indicates whether the interaction metrics occurred on the feed item itself
// or a different extension or ad unit.
optional bool interaction_on_this_extension = 89;
// Keyword criterion.
Keyword keyword = 61;
// Month as represented by the date of the first day of a month. Formatted as
// yyyy-MM-dd.
optional string month = 90;
// Month of the year, e.g., January.
google.ads.googleads.v8.enums.MonthOfYearEnum.MonthOfYear month_of_year = 18;
// Partner hotel ID.
optional string partner_hotel_id = 91;
// Placeholder type. This is only used with feed item metrics.
google.ads.googleads.v8.enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 20;
// Aggregator ID of the product.
optional int64 product_aggregator_id = 132;
// Bidding category (level 1) of the product.
optional string product_bidding_category_level1 = 92;
// Bidding category (level 2) of the product.
optional string product_bidding_category_level2 = 93;
// Bidding category (level 3) of the product.
optional string product_bidding_category_level3 = 94;
// Bidding category (level 4) of the product.
optional string product_bidding_category_level4 = 95;
// Bidding category (level 5) of the product.
optional string product_bidding_category_level5 = 96;
// Brand of the product.
optional string product_brand = 97;
// Channel of the product.
google.ads.googleads.v8.enums.ProductChannelEnum.ProductChannel product_channel = 30;
// Channel exclusivity of the product.
google.ads.googleads.v8.enums.ProductChannelExclusivityEnum.ProductChannelExclusivity product_channel_exclusivity = 31;
// Condition of the product.
google.ads.googleads.v8.enums.ProductConditionEnum.ProductCondition product_condition = 32;
// Resource name of the geo target constant for the country of sale of the
// product.
optional string product_country = 98;
// Custom attribute 0 of the product.
optional string product_custom_attribute0 = 99;
// Custom attribute 1 of the product.
optional string product_custom_attribute1 = 100;
// Custom attribute 2 of the product.
optional string product_custom_attribute2 = 101;
// Custom attribute 3 of the product.
optional string product_custom_attribute3 = 102;
// Custom attribute 4 of the product.
optional string product_custom_attribute4 = 103;
// Item ID of the product.
optional string product_item_id = 104;
// Resource name of the language constant for the language of the product.
optional string product_language = 105;
// Merchant ID of the product.
optional int64 product_merchant_id = 133;
// Store ID of the product.
optional string product_store_id = 106;
// Title of the product.
optional string product_title = 107;
// Type (level 1) of the product.
optional string product_type_l1 = 108;
// Type (level 2) of the product.
optional string product_type_l2 = 109;
// Type (level 3) of the product.
optional string product_type_l3 = 110;
// Type (level 4) of the product.
optional string product_type_l4 = 111;
// Type (level 5) of the product.
optional string product_type_l5 = 112;
// Quarter as represented by the date of the first day of a quarter.
// Uses the calendar year for quarters, e.g., the second quarter of 2018
// starts on 2018-04-01. Formatted as yyyy-MM-dd.
optional string quarter = 128;
// Recommendation type.
google.ads.googleads.v8.enums.RecommendationTypeEnum.RecommendationType recommendation_type = 140;
// Type of the search engine results page.
google.ads.googleads.v8.enums.SearchEngineResultsPageTypeEnum.SearchEngineResultsPageType search_engine_results_page_type = 70;
// Match type of the keyword that triggered the ad, including variants.
google.ads.googleads.v8.enums.SearchTermMatchTypeEnum.SearchTermMatchType search_term_match_type = 22;
// Position of the ad.
google.ads.googleads.v8.enums.SlotEnum.Slot slot = 23;
// Primary dimension of applied conversion value rules.
// NO_RULE_APPLIED shows the total recorded value of conversions that
// do not have a value rule applied.
// ORIGINAL shows the original value of conversions to which a value rule
// has been applied.
// GEO_LOCATION, DEVICE, AUDIENCE show the net adjustment after value
// rules were applied.
google.ads.googleads.v8.enums.ConversionValueRulePrimaryDimensionEnum.ConversionValueRulePrimaryDimension conversion_value_rule_primary_dimension = 138;
// Resource name of the ad group criterion that represents webpage criterion.
optional string webpage = 129;
// Week as defined as Monday through Sunday, and represented by the date of
// Monday. Formatted as yyyy-MM-dd.
optional string week = 130;
// Year, formatted as yyyy.
optional int32 year = 131;
// iOS Store Kit Ad Network conversion value.
// Null value means this segment is not applicable, e.g. non-iOS campaign.
optional int64 sk_ad_network_conversion_value = 137;
// Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics.
// Indicates whether the interaction metrics occurred on the asset itself
// or a different asset or ad unit.
// Interactions (e.g. clicks) are counted across all the parts of the served
// ad (e.g. Ad itself and other components like Sitelinks) when they are
// served together. When interaction_on_this_asset is true, it means the
// interactions are on this specific asset and when interaction_on_this_asset
// is false, it means the interactions is not on this specific asset but on
// other parts of the served ad this asset is served with.
optional AssetInteractionTarget asset_interaction_target = 139;
}
// A Keyword criterion segment.
message Keyword {
// The AdGroupCriterion resource name.
optional string ad_group_criterion = 3;
// Keyword info.
KeywordInfo info = 2;
}
// A BudgetCampaignAssociationStatus segment.
message BudgetCampaignAssociationStatus {
// The campaign resource name.
optional string campaign = 1;
// Budget campaign association status.
google.ads.googleads.v8.enums.BudgetCampaignAssociationStatusEnum.BudgetCampaignAssociationStatus status = 2;
}
// An AssetInteractionTarget segment.
message AssetInteractionTarget {
// The asset resource name.
string asset = 1;
// Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics.
// Indicates whether the interaction metrics occurred on the asset itself or a
// different asset or ad unit.
bool interaction_on_this_asset = 2;
}

358
google/ads/googleads/v8/common/simulation.proto
View file

@ -1,358 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "SimulationProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing simulation points.
// A container for simulation points for simulations of type BID_MODIFIER.
message BidModifierSimulationPointList {
// Projected metrics for a series of bid modifier amounts.
repeated BidModifierSimulationPoint points = 1;
}
// A container for simulation points for simulations of type CPC_BID.
message CpcBidSimulationPointList {
// Projected metrics for a series of CPC bid amounts.
repeated CpcBidSimulationPoint points = 1;
}
// A container for simulation points for simulations of type CPV_BID.
message CpvBidSimulationPointList {
// Projected metrics for a series of CPV bid amounts.
repeated CpvBidSimulationPoint points = 1;
}
// A container for simulation points for simulations of type TARGET_CPA.
message TargetCpaSimulationPointList {
// Projected metrics for a series of target CPA amounts.
repeated TargetCpaSimulationPoint points = 1;
}
// A container for simulation points for simulations of type TARGET_ROAS.
message TargetRoasSimulationPointList {
// Projected metrics for a series of target ROAS amounts.
repeated TargetRoasSimulationPoint points = 1;
}
// A container for simulation points for simulations of type PERCENT_CPC_BID.
message PercentCpcBidSimulationPointList {
// Projected metrics for a series of percent CPC bid amounts.
repeated PercentCpcBidSimulationPoint points = 1;
}
// A container for simulation points for simulations of type BUDGET.
message BudgetSimulationPointList {
// Projected metrics for a series of budget amounts.
repeated BudgetSimulationPoint points = 1;
}
// A container for simulation points for simulations of type
// TARGET_IMPRESSION_SHARE.
message TargetImpressionShareSimulationPointList {
// Projected metrics for a specific target impression share value.
repeated TargetImpressionShareSimulationPoint points = 1;
}
// Projected metrics for a specific bid modifier amount.
message BidModifierSimulationPoint {
// The simulated bid modifier upon which projected metrics are based.
optional double bid_modifier = 15;
// Projected number of biddable conversions.
// Only search advertising channel type supports this field.
optional double biddable_conversions = 16;
// Projected total value of biddable conversions.
// Only search advertising channel type supports this field.
optional double biddable_conversions_value = 17;
// Projected number of clicks.
optional int64 clicks = 18;
// Projected cost in micros.
optional int64 cost_micros = 19;
// Projected number of impressions.
optional int64 impressions = 20;
// Projected number of top slot impressions.
// Only search advertising channel type supports this field.
optional int64 top_slot_impressions = 21;
// Projected number of biddable conversions for the parent resource.
// Only search advertising channel type supports this field.
optional double parent_biddable_conversions = 22;
// Projected total value of biddable conversions for the parent resource.
// Only search advertising channel type supports this field.
optional double parent_biddable_conversions_value = 23;
// Projected number of clicks for the parent resource.
optional int64 parent_clicks = 24;
// Projected cost in micros for the parent resource.
optional int64 parent_cost_micros = 25;
// Projected number of impressions for the parent resource.
optional int64 parent_impressions = 26;
// Projected number of top slot impressions for the parent resource.
// Only search advertising channel type supports this field.
optional int64 parent_top_slot_impressions = 27;
// Projected minimum daily budget that must be available to the parent
// resource to realize this simulation.
optional int64 parent_required_budget_micros = 28;
}
// Projected metrics for a specific CPC bid amount.
message CpcBidSimulationPoint {
// Projected required daily budget that the advertiser must set in order to
// receive the estimated traffic, in micros of advertiser currency.
int64 required_budget_amount_micros = 17;
// Projected number of biddable conversions.
optional double biddable_conversions = 9;
// Projected total value of biddable conversions.
optional double biddable_conversions_value = 10;
// Projected number of clicks.
optional int64 clicks = 11;
// Projected cost in micros.
optional int64 cost_micros = 12;
// Projected number of impressions.
optional int64 impressions = 13;
// Projected number of top slot impressions.
// Only search advertising channel type supports this field.
optional int64 top_slot_impressions = 14;
// When SimulationModificationMethod = UNIFORM or DEFAULT,
// cpc_bid_micros is set.
// When SimulationModificationMethod = SCALING,
// cpc_bid_scaling_modifier is set.
oneof cpc_simulation_key_value {
// The simulated CPC bid upon which projected metrics are based.
int64 cpc_bid_micros = 15;
// The simulated scaling modifier upon which projected metrics are based.
// All CPC bids relevant to the simulated entity are scaled by this
// modifier.
double cpc_bid_scaling_modifier = 16;
}
}
// Projected metrics for a specific CPV bid amount.
message CpvBidSimulationPoint {
// The simulated CPV bid upon which projected metrics are based.
optional int64 cpv_bid_micros = 5;
// Projected cost in micros.
optional int64 cost_micros = 6;
// Projected number of impressions.
optional int64 impressions = 7;
// Projected number of views.
optional int64 views = 8;
}
// Projected metrics for a specific target CPA amount.
message TargetCpaSimulationPoint {
// Projected required daily budget that the advertiser must set in order to
// receive the estimated traffic, in micros of advertiser currency.
int64 required_budget_amount_micros = 19;
// Projected number of biddable conversions.
optional double biddable_conversions = 9;
// Projected total value of biddable conversions.
optional double biddable_conversions_value = 10;
// Projected number of app installs.
double app_installs = 15;
// Projected number of in-app actions.
double in_app_actions = 16;
// Projected number of clicks.
optional int64 clicks = 11;
// Projected cost in micros.
optional int64 cost_micros = 12;
// Projected number of impressions.
optional int64 impressions = 13;
// Projected number of top slot impressions.
// Only search advertising channel type supports this field.
optional int64 top_slot_impressions = 14;
// When SimulationModificationMethod = UNIFORM or DEFAULT,
// target_cpa_micros is set.
// When SimulationModificationMethod = SCALING,
// target_cpa_scaling_modifier is set.
oneof target_cpa_simulation_key_value {
// The simulated target CPA upon which projected metrics are based.
int64 target_cpa_micros = 17;
// The simulated scaling modifier upon which projected metrics are based.
// All CPA targets relevant to the simulated entity are scaled by this
// modifier.
double target_cpa_scaling_modifier = 18;
}
}
// Projected metrics for a specific target ROAS amount.
message TargetRoasSimulationPoint {
// The simulated target ROAS upon which projected metrics are based.
optional double target_roas = 8;
// Projected required daily budget that the advertiser must set in order to
// receive the estimated traffic, in micros of advertiser currency.
int64 required_budget_amount_micros = 15;
// Projected number of biddable conversions.
optional double biddable_conversions = 9;
// Projected total value of biddable conversions.
optional double biddable_conversions_value = 10;
// Projected number of clicks.
optional int64 clicks = 11;
// Projected cost in micros.
optional int64 cost_micros = 12;
// Projected number of impressions.
optional int64 impressions = 13;
// Projected number of top slot impressions.
// Only Search advertising channel type supports this field.
optional int64 top_slot_impressions = 14;
}
// Projected metrics for a specific percent CPC amount. Only Hotel advertising
// channel type supports this field.
message PercentCpcBidSimulationPoint {
// The simulated percent CPC upon which projected metrics are based. Percent
// CPC expressed as fraction of the advertised price for some good or service.
// The value stored here is 1,000,000 * [fraction].
optional int64 percent_cpc_bid_micros = 1;
// Projected number of biddable conversions.
optional double biddable_conversions = 2;
// Projected total value of biddable conversions in local currency.
optional double biddable_conversions_value = 3;
// Projected number of clicks.
optional int64 clicks = 4;
// Projected cost in micros.
optional int64 cost_micros = 5;
// Projected number of impressions.
optional int64 impressions = 6;
// Projected number of top slot impressions.
optional int64 top_slot_impressions = 7;
}
// Projected metrics for a specific budget amount.
message BudgetSimulationPoint {
// The simulated budget upon which projected metrics are based.
int64 budget_amount_micros = 1;
// Projected required daily cpc bid ceiling that the advertiser must set to
// realize this simulation, in micros of the advertiser currency.
// Only campaigns with the Target Spend bidding strategy support this field.
int64 required_cpc_bid_ceiling_micros = 2;
// Projected number of biddable conversions.
double biddable_conversions = 3;
// Projected total value of biddable conversions.
double biddable_conversions_value = 4;
// Projected number of clicks.
int64 clicks = 5;
// Projected cost in micros.
int64 cost_micros = 6;
// Projected number of impressions.
int64 impressions = 7;
// Projected number of top slot impressions.
// Only search advertising channel type supports this field.
int64 top_slot_impressions = 8;
}
// Projected metrics for a specific target impression share value.
message TargetImpressionShareSimulationPoint {
// The simulated target impression share value (in micros) upon which
// projected metrics are based.
// E.g. 10% impression share, which is equal to 0.1, is stored as 100_000.
// This value is validated and will not exceed 1M (100%).
int64 target_impression_share_micros = 1;
// Projected required daily cpc bid ceiling that the advertiser must set to
// realize this simulation, in micros of the advertiser currency.
int64 required_cpc_bid_ceiling_micros = 2;
// Projected required daily budget that the advertiser must set in order to
// receive the estimated traffic, in micros of advertiser currency.
int64 required_budget_amount_micros = 3;
// Projected number of biddable conversions.
double biddable_conversions = 4;
// Projected total value of biddable conversions.
double biddable_conversions_value = 5;
// Projected number of clicks.
int64 clicks = 6;
// Projected cost in micros.
int64 cost_micros = 7;
// Projected number of impressions.
int64 impressions = 8;
// Projected number of top slot impressions.
// Only search advertising channel type supports this field.
int64 top_slot_impressions = 9;
// Projected number of absolute top impressions.
// Only search advertising channel type supports this field.
int64 absolute_top_impressions = 10;
}

50
google/ads/googleads/v8/common/tag_snippet.proto
View file

@ -1,50 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/enums/tracking_code_page_format.proto";
import "google/ads/googleads/v8/enums/tracking_code_type.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "TagSnippetProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing TagSnippet
// The site tag and event snippet pair for a TrackingCodeType.
message TagSnippet {
// The type of the generated tag snippets for tracking conversions.
google.ads.googleads.v8.enums.TrackingCodeTypeEnum.TrackingCodeType type = 1;
// The format of the web page where the tracking tag and snippet will be
// installed, e.g. HTML.
google.ads.googleads.v8.enums.TrackingCodePageFormatEnum.TrackingCodePageFormat page_format = 2;
// The site tag that adds visitors to your basic remarketing lists and sets
// new cookies on your domain.
optional string global_site_tag = 5;
// The event snippet that works with the site tag to track actions that
// should be counted as conversions.
optional string event_snippet = 6;
}

85
google/ads/googleads/v8/common/targeting_setting.proto
View file

@ -1,85 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/enums/targeting_dimension.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "TargetingSettingProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing TargetingSetting
// Settings for the targeting-related features, at the campaign and ad group
// levels. For more details about the targeting setting, visit
// https://support.google.com/google-ads/answer/7365594
message TargetingSetting {
// The per-targeting-dimension setting to restrict the reach of your campaign
// or ad group.
repeated TargetRestriction target_restrictions = 1;
// The list of operations changing the target restrictions.
//
// Adding a target restriction with a targeting dimension that already exists
// causes the existing target restriction to be replaced with the new value.
repeated TargetRestrictionOperation target_restriction_operations = 2;
}
// The list of per-targeting-dimension targeting settings.
message TargetRestriction {
// The targeting dimension that these settings apply to.
google.ads.googleads.v8.enums.TargetingDimensionEnum.TargetingDimension targeting_dimension = 1;
// Indicates whether to restrict your ads to show only for the criteria you
// have selected for this targeting_dimension, or to target all values for
// this targeting_dimension and show ads based on your targeting in other
// TargetingDimensions. A value of `true` means that these criteria will only
// apply bid modifiers, and not affect targeting. A value of `false` means
// that these criteria will restrict targeting as well as applying bid
// modifiers.
optional bool bid_only = 3;
}
// Operation to be performed on a target restriction list in a mutate.
message TargetRestrictionOperation {
// The operator.
enum Operator {
// Unspecified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Add the restriction to the existing restrictions.
ADD = 2;
// Remove the restriction from the existing restrictions.
REMOVE = 3;
}
// Type of list operation to perform.
Operator operator = 1;
// The target restriction being added to or removed from the list.
TargetRestriction value = 2;
}

40
google/ads/googleads/v8/common/text_label.proto
View file

@ -1,40 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "TextLabelProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// A type of label displaying text on a colored background.
message TextLabel {
// Background color of the label in RGB format. This string must match the
// regular expression '^\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'.
// Note: The background color may not be visible for manager accounts.
optional string background_color = 3;
// A short description of the label. The length must be no more than 200
// characters.
optional string description = 4;
}

45
google/ads/googleads/v8/common/url_collection.proto
View file

@ -1,45 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "UrlCollectionProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file UrlCollection type.
// Collection of urls that is tagged with a unique identifier.
message UrlCollection {
// Unique identifier for this UrlCollection instance.
optional string url_collection_id = 5;
// A list of possible final URLs.
repeated string final_urls = 6;
// A list of possible final mobile URLs.
repeated string final_mobile_urls = 7;
// URL template for constructing a tracking URL.
optional string tracking_url_template = 8;
}

291
google/ads/googleads/v8/common/user_lists.proto
View file

@ -1,291 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/ads/googleads/v8/enums/customer_match_upload_key_type.proto";
import "google/ads/googleads/v8/enums/user_list_combined_rule_operator.proto";
import "google/ads/googleads/v8/enums/user_list_crm_data_source_type.proto";
import "google/ads/googleads/v8/enums/user_list_date_rule_item_operator.proto";
import "google/ads/googleads/v8/enums/user_list_logical_rule_operator.proto";
import "google/ads/googleads/v8/enums/user_list_number_rule_item_operator.proto";
import "google/ads/googleads/v8/enums/user_list_prepopulation_status.proto";
import "google/ads/googleads/v8/enums/user_list_rule_type.proto";
import "google/ads/googleads/v8/enums/user_list_string_rule_item_operator.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "UserListsProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing user list types.
// SimilarUserList is a list of users which are similar to users from another
// UserList. These lists are read-only and automatically created by Google.
message SimilarUserListInfo {
// Seed UserList from which this list is derived.
optional string seed_user_list = 2;
}
// UserList of CRM users provided by the advertiser.
message CrmBasedUserListInfo {
// A string that uniquely identifies a mobile application from which the data
// was collected.
// For iOS, the ID string is the 9 digit string that appears at the end of an
// App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is
// http://itunes.apple.com/us/app/flood-it!-2/id476943146).
// For Android, the ID string is the application's package name
// (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link
// https://play.google.com/store/apps/details?id=com.labpixies.colordrips).
// Required when creating CrmBasedUserList for uploading mobile advertising
// IDs.
optional string app_id = 4;
// Matching key type of the list.
// Mixed data types are not allowed on the same list.
// This field is required for an ADD operation.
google.ads.googleads.v8.enums.CustomerMatchUploadKeyTypeEnum.CustomerMatchUploadKeyType upload_key_type = 2;
// Data source of the list. Default value is FIRST_PARTY.
// Only customers on the allow-list can create third-party sourced CRM lists.
google.ads.googleads.v8.enums.UserListCrmDataSourceTypeEnum.UserListCrmDataSourceType data_source_type = 3;
}
// A client defined rule based on custom parameters sent by web sites or
// uploaded by the advertiser.
message UserListRuleInfo {
// Rule type is used to determine how to group rule items.
//
// The default is OR of ANDs (disjunctive normal form).
// That is, rule items will be ANDed together within rule item groups and the
// groups themselves will be ORed together.
//
// Currently AND of ORs (conjunctive normal form) is only supported for
// ExpressionRuleUserList.
google.ads.googleads.v8.enums.UserListRuleTypeEnum.UserListRuleType rule_type = 1;
// List of rule item groups that defines this rule.
// Rule item groups are grouped together based on rule_type.
repeated UserListRuleItemGroupInfo rule_item_groups = 2;
}
// A group of rule items.
message UserListRuleItemGroupInfo {
// Rule items that will be grouped together based on rule_type.
repeated UserListRuleItemInfo rule_items = 1;
}
// An atomic rule item.
message UserListRuleItemInfo {
// Rule variable name. It should match the corresponding key name fired
// by the pixel.
// A name must begin with US-ascii letters or underscore or UTF8 code that is
// greater than 127 and consist of US-ascii letters or digits or underscore or
// UTF8 code that is greater than 127.
// For websites, there are two built-in variable URL (name = 'url__') and
// referrer URL (name = 'ref_url__').
// This field must be populated when creating a new rule item.
optional string name = 5;
// An atomic rule item.
oneof rule_item {
// An atomic rule item composed of a number operation.
UserListNumberRuleItemInfo number_rule_item = 2;
// An atomic rule item composed of a string operation.
UserListStringRuleItemInfo string_rule_item = 3;
// An atomic rule item composed of a date operation.
UserListDateRuleItemInfo date_rule_item = 4;
}
}
// A rule item composed of a date operation.
message UserListDateRuleItemInfo {
// Date comparison operator.
// This field is required and must be populated when creating new date
// rule item.
google.ads.googleads.v8.enums.UserListDateRuleItemOperatorEnum.UserListDateRuleItemOperator operator = 1;
// String representing date value to be compared with the rule variable.
// Supported date format is YYYY-MM-DD.
// Times are reported in the customer's time zone.
optional string value = 4;
// The relative date value of the right hand side denoted by number of days
// offset from now. The value field will override this field when both are
// present.
optional int64 offset_in_days = 5;
}
// A rule item composed of a number operation.
message UserListNumberRuleItemInfo {
// Number comparison operator.
// This field is required and must be populated when creating a new number
// rule item.
google.ads.googleads.v8.enums.UserListNumberRuleItemOperatorEnum.UserListNumberRuleItemOperator operator = 1;
// Number value to be compared with the variable.
// This field is required and must be populated when creating a new number
// rule item.
optional double value = 3;
}
// A rule item composed of a string operation.
message UserListStringRuleItemInfo {
// String comparison operator.
// This field is required and must be populated when creating a new string
// rule item.
google.ads.googleads.v8.enums.UserListStringRuleItemOperatorEnum.UserListStringRuleItemOperator operator = 1;
// The right hand side of the string rule item. For URLs or referrer URLs,
// the value can not contain illegal URL chars such as newlines, quotes,
// tabs, or parentheses. This field is required and must be populated when
// creating a new string rule item.
optional string value = 3;
}
// User lists defined by combining two rules, left operand and right operand.
// There are two operators: AND where left operand and right operand have to be
// true; AND_NOT where left operand is true but right operand is false.
message CombinedRuleUserListInfo {
// Left operand of the combined rule.
// This field is required and must be populated when creating new combined
// rule based user list.
UserListRuleInfo left_operand = 1;
// Right operand of the combined rule.
// This field is required and must be populated when creating new combined
// rule based user list.
UserListRuleInfo right_operand = 2;
// Operator to connect the two operands.
//
// Required for creating a combined rule user list.
google.ads.googleads.v8.enums.UserListCombinedRuleOperatorEnum.UserListCombinedRuleOperator rule_operator = 3;
}
// Visitors of a page during specific dates.
message DateSpecificRuleUserListInfo {
// Boolean rule that defines visitor of a page.
//
// Required for creating a date specific rule user list.
UserListRuleInfo rule = 1;
// Start date of users visit. If set to 2000-01-01, then the list includes all
// users before end_date. The date's format should be YYYY-MM-DD.
//
// Required for creating a data specific rule user list.
optional string start_date = 4;
// Last date of users visit. If set to 2037-12-30, then the list includes all
// users after start_date. The date's format should be YYYY-MM-DD.
//
// Required for creating a data specific rule user list.
optional string end_date = 5;
}
// Visitors of a page. The page visit is defined by one boolean rule expression.
message ExpressionRuleUserListInfo {
// Boolean rule that defines this user list. The rule consists of a list of
// rule item groups and each rule item group consists of a list of rule items.
// All the rule item groups are ORed or ANDed together for evaluation based on
// rule.rule_type.
//
// Required for creating an expression rule user list.
UserListRuleInfo rule = 1;
}
// Representation of a userlist that is generated by a rule.
message RuleBasedUserListInfo {
// The status of pre-population. The field is default to NONE if not set which
// means the previous users will not be considered. If set to REQUESTED, past
// site visitors or app users who match the list definition will be included
// in the list (works on the Display Network only). This will only
// add past users from within the last 30 days, depending on the
// list's membership duration and the date when the remarketing tag is added.
// The status will be updated to FINISHED once request is processed, or FAILED
// if the request fails.
google.ads.googleads.v8.enums.UserListPrepopulationStatusEnum.UserListPrepopulationStatus prepopulation_status = 1;
// Subtypes of rule based user lists.
oneof rule_based_user_list {
// User lists defined by combining two rules.
// There are two operators: AND, where the left and right operands have to
// be true; AND_NOT where left operand is true but right operand is false.
CombinedRuleUserListInfo combined_rule_user_list = 2;
// Visitors of a page during specific dates. The visiting periods are
// defined as follows:
// Between start_date (inclusive) and end_date (inclusive);
// Before end_date (exclusive) with start_date = 2000-01-01;
// After start_date (exclusive) with end_date = 2037-12-30.
DateSpecificRuleUserListInfo date_specific_rule_user_list = 3;
// Visitors of a page. The page visit is defined by one boolean rule
// expression.
ExpressionRuleUserListInfo expression_rule_user_list = 4;
}
}
// Represents a user list that is a custom combination of user lists.
message LogicalUserListInfo {
// Logical list rules that define this user list. The rules are defined as a
// logical operator (ALL/ANY/NONE) and a list of user lists. All the rules are
// ANDed when they are evaluated.
//
// Required for creating a logical user list.
repeated UserListLogicalRuleInfo rules = 1;
}
// A user list logical rule. A rule has a logical operator (and/or/not) and a
// list of user lists as operands.
message UserListLogicalRuleInfo {
// The logical operator of the rule.
google.ads.googleads.v8.enums.UserListLogicalRuleOperatorEnum.UserListLogicalRuleOperator operator = 1;
// The list of operands of the rule.
repeated LogicalUserListOperandInfo rule_operands = 2;
}
// Operand of logical user list that consists of a user list.
message LogicalUserListOperandInfo {
// Resource name of a user list as an operand.
optional string user_list = 2;
}
// User list targeting as a collection of conversions or remarketing actions.
message BasicUserListInfo {
// Actions associated with this user list.
repeated UserListActionInfo actions = 1;
}
// Represents an action type used for building remarketing user lists.
message UserListActionInfo {
// Subtypes of user list action.
oneof user_list_action {
// A conversion action that's not generated from remarketing.
string conversion_action = 3;
// A remarketing action.
string remarketing_action = 4;
}
}

51
google/ads/googleads/v8/common/value.proto
View file

@ -1,51 +0,0 @@
// Copyright 2021 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.v8.common;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Common";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/common;common";
option java_multiple_files = true;
option java_outer_classname = "ValueProto";
option java_package = "com.google.ads.googleads.v8.common";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Common";
option ruby_package = "Google::Ads::GoogleAds::V8::Common";
// Proto file describing value types.
// 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;
}
}

89
google/ads/googleads/v8/enums/BUILD.bazel
View file

@ -1,89 +0,0 @@
# Copyright 2020 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
#
# https://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.
package(default_visibility = ["//visibility:public"])
##############################################################################
# Common
##############################################################################
load("@rules_proto//proto:defs.bzl", "proto_library")
# TODO(ohren): Change srcs to use an enumeration of each individual proto
# instead of *.proto globbing once the build file generator supports subpackages.
proto_library(
name = "enums_proto",
srcs = glob(["*.proto"]),
deps = [
"//google/api:annotations_proto",
],
)
##############################################################################
# Java
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"java_proto_library",
)
java_proto_library(
name = "enums_java_proto",
deps = [":enums_proto"],
)
##############################################################################
# PHP
##############################################################################
# PHP targets are in the parent directory's BUILD.bazel file to facilitate
# aggregating metadata using a single underlying call to protoc.
##############################################################################
# C#
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"csharp_proto_library",
)
csharp_proto_library(
name = "enums_csharp_proto",
deps = [":enums_proto"],
)
##############################################################################
# Ruby
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"ruby_proto_library",
)
ruby_proto_library(
name = "enums_ruby_proto",
deps = [":enums_proto"],
)
##############################################################################
# Python
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"py_proto_library",
)
py_proto_library(
name = "enums_py_proto",
deps = [":enums_proto"],
)

55
google/ads/googleads/v8/enums/access_invitation_status.proto
View file

@ -1,55 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AccessInvitationStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing AccessInvitationStatus enum.
// Container for enum for identifying the status of access invitation
message AccessInvitationStatusEnum {
// Possible access invitation status of a user
enum AccessInvitationStatus {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The initial state of an invitation, before being acted upon by anyone.
PENDING = 2;
// Invitation process was terminated by the email recipient. No new user was
// created.
DECLINED = 3;
// Invitation URLs expired without being acted upon. No new user can be
// created. Invitations expire 20 days after creation.
EXPIRED = 4;
}
}

57
google/ads/googleads/v8/enums/access_reason.proto
View file

@ -1,57 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AccessReasonProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Indicates the way the resource such as user list is related to a user.
message AccessReasonEnum {
// Enum describing possible access reasons.
enum AccessReason {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The resource is owned by the user.
OWNED = 2;
// The resource is shared to the user.
SHARED = 3;
// The resource is licensed to the user.
LICENSED = 4;
// The user subscribed to the resource.
SUBSCRIBED = 5;
// The resource is accessible to the user.
AFFILIATED = 6;
}
}

55
google/ads/googleads/v8/enums/access_role.proto
View file

@ -1,55 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AccessRoleProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Container for enum describing possible access role for user.
message AccessRoleEnum {
// Possible access role of a user.
enum AccessRole {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Owns its account and can control the addition of other users.
ADMIN = 2;
// Can modify campaigns, but can't affect other users.
STANDARD = 3;
// Can view campaigns and account changes, but cannot make edits.
READ_ONLY = 4;
// Role for \"email only\" access. Represents an email recipient rather than
// a true User entity.
EMAIL_ONLY = 5;
}
}

63
google/ads/googleads/v8/enums/account_budget_proposal_status.proto
View file

@ -1,63 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AccountBudgetProposalStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing AccountBudgetProposal statuses.
// Message describing AccountBudgetProposal statuses.
message AccountBudgetProposalStatusEnum {
// The possible statuses of an AccountBudgetProposal.
enum AccountBudgetProposalStatus {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The proposal is pending approval.
PENDING = 2;
// The proposal has been approved but the corresponding billing setup
// has not. This can occur for proposals that set up the first budget
// when signing up for billing or when performing a change of bill-to
// operation.
APPROVED_HELD = 3;
// The proposal has been approved.
APPROVED = 4;
// The proposal has been cancelled by the user.
CANCELLED = 5;
// The proposal has been rejected by the user, e.g. by rejecting an
// acceptance email.
REJECTED = 6;
}
}

56
google/ads/googleads/v8/enums/account_budget_proposal_type.proto
View file

@ -1,56 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AccountBudgetProposalTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing AccountBudgetProposal types.
// Message describing AccountBudgetProposal types.
message AccountBudgetProposalTypeEnum {
// The possible types of an AccountBudgetProposal.
enum AccountBudgetProposalType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Identifies a request to create a new budget.
CREATE = 2;
// Identifies a request to edit an existing budget.
UPDATE = 3;
// Identifies a request to end a budget that has already started.
END = 4;
// Identifies a request to remove a budget that hasn't started yet.
REMOVE = 5;
}
}

53
google/ads/googleads/v8/enums/account_budget_status.proto
View file

@ -1,53 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AccountBudgetStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing AccountBudget statuses.
// Message describing AccountBudget statuses.
message AccountBudgetStatusEnum {
// The possible statuses of an AccountBudget.
enum AccountBudgetStatus {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The account budget is pending approval.
PENDING = 2;
// The account budget has been approved.
APPROVED = 3;
// The account budget has been cancelled by the user.
CANCELLED = 4;
}
}

63
google/ads/googleads/v8/enums/account_link_status.proto
View file

@ -1,63 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AccountLinkStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Container for enum describing possible statuses of an account link.
message AccountLinkStatusEnum {
// Describes the possible statuses for a link between a Google Ads customer
// and another account.
enum AccountLinkStatus {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The link is enabled.
ENABLED = 2;
// The link is removed/disabled.
REMOVED = 3;
// The link to the other account has been requested. A user on the other
// account may now approve the link by setting the status to ENABLED.
REQUESTED = 4;
// This link has been requested by a user on the other account. It may be
// approved by a user on this account by setting the status to ENABLED.
PENDING_APPROVAL = 5;
// The link is rejected by the approver.
REJECTED = 6;
// The link is revoked by the user who requested the link.
REVOKED = 7;
}
}

56
google/ads/googleads/v8/enums/ad_customizer_placeholder_field.proto
View file

@ -1,56 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdCustomizerPlaceholderFieldProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing Ad Customizer placeholder fields.
// Values for Ad Customizer placeholder fields.
message AdCustomizerPlaceholderFieldEnum {
// Possible values for Ad Customizers placeholder fields.
enum AdCustomizerPlaceholderField {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Data Type: INT64. Integer value to be inserted.
INTEGER = 2;
// Data Type: STRING. Price value to be inserted.
PRICE = 3;
// Data Type: DATE_TIME. Date value to be inserted.
DATE = 4;
// Data Type: STRING. String value to be inserted.
STRING = 5;
}
}

77
google/ads/googleads/v8/enums/ad_destination_type.proto
View file

@ -1,77 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdDestinationTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing ad destination types.
// Container for enumeration of Google Ads destination types.
message AdDestinationTypeEnum {
// Enumerates Google Ads destination types
enum AdDestinationType {
// Not specified.
UNSPECIFIED = 0;
// The value is unknown in this version.
UNKNOWN = 1;
// Ads that don't intend to drive users off from ads to other destinations
NOT_APPLICABLE = 2;
// Website
WEBSITE = 3;
// App Deep Link
APP_DEEP_LINK = 4;
// iOS App Store or Play Store
APP_STORE = 5;
// Call Dialer
PHONE_CALL = 6;
// Map App
MAP_DIRECTIONS = 7;
// Location Dedicated Page
LOCATION_LISTING = 8;
// Text Message
MESSAGE = 9;
// Lead Generation Form
LEAD_FORM = 10;
// YouTube
YOUTUBE = 11;
// Ad Destination for Conversions with keys unknown
UNMODELED_FOR_CONVERSIONS = 12;
}
}

53
google/ads/googleads/v8/enums/ad_group_ad_rotation_mode.proto
View file

@ -1,53 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdGroupAdRotationModeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing ad group ad rotation mode.
// Container for enum describing possible ad rotation modes of ads within an
// ad group.
message AdGroupAdRotationModeEnum {
// The possible ad rotation modes of an ad group.
enum AdGroupAdRotationMode {
// The ad rotation mode has not been specified.
UNSPECIFIED = 0;
// The received value is not known in this version.
//
// This is a response-only value.
UNKNOWN = 1;
// Optimize ad group ads based on clicks or conversions.
OPTIMIZE = 2;
// Rotate evenly forever.
ROTATE_FOREVER = 3;
}
}

55
google/ads/googleads/v8/enums/ad_group_ad_status.proto
View file

@ -1,55 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdGroupAdStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing ad group status.
// 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;
}
}

56
google/ads/googleads/v8/enums/ad_group_criterion_approval_status.proto
View file

@ -1,56 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCriterionApprovalStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing approval status for the criterion.
// Container for enum describing possible AdGroupCriterion approval statuses.
message AdGroupCriterionApprovalStatusEnum {
// Enumerates AdGroupCriterion approval statuses.
enum AdGroupCriterionApprovalStatus {
// Not specified.
UNSPECIFIED = 0;
// The value is unknown in this version.
UNKNOWN = 1;
// Approved.
APPROVED = 2;
// Disapproved.
DISAPPROVED = 3;
// Pending Review.
PENDING_REVIEW = 4;
// Under review.
UNDER_REVIEW = 5;
}
}

55
google/ads/googleads/v8/enums/ad_group_criterion_status.proto
View file

@ -1,55 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCriterionStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing AdGroupCriterion statuses.
// 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;
}
}

55
google/ads/googleads/v8/enums/ad_group_status.proto
View file

@ -1,55 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdGroupStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing ad group status.
// 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;
}
}

96
google/ads/googleads/v8/enums/ad_group_type.proto
View file

@ -1,96 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdGroupTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing ad group types.
// 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 Display campaigns.
DISPLAY_STANDARD = 3;
// The ad group type for Shopping campaigns serving standard product ads.
SHOPPING_PRODUCT_ADS = 4;
// The default ad group type for Hotel campaigns.
HOTEL_ADS = 6;
// The type for ad groups in Smart Shopping campaigns.
SHOPPING_SMART_ADS = 7;
// Short unskippable in-stream video ads.
VIDEO_BUMPER = 8;
// TrueView (skippable) in-stream video ads.
VIDEO_TRUE_VIEW_IN_STREAM = 9;
// TrueView in-display video ads.
VIDEO_TRUE_VIEW_IN_DISPLAY = 10;
// Unskippable in-stream video ads.
VIDEO_NON_SKIPPABLE_IN_STREAM = 11;
// Outstream video ads.
VIDEO_OUTSTREAM = 12;
// Ad group type for Dynamic Search Ads ad groups.
SEARCH_DYNAMIC_ADS = 13;
// The type for ad groups in Shopping Comparison Listing campaigns.
SHOPPING_COMPARISON_LISTING_ADS = 14;
// The ad group type for Promoted Hotel ad groups.
PROMOTED_HOTEL_ADS = 15;
// Video responsive ad groups.
VIDEO_RESPONSIVE = 16;
// Video efficient reach ad groups.
VIDEO_EFFICIENT_REACH = 17;
// Ad group type for Smart campaigns.
SMART_CAMPAIGN_ADS = 18;
}
}

62
google/ads/googleads/v8/enums/ad_network_type.proto
View file

@ -1,62 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdNetworkTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing ad network types.
// Container for enumeration of Google Ads network types.
message AdNetworkTypeEnum {
// Enumerates Google Ads 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;
// Cross-network.
MIXED = 7;
}
}

64
google/ads/googleads/v8/enums/ad_serving_optimization_status.proto
View file

@ -1,64 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdServingOptimizationStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing ad serving statuses.
// 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;
}
}

62
google/ads/googleads/v8/enums/ad_strength.proto
View file

@ -1,62 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdStrengthProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing ad strengths.
// Container for enum describing possible ad strengths.
message AdStrengthEnum {
// Enum listing the possible ad strengths.
enum AdStrength {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The ad strength is currently pending.
PENDING = 2;
// No ads could be generated.
NO_ADS = 3;
// Poor strength.
POOR = 4;
// Average strength.
AVERAGE = 5;
// Good strength.
GOOD = 6;
// Excellent strength.
EXCELLENT = 7;
}
}

128
google/ads/googleads/v8/enums/ad_type.proto
View file

@ -1,128 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing the ad type.
// 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 an expanded dynamic search ad.
EXPANDED_DYNAMIC_SEARCH_AD = 7;
// The ad is a hotel ad.
HOTEL_AD = 8;
// The ad is a Smart Shopping ad.
SHOPPING_SMART_AD = 9;
// The ad is a standard Shopping ad.
SHOPPING_PRODUCT_AD = 10;
// The ad is a video ad.
VIDEO_AD = 12;
// This ad is a Gmail ad.
GMAIL_AD = 13;
// This ad is an Image ad.
IMAGE_AD = 14;
// The ad is a responsive search ad.
RESPONSIVE_SEARCH_AD = 15;
// The ad is a legacy responsive display ad.
LEGACY_RESPONSIVE_DISPLAY_AD = 16;
// The ad is an app ad.
APP_AD = 17;
// The ad is a legacy app install ad.
LEGACY_APP_INSTALL_AD = 18;
// The ad is a responsive display ad.
RESPONSIVE_DISPLAY_AD = 19;
// The ad is a local ad.
LOCAL_AD = 20;
// The ad is a display upload ad with the HTML5_UPLOAD_AD product type.
HTML5_UPLOAD_AD = 21;
// The ad is a display upload ad with one of the DYNAMIC_HTML5_* product
// types.
DYNAMIC_HTML5_AD = 22;
// The ad is an app engagement ad.
APP_ENGAGEMENT_AD = 23;
// The ad is a Shopping Comparison Listing ad.
SHOPPING_COMPARISON_LISTING_AD = 24;
// Video bumper ad.
VIDEO_BUMPER_AD = 25;
// Video non-skippable in-stream ad.
VIDEO_NON_SKIPPABLE_IN_STREAM_AD = 26;
// Video outstream ad.
VIDEO_OUTSTREAM_AD = 27;
// Video TrueView in-display ad.
VIDEO_TRUEVIEW_DISCOVERY_AD = 28;
// Video TrueView in-stream ad.
VIDEO_TRUEVIEW_IN_STREAM_AD = 29;
// Video responsive ad.
VIDEO_RESPONSIVE_AD = 30;
// Smart campaign ad.
SMART_CAMPAIGN_AD = 31;
// Call ad.
CALL_AD = 32;
}
}

96
google/ads/googleads/v8/enums/advertising_channel_sub_type.proto
View file

@ -1,96 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdvertisingChannelSubTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing advertising channel subtypes.
// 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;
// Mobile app campaigns for Display.
DISPLAY_MOBILE_APP = 3;
// AdWords express campaigns for search.
SEARCH_EXPRESS = 4;
// AdWords Express campaigns for display.
DISPLAY_EXPRESS = 5;
// Smart Shopping campaigns.
SHOPPING_SMART_ADS = 6;
// Gmail Ad campaigns.
DISPLAY_GMAIL_AD = 7;
// Smart display campaigns.
DISPLAY_SMART_CAMPAIGN = 8;
// Video Outstream campaigns.
VIDEO_OUTSTREAM = 9;
// Video TrueView for Action campaigns.
VIDEO_ACTION = 10;
// Video campaigns with non-skippable video ads.
VIDEO_NON_SKIPPABLE = 11;
// App Campaign that allows you to easily promote your Android or iOS app
// across Google's top properties including Search, Play, YouTube, and the
// Google Display Network.
APP_CAMPAIGN = 12;
// App Campaign for engagement, focused on driving re-engagement with the
// app across several of Google’s top properties including Search, YouTube,
// and the Google Display Network.
APP_CAMPAIGN_FOR_ENGAGEMENT = 13;
// Campaigns specialized for local advertising.
LOCAL_CAMPAIGN = 14;
// Shopping Comparison Listing campaigns.
SHOPPING_COMPARISON_LISTING_ADS = 15;
// Standard Smart campaigns.
SMART_CAMPAIGN = 16;
// Video campaigns with sequence video ads.
VIDEO_SEQUENCE = 17;
}
}

70
google/ads/googleads/v8/enums/advertising_channel_type.proto
View file

@ -1,70 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdvertisingChannelTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing advertising channel types
// 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;
// Google Display Network only.
DISPLAY = 3;
// Shopping campaigns serve on the shopping property
// and on google.com search results.
SHOPPING = 4;
// Hotel Ads campaigns.
HOTEL = 5;
// Video campaigns.
VIDEO = 6;
// App Campaigns, and App Campaigns for Engagement, that run
// across multiple channels.
MULTI_CHANNEL = 7;
// Local ads campaigns.
LOCAL = 8;
// Smart campaigns.
SMART = 9;
}
}

48
google/ads/googleads/v8/enums/affiliate_location_feed_relationship_type.proto
View file

@ -1,48 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AffiliateLocationFeedRelationshipTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing relation type for affiliate location feeds.
// Container for enum describing possible values for a relationship type for
// an affiliate location feed.
message AffiliateLocationFeedRelationshipTypeEnum {
// Possible values for a relationship type for an affiliate location feed.
enum AffiliateLocationFeedRelationshipType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// General retailer relationship.
GENERAL_RETAILER = 2;
}
}

77
google/ads/googleads/v8/enums/affiliate_location_placeholder_field.proto
View file

@ -1,77 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AffiliateLocationPlaceholderFieldProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing Affiliate Location placeholder fields.
// Values for Affiliate Location placeholder fields.
message AffiliateLocationPlaceholderFieldEnum {
// Possible values for Affiliate Location placeholder fields.
enum AffiliateLocationPlaceholderField {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Data Type: STRING. The name of the business.
BUSINESS_NAME = 2;
// Data Type: STRING. Line 1 of the business address.
ADDRESS_LINE_1 = 3;
// Data Type: STRING. Line 2 of the business address.
ADDRESS_LINE_2 = 4;
// Data Type: STRING. City of the business address.
CITY = 5;
// Data Type: STRING. Province of the business address.
PROVINCE = 6;
// Data Type: STRING. Postal code of the business address.
POSTAL_CODE = 7;
// Data Type: STRING. Country code of the business address.
COUNTRY_CODE = 8;
// Data Type: STRING. Phone number of the business.
PHONE_NUMBER = 9;
// Data Type: STRING. Language code of the business.
LANGUAGE_CODE = 10;
// Data Type: INT64. ID of the chain.
CHAIN_ID = 11;
// Data Type: STRING. Name of the chain.
CHAIN_NAME = 12;
}
}

65
google/ads/googleads/v8/enums/age_range_type.proto
View file

@ -1,65 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AgeRangeTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing age range types.
// Container for enum describing the type of demographic age ranges.
message AgeRangeTypeEnum {
// The type of demographic age ranges (e.g. between 18 and 24 years old).
enum AgeRangeType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Between 18 and 24 years old.
AGE_RANGE_18_24 = 503001;
// Between 25 and 34 years old.
AGE_RANGE_25_34 = 503002;
// Between 35 and 44 years old.
AGE_RANGE_35_44 = 503003;
// Between 45 and 54 years old.
AGE_RANGE_45_54 = 503004;
// Between 55 and 64 years old.
AGE_RANGE_55_64 = 503005;
// 65 years old and beyond.
AGE_RANGE_65_UP = 503006;
// Undetermined age range.
AGE_RANGE_UNDETERMINED = 503999;
}
}

50
google/ads/googleads/v8/enums/app_campaign_app_store.proto
View file

@ -1,50 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AppCampaignAppStoreProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing App Campaign app store.
// The application store that distributes mobile applications.
message AppCampaignAppStoreEnum {
// Enum describing app campaign app store.
enum AppCampaignAppStore {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Apple app store.
APPLE_APP_STORE = 2;
// Google play.
GOOGLE_APP_STORE = 3;
}
}

64
google/ads/googleads/v8/enums/app_campaign_bidding_strategy_goal_type.proto
View file

@ -1,64 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AppCampaignBiddingStrategyGoalTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing App Campaign bidding strategy goal types.
// Container for enum describing goal towards which the bidding strategy of an
// app campaign should optimize for.
message AppCampaignBiddingStrategyGoalTypeEnum {
// Goal type of App campaign BiddingStrategy.
enum AppCampaignBiddingStrategyGoalType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Aim to maximize the number of app installs. The cpa bid is the
// target cost per install.
OPTIMIZE_INSTALLS_TARGET_INSTALL_COST = 2;
// Aim to maximize the long term number of selected in-app conversions from
// app installs. The cpa bid is the target cost per install.
OPTIMIZE_IN_APP_CONVERSIONS_TARGET_INSTALL_COST = 3;
// Aim to maximize the long term number of selected in-app conversions from
// app installs. The cpa bid is the target cost per in-app conversion. Note
// that the actual cpa may seem higher than the target cpa at first, since
// the long term conversions haven’t happened yet.
OPTIMIZE_IN_APP_CONVERSIONS_TARGET_CONVERSION_COST = 4;
// Aim to maximize all conversions' value, i.e. install + selected in-app
// conversions while achieving or exceeding target return on advertising
// spend.
OPTIMIZE_RETURN_ON_ADVERTISING_SPEND = 5;
}
}

47
google/ads/googleads/v8/enums/app_payment_model_type.proto
View file

@ -1,47 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AppPaymentModelTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing criteria types.
// Represents a criterion for targeting paid apps.
message AppPaymentModelTypeEnum {
// Enum describing possible app payment models.
enum AppPaymentModelType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Represents paid-for apps.
PAID = 30;
}
}

75
google/ads/googleads/v8/enums/app_placeholder_field.proto
View file

@ -1,75 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AppPlaceholderFieldProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing App placeholder fields.
// Values for App placeholder fields.
message AppPlaceholderFieldEnum {
// Possible values for App placeholder fields.
enum AppPlaceholderField {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Data Type: INT64. The application store that the target application
// belongs to. Valid values are: 1 = Apple iTunes Store; 2 = Google Play
// Store.
STORE = 2;
// Data Type: STRING. The store-specific ID for the target application.
ID = 3;
// Data Type: STRING. The visible text displayed when the link is rendered
// in an ad.
LINK_TEXT = 4;
// Data Type: STRING. The destination URL of the in-app link.
URL = 5;
// Data Type: URL_LIST. Final URLs for the in-app link when using Upgraded
// URLs.
FINAL_URLS = 6;
// Data Type: URL_LIST. Final Mobile URLs for the in-app link when using
// Upgraded URLs.
FINAL_MOBILE_URLS = 7;
// Data Type: URL. Tracking template for the in-app link when using Upgraded
// URLs.
TRACKING_URL = 8;
// Data Type: STRING. Final URL suffix for the in-app link when using
// parallel tracking.
FINAL_URL_SUFFIX = 9;
}
}

50
google/ads/googleads/v8/enums/app_store.proto
View file

@ -1,50 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AppStoreProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing app store types for an app extension.
// Container for enum describing app store type in an app extension.
message AppStoreEnum {
// App store type in an app extension.
enum AppStore {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Apple iTunes.
APPLE_ITUNES = 2;
// Google Play.
GOOGLE_PLAY = 3;
}
}

50
google/ads/googleads/v8/enums/app_url_operating_system_type.proto
View file

@ -1,50 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AppUrlOperatingSystemTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing operating system for a deeplink app URL.
// The possible OS types for a deeplink AppUrl.
message AppUrlOperatingSystemTypeEnum {
// Operating System
enum AppUrlOperatingSystemType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The Apple IOS operating system.
IOS = 2;
// The Android operating system.
ANDROID = 3;
}
}

81
google/ads/googleads/v8/enums/asset_field_type.proto
View file

@ -1,81 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AssetFieldTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing asset type.
// Container for enum describing the possible placements of an asset.
message AssetFieldTypeEnum {
// Enum describing the possible placements of an asset.
enum AssetFieldType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The asset is linked for use as a headline.
HEADLINE = 2;
// The asset is linked for use as a description.
DESCRIPTION = 3;
// The asset is linked for use as mandatory ad text.
MANDATORY_AD_TEXT = 4;
// The asset is linked for use as a marketing image.
MARKETING_IMAGE = 5;
// The asset is linked for use as a media bundle.
MEDIA_BUNDLE = 6;
// The asset is linked for use as a YouTube video.
YOUTUBE_VIDEO = 7;
// The asset is linked to indicate that a hotels campaign is "Book on
// Google" enabled.
BOOK_ON_GOOGLE = 8;
// The asset is linked for use as a Lead Form extension.
LEAD_FORM = 9;
// The asset is linked for use as a Promotion extension.
PROMOTION = 10;
// The asset is linked for use as a Callout extension.
CALLOUT = 11;
// The asset is linked for use as a Structured Snippet extension.
STRUCTURED_SNIPPET = 12;
// The asset is linked for use as a Sitelink extension.
SITELINK = 13;
}
}

53
google/ads/googleads/v8/enums/asset_link_status.proto
View file

@ -1,53 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AssetLinkStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing status of an asset link.
// Container for enum describing possible statuses of an asset link.
message AssetLinkStatusEnum {
// Enum describing statuses of an asset link.
enum AssetLinkStatus {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Asset link is enabled.
ENABLED = 2;
// Asset link has been removed.
REMOVED = 3;
// Asset link is paused.
PAUSED = 4;
}
}

62
google/ads/googleads/v8/enums/asset_performance_label.proto
View file

@ -1,62 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AssetPerformanceLabelProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing the performance label of an asset.
// Container for enum describing the performance label of an asset.
message AssetPerformanceLabelEnum {
// Enum describing the possible performance labels of an asset, usually
// computed in the context of a linkage.
enum AssetPerformanceLabel {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// This asset does not yet have any performance informantion. This may be
// because it is still under review.
PENDING = 2;
// The asset has started getting impressions but the stats are not
// statistically significant enough to get an asset performance label.
LEARNING = 3;
// Worst performing assets.
LOW = 4;
// Good performing assets.
GOOD = 5;
// Best performing assets.
BEST = 6;
}
}

74
google/ads/googleads/v8/enums/asset_type.proto
View file

@ -1,74 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AssetTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing asset type.
// Container for enum describing the types of asset.
message AssetTypeEnum {
// Enum describing possible types of asset.
enum AssetType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// YouTube video asset.
YOUTUBE_VIDEO = 2;
// Media bundle asset.
MEDIA_BUNDLE = 3;
// Image asset.
IMAGE = 4;
// Text asset.
TEXT = 5;
// Lead form asset.
LEAD_FORM = 6;
// Book on Google asset.
BOOK_ON_GOOGLE = 7;
// Promotion asset.
PROMOTION = 8;
// Callout asset.
CALLOUT = 9;
// Structured Snippet asset.
STRUCTURED_SNIPPET = 10;
// Sitelink asset.
SITELINK = 11;
}
}

72
google/ads/googleads/v8/enums/attribution_model.proto
View file

@ -1,72 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AttributionModelProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Container for enum representing the attribution model that describes how to
// distribute credit for a particular conversion across potentially many prior
// interactions.
message AttributionModelEnum {
// The attribution model that describes how to distribute credit for a
// particular conversion across potentially many prior interactions.
enum AttributionModel {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Uses external attribution.
EXTERNAL = 100;
// Attributes all credit for a conversion to its last click.
GOOGLE_ADS_LAST_CLICK = 101;
// Attributes all credit for a conversion to its first click using Google
// Search attribution.
GOOGLE_SEARCH_ATTRIBUTION_FIRST_CLICK = 102;
// Attributes credit for a conversion equally across all of its clicks using
// Google Search attribution.
GOOGLE_SEARCH_ATTRIBUTION_LINEAR = 103;
// Attributes exponentially more credit for a conversion to its more recent
// clicks using Google Search attribution (half-life is 1 week).
GOOGLE_SEARCH_ATTRIBUTION_TIME_DECAY = 104;
// Attributes 40% of the credit for a conversion to its first and last
// clicks. Remaining 20% is evenly distributed across all other clicks. This
// uses Google Search attribution.
GOOGLE_SEARCH_ATTRIBUTION_POSITION_BASED = 105;
// Flexible model that uses machine learning to determine the appropriate
// distribution of credit among clicks using Google Search attribution.
GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN = 106;
}
}

53
google/ads/googleads/v8/enums/batch_job_status.proto
View file

@ -1,53 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BatchJobStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing batch job statuses.
// Container for enum describing possible batch job statuses.
message BatchJobStatusEnum {
// The batch job statuses.
enum BatchJobStatus {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The job is not currently running.
PENDING = 2;
// The job is running.
RUNNING = 3;
// The job is done.
DONE = 4;
}
}

51
google/ads/googleads/v8/enums/bid_modifier_source.proto
View file

@ -1,51 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BidModifierSourceProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing bid modifier source.
// Container for enum describing possible bid modifier sources.
message BidModifierSourceEnum {
// Enum describing possible bid modifier sources.
enum BidModifierSource {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The bid modifier is specified at the campaign level, on the campaign
// level criterion.
CAMPAIGN = 2;
// The bid modifier is specified (overridden) at the ad group level.
AD_GROUP = 3;
}
}

55
google/ads/googleads/v8/enums/bidding_source.proto
View file

@ -1,55 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BiddingSourceProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing bidding sources.
// Container for enum describing possible bidding sources.
message BiddingSourceEnum {
// Indicates where a bid or target is defined. For example, an ad group
// criterion may define a cpc bid directly, or it can inherit its cpc bid from
// the ad group.
enum BiddingSource {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Effective bid or target is inherited from campaign bidding strategy.
CAMPAIGN_BIDDING_STRATEGY = 5;
// The bid or target is defined on the ad group.
AD_GROUP = 6;
// The bid or target is defined on the ad group criterion.
AD_GROUP_CRITERION = 7;
}
}

52
google/ads/googleads/v8/enums/bidding_strategy_status.proto
View file

@ -1,52 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BiddingStrategyStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing BiddingStrategy statuses.
// Message describing BiddingStrategy statuses.
message BiddingStrategyStatusEnum {
// The possible statuses of a BiddingStrategy.
enum BiddingStrategyStatus {
// 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 bidding strategy is enabled.
ENABLED = 2;
// The bidding strategy is removed.
REMOVED = 4;
}
}

119
google/ads/googleads/v8/enums/bidding_strategy_type.proto
View file

@ -1,119 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BiddingStrategyTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing bidding schemes.
// 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;
// Commission is an automatic bidding strategy in which the advertiser pays
// a certain portion of the conversion value.
COMMISSION = 16;
// 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;
// Used for return value only. Indicates that a campaign does not have a
// bidding strategy. This prevents the campaign from serving. For example,
// a campaign may be attached to a manager bidding strategy and the serving
// account is subsequently unlinked from the manager account. In this case
// the campaign will automatically be detached from the now inaccessible
// manager bidding strategy and transition to the INVALID bidding strategy
// type.
INVALID = 17;
// 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 pays a configurable amount per video view.
MANUAL_CPV = 13;
// 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.
// This enum value is deprecated.
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 CPM is an automated bid strategy that sets bids to help get
// as many impressions as possible at the target cost per one thousand
// impressions (CPM) you set.
TARGET_CPM = 14;
// 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).
TARGET_IMPRESSION_SHARE = 15;
// 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.
// This enum value is deprecated.
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;
}
}

58
google/ads/googleads/v8/enums/billing_setup_status.proto
View file

@ -1,58 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BillingSetupStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing BillingSetup statuses.
// Message describing BillingSetup statuses.
message BillingSetupStatusEnum {
// The possible statuses of a BillingSetup.
enum BillingSetupStatus {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The billing setup is pending approval.
PENDING = 2;
// The billing setup has been approved but the corresponding first budget
// has not. This can only occur for billing setups configured for monthly
// invoicing.
APPROVED_HELD = 3;
// The billing setup has been approved.
APPROVED = 4;
// The billing setup was cancelled by the user prior to approval.
CANCELLED = 5;
}
}

73
google/ads/googleads/v8/enums/brand_safety_suitability.proto
View file

@ -1,73 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BrandSafetySuitabilityProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing brand safety suitability settings.
// Container for enum with 3-Tier brand safety suitability control.
message BrandSafetySuitabilityEnum {
// 3-Tier brand safety suitability control.
enum BrandSafetySuitability {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// This option lets you show ads across all inventory on YouTube and video
// partners that meet our standards for monetization. This option may be an
// appropriate choice for brands that want maximum access to the full
// breadth of videos eligible for ads, including, for example, videos that
// have strong profanity in the context of comedy or a documentary, or
// excessive violence as featured in video games.
EXPANDED_INVENTORY = 2;
// This option lets you show ads across a wide range of content that's
// appropriate for most brands, such as popular music videos, documentaries,
// and movie trailers. The content you can show ads on is based on YouTube's
// advertiser-friendly content guidelines that take into account, for
// example, the strength or frequency of profanity, or the appropriateness
// of subject matter like sensitive events. Ads won't show, for example, on
// content with repeated strong profanity, strong sexual content, or graphic
// violence.
STANDARD_INVENTORY = 3;
// This option lets you show ads on a reduced range of content that's
// appropriate for brands with particularly strict guidelines around
// inappropriate language and sexual suggestiveness; above and beyond what
// YouTube's advertiser-friendly content guidelines address. The videos
// accessible in this sensitive category meet heightened requirements,
// especially for inappropriate language and sexual suggestiveness. For
// example, your ads will be excluded from showing on some of YouTube's most
// popular music videos and other pop culture content across YouTube and
// Google video partners.
LIMITED_INVENTORY = 4;
}
}

51
google/ads/googleads/v8/enums/budget_campaign_association_status.proto
View file

@ -1,51 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BudgetCampaignAssociationStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing Budget and Campaign association status.
// Message describing the status of the association between the Budget and the
// Campaign.
message BudgetCampaignAssociationStatusEnum {
// Possible statuses of the association between the Budget and the Campaign.
enum BudgetCampaignAssociationStatus {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The campaign is currently using the budget.
ENABLED = 2;
// The campaign is no longer using the budget.
REMOVED = 3;
}
}

53
google/ads/googleads/v8/enums/budget_delivery_method.proto
View file

@ -1,53 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BudgetDeliveryMethodProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing Budget delivery methods.
// 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;
}
}

53
google/ads/googleads/v8/enums/budget_period.proto
View file

@ -1,53 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BudgetPeriodProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing Budget delivery methods.
// Message describing Budget period.
message BudgetPeriodEnum {
// Possible period of a Budget.
enum BudgetPeriod {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Daily budget.
DAILY = 2;
// Custom budget, added back in V5.
// Custom bugdet can be used with total_amount to specify lifetime budget
// limit. See: https://support.google.com/google-ads/answer/6385083 for more
// info.
CUSTOM_PERIOD = 5;
}
}

50
google/ads/googleads/v8/enums/budget_status.proto
View file

@ -1,50 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BudgetStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing Budget statuses
// 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;
}
}

74
google/ads/googleads/v8/enums/budget_type.proto
View file

@ -1,74 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BudgetTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing Budget types.
// Describes Budget types.
message BudgetTypeEnum {
// Possible Budget types.
enum BudgetType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Budget type for standard Google Ads usage.
// Caps daily spend at two times the specified budget amount.
// Full details: https://support.google.com/google-ads/answer/6385083
STANDARD = 2;
// Budget type for Hotels Ads commission program.
// Full details: https://support.google.com/google-ads/answer/9243945
//
// This type is only supported by campaigns with
// AdvertisingChannelType.HOTEL, BiddingStrategyType.COMMISSION and
// PaymentMode.CONVERSION_VALUE.
HOTEL_ADS_COMMISSION = 3;
// Budget type with a fixed cost-per-acquisition (conversion).
// Full details: https://support.google.com/google-ads/answer/7528254
//
// This type is only supported by campaigns with
// AdvertisingChannelType.DISPLAY (excluding
// AdvertisingChannelSubType.DISPLAY_GMAIL),
// BiddingStrategyType.TARGET_CPA and PaymentMode.CONVERSIONS.
FIXED_CPA = 4;
// Budget type for Smart Campaign.
// Full details: https://support.google.com/google-ads/answer/7653509
//
// This type is only supported by campaigns with
// AdvertisingChannelType.SMART and
// AdvertisingChannelSubType.SMART_CAMPAIGN.
SMART_CAMPAIGN = 5;
}
}

56
google/ads/googleads/v8/enums/call_conversion_reporting_state.proto
View file

@ -1,56 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CallConversionReportingStateProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing call conversion reporting state.
// Container for enum describing possible data types for call conversion
// reporting state.
message CallConversionReportingStateEnum {
// Possible data types for a call conversion action state.
enum CallConversionReportingState {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Call conversion action is disabled.
DISABLED = 2;
// Call conversion action will use call conversion type set at the
// account level.
USE_ACCOUNT_LEVEL_CALL_CONVERSION_ACTION = 3;
// Call conversion action will use call conversion type set at the resource
// (call only ads/call extensions) level.
USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION = 4;
}
}

66
google/ads/googleads/v8/enums/call_placeholder_field.proto
View file

@ -1,66 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CallPlaceholderFieldProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing Call placeholder fields.
// Values for Call placeholder fields.
message CallPlaceholderFieldEnum {
// Possible values for Call placeholder fields.
enum CallPlaceholderField {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Data Type: STRING. The advertiser's phone number to append to the ad.
PHONE_NUMBER = 2;
// Data Type: STRING. Uppercase two-letter country code of the advertiser's
// phone number.
COUNTRY_CODE = 3;
// Data Type: BOOLEAN. Indicates whether call tracking is enabled. Default:
// true.
TRACKED = 4;
// Data Type: INT64. The ID of an AdCallMetricsConversion object. This
// object contains the phoneCallDurationfield which is the minimum duration
// (in seconds) of a call to be considered a conversion.
CONVERSION_TYPE_ID = 5;
// Data Type: STRING. Indicates whether this call extension uses its own
// call conversion setting or follows the account level setting.
// Valid values are: USE_ACCOUNT_LEVEL_CALL_CONVERSION_ACTION and
// USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.
CONVERSION_REPORTING_STATE = 6;
}
}

50
google/ads/googleads/v8/enums/call_tracking_display_location.proto
View file

@ -1,50 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CallTrackingDisplayLocationProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing call tracking display location.
// Container for enum describing possible call tracking display locations.
message CallTrackingDisplayLocationEnum {
// Possible call tracking display locations.
enum CallTrackingDisplayLocation {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The phone call placed from the ad.
AD = 2;
// The phone call placed from the landing page ad points to.
LANDING_PAGE = 3;
}
}

51
google/ads/googleads/v8/enums/call_type.proto
View file

@ -1,51 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CallTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing call types.
// Container for enum describing possible types of property from where the call
// was made.
message CallTypeEnum {
// Possible types of property from where the call was made.
enum CallType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The phone call was manually dialed.
MANUALLY_DIALED = 2;
// The phone call was a mobile click-to-call.
HIGH_END_MOBILE_SEARCH = 3;
}
}

47
google/ads/googleads/v8/enums/callout_placeholder_field.proto
View file

@ -1,47 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CalloutPlaceholderFieldProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing Callout placeholder fields.
// Values for Callout placeholder fields.
message CalloutPlaceholderFieldEnum {
// Possible values for Callout placeholder fields.
enum CalloutPlaceholderField {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Data Type: STRING. Callout text.
CALLOUT_TEXT = 2;
}
}

55
google/ads/googleads/v8/enums/campaign_criterion_status.proto
View file

@ -1,55 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CampaignCriterionStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing CampaignCriterion statuses.
// Message describing CampaignCriterion statuses.
message CampaignCriterionStatusEnum {
// The possible statuses of a CampaignCriterion.
enum CampaignCriterionStatus {
// 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 campaign criterion is enabled.
ENABLED = 2;
// The campaign criterion is paused.
PAUSED = 3;
// The campaign criterion is removed.
REMOVED = 4;
}
}

65
google/ads/googleads/v8/enums/campaign_draft_status.proto
View file

@ -1,65 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CampaignDraftStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing campaign draft status.
// Container for enum describing possible statuses of a campaign draft.
message CampaignDraftStatusEnum {
// Possible statuses of a campaign draft.
enum CampaignDraftStatus {
// The status has not been specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Initial state of the draft, the advertiser can start adding changes with
// no effect on serving.
PROPOSED = 2;
// The campaign draft is removed.
REMOVED = 3;
// Advertiser requested to promote draft's changes back into the original
// campaign. Advertiser can poll the long running operation returned by
// the promote action to see the status of the promotion.
PROMOTING = 5;
// The process to merge changes in the draft back to the original campaign
// has completed successfully.
PROMOTED = 4;
// The promotion failed after it was partially applied. Promote cannot be
// attempted again safely, so the issue must be corrected in the original
// campaign.
PROMOTE_FAILED = 6;
}
}

77
google/ads/googleads/v8/enums/campaign_experiment_status.proto
View file

@ -1,77 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CampaignExperimentStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing campaign experiment status.
// Container for enum describing possible statuses of a campaign experiment.
message CampaignExperimentStatusEnum {
// Possible statuses of a campaign experiment.
enum CampaignExperimentStatus {
// The status has not been specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The experiment campaign is being initialized.
INITIALIZING = 2;
// Initialization of the experiment campaign failed.
INITIALIZATION_FAILED = 8;
// The experiment campaign is fully initialized. The experiment is currently
// running, scheduled to run in the future or has ended based on its
// end date. An experiment with the status INITIALIZING will be updated to
// ENABLED when it is fully created.
ENABLED = 3;
// The experiment campaign was graduated to a stand-alone
// campaign, existing independently of the experiment.
GRADUATED = 4;
// The experiment is removed.
REMOVED = 5;
// The experiment's changes are being applied to the original campaign.
// The long running operation returned by the promote method can be polled
// to see the status of the promotion.
PROMOTING = 6;
// Promote of the experiment campaign failed.
PROMOTION_FAILED = 9;
// The changes of the experiment are promoted to their original campaign.
PROMOTED = 7;
// The experiment was ended manually. It did not end based on its end date.
ENDED_MANUALLY = 10;
}
}

53
google/ads/googleads/v8/enums/campaign_experiment_traffic_split_type.proto
View file

@ -1,53 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CampaignExperimentTrafficSplitTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing campaign experiment traffic split type.
// Container for enum describing campaign experiment traffic split type.
message CampaignExperimentTrafficSplitTypeEnum {
// Enum of strategies for splitting traffic between base and experiment
// campaigns in campaign experiment.
enum CampaignExperimentTrafficSplitType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Traffic is randomly assigned to the base or experiment arm for each
// query, independent of previous assignments for the same user.
RANDOM_QUERY = 2;
// Traffic is split using cookies to keep users in the same arm (base or
// experiment) of the experiment.
COOKIE = 3;
}
}

59
google/ads/googleads/v8/enums/campaign_experiment_type.proto
View file

@ -1,59 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CampaignExperimentTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing campaign experiment type.
// Container for enum describing campaign experiment type.
message CampaignExperimentTypeEnum {
// Indicates if this campaign is a normal campaign,
// a draft campaign, or an experiment campaign.
enum CampaignExperimentType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// This is a regular campaign.
BASE = 2;
// This is a draft version of a campaign.
// It has some modifications from a base campaign,
// but it does not serve or accrue metrics.
DRAFT = 3;
// This is an experiment version of a campaign.
// It has some modifications from a base campaign,
// and a percentage of traffic is being diverted
// from the BASE campaign to this experiment campaign.
EXPERIMENT = 4;
}
}

61
google/ads/googleads/v8/enums/campaign_serving_status.proto
View file

@ -1,61 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CampaignServingStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing Campaign serving statuses.
// 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;
}
}

50
google/ads/googleads/v8/enums/campaign_shared_set_status.proto
View file

@ -1,50 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CampaignSharedSetStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing campaign shared set statuses.
// Container for enum describing types of campaign shared set statuses.
message CampaignSharedSetStatusEnum {
// Enum listing the possible campaign shared set statuses.
enum CampaignSharedSetStatus {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// The campaign shared set is enabled.
ENABLED = 2;
// The campaign shared set is removed and can no longer be used.
REMOVED = 3;
}
}

53
google/ads/googleads/v8/enums/campaign_status.proto
View file

@ -1,53 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CampaignStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing campaign status.
// 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;
}
}

87
google/ads/googleads/v8/enums/change_client_type.proto
View file

@ -1,87 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ChangeClientTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing the sources that the change event resource was
// made through.
// Container for enum describing the sources that the change event resource
// was made through.
message ChangeClientTypeEnum {
// The source that the change_event resource was made through.
enum ChangeClientType {
// No value has been specified.
UNSPECIFIED = 0;
// Used for return value only. Represents an unclassified client type
// unknown in this version.
UNKNOWN = 1;
// Changes made through the "ads.google.com".
// For example, changes made through campaign management.
GOOGLE_ADS_WEB_CLIENT = 2;
// Changes made through Google Ads automated rules.
GOOGLE_ADS_AUTOMATED_RULE = 3;
// Changes made through Google Ads scripts.
GOOGLE_ADS_SCRIPTS = 4;
// Changes made by Google Ads bulk upload.
GOOGLE_ADS_BULK_UPLOAD = 5;
// Changes made by Google Ads API.
GOOGLE_ADS_API = 6;
// Changes made by Google Ads Editor.
GOOGLE_ADS_EDITOR = 7;
// Changes made by Google Ads mobile app.
GOOGLE_ADS_MOBILE_APP = 8;
// Changes made through Google Ads recommendations.
GOOGLE_ADS_RECOMMENDATIONS = 9;
// Changes made through Search Ads 360 Sync.
SEARCH_ADS_360_SYNC = 10;
// Changes made through Search Ads 360 Post.
SEARCH_ADS_360_POST = 11;
// Changes made through internal tools.
// For example, when a user sets a URL template on an entity like a
// Campaign, it's automatically wrapped with the SA360 Clickserver URL.
INTERNAL_TOOL = 12;
// Types of changes that are not categorized, for example,
// changes made by coupon redemption through Google Ads.
OTHER = 13;
}
}

94
google/ads/googleads/v8/enums/change_event_resource_type.proto
View file

@ -1,94 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ChangeEventResourceTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing the resource types the ChangeEvent resource supports.
// Container for enum describing supported resource types for the ChangeEvent
// resource.
message ChangeEventResourceTypeEnum {
// Enum listing the resource types support by the ChangeEvent resource.
enum ChangeEventResourceType {
// No value has been specified.
UNSPECIFIED = 0;
// Used for return value only. Represents an unclassified resource unknown
// in this version.
UNKNOWN = 1;
// An Ad resource change.
AD = 2;
// An AdGroup resource change.
AD_GROUP = 3;
// An AdGroupCriterion resource change.
AD_GROUP_CRITERION = 4;
// A Campaign resource change.
CAMPAIGN = 5;
// A CampaignBudget resource change.
CAMPAIGN_BUDGET = 6;
// An AdGroupBidModifier resource change.
AD_GROUP_BID_MODIFIER = 7;
// A CampaignCriterion resource change.
CAMPAIGN_CRITERION = 8;
// A Feed resource change.
FEED = 9;
// A FeedItem resource change.
FEED_ITEM = 10;
// A CampaignFeed resource change.
CAMPAIGN_FEED = 11;
// An AdGroupFeed resource change.
AD_GROUP_FEED = 12;
// An AdGroupAd resource change.
AD_GROUP_AD = 13;
// An Asset resource change.
ASSET = 14;
// A CustomerAsset resource change.
CUSTOMER_ASSET = 15;
// A CampaignAsset resource change.
CAMPAIGN_ASSET = 16;
// An AdGroupAsset resource change.
AD_GROUP_ASSET = 17;
}
}

54
google/ads/googleads/v8/enums/change_status_operation.proto
View file

@ -1,54 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ChangeStatusOperationProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing the change status operations.
// Container for enum describing operations for the ChangeStatus resource.
message ChangeStatusOperationEnum {
// Status of the changed resource
enum ChangeStatusOperation {
// No value has been specified.
UNSPECIFIED = 0;
// Used for return value only. Represents an unclassified resource unknown
// in this version.
UNKNOWN = 1;
// The resource was created.
ADDED = 2;
// The resource was modified.
CHANGED = 3;
// The resource was removed.
REMOVED = 4;
}
}

94
google/ads/googleads/v8/enums/change_status_resource_type.proto
View file

@ -1,94 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ChangeStatusResourceTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing the resource types the ChangeStatus resource supports.
// Container for enum describing supported resource types for the ChangeStatus
// resource.
message ChangeStatusResourceTypeEnum {
// Enum listing the resource types support by the ChangeStatus resource.
enum ChangeStatusResourceType {
// No value has been specified.
UNSPECIFIED = 0;
// Used for return value only. Represents an unclassified resource unknown
// in this version.
UNKNOWN = 1;
// An AdGroup resource change.
AD_GROUP = 3;
// An AdGroupAd resource change.
AD_GROUP_AD = 4;
// An AdGroupCriterion resource change.
AD_GROUP_CRITERION = 5;
// A Campaign resource change.
CAMPAIGN = 6;
// A CampaignCriterion resource change.
CAMPAIGN_CRITERION = 7;
// A Feed resource change.
FEED = 9;
// A FeedItem resource change.
FEED_ITEM = 10;
// An AdGroupFeed resource change.
AD_GROUP_FEED = 11;
// A CampaignFeed resource change.
CAMPAIGN_FEED = 12;
// An AdGroupBidModifier resource change.
AD_GROUP_BID_MODIFIER = 13;
// A SharedSet resource change.
SHARED_SET = 14;
// A CampaignSharedSet resource change.
CAMPAIGN_SHARED_SET = 15;
// An Asset resource change.
ASSET = 16;
// A CustomerAsset resource change.
CUSTOMER_ASSET = 17;
// A CampaignAsset resource change.
CAMPAIGN_ASSET = 18;
// An AdGroupAsset resource change.
AD_GROUP_ASSET = 19;
}
}

203
google/ads/googleads/v8/enums/click_type.proto
View file

@ -1,203 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ClickTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing click types.
// Container for enumeration of Google Ads click types.
message ClickTypeEnum {
// Enumerates Google Ads click types.
enum ClickType {
// Not specified.
UNSPECIFIED = 0;
// The value is unknown in this version.
UNKNOWN = 1;
// App engagement ad deep link.
APP_DEEPLINK = 2;
// Breadcrumbs.
BREADCRUMBS = 3;
// Broadband Plan.
BROADBAND_PLAN = 4;
// Manually dialed phone calls.
CALL_TRACKING = 5;
// Phone calls.
CALLS = 6;
// Click on engagement ad.
CLICK_ON_ENGAGEMENT_AD = 7;
// Driving direction.
GET_DIRECTIONS = 8;
// Get location details.
LOCATION_EXPANSION = 9;
// Call.
LOCATION_FORMAT_CALL = 10;
// Directions.
LOCATION_FORMAT_DIRECTIONS = 11;
// Image(s).
LOCATION_FORMAT_IMAGE = 12;
// Go to landing page.
LOCATION_FORMAT_LANDING_PAGE = 13;
// Map.
LOCATION_FORMAT_MAP = 14;
// Go to store info.
LOCATION_FORMAT_STORE_INFO = 15;
// Text.
LOCATION_FORMAT_TEXT = 16;
// Mobile phone calls.
MOBILE_CALL_TRACKING = 17;
// Print offer.
OFFER_PRINTS = 18;
// Other.
OTHER = 19;
// Product plusbox offer.
PRODUCT_EXTENSION_CLICKS = 20;
// Shopping - Product - Online.
PRODUCT_LISTING_AD_CLICKS = 21;
// Sitelink.
SITELINKS = 22;
// Show nearby locations.
STORE_LOCATOR = 23;
// Headline.
URL_CLICKS = 25;
// App store.
VIDEO_APP_STORE_CLICKS = 26;
// Call-to-Action overlay.
VIDEO_CALL_TO_ACTION_CLICKS = 27;
// Cards.
VIDEO_CARD_ACTION_HEADLINE_CLICKS = 28;
// End cap.
VIDEO_END_CAP_CLICKS = 29;
// Website.
VIDEO_WEBSITE_CLICKS = 30;
// Visual Sitelinks.
VISUAL_SITELINKS = 31;
// Wireless Plan.
WIRELESS_PLAN = 32;
// Shopping - Product - Local.
PRODUCT_LISTING_AD_LOCAL = 33;
// Shopping - Product - MultiChannel Local.
PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL = 34;
// Shopping - Product - MultiChannel Online.
PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE = 35;
// Shopping - Product - Coupon.
PRODUCT_LISTING_ADS_COUPON = 36;
// Shopping - Product - Sell on Google.
PRODUCT_LISTING_AD_TRANSACTABLE = 37;
// Shopping - Product - App engagement ad deep link.
PRODUCT_AD_APP_DEEPLINK = 38;
// Shopping - Showcase - Category.
SHOWCASE_AD_CATEGORY_LINK = 39;
// Shopping - Showcase - Local storefront.
SHOWCASE_AD_LOCAL_STOREFRONT_LINK = 40;
// Shopping - Showcase - Online product.
SHOWCASE_AD_ONLINE_PRODUCT_LINK = 42;
// Shopping - Showcase - Local product.
SHOWCASE_AD_LOCAL_PRODUCT_LINK = 43;
// Promotion Extension.
PROMOTION_EXTENSION = 44;
// Ad Headline.
SWIPEABLE_GALLERY_AD_HEADLINE = 45;
// Swipes.
SWIPEABLE_GALLERY_AD_SWIPES = 46;
// See More.
SWIPEABLE_GALLERY_AD_SEE_MORE = 47;
// Sitelink 1.
SWIPEABLE_GALLERY_AD_SITELINK_ONE = 48;
// Sitelink 2.
SWIPEABLE_GALLERY_AD_SITELINK_TWO = 49;
// Sitelink 3.
SWIPEABLE_GALLERY_AD_SITELINK_THREE = 50;
// Sitelink 4.
SWIPEABLE_GALLERY_AD_SITELINK_FOUR = 51;
// Sitelink 5.
SWIPEABLE_GALLERY_AD_SITELINK_FIVE = 52;
// Hotel price.
HOTEL_PRICE = 53;
// Price Extension.
PRICE_EXTENSION = 54;
// Book on Google hotel room selection.
HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION = 55;
// Shopping - Comparison Listing.
SHOPPING_COMPARISON_LISTING = 56;
}
}

51
google/ads/googleads/v8/enums/combined_audience_status.proto
View file

@ -1,51 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CombinedAudienceStatusProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing combined audience status.
// The status of combined audience.
message CombinedAudienceStatusEnum {
// Enum containing possible combined audience status types.
enum CombinedAudienceStatus {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Enabled status - combined audience is enabled and can be targeted.
ENABLED = 2;
// Removed status - combined audience is removed and cannot be used for
// targeting.
REMOVED = 3;
}
}

89
google/ads/googleads/v8/enums/content_label_type.proto
View file

@ -1,89 +0,0 @@
// Copyright 2021 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.v8.enums;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V8.Enums";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v8/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ContentLabelTypeProto";
option java_package = "com.google.ads.googleads.v8.enums";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V8\\Enums";
option ruby_package = "Google::Ads::GoogleAds::V8::Enums";
// Proto file describing content label types.
// Container for enum describing content label types in ContentLabel.
message ContentLabelTypeEnum {
// Enum listing the content label types supported by ContentLabel criterion.
enum ContentLabelType {
// Not specified.
UNSPECIFIED = 0;
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
// Sexually suggestive content.
SEXUALLY_SUGGESTIVE = 2;
// Below the fold placement.
BELOW_THE_FOLD = 3;
// Parked domain.
PARKED_DOMAIN = 4;
// Juvenile, gross & bizarre content.
JUVENILE = 6;
// Profanity & rough language.
PROFANITY = 7;
// Death & tragedy.
TRAGEDY = 8;
// Video.
VIDEO = 9;
// Content rating: G.
VIDEO_RATING_DV_G = 10;
// Content rating: PG.
VIDEO_RATING_DV_PG = 11;
// Content rating: T.
VIDEO_RATING_DV_T = 12;
// Content rating: MA.
VIDEO_RATING_DV_MA = 13;
// Content rating: not yet rated.
VIDEO_NOT_YET_RATED = 14;
// Embedded video.
EMBEDDED_VIDEO = 15;
// Live streaming video.
LIVE_STREAMING_VIDEO = 16;
// Sensitive social issues.
SOCIAL_ISSUES = 17;
}
}

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