@guardian/google-admanager-api 6.1.0 → 6.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/dist/client/common/enums/delivery.enum.d.ts +1 -1
- package/dist/client/common/enums/delivery.enum.js +1 -1
- package/dist/client/common/enums/general.enum.d.ts +7 -7
- package/dist/client/common/enums/general.enum.js +7 -7
- package/dist/client/common/enums/lineItemSummary.enum.d.ts +4 -4
- package/dist/client/common/enums/lineItemSummary.enum.js +4 -4
- package/dist/client/common/types/general.type.d.ts +21 -21
- package/dist/client/common/types/label.type.d.ts +2 -2
- package/dist/client/common/types/lineItemSummary.type.d.ts +7 -7
- package/dist/client/common/types/targeting.type.d.ts +16 -18
- package/dist/client/common/types/targeting.type.d.ts.map +1 -1
- package/dist/client/common/types/targeting.type.js +10 -11
- package/dist/client/common/types/targeting.type.js.map +1 -1
- package/dist/client/services/activity/activity.type.d.ts +4 -4
- package/dist/client/services/activity/activityService.interface.d.ts +12 -12
- package/dist/client/services/activityGroup/activityGroup.type.d.ts +4 -4
- package/dist/client/services/activityGroup/activityGroupService.interface.d.ts +11 -11
- package/dist/client/services/adRule/adRule.type.d.ts +2 -2
- package/dist/client/services/adRule/adSpot.type.d.ts +1 -1
- package/dist/client/services/adjustment/adjustment.enum.d.ts +1 -1
- package/dist/client/services/adjustment/adjustment.enum.js +1 -1
- package/dist/client/services/adjustment/adjustment.type.d.ts +1 -1
- package/dist/client/services/adjustment/adjustmentService.interface.d.ts +23 -23
- package/dist/client/services/audienceSegment/audienceSegment.action.d.ts +6 -6
- package/dist/client/services/audienceSegment/audienceSegment.action.js +6 -6
- package/dist/client/services/audienceSegment/audienceSegment.enum.d.ts +4 -4
- package/dist/client/services/audienceSegment/audienceSegment.enum.js +4 -4
- package/dist/client/services/audienceSegment/audienceSegment.type.d.ts +14 -14
- package/dist/client/services/audienceSegment/audienceSegmentService.interface.d.ts +17 -17
- package/dist/client/services/cdnConfiguration/cdnConfiguration.action.d.ts +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.action.js +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.enum.d.ts +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.enum.js +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.interface.d.ts +11 -11
- package/dist/client/services/cdnConfiguration/cdnConfiguration.type.d.ts +1 -1
- package/dist/client/services/cmsMetadata/cmsMetadata.action.d.ts +6 -6
- package/dist/client/services/cmsMetadata/cmsMetadata.action.js +6 -6
- package/dist/client/services/cmsMetadata/cmsMetadataService.interface.d.ts +16 -16
- package/dist/client/services/company/company.type.d.ts +3 -3
- package/dist/client/services/company/companyService.interface.d.ts +11 -11
- package/dist/client/services/contact/contact.type.d.ts +2 -2
- package/dist/client/services/contact/contactService.interface.d.ts +15 -15
- package/dist/client/services/content/content.enum.d.ts +2 -2
- package/dist/client/services/content/content.enum.js +2 -2
- package/dist/client/services/content/content.type.d.ts +1 -1
- package/dist/client/services/content/contentService.interface.d.ts +15 -15
- package/dist/client/services/contentBundle/contentBundle.action.d.ts +3 -3
- package/dist/client/services/contentBundle/contentBundle.action.js +3 -3
- package/dist/client/services/contentBundle/contentBundle.type.d.ts +2 -2
- package/dist/client/services/contentBundle/contentBundleService.interface.d.ts +10 -10
- package/dist/client/services/creative/creative.action.d.ts +3 -3
- package/dist/client/services/creative/creative.action.js +3 -3
- package/dist/client/services/creative/creative.type.d.ts +1 -1
- package/dist/client/services/creative/creativeService.interface.d.ts +15 -15
- package/dist/client/services/creativeReview/creativeReviewService.interface.d.ts +4 -4
- package/dist/client/services/creativeSet/creativeSet.type.d.ts +1 -1
- package/dist/client/services/creativeSet/creativeSetService.interface.d.ts +10 -10
- package/dist/client/services/creativeTemplate/creativeTemplate.type.d.ts +1 -1
- package/dist/client/services/creativeTemplate/creativeTemplateService.interface.d.ts +8 -8
- package/dist/client/services/creativeWrapper/creativeWrapper.action.d.ts +3 -3
- package/dist/client/services/creativeWrapper/creativeWrapper.action.js +3 -3
- package/dist/client/services/creativeWrapper/creativeWrapper.type.d.ts +1 -1
- package/dist/client/services/creativeWrapper/creativeWrapperService.interface.d.ts +15 -15
- package/dist/client/services/customField/customField.action.d.ts +3 -3
- package/dist/client/services/customField/customField.action.js +3 -3
- package/dist/client/services/customField/customField.enum.d.ts +1 -1
- package/dist/client/services/customField/customField.enum.js +1 -1
- package/dist/client/services/customField/customField.type.d.ts +3 -3
- package/dist/client/services/customField/customFieldService.interface.d.ts +22 -22
- package/dist/client/services/customTargeting/customTargeting.action.d.ts +6 -6
- package/dist/client/services/customTargeting/customTargeting.action.js +6 -6
- package/dist/client/services/customTargeting/customTargeting.enum.d.ts +1 -1
- package/dist/client/services/customTargeting/customTargeting.enum.js +1 -1
- package/dist/client/services/customTargeting/customTargeting.interface.d.ts +29 -29
- package/dist/client/services/customTargeting/customTargeting.type.d.ts +2 -2
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.action.d.ts +3 -3
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.action.js +3 -3
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.type.d.ts +1 -1
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKeyService.interface.d.ts +13 -13
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.action.d.ts +3 -3
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.action.js +3 -3
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.enum.d.ts +1 -1
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.enum.js +1 -1
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.type.d.ts +2 -2
- package/dist/client/services/daiEncodingProfile/daiEncodingProfileService.interface.d.ts +11 -11
- package/dist/client/services/forecast/forecast.type.d.ts +1 -1
- package/dist/client/services/forecast/forecastService.interface.d.ts +9 -9
- package/dist/client/services/inventory/adUnit.action.d.ts +4 -4
- package/dist/client/services/inventory/adUnit.action.js +4 -4
- package/dist/client/services/inventory/adUnit.enum.d.ts +2 -2
- package/dist/client/services/inventory/adUnit.enum.js +2 -2
- package/dist/client/services/inventory/adUnit.type.d.ts +2 -2
- package/dist/client/services/inventory/inventoryService.interface.d.ts +16 -16
- package/dist/client/services/label/label.action.d.ts +3 -3
- package/dist/client/services/label/label.action.js +3 -3
- package/dist/client/services/label/label.interface.d.ts +11 -11
- package/dist/client/services/label/label.type.d.ts +1 -1
- package/dist/client/services/lineItem/lineItem.action.d.ts +9 -9
- package/dist/client/services/lineItem/lineItem.action.js +9 -9
- package/dist/client/services/lineItem/lineItem.type.d.ts +2 -2
- package/dist/client/services/lineItem/lineItemService.interface.d.ts +23 -23
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.action.d.ts +4 -4
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.action.js +4 -4
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.type.d.ts +6 -6
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociationService.interface.d.ts +18 -18
- package/dist/client/services/lineItemTemplate/lineItemTemplate.type.d.ts +1 -1
- package/dist/client/services/lineItemTemplate/lineItemTemplateService.interface.d.ts +5 -5
- package/dist/client/services/liveStreamEvent/liveStreamEvent.action.d.ts +7 -7
- package/dist/client/services/liveStreamEvent/liveStreamEvent.action.js +7 -7
- package/dist/client/services/liveStreamEvent/liveStreamEvent.enum.d.ts +2 -2
- package/dist/client/services/liveStreamEvent/liveStreamEvent.enum.js +2 -2
- package/dist/client/services/liveStreamEvent/liveStreamEvent.type.d.ts +1 -1
- package/dist/client/services/liveStreamEvent/liveStreamEventService.interface.d.ts +29 -29
- package/dist/client/services/mobileApplication/mobileApplication.action.d.ts +3 -3
- package/dist/client/services/mobileApplication/mobileApplication.action.js +3 -3
- package/dist/client/services/mobileApplication/mobileApplication.enum.d.ts +2 -2
- package/dist/client/services/mobileApplication/mobileApplication.enum.js +2 -2
- package/dist/client/services/mobileApplication/mobileApplication.type.d.ts +1 -1
- package/dist/client/services/mobileApplication/mobileApplicationService.interface.d.ts +12 -12
- package/dist/client/services/nativeStyle/nativeStyle.type.d.ts +1 -1
- package/dist/client/services/nativeStyle/nativeStyleService.interface.d.ts +9 -9
- package/dist/client/services/order/order.action.d.ts +13 -13
- package/dist/client/services/order/order.action.js +13 -13
- package/dist/client/services/order/order.enum.d.ts +5 -5
- package/dist/client/services/order/order.enum.js +5 -5
- package/dist/client/services/order/order.type.d.ts +13 -13
- package/dist/client/services/order/orderService.interface.d.ts +18 -18
- package/dist/client/services/placement/placement.action.d.ts +4 -4
- package/dist/client/services/placement/placement.action.js +4 -4
- package/dist/client/services/placement/placement.type.d.ts +1 -1
- package/dist/client/services/placement/placementService.interface.d.ts +13 -13
- package/dist/client/services/proposal/proposal.action.d.ts +15 -15
- package/dist/client/services/proposal/proposal.action.js +15 -15
- package/dist/client/services/proposal/proposal.enum.d.ts +1 -1
- package/dist/client/services/proposal/proposal.enum.js +1 -1
- package/dist/client/services/proposal/proposal.type.d.ts +3 -3
- package/dist/client/services/proposal/proposalService.interface.d.ts +26 -26
- package/dist/client/services/proposalLineItem/proposalLineItem.action.d.ts +10 -10
- package/dist/client/services/proposalLineItem/proposalLineItem.action.js +10 -10
- package/dist/client/services/proposalLineItem/proposalLineItem.type.d.ts +3 -3
- package/dist/client/services/proposalLineItem/proposalLineItemService.interface.d.ts +15 -15
- package/dist/client/services/publisherQueryLanguage/publisherQueryLanguageService.interface.d.ts +3 -3
- package/dist/client/services/report/report.type.d.ts +2 -2
- package/dist/client/services/report/reportService.interface.d.ts +16 -16
- package/dist/client/services/site/siteService.interface.d.ts +13 -13
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.action.d.ts +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.action.js +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.type.d.ts +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnitService.interface.d.ts +9 -9
- package/dist/client/services/targetingPresent/targetingPresentService.interface.d.ts +5 -5
- package/dist/client/services/team/team.action.d.ts +3 -3
- package/dist/client/services/team/team.action.js +3 -3
- package/dist/client/services/team/team.type.d.ts +2 -2
- package/dist/client/services/team/teamService.interface.d.ts +12 -12
- package/dist/client/services/user/user.action.d.ts +3 -3
- package/dist/client/services/user/user.action.js +3 -3
- package/dist/client/services/user/user.type.d.ts +5 -5
- package/dist/client/services/user/userService.interface.d.ts +17 -17
- package/dist/client/services/userTeamAssociation/userTeamAssociation.action.d.ts +2 -2
- package/dist/client/services/userTeamAssociation/userTeamAssociation.action.js +2 -2
- package/dist/client/services/userTeamAssociation/userTeamAssociation.type.d.ts +5 -5
- package/dist/client/services/userTeamAssociation/userTeamAssociationService.interface.d.ts +10 -10
- package/dist/common/types/statement.type.d.ts +4 -4
- package/package.json +1 -1
|
@@ -2,19 +2,19 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.DeactivateCustomFields = exports.ActivateCustomFields = exports.CustomFieldAction = void 0;
|
|
4
4
|
/**
|
|
5
|
-
* Represents the actions that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* Represents the actions that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField CustomField} objects.
|
|
6
6
|
*/
|
|
7
7
|
class CustomFieldAction {
|
|
8
8
|
}
|
|
9
9
|
exports.CustomFieldAction = CustomFieldAction;
|
|
10
10
|
/**
|
|
11
|
-
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/
|
|
11
|
+
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField CustomField} objects.
|
|
12
12
|
*/
|
|
13
13
|
class ActivateCustomFields {
|
|
14
14
|
}
|
|
15
15
|
exports.ActivateCustomFields = ActivateCustomFields;
|
|
16
16
|
/**
|
|
17
|
-
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
+
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField CustomField} objects.
|
|
18
18
|
*/
|
|
19
19
|
class DeactivateCustomFields {
|
|
20
20
|
}
|
|
@@ -36,7 +36,7 @@ export declare enum CustomFieldEntityType {
|
|
|
36
36
|
UNKNOWN = "UNKNOWN"
|
|
37
37
|
}
|
|
38
38
|
/**
|
|
39
|
-
* The data types allowed for {@link https://developers.google.com/ad-manager/api/reference/
|
|
39
|
+
* The data types allowed for {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField CustomField} objects.
|
|
40
40
|
*/
|
|
41
41
|
export declare enum CustomFieldDataType {
|
|
42
42
|
/**
|
|
@@ -40,7 +40,7 @@ var CustomFieldEntityType;
|
|
|
40
40
|
CustomFieldEntityType["UNKNOWN"] = "UNKNOWN";
|
|
41
41
|
})(CustomFieldEntityType || (exports.CustomFieldEntityType = CustomFieldEntityType = {}));
|
|
42
42
|
/**
|
|
43
|
-
* The data types allowed for {@link https://developers.google.com/ad-manager/api/reference/
|
|
43
|
+
* The data types allowed for {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField CustomField} objects.
|
|
44
44
|
*/
|
|
45
45
|
var CustomFieldDataType;
|
|
46
46
|
(function (CustomFieldDataType) {
|
|
@@ -2,8 +2,8 @@ import type { PageResult } from "../../../common/types";
|
|
|
2
2
|
import type { CustomFieldDataType, CustomFieldEntityType, CustomFieldVisibility } from "./customField.enum";
|
|
3
3
|
/**
|
|
4
4
|
* An option represents a permitted value for a custom field that has a
|
|
5
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField#dataType CustomField.dataType} of
|
|
6
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomFieldDataType#DROP_DOWN CustomFieldDataType.DROP_DOWN}.
|
|
7
7
|
*/
|
|
8
8
|
export type CustomFieldOption = {
|
|
9
9
|
/**
|
|
@@ -62,7 +62,7 @@ export type CustomField = {
|
|
|
62
62
|
visibility: CustomFieldVisibility;
|
|
63
63
|
} & DropDownCustomField;
|
|
64
64
|
/**
|
|
65
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
65
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField CustomField} objects.
|
|
66
66
|
*/
|
|
67
67
|
export type CustomFieldPage = PageResult<CustomField>;
|
|
68
68
|
//# sourceMappingURL=customField.type.d.ts.map
|
|
@@ -2,38 +2,38 @@ import type { Statement, UpdateResult } from "../../../common/types";
|
|
|
2
2
|
import type { CustomFieldAction } from "./customField.action";
|
|
3
3
|
import type { CustomField, CustomFieldOption, CustomFieldPage } from "./customField.type";
|
|
4
4
|
/**
|
|
5
|
-
* Provides methods for the creation and management of {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* Provides methods for the creation and management of {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField CustomField} objects.
|
|
6
6
|
*
|
|
7
7
|
*/
|
|
8
8
|
export interface CustomFieldServiceOperations {
|
|
9
9
|
/**
|
|
10
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
10
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomFieldOption CustomFieldOption} objects.
|
|
11
11
|
*
|
|
12
12
|
* The following fields are required:
|
|
13
13
|
*
|
|
14
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
14
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField#name CustomFieldOption.displayName}
|
|
15
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField#name CustomFieldOption.customFieldId}
|
|
16
16
|
*
|
|
17
17
|
* @param customFieldOptions the custom fields to create
|
|
18
18
|
* @returns the created custom field options with their IDs filled in
|
|
19
19
|
*/
|
|
20
20
|
createCustomFieldOptions(customFieldOptions: Partial<CustomFieldOption>[]): Promise<CustomFieldOption[]>;
|
|
21
21
|
/**
|
|
22
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
22
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField CustomField} objects.
|
|
23
23
|
*
|
|
24
24
|
* The following fields are required:
|
|
25
25
|
*
|
|
26
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField#name CustomField.name}
|
|
27
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField#entityType CustomField.entityType}
|
|
28
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField#dataType CustomField.dataType}
|
|
29
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField#visibility CustomField.visibility}
|
|
30
30
|
*
|
|
31
31
|
* @param customFields the custom fields to create
|
|
32
32
|
* @returns the created custom fields with their IDs filled in
|
|
33
33
|
*/
|
|
34
34
|
createCustomFields(customFields: Partial<CustomField>[]): Promise<CustomField[]>;
|
|
35
35
|
/**
|
|
36
|
-
* Returns the {@link https://developers.google.com/ad-manager/api/reference/
|
|
36
|
+
* Returns the {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomFieldOption CustomFieldOption}
|
|
37
37
|
* uniquely identified by the given ID.
|
|
38
38
|
*
|
|
39
39
|
* @param customFieldOptionId the ID of the custom field option, which must already exist
|
|
@@ -41,26 +41,26 @@ export interface CustomFieldServiceOperations {
|
|
|
41
41
|
*/
|
|
42
42
|
getCustomFieldOption(customFieldOptionId: number): Promise<CustomFieldOption>;
|
|
43
43
|
/**
|
|
44
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
45
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
46
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
44
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomFieldPage CustomFieldPage}
|
|
45
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField CustomField} objects that satisfy the given
|
|
46
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.Statement#query Statement.query}.
|
|
47
47
|
* The following fields are supported for filtering:
|
|
48
48
|
*
|
|
49
49
|
* | PQL Property | PQL Property |
|
|
50
50
|
* | ------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
|
|
51
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
52
|
-
* | entityType | {@link https://developers.google.com/ad-manager/api/reference/
|
|
53
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
54
|
-
* | isActive | {@link https://developers.google.com/ad-manager/api/reference/
|
|
55
|
-
* | visibility | {@link https://developers.google.com/ad-manager/api/reference/
|
|
51
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField#id CustomField.id} |
|
|
52
|
+
* | entityType | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField#entityType CustomField.entityType} |
|
|
53
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField#name CustomField.name} |
|
|
54
|
+
* | isActive | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField#isActive CustomField.isActive} |
|
|
55
|
+
* | visibility | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField#visibility CustomField.visibility} |
|
|
56
56
|
*
|
|
57
57
|
* @param filterStatement a Publisher Query Language statement used to filter a set of custom fields.
|
|
58
58
|
* @returns the custom fields that match the given filter
|
|
59
59
|
*/
|
|
60
60
|
getCustomFieldsByStatement(filterStatement: Statement): Promise<CustomFieldPage>;
|
|
61
61
|
/**
|
|
62
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
63
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
62
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField CustomField} objects that match the given
|
|
63
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.Statement#query Statement.query}.
|
|
64
64
|
*
|
|
65
65
|
* @param CustomFieldAction the action to perform
|
|
66
66
|
* @param filterStatement a Publisher Query Language statement used to filter a set of custom fields
|
|
@@ -68,14 +68,14 @@ export interface CustomFieldServiceOperations {
|
|
|
68
68
|
*/
|
|
69
69
|
performCustomFieldAction(customFieldAction: CustomFieldAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
70
70
|
/**
|
|
71
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
71
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomFieldOption CustomFieldOption} objects.
|
|
72
72
|
*
|
|
73
73
|
* @param customFieldOptions the custom field options to update
|
|
74
74
|
* @returns the updated custom field options
|
|
75
75
|
*/
|
|
76
76
|
updateCustomFieldOptions(customFieldOptions: CustomFieldOption[]): Promise<CustomFieldOption[]>;
|
|
77
77
|
/**
|
|
78
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
78
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField CustomField} objects.
|
|
79
79
|
*
|
|
80
80
|
* @param customFields the custom fields to update
|
|
81
81
|
* @returns the updated custom fields
|
|
@@ -1,36 +1,36 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Represents the actions that can be performed on
|
|
3
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
3
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects.
|
|
4
4
|
*/
|
|
5
5
|
export declare abstract class CustomTargetingKeyAction {
|
|
6
6
|
}
|
|
7
7
|
/**
|
|
8
8
|
* The action used for activating inactive (i.e. deleted)
|
|
9
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
9
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects.
|
|
10
10
|
*/
|
|
11
11
|
export declare class ActivateCustomTargetingKeys implements CustomTargetingKeyAction {
|
|
12
12
|
}
|
|
13
13
|
/**
|
|
14
14
|
* Represents the delete action that can be performed on
|
|
15
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects.
|
|
16
16
|
*/
|
|
17
17
|
export declare class DeleteCustomTargetingKeys implements CustomTargetingKeyAction {
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
20
20
|
* Represents the actions that can be performed on
|
|
21
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
21
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
|
|
22
22
|
*/
|
|
23
23
|
export declare abstract class CustomTargetingValueAction {
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
26
|
* The action used for activating inactive (i.e. deleted)
|
|
27
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
|
|
28
28
|
*/
|
|
29
29
|
export declare class ActivateCustomTargetingValues implements CustomTargetingValueAction {
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
32
|
* Represents the delete action that can be performed on
|
|
33
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
33
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
|
|
34
34
|
*/
|
|
35
35
|
export declare class DeleteCustomTargetingValues implements CustomTargetingValueAction {
|
|
36
36
|
}
|
|
@@ -3,42 +3,42 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.DeleteCustomTargetingValues = exports.ActivateCustomTargetingValues = exports.CustomTargetingValueAction = exports.DeleteCustomTargetingKeys = exports.ActivateCustomTargetingKeys = exports.CustomTargetingKeyAction = void 0;
|
|
4
4
|
/**
|
|
5
5
|
* Represents the actions that can be performed on
|
|
6
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects.
|
|
7
7
|
*/
|
|
8
8
|
class CustomTargetingKeyAction {
|
|
9
9
|
}
|
|
10
10
|
exports.CustomTargetingKeyAction = CustomTargetingKeyAction;
|
|
11
11
|
/**
|
|
12
12
|
* The action used for activating inactive (i.e. deleted)
|
|
13
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
13
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects.
|
|
14
14
|
*/
|
|
15
15
|
class ActivateCustomTargetingKeys {
|
|
16
16
|
}
|
|
17
17
|
exports.ActivateCustomTargetingKeys = ActivateCustomTargetingKeys;
|
|
18
18
|
/**
|
|
19
19
|
* Represents the delete action that can be performed on
|
|
20
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
20
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects.
|
|
21
21
|
*/
|
|
22
22
|
class DeleteCustomTargetingKeys {
|
|
23
23
|
}
|
|
24
24
|
exports.DeleteCustomTargetingKeys = DeleteCustomTargetingKeys;
|
|
25
25
|
/**
|
|
26
26
|
* Represents the actions that can be performed on
|
|
27
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
|
|
28
28
|
*/
|
|
29
29
|
class CustomTargetingValueAction {
|
|
30
30
|
}
|
|
31
31
|
exports.CustomTargetingValueAction = CustomTargetingValueAction;
|
|
32
32
|
/**
|
|
33
33
|
* The action used for activating inactive (i.e. deleted)
|
|
34
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
34
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
|
|
35
35
|
*/
|
|
36
36
|
class ActivateCustomTargetingValues {
|
|
37
37
|
}
|
|
38
38
|
exports.ActivateCustomTargetingValues = ActivateCustomTargetingValues;
|
|
39
39
|
/**
|
|
40
40
|
* Represents the delete action that can be performed on
|
|
41
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
41
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
|
|
42
42
|
*/
|
|
43
43
|
class DeleteCustomTargetingValues {
|
|
44
44
|
}
|
|
@@ -66,7 +66,7 @@ export declare enum ReportableType {
|
|
|
66
66
|
}
|
|
67
67
|
/**
|
|
68
68
|
* Represents the ways in which
|
|
69
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
69
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue#name CustomTargetingValue.name} strings will be matched with ad requests.
|
|
70
70
|
*/
|
|
71
71
|
export declare enum CustomTargetingValueMatchType {
|
|
72
72
|
/**
|
|
@@ -73,7 +73,7 @@ var ReportableType;
|
|
|
73
73
|
})(ReportableType || (exports.ReportableType = ReportableType = {}));
|
|
74
74
|
/**
|
|
75
75
|
* Represents the ways in which
|
|
76
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
76
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue#name CustomTargetingValue.name} strings will be matched with ad requests.
|
|
77
77
|
*/
|
|
78
78
|
var CustomTargetingValueMatchType;
|
|
79
79
|
(function (CustomTargetingValueMatchType) {
|
|
@@ -3,54 +3,54 @@ import type { CustomTargetingKeyAction, CustomTargetingValueAction } from "./cus
|
|
|
3
3
|
import type { CustomTargetingKey, CustomTargetingKeyPage, CustomTargetingValue, CustomTargetingValuePage } from "./customTargeting.type";
|
|
4
4
|
/**
|
|
5
5
|
* Provides operations for creating, updating and retrieving
|
|
6
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
-
* and {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey}
|
|
7
|
+
* and {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
|
|
8
8
|
*
|
|
9
9
|
*/
|
|
10
10
|
export interface CustomTargetingServiceOperations {
|
|
11
11
|
/**
|
|
12
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
12
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects.
|
|
13
13
|
* The following fields are required:
|
|
14
14
|
*
|
|
15
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
16
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey#name CustomTargetingKey.name }
|
|
16
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey#type CustomTargetingKey.type }
|
|
17
17
|
*
|
|
18
18
|
* @param keys the custom targeting keys to update
|
|
19
19
|
* @returns the updated custom targeting keys
|
|
20
20
|
*/
|
|
21
21
|
createCustomTargetingKeys(keys: Partial<CustomTargetingKey>[]): Promise<CustomTargetingKey[]>;
|
|
22
22
|
/**
|
|
23
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
|
|
24
24
|
* The following fields are required:
|
|
25
25
|
*
|
|
26
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue#customTargetingKeyId CustomTargetingValue.customTargetingKeyId }
|
|
27
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey#name CustomTargetingValue.name }
|
|
28
28
|
*
|
|
29
29
|
* @param values the custom targeting values to update
|
|
30
30
|
* @returns the updated custom targeting values
|
|
31
31
|
*/
|
|
32
32
|
createCustomTargetingValues(values: Partial<CustomTargetingValue>[]): Promise<CustomTargetingValue[]>;
|
|
33
33
|
/**
|
|
34
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
35
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
36
|
-
* the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
34
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKeyPage CustomTargetingKeyPage}
|
|
35
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects that satisfy
|
|
36
|
+
* the given {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.Statement#query Statement.query}.
|
|
37
37
|
* The following fields are supported for filtering:
|
|
38
38
|
*
|
|
39
39
|
* | PQL Property | PQL Property |
|
|
40
40
|
* | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
41
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
42
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
43
|
-
* | displayName | {@link https://developers.google.com/ad-manager/api/reference/
|
|
44
|
-
* | type | {@link https://developers.google.com/ad-manager/api/reference/
|
|
41
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey#id CustomTargetingKey.id} |
|
|
42
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey#name CustomTargetingKey.name} |
|
|
43
|
+
* | displayName | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey#displayName CustomTargetingKey.displayName} |
|
|
44
|
+
* | type | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey#type CustomTargetingKey.type} |
|
|
45
45
|
*
|
|
46
46
|
* @param filterStatement a Publisher Query Language statement used to filter a set of custom targeting keys
|
|
47
47
|
* @returns the custom targeting keys that match the given filter
|
|
48
48
|
*/
|
|
49
49
|
getCustomTargetingKeysByStatement(filterStatement: Statement): Promise<CustomTargetingKeyPage>;
|
|
50
50
|
/**
|
|
51
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
52
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
53
|
-
* the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
51
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValuePage CustomTargetingValuePage}
|
|
52
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects that satisfy
|
|
53
|
+
* the given {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.Statement#query Statement.query}.
|
|
54
54
|
*
|
|
55
55
|
* The WHERE clause in the Statement.query must always contain CustomTargetingValue.customTargetingKeyId as one of its columns in a way that it is
|
|
56
56
|
* 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:
|
|
@@ -62,19 +62,19 @@ export interface CustomTargetingServiceOperations {
|
|
|
62
62
|
*
|
|
63
63
|
* | PQL Property | PQL Property |
|
|
64
64
|
* | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
65
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
66
|
-
* | customTargetingKeyId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
67
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
68
|
-
* | displayName | {@link https://developers.google.com/ad-manager/api/reference/
|
|
69
|
-
* | matchType | {@link https://developers.google.com/ad-manager/api/reference/
|
|
65
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue#id CustomTargetingValue.id} |
|
|
66
|
+
* | customTargetingKeyId | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue#customTargetingKeyId CustomTargetingValue.customTargetingKeyId} |
|
|
67
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue#name CustomTargetingValue.name} |
|
|
68
|
+
* | displayName | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue#displayName CustomTargetingValue.displayName} |
|
|
69
|
+
* | matchType | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue#matchType CustomTargetingValue.matchType} |
|
|
70
70
|
*
|
|
71
71
|
* @param filterStatement a Publisher Query Language statement used to filter a set of custom targeting values
|
|
72
72
|
* @returns the custom targeting values that match the given filter
|
|
73
73
|
*/
|
|
74
74
|
getCustomTargetingValuesByStatement(filterStatement: Statement): Promise<CustomTargetingValuePage>;
|
|
75
75
|
/**
|
|
76
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
77
|
-
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
76
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey}
|
|
77
|
+
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.Statement#query Statement.query}.
|
|
78
78
|
*
|
|
79
79
|
* @param customTargetingKeyAction the action to perform
|
|
80
80
|
* @param filterStatement a Publisher Query Language statement used to filter a set of custom targeting keys
|
|
@@ -82,8 +82,8 @@ export interface CustomTargetingServiceOperations {
|
|
|
82
82
|
*/
|
|
83
83
|
performCustomTargetingKeyAction(customTargetingKeyAction: CustomTargetingKeyAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
84
84
|
/**
|
|
85
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
86
|
-
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
85
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue}
|
|
86
|
+
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.Statement#query Statement.query}.
|
|
87
87
|
*
|
|
88
88
|
* @param customTargetingKeyAction the action to perform
|
|
89
89
|
* @param filterStatement a Publisher Query Language statement used to filter a set of ad units
|
|
@@ -91,14 +91,14 @@ export interface CustomTargetingServiceOperations {
|
|
|
91
91
|
*/
|
|
92
92
|
performCustomTargetingValueAction(customTargetingValueAction: CustomTargetingValueAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
93
93
|
/**
|
|
94
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
94
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects.
|
|
95
95
|
*
|
|
96
96
|
* @param keys the custom targeting keys to update
|
|
97
97
|
* @returns the updated custom targeting keys
|
|
98
98
|
*/
|
|
99
99
|
updateCustomTargetingKeys(keys: CustomTargetingKey[]): Promise<CustomTargetingKey[]>;
|
|
100
100
|
/**
|
|
101
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
101
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
|
|
102
102
|
*
|
|
103
103
|
* @param values the custom targeting values to update
|
|
104
104
|
* @returns the updated custom targeting values
|
|
@@ -39,7 +39,7 @@ export type CustomTargetingKey = {
|
|
|
39
39
|
reportableType: ReportableType;
|
|
40
40
|
};
|
|
41
41
|
/**
|
|
42
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
42
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects.
|
|
43
43
|
*/
|
|
44
44
|
export type CustomTargetingKeyPage = PageResult<CustomTargetingKey>;
|
|
45
45
|
/**
|
|
@@ -81,7 +81,7 @@ export type CustomTargetingValue = {
|
|
|
81
81
|
*/
|
|
82
82
|
export declare const CustomTargetingValueStruct: Describe<CustomTargetingValue>;
|
|
83
83
|
/**
|
|
84
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
84
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
|
|
85
85
|
*/
|
|
86
86
|
export type CustomTargetingValuePage = PageResult<CustomTargetingValue>;
|
|
87
87
|
//# sourceMappingURL=customTargeting.type.d.ts.map
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Represents the actions that can be performed on
|
|
3
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
3
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
4
4
|
*/
|
|
5
5
|
export declare abstract class DaiAuthenticationKeyAction {
|
|
6
6
|
}
|
|
7
7
|
/**
|
|
8
|
-
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/
|
|
8
|
+
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
9
9
|
*/
|
|
10
10
|
export declare class ActivateDaiAuthenticationKeys implements DaiAuthenticationKeyAction {
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
13
|
-
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/
|
|
13
|
+
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
14
14
|
*/
|
|
15
15
|
export declare class DeactivateDaiAuthenticationKeys implements DaiAuthenticationKeyAction {
|
|
16
16
|
}
|
|
@@ -3,19 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.DeactivateDaiAuthenticationKeys = exports.ActivateDaiAuthenticationKeys = exports.DaiAuthenticationKeyAction = void 0;
|
|
4
4
|
/**
|
|
5
5
|
* Represents the actions that can be performed on
|
|
6
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
7
7
|
*/
|
|
8
8
|
class DaiAuthenticationKeyAction {
|
|
9
9
|
}
|
|
10
10
|
exports.DaiAuthenticationKeyAction = DaiAuthenticationKeyAction;
|
|
11
11
|
/**
|
|
12
|
-
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/
|
|
12
|
+
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
13
13
|
*/
|
|
14
14
|
class ActivateDaiAuthenticationKeys {
|
|
15
15
|
}
|
|
16
16
|
exports.ActivateDaiAuthenticationKeys = ActivateDaiAuthenticationKeys;
|
|
17
17
|
/**
|
|
18
|
-
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/
|
|
18
|
+
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
19
19
|
*/
|
|
20
20
|
class DeactivateDaiAuthenticationKeys {
|
|
21
21
|
}
|
|
@@ -34,7 +34,7 @@ export type DaiAuthenticationKey = {
|
|
|
34
34
|
keyType: DaiAuthenticationKeyType;
|
|
35
35
|
};
|
|
36
36
|
/**
|
|
37
|
-
* Captures a page of https://developers.google.com/ad-manager/api/reference/
|
|
37
|
+
* Captures a page of https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
38
38
|
*/
|
|
39
39
|
export type DaiAuthenticationKeyPage = PageResult<DaiAuthenticationKey>;
|
|
40
40
|
//# sourceMappingURL=daiAuthenticationKey.type.d.ts.map
|
package/dist/client/services/daiAuthenticationKey/daiAuthenticationKeyService.interface.d.ts
CHANGED
|
@@ -3,42 +3,42 @@ import type { DaiAuthenticationKeyAction } from "./daiAuthenticationKey.action";
|
|
|
3
3
|
import type { DaiAuthenticationKey, DaiAuthenticationKeyPage } from "./daiAuthenticationKey.type";
|
|
4
4
|
/**
|
|
5
5
|
* Provides methods for creating, updating and retrieving
|
|
6
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
7
7
|
*/
|
|
8
8
|
export interface DaiAuthenticationKeyServiceOperations {
|
|
9
9
|
/**
|
|
10
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
10
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
11
11
|
*
|
|
12
12
|
* The following fields are required:
|
|
13
13
|
*
|
|
14
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
14
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey#name DaiAuthenticationKey.name }
|
|
15
15
|
*
|
|
16
16
|
* @param daiAuthenticationKeys the DAI authentication keys to create
|
|
17
17
|
* @returns the created DAI authentication keys with their IDs filled in
|
|
18
18
|
*/
|
|
19
19
|
createDaiAuthenticationKeys(daiAuthenticationKeys: Partial<DaiAuthenticationKey>[]): Promise<DaiAuthenticationKey[]>;
|
|
20
20
|
/**
|
|
21
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
22
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
21
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKeyPage DaiAuthenticationKeyPage}
|
|
22
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects that satisfy the given
|
|
23
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.Statement#query Statement.query}.
|
|
24
24
|
* The following fields are supported for filtering:
|
|
25
25
|
*
|
|
26
26
|
* | PQL Property | PQL Property |
|
|
27
27
|
* | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
28
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
30
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey#id DaiAuthenticationKey.id} |
|
|
29
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey#status DaiAuthenticationKey.status} |
|
|
30
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey#name DaiAuthenticationKey.name} |
|
|
31
31
|
*
|
|
32
32
|
* @param filterStatement a Publisher Query Language statement to filter a list of DAI authentication keys
|
|
33
33
|
* @returns the DAI authentication keys that match the filter
|
|
34
34
|
*/
|
|
35
35
|
getDaiAuthenticationKeysByStatement(filterStatement: Statement): Promise<DaiAuthenticationKeyPage>;
|
|
36
36
|
/**
|
|
37
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
38
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
37
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects that match the given
|
|
38
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.Statement#query Statement.query}.
|
|
39
39
|
*
|
|
40
40
|
* DAI authentication keys cannot be deactivated if there are active
|
|
41
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
41
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent}s or Content Sources that are using them.
|
|
42
42
|
*
|
|
43
43
|
* @param daiAuthenticationKeyAction the action to perform
|
|
44
44
|
* @param filterStatement a Publisher Query Language statement used to filter a set of live stream events
|
|
@@ -46,7 +46,7 @@ export interface DaiAuthenticationKeyServiceOperations {
|
|
|
46
46
|
*/
|
|
47
47
|
performDaiAuthenticationKeyAction(daiAuthenticationKeyAction: DaiAuthenticationKeyAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
48
48
|
/**
|
|
49
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
49
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
50
50
|
*
|
|
51
51
|
* @param daiAuthenticationKeys the video DAI authentication keys to update
|
|
52
52
|
* @returns the updated DAI authentication keys
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Represents the actions that can be performed on
|
|
3
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
3
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} objects.
|
|
4
4
|
*/
|
|
5
5
|
export declare abstract class DaiEncodingProfileAction {
|
|
6
6
|
}
|
|
7
7
|
/**
|
|
8
|
-
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/
|
|
8
|
+
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} objects.
|
|
9
9
|
*/
|
|
10
10
|
export declare class ActivateDaiEncodingProfiles implements DaiEncodingProfileAction {
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
13
|
-
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/
|
|
13
|
+
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} objects.
|
|
14
14
|
*/
|
|
15
15
|
export declare class ArchiveDaiEncodingProfiles implements DaiEncodingProfileAction {
|
|
16
16
|
}
|