GoogleAdsSearchads360V0Resources__Campaign

import type { GoogleAdsSearchads360V0Resources__Campaign } from "https://googleapis.deno.dev/v1/searchads360:v0.ts";

A campaign.

interface GoogleAdsSearchads360V0Resources__Campaign {

readonly accessibleBiddingStrategy?: string;

adServingOptimizationStatus?:

| "UNSPECIFIED"

| "UNKNOWN"

| "OPTIMIZE"

| "CONVERSION_OPTIMIZE"

| "ROTATE"

| "ROTATE_INDEFINITELY"

| "UNAVAILABLE";

advertisingChannelSubType?:

| "UNSPECIFIED"

| "UNKNOWN"

| "SEARCH_MOBILE_APP"

| "DISPLAY_MOBILE_APP"

| "SEARCH_EXPRESS"

| "DISPLAY_EXPRESS"

| "SHOPPING_SMART_ADS"

| "DISPLAY_GMAIL_AD"

| "DISPLAY_SMART_CAMPAIGN"

| "VIDEO_OUTSTREAM"

| "VIDEO_ACTION"

| "VIDEO_NON_SKIPPABLE"

| "APP_CAMPAIGN"

| "APP_CAMPAIGN_FOR_ENGAGEMENT"

| "LOCAL_CAMPAIGN"

| "SHOPPING_COMPARISON_LISTING_ADS"

| "SMART_CAMPAIGN"

| "VIDEO_SEQUENCE"

| "APP_CAMPAIGN_FOR_PRE_REGISTRATION"

| "VIDEO_REACH_TARGET_FREQUENCY"

| "TRAVEL_ACTIVITIES";

advertisingChannelType?:

| "UNSPECIFIED"

| "UNKNOWN"

| "SEARCH"

| "DISPLAY"

| "SHOPPING"

| "HOTEL"

| "VIDEO"

| "MULTI_CHANNEL"

| "LOCAL"

| "SMART"

| "PERFORMANCE_MAX"

| "LOCAL_SERVICES"

| "DISCOVERY"

| "TRAVEL";

biddingStrategy?: string;

readonly biddingStrategySystemStatus?:

| "UNSPECIFIED"

| "UNKNOWN"

| "ENABLED"

| "LEARNING_NEW"

| "LEARNING_SETTING_CHANGE"

| "LEARNING_BUDGET_CHANGE"

| "LEARNING_COMPOSITION_CHANGE"

| "LEARNING_CONVERSION_TYPE_CHANGE"

| "LEARNING_CONVERSION_SETTING_CHANGE"

| "LIMITED_BY_CPC_BID_CEILING"

| "LIMITED_BY_CPC_BID_FLOOR"

| "LIMITED_BY_DATA"

| "LIMITED_BY_BUDGET"

| "LIMITED_BY_LOW_PRIORITY_SPEND"

| "LIMITED_BY_LOW_QUALITY"

| "LIMITED_BY_INVENTORY"

| "MISCONFIGURED_ZERO_ELIGIBILITY"

| "MISCONFIGURED_CONVERSION_TYPES"

| "MISCONFIGURED_CONVERSION_SETTINGS"

| "MISCONFIGURED_SHARED_BUDGET"

| "MISCONFIGURED_STRATEGY_TYPE"

| "PAUSED"

| "UNAVAILABLE"

| "MULTIPLE_LEARNING"

| "MULTIPLE_LIMITED"

| "MULTIPLE_MISCONFIGURED"

| "MULTIPLE";

readonly biddingStrategyType?:

| "UNSPECIFIED"

| "UNKNOWN"

| "COMMISSION"

| "ENHANCED_CPC"

| "INVALID"

| "MANUAL_CPA"

| "MANUAL_CPC"

| "MANUAL_CPM"

| "MANUAL_CPV"

| "MAXIMIZE_CONVERSIONS"

| "MAXIMIZE_CONVERSION_VALUE"

| "PAGE_ONE_PROMOTED"

| "PERCENT_CPC"

| "TARGET_CPA"

| "TARGET_CPM"

| "TARGET_IMPRESSION_SHARE"

| "TARGET_OUTRANK_SHARE"

| "TARGET_ROAS"

| "TARGET_SPEND";

campaignBudget?: string;

readonly createTime?: string;

readonly creationTime?: string;

dynamicSearchAdsSetting?: GoogleAdsSearchads360V0Resources_Campaign_DynamicSearchAdsSetting;

endDate?: string;

readonly engineId?: string;

excludedParentAssetFieldTypes?:

| "UNSPECIFIED"

| "UNKNOWN"

| "HEADLINE"

| "DESCRIPTION"

| "MANDATORY_AD_TEXT"

| "MARKETING_IMAGE"

| "MEDIA_BUNDLE"

| "YOUTUBE_VIDEO"

| "BOOK_ON_GOOGLE"

| "LEAD_FORM"

| "PROMOTION"

| "CALLOUT"

| "STRUCTURED_SNIPPET"

| "SITELINK"

| "MOBILE_APP"

| "HOTEL_CALLOUT"

| "CALL"

| "PRICE"

| "LONG_HEADLINE"

| "BUSINESS_NAME"

| "SQUARE_MARKETING_IMAGE"

| "PORTRAIT_MARKETING_IMAGE"

| "LOGO"

| "LANDSCAPE_LOGO"

| "VIDEO"

| "CALL_TO_ACTION_SELECTION"

| "AD_IMAGE"

| "BUSINESS_LOGO"

| "HOTEL_PROPERTY"

| "DISCOVERY_CAROUSEL_CARD"[];

finalUrlSuffix?: string;

frequencyCaps?: GoogleAdsSearchads360V0Common__FrequencyCapEntry[];

geoTargetTypeSetting?: GoogleAdsSearchads360V0Resources_Campaign_GeoTargetTypeSetting;

readonly id?: bigint;

readonly labels?: string[];

readonly lastModifiedTime?: string;

manualCpa?: GoogleAdsSearchads360V0Common__ManualCpa;

manualCpc?: GoogleAdsSearchads360V0Common__ManualCpc;

manualCpm?: GoogleAdsSearchads360V0Common__ManualCpm;

maximizeConversions?: GoogleAdsSearchads360V0Common__MaximizeConversions;

maximizeConversionValue?: GoogleAdsSearchads360V0Common__MaximizeConversionValue;

name?: string;

networkSettings?: GoogleAdsSearchads360V0Resources_Campaign_NetworkSettings;

optimizationGoalSetting?: GoogleAdsSearchads360V0Resources_Campaign_OptimizationGoalSetting;

percentCpc?: GoogleAdsSearchads360V0Common__PercentCpc;

realTimeBiddingSetting?: GoogleAdsSearchads360V0Common__RealTimeBiddingSetting;

resourceName?: string;

selectiveOptimization?: GoogleAdsSearchads360V0Resources_Campaign_SelectiveOptimization;

readonly servingStatus?:

| "UNSPECIFIED"

| "UNKNOWN"

| "SERVING"

| "NONE"

| "ENDED"

| "PENDING"

| "SUSPENDED";

shoppingSetting?: GoogleAdsSearchads360V0Resources_Campaign_ShoppingSetting;

startDate?: string;

status?:

| "UNSPECIFIED"

| "UNKNOWN"

| "ENABLED"

| "PAUSED"

| "REMOVED";

targetCpa?: GoogleAdsSearchads360V0Common__TargetCpa;

targetCpm?: GoogleAdsSearchads360V0Common__TargetCpm;

targetImpressionShare?: GoogleAdsSearchads360V0Common__TargetImpressionShare;

targetRoas?: GoogleAdsSearchads360V0Common__TargetRoas;

targetSpend?: GoogleAdsSearchads360V0Common__TargetSpend;

readonly trackingSetting?: GoogleAdsSearchads360V0Resources_Campaign_TrackingSetting;

trackingUrlTemplate?: string;

urlCustomParameters?: GoogleAdsSearchads360V0Common__CustomParameter[];

urlExpansionOptOut?: boolean;

}

§Properties

readonly accessibleBiddingStrategy?: string

[src]

Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource.

[src]

The ad serving optimization status of the campaign.

[src]

Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed.

[src]

Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed.

biddingStrategy?: string

[src]

Portfolio bidding strategy used by campaign.

[src]

Output only. The system status of the campaign's bidding strategy.

[src]

Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only.

campaignBudget?: string

[src]

The budget of the campaign.

readonly createTime?: string

[src]

Output only. The timestamp when this campaign was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. create_time will be deprecated in v1. Use creation_time instead.

readonly creationTime?: string

[src]

Output only. The timestamp when this campaign was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.

dynamicSearchAdsSetting?: GoogleAdsSearchads360V0Resources_Campaign_DynamicSearchAdsSetting

[src]

The setting for controlling Dynamic Search Ads (DSA).

endDate?: string

[src]

The last day of the campaign in serving customer's timezone in YYYY-MM-DD format. On create, defaults to 2037-12-30, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 2037-12-30.

readonly engineId?: string

[src]

Output only. ID of the campaign in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "campaign.id" instead.

[src]

The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level.

finalUrlSuffix?: string

[src]

Suffix used to append query parameters to landing pages that are served with parallel tracking.

frequencyCaps?: GoogleAdsSearchads360V0Common__FrequencyCapEntry[]

[src]

A list that limits how often each user will see this campaign's ads.

geoTargetTypeSetting?: GoogleAdsSearchads360V0Resources_Campaign_GeoTargetTypeSetting

[src]

The setting for ads geotargeting.

readonly id?: bigint

[src]

Output only. The ID of the campaign.

readonly labels?: string[]

[src]

Output only. The resource names of labels attached to this campaign.

readonly lastModifiedTime?: string

[src]

Output only. The datetime when this campaign was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.

manualCpa?: GoogleAdsSearchads360V0Common__ManualCpa

[src]

Standard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.

manualCpc?: GoogleAdsSearchads360V0Common__ManualCpc

[src]

Standard Manual CPC bidding strategy. Manual click-based bidding where user pays per click.

manualCpm?: GoogleAdsSearchads360V0Common__ManualCpm

[src]

Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.

maximizeConversions?: GoogleAdsSearchads360V0Common__MaximizeConversions

[src]

Standard Maximize Conversions bidding strategy that automatically maximizes number of conversions while spending your budget.

maximizeConversionValue?: GoogleAdsSearchads360V0Common__MaximizeConversionValue

[src]

Standard Maximize Conversion Value bidding strategy that automatically sets bids to maximize revenue while spending your budget.

name?: string

[src]

The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.

networkSettings?: GoogleAdsSearchads360V0Resources_Campaign_NetworkSettings

[src]

The network settings for the campaign.

optimizationGoalSetting?: GoogleAdsSearchads360V0Resources_Campaign_OptimizationGoalSetting

[src]

Optimization goal setting for this campaign, which includes a set of optimization goal types.

percentCpc?: GoogleAdsSearchads360V0Common__PercentCpc

[src]

Standard Percent Cpc bidding strategy where bids are a fraction of the advertised price for some good or service.

realTimeBiddingSetting?: GoogleAdsSearchads360V0Common__RealTimeBiddingSetting

[src]

Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.

resourceName?: string

[src]

Immutable. The resource name of the campaign. Campaign resource names have the form: customers/{customer_id}/campaigns/{campaign_id}

selectiveOptimization?: GoogleAdsSearchads360V0Resources_Campaign_SelectiveOptimization

[src]

Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards. This feature only applies to app campaigns that use MULTI_CHANNEL as AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as AdvertisingChannelSubType.

[src]

Output only. The ad serving status of the campaign.

shoppingSetting?: GoogleAdsSearchads360V0Resources_Campaign_ShoppingSetting

[src]

The setting for controlling Shopping campaigns.

startDate?: string

[src]

The date when campaign started in serving customer's timezone in YYYY-MM-DD format.

status?: "UNSPECIFIED" | "UNKNOWN" | "ENABLED" | "PAUSED" | "REMOVED"

[src]

The status of the campaign. When a new campaign is added, the status defaults to ENABLED.

targetCpa?: GoogleAdsSearchads360V0Common__TargetCpa

[src]

Standard Target CPA bidding strategy that automatically sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.

targetCpm?: GoogleAdsSearchads360V0Common__TargetCpm

[src]

A bidding strategy that automatically optimizes cost per thousand impressions.

targetImpressionShare?: GoogleAdsSearchads360V0Common__TargetImpressionShare

[src]

Target Impression Share bidding strategy. An automated bidding strategy that sets bids to achieve a chosen percentage of impressions.

targetRoas?: GoogleAdsSearchads360V0Common__TargetRoas

[src]

Standard Target ROAS bidding strategy that automatically maximizes revenue while averaging a specific target return on ad spend (ROAS).

targetSpend?: GoogleAdsSearchads360V0Common__TargetSpend

[src]

Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget.

readonly trackingSetting?: GoogleAdsSearchads360V0Resources_Campaign_TrackingSetting

[src]

Output only. Campaign-level settings for tracking information.

trackingUrlTemplate?: string

[src]

The URL template for constructing a tracking URL.

urlCustomParameters?: GoogleAdsSearchads360V0Common__CustomParameter[]

[src]

The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.

urlExpansionOptOut?: boolean

[src]

Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false.