mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
4f8a3d571b
* Add Google APIs typings * [gapi.cliebt.* ] Add version as part of typings name and fix gapi.client tslint errors * versions should not get their own folders fixing a few typos using /** syntax so comments show up in editors export only actual (last) version for now * export only actual (last) version for now * merge namespaces and remove unnecessary namespace qualifiers * remove namespace qualifier for gapi.client.Request from nested namespaces and change Request base interface to Promise * disable await-promise rule * fix collision between gapi.client.Request and Request from nested namespace disable no-irregular-whitespace rule * sort properties and namespace resources * remove empty comments sort resources amd methods in tests and readme.md * update 'this is autogenerated file' banner to remove this text from gapi.client namespace hint use multiline comments when comment has several lines * implement no-trailing-whitespace, no-padding, max-line-length, await-promise, no-irregular-whitespace rules * add strictFunctionTypes to tsconfig * fix "Whitespace within parentheses is not allowed" rule * fix ts-lint rules * fixes * remove deprecated replicapool and replicapoolupdater api * fix no-irregular-whitespace * fix no-irregular-whitespace
3.0 KiB
3.0 KiB
TypeScript typings for DoubleClick Search API v2
Reports and modifies your advertising data in DoubleClick Search (for example, campaigns, ad groups, keywords, and conversions). For detailed description please check documentation.
Installing
Install typings for DoubleClick Search API:
npm install @types/gapi.client.doubleclicksearch@v2 --save-dev
Usage
You need to initialize Google API client in your code:
gapi.load("client", () => {
// now we can use gapi.client
// ...
});
Then load api client wrapper:
gapi.client.load('doubleclicksearch', 'v2', () => {
// now we can use gapi.client.doubleclicksearch
// ...
});
Don't forget to authenticate your client before sending any request to resources:
// declare client_id registered in Google Developers Console
var client_id = '',
scope = [
// View and manage your advertising data in DoubleClick Search
'https://www.googleapis.com/auth/doubleclicksearch',
],
immediate = true;
// ...
gapi.auth.authorize({ client_id: client_id, scope: scope, immediate: immediate }, authResult => {
if (authResult && !authResult.error) {
/* handle succesfull authorization */
} else {
/* handle authorization error */
}
});
After that you can use DoubleClick Search API resources:
/*
Retrieves a list of conversions from a DoubleClick Search engine account.
*/
await gapi.client.conversion.get({ advertiserId: "advertiserId", agencyId: "agencyId", endDate: 1, engineAccountId: "engineAccountId", rowCount: 1, startDate: 1, startRow: 1, });
/*
Inserts a batch of new conversions into DoubleClick Search.
*/
await gapi.client.conversion.insert({ });
/*
Updates a batch of conversions in DoubleClick Search. This method supports patch semantics.
*/
await gapi.client.conversion.patch({ advertiserId: "advertiserId", agencyId: "agencyId", endDate: 1, engineAccountId: "engineAccountId", rowCount: 1, startDate: 1, startRow: 1, });
/*
Updates a batch of conversions in DoubleClick Search.
*/
await gapi.client.conversion.update({ });
/*
Updates the availabilities of a batch of floodlight activities in DoubleClick Search.
*/
await gapi.client.conversion.updateAvailability({ });
/*
Generates and returns a report immediately.
*/
await gapi.client.reports.generate({ });
/*
Polls for the status of a report request.
*/
await gapi.client.reports.get({ reportId: "reportId", });
/*
Downloads a report file encoded in UTF-8.
*/
await gapi.client.reports.getFile({ reportFragment: 1, reportId: "reportId", });
/*
Inserts a report request into the reporting system.
*/
await gapi.client.reports.request({ });
/*
Retrieve the list of saved columns for a specified advertiser.
*/
await gapi.client.savedColumns.list({ advertiserId: "advertiserId", agencyId: "agencyId", });