-
Notifications
You must be signed in to change notification settings - Fork 0
/
channel_excluder.js
233 lines (210 loc) · 9.56 KB
/
channel_excluder.js
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
var SPREADSHEET_URL = "https://docs.google.com/spreadsheets/d/xxxx";
var SHEET_NAME = "Placements";
var EMAIL_ADRESSES = "[email protected]"; // comma separated
var allowedCountries = /^DE|AT|US|GB|CH$/; // Provide RegEx, e.g. /^DE$/ or /^DE|AT|CH$/ // ISO 3166-1 alpha-2 https://www.iso.org/obp/ui/#search
var impressionsTimeRange = "LAST_7_DAYS"; // valid ranges, see: https://developers.google.com/google-ads/api/docs/query/date-ranges
var impressionsThreshold = 1;
var MUSIC_TOPIC_CATEGORIES = [
"/m/04rlf", "/m/05fw6t", "/m/02mscn", "/m/0ggq0m", "/m/01lyv", "/m/02lkt", "/m/0glt670", "/m/05rwpb", "/m/03_d0", "/m/028sqc", "/m/0g293", "/m/064t9",
"/m/06cqb", "/m/06j6l", "/m/06by7", "/m/0gywn"
]
function main() {
// Prepare an array for logging purposes
var allExclusions = [];
// Fetch all active video campaigns and start iterating
var videoCampaignIterator = AdsApp.videoCampaigns().withCondition("Status = 'ENABLED'").get();
while (videoCampaignIterator.hasNext()) {
var alreadyExcludedYouTubeChannels = [];
var includedYouTubeChannelsFromGoogleAdsInterface = [];
var videoCampaign = videoCampaignIterator.next();
// Fetch all already excluded YouTube Channels from the processed campaign and store them in an array
var exludedYoutubeChannelIterator = videoCampaign.videoTargeting().excludedYouTubeChannels().get();
while (exludedYoutubeChannelIterator.hasNext()) {
var excludedYouTubeChannel = exludedYoutubeChannelIterator.next();
alreadyExcludedYouTubeChannels.push(excludedYouTubeChannel.getChannelId());
}
//Fetch YouTube Channels that have been included to the campaign, these channels will not be blacklisted even if they do not meet inclusion critera (Musc Channel, Country)
var selectedYouTubeChannels = videoCampaign.videoTargeting().youTubeChannels().get();
while (selectedYouTubeChannels.hasNext()) {
var selectedYouTubeChannel = selectedYouTubeChannels.next();
includedYouTubeChannelsFromGoogleAdsInterface.push(selectedYouTubeChannel.getChannelId());
}
// Build a batch with to be excluded YouTube channels
const toBeExcludedYouTubeChannels = checkYouTubeChannels(videoCampaign.getId(),alreadyExcludedYouTubeChannels, includedYouTubeChannelsFromGoogleAdsInterface);
// Exclude all YouTube channels in batch from campaign
for (i=0;i<toBeExcludedYouTubeChannels.length;i++){
videoCampaign.videoTargeting().newYouTubeChannelBuilder().withChannelId(toBeExcludedYouTubeChannels[i].id).exclude();
}
// Add logging information to log array
allExclusions.push({ campaign: videoCampaign.getName(), excludedYouTubeChannels: toBeExcludedYouTubeChannels })
}
// Prepare and send a notification email with logging information
sendConfirmationEmail(allExclusions);
}
function buildLikeQueryExtension(channelIDs){
var channels = "";
for (var i = 0; i < channelIDs.length; i++){
if(channelIDs[i].length > 0){
channels += " AND detail_placement_view.group_placement_target_url NOT LIKE '%"+channelIDs[i]+"%' ";
}
}
return channels
}
function checkYouTubeChannels(campaignId, alreadyExcludedYouTubeChannels, includedYouTubeChannelsFromGoogleAdsInterface){
// Prepare an array for the return values
var toBeExcludedYouTubeChannels = [];
// Load currently known allowed YouTube Channels from Google Sheet
var knownAllowedYouTubeChannels = getAllowedYouTubeChannels();
// Prepare an array for newly identified allowed YouTube Channels to be added to the Google Sheet
var newAllowedYouTubeChannels = [];
// Query all YouTube placements of the processed campaign with at least ${impressionsThreshold} impressions within the ${impressionsTimeRange}
var query =
"SELECT detail_placement_view.group_placement_target_url FROM detail_placement_view " +
"WHERE " +
" campaign.id = " + campaignId +
" AND segments.date DURING " + impressionsTimeRange +
" AND metrics.impressions > " + impressionsThreshold +
" AND detail_placement_view.placement_type IN ('YOUTUBE_VIDEO','YOUTUBE_CHANNEL') " +
" AND detail_placement_view.group_placement_target_url IS NOT NULL " +
buildLikeQueryExtension(alreadyExcludedYouTubeChannels) + buildLikeQueryExtension(includedYouTubeChannelsFromGoogleAdsInterface) + buildLikeQueryExtension(knownAllowedYouTubeChannels)
""
;
var result = AdsApp.search(query);
var channels = new Set()
while (result.hasNext()) {
var row = result.next();
var channelID = row['detailPlacementView']['groupPlacementTargetUrl'].match(/^.*\/([^\/]*)$/)[1];
channels.add(channelID)
}
console.log(channels.size+ " unique YouTube placements found");
//unique ids of channels are iterated here
for (const channelID of channels) {
const channelInfo = getChannelInfo(channelID);
var title = channelInfo.title
var topicIDs = channelInfo.topicIDs
var country = channelInfo.country
var language = channelInfo.language
var isMusicChannel = arrayContainsElementOf(MUSIC_TOPIC_CATEGORIES, topicIDs)
if (!isMusicChannel && country.match(allowedCountries)){
// Store channel id of newly identified YouTube Channel in array to be added to Google Sheet
newAllowedYouTubeChannels.push(channelID);
}
else {
toBeExcludedYouTubeChannels.push(
{
id: channelID,
name: title,
country: country,
language: language,
isMusicChannel: isMusicChannel
}
);
}
}
if (newAllowedYouTubeChannels.length > 0){
console.log(newAllowedYouTubeChannels.length + " new allowed Channel(s) found." + "\n\n");
saveAllowedYouTubeChannels(newAllowedYouTubeChannels);
}
return toBeExcludedYouTubeChannels.sort();
}
function arrayContainsElementOf(masterArray, searchArray){
for ( let i = 0; i < searchArray.length; i++){
var searchElement = searchArray[i];
for ( let j = 0; j < masterArray.length; j++){
var masterElement = masterArray[j];
if( masterElement == searchElement ){
return true;
}
}
}
return false;
}
function getChannelInfo(channelId){
try {
const results = YouTube.Channels.list('snippet,localizations, topicDetails', {
id: channelId,
maxResults: 1
});
if (results === null) {
console.log(`ID ${channelId}: Unable to search videos`);
return;
}
var topicIDs = []
var title = ""
var country = ""
var defaultLanguage = ""
if(results.items[0].hasOwnProperty('topicDetails')) {
if(results.items[0].topicDetails.hasOwnProperty('topicIds')) {
var topicDetails = results.items[0].topicDetails.topicIds;
for (var i = 0; i < topicDetails.length; i++){
topicIDs.push(topicDetails[i])
}
}
}
if(results.items[0].snippet.hasOwnProperty('title')){
title = results.items[0].snippet.title
}
if(results.items[0].snippet.hasOwnProperty('country')){
country = results.items[0].snippet.country
}
if(results.items[0].snippet.hasOwnProperty('defaultLanguage')){
defaultLanguage = results.items[0].snippet.defaultLanguage
}
var channelInformation = {}
channelInformation.country = country
channelInformation.defaultLanguage = defaultLanguage
channelInformation.topicIDs = topicIDs
channelInformation.title = title
return channelInformation
} catch (err) {
// TODO (developer) - Handle exceptions from Youtube API
console.log(`ID ${channelId}: Failed with an error: %s`, err.message);
}
}
function getAllowedYouTubeChannels(){
var sheet = SpreadsheetApp.openByUrl(SPREADSHEET_URL).getSheetByName(SHEET_NAME);
var lastRow = sheet.getLastRow();
if(lastRow < 1) {
lastRow = 1
}
var range = sheet.getRange(1, 1, lastRow);
var returnValues = [];
var values = range.getValues();
for (var row in values) {
for (var col in values[row]) {
returnValues.push(values[row][col]);
}
}
return returnValues;
}
function saveAllowedYouTubeChannels(newAllowedYouTubeChannels){
var sheet = SpreadsheetApp.openByUrl(SPREADSHEET_URL).getSheetByName(SHEET_NAME);
var lastRow = sheet.getLastRow();
var range = sheet.getRange(lastRow+1,1,newAllowedYouTubeChannels.length);
var outputValues = [];
while(newAllowedYouTubeChannels.length) outputValues.push(newAllowedYouTubeChannels.splice(0,1));
range.setValues(outputValues);
sheet.sort(1);
}
function sendConfirmationEmail(allExclusions){
var output = "";
for (i=0;i<allExclusions.length;i++){
output += allExclusions[i].excludedYouTubeChannels.length.toLocaleString("de") + " Channel(s) excluded from Campaign " + allExclusions[i].campaign + "\n\n";
var outputChannels = "";
for (j=0;j<allExclusions[i].excludedYouTubeChannels.length;j++){
outputChannels += allExclusions[i].excludedYouTubeChannels[j].name + " (Country: " + allExclusions[i].excludedYouTubeChannels[j].country + "| Language: " + allExclusions[i].excludedYouTubeChannels[j].language + " | Is Music Channel: " + allExclusions[i].excludedYouTubeChannels[j].isMusicChannel + ")\n";
outputChannels += "https://youtube.com/channel/" + allExclusions[i].excludedYouTubeChannels[j].id + "\n\n";
}
output += outputChannels;
}
var eMailAddress = EMAIL_ADRESSES;
var eMailSubject = "YouTube Channel Excluder";
var eMailContent = output;
console.log(output);
sendSimpleTextEmail(eMailAddress,eMailSubject,eMailContent)
}
// HELPERS
function sendSimpleTextEmail(eMailAddress,eMailSubject,eMailContent) {
MailApp.sendEmail(eMailAddress,eMailSubject,eMailContent);
Logger.log("Mail sent.");
}