properties_google_ads_links_delete.py

#!/usr/bin/env python

# Copyright 2021 Google LLC 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 deletes the Google Ads link
from the specified Google Analytics 4 property.

See https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.googleAdsLinks/delete
for more information.
"""
# [START analyticsadmin_properties_google_ads_links_delete]
from google.analytics.admin import AnalyticsAdminServiceClient


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 Google Analytics Ads
    #  link ID (e.g. "123456") before running the sample.
    google_ads_link_id = "YOUR-GOOGLE-ADS-LINK-ID"

    delete_google_ads_link(property_id, google_ads_link_id)


def delete_google_ads_link(
    property_id: str, google_ads_link_id: str, transport: str = None
):
    """
    Deletes the Google Ads link.

    Args:
        property_id(str): The Google Analytics Property ID.
        google_ads_link_id(str): The Google Analytics Ads Link Id.
        transport(str): The transport to use. For example, "grpc"
            or "rest". If set to None, a transport is chosen automatically.
    """
    client = AnalyticsAdminServiceClient(transport=transport)
    client.delete_google_ads_link(
        name=f"properties/{property_id}/googleAdsLinks/{google_ads_link_id}"
    )
    print("Google Ads link deleted")


# [END analyticsadmin_properties_google_ads_links_delete]


if __name__ == "__main__":
    run_sample()