google/ads/googleads/v0/resources/campaign_criterion.proto


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

// Copyright 2018 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.


// Proto file describing the Campaign Criterion resource.
syntax = "proto3";

package google.ads.googleads.v0.resources;

import "google/ads/googleads/v0/common/criteria.proto";
import "google/ads/googleads/v0/enums/criterion_type.proto";
import "google/protobuf/wrappers.proto";

option java_package = "com.google.ads.googleads.v0.resources";
option java_outer_classname = "CampaignCriterionProto";
option java_multiple_files = true;

// Objective-C prefix. Google Ads API.
option objc_class_prefix = "GAA";
option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
option php_metadata_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";

// A campaign criterion.
message CampaignCriterion {

  // The resource name of the campaign criterion.
  // Campaign criterion resource names have the form:
  //
  // `customers/{customer_id}/campaignCriteria/{campaign_id}_{criterion_id}
  string resource_name = 1;

  // The campaign to which the criterion belongs.
  //
  // This field must not be used in WHERE clauses.
  google.protobuf.StringValue campaign = 4;

  // The ID of the criterion.
  //
  // This field is ignored during mutate.
  google.protobuf.Int64Value criterion_id = 5;

  // The modifier for the bids when the criterion matches.
  // Allowable modifier values depend on the criterion:
  //  - 0.1 - 10.0: Location
  //  - 0.1 - 4.0: Platform (mobile). Use 0 to opt out of mobile.
  google.protobuf.FloatValue bid_modifier = 14;

  // Whether to target (`false`) or exclude (`true`) the criterion.
  google.protobuf.BoolValue negative = 7;

  // The type of the criterion.
  enums.CriterionTypeEnum.CriterionType type = 6;

  // The campaign criterion.
  //
  // Exactly one must be set.
  oneof criterion {

    // Keyword.
    common.KeywordInfo keyword = 8;

    // Location.
    common.LocationInfo location = 12;

    // Platform.
    common.PlatformInfo platform = 13;
  }
}