@niur/google-admanager-api 0.0.5

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

@@ -0,0 +1,130 @@
+/**
+ * Specifies the types for CustomTargetingKey objects.
+ */
+export declare enum CustomTargetingKeyType {
+    /**
+     * Target audiences by criteria values that are defined in advance.
+     */
+    PREDEFINED = "PREDEFINED",
+    /**
+     * Target audiences by adding criteria values when creating line items.
+     */
+    FREEFORM = "FREEFORM"
+}
+/**
+ * Enum to represent the type of values that will be passed for this key.
+ */
+export declare enum ValueDeclarationType {
+    /**
+     * Values are not user-related data and will be used in all ad requests.
+     */
+    NON_USER_DATA = "NON_USER_DATA",
+    /**
+     * Values are declared as user data that will not be used in sensitive ad requests' targeting.
+     */
+    USER_DATA = "USER_DATA",
+    /**
+     * Values are declared as user identifiers that will not be used in targeting and will be encrypted in DT using a publisher-provided public key.
+     */
+    USER_ID = "USER_ID"
+}
+/**
+ * Describes the statuses for CustomTargetingKey objects.
+ */
+export declare enum CustomTargetingKeyStatus {
+    /**
+     * The object is active.
+     */
+    ACTIVE = "ACTIVE",
+    /**
+     * The object is no longer active.
+     */
+    INACTIVE = "INACTIVE",
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    UNKNOWN = "UNKNOWN"
+}
+/**
+ * Represents the reportable state of a custom key.
+ */
+export declare enum ReportableType {
+    UNKNOWN = "UNKNOWN",
+    /**
+     * Available for reporting in the Ad Manager query tool.
+     */
+    ON = "ON",
+    /**
+     * Not available for reporting in the Ad Manager query tool.
+     */
+    OFF = "OFF",
+    /**
+     * Custom dimension available for reporting in the AdManager query tool.
+     */
+    CUSTOM_DIMENSION = "CUSTOM_DIMENSION"
+}
+/**
+ * Represents the ways in which
+ * {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValue#name CustomTargetingValue.name} strings will be matched with ad requests.
+ */
+export declare enum CustomTargetingValueMatchType {
+    /**
+     * Used for exact matching. For example, the targeting value car=honda will only match to the ad request car=honda.
+     */
+    EXACT = "EXACT",
+    /**
+     * Used for lenient matching when at least one of the words in the ad request matches the targeted value.
+     * The targeting value car=honda will match to ad requests containing the word honda.
+     * So ad requests car=honda or car=honda civic or car=buy honda or car=how much does a honda cost will all have the line item delivered.
+     *
+     * This match type can not be used within an audience segment rule.
+     */
+    BROAD = "BROAD",
+    /**
+     * Used for 'starts with' matching when the first few characters in the ad request match all of the characters in the targeted value. The targeting value car=honda will match to ad requests car=honda or car=hondas for sale but not to car=I want a honda.
+     */
+    PREFIX = "PREFIX",
+    /**
+     * This is a combination of MatchType#BROAD and MatchType#PREFIX matching.
+     * The targeting value car=honda will match to ad requests that contain words that start with the characters in the targeted value, for example with car=civic hondas.
+     *
+     * This match type can not be used within an audience segment rule.
+     */
+    BROAD_PREFIX = "BROAD_PREFIX",
+    /**
+     * Used for 'ends with' matching when the last characters in the ad request match all of the characters in the targeted value.
+     * The targeting value car=honda will match with ad requests car=honda or car=I want a honda but not to car=hondas for sale.
+     *
+     * This match type can not be used within line item targeting.
+     */
+    SUFFIX = "SUFFIX",
+    /**
+     * Used for 'within' matching when the string in the ad request contains the string in the targeted value.
+     * The targeting value car=honda will match with ad requests car=honda, car=I want a honda, and also with car=hondas for sale, but not with car=misspelled hond a.
+     *
+     * This match type can not be used within line item targeting.
+     */
+    CONTAINS = "CONTAINS",
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    UNKNOWN = "UNKNOWN"
+}
+/**
+ * Describes the statuses for CustomTargetingValue objects.
+ */
+export declare enum CustomTargetingValueStatus {
+    /**
+     * The object is active.
+     */
+    ACTIVE = "ACTIVE",
+    /**
+     * The object is no longer active.
+     */
+    INACTIVE = "INACTIVE",
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    UNKNOWN = "UNKNOWN"
+}
+//# sourceMappingURL=customTargeting.enum.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customTargeting.enum.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/customTargeting/customTargeting.enum.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,sBAAsB;IAChC;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,QAAQ,aAAa;CACtB;AAED;;GAEG;AACH,oBAAY,oBAAoB;IAC9B;;OAEG;IACH,aAAa,kBAAkB;IAC/B;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,oBAAY,wBAAwB;IAClC;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,QAAQ,aAAa;IACrB;;OAEG;IACH,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,OAAO,YAAY;IACnB;;OAEG;IACH,EAAE,OAAO;IACT;;OAEG;IACH,GAAG,QAAQ;IACX;;OAEG;IACH,gBAAgB,qBAAqB;CACtC;AAED;;;GAGG;AACH,oBAAY,6BAA6B;IACvC;;OAEG;IACH,KAAK,UAAU;IACf;;;;;;OAMG;IACH,KAAK,UAAU;IACf;;OAEG;IACH,MAAM,WAAW;IACjB;;;;;OAKG;IACH,YAAY,iBAAiB;IAC7B;;;;;OAKG;IACH,MAAM,WAAW;IACjB;;;;;OAKG;IACH,QAAQ,aAAa;IACrB;;OAEG;IACH,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,oBAAY,0BAA0B;IACpC;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,QAAQ,aAAa;IACrB;;OAEG;IACH,OAAO,YAAY;CACpB"}

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

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomTargetingValueStatus = exports.CustomTargetingValueMatchType = exports.ReportableType = exports.CustomTargetingKeyStatus = exports.ValueDeclarationType = exports.CustomTargetingKeyType = void 0;
+/**
+ * Specifies the types for CustomTargetingKey objects.
+ */
+var CustomTargetingKeyType;
+(function (CustomTargetingKeyType) {
+    /**
+     * Target audiences by criteria values that are defined in advance.
+     */
+    CustomTargetingKeyType["PREDEFINED"] = "PREDEFINED";
+    /**
+     * Target audiences by adding criteria values when creating line items.
+     */
+    CustomTargetingKeyType["FREEFORM"] = "FREEFORM";
+})(CustomTargetingKeyType = exports.CustomTargetingKeyType || (exports.CustomTargetingKeyType = {}));
+/**
+ * Enum to represent the type of values that will be passed for this key.
+ */
+var ValueDeclarationType;
+(function (ValueDeclarationType) {
+    /**
+     * Values are not user-related data and will be used in all ad requests.
+     */
+    ValueDeclarationType["NON_USER_DATA"] = "NON_USER_DATA";
+    /**
+     * Values are declared as user data that will not be used in sensitive ad requests' targeting.
+     */
+    ValueDeclarationType["USER_DATA"] = "USER_DATA";
+    /**
+     * Values are declared as user identifiers that will not be used in targeting and will be encrypted in DT using a publisher-provided public key.
+     */
+    ValueDeclarationType["USER_ID"] = "USER_ID";
+})(ValueDeclarationType = exports.ValueDeclarationType || (exports.ValueDeclarationType = {}));
+/**
+ * Describes the statuses for CustomTargetingKey objects.
+ */
+var CustomTargetingKeyStatus;
+(function (CustomTargetingKeyStatus) {
+    /**
+     * The object is active.
+     */
+    CustomTargetingKeyStatus["ACTIVE"] = "ACTIVE";
+    /**
+     * The object is no longer active.
+     */
+    CustomTargetingKeyStatus["INACTIVE"] = "INACTIVE";
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    CustomTargetingKeyStatus["UNKNOWN"] = "UNKNOWN";
+})(CustomTargetingKeyStatus = exports.CustomTargetingKeyStatus || (exports.CustomTargetingKeyStatus = {}));
+/**
+ * Represents the reportable state of a custom key.
+ */
+var ReportableType;
+(function (ReportableType) {
+    ReportableType["UNKNOWN"] = "UNKNOWN";
+    /**
+     * Available for reporting in the Ad Manager query tool.
+     */
+    ReportableType["ON"] = "ON";
+    /**
+     * Not available for reporting in the Ad Manager query tool.
+     */
+    ReportableType["OFF"] = "OFF";
+    /**
+     * Custom dimension available for reporting in the AdManager query tool.
+     */
+    ReportableType["CUSTOM_DIMENSION"] = "CUSTOM_DIMENSION";
+})(ReportableType = exports.ReportableType || (exports.ReportableType = {}));
+/**
+ * Represents the ways in which
+ * {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValue#name CustomTargetingValue.name} strings will be matched with ad requests.
+ */
+var CustomTargetingValueMatchType;
+(function (CustomTargetingValueMatchType) {
+    /**
+     * Used for exact matching. For example, the targeting value car=honda will only match to the ad request car=honda.
+     */
+    CustomTargetingValueMatchType["EXACT"] = "EXACT";
+    /**
+     * Used for lenient matching when at least one of the words in the ad request matches the targeted value.
+     * The targeting value car=honda will match to ad requests containing the word honda.
+     * So ad requests car=honda or car=honda civic or car=buy honda or car=how much does a honda cost will all have the line item delivered.
+     *
+     * This match type can not be used within an audience segment rule.
+     */
+    CustomTargetingValueMatchType["BROAD"] = "BROAD";
+    /**
+     * Used for 'starts with' matching when the first few characters in the ad request match all of the characters in the targeted value. The targeting value car=honda will match to ad requests car=honda or car=hondas for sale but not to car=I want a honda.
+     */
+    CustomTargetingValueMatchType["PREFIX"] = "PREFIX";
+    /**
+     * This is a combination of MatchType#BROAD and MatchType#PREFIX matching.
+     * The targeting value car=honda will match to ad requests that contain words that start with the characters in the targeted value, for example with car=civic hondas.
+     *
+     * This match type can not be used within an audience segment rule.
+     */
+    CustomTargetingValueMatchType["BROAD_PREFIX"] = "BROAD_PREFIX";
+    /**
+     * Used for 'ends with' matching when the last characters in the ad request match all of the characters in the targeted value.
+     * The targeting value car=honda will match with ad requests car=honda or car=I want a honda but not to car=hondas for sale.
+     *
+     * This match type can not be used within line item targeting.
+     */
+    CustomTargetingValueMatchType["SUFFIX"] = "SUFFIX";
+    /**
+     * Used for 'within' matching when the string in the ad request contains the string in the targeted value.
+     * The targeting value car=honda will match with ad requests car=honda, car=I want a honda, and also with car=hondas for sale, but not with car=misspelled hond a.
+     *
+     * This match type can not be used within line item targeting.
+     */
+    CustomTargetingValueMatchType["CONTAINS"] = "CONTAINS";
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    CustomTargetingValueMatchType["UNKNOWN"] = "UNKNOWN";
+})(CustomTargetingValueMatchType = exports.CustomTargetingValueMatchType || (exports.CustomTargetingValueMatchType = {}));
+/**
+ * Describes the statuses for CustomTargetingValue objects.
+ */
+var CustomTargetingValueStatus;
+(function (CustomTargetingValueStatus) {
+    /**
+     * The object is active.
+     */
+    CustomTargetingValueStatus["ACTIVE"] = "ACTIVE";
+    /**
+     * The object is no longer active.
+     */
+    CustomTargetingValueStatus["INACTIVE"] = "INACTIVE";
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    CustomTargetingValueStatus["UNKNOWN"] = "UNKNOWN";
+})(CustomTargetingValueStatus = exports.CustomTargetingValueStatus || (exports.CustomTargetingValueStatus = {}));
+//# sourceMappingURL=customTargeting.enum.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customTargeting.enum.js","sourceRoot":"","sources":["../../../../lib/client/services/customTargeting/customTargeting.enum.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC;;OAEG;IACH,mDAAyB,CAAA;IACzB;;OAEG;IACH,+CAAqB,CAAA;AACvB,CAAC,EATW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QASjC;AAED;;GAEG;AACH,IAAY,oBAaX;AAbD,WAAY,oBAAoB;IAC9B;;OAEG;IACH,uDAA+B,CAAA;IAC/B;;OAEG;IACH,+CAAuB,CAAA;IACvB;;OAEG;IACH,2CAAmB,CAAA;AACrB,CAAC,EAbW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAa/B;AAED;;GAEG;AACH,IAAY,wBAaX;AAbD,WAAY,wBAAwB;IAClC;;OAEG;IACH,6CAAiB,CAAA;IACjB;;OAEG;IACH,iDAAqB,CAAA;IACrB;;OAEG;IACH,+CAAmB,CAAA;AACrB,CAAC,EAbW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAanC;AAED;;GAEG;AACH,IAAY,cAcX;AAdD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB;;OAEG;IACH,2BAAS,CAAA;IACT;;OAEG;IACH,6BAAW,CAAA;IACX;;OAEG;IACH,uDAAqC,CAAA;AACvC,CAAC,EAdW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAczB;AAED;;;GAGG;AACH,IAAY,6BA0CX;AA1CD,WAAY,6BAA6B;IACvC;;OAEG;IACH,gDAAe,CAAA;IACf;;;;;;OAMG;IACH,gDAAe,CAAA;IACf;;OAEG;IACH,kDAAiB,CAAA;IACjB;;;;;OAKG;IACH,8DAA6B,CAAA;IAC7B;;;;;OAKG;IACH,kDAAiB,CAAA;IACjB;;;;;OAKG;IACH,sDAAqB,CAAA;IACrB;;OAEG;IACH,oDAAmB,CAAA;AACrB,CAAC,EA1CW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QA0CxC;AAED;;GAEG;AACH,IAAY,0BAaX;AAbD,WAAY,0BAA0B;IACpC;;OAEG;IACH,+CAAiB,CAAA;IACjB;;OAEG;IACH,mDAAqB,CAAA;IACrB;;OAEG;IACH,iDAAmB,CAAA;AACrB,CAAC,EAbW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAarC"}

package/dist/client/services/customTargeting/customTargeting.interface.d.ts

@@ -0,0 +1,107 @@
+import { Statement, UpdateResult } from '../../../common/types';
+import { CustomTargetingKey, CustomTargetingKeyAction, CustomTargetingKeyPage, CustomTargetingValue, CustomTargetingValueAction, CustomTargetingValuePage } from './customTargeting.type';
+/**
+ * Provides operations for creating, updating and retrieving
+ * {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingKey CustomTargetingKey}
+ * and {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
+ *
+ */
+export interface CustomTargetingServiceOperations {
+    /**
+     * Creates new {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects.
+     * The following fields are required:
+     *
+     * - {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingKey#name CustomTargetingKey.name }
+     * - {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingKey#type CustomTargetingKey.type }
+     *
+     * @param keys the custom targeting keys to update
+     * @returns the updated custom targeting keys
+     */
+    createCustomTargetingKeys(keys: CustomTargetingKey[]): Promise<CustomTargetingKey[]>;
+    /**
+     * Creates new {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
+     * The following fields are required:
+     *
+     * - {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValue#customTargetingKeyId CustomTargetingValue.customTargetingKeyId }
+     * - {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingKey#name CustomTargetingValue.name }
+     *
+     * @param values 	the custom targeting values to update
+     * @returns the updated custom targeting values
+     */
+    createCustomTargetingValues(values: CustomTargetingValue[]): Promise<CustomTargetingValue[]>;
+    /**
+     * Gets a {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingKeyPage CustomTargetingKeyPage}
+     * of {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects that satisfy
+     * the given {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.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/CustomTargetingService.CustomTargetingKey#id CustomTargetingKey.id}                  |
+     * | name         | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingKey#name CustomTargetingKey.name}               |
+     * | displayName  | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingKey#displayName CustomTargetingKey.displayName} |
+     * | type         | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingKey#type CustomTargetingKey.type}               |
+     *
+     * @param filterStatement a Publisher Query Language statement used to filter a set of custom targeting keys
+     * @returns the custom targeting keys that match the given filter
+     */
+    getCustomTargetingKeysByStatement(filterStatement: Statement): Promise<CustomTargetingKeyPage>;
+    /**
+     * Gets a {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValuePage CustomTargetingValuePage}
+     * of {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects that satisfy
+     * the given {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.Statement#query Statement.query}.
+     *
+     * The WHERE clause in the Statement.query must always contain CustomTargetingValue.customTargetingKeyId as one of its columns in a way that it is
+     * AND'ed with the rest of the query. So, if you want to retrieve values for a known set of key ids, valid Statement.query would look like:
+     *
+     * - "WHERE customTargetingKeyId IN ('17','18','19')" retrieves all values that are associated with keys having ids 17, 18, 19.
+     * - "WHERE customTargetingKeyId = '17' AND name = 'red'" retrieves values that are associated with keys having id 17 and value name is 'red'.
+     *
+     * The following fields are supported for filtering:
+     *
+     * | PQL Property         | PQL Property                                                                                                                                                                      |
+     * | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+     * | id                   | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValue#id CustomTargetingValue.id}                                     |
+     * | customTargetingKeyId | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValue#customTargetingKeyId CustomTargetingValue.customTargetingKeyId} |
+     * | name                 | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValue#name CustomTargetingValue.name}                                 |
+     * | displayName          | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValue#displayName CustomTargetingValue.displayName}                   |
+     * | matchType            | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValue#matchType CustomTargetingValue.matchType}                       |
+     *
+     * @param filterStatement a Publisher Query Language statement used to filter a set of custom targeting values
+     * @returns the custom targeting values that match the given filter
+     */
+    getCustomTargetingValuesByStatement(filterStatement: Statement): Promise<CustomTargetingValuePage>;
+    /**
+     * Performs actions on {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingKey CustomTargetingKey}
+     * objects that match the given {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.Statement#query Statement.query}.
+     *
+     * @param customTargetingKeyAction the action to perform
+     * @param filterStatement a Publisher Query Language statement used to filter a set of custom targeting keys
+     * @returns the result of the action performed
+     */
+    performCustomTargetingKeyAction(customTargetingKeyAction: CustomTargetingKeyAction, filterStatement: Statement): Promise<UpdateResult>;
+    /**
+     * Performs actions on {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValue CustomTargetingValue}
+     * objects that match the given {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.Statement#query Statement.query}.
+     *
+     * @param customTargetingKeyAction the action to perform
+     * @param filterStatement a Publisher Query Language statement used to filter a set of ad units
+     * @returns the result of the action performed
+     */
+    performCustomTargetingValueAction(customTargetingValueAction: CustomTargetingValueAction, filterStatement: Statement): Promise<UpdateResult>;
+    /**
+     * Updates the specified {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects.
+     *
+     * @param keys the custom targeting keys to update
+     * @returns the updated custom targeting keys
+     */
+    updateCustomTargetingKeys(keys: CustomTargetingKey[]): Promise<CustomTargetingKey[]>;
+    /**
+     * Updates the specified {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
+     *
+     * @param values the custom targeting values to update
+     * @returns the updated custom targeting values
+     */
+    updateCustomTargetingValues(values: CustomTargetingValue[]): Promise<CustomTargetingValue[]>;
+}
+//# sourceMappingURL=customTargeting.interface.d.ts.map

package/dist/client/services/customTargeting/customTargeting.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customTargeting.interface.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/customTargeting/customTargeting.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,sBAAsB,EACtB,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,EACzB,MAAM,wBAAwB,CAAC;AAEhC;;;;;GAKG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;;;;;;;;OASG;IACH,yBAAyB,CAAC,IAAI,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACrF;;;;;;;;;OASG;IACH,2BAA2B,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAC7F;;;;;;;;;;;;;;;OAeG;IACH,iCAAiC,CAAC,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAC/F;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,mCAAmC,CAAC,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACnG;;;;;;;OAOG;IACH,+BAA+B,CAC7B,wBAAwB,EAAE,wBAAwB,EAClD,eAAe,EAAE,SAAS,GACzB,OAAO,CAAC,YAAY,CAAC,CAAC;IACzB;;;;;;;OAOG;IACH,iCAAiC,CAC/B,0BAA0B,EAAE,0BAA0B,EACtD,eAAe,EAAE,SAAS,GACzB,OAAO,CAAC,YAAY,CAAC,CAAC;IACzB;;;;;OAKG;IACH,yBAAyB,CAAC,IAAI,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACrF;;;;;OAKG;IACH,2BAA2B,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;CAC9F"}

package/dist/client/services/customTargeting/customTargeting.interface.js

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

package/dist/client/services/customTargeting/customTargeting.interface.js.map

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

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

@@ -0,0 +1,17 @@
+import { Client } from 'soap';
+import { CustomTargetingServiceOperations } from './customTargeting.interface';
+import { Statement, UpdateResult } from '../../../common/types';
+import { CustomTargetingKey, CustomTargetingKeyAction, CustomTargetingKeyPage, CustomTargetingValue, CustomTargetingValueAction, CustomTargetingValuePage } from './customTargeting.type';
+export declare class CustomTargetingService implements CustomTargetingServiceOperations {
+    private _client;
+    constructor(client: Client);
+    createCustomTargetingKeys(keys: CustomTargetingKey[]): Promise<CustomTargetingKey[]>;
+    createCustomTargetingValues(values: CustomTargetingValue[]): Promise<CustomTargetingValue[]>;
+    getCustomTargetingKeysByStatement(filterStatement: Statement): Promise<CustomTargetingKeyPage>;
+    getCustomTargetingValuesByStatement(filterStatement: Statement): Promise<CustomTargetingValuePage>;
+    performCustomTargetingKeyAction(customTargetingKeyAction: CustomTargetingKeyAction, filterStatement: Statement): Promise<UpdateResult>;
+    performCustomTargetingValueAction(customTargetingValueAction: CustomTargetingValueAction, filterStatement: Statement): Promise<UpdateResult>;
+    updateCustomTargetingKeys(keys: CustomTargetingKey[]): Promise<CustomTargetingKey[]>;
+    updateCustomTargetingValues(values: CustomTargetingValue[]): Promise<CustomTargetingValue[]>;
+}
+//# sourceMappingURL=customTargeting.service.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customTargeting.service.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/customTargeting/customTargeting.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,gCAAgC,EAAE,MAAM,6BAA6B,CAAC;AAC/E,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,sBAAsB,EACtB,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,EACzB,MAAM,wBAAwB,CAAC;AAEhC,qBAAa,sBAAuB,YAAW,gCAAgC;IAC7E,OAAO,CAAC,OAAO,CAAS;gBAEZ,MAAM,EAAE,MAAM;IAIpB,yBAAyB,CAAC,IAAI,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAIpF,2BAA2B,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAI5F,iCAAiC,CAAC,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAM9F,mCAAmC,CAAC,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAMlG,+BAA+B,CACnC,wBAAwB,EAAE,wBAAwB,EAClD,eAAe,EAAE,SAAS,GACzB,OAAO,CAAC,YAAY,CAAC;IAWlB,iCAAiC,CACrC,0BAA0B,EAAE,0BAA0B,EACtD,eAAe,EAAE,SAAS,GACzB,OAAO,CAAC,YAAY,CAAC;IAWlB,yBAAyB,CAAC,IAAI,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAIpF,2BAA2B,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;CAGnG"}

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

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomTargetingService = void 0;
+class CustomTargetingService {
+    constructor(client) {
+        this._client = client;
+    }
+    async createCustomTargetingKeys(keys) {
+        return this._client.createCustomTargetingKeys({ keys });
+    }
+    async createCustomTargetingValues(values) {
+        return this._client.createCustomTargetingValues({ values });
+    }
+    async getCustomTargetingKeysByStatement(filterStatement) {
+        return this._client.getCustomTargetingKeysByStatement({
+            filterStatement,
+        });
+    }
+    async getCustomTargetingValuesByStatement(filterStatement) {
+        return this._client.getCustomTargetingValuesByStatement({
+            filterStatement,
+        });
+    }
+    async performCustomTargetingKeyAction(customTargetingKeyAction, filterStatement) {
+        return this._client.performCustomTargetingKeyAction({
+            customTargetingKeyAction: {
+                attributes: {
+                    'xsi:type': customTargetingKeyAction,
+                },
+            },
+            filterStatement,
+        });
+    }
+    async performCustomTargetingValueAction(customTargetingValueAction, filterStatement) {
+        return this._client.performCustomTargetingValueAction({
+            customTargetingValueAction: {
+                attributes: {
+                    'xsi:type': customTargetingValueAction,
+                },
+            },
+            filterStatement,
+        });
+    }
+    async updateCustomTargetingKeys(keys) {
+        return this._client.updateCustomTargetingKeys({ keys });
+    }
+    async updateCustomTargetingValues(values) {
+        return this._client.updateCustomTargetingValues({ values });
+    }
+}
+exports.CustomTargetingService = CustomTargetingService;
+//# sourceMappingURL=customTargeting.service.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customTargeting.service.js","sourceRoot":"","sources":["../../../../lib/client/services/customTargeting/customTargeting.service.ts"],"names":[],"mappings":";;;AAaA,MAAa,sBAAsB;IAGjC,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,yBAAyB,CAAC,IAA0B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,KAAK,CAAC,2BAA2B,CAAC,MAA8B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED,KAAK,CAAC,iCAAiC,CAAC,eAA0B;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,iCAAiC,CAAC;YACpD,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,mCAAmC,CAAC,eAA0B;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,mCAAmC,CAAC;YACtD,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,+BAA+B,CACnC,wBAAkD,EAClD,eAA0B;QAE1B,OAAO,IAAI,CAAC,OAAO,CAAC,+BAA+B,CAAC;YAClD,wBAAwB,EAAE;gBACxB,UAAU,EAAE;oBACV,UAAU,EAAE,wBAAwB;iBACrC;aACF;YACD,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,iCAAiC,CACrC,0BAAsD,EACtD,eAA0B;QAE1B,OAAO,IAAI,CAAC,OAAO,CAAC,iCAAiC,CAAC;YACpD,0BAA0B,EAAE;gBAC1B,UAAU,EAAE;oBACV,UAAU,EAAE,0BAA0B;iBACvC;aACF;YACD,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,yBAAyB,CAAC,IAA0B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,KAAK,CAAC,2BAA2B,CAAC,MAA8B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9D,CAAC;CACF;AA9DD,wDA8DC"}

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

@@ -0,0 +1,92 @@
+import { PageResult } from '../../../common/types';
+import { CustomTargetingKeyStatus, CustomTargetingKeyType, CustomTargetingValueMatchType, CustomTargetingValueStatus, ReportableType, ValueDeclarationType } from './customTargeting.enum';
+/**
+ * **`CustomTargetingKey`** represents a key used for custom targeting.
+ */
+export declare type CustomTargetingKey = {
+    /**
+     * The ID of the CustomTargetingKey. This value is readonly and is populated by Google.
+     */
+    id: number;
+    /**
+     * Name of the key. This can be used for encoding .
+     * If you don't want users to be able to see potentially sensitive targeting information in the ad tags of your site, you can encode your key/values.
+     * For example, you can create key/value g1=abc to represent gender=female.
+     * Keys can contain up to 10 characters each.
+     * You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
+     */
+    name: string;
+    /**
+     * Descriptive name for the key.
+     */
+    displayName: string;
+    /**
+     * Indicates whether users will select from predefined values or create new targeting values, while specifying targeting criteria for a line item.
+     */
+    type: CustomTargetingKeyType;
+    /**
+     * Indicates the type of values being passed for this key in ad requests. This field is nullable for a key until it is set, after which it cannot be reset back to null.
+     */
+    valueDeclarationType: ValueDeclarationType;
+    /**
+     * Status of the CustomTargetingKey. This field is read-only. A key can be activated and deactivated by calling CustomTargetingService.performCustomTargetingKeyAction.
+     */
+    status: CustomTargetingKeyStatus;
+    /**
+     * Reportable state of a {@CustomTargetingKey} as defined in ReportableType.
+     */
+    reportableType: ReportableType;
+};
+/**
+ * Represents the actions that can be performed on
+ * {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects.
+ */
+export declare type CustomTargetingKeyAction = 'ActivateCustomTargetingKeys' | 'DeleteCustomTargetingKeys';
+/**
+ * Captures a page of {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects.
+ */
+export declare type CustomTargetingKeyPage = PageResult<CustomTargetingKey>;
+/**
+ * CustomTargetingValue represents a value used for custom targeting.
+ */
+export declare type CustomTargetingValue = {
+    /**
+     * The ID of the CustomTargetingKey for which this is the value.
+     */
+    customTargetingKeyId: number;
+    /**
+     * The ID of the CustomTargetingValue. This value is readonly and is populated by Google.
+     */
+    id: number;
+    /**
+     * Name of the value. This can be used for encoding .
+     * If you don't want users to be able to see potentially sensitive targeting information in the ad tags of your site, you can encode your key/values.
+     * For example, you can create key/value g1=abc to represent gender=female. Values can contain up to 40 characters each.
+     * You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ].
+     * Values are not data-specific; all values are treated as string. For example, instead of using "age>=18 AND <=34", try "18-34"
+     */
+    name: string;
+    /**
+     * Descriptive name for the value.
+     */
+    displayName: string;
+    /**
+     *  The way in which the CustomTargetingValue.name strings will be matched.
+     */
+    matchType: CustomTargetingValueMatchType;
+    /**
+     * Status of the CustomTargetingValue. This field is read-only.
+     * A value can be activated and deactivated by calling CustomTargetingService.performCustomTargetingValueAction.
+     */
+    status: CustomTargetingValueStatus;
+};
+/**
+ * Represents the actions that can be performed on
+ * {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
+ */
+export declare type CustomTargetingValueAction = 'ActivateCustomTargetingValues' | 'DeleteCustomTargetingValues';
+/**
+ * Captures a page of {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
+ */
+export declare type CustomTargetingValuePage = PageResult<CustomTargetingValue>;
+//# sourceMappingURL=customTargeting.type.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customTargeting.type.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/customTargeting/customTargeting.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EACL,wBAAwB,EACxB,sBAAsB,EACtB,6BAA6B,EAC7B,0BAA0B,EAC1B,cAAc,EACd,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAEhC;;GAEG;AACH,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAC7B;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C;;OAEG;IACH,MAAM,EAAE,wBAAwB,CAAC;IACjC;;OAEG;IACH,cAAc,EAAE,cAAc,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,oBAAY,wBAAwB,GAAG,6BAA6B,GAAG,2BAA2B,CAAC;AAEnG;;GAEG;AACH,oBAAY,sBAAsB,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAEpE;;GAEG;AACH,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,6BAA6B,CAAC;IACzC;;;OAGG;IACH,MAAM,EAAE,0BAA0B,CAAC;CACpC,CAAC;AAEF;;;GAGG;AACH,oBAAY,0BAA0B,GAAG,+BAA+B,GAAG,6BAA6B,CAAC;AAEzG;;GAEG;AACH,oBAAY,wBAAwB,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC"}

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

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

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

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

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

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

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

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

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

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

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

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