Rechercher des annonces ou des mots clés avec des URL rompues
Cette solution montre comment case activée des annonces ou des mots clés avec des URL rompues. Le script effectue la case activée sur toutes les annonces ou mots clés dans les comptes auxquels l’utilisateur a accès. Voici le flux de haut niveau du script. Pour plus d’informations, lisez les commentaires inline.
- Avant d’exécuter, définissez les variables NOTIFY et ENTITY_NAME. Définissez la variable NOTIFY sur la liste des adresses e-mail à laquelle vous souhaitez envoyer les résultats du script. Et définissez la variable ENTITY_NAME pour spécifier si vous souhaitez case activée des annonces ou des mots clés (la valeur par défaut est les annonces).
- Lit un fichier à partir de Google Drive. Le fichier contient une liste d’objets. Chaque objet contient un ID de compte et un horodatage de la dernière vérification des URL rompues du compte. La première fois que le script s’exécute, le fichier ne doit pas exister. Si le fichier n’existe pas, le script génère la liste complète des comptes auxquels l’utilisateur a accès. Notez que le script ne récupère pas les nouveaux comptes qui ont été ajoutés après la génération du fichier. Si des comptes ont été ajoutés, vous devez supprimer le fichier afin qu’il génère une nouvelle liste de comptes.
- Trie la liste des comptes afin que les comptes qui n’ont pas été vérifiés ou qui sont les plus anciens apparaissent en premier.
- Obtient jusqu’aux 50 premiers ID de compte de la liste et appelle la méthode executeInParallel du sélecteur. La méthode exécute en parallèle la
findBrokenUrls
fonction pour chaque compte. Cette fonction retourne un objet qui contient les informations du compte et la liste des annonces ou mots clés avec des URL rompues, le cas échéant. - Exécute la
reportResults
fonction une fois tous les appels de fonctionfindBrokenUrls
terminés. Cette fonction crée une feuille de calcul et utilise Google Sheets pour créer une feuille pour chaque compte. Si le compte contient des annonces ou des mots clés avec des URL rompues, il écrit l’entité dans la feuille. - Utilise Google Mail pour envoyer une notification par e-mail aux destinataires spécifiés. L’e-mail indique si un compte contient des URL rompues et fournit un lien vers la feuille où il peut voir les détails.
- Mises à jour le
lastChecked
champ pour chaque compte et enregistre le fichier. La prochaine fois que le script s’exécute, il trie la liste des comptes parlastChecked
horodatage. Cela signifie que tous les comptes qui n’ont pas été traités ou qui sont les plus anciens seront en premier dans la liste. Ce script doit s’exécuter une ou plusieurs fois en fonction du nombre de comptes dont vous disposez.
Avant d’utiliser cet exemple, consultez Authentification avec les services Google pour connaître les options permettant d’obtenir un jeton d’accès à utiliser dans cette solution.
Remarque
Remplacez la fonction main et tout ce qui se trouve dans l’éditeur de code par cet exemple de script.
// Add a comma-delimited list of email addresses that should receive the
// notification email
const NOTIFY = ['someone@example.com'];
// Set this value to 'Ad' to check ad URLs or 'Keyword' to check keyword URLs
const ENTITY_NAME = 'Ad'; // Valid values: 'Ad', 'Keyword'
const SCRIPT_NAME = `Microsoft Advertising - ${ENTITY_NAME} URL Checker`;
const ACCOUNTS_FILE_NAME = `MicrosoftAds-Scripts-Broken${ENTITY_NAME}Urls-AccountList.json`;
const SPREADSHEET_PREFIX = `MicrosoftAds-Scripts-Broken${ENTITY_NAME}Urls`;
const ACCOUNT_BATCH_SIZE = 50;
// Set this value to true to get an email even if no broken URLs were found
const SEND_EMAIL_EVEN_IF_NO_BROKEN_URLS_FOUND = false;
// Set this value to true to include inactive entities in the check
const INCLUDE_INACTIVE_ENTITIES = false;
// Add custom response checks to this function if needed
const checkResponse = function (url, response, entity) {
/*
var responseText = response.getContentText();
if (responseText.includes('out of stock')) {
return { isGood: false, error: 'Received out of stock response' };
}
*/
return { isGood: true };
}
// See this page to get Google credentials: https://learn.microsoft.com/advertising/scripts/examples/authenticating-with-google-services
// If you chose option 1 in Getting an access token, set accessToken to
// the token you received from Google OAuth playground. Otherwise, if you
// chose option 2, set clientId, clientSecret, and refreshToken.
const credentials = {
accessToken: '',
clientId: '',
clientSecret: '',
refreshToken: ''
};
function main() {
const remainingQuota = UrlFetchApp.getRemainingDailyQuota();
if (remainingQuota < 50) {
Logger.log(`Remaining URL fetch quota ${remainingQuota} is not enough to run this script now`);
return;
}
// If it's the first time the script has run, the function creates
// the JSON file. The file contains a list of JSON objects.
// Each object contains an account ID field (id) and a time
// stamp field (lastChecked) when the account was last checked
// for broken URLs.
createFileIfNotExists(ACCOUNTS_FILE_NAME, false);
// Load the list of objects from the JSON file, or if the file is empty,
// set the list to empty.
const accountsList = loadObject(ACCOUNTS_FILE_NAME) || [];
// If the JSON file is empty, get a list of accounts the user
// has access to. For each account, create an object that contains
// the id field and lastChecked field. Then add it to accountsList.
// Note that if the file exists, accountsList will not include
// new accounts that were added since the script last ran. To ensure
// that the list contains all accounts, consider deleting the file
// periodically or after you add an account.
if (accountsList.length === 0) {
const accounts = AccountsApp.accounts().get();
while (accounts.hasNext()) {
const account = accounts.next();
accountsList.push({
id: account.getAccountId(),
lastChecked: '',
lastCheckedId: '0'
});
}
}
// Sort the list by lastChecked. This ensures that unprocessed accounts
// (i.e., lastChecked: '') in accountsList are first in the list. If all
// accounts have been processed, the accounts with the oldest lastChecked
// time stamp are first.
accountsList.sort((a, b) => a.lastChecked.localeCompare(b.lastChecked));
// Save the list of JSON objects back to the file. The file is opened
// again in reportResults() to update the lastChecked field with
// the time stamp of when the account was processed.
saveObject(accountsList, ACCOUNTS_FILE_NAME);
// Get a maximum of the first 50 accounts (ACCOUNT_BATCH_SIZE) from accountsList.
// Each time the script runs, it grabs the next 50 accounts until eventually
// the script processes all the accounts.
const accountsToCheck = accountsList.slice(0, ACCOUNT_BATCH_SIZE);
const accountIds = accountsToCheck.map(x => x.id);
Logger.log('Checking the following accounts: ' + JSON.stringify(accountIds));
// Use the executeInParallel method to execute the findBrokenUrls function
// for all 50 accounts in parallel. When findBrokenUrls finishes with all
// 50 accounts, Scripts calls the reportResults function.
AccountsApp.accounts().withIds(accountIds).executeInParallel('findBrokenUrls', 'reportResults', JSON.stringify(accountsToCheck));
}
const URL_FETCH_QUOTA_EXCEEDED = 'URL fetch quota exceeded';
// The script executes this function in parallel for each account that the
// BingAdsAccountSelector returns (see the executeInParallel call in main()).
// Each account in the selector becomes the current account for each instance
// of findBrokenUrls().
function findBrokenUrls(accountsToCheckJson) {
const currentAccount = AdsApp.currentAccount();
const currentAccountInfo = `${currentAccount.getName()} ${currentAccount.getAccountId()} (${currentAccount.getAccountNumber()})`;
Logger.log(`Processing account: ${currentAccountInfo}`);
const results = [];
// Contains a list of entity fields.
let columns;
let entityName = ENTITY_NAME;
switch (entityName) {
case 'Keyword':
columns = [
{ name: 'Campaign', func: keyword => keyword.getCampaign().getName() },
{ name: 'Campaign Id', func: keyword => keyword.getCampaign().getId() },
{ name: 'AdGroup', func: keyword => keyword.getAdGroup().getName() },
{ name: 'AdGroup Id', func: keyword => keyword.getAdGroup().getId() },
{ name: 'Keyword', func: keyword => keyword.getText() },
{ name: 'Keyword Id', func: keyword => keyword.getId() },
{ name: 'Match Type', func: keyword => keyword.getMatchType() },
{ name: 'Final Url', func: keyword => keyword.urls().getFinalUrl() },
{ name: 'HTTP code', func: keyword => keyword['checkResult'].code },
{ name: 'Error', func: keyword => keyword['checkResult'].error }
];
break;
case 'Ad':
columns = [
{ name: 'Campaign', func: ad => ad.getCampaign().getName() },
{ name: 'Campaign Id', func: ad => ad.getCampaign().getId() },
{ name: 'AdGroup', func: ad => ad.getAdGroup().getName() },
{ name: 'AdGroup Id', func: ad => ad.getAdGroup().getId() },
{ name: 'Id', func: ad => ad.getId() },
{ name: 'Type', func: ad => ad.getType() },
{ name: 'Title', func: ad => ad.getHeadline() },
{ name: 'Title 1', func: ad => ad.isType().expandedTextAd() ? ad.asType().expandedTextAd().getHeadlinePart1() : null },
{ name: 'Title 2', func: ad => ad.isType().expandedTextAd() ? ad.asType().expandedTextAd().getHeadlinePart2() : null },
{ name: 'Text', func: ad => ad.getDescription() },
{ name: 'Display Url', func: ad => ad.getDisplayUrl() },
{ name: 'Destination Url', func: ad => ad.getDestinationUrl() },
{ name: 'Final Url', func: ad => ad.urls().getFinalUrl() },
{ name: 'Path 1', func: ad => ad.isType().expandedTextAd() ? ad.asType().expandedTextAd().getPath1() : null },
{ name: 'Path 2', func: ad => ad.isType().expandedTextAd() ? ad.asType().expandedTextAd().getPath2() : null },
{ name: 'HTTP code', func: ad => ad['checkResult'].code },
{ name: 'Error', func: ad => ad['checkResult'].error }
];
break;
}
let executionInfo = AdsApp.getExecutionInfo();
let allEntitiesChecked = false;
let checkedEntitiesCount = 0;
let lastCheckedId = JSON.parse(accountsToCheckJson).filter(x => x.id == currentAccount.getAccountId())[0].lastCheckedId;
while (true) {
let entitySelector;
switch (entityName) {
case 'Keyword':
entitySelector = AdsApp.keywords();
break;
case 'Ad':
entitySelector = AdsApp.ads();
break;
}
entitySelector = entitySelector
.withCondition(`Id > ${lastCheckedId}`);
if (!INCLUDE_INACTIVE_ENTITIES) {
entitySelector = entitySelector
.withCondition('CampaignStatus = ENABLED')
.withCondition('AdGroupStatus = ENABLED')
.withCondition('Status = ENABLED');
}
const notCheckedEntities = entitySelector.orderBy('Id ASC').get();
allEntitiesChecked = notCheckedEntities.totalNumEntities() == 0;
if (allEntitiesChecked) {
Logger.log(`All ${ENTITY_NAME}s have been checked for account ${currentAccountInfo}`);
lastCheckedId = '0';
break;
} else {
Logger.log(`Checking up to ${notCheckedEntities.totalNumEntities()} ${ENTITY_NAME}s for account ${currentAccountInfo}`);
let processedEntitiesCountInBatch = 0;
let timeLimitReached = false;
let urlFetchLimitReached = false;
while (notCheckedEntities.hasNext()) {
const entity = notCheckedEntities.next();
processedEntitiesCountInBatch++;
// Make sure the script has time to finish processing
// the entity, so the script ends cleanly
if (executionInfo.getRemainingTime() < 180) {
timeLimitReached = true;
break;
}
let url = entity.urls().getFinalUrl();
if (!url && entityName == 'Ad') {
url = entity.getDestinationUrl();
}
if (url) {
try {
const urlCheckResult = checkUrlWithCache(url, entity);
if (!urlCheckResult.isGood) {
entity['checkResult'] = urlCheckResult;
const entityResult = columns.reduce((temp, column) => { temp[column.name] = column.func(entity); return temp }, {});
results.push(entityResult);
}
} catch (e) {
if (e == URL_FETCH_QUOTA_EXCEEDED) {
urlFetchLimitReached = true;
break;
}
throw e;
}
}
lastCheckedId = entity.getId();
checkedEntitiesCount++;
}
if (processedEntitiesCountInBatch == 0) {
Logger.log(`Stopping processing for account ${currentAccountInfo} since entity limit has been reached`);
break;
}
if (timeLimitReached) {
Logger.log(`Stopping processing for account ${currentAccountInfo} since time limit has been reached`);
break;
}
if (urlFetchLimitReached) {
Logger.log(`Stopping processing for account ${currentAccountInfo} since URL fetch limit has been reached`);
break;
}
}
Logger.log(`Found ${results.length} broken ${ENTITY_NAME}(s) for account ${currentAccountInfo}`);
}
// Create an object that identifies the account and its
// list of entities with a broken URL, if any. Convert it to a string that's
// past to the reportResults function when all instances of
// this function finish.
return JSON.stringify({
customerId: currentAccount.getCustomerId(),
accountId: currentAccount.getAccountId(),
accountNumber: currentAccount.getAccountNumber(),
accountName: currentAccount.getName(),
brokenEntitiesCount: results.length,
brokenEntities: { rows: results, headers: columns.map(x => x.name) },
allEntitiesChecked: allEntitiesChecked,
checkedEntitiesCount: checkedEntitiesCount,
lastCheckedId: lastCheckedId
});
}
let urlCheckCache = {};
function checkUrlWithCache(url, entity) {
const cachedResult = urlCheckCache[url];
if (cachedResult) {
return cachedResult;
}
const checkResult = checkUrl(url, entity);
urlCheckCache[url] = checkResult;
return checkResult;
}
function checkUrl(url, entity) {
const remainingQuota = UrlFetchApp.getRemainingDailyQuota();
// Make sure the script has enough calls left in its quota to
// finish processing the entity, so the script ends cleanly
if (remainingQuota < 30) {
throw URL_FETCH_QUOTA_EXCEEDED;
}
let response;
try {
response = UrlFetchApp.fetch(url, { muteHttpExceptions: true, headers: { 'User-Agent': 'Mozilla/5.0 (compatible; Microsoft-Ads-Url-Checker)' } });
} catch (e) {
return { isGood: false, error: e.message };
}
const code = response.getResponseCode();
if (code >= 200 && code <= 299) {
return checkResponse(url, response, entity);
}
return { isGood: false, code: code };
}
// Scripts calls this function for each account when findBrokenUrls
// finishes processing all accounts.
// This function creates a spreadsheet that contains a sheet for each
// account. It then sends an email notification to the list of
// recipients in 'NOTIFY'.
function reportResults(results) {
Logger.log('Reporting results');
const sheetResults = [];
// Create a sheet object for each account in the list of results.
for (const result of results) {
if (!result.getReturnValue()) {
Logger.log(`Got an error in result: ${result.getError()}`);
continue;
}
const accountResult = JSON.parse(result.getReturnValue());
const sheetName = `${accountResult.accountId} (${accountResult.accountNumber})`;
sheetResults.push({ accountResult: accountResult, sheetName: sheetName });
}
// Gets a time stamp. The .replace function removes the u2003 character that
// toLocaleString() adds to the date string.
const dateTimeStr = new Date().toISOString().replace(/\u200e/g, '');
// Create the spreadsheet file.
const spreadsheetName = `${SPREADSHEET_PREFIX} ${dateTimeStr}`;
const spreadsheetId = createFileIfNotExists(spreadsheetName, true);
// Adds a sheet for each account to the spreadsheet.
const createSheetsResponse = createSheets(spreadsheetId, sheetResults.map(x => x.sheetName));
// Get the original accounts list, so the script can
// update the lastChecked time stamp.
const accountsList = loadObject(ACCOUNTS_FILE_NAME);
const accountsById = accountsList.reduce((map, acc) => (map[acc.id] = acc, map), {});
const sheetsByName = createSheetsResponse.updatedSpreadsheet.sheets.reduce((map, sheet) => (map[sheet.properties.title] = sheet, map), {});
const spreadsheetRows = [];
const summaryEmailData = [];
// Builds the sheet information.
for (const sheetResult of sheetResults) {
const accountResult = sheetResult.accountResult;
const sheetRows = [accountResult.brokenEntities.headers];
for (const row of accountResult.brokenEntities.rows) {
const rowValues = accountResult.brokenEntities.headers.map(x => row[x]);
sheetRows.push(rowValues);
}
const sheetId = sheetsByName[sheetResult.sheetName].properties.sheetId;
spreadsheetRows.push({ sheetId: sheetId, rows: sheetRows });
summaryEmailData.push({
customerId: accountResult.customerId,
accountId: accountResult.accountId,
accountNumber: accountResult.accountNumber,
accountName: accountResult.accountName,
brokenEntitiesCount: accountResult.brokenEntitiesCount,
checkedEntitiesCount: accountResult.checkedEntitiesCount,
sheetId: sheetId
});
accountsById[accountResult.accountId].lastCheckedId = accountResult.lastCheckedId;
if (accountResult.allEntitiesChecked) {
accountsById[accountResult.accountId].lastChecked = dateTimeStr;
}
}
writeRowsToSpreadsheet(spreadsheetRows, spreadsheetId);
sendSummaryEmailIfNeeded(summaryEmailData, spreadsheetId);
saveObject(accountsList, ACCOUNTS_FILE_NAME);
}
// Send an email to recipients with a list of the accounts and any
// entities with a broken URL. The recipient can click the embedded
// link to access the spreadsheet that contains details about
// the entities.
function sendSummaryEmailIfNeeded(summaryEmailData, spreadsheetId) {
if (summaryEmailData.length == 0) {
return;
}
let totalbrokenEntitiesCount = summaryEmailData.reduce((sum, accountData) => sum + accountData.brokenEntitiesCount, 0);
if (totalbrokenEntitiesCount == 0 && !SEND_EMAIL_EVEN_IF_NO_BROKEN_URLS_FOUND) {
Logger.log("Skipping email notification since no broken urls were found");
return;
}
const subject = `${SCRIPT_NAME} Summary - Found ${totalbrokenEntitiesCount} ${ENTITY_NAME}(s)`;
// Gets a link to the file to include in the email notification.
const fileUrl = shareFileWithLink(spreadsheetId);
const messageHtml =
`<html>
<body>
${subject}
<br/ ><br/ >
<table border="1" width="95%" style="border-collapse:collapse;">
<tr>
<th align="left">Customer Id</th>
<th align="left">Account Id</th>
<th align="left">Account Number</th>
<th align="left">Account Name</th>
<th align="center">${ENTITY_NAME}s With Broken URL Found</th>
<th align="center">Full Report</th>
<th align="center">Total ${ENTITY_NAME}s Checked</th>
</tr>
${summaryEmailData.map(row =>
`<tr>
<td align="left">${row.customerId}</td>
<td align="left">${row.accountId}</td>
<td align="left">${row.accountNumber}</td>
<td align="left">${row.accountName}</td>
<td align="center">${row.brokenEntitiesCount}</td>
<td align="center"><a href="${fileUrl}#gid=${row.sheetId}">Show Details</a></td>
<td align="center">${row.checkedEntitiesCount}</td>
</tr>`).join('')}
</table>
<br/ >
${new Date().toUTCString()}. Completed. ${summaryEmailData.length} accounts checked.
</body>
</html>`;
for (const i in NOTIFY) {
const email =
`To: ${NOTIFY[i]}
Subject: ${subject}
Content-Type: text/html; charset="utf-8"
${messageHtml}`;
getGmailApi().users.messages.send({ userId: 'me' }, { raw: Base64.encode(email) });
}
}
// Calls to get Google services.
const getSheetsApi = (() => {
let sheetsApi;
return () => sheetsApi || (sheetsApi = GoogleApis.createSheetsService(credentials));
})();
const getDriveApi = (() => {
let driveApi;
return () => driveApi || (driveApi = GoogleApis.createDriveService(credentials));
})();
const getGmailApi = (() => {
let gmailApi;
return () => gmailApi || (gmailApi = GoogleApis.createGmailService(credentials));
})();
// Creates each sheet in the spreadsheet.
function createSheets(spreadsheetId, sheetNames) {
const requests = sheetNames.map(x => ({ addSheet: { properties: { title: x } } }));
const response = getSheetsApi().spreadsheets.batchUpdate({ spreadsheetId: spreadsheetId }, {
requests: requests,
includeSpreadsheetInResponse: true
}).result;
return response;
}
// Writes the entities and broken URLs to each sheet.
function writeRowsToSpreadsheet(spreadsheetRows, spreadsheetId) {
const requests = spreadsheetRows.map(sheetRows => ({
appendCells: {
sheetId: sheetRows.sheetId,
rows: sheetRows.rows.map(row => ({
values: row.map(columnValue => ({
userEnteredValue: { stringValue: columnValue ? columnValue.toString() : columnValue }
}))
})),
fields: '*'
}
}));
getSheetsApi().spreadsheets.batchUpdate({ spreadsheetId: spreadsheetId }, {
requests: requests,
includeSpreadsheetInResponse: false
});
}
// Returns a link to the spreadsheet. The script includes
// the link in the email notification.
function shareFileWithLink(fileId) {
// Set up permissions, so the recipient doesn't have to
// sign in.
getDriveApi().permissions.create({ fileId: fileId }, {
type: 'anyone',
role: 'reader',
allowFileDiscovery: false
});
const fileResponse = getDriveApi().files.get({ fileId: fileId, fields: 'webViewLink' }).result;
return fileResponse.webViewLink;
}
function findFileId(fileName) {
const req = escape(`name = '${fileName}'`);
const searchResult = getDriveApi().files.list({ q: req }).result;
if (searchResult.files.length > 0) {
return searchResult.files[0].id;
}
return null;
}
function createFileIfNotExists(fileName, isSpreadsheet) {
const existingFileId = findFileId(fileName);
if (existingFileId) {
return existingFileId;
}
const createResult = getDriveApi().files.create({}, {
name: fileName,
mimeType: isSpreadsheet ? 'application/vnd.google-apps.spreadsheet' : 'application/vnd.google-apps.document'
}).result;
return createResult.id;
}
function saveObject(obj, fileName) {
const fileId = createFileIfNotExists(fileName, false);
getDriveApi().files.update({ fileId: fileId }, JSON.stringify(obj), { uploadType: 'simple', contentType: 'text/plain' });
}
function loadObject(fileName) {
const fileId = findFileId(fileName);
if (!fileId) {
throw new Error(`File ${fileName} not found`);
}
const fileData = getDriveApi().files.export({ fileId: fileId, mimeType: 'text/plain' }).body.trim();
if (fileData) {
return JSON.parse(fileData.trim());
} else {
return null;
}
}
// Common Google library code that all Scripts that access Google
// services will include.
var GoogleApis;
(function (GoogleApis) {
GoogleApis.createSheetsService = credentials => createService("https://sheets.googleapis.com/$discovery/rest?version=v4", credentials);
GoogleApis.createDriveService = credentials => createService("https://www.googleapis.com/discovery/v1/apis/drive/v3/rest", credentials);
GoogleApis.createGmailService = credentials => createService("https://www.googleapis.com/discovery/v1/apis/gmail/v1/rest", credentials);
// Creation logic based on https://developers.google.com/discovery/v1/using#usage-simple
function createService(url, credentials) {
const content = UrlFetchApp.fetch(url).getContentText();
const discovery = JSON.parse(content);
const accessToken = getAccessToken(credentials);
const standardParameters = discovery.parameters;
const service = build(discovery, {}, discovery['rootUrl'], discovery['servicePath'], standardParameters, accessToken);
return service;
}
function createNewMethod(method, rootUrl, servicePath, standardParameters, accessToken) {
return (urlParams, body, uploadParams) => {
let urlPath = method.path;
if (uploadParams) {
if (!method.supportsMediaUpload) {
throw new Error(`Media upload is not supported`);
}
const uploadProtocols = method.mediaUpload.protocols;
const uploadType = uploadParams.uploadType;
switch (uploadType) {
case 'simple':
const simpleProtocol = uploadProtocols.simple;
if (!simpleProtocol) {
throw new Error(`Upload protocol ${uploadType} is not supported`);
}
urlPath = simpleProtocol.path;
break;
case 'resumable':
const resumableProtocol = uploadProtocols.resumable;
if (!resumableProtocol) {
throw new Error(`Upload protocol ${uploadType} is not supported`);
}
urlPath = resumableProtocol.path;
break;
default:
throw new Error(`Unknown upload type ${uploadType}`);
}
}
const queryArguments = [];
for (const name in urlParams) {
const paramConfg = method.parameters[name] || standardParameters[name];
if (!paramConfg) {
throw new Error(`Unexpected url parameter ${name}`);
}
switch (paramConfg.location) {
case 'path':
urlPath = urlPath.replace('{' + name + '}', urlParams[name]);
break;
case 'query':
queryArguments.push(`${name}=${urlParams[name]}`);
break;
default:
throw new Error(`Unknown location ${paramConfg.location} for url parameter ${name}`);
}
}
if (uploadParams) {
queryArguments.push(`uploadType=${uploadParams.uploadType === 'simple' ? 'media' : uploadParams.uploadType}`);
}
let url = rootUrl;
if (urlPath.startsWith('/')) {
url += urlPath.substring(1);
} else {
url += servicePath + urlPath;
}
if (queryArguments.length > 0) {
url += '?' + queryArguments.join('&');
}
const payload = uploadParams ? body : JSON.stringify(body);
const contentType = uploadParams ? uploadParams.contentType : 'application/json';
const fetchParams = { contentType: contentType, method: method.httpMethod, payload: payload, headers: { Authorization: `Bearer ${accessToken}` }, muteHttpExceptions: true };
const httpResponse = UrlFetchApp.fetch(url, fetchParams);
const responseContent = httpResponse.getContentText();
const responseCode = httpResponse.getResponseCode();
let parsedResult;
try {
parsedResult = JSON.parse(responseContent);
} catch (e) {
parsedResult = false;
}
const response = new Response(parsedResult, responseContent, responseCode);
if (responseCode >= 200 && responseCode <= 299) {
return response;
}
throw new Error(response.toString());
}
}
function Response(result, body, status) {
this.result = result;
this.body = body;
this.status = status;
}
Response.prototype.toString = function () {
return this.body;
}
function build(discovery, collection, rootUrl, servicePath, standardParameters, accessToken) {
for (const name in discovery.resources) {
const resource = discovery.resources[name];
collection[name] = build(resource, {}, rootUrl, servicePath, standardParameters, accessToken);
}
for (const name in discovery.methods) {
const method = discovery.methods[name];
collection[name] = createNewMethod(method, rootUrl, servicePath, standardParameters, accessToken);
}
return collection;
}
function getAccessToken(credentials) {
if (credentials.accessToken) {
return credentials.accessToken;
}
const tokenResponse = UrlFetchApp.fetch('https://www.googleapis.com/oauth2/v4/token', { method: 'post', contentType: 'application/x-www-form-urlencoded', muteHttpExceptions: true, payload: { client_id: credentials.clientId, client_secret: credentials.clientSecret, refresh_token: credentials.refreshToken, grant_type: 'refresh_token' } });
const responseCode = tokenResponse.getResponseCode();
const responseText = tokenResponse.getContentText();
if (responseCode >= 200 && responseCode <= 299) {
const accessToken = JSON.parse(responseText)['access_token'];
return accessToken;
}
throw new Error(responseText);
}
})(GoogleApis || (GoogleApis = {}));
// https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/master/lib/msal-core/src/Utils.ts
class Base64 {
static encode(input) {
const keyStr = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=";
let output = "";
let chr1, chr2, chr3, enc1, enc2, enc3, enc4;
let i = 0;
input = this.utf8Encode(input);
while (i < input.length) {
chr1 = input.charCodeAt(i++);
chr2 = input.charCodeAt(i++);
chr3 = input.charCodeAt(i++);
enc1 = chr1 >> 2;
enc2 = ((chr1 & 3) << 4) | (chr2 >> 4);
enc3 = ((chr2 & 15) << 2) | (chr3 >> 6);
enc4 = chr3 & 63;
if (isNaN(chr2)) {
enc3 = enc4 = 64;
}
else if (isNaN(chr3)) {
enc4 = 64;
}
output = output + keyStr.charAt(enc1) + keyStr.charAt(enc2) + keyStr.charAt(enc3) + keyStr.charAt(enc4);
}
return output.replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/, "");
}
static utf8Encode(input) {
input = input.replace(/\r\n/g, "\n");
let utftext = "";
for (let n = 0; n < input.length; n++) {
const c = input.charCodeAt(n);
if (c < 128) {
utftext += String.fromCharCode(c);
}
else if ((c > 127) && (c < 2048)) {
utftext += String.fromCharCode((c >> 6) | 192);
utftext += String.fromCharCode((c & 63) | 128);
}
else {
utftext += String.fromCharCode((c >> 12) | 224);
utftext += String.fromCharCode(((c >> 6) & 63) | 128);
utftext += String.fromCharCode((c & 63) | 128);
}
}
return utftext;
}
}