@niur/google-admanager-api 0.0.5

package/dist/client/services/creativeWrapper/creativeWrapper.type.d.ts

@@ -0,0 +1,81 @@
+import { PageResult } from '../../../common/types';
+import { ThirdPartyDataDeclaration } from '../../common/types';
+import { ConversionEvent, CreativeWrapperOrdering, CreativeWrapperStatus, CreativeWrapperType } from './creativeWrapper.enum';
+/**
+ * A list of URLs that should be pinged for a conversion event.
+ */
+export declare type TrackingUrls = {
+    /**
+     * A list of all URLs that should be pinged.
+     */
+    urls: string[];
+};
+/**
+ * This represents an entry in a map with a key of type ConversionEvent and value of type TrackingUrls.
+ */
+export declare type ConversionEvent_TrackingUrlsMapEntry = {
+    key: ConversionEvent;
+    value: TrackingUrls;
+};
+/**
+ * A CreativeWrapper allows the wrapping of HTML snippets to be served along with Creative objects.
+ *
+ * Creative wrappers must be associated with a LabelType.CREATIVE_WRAPPER label and applied to ad units by AdUnit.appliedLabels.
+ */
+export declare type CreativeWrapper = {
+    /**
+     * The unique ID of the CreativeWrapper. This value is readonly and is assigned by Google.
+     */
+    id: number;
+    /**
+     * The ID of the Label which will be used to label ad units. The labelId on a creative wrapper cannot be changed once it is created.
+     */
+    labelId: number;
+    /**
+     * The creative wrapper type. If the creative wrapper type is CreativeWrapperType.VIDEO_TRACKING_URL, the videoTrackingUrls field must be set. If the creative wrapper type is CreativeWrapperType.HTML, either the header or footer field must be set. This field is required.
+     */
+    creativeWrapperType: CreativeWrapperType;
+    /**
+     * The header HTML snippet that this creative wrapper delivers.
+     */
+    htmlHeader: string;
+    /**
+     * The footer HTML snippet that this creative wrapper delivers.
+     */
+    htmlFooter: string;
+    /**
+     * The header AMP snippet that this creative wrapper delivers.
+     */
+    ampHead: string;
+    /**
+     * The footer AMP snippet that this creative wrapper delivers.
+     */
+    ampBody: string;
+    /**
+     * The video tracking URLs that this creative wrapper delivers. This field is required if the creativeWrapperType is CreativeWrapperType.VIDEO_TRACKING_URL and ignored otherwise.
+     */
+    videoTrackingUrls: ConversionEvent_TrackingUrlsMapEntry[];
+    /**
+     * The ThirdPartyDataDeclaration for this creative wrapper.
+     *
+     * It is copied to one of the underlying creatives. If the header creative is active then it is persisted there. Otherwise it is stored on the footer creative.
+     */
+    thirdPartyDataDeclaration: ThirdPartyDataDeclaration;
+    /**
+     * If there are multiple wrappers for a creative, then ordering defines the order in which the HTML snippets are rendered.
+     */
+    ordering: CreativeWrapperOrdering;
+    /**
+     * The status of the CreativeWrapper. This attribute is readonly.
+     */
+    status: CreativeWrapperStatus;
+};
+/**
+ * Represents the actions that can be performed on CreativeWrapper objects.
+ */
+export declare type CreativeWrapperAction = 'ActivateCreativeWrappers' | 'DeactivateCreativeWrappers';
+/**
+ * Captures a page of {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeWrapperService.CreativeWrapper CreativeWrapper} objects.
+ */
+export declare type CreativeWrapperPage = PageResult<CreativeWrapper>;
+//# sourceMappingURL=creativeWrapper.type.d.ts.map

package/dist/client/services/creativeWrapper/creativeWrapper.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"creativeWrapper.type.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/creativeWrapper/creativeWrapper.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EACL,eAAe,EACf,uBAAuB,EACvB,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,wBAAwB,CAAC;AAEhC;;GAEG;AACH,oBAAY,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,oBAAY,oCAAoC,GAAG;IACjD,GAAG,EAAE,eAAe,CAAC;IAErB,KAAK,EAAE,YAAY,CAAC;CACrB,CAAC;AAEF;;;;GAIG;AACH,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,iBAAiB,EAAE,oCAAoC,EAAE,CAAC;IAE1D;;;;OAIG;IACH,yBAAyB,EAAE,yBAAyB,CAAC;IAErD;;OAEG;IACH,QAAQ,EAAE,uBAAuB,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB,GAAG,0BAA0B,GAAG,4BAA4B,CAAC;AAE9F;;GAEG;AACH,oBAAY,mBAAmB,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC"}

package/dist/client/services/creativeWrapper/creativeWrapper.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=creativeWrapper.type.js.map

package/dist/client/services/creativeWrapper/creativeWrapper.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"creativeWrapper.type.js","sourceRoot":"","sources":["../../../../lib/client/services/creativeWrapper/creativeWrapper.type.ts"],"names":[],"mappings":""}

package/dist/client/services/creativeWrapper/creativeWrapperService.interface.d.ts

@@ -0,0 +1,57 @@
+import { Statement, UpdateResult } from '../../../common/types';
+import { CreativeWrapper, CreativeWrapperAction, CreativeWrapperPage } from './creativeWrapper.type';
+/**
+ * Provides methods for the creation and management of creative wrappers.
+ * {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeWrapperService.CreativeWrapper CreativeWrappers} allow HTML snippets to be served along with creatives.
+ *
+ * Creative wrappers must be associated with a
+ * {@link https://developers.google.com/ad-manager/api/reference/v202202/LabelService.LabelType#CREATIVE_WRAPPER LabelType.CREATIVE_WRAPPER}
+ * label and applied to ad units by {@link https://developers.google.com/ad-manager/api/reference/v202202/InventoryService.AdUnit#appliedLabels AdUnit.appliedLabels}.
+ */
+export interface CreativeWrapperServiceOperations {
+    /**
+     * Creates a new CreativeWrapper objects. The following fields are required:
+     *
+     * - {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeWrapperService.CreativeWrapper#labelId CreativeWrapper.labelId }
+     * - {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeWrapperService.CreativeWrapper#ordering CreativeWrapper.ordering }
+     * - {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeWrapperService.CreativeWrapper#header CreativeWrapper.header }
+     * or {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeWrapperService.CreativeWrapper#footer CreativeWrapper.footer }
+     *
+     * @param creativeWrappers the creative wrappers to create
+     * @returns the creative wrappers with their IDs filled in
+     */
+    createCreativeWrappers(creativeWrappers: CreativeWrapper[]): Promise<CreativeWrapper[]>;
+    /**
+     * Gets a {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeWrapperService.CreativeWrapperPage CreativeWrapperPage}
+     * of {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeWrapperService.CreativeWrapper CreativeWrapper} objects that satisfy the given
+     * {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeWrapperService.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/CreativeWrapperService.CreativeWrapper#id CreativeWrapper.id}                                     |
+     * | labelId      | {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeWrapperService.CreativeWrapper#labelId CreativeWrapper.labelId}                                 |
+     * | status       | {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeWrapperService.CreativeWrapper#status CreativeWrapper.status}                                 |
+     * | ordering     | {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeWrapperService.CreativeWrapper#ordering CreativeWrapper.lastModifiedDateTime} |
+     *
+     * @param filterStatement a Publisher Query Language statement used to filter a set of creative wrappers.
+     * @returns the creative wrappers that match the given filter
+     */
+    getCreativeWrappersByStatement(filterStatement: Statement): Promise<CreativeWrapperPage>;
+    /**
+     * Performs actions on {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeWrapperService.CreativeWrapper CreativeWrapper} objects that match the given Statement.
+     *
+     * @param creativeWrapperAction the action to perform
+     * @param filterStatement a Publisher Query Language statement used to filter a set of labels
+     * @returns the result of the action performed
+     */
+    performCreativeWrapperAction(creativeWrapperAction: CreativeWrapperAction, filterStatement: Statement): Promise<UpdateResult>;
+    /**
+     * Updates the specified CreativeWrapper objects.
+     *
+     * @param creativeWrappers the creative wrappers to update
+     * @returns the updated creative wrapper objects
+     */
+    updateCreativeWrappers(creativeWrappers: CreativeWrapper[]): Promise<CreativeWrapper[]>;
+}
+//# sourceMappingURL=creativeWrapperService.interface.d.ts.map

package/dist/client/services/creativeWrapper/creativeWrapperService.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"creativeWrapperService.interface.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/creativeWrapper/creativeWrapperService.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAErG;;;;;;;GAOG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;;;;;;;;;OAUG;IACH,sBAAsB,CAAC,gBAAgB,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IACxF;;;;;;;;;;;;;;;OAeG;IACH,8BAA8B,CAAC,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACzF;;;;;;OAMG;IACH,4BAA4B,CAC1B,qBAAqB,EAAE,qBAAqB,EAC5C,eAAe,EAAE,SAAS,GACzB,OAAO,CAAC,YAAY,CAAC,CAAC;IACzB;;;;;OAKG;IACH,sBAAsB,CAAC,gBAAgB,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;CACzF"}

package/dist/client/services/creativeWrapper/creativeWrapperService.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=creativeWrapperService.interface.js.map

package/dist/client/services/creativeWrapper/creativeWrapperService.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"creativeWrapperService.interface.js","sourceRoot":"","sources":["../../../../lib/client/services/creativeWrapper/creativeWrapperService.interface.ts"],"names":[],"mappings":""}

package/dist/client/services/creativeWrapper/index.d.ts

@@ -0,0 +1,2 @@
+export { CreativeWrapperService } from './creativeWrapper.service';
+//# sourceMappingURL=index.d.ts.map

package/dist/client/services/creativeWrapper/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/creativeWrapper/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/client/services/creativeWrapper/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreativeWrapperService = void 0;
+var creativeWrapper_service_1 = require("./creativeWrapper.service");
+Object.defineProperty(exports, "CreativeWrapperService", { enumerable: true, get: function () { return creativeWrapper_service_1.CreativeWrapperService; } });
+//# sourceMappingURL=index.js.map

package/dist/client/services/creativeWrapper/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/client/services/creativeWrapper/index.ts"],"names":[],"mappings":";;;AAAA,qEAAmE;AAA1D,iIAAA,sBAAsB,OAAA"}

package/dist/client/services/customField/customField.enum.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Entity types recognized by custom fields
+ */
+export declare enum CustomFieldEntityType {
+    /**
+     * Represents the LineItem type.
+     */
+    LINE_ITEM = "LINE_ITEM",
+    /**
+     * Represents the Order type.
+     */
+    ORDER = "ORDER",
+    /**
+     * Represents the Creative type.
+     */
+    CREATIVE = "CREATIVE",
+    /**
+     * Represents the ProductTemplate type.
+     */
+    PRODUCT_TEMPLATE = "PRODUCT_TEMPLATE",
+    /**
+     * Represents the Product type.
+     */
+    PRODUCT = "PRODUCT",
+    /**
+     * Represents the Proposal type.
+     */
+    PROPOSAL = "PROPOSAL",
+    /**
+     * Represents the ProposalLineItem type.
+     */
+    PROPOSAL_LINE_ITEM = "PROPOSAL_LINE_ITEM",
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    UNKNOWN = "UNKNOWN"
+}
+/**
+ * The data types allowed for {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField CustomField} objects.
+ */
+export declare enum CustomFieldDataType {
+    /**
+     * A string field. The max length is 255 characters.
+     */
+    STRING = "STRING",
+    /**
+     * A number field.
+     */
+    NUMBER = "NUMBER",
+    /**
+     * A boolean field. Values may be "true", "false", or empty.
+     */
+    TOGGLE = "TOGGLE",
+    /**
+     * A drop-down field. Values may only be the ids of CustomFieldOption objects.
+     */
+    DROP_DOWN = "DROP_DOWN",
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    UNKNOWN = "UNKNOWN"
+}
+/**
+ * The visibility levels of a custom field.
+ */
+export declare enum CustomFieldVisibility {
+    /**
+     * Only visible through the API.
+     */
+    API_ONLY = "API_ONLY",
+    /**
+     * Visible in the UI, but only editable through the API
+     */
+    READ_ONLY = "READ_ONLY",
+    /**
+     * Visible and editable both in the API and the UI.
+     */
+    FULL = "FULL"
+}
+//# sourceMappingURL=customField.enum.d.ts.map

package/dist/client/services/customField/customField.enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customField.enum.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/customField/customField.enum.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,qBAAqB;IAC/B;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,KAAK,UAAU;IACf;;OAEG;IACH,QAAQ,aAAa;IACrB;;OAEG;IACH,gBAAgB,qBAAqB;IACrC;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,QAAQ,aAAa;IACrB;;OAEG;IACH,kBAAkB,uBAAuB;IACzC;;OAEG;IACH,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,oBAAY,mBAAmB;IAC7B;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,oBAAY,qBAAqB;IAC/B;;OAEG;IACH,QAAQ,aAAa;IACrB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,IAAI,SAAS;CACd"}

package/dist/client/services/customField/customField.enum.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomFieldVisibility = exports.CustomFieldDataType = exports.CustomFieldEntityType = void 0;
+/**
+ * Entity types recognized by custom fields
+ */
+var CustomFieldEntityType;
+(function (CustomFieldEntityType) {
+    /**
+     * Represents the LineItem type.
+     */
+    CustomFieldEntityType["LINE_ITEM"] = "LINE_ITEM";
+    /**
+     * Represents the Order type.
+     */
+    CustomFieldEntityType["ORDER"] = "ORDER";
+    /**
+     * Represents the Creative type.
+     */
+    CustomFieldEntityType["CREATIVE"] = "CREATIVE";
+    /**
+     * Represents the ProductTemplate type.
+     */
+    CustomFieldEntityType["PRODUCT_TEMPLATE"] = "PRODUCT_TEMPLATE";
+    /**
+     * Represents the Product type.
+     */
+    CustomFieldEntityType["PRODUCT"] = "PRODUCT";
+    /**
+     * Represents the Proposal type.
+     */
+    CustomFieldEntityType["PROPOSAL"] = "PROPOSAL";
+    /**
+     * Represents the ProposalLineItem type.
+     */
+    CustomFieldEntityType["PROPOSAL_LINE_ITEM"] = "PROPOSAL_LINE_ITEM";
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    CustomFieldEntityType["UNKNOWN"] = "UNKNOWN";
+})(CustomFieldEntityType = exports.CustomFieldEntityType || (exports.CustomFieldEntityType = {}));
+/**
+ * The data types allowed for {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField CustomField} objects.
+ */
+var CustomFieldDataType;
+(function (CustomFieldDataType) {
+    /**
+     * A string field. The max length is 255 characters.
+     */
+    CustomFieldDataType["STRING"] = "STRING";
+    /**
+     * A number field.
+     */
+    CustomFieldDataType["NUMBER"] = "NUMBER";
+    /**
+     * A boolean field. Values may be "true", "false", or empty.
+     */
+    CustomFieldDataType["TOGGLE"] = "TOGGLE";
+    /**
+     * A drop-down field. Values may only be the ids of CustomFieldOption objects.
+     */
+    CustomFieldDataType["DROP_DOWN"] = "DROP_DOWN";
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    CustomFieldDataType["UNKNOWN"] = "UNKNOWN";
+})(CustomFieldDataType = exports.CustomFieldDataType || (exports.CustomFieldDataType = {}));
+/**
+ * The visibility levels of a custom field.
+ */
+var CustomFieldVisibility;
+(function (CustomFieldVisibility) {
+    /**
+     * Only visible through the API.
+     */
+    CustomFieldVisibility["API_ONLY"] = "API_ONLY";
+    /**
+     * Visible in the UI, but only editable through the API
+     */
+    CustomFieldVisibility["READ_ONLY"] = "READ_ONLY";
+    /**
+     * Visible and editable both in the API and the UI.
+     */
+    CustomFieldVisibility["FULL"] = "FULL";
+})(CustomFieldVisibility = exports.CustomFieldVisibility || (exports.CustomFieldVisibility = {}));
+//# sourceMappingURL=customField.enum.js.map

package/dist/client/services/customField/customField.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customField.enum.js","sourceRoot":"","sources":["../../../../lib/client/services/customField/customField.enum.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,qBAiCX;AAjCD,WAAY,qBAAqB;IAC/B;;OAEG;IACH,gDAAuB,CAAA;IACvB;;OAEG;IACH,wCAAe,CAAA;IACf;;OAEG;IACH,8CAAqB,CAAA;IACrB;;OAEG;IACH,8DAAqC,CAAA;IACrC;;OAEG;IACH,4CAAmB,CAAA;IACnB;;OAEG;IACH,8CAAqB,CAAA;IACrB;;OAEG;IACH,kEAAyC,CAAA;IACzC;;OAEG;IACH,4CAAmB,CAAA;AACrB,CAAC,EAjCW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAiChC;AAED;;GAEG;AACH,IAAY,mBAqBX;AArBD,WAAY,mBAAmB;IAC7B;;OAEG;IACH,wCAAiB,CAAA;IACjB;;OAEG;IACH,wCAAiB,CAAA;IACjB;;OAEG;IACH,wCAAiB,CAAA;IACjB;;OAEG;IACH,8CAAuB,CAAA;IACvB;;OAEG;IACH,0CAAmB,CAAA;AACrB,CAAC,EArBW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAqB9B;AAED;;GAEG;AACH,IAAY,qBAaX;AAbD,WAAY,qBAAqB;IAC/B;;OAEG;IACH,8CAAqB,CAAA;IACrB;;OAEG;IACH,gDAAuB,CAAA;IACvB;;OAEG;IACH,sCAAa,CAAA;AACf,CAAC,EAbW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAahC"}

package/dist/client/services/customField/customField.service.d.ts

@@ -0,0 +1,16 @@
+import { Client } from 'soap';
+import { CustomFieldServiceOperations } from './customFieldService.interface';
+import { Statement, UpdateResult } from '../../../common/types';
+import { CustomField, CustomFieldAction, CustomFieldOption, CustomFieldPage } from './customField.type';
+export declare class CustomFieldService implements CustomFieldServiceOperations {
+    private _client;
+    constructor(client: Client);
+    createCustomFieldOptions(customFieldOptions: CustomFieldOption[]): Promise<CustomFieldOption[]>;
+    createCustomFields(customFields: CustomField[]): Promise<CustomField[]>;
+    getCustomFieldOption(customFieldOptionId: number): Promise<CustomFieldOption>;
+    getCustomFieldsByStatement(filterStatement: Statement): Promise<CustomFieldPage>;
+    performCustomFieldAction(customFieldAction: CustomFieldAction, filterStatement: Statement): Promise<UpdateResult>;
+    updateCustomFieldOptions(customFieldOptions: CustomFieldOption[]): Promise<CustomFieldOption[]>;
+    updateCustomFields(CustomFields: CustomField[]): Promise<CustomField[]>;
+}
+//# sourceMappingURL=customField.service.d.ts.map

package/dist/client/services/customField/customField.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customField.service.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/customField/customField.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAExG,qBAAa,kBAAmB,YAAW,4BAA4B;IACrE,OAAO,CAAC,OAAO,CAAS;gBAEZ,MAAM,EAAE,MAAM;IAIpB,wBAAwB,CAAC,kBAAkB,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAI/F,kBAAkB,CAAC,YAAY,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAIvE,oBAAoB,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAM7E,0BAA0B,CAAC,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,eAAe,CAAC;IAMhF,wBAAwB,CAC5B,iBAAiB,EAAE,iBAAiB,EACpC,eAAe,EAAE,SAAS,GACzB,OAAO,CAAC,YAAY,CAAC;IAWlB,wBAAwB,CAAC,kBAAkB,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAI/F,kBAAkB,CAAC,YAAY,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;CAG9E"}

package/dist/client/services/customField/customField.service.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomFieldService = void 0;
+class CustomFieldService {
+    constructor(client) {
+        this._client = client;
+    }
+    async createCustomFieldOptions(customFieldOptions) {
+        return this._client.createCustomFieldOptions({ customFieldOptions });
+    }
+    async createCustomFields(customFields) {
+        return this._client.createCustomFields({ customFields });
+    }
+    async getCustomFieldOption(customFieldOptionId) {
+        return this._client.getCustomFieldsByStatement({
+            customFieldOptionId,
+        });
+    }
+    async getCustomFieldsByStatement(filterStatement) {
+        return this._client.getCustomFieldsByStatement({
+            filterStatement,
+        });
+    }
+    async performCustomFieldAction(customFieldAction, filterStatement) {
+        return this._client.performCustomFieldAction({
+            customFieldAction: {
+                attributes: {
+                    'xsi:type': customFieldAction,
+                },
+            },
+            filterStatement,
+        });
+    }
+    async updateCustomFieldOptions(customFieldOptions) {
+        return this._client.updateCustomFields({ customFieldOptions });
+    }
+    async updateCustomFields(CustomFields) {
+        return this._client.updateCustomFields({ CustomFields });
+    }
+}
+exports.CustomFieldService = CustomFieldService;
+//# sourceMappingURL=customField.service.js.map

package/dist/client/services/customField/customField.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customField.service.js","sourceRoot":"","sources":["../../../../lib/client/services/customField/customField.service.ts"],"names":[],"mappings":";;;AAMA,MAAa,kBAAkB;IAG7B,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,wBAAwB,CAAC,kBAAuC;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,wBAAwB,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,YAA2B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,mBAA2B;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,0BAA0B,CAAC;YAC7C,mBAAmB;SACpB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,0BAA0B,CAAC,eAA0B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,0BAA0B,CAAC;YAC7C,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,wBAAwB,CAC5B,iBAAoC,EACpC,eAA0B;QAE1B,OAAO,IAAI,CAAC,OAAO,CAAC,wBAAwB,CAAC;YAC3C,iBAAiB,EAAE;gBACjB,UAAU,EAAE;oBACV,UAAU,EAAE,iBAAiB;iBAC9B;aACF;YACD,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,wBAAwB,CAAC,kBAAuC;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,YAA2B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF;AAhDD,gDAgDC"}

package/dist/client/services/customField/customField.type.d.ts

@@ -0,0 +1,72 @@
+import { PageResult } from '../../../common/types';
+import { CustomFieldDataType, CustomFieldEntityType, CustomFieldVisibility } from './customField.enum';
+/**
+ * An option represents a permitted value for a custom field that has a
+ * {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField#dataType CustomField.dataType} of
+ * {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomFieldDataType#DROP_DOWN CustomFieldDataType.DROP_DOWN}.
+ */
+export declare type CustomFieldOption = {
+    /**
+     * Unique ID of this option. This value is readonly and is assigned by Google.
+     */
+    id: number;
+    /**
+     * The id of the custom field this option belongs to.
+     */
+    customFieldId: number;
+    /**
+     * The display name of this option.
+     */
+    displayName: string;
+};
+/**
+ * A custom field that has the drop-down data type.
+ */
+export declare type DropDownCustomField = {
+    /**
+     * The options allowed for this custom field. This is read only.
+     */
+    options: CustomFieldOption[];
+};
+/**
+ * An additional, user-created field on an entity.
+ */
+export declare type CustomField = {
+    /**
+     * Unique ID of the CustomField. This value is readonly and is assigned by Google.
+     */
+    id: number;
+    /**
+     * Name of the CustomField. This is value is required to create a custom field. The max length is 127 characters.
+     */
+    name: string;
+    /**
+     * A description of the custom field. This value is optional. The maximum length is 511 characters
+     */
+    description: string;
+    /**
+     *  Specifies whether or not the custom fields is active. This attribute is read-only.
+     */
+    isActive: boolean;
+    /**
+     * The type of entity that this custom field is associated with. This attribute is read-only if there exists a CustomFieldValue for this field.
+     */
+    entityType: CustomFieldEntityType;
+    /**
+     * The type of data this custom field contains. This attribute is read-only if there exists a CustomFieldValue for this field.
+     */
+    dataType: CustomFieldDataType;
+    /**
+     * How visible/accessible this field is in the UI.
+     */
+    visibility: CustomFieldVisibility;
+} & DropDownCustomField;
+/**
+ * Represents the actions that can be performed on {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField CustomField} objects.
+ */
+export declare type CustomFieldAction = 'ActivateCustomFields' | 'DeactivateCustomFields';
+/**
+ * Captures a page of {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField CustomField} objects.
+ */
+export declare type CustomFieldPage = PageResult<CustomField>;
+//# sourceMappingURL=customField.type.d.ts.map

package/dist/client/services/customField/customField.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customField.type.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/customField/customField.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAEvG;;;;GAIG;AACH,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,OAAO,EAAE,iBAAiB,EAAE,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,oBAAY,WAAW,GAAG;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,UAAU,EAAE,qBAAqB,CAAC;IAClC;;OAEG;IACH,QAAQ,EAAE,mBAAmB,CAAC;IAC9B;;OAEG;IACH,UAAU,EAAE,qBAAqB,CAAC;CACnC,GAAG,mBAAmB,CAAC;AAExB;;GAEG;AACH,oBAAY,iBAAiB,GAAG,sBAAsB,GAAG,wBAAwB,CAAC;AAElF;;GAEG;AACH,oBAAY,eAAe,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC"}

package/dist/client/services/customField/customField.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=customField.type.js.map

package/dist/client/services/customField/customField.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customField.type.js","sourceRoot":"","sources":["../../../../lib/client/services/customField/customField.type.ts"],"names":[],"mappings":""}

package/dist/client/services/customField/customFieldService.interface.d.ts

@@ -0,0 +1,84 @@
+import { Statement, UpdateResult } from '../../../common/types';
+import { CustomField, CustomFieldAction, CustomFieldOption, CustomFieldPage } from './customField.type';
+/**
+ * Provides methods for the creation and management of {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField CustomField} objects.
+ *
+ */
+export interface CustomFieldServiceOperations {
+    /**
+     * Creates new {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomFieldOption CustomFieldOption} objects.
+     *
+     * The following fields are required:
+     *
+     * - {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField#name CustomFieldOption.displayName}
+     * - {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField#name CustomFieldOption.customFieldId}
+     *
+     * @param customFieldOptions the custom fields to create
+     * @returns the created custom field options with their IDs filled in
+     */
+    createCustomFieldOptions(customFieldOptions: CustomFieldOption[]): Promise<CustomFieldOption[]>;
+    /**
+     * Creates new {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField CustomField} objects.
+     *
+     * The following fields are required:
+     *
+     * - {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField#name CustomField.name}
+     * - {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField#entityType CustomField.entityType}
+     * - {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField#dataType CustomField.dataType}
+     * - {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField#visibility CustomField.visibility}
+     *
+     * @param customFields the custom fields to create
+     * @returns the created custom fields with their IDs filled in
+     */
+    createCustomFields(customFields: CustomField[]): Promise<CustomField[]>;
+    /**
+     * Returns the {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomFieldOption CustomFieldOption}
+     * uniquely identified by the given ID.
+     *
+     * @param customFieldOptionId the ID of the custom field option, which must already exist
+     * @returns the CustomFieldOption uniquely identified by the given ID
+     */
+    getCustomFieldOption(customFieldOptionId: number): Promise<CustomFieldOption>;
+    /**
+     * Gets a {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomFieldPage CustomFieldPage}
+     * of {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField CustomField} objects that satisfy the given
+     * {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.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/CustomFieldService.CustomField#id CustomField.id}                 |
+     * | entityType   | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField#entityType CustomField.entityType} |
+     * | name         | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField#name CustomField.name}             |
+     * | isActive     | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField#isActive CustomField.isActive}     |
+     * | visibility   | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField#visibility CustomField.visibility} |
+     *
+     * @param filterStatement a Publisher Query Language statement used to filter a set of custom fields.
+     * @returns the custom fields that match the given filter
+     */
+    getCustomFieldsByStatement(filterStatement: Statement): Promise<CustomFieldPage>;
+    /**
+     * Performs actions on {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField CustomField} objects that match the given
+     * {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.Statement#query Statement.query}.
+     *
+     * @param CustomFieldAction the action to perform
+     * @param filterStatement	a Publisher Query Language statement used to filter a set of custom fields
+     * @returns the result of the action performed
+     */
+    performCustomFieldAction(customFieldAction: CustomFieldAction, filterStatement: Statement): Promise<UpdateResult>;
+    /**
+     * Updates the specified {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomFieldOption CustomFieldOption} objects.
+     *
+     * @param customFieldOptions the custom field options to update
+     * @returns 	the updated custom field options
+     */
+    updateCustomFieldOptions(customFieldOptions: CustomFieldOption[]): Promise<CustomFieldOption[]>;
+    /**
+     * Updates the specified {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField CustomField} objects.
+     *
+     * @param customFields the custom fields to update
+     * @returns the updated custom fields
+     */
+    updateCustomFields(customFields: CustomField[]): Promise<CustomField[]>;
+}
+//# sourceMappingURL=customFieldService.interface.d.ts.map

package/dist/client/services/customField/customFieldService.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customFieldService.interface.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/customField/customFieldService.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAExG;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;;;;;;;;OAUG;IACH,wBAAwB,CAAC,kBAAkB,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAChG;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,YAAY,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IACxE;;;;;;OAMG;IACH,oBAAoB,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC9E;;;;;;;;;;;;;;;;OAgBG;IACH,0BAA0B,CAAC,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACjF;;;;;;;OAOG;IACH,wBAAwB,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAClH;;;;;OAKG;IACH,wBAAwB,CAAC,kBAAkB,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAChG;;;;;OAKG;IACH,kBAAkB,CAAC,YAAY,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;CACzE"}

package/dist/client/services/customField/customFieldService.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=customFieldService.interface.js.map

package/dist/client/services/customField/customFieldService.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customFieldService.interface.js","sourceRoot":"","sources":["../../../../lib/client/services/customField/customFieldService.interface.ts"],"names":[],"mappings":""}

package/dist/client/services/customField/index.d.ts

@@ -0,0 +1,2 @@
+export { CustomFieldService } from './customField.service';
+//# sourceMappingURL=index.d.ts.map

package/dist/client/services/customField/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/customField/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/client/services/customField/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomFieldService = void 0;
+var customField_service_1 = require("./customField.service");
+Object.defineProperty(exports, "CustomFieldService", { enumerable: true, get: function () { return customField_service_1.CustomFieldService; } });
+//# sourceMappingURL=index.js.map

package/dist/client/services/customField/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/client/services/customField/index.ts"],"names":[],"mappings":";;;AAAA,6DAA2D;AAAlD,yHAAA,kBAAkB,OAAA"}