googleapis.deno.dev/v1/dfareporting:v4.ts – Ad

import type { Ad } from "https://googleapis.deno.dev/v1/dfareporting:v4.ts";

Contains properties of a Campaign Manager ad.

interface Ad {

accountId?: bigint;

active?: boolean;

advertiserId?: bigint;

advertiserIdDimensionValue?: DimensionValue;

archived?: boolean;

audienceSegmentId?: bigint;

campaignId?: bigint;

campaignIdDimensionValue?: DimensionValue;

clickThroughUrl?: ClickThroughUrl;

clickThroughUrlSuffixProperties?: ClickThroughUrlSuffixProperties;

comments?: string;

compatibility?:

| "DISPLAY"

| "DISPLAY_INTERSTITIAL"

| "APP"

| "APP_INTERSTITIAL"

| "IN_STREAM_VIDEO"

| "IN_STREAM_AUDIO";

createInfo?: LastModifiedInfo;

creativeGroupAssignments?: CreativeGroupAssignment[];

creativeRotation?: CreativeRotation;

dayPartTargeting?: DayPartTargeting;

defaultClickThroughEventTagProperties?: DefaultClickThroughEventTagProperties;

deliverySchedule?: DeliverySchedule;

dynamicClickTracker?: boolean;

endTime?: Date;

eventTagOverrides?: EventTagOverride[];

geoTargeting?: GeoTargeting;

id?: bigint;

idDimensionValue?: DimensionValue;

keyValueTargetingExpression?: KeyValueTargetingExpression;

kind?: string;

languageTargeting?: LanguageTargeting;

lastModifiedInfo?: LastModifiedInfo;

name?: string;

placementAssignments?: PlacementAssignment[];

remarketingListExpression?: ListTargetingExpression;

size?: Size;

sslCompliant?: boolean;

sslRequired?: boolean;

startTime?: Date;

subaccountId?: bigint;

targetingTemplateId?: bigint;

technologyTargeting?: TechnologyTargeting;

type?:

| "AD_SERVING_STANDARD_AD"

| "AD_SERVING_DEFAULT_AD"

| "AD_SERVING_CLICK_TRACKER"

| "AD_SERVING_TRACKING"

| "AD_SERVING_BRAND_SAFE_AD";

}

§Properties

accountId?: bigint

[src]

Account ID of this ad. This is a read-only field that can be left blank.

active?: boolean

[src]

Whether this ad is active. When true, archived must be false.

advertiserId?: bigint

[src]

Advertiser ID of this ad. This is a required field on insertion.

advertiserIdDimensionValue?: DimensionValue

[src]

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

archived?: boolean

[src]

Whether this ad is archived. When true, active must be false.

audienceSegmentId?: bigint

[src]

Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.

campaignId?: bigint

[src]

Campaign ID of this ad. This is a required field on insertion.

campaignIdDimensionValue?: DimensionValue

[src]

Dimension value for the ID of the campaign. This is a read-only, auto-generated field.

clickThroughUrl?: ClickThroughUrl

[src]

Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.

clickThroughUrlSuffixProperties?: ClickThroughUrlSuffixProperties

[src]

Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.

comments?: string

[src]

Comments for this ad.

[src]

Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.

createInfo?: LastModifiedInfo

[src]

Information about the creation of this ad. This is a read-only field.

creativeGroupAssignments?: CreativeGroupAssignment[]

[src]

Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.

creativeRotation?: CreativeRotation

[src]

Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment .

dayPartTargeting?: DayPartTargeting

[src]

Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.

defaultClickThroughEventTagProperties?: DefaultClickThroughEventTagProperties

[src]

Default click-through event tag properties for this ad.

deliverySchedule?: DeliverySchedule

[src]

Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.

dynamicClickTracker?: boolean

[src]

Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.

endTime?: Date

[src]

eventTagOverrides?: EventTagOverride[]

[src]

Event tag overrides for this ad.

geoTargeting?: GeoTargeting

[src]

Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.

id?: bigint

[src]

ID of this ad. This is a read-only, auto-generated field.

idDimensionValue?: DimensionValue

[src]

Dimension value for the ID of this ad. This is a read-only, auto-generated field.

keyValueTargetingExpression?: KeyValueTargetingExpression

[src]

Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.

kind?: string

[src]

Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".

languageTargeting?: LanguageTargeting

[src]

Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.

lastModifiedInfo?: LastModifiedInfo

[src]

Information about the most recent modification of this ad. This is a read-only field.

name?: string

[src]

Name of this ad. This is a required field and must be less than 256 characters long.

placementAssignments?: PlacementAssignment[]

[src]

Placement assignments for this ad.

remarketingListExpression?: ListTargetingExpression

[src]

Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.

size?: Size

[src]

Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.

sslCompliant?: boolean

[src]

Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.

sslRequired?: boolean

[src]

Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.

startTime?: Date

[src]

subaccountId?: bigint

[src]

Subaccount ID of this ad. This is a read-only field that can be left blank.

targetingTemplateId?: bigint

[src]

Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.

technologyTargeting?: TechnologyTargeting

[src]

Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.

type?: "AD_SERVING_STANDARD_AD" | "AD_SERVING_DEFAULT_AD" | "AD_SERVING_CLICK_TRACKER" | "AD_SERVING_TRACKING" | "AD_SERVING_BRAND_SAFE_AD"

[src]

Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).