// Copyright 2024 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.v17.resources;

import "google/ads/googleads/v17/enums/android_privacy_interaction_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";

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

// Proto file describing the AndroidPrivacySharedKeyGoogleCampaign resource.

// An Android privacy shared key view for Google campaign key.
message AndroidPrivacySharedKeyGoogleCampaign {
  option (google.api.resource) = {
    type: "googleads.googleapis.com/AndroidPrivacySharedKeyGoogleCampaign"
    pattern: "customers/{customer_id}/androidPrivacySharedKeyGoogleCampaigns/{campaign_id}~{android_privacy_interaction_type}~{android_privacy_interaction_date}"
  };

  // Output only. The resource name of the Android privacy shared key.
  // Android privacy shared key resource names have the form:
  //
  // `customers/{customer_id}/androidPrivacySharedKeyGoogleCampaigns/{campaign_id}~{android_privacy_interaction_type}~{android_privacy_interaction_date(yyyy-mm-dd)}`
  string resource_name = 1 [
    (google.api.field_behavior) = OUTPUT_ONLY,
    (google.api.resource_reference) = {
      type: "googleads.googleapis.com/AndroidPrivacySharedKeyGoogleCampaign"
    }
  ];

  // Output only. The campaign ID used in the share key encoding.
  int64 campaign_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The interaction type enum used in the share key encoding.
  google.ads.googleads.v17.enums.AndroidPrivacyInteractionTypeEnum
      .AndroidPrivacyInteractionType android_privacy_interaction_type = 3
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The interaction date used in the shared key encoding in the
  // format of "YYYY-MM-DD" in UTC timezone.
  string android_privacy_interaction_date = 4
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. 128 bit hex string of the encoded shared campaign key,
  // including a '0x' prefix. This key can be used to do a bitwise OR operator
  // with the aggregate conversion key to create a full aggregation key to
  // retrieve the Aggregate API Report in Android Privacy Sandbox.
  string shared_campaign_key = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
}
