Interested in sharing your feedback about the Google Ads API?
Sign up to be invited to participate in user research!
AndroidPrivacySharedKeyGoogleAdGroup
An Android privacy shared key view for Google ad group key.
| Fields |
resource_name
|
string
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)}
|
campaign_id
|
int64
Output only. The campaign ID used in the share key encoding.
|
android_privacy_interaction_type
|
AndroidPrivacyInteractionType
Output only. The interaction type enum used in the share key encoding.
|
android_privacy_interaction_date
|
string
Output only. The interaction date used in the shared key encoding in the format of "YYYY-MM-DD" in UTC timezone.
|
android_privacy_network_type
|
AndroidPrivacyNetworkType
Output only. The network type enum used in the share key encoding.
|
ad_group_id
|
int64
Output only. The ad group ID used in the share key encoding.
|
shared_ad_group_key
|
string
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-25 UTC.
[null,null,["Last updated 2025-02-25 UTC."],[[["The Android privacy shared key view provides a secure way to access aggregated campaign data in the Android Privacy Sandbox."],["It uses a 128-bit hex encoded key (`shared_ad_group_key`) that combines information like campaign ID, ad group ID, interaction type, network type, and interaction date."],["This shared key, when combined with an aggregate conversion key, enables retrieval of aggregated reports via the Aggregate API."],["The resource name follows a specific format: `customers/{customer_id}/androidPrivacySharedKeyGoogleAdGroups/{campaign_id}~{ad_group_id}~{android_privacy_interaction_type}~{android_privacy_network_type}~{android_privacy_interaction_date(yyyy-mm-dd)}`."]]],["This document details an Android privacy shared key for Google ad groups. Key information includes the `resource_name`, formatted as `customers/{customer_id}/...`, along with `campaign_id` and `ad_group_id`. The `android_privacy_interaction_type`, `android_privacy_interaction_date` (in YYYY-MM-DD format), and `android_privacy_network_type` are also specified. A `shared_ad_group_key`, a 128-bit hex string, is provided to merge with an aggregate conversion key for retrieving an Aggregate API Report in Android Privacy Sandbox.\n"]]
