// Copyright 2026 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.datamanager.v1;

import "google/api/field_behavior.proto";

option csharp_namespace = "Google.Ads.DataManager.V1";
option go_package = "cloud.google.com/go/datamanager/apiv1/datamanagerpb;datamanagerpb";
option java_multiple_files = true;
option java_outer_classname = "EncryptedUserIdProto";
option java_package = "com.google.ads.datamanager.v1";
option php_namespace = "Google\\Ads\\DataManager\\V1";
option ruby_package = "Google::Ads::DataManager::V1";

// A user identifier issued to be used for attribution. All fields are
// required if this is used.
message EncryptedUserId {
  // The encryption entity type.
  enum EncryptionEntityType {
    // Unspecified encryption entity type.
    ENCRYPTION_ENTITY_TYPE_UNSPECIFIED = 0;

    // Campaign Manager 360 account.
    CAMPAIGN_MANAGER_ACCOUNT = 1;

    // Campaign Manager 360 advertiser.
    CAMPAIGN_MANAGER_ADVERTISER = 2;

    // Display & Video 360 partner.
    DISPLAY_VIDEO_PARTNER = 3;

    // Display & Video 360 advertiser.
    DISPLAY_VIDEO_ADVERTISER = 4;

    // Google Ads customer.
    GOOGLE_ADS_CUSTOMER = 5;

    // Google Ad Manager network code.
    GOOGLE_AD_MANAGER_NETWORK_CODE = 6;
  }

  // The encryption source.
  enum EncryptionSource {
    // Unspecified encryption source.
    ENCRYPTION_SOURCE_UNSPECIFIED = 0;

    // Ad serving encryption source.
    AD_SERVING = 1;

    // Data transfer encryption source.
    DATA_TRANSFER = 2;
  }

  // Required. The alphanumeric encrypted id.
  string encrypted_id = 1 [(google.api.field_behavior) = REQUIRED];

  // Required. The encryption entity type. This should match the encryption
  // configuration for ad serving or Data Transfer.
  EncryptionEntityType entity_type = 2 [(google.api.field_behavior) = REQUIRED];

  // Required. The encryption entity ID. This should match the encryption
  // configuration for ad serving or Data Transfer.
  int64 entity_id = 3 [(google.api.field_behavior) = REQUIRED];

  // Required. Describes whether the encrypted cookie was received from ad
  // serving (the %m macro) or from Data Transfer.
  EncryptionSource source = 4 [(google.api.field_behavior) = REQUIRED];
}