Sharing Campaign Budgets

A budget can be applied to a single campaign, or be shared across many campaigns.

Setup

When you create a new CampaignBudget using the Google Ads API, you can specify if it is shareable with the BoolValue of the explicitly_shared field:

  • true (default): can be shared among multiple campaigns
  • false: can be used by only one campaign

Explicitly shared budgets appear in an account's Shared Library in the Google Ads UI, whereas a non-shared budget appears only within its associated campaign's Settings.

In the following example where a new budget is created, the budget is shared because explicitly_shared is set to true.

Java

private String createSharedCampaignBudget(GoogleAdsClient googleAdsClient, long customerId) {
  try (CampaignBudgetServiceClient campaignBudgetServiceClient =
      googleAdsClient.getLatestVersion().createCampaignBudgetServiceClient()) {
    // Creates a shared budget.
    CampaignBudget budget =
        CampaignBudget.newBuilder()
            .setName("Shared Interplanetary Budget #" + System.currentTimeMillis())
            .setAmountMicros(50_000_000L)
            .setDeliveryMethod(BudgetDeliveryMethod.STANDARD)
            .setExplicitlyShared(true)
            .build();
    // Constructs an operation that will create a shared budget.
    CampaignBudgetOperation operation =
        CampaignBudgetOperation.newBuilder().setCreate(budget).build();
    // Sends the operation in a mutate request.
    MutateCampaignBudgetsResponse response =
        campaignBudgetServiceClient.mutateCampaignBudgets(
            Long.toString(customerId), Lists.newArrayList(operation));

    MutateCampaignBudgetResult mutateCampaignBudgetResult = response.getResults(0);
    // Prints the resource name of the created object.
    System.out.printf(
        "Created shared budget with resource name: '%s'.%n",
        mutateCampaignBudgetResult.getResourceName());

    return mutateCampaignBudgetResult.getResourceName();
  }
}

C#

private string CreateSharedBudget(GoogleAdsClient client, long customerId, string name,
    long amount)
{
    // Get the CampaignBudgetService.
    CampaignBudgetServiceClient campaignBudgetService =
        client.GetService(Services.V5.CampaignBudgetService);

    // Create a shared budget.
    CampaignBudget budget = new CampaignBudget()
    {
        Name = name,
        AmountMicros = amount,
        DeliveryMethod = BudgetDeliveryMethodEnum.Types.BudgetDeliveryMethod.Standard,
        ExplicitlyShared = true
    };

    // Create the operation.
    CampaignBudgetOperation campaignBudgetOperation = new CampaignBudgetOperation()
    {
        Create = budget
    };

    // Make the mutate request.
    MutateCampaignBudgetsResponse retVal = campaignBudgetService.MutateCampaignBudgets(
        customerId.ToString(), new CampaignBudgetOperation[] { campaignBudgetOperation });
    return retVal.Results[0].ResourceName;
}

PHP

private static function createSharedCampaignBudget(
    GoogleAdsClient $googleAdsClient,
    int $customerId
) {
    // Creates a shared budget.
    $budget = new CampaignBudget([
        'name' => 'Shared Interplanetary Budget #' . uniqid(),
        'delivery_method' => BudgetDeliveryMethod::STANDARD,
        // Sets the amount of budget.
        'amount_micros' => 50000000,
        // Makes the budget explicitly shared.
        'explicitly_shared' => true
    ]);

    // Constructs a campaign budget operation.
    $campaignBudgetOperation = new CampaignBudgetOperation();
    $campaignBudgetOperation->setCreate($budget);

    // Issues a mutate request to create the budget.
    $campaignBudgetServiceClient = $googleAdsClient->getCampaignBudgetServiceClient();
    $response = $campaignBudgetServiceClient->mutateCampaignBudgets(
        $customerId,
        [$campaignBudgetOperation]
    );

    /** @var CampaignBudget $addedBudget */
    $addedBudget = $response->getResults()[0];
    printf(
        "Created a shared budget with resource name '%s'.%s",
        $addedBudget->getResourceName(),
        PHP_EOL
    );

    return $addedBudget->getResourceName();
}

Python

# Create a budget, which can be shared by multiple campaigns.
campaign_budget_operation = client.get_type(
    "CampaignBudgetOperation", version="v5"
)
campaign_budget = campaign_budget_operation.create
campaign_budget.name = "Interplanetary Budget %s" % uuid.uuid4()
campaign_budget.delivery_method = client.get_type(
    "BudgetDeliveryMethodEnum"
).STANDARD
campaign_budget.amount_micros = 500000
campaign_budget.explicitly_shared = True

# Add budget.
try:
    campaign_budget_response = campaign_budget_service.mutate_campaign_budgets(
        customer_id, [campaign_budget_operation]
    )
except google.ads.google_ads.errors.GoogleAdsException as ex:
    print(
        'Request with ID "%s" failed with status "%s" and includes the '
        "following errors:" % (ex.request_id, ex.error.code().name)
    )
    for error in ex.failure.errors:
        print('\tError with message "%s".' % error.message)
        if error.location:
            for field_path_element in error.location.field_path_elements:
                print("\t\tOn field: %s" % field_path_element.field_name)
    sys.exit(1)

Ruby

# Create a budget, which can be shared by multiple campaigns.
budget = client.resource.campaign_budget do |cb|
  cb.name = "Interplanetary budget ##{(Time.new.to_f * 1000).to_i}"
  cb.amount_micros = 50_000_000
  cb.delivery_method = :STANDARD
  cb.explicitly_shared = true
end

operation = client.operation.create_resource.campaign_budget(budget)

response = client.service.campaign_budget.mutate_campaign_budgets(
  customer_id: customer_id,
  operations: [operation],
)
budget_id = response.results.first.resource_name

Perl

sub create_shared_campaign_buget {
  my ($api_client, $customer_id) = @_;

  # Create a shared budget.
  my $campaign_budget =
    Google::Ads::GoogleAds::V5::Resources::CampaignBudget->new({
      name           => "Shared Interplanetary Budget #" . uniqid(),
      deliveryMethod => STANDARD,
      # Set the amount of budget.
      amountMicros => 50000000,
      # Makes the budget explicitly shared.
      explicitlyShared => 'true'
    });

  # Create a campaign budget operation.
  my $campaign_budget_operation =
    Google::Ads::GoogleAds::V5::Services::CampaignBudgetService::CampaignBudgetOperation
    ->new({create => $campaign_budget});

  # Add the campaign budget.
  my $campaign_budget_response = $api_client->CampaignBudgetService()->mutate({
      customerId => $customer_id,
      operations => [$campaign_budget_operation]});

  my $campaign_budget_resource_name =
    $campaign_budget_response->{results}[0]{resourceName};

  printf "Created a shared budget with resource name: '%s'.\n",
    $campaign_budget_resource_name;

  return $campaign_budget_resource_name;
}

Determine if a campaign budget is shared

You can retrieve the budget setting value by searching for the campaign_budget.explicitly_shared field. Here is the GAQL query for the field, filtering on a budget ID:

SELECT campaign_budget.explicitly_shared
FROM campaign_budget
WHERE campaign_budget.id = campaign_budget_id