Skip to content

Port the experiments examples to .NET #645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Raibaz merged 3 commits into from
May 21, 2026
Merged

Port the experiments examples to .NET #645

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
352956b
Port the experiments examples to .NET
Raibaz May 19, 2026
2802d71
Update with the latest changes from the python code example
Raibaz May 20, 2026
4393d8d
Merge branch 'main' into experiments-examples
Raibaz May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 31 additions & 24 deletions ...es/CampaignManagement/CreateExperiment.cs → ...periments/CreateSearchCustomExperiment.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2022 Google LLC
// Copyright 2026 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -28,13 +28,19 @@
namespace Google.Ads.GoogleAds.Examples.V24
{
/// <summary>
/// This code example creates a new experiment, experiment arms, and demonstrates
/// how to modify the draft campaign as well as begin the experiment.
/// This code example creates a standard, system-managed campaign experiment.
/// It demonstrates how to create an experiment, configure its control and treatment
/// arms (where the treatment arm automatically generates a draft campaign), modify
/// the system-generated draft campaign, and schedule the experiment.
///
/// Note: This standard draft-based workflow does not apply to all experiment types
/// (e.g., intra-campaign or asset optimization experiments) that do not use system-generated
/// treatment campaign copies.
/// </summary>
public class CreateExperiment : ExampleBase
public class CreateSearchCustomExperiment : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="CreateExperiment"/> example.
/// Command line options for running the <see cref="CreateSearchCustomExperiment"/> example.
/// </summary>
public class Options : OptionsBase
{
Expand All @@ -61,17 +67,18 @@ public static void Main(string[] args)
{
Options options = ExampleUtilities.ParseCommandLine<Options>(args);

CreateExperiment codeExample = new CreateExperiment();
Console.WriteLine(codeExample.Description);
CreateSearchCustomExperiment codeExample = new CreateSearchCustomExperiment();
Console.WriteLine(codeExample.Description);
codeExample.Run(new GoogleAdsClient(), options.CustomerId, options.BaseCampaignId);
}

/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description =>
"This code example creates a new experiment, experiment arms, and demonstrates how " +
"to modify the draft campaign as well as begin the experiment.";
"This code example creates a standard, system-managed campaign experiment. " +
"It demonstrates how to create an experiment, configure its control and treatment arms, " +
"modify the system-generated draft campaign, and schedule the experiment.";

/// <summary>
/// Runs the code example.
Expand All @@ -87,7 +94,7 @@ public void Run(GoogleAdsClient client, long customerId, long baseCampaignId)

try
{
string experimentResourceName = CreateAnExperiment(client, customerId);
string experimentResourceName = CreateExperimentResource(client, customerId);
MutateExperimentArmResult controlArm, treatmentArm;

(controlArm, treatmentArm) = CreateExperimentArms(
Expand All @@ -109,15 +116,15 @@ public void Run(GoogleAdsClient client, long customerId, long baseCampaignId)
throw;
}
}

// [START create_experiment_1]

/// <summary>
/// Creates the experiment.
/// Creates the experiment resource.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The customer ID for which the call is made.</param>
/// <returns>The resource name of the newly created experiment.</returns>
private static string CreateAnExperiment(GoogleAdsClient client, long customerId)
// [START create_experiment_1]
private static string CreateExperimentResource(GoogleAdsClient client, long customerId)
{
// Get the ExperimentService.
ExperimentServiceClient experimentService = client.GetService(
Expand All @@ -128,6 +135,9 @@ private static string CreateAnExperiment(GoogleAdsClient client, long customerId
{
// Name must be unique.
Name = $"Example Experiment #{ExampleUtilities.GetRandomString()}",
// We specify SearchCustom to create a standard search campaign experiment.
// This type uses a standard draft-based workflow where the system automatically
// creates a draft/in-design campaign for the treatment arm.
Type = ExperimentType.SearchCustom,
Suffix = "[experiment]",
Status = ExperimentStatus.Setup
Expand All @@ -150,10 +160,8 @@ private static string CreateAnExperiment(GoogleAdsClient client, long customerId
$"'{experimentResourceName}'.");
return experimentResourceName;
}

// [END create_experiment_1]

// [START create_experiment_2]

/// <summary>
/// Creates the experiment arms.
/// </summary>
Expand All @@ -163,6 +171,7 @@ private static string CreateAnExperiment(GoogleAdsClient client, long customerId
/// created.</param>
/// <param name="experimentResourceName">Resource name of the experiment.</param>
/// <returns>The control and treatment arms.</returns>
// [START create_experiment_2]
private static (MutateExperimentArmResult, MutateExperimentArmResult)
CreateExperimentArms(GoogleAdsClient client, long customerId, long baseCampaignId,
string experimentResourceName)
Expand All @@ -186,9 +195,9 @@ private static (MutateExperimentArmResult, MutateExperimentArmResult)
}
};

// Create the non-control arm. The non-"control" arm, also called a "treatment" arm,
// will automatically generate draft campaigns that you can modify before starting the
// experiment.
// Create the non-control arm.
// In standard campaign experiments, creating the treatment arm automatically
// generates a draft campaign that you can modify before starting the experiment.
ExperimentArmOperation treatmentArmOperation = new ExperimentArmOperation()
{
Create = new ExperimentArm()
Expand All @@ -210,7 +219,6 @@ private static (MutateExperimentArmResult, MutateExperimentArmResult)
ResponseContentType = ResponseContentType.MutableResource
};


MutateExperimentArmsResponse response = experimentService.MutateExperimentArms(
request
);
Expand All @@ -221,12 +229,11 @@ private static (MutateExperimentArmResult, MutateExperimentArmResult)
MutateExperimentArmResult treatmentArm = response.Results.Last();

Console.WriteLine($"Created control arm with resource name " +
$"'{controlArm.ResourceName}.");
$"'{controlArm.ResourceName}'.");
Console.WriteLine($"Created treatment arm with resource name" +
$" '{treatmentArm.ResourceName}'.");
return (controlArm, treatmentArm);
}

// [END create_experiment_2]

/// <summary>
Expand Down Expand Up @@ -271,4 +278,4 @@ private static void ModifyDraftCampaign(GoogleAdsClient client, long customerId,
Console.WriteLine($"Updated the name for campaign {draftCampaignResourceName}.");
}
}
}
}
Loading
Loading