Google Ads API set campaign goal

set_campaign_goal.py

#!/usr/bin/env python
# Copyright 2018 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
#
#     https://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.


import argparse
import sys

from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
from google.api_core import protobuf_helpers


def main(client, customer_id, campaign_id):
    campaign_goal_service = client.get_service("CampaignConversionGoalService")

    campaign_goal_operation = client.get_type("CampaignConversionGoalOperation")
    campaign_goal = campaign_goal_operation.update

    category = 'DOWNLOAD'
    origin = 'APP'
    campaign_goal.resource_name = campaign_goal_service.campaign_conversion_goal_path(
                customer_id,
                campaign_id,
                category,
                origin
            )

    campaign_goal.biddable = False

    client.copy_from(
        campaign_goal_operation.update_mask,
        protobuf_helpers.field_mask(None, campaign_goal._pb),
    )

    response = campaign_goal_service.mutate_campaign_conversion_goals(
        customer_id=customer_id, operations=[campaign_goal_operation]
    )

    print(f"Updated campaign {response.results[0].resource_name}.")

if __name__ == "__main__":
    # GoogleAdsClient will read the google-ads.yaml configuration file in the
    # home directory if none is specified.
    googleads_client = GoogleAdsClient.load_from_storage(version="v15")

    parser = argparse.ArgumentParser(
        description="Updates the given campaign for the specified customer."
    )
    # The following argument(s) should be provided to run the example.
    parser.add_argument(
        "-c",
        "--customer_id",
        type=str,
        required=True,
        help="The Google Ads customer ID.",
    )
    parser.add_argument(
        "-i", "--campaign_id", type=str, required=True, help="The campaign ID."
    )
    args = parser.parse_args()

    try:
        main(googleads_client, args.customer_id, args.campaign_id)
    except GoogleAdsException as ex:
        print(
            f'Request with ID "{ex.request_id}" failed with status '
            f'"{ex.error.code().name}" and includes the following errors:'
        )
        for error in ex.failure.errors:
            print(f'\tError with message "{error.message}".')
            if error.location:
                for field_path_element in error.location.field_path_elements:
                    print(f"\t\tOn field: {field_path_element.field_name}")
        sys.exit(1)