kratos/third_party/google/ads/googleads/v1/resources/customer.proto

// Copyright 2019 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.v1.resources;

import "google/ads/googleads/v1/enums/customer_pay_per_conversion_eligibility_failure_reason.proto";
import "google/protobuf/wrappers.proto";
import "google/api/annotations.proto";

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

// Proto file describing the Customer resource.

// A customer.
message Customer {
  // The resource name of the customer.
  // Customer resource names have the form:
  //
  // `customers/{customer_id}`
  string resource_name = 1;

  // The ID of the customer.
  google.protobuf.Int64Value id = 3;

  // Optional, non-unique descriptive name of the customer.
  google.protobuf.StringValue descriptive_name = 4;

  // The currency in which the account operates.
  // A subset of the currency codes from the ISO 4217 standard is
  // supported.
  google.protobuf.StringValue currency_code = 5;

  // The local timezone ID of the customer.
  google.protobuf.StringValue time_zone = 6;

  // The URL template for constructing a tracking URL out of parameters.
  google.protobuf.StringValue tracking_url_template = 7;

  // The URL template for appending params to the final URL
  google.protobuf.StringValue final_url_suffix = 11;

  // Whether auto-tagging is enabled for the customer.
  google.protobuf.BoolValue auto_tagging_enabled = 8;

  // Whether the Customer has a Partners program badge. If the Customer is not
  // associated with the Partners program, this will be false. For more
  // information, see https://support.google.com/partners/answer/3125774.
  google.protobuf.BoolValue has_partners_badge = 9;

  // Whether the customer is a manager.
  google.protobuf.BoolValue manager = 12;

  // Whether the customer is a test account.
  google.protobuf.BoolValue test_account = 13;

  // Call reporting setting for a customer.
  CallReportingSetting call_reporting_setting = 10;

  // Conversion tracking setting for a customer.
  ConversionTrackingSetting conversion_tracking_setting = 14;

  // Remarketing setting for a customer.
  RemarketingSetting remarketing_setting = 15;

  // Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If
  // the list is empty, the customer is eligible. This field is read-only.
  repeated google.ads.googleads.v1.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16;
}

// Call reporting setting for a customer.
message CallReportingSetting {
  // Enable reporting of phone call events by redirecting them via Google
  // System.
  google.protobuf.BoolValue call_reporting_enabled = 1;

  // Whether to enable call conversion reporting.
  google.protobuf.BoolValue call_conversion_reporting_enabled = 2;

  // Customer-level call conversion action to attribute a call conversion to.
  // If not set a default conversion action is used. Only in effect when
  // call_conversion_reporting_enabled is set to true.
  google.protobuf.StringValue call_conversion_action = 9;
}

// A collection of customer-wide settings related to Google Ads Conversion
// Tracking.
message ConversionTrackingSetting {
  // The conversion tracking id used for this account. This id is automatically
  // assigned after any conversion tracking feature is used. If the customer
  // doesn't use conversion tracking, this is 0. This field is read-only.
  google.protobuf.Int64Value conversion_tracking_id = 1;

  // The conversion tracking id of the customer's manager. This is set when the
  // customer is opted into cross account conversion tracking, and it overrides
  // conversion_tracking_id. This field can only be managed through the Google
  // Ads UI. This field is read-only.
  google.protobuf.Int64Value cross_account_conversion_tracking_id = 2;
}

// Remarketing setting for a customer.
message RemarketingSetting {
  // The Google global site tag.
  google.protobuf.StringValue google_global_site_tag = 1;
}