/// <summary>
/// Run the code example.
/// </summary>
/// <param name="user">The DFP user object running the code example.</param>
public override void Run(DfpUser user) {
// Get the CreativeService.
CreativeService creativeService =
(CreativeService) user.GetService(DfpService.v201511.CreativeService);
// Create a statement to get all creatives.
StatementBuilder statementBuilder = new StatementBuilder()
.OrderBy("id ASC")
.Limit(StatementBuilder.SUGGESTED_PAGE_LIMIT);
// Set default for page.
CreativePage page = new CreativePage();
try {
do {
// Get creatives by statement.
page = creativeService.getCreativesByStatement(statementBuilder.ToStatement());
if (page.results != null && page.results.Length > 0) {
int i = page.startIndex;
foreach (Creative creative in page.results) {
Console.WriteLine("{0}) Creative with ID ='{1}', name ='{2}' and type ='{3}' " +
"was found.", i, creative.id, creative.name, creative.GetType().Name);
i++;
}
}
statementBuilder.IncreaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
} while (statementBuilder.GetOffset() < page.totalResultSetSize);
Console.WriteLine("Number of results found: {0}", page.totalResultSetSize);
} catch (Exception e) {
Console.WriteLine("Failed to get all creatives. Exception says \"{0}\"", e.Message);
}
}
/// <summary>
/// Run the code example.
/// </summary>
/// <param name="user">The DFP user object running the code example.</param>
public override void Run(DfpUser user)
{
// Get the CreativeService.
CreativeService creativeService =
(CreativeService)user.GetService(DfpService.v201311.CreativeService);
// Create a Statement to only select image creatives.
Statement statement = new StatementBuilder("WHERE creativeType = :creativeType LIMIT 500").
AddValue("creativeType", "ImageCreative").ToStatement();
try {
// Get creatives by Statement.
CreativePage page = creativeService.getCreativesByStatement(statement);
if (page.results != null && page.results.Length > 0)
{
int i = page.startIndex;
foreach (Creative creative in page.results)
{
Console.WriteLine("{0}) Creative with ID ='{1}', name ='{2}' and type ='{3}' " +
"was found.", i, creative.id, creative.name, creative.CreativeType);
i++;
}
}
Console.WriteLine("Number of results found: {0}", page.totalResultSetSize);
} catch (Exception ex) {
Console.WriteLine("Failed to get creatives by Statement. Exception says \"{0}\"",
ex.Message);
}
}
/// <summary>
/// Run the code example.
/// </summary>
public void Run(DfpUser user)
{
using (CreativeService creativeService =
(CreativeService)user.GetService(DfpService.v201711.CreativeService)) {
long creativeId = long.Parse(_T("INSERT_IMAGE_CREATIVE_ID_HERE"));
// Create a statement to get the image creative.
StatementBuilder statementBuilder = new StatementBuilder()
.Where("id = :id")
.OrderBy("id ASC")
.Limit(StatementBuilder.SUGGESTED_PAGE_LIMIT)
.AddValue("id", creativeId);
try {
// Get the creative.
CreativePage page = creativeService.getCreativesByStatement(
statementBuilder.ToStatement());
if (page.results != null)
{
ImageCreative imageCreative = (ImageCreative)page.results[0];
// Since we cannot set id to null, we mark it as not specified.
imageCreative.idSpecified = false;
imageCreative.advertiserId = imageCreative.advertiserId;
imageCreative.name = imageCreative.name + " (Copy #" + GetTimeStamp() + ")";
// Create image asset.
CreativeAsset creativeAsset = new CreativeAsset();
creativeAsset.fileName = "image.jpg";
creativeAsset.assetByteArray = MediaUtilities.GetAssetDataFromUrl(
imageCreative.primaryImageAsset.assetUrl);
creativeAsset.size = imageCreative.primaryImageAsset.size;
imageCreative.primaryImageAsset = creativeAsset;
// Create the copied creative.
Creative[] creatives = creativeService.createCreatives(
new Creative[] { imageCreative });
// Display copied creatives.
foreach (Creative copiedCreative in creatives)
{
Console.WriteLine("Image creative with ID \"{0}\", name \"{1}\", and type \"{2}\" " +
"was created and can be previewed at {3}", copiedCreative.id,
copiedCreative.name, copiedCreative.GetType().Name, copiedCreative.previewUrl);
}
}
else
{
Console.WriteLine("No creatives were copied.");
}
} catch (Exception e) {
Console.WriteLine("Failed to copy creatives. Exception says \"{0}\"", e.Message);
}
}
}
/// <summary>
/// Run the code example.
/// </summary>
/// <param name="user">The DFP user object running the code example.</param>
public override void Run(DfpUser user)
{
// Get the CreativeService.
CreativeService creativeService =
(CreativeService)user.GetService(DfpService.v201311.CreativeService);
// Create a Statement to get all image creatives.
Statement statement = new StatementBuilder("WHERE creativeType = :creativeType LIMIT 500").
AddValue("creativeType", "ImageCreative").ToStatement();
try {
// Get creatives by Statement.
CreativePage page = creativeService.getCreativesByStatement(statement);
if (page.results != null && page.results.Length > 0)
{
Creative[] creatives = page.results;
// Update each local creative object by changing its destination URL.
foreach (Creative creative in creatives)
{
if (creative is ImageCreative)
{
ImageCreative imageCreative = (ImageCreative)creative;
imageCreative.destinationUrl = "http://news.google.com";
}
}
// Update the creatives on the server.
creatives = creativeService.updateCreatives(creatives);
if (creatives != null)
{
foreach (Creative creative in creatives)
{
if (creative is ImageCreative)
{
ImageCreative imageCreative = (ImageCreative)creative;
Console.WriteLine("An image creative with ID = '{0}' and destination URL ='{1}' " +
"was updated.", imageCreative.id, imageCreative.destinationUrl);
}
}
}
else
{
Console.WriteLine("No creatives updated.");
}
}
else
{
Console.WriteLine("No creatives found to update.");
}
} catch (Exception ex) {
Console.WriteLine("Failed to update creatives. Exception says \"{0}\"", ex.Message);
}
}
/// <summary>
/// Run the code example.
/// </summary>
public void Run(DfpUser user)
{
using (CreativeService creativeService =
(CreativeService)user.GetService(DfpService.v201805.CreativeService))
{
// Set the ID of the creative to update.
long creativeId = long.Parse(_T("INSERT_CREATIVE_ID_HERE"));
// Create a statement to get all image creatives.
Statement statement = new StatementBuilder().Where("id = :id").OrderBy("id ASC")
.Limit(1)
.AddValue("id", creativeId).ToStatement();
try
{
// Get creatives by statement.
CreativePage page = creativeService.getCreativesByStatement(statement);
Creative creative = page.results[0];
// Update local creative object by changing its destination URL.
if (creative is ImageCreative)
{
ImageCreative imageCreative = (ImageCreative)creative;
imageCreative.destinationUrl = "http://news.google.com";
}
// Update the creatives on the server.
Creative[] creatives = creativeService.updateCreatives(new Creative[]
{
creative
});
foreach (Creative updatedCreative in creatives)
{
if (creative is ImageCreative)
{
ImageCreative imageCreative = (ImageCreative)updatedCreative;
Console.WriteLine(
"An image creative with ID = '{0}' and destination URL ='{1}' " +
"was updated.", imageCreative.id, imageCreative.destinationUrl);
}
}
}
catch (Exception e)
{
Console.WriteLine("Failed to update creatives. Exception says \"{0}\"",
e.Message);
}
}
}
/// <summary>
/// Run the code example.
/// </summary>
public void Run(DfpUser user)
{
CreativeService creativeService =
(CreativeService)user.GetService(DfpService.v201605.CreativeService);
// Create a statement to select creatives.
StatementBuilder statementBuilder = new StatementBuilder()
.Where("creativeType = :creativeType")
.OrderBy("id ASC")
.Limit(StatementBuilder.SUGGESTED_PAGE_LIMIT)
.AddValue("creativeType", "ImageCreative");
// Retrieve a small amount of creatives at a time, paging through
// until all creatives have been retrieved.
CreativePage page = new CreativePage();
try {
do
{
page = creativeService.getCreativesByStatement(statementBuilder.ToStatement());
if (page.results != null)
{
// Print out some information for each creative.
int i = page.startIndex;
foreach (Creative creative in page.results)
{
Console.WriteLine("{0}) Creative with ID \"{1}\" and name \"{2}\" was found.",
i++,
creative.id,
creative.name);
}
}
statementBuilder.IncreaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
} while (statementBuilder.GetOffset() < page.totalResultSetSize);
Console.WriteLine("Number of results found: {0}", page.totalResultSetSize);
} catch (Exception e) {
Console.WriteLine("Failed to get creatives. Exception says \"{0}\"",
e.Message);
}
}
/// <summary>
/// Run the code example.
/// </summary>
public void Run(DfpUser dfpUser)
{
CreativeService creativeService =
(CreativeService)dfpUser.GetService(DfpService.v201702.CreativeService);
// Create a statement to select creatives.
int pageSize = StatementBuilder.SUGGESTED_PAGE_LIMIT;
StatementBuilder statementBuilder = new StatementBuilder()
.Where("creativeType = :creativeType")
.OrderBy("id ASC")
.Limit(pageSize)
.AddValue("creativeType", "ImageCreative");
// Retrieve a small amount of creatives at a time, paging through until all
// creatives have been retrieved.
int totalResultSetSize = 0;
do
{
CreativePage page = creativeService.getCreativesByStatement(
statementBuilder.ToStatement());
// Print out some information for each creative.
if (page.results != null)
{
totalResultSetSize = page.totalResultSetSize;
int i = page.startIndex;
foreach (Creative creative in page.results)
{
Console.WriteLine(
"{0}) Creative with ID {1} and name \"{2}\" was found.",
i++,
creative.id,
creative.name
);
}
}
statementBuilder.IncreaseOffsetBy(pageSize);
} while (statementBuilder.GetOffset() < totalResultSetSize);
Console.WriteLine("Number of results found: {0}", totalResultSetSize);
}
/// <summary>
/// Run the code example.
/// </summary>
/// <param name="user">The DFP user object running the code example.</param>
public override void Run(DfpUser user)
{
// Get the CreativeService.
CreativeService creativeService =
(CreativeService)user.GetService(DfpService.v201408.CreativeService);
// Create a Statement to only select image creatives.
StatementBuilder statementBuilder = new StatementBuilder()
.Where("creativeType = :creativeType")
.OrderBy("id ASC")
.Limit(StatementBuilder.SUGGESTED_PAGE_LIMIT)
.AddValue("creativeType", "ImageCreative");
// Set default for page.
CreativePage page = new CreativePage();
try {
do
{
// Get creatives by Statement.
page = creativeService.getCreativesByStatement(statementBuilder.ToStatement());
if (page.results != null && page.results.Length > 0)
{
int i = page.startIndex;
foreach (Creative creative in page.results)
{
Console.WriteLine("{0}) Creative with ID ='{1}', name ='{2}' and type ='{3}' " +
"was found.", i, creative.id, creative.name, creative.CreativeType);
i++;
}
}
statementBuilder.IncreaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
} while (statementBuilder.GetOffset() < page.totalResultSetSize);
Console.WriteLine("Number of results found: {0}", page.totalResultSetSize);
} catch (Exception ex) {
Console.WriteLine("Failed to get creatives by Statement. Exception says \"{0}\"",
ex.Message);
}
}
/// <summary>
/// Run the code example.
/// </summary>
/// <param name="user">The DFP user object running the code example.</param>
public override void Run(DfpUser user)
{
// Get the CreativeService.
CreativeService creativeService =
(CreativeService)user.GetService(DfpService.v201311.CreativeService);
// Set defaults for page and Statement.
CreativePage page = new CreativePage();
Statement statement = new Statement();
int offset = 0;
try {
do
{
// Create a Statement to get all creatives.
statement.query = string.Format("LIMIT 500 OFFSET {0}", offset);
// Get creatives by Statement.
page = creativeService.getCreativesByStatement(statement);
if (page.results != null && page.results.Length > 0)
{
int i = page.startIndex;
foreach (Creative creative in page.results)
{
Console.WriteLine("{0}) Creative with ID ='{1}', name ='{2}' and type ='{3}' " +
"was found.", i, creative.id, creative.name, creative.CreativeType);
i++;
}
}
offset += 500;
} while (offset < page.totalResultSetSize);
Console.WriteLine("Number of results found: {0}", page.totalResultSetSize);
} catch (Exception ex) {
Console.WriteLine("Failed to get all creatives. Exception says \"{0}\"", ex.Message);
}
}
public void TestGetCreativesByStatement()
{
Statement statement = new Statement();
statement.query = string.Format("WHERE id = '{0}' LIMIT 500", creative1.id);
CreativePage page = null;
Assert.DoesNotThrow(delegate() {
page = creativeService.getCreativesByStatement(statement);
});
Assert.NotNull(page);
Assert.NotNull(page.results);
Assert.AreEqual(page.totalResultSetSize, 1);
Assert.NotNull(page.results[0]);
Assert.AreEqual(page.results[0].id, creative1.id);
Assert.AreEqual(page.results[0].GetType(), creative1.GetType());
Assert.AreEqual(page.results[0].name, creative1.name);
Assert.AreEqual(page.results[0].advertiserId, creative1.advertiserId);
Assert.AreEqual(page.results[0].previewUrl, creative1.previewUrl);
Assert.AreEqual(page.results[0].size.height, creative1.size.height);
Assert.AreEqual(page.results[0].size.width, creative1.size.width);
}
/// <summary>
/// Run the code example.
/// </summary>
/// <param name="user">The DFP user object running the code example.</param>
public override void Run(DfpUser user)
{
// Get the CreativeService.
CreativeService creativeService =
(CreativeService)user.GetService(DfpService.v201311.CreativeService);
long[] creativeIds = new long[] { long.Parse(_T("INSERT_IMAGE_CREATIVE_ID_HERE")) };
// Build a comma separated list of creativeIds. Note that if you are using
// .NET 4.0 or above, you could use the newly introduced
// String.Join<T>(string separator, IEnumerable<T> values) method to
// perform this task.
string[] creativeIdTexts = new string[creativeIds.Length];
for (int i = 0; i < creativeIdTexts.Length; i++)
{
creativeIdTexts[i] = creativeIds[i].ToString();
}
string commaSeparatedCreativeIds = string.Join(",", creativeIdTexts);
// Create the statement to filter image creatives by id.
Statement statement = new StatementBuilder(
string.Format("WHERE id IN ({0}) and creativeType = :creativeType LIMIT 500",
commaSeparatedCreativeIds)).AddValue("creativeType", "ImageCreative").
ToStatement();
try {
// Retrieve all creatives which match.
CreativePage page = creativeService.getCreativesByStatement(statement);
if (page.results != null)
{
Creative[] creatives = page.results;
long[] oldIds = new long[creatives.Length];
for (int i = 0; i < creatives.Length; i++)
{
ImageCreative imageCreative = (ImageCreative)creatives[i];
oldIds[i] = imageCreative.id;
// Since we cannot set id to null, we mark it as not specified.
imageCreative.idSpecified = false;
imageCreative.advertiserId = imageCreative.advertiserId;
imageCreative.name = imageCreative.name + " (Copy #" + GetTimeStamp() + ")";
// Create image asset.
CreativeAsset creativeAsset = new CreativeAsset();
creativeAsset.fileName = "image.jpg";
creativeAsset.assetByteArray = MediaUtilities.GetAssetDataFromUrl(
imageCreative.primaryImageAsset.assetUrl);
creativeAsset.size = imageCreative.primaryImageAsset.size;
imageCreative.primaryImageAsset = creativeAsset;
creatives[i] = imageCreative;
}
// Create the copied creative.
creatives = creativeService.createCreatives(creatives);
// Display copied creatives.
for (int i = 0; i < creatives.Length; i++)
{
Console.WriteLine("Image creative with ID \"{0}\" copied to ID \"{1}\".", oldIds[i],
creatives[i].id);
}
}
else
{
Console.WriteLine("No creatives were copied.");
}
} catch (Exception ex) {
Console.WriteLine("Failed to copy creatives. Exception says \"{0}\"", ex.Message);
}
}
