/
AddGmailAd.cs
executable file
·177 lines (163 loc) · 6.63 KB
/
AddGmailAd.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
using Google.Api.Ads.AdWords.Lib;
using Google.Api.Ads.AdWords.v201809;
using Google.Api.Ads.Common.Util;
using System;
namespace Google.Api.Ads.AdWords.Examples.CSharp.v201809
{
/// <summary>
/// This code example adds a Gmail ad to a given ad group. The ad group's
/// campaign needs to have an AdvertisingChannelType of DISPLAY and
/// AdvertisingChannelSubType of DISPLAY_GMAIL_AD.
/// To get ad groups, run GetAdGroups.cs.
/// </summary>
public class AddGmailAd : ExampleBase
{
/// <summary>
/// Main method, to run this code example as a standalone application.
/// </summary>
/// <param name="args">The command line arguments.</param>
public static void Main(string[] args)
{
AddGmailAd codeExample = new AddGmailAd();
Console.WriteLine(codeExample.Description);
try
{
long adGroupId = long.Parse("INSERT_ADGROUP_ID_HERE");
codeExample.Run(new AdWordsUser(), adGroupId);
}
catch (Exception e)
{
Console.WriteLine("An exception occurred while running this code example. {0}",
ExampleUtilities.FormatException(e));
}
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description
{
get
{
return "This code example adds a Gmail ad to a given ad group. The ad group's " +
"campaign needs to have an AdvertisingChannelType of DISPLAY and " +
"AdvertisingChannelSubType of DISPLAY_GMAIL_AD. To get ad groups, " +
"run GetAdGroups.cs.";
}
}
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="user">The AdWords user.</param>
/// <param name="adGroupId">Id of the adgroup to which ads are added.</param>
public void Run(AdWordsUser user, long adGroupId)
{
using (AdGroupAdService adGroupAdService =
(AdGroupAdService) user.GetService(AdWordsService.v201809.AdGroupAdService))
{
// This ad format does not allow the creation of an image using the
// Image.data field. An image must first be created using the
// MediaService, and Image.mediaId must be populated when creating the
// ad.
Image logoImage = new Image
{
mediaId = UploadImage(user, "https://goo.gl/mtt54n").mediaId
};
Image marketingImage = new Image
{
mediaId = UploadImage(user, "https://goo.gl/3b9Wfh").mediaId
};
GmailTeaser teaser = new GmailTeaser
{
headline = "Dream",
description = "Create your own adventure",
businessName = "Interplanetary Ships",
logoImage = logoImage
};
// Creates a Gmail ad.
GmailAd gmailAd = new GmailAd
{
teaser = teaser,
marketingImage = marketingImage,
marketingImageHeadline = "Travel",
marketingImageDescription = "Take to the skies!",
finalUrls = new string[]
{
"http://www.example.com/"
}
};
// Creates ad group ad for the Gmail ad.
AdGroupAd adGroupAd = new AdGroupAd
{
adGroupId = adGroupId,
ad = gmailAd,
// Optional: Set additional settings.
status = AdGroupAdStatus.PAUSED
};
// Creates ad group ad operation and add it to the list.
AdGroupAdOperation operation = new AdGroupAdOperation
{
operand = adGroupAd,
@operator = Operator.ADD
};
try
{
// Adds a responsive display ad on the server.
AdGroupAdReturnValue result = adGroupAdService.mutate(new AdGroupAdOperation[]
{
operation
});
if (result == null || result.value == null || result.value.Length == 0)
{
Console.WriteLine("No Gmail ads were added.");
return;
}
// Prints out some information for each created Gmail ad.
foreach (AdGroupAd newAdGroupAd in result.value)
{
Console.WriteLine("A Gmail ad with ID {0} and headline '{1}' was added.",
newAdGroupAd.ad.id, (newAdGroupAd.ad as GmailAd).teaser.headline);
}
}
catch (Exception e)
{
throw new System.ApplicationException("Failed to add Gmail ads.", e);
}
}
}
/// <summary>
/// Uploads an image to the server.
/// </summary>
/// <param name="user">The AdWords user.</param>
/// <param name="url">The URL of image to upload.</param>
/// <returns>The created image.</returns>
private static Media UploadImage(AdWordsUser user, string url)
{
using (MediaService mediaService =
(MediaService) user.GetService(AdWordsService.v201809.MediaService))
{
Image image = new Image
{
data = MediaUtilities.GetAssetDataFromUrl(url, user.Config),
type = MediaMediaType.IMAGE
};
return mediaService.upload(new Media[]
{
image
})[0];
}
}
}
}