/// <summary>Snippet for GetCampaignExtensionSetting</summary>
/// <remarks>
/// This snippet has been automatically generated for illustrative purposes only.
/// It may require modifications to work in your environment.
/// </remarks>
public void GetCampaignExtensionSetting()
{
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = CampaignExtensionSettingServiceClient.Create();
// Initialize request argument(s)
string resourceName = "customers/[CUSTOMER]/campaignExtensionSettings/[CAMPAIGN_EXTENSION_SETTING]";
// Make the request
CampaignExtensionSetting response = campaignExtensionSettingServiceClient.GetCampaignExtensionSetting(resourceName);
}
/// <summary>Snippet for GetCampaignExtensionSetting</summary>
/// <remarks>
/// This snippet has been automatically generated for illustrative purposes only.
/// It may require modifications to work in your environment.
/// </remarks>
public void GetCampaignExtensionSettingResourceNames()
{
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = CampaignExtensionSettingServiceClient.Create();
// Initialize request argument(s)
CampaignExtensionSettingName resourceName = CampaignExtensionSettingName.FromCustomerCampaignExtensionType("[CUSTOMER_ID]", "[CAMPAIGN_ID]", "[EXTENSION_TYPE]");
// Make the request
CampaignExtensionSetting response = campaignExtensionSettingServiceClient.GetCampaignExtensionSetting(resourceName);
}
/// <summary>Snippet for GetCampaignExtensionSettingAsync</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 GetCampaignExtensionSettingAsync()
{
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = await CampaignExtensionSettingServiceClient.CreateAsync();
// Initialize request argument(s)
string resourceName = "customers/[CUSTOMER_ID]/campaignExtensionSettings/[CAMPAIGN_ID]~[EXTENSION_TYPE]";
// Make the request
CampaignExtensionSetting response = await campaignExtensionSettingServiceClient.GetCampaignExtensionSettingAsync(resourceName);
}
/// <summary>Snippet for GetCampaignExtensionSettingAsync</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 GetCampaignExtensionSettingResourceNamesAsync()
{
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = await CampaignExtensionSettingServiceClient.CreateAsync();
// Initialize request argument(s)
CampaignExtensionSettingName resourceName = CampaignExtensionSettingName.FromCustomerCampaignExtensionSetting("[CUSTOMER]", "[CAMPAIGN_EXTENSION_SETTING]");
// Make the request
CampaignExtensionSetting response = await campaignExtensionSettingServiceClient.GetCampaignExtensionSettingAsync(resourceName);
}
/// <summary>Snippet for GetCampaignExtensionSetting</summary>
public void GetCampaignExtensionSetting()
{
// Snippet: GetCampaignExtensionSetting(string, CallSettings)
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = CampaignExtensionSettingServiceClient.Create();
// Initialize request argument(s)
string resourceName = "customers/[CUSTOMER_ID]/campaignExtensionSettings/[CAMPAIGN_ID]~[EXTENSION_TYPE]";
// Make the request
CampaignExtensionSetting response = campaignExtensionSettingServiceClient.GetCampaignExtensionSetting(resourceName);
// End snippet
}
/// <summary>Snippet for GetCampaignExtensionSetting</summary>
public void GetCampaignExtensionSettingResourceNames()
{
// Snippet: GetCampaignExtensionSetting(CampaignExtensionSettingName, CallSettings)
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = CampaignExtensionSettingServiceClient.Create();
// Initialize request argument(s)
CampaignExtensionSettingName resourceName = CampaignExtensionSettingName.FromCustomerCampaignExtensionSetting("[CUSTOMER]", "[CAMPAIGN_EXTENSION_SETTING]");
// Make the request
CampaignExtensionSetting response = campaignExtensionSettingServiceClient.GetCampaignExtensionSetting(resourceName);
// End snippet
}
/// <summary>Snippet for GetCampaignExtensionSetting</summary>
/// <remarks>
/// This snippet has been automatically generated for illustrative purposes only.
/// It may require modifications to work in your environment.
/// </remarks>
public void GetCampaignExtensionSettingRequestObject()
{
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = CampaignExtensionSettingServiceClient.Create();
// Initialize request argument(s)
GetCampaignExtensionSettingRequest request = new GetCampaignExtensionSettingRequest
{
ResourceNameAsCampaignExtensionSettingName = CampaignExtensionSettingName.FromCustomerCampaignExtensionSetting("[CUSTOMER]", "[CAMPAIGN_EXTENSION_SETTING]"),
};
// Make the request
CampaignExtensionSetting response = campaignExtensionSettingServiceClient.GetCampaignExtensionSetting(request);
}
/// <summary>Snippet for GetCampaignExtensionSettingAsync</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 GetCampaignExtensionSettingRequestObjectAsync()
{
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = await CampaignExtensionSettingServiceClient.CreateAsync();
// Initialize request argument(s)
GetCampaignExtensionSettingRequest request = new GetCampaignExtensionSettingRequest
{
ResourceNameAsCampaignExtensionSettingName = CampaignExtensionSettingName.FromCustomerCampaignExtensionType("[CUSTOMER_ID]", "[CAMPAIGN_ID]", "[EXTENSION_TYPE]"),
};
// Make the request
CampaignExtensionSetting response = await campaignExtensionSettingServiceClient.GetCampaignExtensionSettingAsync(request);
}
/// <summary>Snippet for MutateCampaignExtensionSettings</summary>
/// <remarks>
/// This snippet has been automatically generated for illustrative purposes only.
/// It may require modifications to work in your environment.
/// </remarks>
public void MutateCampaignExtensionSettings()
{
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = CampaignExtensionSettingServiceClient.Create();
// Initialize request argument(s)
string customerId = "";
IEnumerable <CampaignExtensionSettingOperation> operations = new CampaignExtensionSettingOperation[]
{
new CampaignExtensionSettingOperation(),
};
// Make the request
MutateCampaignExtensionSettingsResponse response = campaignExtensionSettingServiceClient.MutateCampaignExtensionSettings(customerId, operations);
}
/// <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 campaign ID.</param>
/// <param name="feedItemIds">The extension feed item IDs to replace.</param>
// [START update_sitelink_campaign_extension_setting]
public void Run(GoogleAdsClient client, long customerId, long campaignId,
long[] feedItemIds)
{
// Get the CampaignExtensionSettingService.
CampaignExtensionSettingServiceClient campaignExtensionSettingService =
client.GetService(Services.V10.CampaignExtensionSettingService);
// Transform the specified extension feed item IDs to an array of resource names.
IEnumerable <string> extensionFeedItems = feedItemIds.Select(feedItemId =>
ResourceNames.ExtensionFeedItem(customerId, feedItemId));
// Create a campaign extension setting using the specified campaign ID and extension
// feed item resource names.
CampaignExtensionSetting campaignExtensionSetting = new CampaignExtensionSetting
{
ResourceName = ResourceNames.CampaignExtensionSetting(customerId, campaignId,
ExtensionType.Sitelink)
};
campaignExtensionSetting.ExtensionFeedItems.Add(extensionFeedItems);
// Construct an operation that will update the extension feed item using the FieldMasks
// utilities to derive the update mask. This mask tells the Google Ads API which
// attributes of the extension feed item you want to change.
CampaignExtensionSettingOperation campaignExtensionSettingOperation =
new CampaignExtensionSettingOperation
{
Update = campaignExtensionSetting,
UpdateMask = FieldMasks.AllSetFieldsOf(campaignExtensionSetting)
};
try
{
// Issue a mutate request to update the campaign extension setting.
MutateCampaignExtensionSettingsResponse response =
campaignExtensionSettingService.MutateCampaignExtensionSettings
(customerId.ToString(), new[] { campaignExtensionSettingOperation });
// Print the resource name of the updated campaign extension setting.
Console.WriteLine("Updated a campaign extension setting with resource name " +
$"'{response.Results.First().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>Snippet for GetCampaignExtensionSetting</summary>
public void GetCampaignExtensionSettingRequestObject()
{
// Snippet: GetCampaignExtensionSetting(GetCampaignExtensionSettingRequest, CallSettings)
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = CampaignExtensionSettingServiceClient.Create();
// Initialize request argument(s)
GetCampaignExtensionSettingRequest request = new GetCampaignExtensionSettingRequest
{
ResourceNameAsCampaignExtensionSettingName = CampaignExtensionSettingName.FromCustomerCampaignExtensionType("[CUSTOMER_ID]", "[CAMPAIGN_ID]", "[EXTENSION_TYPE]"),
};
// Make the request
CampaignExtensionSetting response = campaignExtensionSettingServiceClient.GetCampaignExtensionSetting(request);
// End snippet
}
/// <summary>Snippet for GetCampaignExtensionSettingAsync</summary>
public async Task GetCampaignExtensionSettingResourceNamesAsync()
{
// Snippet: GetCampaignExtensionSettingAsync(CampaignExtensionSettingName, CallSettings)
// Additional: GetCampaignExtensionSettingAsync(CampaignExtensionSettingName, CancellationToken)
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = await CampaignExtensionSettingServiceClient.CreateAsync();
// Initialize request argument(s)
CampaignExtensionSettingName resourceName = CampaignExtensionSettingName.FromCustomerCampaignExtensionType("[CUSTOMER_ID]", "[CAMPAIGN_ID]", "[EXTENSION_TYPE]");
// Make the request
CampaignExtensionSetting response = await campaignExtensionSettingServiceClient.GetCampaignExtensionSettingAsync(resourceName);
// End snippet
}
/// <summary>Snippet for GetCampaignExtensionSettingAsync</summary>
public async Task GetCampaignExtensionSettingAsync()
{
// Snippet: GetCampaignExtensionSettingAsync(string, CallSettings)
// Additional: GetCampaignExtensionSettingAsync(string, CancellationToken)
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = await CampaignExtensionSettingServiceClient.CreateAsync();
// Initialize request argument(s)
string resourceName = "customers/[CUSTOMER]/campaignExtensionSettings/[CAMPAIGN_EXTENSION_SETTING]";
// Make the request
CampaignExtensionSetting response = await campaignExtensionSettingServiceClient.GetCampaignExtensionSettingAsync(resourceName);
// End snippet
}
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The customer ID for which the call is made.</param>
/// <param name="campaignId">ID of the campaign to which sitelinks are added.</param>
/// <param name="imageAssetId">ID of the image asset to be used for creating the extension.
/// </param>
public void Run(GoogleAdsClient client, long customerId, long campaignId,
long imageAssetId)
{
// Get the CampaignExtensionSettingServiceClient.
CampaignExtensionSettingServiceClient campaignExtensionSettingService =
client.GetService(Services.V10.CampaignExtensionSettingService);
try
{
// Creates an image extension.
string imageExtensionResourceName =
CreateImageExtension(client, customerId, imageAssetId);
string campaignResourceName = ResourceNames.Campaign(customerId, campaignId);
// Creates a CampaignExtensionSetting.
CampaignExtensionSetting campaignExtensionSetting = new CampaignExtensionSetting()
{
Campaign = campaignResourceName,
ExtensionType = ExtensionType.Image,
ExtensionFeedItems = { imageExtensionResourceName }
};
// Creates the operation.
CampaignExtensionSettingOperation operation =
new CampaignExtensionSettingOperation()
{
Create = campaignExtensionSetting
};
// Creates the campaign extension.
MutateCampaignExtensionSettingsResponse response =
campaignExtensionSettingService.MutateCampaignExtensionSettings(
customerId.ToString(), new[] { operation });
foreach (MutateCampaignExtensionSettingResult result in response.Results)
{
Console.WriteLine($"Created campaign extension setting with resource " +
$"name '{result.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>Snippet for GetCampaignExtensionSettingAsync</summary>
public async Task GetCampaignExtensionSettingRequestObjectAsync()
{
// Snippet: GetCampaignExtensionSettingAsync(GetCampaignExtensionSettingRequest, CallSettings)
// Additional: GetCampaignExtensionSettingAsync(GetCampaignExtensionSettingRequest, CancellationToken)
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = await CampaignExtensionSettingServiceClient.CreateAsync();
// Initialize request argument(s)
GetCampaignExtensionSettingRequest request = new GetCampaignExtensionSettingRequest
{
ResourceNameAsCampaignExtensionSettingName = CampaignExtensionSettingName.FromCustomerCampaignExtensionSetting("[CUSTOMER]", "[CAMPAIGN_EXTENSION_SETTING]"),
};
// Make the request
CampaignExtensionSetting response = await campaignExtensionSettingServiceClient.GetCampaignExtensionSettingAsync(request);
// End snippet
}
/// <summary>Snippet for MutateCampaignExtensionSettingsAsync</summary>
public async Task MutateCampaignExtensionSettingsAsync()
{
// Snippet: MutateCampaignExtensionSettingsAsync(string, IEnumerable<CampaignExtensionSettingOperation>, CallSettings)
// Additional: MutateCampaignExtensionSettingsAsync(string, IEnumerable<CampaignExtensionSettingOperation>, CancellationToken)
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = await CampaignExtensionSettingServiceClient.CreateAsync();
// Initialize request argument(s)
string customerId = "";
IEnumerable <CampaignExtensionSettingOperation> operations = new CampaignExtensionSettingOperation[]
{
new CampaignExtensionSettingOperation(),
};
// Make the request
MutateCampaignExtensionSettingsResponse response = await campaignExtensionSettingServiceClient.MutateCampaignExtensionSettingsAsync(customerId, operations);
// End snippet
}
/// <summary>Snippet for MutateCampaignExtensionSettings</summary>
/// <remarks>
/// This snippet has been automatically generated for illustrative purposes only.
/// It may require modifications to work in your environment.
/// </remarks>
public void MutateCampaignExtensionSettingsRequestObject()
{
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = CampaignExtensionSettingServiceClient.Create();
// Initialize request argument(s)
MutateCampaignExtensionSettingsRequest request = new MutateCampaignExtensionSettingsRequest
{
CustomerId = "",
Operations =
{
new CampaignExtensionSettingOperation(),
},
PartialFailure = false,
ValidateOnly = false,
};
// Make the request
MutateCampaignExtensionSettingsResponse response = campaignExtensionSettingServiceClient.MutateCampaignExtensionSettings(request);
}
/// <summary>Snippet for MutateCampaignExtensionSettingsAsync</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 MutateCampaignExtensionSettingsRequestObjectAsync()
{
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = await CampaignExtensionSettingServiceClient.CreateAsync();
// Initialize request argument(s)
MutateCampaignExtensionSettingsRequest request = new MutateCampaignExtensionSettingsRequest
{
CustomerId = "",
Operations =
{
new CampaignExtensionSettingOperation(),
},
PartialFailure = false,
ValidateOnly = false,
ResponseContentType = ResponseContentTypeEnum.Types.ResponseContentType.Unspecified,
};
// Make the request
MutateCampaignExtensionSettingsResponse response = await campaignExtensionSettingServiceClient.MutateCampaignExtensionSettingsAsync(request);
}
/// <summary>Snippet for MutateCampaignExtensionSettings</summary>
public void MutateCampaignExtensionSettingsRequestObject()
{
// Snippet: MutateCampaignExtensionSettings(MutateCampaignExtensionSettingsRequest, CallSettings)
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = CampaignExtensionSettingServiceClient.Create();
// Initialize request argument(s)
MutateCampaignExtensionSettingsRequest request = new MutateCampaignExtensionSettingsRequest
{
CustomerId = "",
Operations =
{
new CampaignExtensionSettingOperation(),
},
PartialFailure = false,
ValidateOnly = false,
ResponseContentType = ResponseContentTypeEnum.Types.ResponseContentType.Unspecified,
};
// Make the request
MutateCampaignExtensionSettingsResponse response = campaignExtensionSettingServiceClient.MutateCampaignExtensionSettings(request);
// End snippet
}
/// <summary>Snippet for MutateCampaignExtensionSettingsAsync</summary>
public async Task MutateCampaignExtensionSettingsRequestObjectAsync()
{
// Snippet: MutateCampaignExtensionSettingsAsync(MutateCampaignExtensionSettingsRequest, CallSettings)
// Additional: MutateCampaignExtensionSettingsAsync(MutateCampaignExtensionSettingsRequest, CancellationToken)
// Create client
CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient = await CampaignExtensionSettingServiceClient.CreateAsync();
// Initialize request argument(s)
MutateCampaignExtensionSettingsRequest request = new MutateCampaignExtensionSettingsRequest
{
CustomerId = "",
Operations =
{
new CampaignExtensionSettingOperation(),
},
PartialFailure = false,
ValidateOnly = false,
};
// Make the request
MutateCampaignExtensionSettingsResponse response = await campaignExtensionSettingServiceClient.MutateCampaignExtensionSettingsAsync(request);
// End snippet
}
