kpt-grpc-demo/google/ads/googleads/v11/resources/audience.proto

// Copyright 2022 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.v11.resources;

import "google/ads/googleads/v11/common/audiences.proto";
import "google/ads/googleads/v11/enums/audience_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";

option csharp_namespace = "Google.Ads.GoogleAds.V11.Resources";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v11/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AudienceProto";
option java_package = "com.google.ads.googleads.v11.resources";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V11\\Resources";
option ruby_package = "Google::Ads::GoogleAds::V11::Resources";

// Proto file describing the Audience resource.

// Audience is an effective targeting option that lets you
// intersect different segment attributes, such as detailed demographics and
// affinities, to create audiences that represent sections of your target
// segments.
message Audience {
  option (google.api.resource) = {
    type: "googleads.googleapis.com/Audience"
    pattern: "customers/{customer_id}/audiences/{audience_id}"
  };

  // Immutable. The resource name of the audience.
  // Audience names have the form:
  //
  // `customers/{customer_id}/audiences/{audience_id}`
  string resource_name = 1 [
    (google.api.field_behavior) = IMMUTABLE,
    (google.api.resource_reference) = {
      type: "googleads.googleapis.com/Audience"
    }
  ];

  // Output only. ID of the audience.
  int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. Status of this audience. Indicates whether the audience
  // is enabled or removed.
  google.ads.googleads.v11.enums.AudienceStatusEnum.AudienceStatus status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Required. Name of the audience. It should be unique across all
  // audiences. It must have a minimum length of 1 and
  // maximum length of 255.
  string name = 4 [(google.api.field_behavior) = REQUIRED];

  // Description of this audience.
  string description = 5;

  // Positive dimensions specifying the audience composition.
  repeated google.ads.googleads.v11.common.AudienceDimension dimensions = 6;

  // Negative dimension specifying the audience composition.
  google.ads.googleads.v11.common.AudienceExclusionDimension exclusion_dimension = 7;
}