com.google.ads.googleads.v17.resources.AndroidPrivacySharedKeyGoogleAdGroupOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/resources/android_privacy_shared_key_google_ad_group.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.resources;

public interface AndroidPrivacySharedKeyGoogleAdGroupOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.AndroidPrivacySharedKeyGoogleAdGroup)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Output only. The resource name of the Android privacy shared key.
   * Android privacy shared key resource names have the form:
   *
   * `customers/{customer_id}/androidPrivacySharedKeyGoogleAdGroups/{campaign_id}~{ad_group_id}~{android_privacy_interaction_type}~{android_privacy_network_type}~{android_privacy_interaction_date(yyyy-mm-dd)}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The resourceName.
   */
  java.lang.String getResourceName();
  /**
   *    * Output only. The resource name of the Android privacy shared key.
   * Android privacy shared key resource names have the form:
   *
   * `customers/{customer_id}/androidPrivacySharedKeyGoogleAdGroups/{campaign_id}~{ad_group_id}~{android_privacy_interaction_type}~{android_privacy_network_type}~{android_privacy_interaction_date(yyyy-mm-dd)}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

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

  /**
   *    * 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];
   * @return The enum numeric value on the wire for androidPrivacyInteractionType.
   */
  int getAndroidPrivacyInteractionTypeValue();
  /**
   *    * 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];
   * @return The androidPrivacyInteractionType.
   */
  com.google.ads.googleads.v17.enums.AndroidPrivacyInteractionTypeEnum.AndroidPrivacyInteractionType getAndroidPrivacyInteractionType();

  /**
   *    * 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];
   * @return The androidPrivacyInteractionDate.
   */
  java.lang.String getAndroidPrivacyInteractionDate();
  /**
   *    * 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];
   * @return The bytes for androidPrivacyInteractionDate.
   */
  com.google.protobuf.ByteString
      getAndroidPrivacyInteractionDateBytes();

  /**
   *    * Output only. The network type enum used in the share key encoding.
   * 
   *
   * .google.ads.googleads.v17.enums.AndroidPrivacyNetworkTypeEnum.AndroidPrivacyNetworkType android_privacy_network_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for androidPrivacyNetworkType.
   */
  int getAndroidPrivacyNetworkTypeValue();
  /**
   *    * Output only. The network type enum used in the share key encoding.
   * 
   *
   * .google.ads.googleads.v17.enums.AndroidPrivacyNetworkTypeEnum.AndroidPrivacyNetworkType android_privacy_network_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The androidPrivacyNetworkType.
   */
  com.google.ads.googleads.v17.enums.AndroidPrivacyNetworkTypeEnum.AndroidPrivacyNetworkType getAndroidPrivacyNetworkType();

  /**
   *    * Output only. The ad group ID used in the share key encoding.
   * 
   *
   * int64 ad_group_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The adGroupId.
   */
  long getAdGroupId();

  /**
   *    * Output only. 128 bit hex string of the encoded shared ad group 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_ad_group_key = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The sharedAdGroupKey.
   */
  java.lang.String getSharedAdGroupKey();
  /**
   *    * Output only. 128 bit hex string of the encoded shared ad group 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_ad_group_key = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The bytes for sharedAdGroupKey.
   */
  com.google.protobuf.ByteString
      getSharedAdGroupKeyBytes();
}