-
Notifications
You must be signed in to change notification settings - Fork 199
/
GetKeywordIdeas.cs
executable file
·212 lines (187 loc) · 8.68 KB
/
GetKeywordIdeas.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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
// 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 System;
using System.Collections.Generic;
namespace Google.Api.Ads.AdWords.Examples.CSharp.v201809
{
/// <summary>
/// This code example retrieves keywords that are related to a given keyword.
/// </summary>
public class GetKeywordIdeas : 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)
{
GetKeywordIdeas codeExample = new GetKeywordIdeas();
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 retrieves keywords that are related to a given keyword.";
}
}
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="user">The AdWords user.</param>
/// <param name="adGroupId">ID of the ad group to use for generating ideas.</param>
public void Run(AdWordsUser user, long? adGroupId)
{
using (TargetingIdeaService targetingIdeaService =
(TargetingIdeaService) user.GetService(AdWordsService.v201809.TargetingIdeaService))
{
// Create selector.
TargetingIdeaSelector selector = new TargetingIdeaSelector
{
requestType = RequestType.IDEAS,
ideaType = IdeaType.KEYWORD,
requestedAttributeTypes = new AttributeType[]
{
AttributeType.KEYWORD_TEXT,
AttributeType.SEARCH_VOLUME,
AttributeType.AVERAGE_CPC,
AttributeType.COMPETITION,
AttributeType.CATEGORY_PRODUCTS_AND_SERVICES
}
};
List<SearchParameter> searchParameters = new List<SearchParameter>();
// Create related to query search parameter.
RelatedToQuerySearchParameter relatedToQuerySearchParameter =
new RelatedToQuerySearchParameter
{
queries = new string[]
{
"bakery",
"pastries",
"birthday cake"
}
};
searchParameters.Add(relatedToQuerySearchParameter);
// Add a language search parameter (optional).
// The ID can be found in the documentation:
// https://developers.google.com/adwords/api/docs/appendix/languagecodes
LanguageSearchParameter languageParameter = new LanguageSearchParameter();
Language english = new Language
{
id = 1000
};
languageParameter.languages = new Language[]
{
english
};
searchParameters.Add(languageParameter);
// Add network search parameter (optional).
NetworkSetting networkSetting = new NetworkSetting
{
targetGoogleSearch = true,
targetSearchNetwork = false,
targetContentNetwork = false,
targetPartnerSearchNetwork = false
};
NetworkSearchParameter networkSearchParameter = new NetworkSearchParameter
{
networkSetting = networkSetting
};
searchParameters.Add(networkSearchParameter);
// Optional: Use an existing ad group to generate ideas.
if (adGroupId != null)
{
SeedAdGroupIdSearchParameter seedAdGroupIdSearchParameter =
new SeedAdGroupIdSearchParameter
{
adGroupId = adGroupId.Value
};
searchParameters.Add(seedAdGroupIdSearchParameter);
}
// Set the search parameters.
selector.searchParameters = searchParameters.ToArray();
// Set selector paging (required for targeting idea service).
selector.paging = Paging.Default;
TargetingIdeaPage page = new TargetingIdeaPage();
try
{
int i = 0;
do
{
// Get related keywords.
page = targetingIdeaService.get(selector);
// Display related keywords.
if (page.entries != null && page.entries.Length > 0)
{
foreach (TargetingIdea targetingIdea in page.entries)
{
Dictionary<AttributeType, Google.Api.Ads.AdWords.v201809.Attribute>
ideas = targetingIdea.data.ToDict();
string keyword =
(ideas[AttributeType.KEYWORD_TEXT] as StringAttribute).value;
IntegerSetAttribute categorySet =
ideas[AttributeType.CATEGORY_PRODUCTS_AND_SERVICES] as
IntegerSetAttribute;
string categories = "";
if (categorySet != null && categorySet.value != null)
{
categories = string.Join(", ", categorySet.value);
}
long averageMonthlySearches =
(ideas[AttributeType.SEARCH_VOLUME] as LongAttribute).value;
Money averageCpc =
(ideas[AttributeType.AVERAGE_CPC] as MoneyAttribute).value;
double competition =
(ideas[AttributeType.COMPETITION] as DoubleAttribute).value;
Console.WriteLine(
"Keyword with text '{0}', average monthly search volume {1}, " +
"average CPC {2}, and competition {3:F2} was found with " +
"categories: {4}", keyword, averageMonthlySearches,
averageCpc?.microAmount, competition, categories);
Console.WriteLine(
"Keyword with text '{0}', and average monthly search volume " +
"'{1}' was found with categories: {2}", keyword,
averageMonthlySearches, categories);
i++;
}
}
selector.paging.IncreaseOffset();
} while (selector.paging.startIndex < page.totalNumEntries);
Console.WriteLine("Number of related keywords found: {0}",
page.totalNumEntries);
}
catch (Exception e)
{
throw new System.ApplicationException("Failed to retrieve related keywords.",
e);
}
}
}
}
}