properties_android_app_data_streams_measurement_protocol_secrets_update.py

#!/usr/bin/env python

# Copyright 2021 Google Inc. All Rights Reserved.
#
# 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.

"""Google Analytics Admin API sample application which updates the measurement
protocol secret for the Android app data stream.

See https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.androidAppDataStreams.measurementProtocolSecrets/patch
for more information.
"""
# [START analyticsadmin_properties_android_app_data_streams_measurement_protocol_secrets_update]
from google.analytics.admin import AnalyticsAdminServiceClient
from google.analytics.admin_v1alpha import MeasurementProtocolSecret
from google.protobuf.field_mask_pb2 import FieldMask


def run_sample():
    """Runs the sample."""

    # !!! ATTENTION !!!
    #  Running this sample may change/delete your Google Analytics account
    #  configuration. Make sure to not use the Google Analytics property ID from
    #  your production environment below.

    # TODO(developer): Replace this variable with your Google Analytics 4
    #  property ID (e.g. "123456") before running the sample.
    property_id = "YOUR-GA4-PROPERTY-ID"

    # TODO(developer): Replace this variable with your Android app data stream ID
    #  (e.g. "123456") before running the sample.
    stream_id = "YOUR-ANDROID-APP-DATA-STREAM-ID"

    # TODO(developer): Replace this variable with your measurement protocol
    #  secret ID (e.g. "123456") before running the sample.
    secret_id = "YOUR-MEASUREMENT-PROTOCOL-SECRET-ID"

    update_measurement_protocol_secret(property_id, stream_id, secret_id)


def update_measurement_protocol_secret(property_id, stream_id, secret_id):
    """Updates the measurement protocol secret."""
    client = AnalyticsAdminServiceClient()
    # This call updates the display name of the measurement protocol secret, as
    # indicated by the value of the `update_mask` field. The measurement
    # protocol secret to update is specified in the `name` field of the
    # `MeasurementProtocolSecret` instance.
    measurement_protocol_secret = client.update_measurement_protocol_secret(
        measurement_protocol_secret=MeasurementProtocolSecret(
            name=f"properties/{property_id}/androidAppDataStreams/{stream_id}/measurementProtocolSecrets/{secret_id}",
            display_name="This is an updated measurement protocol secret",
        ),
        update_mask=FieldMask(paths=["display_name"]),
    )

    print("Result:")
    print(f"Resource name: {measurement_protocol_secret.name}")
    print(f"Secret value: {measurement_protocol_secret.secret_value}")
    print(f"Display name: {measurement_protocol_secret.display_name}")


# [END analyticsadmin_properties_android_app_data_streams_measurement_protocol_secrets_update]


if __name__ == "__main__":
    run_sample()