@niur/google-admanager-api/dist/client/common/types/general.type.d.ts

Google Ad Manager API Client Library for NodeJs

import { TimeUnit } from '../../../common/enums';
import { Value } from '../../../common/types';
import { AccountStatus, DeclarationType, DelegationStatus, DelegationType, GoalType, OnboardingTask, UnitType } from '../enums';
/**
 * Represents a set of declarations about what (if any) third party companies are associated with a given creative.
 *
 * This can be set at the network level, as a default for all creatives, or overridden for a particular creative.
 *
 */
export declare type ThirdPartyDataDeclaration = {
    declarationType: DeclarationType;
    thirdPartyCompanyIds: number[];
};
export declare type ChildPublisher = {
    approvedDelegationType: DelegationType;
    proposedDelegationType: DelegationType;
    status: DelegationStatus;
    accountStatus: AccountStatus;
    childNetworkCode: string;
    sellerId: string;
    proposedRevenueShareMillipercent: number;
    onboardingTasks: OnboardingTask[];
};
/**
 * Represents a money amount.
 */
export declare type Money = {
    /**
     * Three letter currency code in string format.
     */
    currencyCode: string;
    /**
     * Money values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
     */
    microAmount: number;
};
/**
 * Represents the dimensions of an {@link https://developers.google.com/ad-manager/api/reference/v202202/InventoryService.AdUnit AdUnit},
 * {@link https://developers.google.com/ad-manager/api/reference/v202202/ForecastService.LineItem LineItem} or
 * {@link https://developers.google.com/ad-manager/api/reference/v202202/CreativeService.Creative Creative}.
 *
 * For interstitial size (out-of-page), native, ignored and fluid size,
 * {@link https://developers.google.com/ad-manager/api/reference/v202202/DaiEncodingProfileService.Size Size} must be 1x1.
 */
export declare type Size = {
    /**
     *  The width of the AdUnit, LineItem or Creative.
     */
    width: number;
    /**
     * The height of the AdUnit, LineItem or Creative.
     */
    height: number;
    /**
     * Whether this size represents an aspect ratio.
     */
    isAspectRatio: boolean;
};
/**
 * The value of a {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField CustomField} for a particular entity.
 */
export declare type BaseCustomFieldValue = {
    /**
     * Id of the **CustomField** to which this value belongs. This attribute is required.
     */
    customFieldId: number;
} & CustomFieldValue & DropDownCustomFieldValue;
/**
 * The value of a {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField CustomField}
 * that does not have a {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField#dataType CustomField.dataType}
 * of {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomFieldDataType#DROP_DOWN CustomFieldDataType.DROP_DOWN}.
 */
declare type CustomFieldValue = {
    /**
     * The value for this field. The appropriate type of **Value** is determined by the
     * {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField#dataType CustomField.dataType}
     * of the **CustomField** that this conforms to.
     *
     * | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomFieldDataType CustomFieldDataType} | {@link https://developers.google.com/ad-manager/api/reference/v202202/OrderService.Value Value} type            |
     * | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
     * | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomFieldDataType#STRING STRING}       | 	{@link https://developers.google.com/ad-manager/api/reference/v202202/OrderService.TextValue TextValue}        |
     * | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomFieldDataType#NUMBER NUMBER}       | 	{@link https://developers.google.com/ad-manager/api/reference/v202202/OrderService.NumberValue NumberValue}    |
     * | {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomFieldDataType#TOGGLE TOGGLE}       | 	{@link https://developers.google.com/ad-manager/api/reference/v202202/OrderService.BooleanValue BooleanValue}  |
     *
     */
    value: Value;
};
/**
 * A {@link https://developers.google.com/ad-manager/api/reference/v202202/OrderService.CustomFieldValue CustomFieldValue} for a
 * {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField CustomField} that has a
 * {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomField#dataType CustomField.dataType} of
 * {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomFieldDataType#DROP_DOWN CustomFieldDataType.DROP_DOWN}
 */
declare type DropDownCustomFieldValue = {
    /**
     * The {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomFieldOption#id ID}
     * of the {@link https://developers.google.com/ad-manager/api/reference/v202202/CustomFieldService.CustomFieldOption CustomFieldOption} for this value.
     */
    customFieldOptionId: number;
};
/**
 * Represents a limit on the number of times a single viewer can be exposed to the same
 * {@link https://developers.google.com/ad-manager/api/reference/v202202/ForecastService.LineItem LineItem} in a specified time period.
 */
export declare type FrequencyCap = {
    /**
     * The maximum number of impressions than can be served to a user within a specified time period.
     */
    maxImpressions: number;
    /**
     * The number of FrequencyCap#timeUnit to represent the total time period.
     */
    numTimeUnits: number;
    /**
     * The unit of time for specifying the time period.
     */
    timeUnit: TimeUnit;
};
/**
 * Defines the criteria a {@link https://developers.google.com/ad-manager/api/reference/v202202/LineItemService.LineItem LineItem} needs to satisfy to meet its delivery goal.
 */
export declare type Goal = {
    /**
     * The type of the goal for the LineItem. It defines the period over which the goal for LineItem should be reached.
     */
    goalType: GoalType;
    /**
     * The type of the goal unit for the LineItem.
     */
    unitType: UnitType;
    /**
     * If this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved for the LineItem. If the line item is of type LineItemType.SPONSORSHIP, it represents the percentage of available impressions reserved. If the line item is of type LineItemType.BULK or LineItemType.PRICE_PRIORITY, it represents the number of remaining impressions reserved. If the line item is of type LineItemType.NETWORK or LineItemType.HOUSE, it represents the percentage of remaining impressions reserved.
     *
     * If this is a secondary goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see LineItem.secondaryGoals.
     */
    units: number;
};
export {};
//# sourceMappingURL=general.type.d.ts.map