/// <summary>Snippet for GetSharedCriterion</summary>
/// <remarks>
/// This snippet has been automatically generated for illustrative purposes only.
/// It may require modifications to work in your environment.
/// </remarks>
public void GetSharedCriterionResourceNames()
{
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = SharedCriterionServiceClient.Create();
// Initialize request argument(s)
SharedCriterionName resourceName = SharedCriterionName.FromCustomerSharedCriterion("[CUSTOMER]", "[SHARED_CRITERION]");
// Make the request
SharedCriterion response = sharedCriterionServiceClient.GetSharedCriterion(resourceName);
}
/// <summary>Snippet for GetSharedCriterion</summary>
/// <remarks>
/// This snippet has been automatically generated for illustrative purposes only.
/// It may require modifications to work in your environment.
/// </remarks>
public void GetSharedCriterion()
{
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = SharedCriterionServiceClient.Create();
// Initialize request argument(s)
string resourceName = "customers/[CUSTOMER_ID]/sharedCriteria/[SHARED_SET_ID]~[CRITERION_ID]";
// Make the request
SharedCriterion response = sharedCriterionServiceClient.GetSharedCriterion(resourceName);
}
/// <summary>Snippet for GetSharedCriterionAsync</summary>
/// <remarks>
/// This snippet has been automatically generated for illustrative purposes only.
/// It may require modifications to work in your environment.
/// </remarks>
public async Task GetSharedCriterionAsync()
{
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = await SharedCriterionServiceClient.CreateAsync();
// Initialize request argument(s)
string resourceName = "customers/[CUSTOMER]/sharedCriteria/[SHARED_CRITERION]";
// Make the request
SharedCriterion response = await sharedCriterionServiceClient.GetSharedCriterionAsync(resourceName);
}
/// <summary>Snippet for GetSharedCriterionAsync</summary>
/// <remarks>
/// This snippet has been automatically generated for illustrative purposes only.
/// It may require modifications to work in your environment.
/// </remarks>
public async Task GetSharedCriterionResourceNamesAsync()
{
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = await SharedCriterionServiceClient.CreateAsync();
// Initialize request argument(s)
SharedCriterionName resourceName = SharedCriterionName.FromCustomerSharedSetCriterion("[CUSTOMER_ID]", "[SHARED_SET_ID]", "[CRITERION_ID]");
// Make the request
SharedCriterion response = await sharedCriterionServiceClient.GetSharedCriterionAsync(resourceName);
}
/// <summary>Snippet for GetSharedCriterion</summary>
public void GetSharedCriterion()
{
// Snippet: GetSharedCriterion(string, CallSettings)
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = SharedCriterionServiceClient.Create();
// Initialize request argument(s)
string resourceName = "customers/[CUSTOMER]/sharedCriteria/[SHARED_CRITERION]";
// Make the request
SharedCriterion response = sharedCriterionServiceClient.GetSharedCriterion(resourceName);
// End snippet
}
/// <summary>Snippet for GetSharedCriterion</summary>
public void GetSharedCriterionResourceNames()
{
// Snippet: GetSharedCriterion(SharedCriterionName, CallSettings)
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = SharedCriterionServiceClient.Create();
// Initialize request argument(s)
SharedCriterionName resourceName = SharedCriterionName.FromCustomerSharedSetCriterion("[CUSTOMER_ID]", "[SHARED_SET_ID]", "[CRITERION_ID]");
// Make the request
SharedCriterion response = sharedCriterionServiceClient.GetSharedCriterion(resourceName);
// End snippet
}
/// <summary>Snippet for GetSharedCriterion</summary>
/// <remarks>
/// This snippet has been automatically generated for illustrative purposes only.
/// It may require modifications to work in your environment.
/// </remarks>
public void GetSharedCriterionRequestObject()
{
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = SharedCriterionServiceClient.Create();
// Initialize request argument(s)
GetSharedCriterionRequest request = new GetSharedCriterionRequest
{
ResourceNameAsSharedCriterionName = SharedCriterionName.FromCustomerSharedSetCriterion("[CUSTOMER_ID]", "[SHARED_SET_ID]", "[CRITERION_ID]"),
};
// Make the request
SharedCriterion response = sharedCriterionServiceClient.GetSharedCriterion(request);
}
/// <summary>Snippet for GetSharedCriterionAsync</summary>
/// <remarks>
/// This snippet has been automatically generated for illustrative purposes only.
/// It may require modifications to work in your environment.
/// </remarks>
public async Task GetSharedCriterionRequestObjectAsync()
{
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = await SharedCriterionServiceClient.CreateAsync();
// Initialize request argument(s)
GetSharedCriterionRequest request = new GetSharedCriterionRequest
{
ResourceNameAsSharedCriterionName = SharedCriterionName.FromCustomerSharedCriterion("[CUSTOMER]", "[SHARED_CRITERION]"),
};
// Make the request
SharedCriterion response = await sharedCriterionServiceClient.GetSharedCriterionAsync(request);
}
/// <summary>Snippet for MutateSharedCriteria</summary>
/// <remarks>
/// This snippet has been automatically generated for illustrative purposes only.
/// It may require modifications to work in your environment.
/// </remarks>
public void MutateSharedCriteria()
{
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = SharedCriterionServiceClient.Create();
// Initialize request argument(s)
string customerId = "";
IEnumerable <SharedCriterionOperation> operations = new SharedCriterionOperation[]
{
new SharedCriterionOperation(),
};
// Make the request
MutateSharedCriteriaResponse response = sharedCriterionServiceClient.MutateSharedCriteria(customerId, operations);
}
/// <summary>Snippet for GetSharedCriterionAsync</summary>
public async Task GetSharedCriterionResourceNamesAsync()
{
// Snippet: GetSharedCriterionAsync(SharedCriterionName, CallSettings)
// Additional: GetSharedCriterionAsync(SharedCriterionName, CancellationToken)
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = await SharedCriterionServiceClient.CreateAsync();
// Initialize request argument(s)
SharedCriterionName resourceName = SharedCriterionName.FromCustomerSharedCriterion("[CUSTOMER]", "[SHARED_CRITERION]");
// Make the request
SharedCriterion response = await sharedCriterionServiceClient.GetSharedCriterionAsync(resourceName);
// End snippet
}
/// <summary>Snippet for GetSharedCriterionAsync</summary>
public async Task GetSharedCriterionAsync()
{
// Snippet: GetSharedCriterionAsync(string, CallSettings)
// Additional: GetSharedCriterionAsync(string, CancellationToken)
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = await SharedCriterionServiceClient.CreateAsync();
// Initialize request argument(s)
string resourceName = "customers/[CUSTOMER]/sharedCriteria/[SHARED_CRITERION]";
// Make the request
SharedCriterion response = await sharedCriterionServiceClient.GetSharedCriterionAsync(resourceName);
// End snippet
}
/// <summary>Snippet for GetSharedCriterion</summary>
public void GetSharedCriterionRequestObject()
{
// Snippet: GetSharedCriterion(GetSharedCriterionRequest, CallSettings)
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = SharedCriterionServiceClient.Create();
// Initialize request argument(s)
GetSharedCriterionRequest request = new GetSharedCriterionRequest
{
ResourceNameAsSharedCriterionName = SharedCriterionName.FromCustomerSharedCriterion("[CUSTOMER]", "[SHARED_CRITERION]"),
};
// Make the request
SharedCriterion response = sharedCriterionServiceClient.GetSharedCriterion(request);
// End snippet
}
/// <summary>Snippet for GetSharedCriterionAsync</summary>
public async Task GetSharedCriterionRequestObjectAsync()
{
// Snippet: GetSharedCriterionAsync(GetSharedCriterionRequest, CallSettings)
// Additional: GetSharedCriterionAsync(GetSharedCriterionRequest, CancellationToken)
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = await SharedCriterionServiceClient.CreateAsync();
// Initialize request argument(s)
GetSharedCriterionRequest request = new GetSharedCriterionRequest
{
ResourceNameAsSharedCriterionName = SharedCriterionName.FromCustomerSharedSetCriterion("[CUSTOMER_ID]", "[SHARED_SET_ID]", "[CRITERION_ID]"),
};
// Make the request
SharedCriterion response = await sharedCriterionServiceClient.GetSharedCriterionAsync(request);
// End snippet
}
/// <summary>Snippet for MutateSharedCriteriaAsync</summary>
public async Task MutateSharedCriteriaAsync()
{
// Snippet: MutateSharedCriteriaAsync(string, IEnumerable<SharedCriterionOperation>, CallSettings)
// Additional: MutateSharedCriteriaAsync(string, IEnumerable<SharedCriterionOperation>, CancellationToken)
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = await SharedCriterionServiceClient.CreateAsync();
// Initialize request argument(s)
string customerId = "";
IEnumerable <SharedCriterionOperation> operations = new SharedCriterionOperation[]
{
new SharedCriterionOperation(),
};
// Make the request
MutateSharedCriteriaResponse response = await sharedCriterionServiceClient.MutateSharedCriteriaAsync(customerId, operations);
// End snippet
}
/// <summary>Snippet for MutateSharedCriteria</summary>
/// <remarks>
/// This snippet has been automatically generated for illustrative purposes only.
/// It may require modifications to work in your environment.
/// </remarks>
public void MutateSharedCriteriaRequestObject()
{
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = SharedCriterionServiceClient.Create();
// Initialize request argument(s)
MutateSharedCriteriaRequest request = new MutateSharedCriteriaRequest
{
CustomerId = "",
Operations =
{
new SharedCriterionOperation(),
},
PartialFailure = false,
ValidateOnly = false,
};
// Make the request
MutateSharedCriteriaResponse response = sharedCriterionServiceClient.MutateSharedCriteria(request);
}
/// <summary>Snippet for MutateSharedCriteriaAsync</summary>
/// <remarks>
/// This snippet has been automatically generated for illustrative purposes only.
/// It may require modifications to work in your environment.
/// </remarks>
public async Task MutateSharedCriteriaRequestObjectAsync()
{
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = await SharedCriterionServiceClient.CreateAsync();
// Initialize request argument(s)
MutateSharedCriteriaRequest request = new MutateSharedCriteriaRequest
{
CustomerId = "",
Operations =
{
new SharedCriterionOperation(),
},
PartialFailure = false,
ValidateOnly = false,
ResponseContentType = ResponseContentTypeEnum.Types.ResponseContentType.Unspecified,
};
// Make the request
MutateSharedCriteriaResponse response = await sharedCriterionServiceClient.MutateSharedCriteriaAsync(request);
}
/// <summary>Snippet for MutateSharedCriteria</summary>
public void MutateSharedCriteriaRequestObject()
{
// Snippet: MutateSharedCriteria(MutateSharedCriteriaRequest, CallSettings)
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = SharedCriterionServiceClient.Create();
// Initialize request argument(s)
MutateSharedCriteriaRequest request = new MutateSharedCriteriaRequest
{
CustomerId = "",
Operations =
{
new SharedCriterionOperation(),
},
PartialFailure = false,
ValidateOnly = false,
ResponseContentType = ResponseContentTypeEnum.Types.ResponseContentType.Unspecified,
};
// Make the request
MutateSharedCriteriaResponse response = sharedCriterionServiceClient.MutateSharedCriteria(request);
// End snippet
}
/// <summary>Snippet for MutateSharedCriteriaAsync</summary>
public async Task MutateSharedCriteriaRequestObjectAsync()
{
// Snippet: MutateSharedCriteriaAsync(MutateSharedCriteriaRequest, CallSettings)
// Additional: MutateSharedCriteriaAsync(MutateSharedCriteriaRequest, CancellationToken)
// Create client
SharedCriterionServiceClient sharedCriterionServiceClient = await SharedCriterionServiceClient.CreateAsync();
// Initialize request argument(s)
MutateSharedCriteriaRequest request = new MutateSharedCriteriaRequest
{
CustomerId = "",
Operations =
{
new SharedCriterionOperation(),
},
PartialFailure = false,
ValidateOnly = false,
};
// Make the request
MutateSharedCriteriaResponse response = await sharedCriterionServiceClient.MutateSharedCriteriaAsync(request);
// End snippet
}
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <param name="campaignId">The ID of the campaign for which shared criterion is updated.
/// </param>
public void Run(GoogleAdsClient client, long customerId, long campaignId)
{
SharedSetServiceClient sharedSetService = client.GetService(
Services.V4.SharedSetService);
SharedCriterionServiceClient sharedCriterionService =
client.GetService(Services.V4.SharedCriterionService);
CampaignSharedSetServiceClient campaignSharedSetService =
client.GetService(Services.V4.CampaignSharedSetService);
try
{
// Keywords to create a shared set of.
string[] keywords = new string[] { "mars cruise", "mars hotels" };
// Create shared negative keyword set.
SharedSet sharedSet = new SharedSet()
{
Name = "API Negative keyword list - " + ExampleUtilities.GetRandomString(),
Type = SharedSetType.NegativeKeywords,
};
SharedSetOperation operation = new SharedSetOperation()
{
Create = sharedSet
};
MutateSharedSetsResponse sharedSetResponse = sharedSetService.MutateSharedSets(
customerId.ToString(), new SharedSetOperation[] { operation });
string sharedSetResourceName = sharedSetResponse.Results[0].ResourceName;
Console.WriteLine($"Created shared set {sharedSetResourceName}.");
// Create negative keywords in the shared set.
List <SharedCriterionOperation> criterionOperations =
new List <SharedCriterionOperation>();
foreach (string keyword in keywords)
{
SharedCriterion sharedCriterion = new SharedCriterion()
{
Keyword = new KeywordInfo()
{
Text = keyword,
MatchType = KeywordMatchType.Broad
},
SharedSet = sharedSetResourceName
};
criterionOperations.Add(new SharedCriterionOperation()
{
Create = sharedCriterion
});
}
MutateSharedCriteriaResponse criteriaResponse =
sharedCriterionService.MutateSharedCriteria(
customerId.ToString(), criterionOperations);
foreach (MutateSharedCriterionResult result in criteriaResponse.Results)
{
Console.WriteLine($"Created shared criterion {result.ResourceName}.");
}
// Attach shared set to campaign.
CampaignSharedSet campaignSet = new CampaignSharedSet()
{
Campaign = ResourceNames.Campaign(customerId, campaignId),
SharedSet = sharedSetResourceName
};
CampaignSharedSetOperation sharedSetoperation = new CampaignSharedSetOperation()
{
Create = campaignSet
};
MutateCampaignSharedSetsResponse response =
campaignSharedSetService.MutateCampaignSharedSets(customerId.ToString(),
new CampaignSharedSetOperation[] { sharedSetoperation });
Console.WriteLine("Created campaign shared set {0}.",
response.Results[0].ResourceName);
}
catch (GoogleAdsException e)
{
Console.WriteLine("Failure:");
Console.WriteLine($"Message: {e.Message}");
Console.WriteLine($"Failure: {e.Failure}");
Console.WriteLine($"Request ID: {e.RequestId}");
throw;
}
}
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <param name="campaignId">The ID of the campaign for which shared criterion is updated.
/// </param>
public void Run(GoogleAdsClient client, long customerId, long campaignId)
{
try
{
SharedCriterionServiceClient sharedCriterionService = client.GetService(
Services.V3.SharedCriterionService);
GoogleAdsServiceClient googleAdsService = client.GetService(
Services.V3.GoogleAdsService);
List <long?> sharedSetIds = new List <long?>();
List <string> criterionResources = new List <string>();
// First, retrieve all shared sets associated with the campaign.
string sharedSetQuery = $"SELECT shared_set.id, shared_set.name FROM " +
$"campaign_shared_set WHERE campaign.id = {campaignId}";
PagedEnumerable <SearchGoogleAdsResponse, GoogleAdsRow> sharedSetResponse =
googleAdsService.Search(customerId.ToString(), sharedSetQuery);
// Display the results.
foreach (GoogleAdsRow googleAdsRow in sharedSetResponse)
{
SharedSet sharedSet = googleAdsRow.SharedSet;
Console.WriteLine("Campaign shared set ID {0} and name '{1}' was found.",
sharedSet.Id, sharedSet.Name);
sharedSetIds.Add(sharedSet.Id);
}
// Next, retrieve shared criteria for all found shared sets.
string sharedCriterionQuery =
"SELECT shared_criterion.type, shared_criterion.keyword.text, " +
"shared_criterion.keyword.match_type, shared_set.id FROM shared_criterion " +
$"WHERE shared_set.id IN(" +
string.Join(",", sharedSetIds.ConvertAll(x => x.ToString())) + ")";
PagedEnumerable <SearchGoogleAdsResponse, GoogleAdsRow> sharedCriterionResponse =
googleAdsService.Search(customerId.ToString(), sharedCriterionQuery);
// Display the results.
foreach (GoogleAdsRow googleAdsRow in sharedCriterionResponse)
{
SharedCriterion sharedCriterion = googleAdsRow.SharedCriterion;
if (sharedCriterion.Type == CriterionType.Keyword)
{
Console.WriteLine("Shared criterion with resource name '{0}' for " +
"negative keyword with text '{1}' and match type '{2}' was found.",
sharedCriterion.ResourceName,
sharedCriterion.Keyword.Text,
sharedCriterion.Keyword.MatchType);
}
else
{
Console.WriteLine("Shared criterion with resource name '{0}' was found.",
sharedCriterion.ResourceName);
}
criterionResources.Add(sharedCriterion.ResourceName);
}
// Finally, remove the criteria.
List <SharedCriterionOperation> operations = new List <SharedCriterionOperation>();
foreach (string criterionResource in criterionResources)
{
SharedCriterionOperation operation = new SharedCriterionOperation()
{
Remove = criterionResource
};
operations.Add(operation);
}
MutateSharedCriteriaResponse response =
sharedCriterionService.MutateSharedCriteria(
customerId.ToString(), operations);
foreach (MutateSharedCriterionResult result in response.Results)
{
Console.WriteLine($"Removed shared criterion {result.ResourceName}.");
}
}
catch (GoogleAdsException e)
{
Console.WriteLine("Failure:");
Console.WriteLine($"Message: {e.Message}");
Console.WriteLine($"Failure: {e.Failure}");
Console.WriteLine($"Request ID: {e.RequestId}");
}
}
