@niur/google-admanager-api
Version:
Google Ad Manager API Client Library for NodeJs
39 lines • 3.01 kB
TypeScript
import { CreativeSet, CreativeSetPage } from './creativeSet.type';
import { Statement } from '../../../common/types';
/**
* Provides operations for creating, updating and retrieving {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeSetService.CreativeSet CreativeSet} objects.
*/
export interface CreativeSetServiceOperations {
/**
* Creates new {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeSetService.CreativeSet CreativeSet} objects.
*
* @param creativeSet the creative set to create
* @returns the created creative set with their IDs filled in
*/
createCreativeSet(creativeSet: CreativeSet): Promise<CreativeSet>;
/**
* Gets a {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeSetService.CreativeSetPage CreativeSetPage}
* of {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeSetService.CreativeSet CreativeSet} objects that satisfy the given
* {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeSetService.Statement#query Statement.query}.
* The following fields are supported for filtering:
*
* | PQL Property | PQL Property |
* | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
* | id | {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeSetService.CreativeSet#id CreativeSet.id} |
* | name | {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeSetService.CreativeSet#name CreativeSet.name} |
* | masterCreativeId | {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeSetService.CreativeSet#masterCreativeId CreativeSet.masterCreativeId} |
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeSetService.CreativeSet#lastModifiedDateTime CreativeSet.lastModifiedDateTime} |
*
* @param filterStatement a Publisher Query Language statement used to filter a set of creative sets
* @returns the creative sets that match the given filter
*/
getCreativeSetsByStatement(filterStatement: Statement): Promise<CreativeSetPage>;
/**
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeSetService.CreativeSet CreativeSet}.
*
* @param creativeSet the creative set to update
* @returns the updated creative set
*/
updateCreativeSet(creativeSet: CreativeSet): Promise<CreativeSet>;
}
//# sourceMappingURL=creativeSetService.interface.d.ts.map