UNPKG

google-ads-node

Version:

Google Ads gRPC Client Library for Node

1,660 lines 173 kB
export interface AdTextAsset { text?: string; pinned_field?: ServedAssetFieldType; } export interface AdImageAsset { asset?: string; } export interface AdVideoAsset { asset?: string; } export interface AdMediaBundleAsset { asset?: string; } export interface TextAdInfo { headline?: string; description1?: string; description2?: string; } export interface ExpandedTextAdInfo { headline_part1?: string; headline_part2?: string; headline_part3?: string; description?: string; description2?: string; path1?: string; path2?: string; } export interface CallOnlyAdInfo { country_code?: string; phone_number?: string; business_name?: string; headline1?: string; headline2?: string; description1?: string; description2?: string; call_tracked?: boolean; disable_call_conversion?: boolean; phone_number_verification_url?: string; conversion_action?: string; conversion_reporting_state?: CallConversionReportingState; } export interface ExpandedDynamicSearchAdInfo { description?: string; } export interface HotelAdInfo { } export interface ShoppingSmartAdInfo { } export interface ShoppingProductAdInfo { } export interface ShoppingComparisonListingAdInfo { headline?: string; } export interface GmailAdInfo { teaser?: GmailTeaser; header_image?: string; marketing_image?: string; marketing_image_headline?: string; marketing_image_description?: string; marketing_image_display_call_to_action?: DisplayCallToAction; product_images?: ProductImage[]; product_videos?: ProductVideo[]; } export interface GmailTeaser { headline?: string; description?: string; business_name?: string; logo_image?: string; } export interface DisplayCallToAction { text?: string; text_color?: string; url_collection_id?: string; } export interface ProductImage { product_image?: string; description?: string; display_call_to_action?: DisplayCallToAction; } export interface ProductVideo { product_video?: string; } export interface ImageAdInfo { pixel_width?: number; pixel_height?: number; image_url?: string; preview_pixel_width?: number; preview_pixel_height?: number; preview_image_url?: string; mime_type?: MimeType; name?: string; media_file?: string; data?: string; ad_id_to_copy_image_from?: number; } export interface VideoBumperInStreamAdInfo { companion_banner?: string; } export interface VideoNonSkippableInStreamAdInfo { companion_banner?: string; } export interface VideoTrueViewInStreamAdInfo { action_button_label?: string; action_headline?: string; companion_banner?: string; } export interface VideoOutstreamAdInfo { headline?: string; description?: string; } export interface VideoAdInfo { media_file?: string; in_stream?: VideoTrueViewInStreamAdInfo; bumper?: VideoBumperInStreamAdInfo; out_stream?: VideoOutstreamAdInfo; non_skippable?: VideoNonSkippableInStreamAdInfo; } export interface ResponsiveSearchAdInfo { headlines?: AdTextAsset[]; descriptions?: AdTextAsset[]; path1?: string; path2?: string; } export interface LegacyResponsiveDisplayAdInfo { short_headline?: string; long_headline?: string; description?: string; business_name?: string; allow_flexible_color?: boolean; accent_color?: string; main_color?: string; call_to_action_text?: string; logo_image?: string; square_logo_image?: string; marketing_image?: string; square_marketing_image?: string; format_setting?: DisplayAdFormatSetting; price_prefix?: string; promo_text?: string; } export interface AppAdInfo { mandatory_ad_text?: AdTextAsset; headlines?: AdTextAsset[]; descriptions?: AdTextAsset[]; images?: AdImageAsset[]; youtube_videos?: AdVideoAsset[]; html_5_media_bundles?: AdMediaBundleAsset[]; } export interface AppEngagementAdInfo { headlines?: AdTextAsset[]; descriptions?: AdTextAsset[]; images?: AdImageAsset[]; videos?: AdVideoAsset[]; } export interface LegacyAppInstallAdInfo { app_id?: string; app_store?: LegacyAppInstallAdAppStore; headline?: string; description1?: string; description2?: string; } export interface ResponsiveDisplayAdInfo { marketing_images?: AdImageAsset[]; square_marketing_images?: AdImageAsset[]; logo_images?: AdImageAsset[]; square_logo_images?: AdImageAsset[]; headlines?: AdTextAsset[]; long_headline?: AdTextAsset; descriptions?: AdTextAsset[]; youtube_videos?: AdVideoAsset[]; business_name?: string; main_color?: string; accent_color?: string; allow_flexible_color?: boolean; call_to_action_text?: string; price_prefix?: string; promo_text?: string; format_setting?: DisplayAdFormatSetting; } export interface DisplayUploadAdInfo { display_upload_product_type?: DisplayUploadProductType; media_bundle?: AdMediaBundleAsset; } export interface YoutubeVideoAsset { youtube_video_id?: string; } export interface MediaBundleAsset { data?: string; } export interface ImageAsset { data?: string; file_size?: number; mime_type?: MimeType; full_size?: ImageDimension; } export interface ImageDimension { height_pixels?: number; width_pixels?: number; url?: string; } export interface TextAsset { text?: string; } export interface Commission { commission_rate_micros?: number; } export interface EnhancedCpc { } export interface ManualCpc { enhanced_cpc_enabled?: boolean; } export interface ManualCpm { } export interface ManualCpv { } export interface MaximizeConversions { } export interface MaximizeConversionValue { target_roas?: number; } export interface PageOnePromoted { strategy_goal?: PageOnePromotedStrategyGoal; cpc_bid_ceiling_micros?: number; bid_modifier?: number; only_raise_cpc_bids?: boolean; raise_cpc_bid_when_budget_constrained?: boolean; raise_cpc_bid_when_quality_score_is_low?: boolean; } export interface TargetCpa { target_cpa_micros?: number; cpc_bid_ceiling_micros?: number; cpc_bid_floor_micros?: number; } export interface TargetCpm { } export interface TargetImpressionShare { location?: TargetImpressionShareLocation; location_fraction_micros?: number; cpc_bid_ceiling_micros?: number; } export interface TargetOutrankShare { target_outrank_share_micros?: number; competitor_domain?: string; cpc_bid_ceiling_micros?: number; only_raise_cpc_bids?: boolean; raise_cpc_bid_when_quality_score_is_low?: boolean; } export interface TargetRoas { target_roas?: number; cpc_bid_ceiling_micros?: number; cpc_bid_floor_micros?: number; } export interface TargetSpend { target_spend_micros?: number; cpc_bid_ceiling_micros?: number; } export interface PercentCpc { cpc_bid_ceiling_micros?: number; enhanced_cpc_enabled?: boolean; } export interface ClickLocation { city?: string; country?: string; metro?: string; most_specific?: string; region?: string; } export interface KeywordInfo { text?: string; match_type?: KeywordMatchType; } export interface PlacementInfo { url?: string; } export interface MobileAppCategoryInfo { mobile_app_category_constant?: string; } export interface MobileApplicationInfo { app_id?: string; name?: string; } export interface LocationInfo { geo_target_constant?: string; } export interface DeviceInfo { type?: Device; } export interface PreferredContentInfo { type?: PreferredContentType; } export interface ListingGroupInfo { type?: ListingGroupType; case_value?: ListingDimensionInfo; parent_ad_group_criterion?: string; } export interface ListingScopeInfo { dimensions?: ListingDimensionInfo[]; } export interface ListingDimensionInfo { listing_brand?: ListingBrandInfo; hotel_id?: HotelIdInfo; hotel_class?: HotelClassInfo; hotel_country_region?: HotelCountryRegionInfo; hotel_state?: HotelStateInfo; hotel_city?: HotelCityInfo; listing_custom_attribute?: ListingCustomAttributeInfo; product_bidding_category?: ProductBiddingCategoryInfo; product_channel?: ProductChannelInfo; product_channel_exclusivity?: ProductChannelExclusivityInfo; product_condition?: ProductConditionInfo; product_item_id?: ProductItemIdInfo; product_type?: ProductTypeInfo; unknown_listing_dimension?: UnknownListingDimensionInfo; } export interface ListingBrandInfo { value?: string; } export interface HotelIdInfo { value?: string; } export interface HotelClassInfo { value?: number; } export interface HotelCountryRegionInfo { country_region_criterion?: string; } export interface HotelStateInfo { state_criterion?: string; } export interface HotelCityInfo { city_criterion?: string; } export interface ListingCustomAttributeInfo { value?: string; index?: ListingCustomAttributeIndex; } export interface ProductBiddingCategoryInfo { id?: number; country_code?: string; level?: ProductBiddingCategoryLevel; } export interface ProductChannelInfo { channel?: ProductChannel; } export interface ProductChannelExclusivityInfo { channel_exclusivity?: ProductChannelExclusivity; } export interface ProductConditionInfo { condition?: ProductCondition; } export interface ProductItemIdInfo { value?: string; } export interface ProductTypeInfo { value?: string; level?: ProductTypeLevel; } export interface UnknownListingDimensionInfo { } export interface HotelDateSelectionTypeInfo { type?: HotelDateSelectionType; } export interface HotelAdvanceBookingWindowInfo { min_days?: number; max_days?: number; } export interface HotelLengthOfStayInfo { min_nights?: number; max_nights?: number; } export interface HotelCheckInDayInfo { day_of_week?: DayOfWeek; } export interface InteractionTypeInfo { type?: InteractionType; } export interface AdScheduleInfo { start_minute?: MinuteOfHour; end_minute?: MinuteOfHour; start_hour?: number; end_hour?: number; day_of_week?: DayOfWeek; } export interface AgeRangeInfo { type?: AgeRangeType; } export interface GenderInfo { type?: GenderType; } export interface IncomeRangeInfo { type?: IncomeRangeType; } export interface ParentalStatusInfo { type?: ParentalStatusType; } export interface YouTubeVideoInfo { video_id?: string; } export interface YouTubeChannelInfo { channel_id?: string; } export interface UserListInfo { user_list?: string; } export interface ProximityInfo { geo_point?: GeoPointInfo; radius?: number; radius_units?: ProximityRadiusUnits; address?: AddressInfo; } export interface GeoPointInfo { longitude_in_micro_degrees?: number; latitude_in_micro_degrees?: number; } export interface AddressInfo { postal_code?: string; province_code?: string; country_code?: string; province_name?: string; street_address?: string; street_address2?: string; city_name?: string; } export interface TopicInfo { topic_constant?: string; path?: string[]; } export interface LanguageInfo { language_constant?: string; } export interface IpBlockInfo { ip_address?: string; } export interface ContentLabelInfo { type?: ContentLabelType; } export interface CarrierInfo { carrier_constant?: string; } export interface UserInterestInfo { user_interest_category?: string; } export interface WebpageInfo { criterion_name?: string; conditions?: WebpageConditionInfo[]; } export interface WebpageConditionInfo { operand?: WebpageConditionOperand; operator?: WebpageConditionOperator; argument?: string; } export interface OperatingSystemVersionInfo { operating_system_version_constant?: string; } export interface AppPaymentModelInfo { type?: AppPaymentModelType; } export interface MobileDeviceInfo { mobile_device_constant?: string; } export interface CustomAffinityInfo { custom_affinity?: string; } export interface CustomIntentInfo { custom_intent?: string; } export interface LocationGroupInfo { feed?: string; geo_target_constants?: string[]; radius?: number; radius_units?: LocationGroupRadiusUnits; } export interface CriterionCategoryAvailability { channel?: CriterionCategoryChannelAvailability; locale?: CriterionCategoryLocaleAvailability[]; } export interface CriterionCategoryChannelAvailability { availability_mode?: CriterionCategoryChannelAvailabilityMode; advertising_channel_type?: AdvertisingChannelType; advertising_channel_sub_type?: AdvertisingChannelSubType[]; include_default_channel_sub_type?: boolean; } export interface CriterionCategoryLocaleAvailability { availability_mode?: CriterionCategoryLocaleAvailabilityMode; country_code?: string; language_code?: string; } export interface CustomParameter { key?: string; value?: string; } export interface DateRange { start_date?: string; end_date?: string; } export interface ExplorerAutoOptimizerSetting { opt_in?: boolean; } export interface AppFeedItem { link_text?: string; app_id?: string; app_store?: AppStore; final_urls?: string[]; final_mobile_urls?: string[]; tracking_url_template?: string; url_custom_parameters?: CustomParameter[]; final_url_suffix?: string; } export interface CallFeedItem { phone_number?: string; country_code?: string; call_tracking_enabled?: boolean; call_conversion_action?: string; call_conversion_tracking_disabled?: boolean; call_conversion_reporting_state?: CallConversionReportingState; } export interface CalloutFeedItem { callout_text?: string; } export interface LocationFeedItem { business_name?: string; address_line1?: string; address_line2?: string; city?: string; province?: string; postal_code?: string; country_code?: string; phone_number?: string; } export interface AffiliateLocationFeedItem { business_name?: string; address_line1?: string; address_line2?: string; city?: string; province?: string; postal_code?: string; country_code?: string; phone_number?: string; chain_id?: number; chain_name?: string; } export interface TextMessageFeedItem { business_name?: string; country_code?: string; phone_number?: string; text?: string; extension_text?: string; } export interface PriceFeedItem { type?: PriceExtensionType; price_qualifier?: PriceExtensionPriceQualifier; tracking_url_template?: string; language_code?: string; price_offerings?: PriceOffer[]; final_url_suffix?: string; } export interface PriceOffer { header?: string; description?: string; price?: Money; unit?: PriceExtensionPriceUnit; final_urls?: string[]; final_mobile_urls?: string[]; } export interface PromotionFeedItem { promotion_target?: string; discount_modifier?: PromotionExtensionDiscountModifier; promotion_start_date?: string; promotion_end_date?: string; occasion?: PromotionExtensionOccasion; final_urls?: string[]; final_mobile_urls?: string[]; tracking_url_template?: string; url_custom_parameters?: CustomParameter[]; final_url_suffix?: string; language_code?: string; percent_off?: number; money_amount_off?: Money; promotion_code?: string; orders_over_amount?: Money; } export interface StructuredSnippetFeedItem { header?: string; values?: string[]; } export interface SitelinkFeedItem { link_text?: string; line1?: string; line2?: string; final_urls?: string[]; final_mobile_urls?: string[]; tracking_url_template?: string; url_custom_parameters?: CustomParameter[]; final_url_suffix?: string; } export interface Money { currency_code?: string; amount_micros?: number; } export interface FinalAppUrl { os_type?: AppUrlOperatingSystemType; url?: string; } export interface FrequencyCapEntry { key?: FrequencyCapKey; cap?: number; } export interface FrequencyCapKey { level?: FrequencyCapLevel; event_type?: FrequencyCapEventType; time_unit?: FrequencyCapTimeUnit; time_length?: number; } export interface KeywordPlanHistoricalMetrics { avg_monthly_searches?: number; competition?: KeywordPlanCompetitionLevel; } export interface MatchingFunction { function_string?: string; operator?: MatchingFunctionOperator; left_operands?: Operand[]; right_operands?: Operand[]; } export interface ConstantOperand { string_value?: string; long_value?: number; boolean_value?: boolean; double_value?: number; } export interface FeedAttributeOperand { feed_id?: number; feed_attribute_id?: number; } export interface FunctionOperand { matching_function?: MatchingFunction; } export interface RequestContextOperand { context_type?: MatchingFunctionContextType; } export interface Operand { constant_operand?: ConstantOperand; feed_attribute_operand?: FeedAttributeOperand; function_operand?: FunctionOperand; request_context_operand?: RequestContextOperand; } export interface Metrics { absolute_top_impression_percentage?: number; active_view_cpm?: number; active_view_ctr?: number; active_view_impressions?: number; active_view_measurability?: number; active_view_measurable_cost_micros?: number; active_view_measurable_impressions?: number; active_view_viewability?: number; all_conversions_from_interactions_rate?: number; all_conversions_value?: number; all_conversions?: number; all_conversions_value_per_cost?: number; all_conversions_from_click_to_call?: number; all_conversions_from_directions?: number; all_conversions_from_interactions_value_per_interaction?: number; all_conversions_from_menu?: number; all_conversions_from_order?: number; all_conversions_from_other_engagement?: number; all_conversions_from_store_visit?: number; all_conversions_from_store_website?: number; average_cost?: number; average_cpc?: number; average_cpe?: number; average_cpm?: number; average_cpv?: number; average_page_views?: number; average_time_on_site?: number; benchmark_average_max_cpc?: number; benchmark_ctr?: number; bounce_rate?: number; clicks?: number; combined_clicks?: number; combined_clicks_per_query?: number; combined_queries?: number; content_budget_lost_impression_share?: number; content_impression_share?: number; conversion_last_received_request_date_time?: string; conversion_last_conversion_date?: string; content_rank_lost_impression_share?: number; conversions_from_interactions_rate?: number; conversions_value?: number; conversions_value_per_cost?: number; conversions_from_interactions_value_per_interaction?: number; conversions?: number; cost_micros?: number; cost_per_all_conversions?: number; cost_per_conversion?: number; cost_per_current_model_attributed_conversion?: number; cross_device_conversions?: number; ctr?: number; current_model_attributed_conversions?: number; current_model_attributed_conversions_from_interactions_rate?: number; current_model_attributed_conversions_from_interactions_value_per_interaction?: number; current_model_attributed_conversions_value?: number; current_model_attributed_conversions_value_per_cost?: number; engagement_rate?: number; engagements?: number; hotel_average_lead_value_micros?: number; historical_creative_quality_score?: QualityScoreBucket; historical_landing_page_quality_score?: QualityScoreBucket; historical_quality_score?: number; historical_search_predicted_ctr?: QualityScoreBucket; gmail_forwards?: number; gmail_saves?: number; gmail_secondary_clicks?: number; impressions_from_store_reach?: number; impressions?: number; interaction_rate?: number; interactions?: number; interaction_event_types?: InteractionEventType[]; invalid_click_rate?: number; invalid_clicks?: number; message_chats?: number; message_impressions?: number; message_chat_rate?: number; mobile_friendly_clicks_percentage?: number; organic_clicks?: number; organic_clicks_per_query?: number; organic_impressions?: number; organic_impressions_per_query?: number; organic_queries?: number; percent_new_visitors?: number; phone_calls?: number; phone_impressions?: number; phone_through_rate?: number; relative_ctr?: number; search_absolute_top_impression_share?: number; search_budget_lost_absolute_top_impression_share?: number; search_budget_lost_impression_share?: number; search_budget_lost_top_impression_share?: number; search_click_share?: number; search_exact_match_impression_share?: number; search_impression_share?: number; search_rank_lost_absolute_top_impression_share?: number; search_rank_lost_impression_share?: number; search_rank_lost_top_impression_share?: number; search_top_impression_share?: number; speed_score?: number; top_impression_percentage?: number; valid_accelerated_mobile_pages_clicks_percentage?: number; value_per_all_conversions?: number; value_per_conversion?: number; value_per_current_model_attributed_conversion?: number; video_quartile_100_rate?: number; video_quartile_25_rate?: number; video_quartile_50_rate?: number; video_quartile_75_rate?: number; video_view_rate?: number; video_views?: number; view_through_conversions?: number; } export interface PolicyViolationKey { policy_name?: string; violating_text?: string; } export interface PolicyValidationParameter { ignorable_policy_topics?: string[]; exempt_policy_violation_keys?: PolicyViolationKey[]; } export interface PolicyTopicEntry { topic?: string; type?: PolicyTopicEntryType; evidences?: PolicyTopicEvidence[]; constraints?: PolicyTopicConstraint[]; } export declare type PolicyTopicEvidence = { website_list?: { websites?: string[]; }; } | { text_list?: { texts?: string[]; }; } | { language_code?: string; } | { destination_text_list?: { destination_texts?: string[]; }; } | { destination_mismatch?: { url_types?: PolicyTopicEvidenceDestinationMismatchUrlType[]; }; } | { destination_not_working?: { expanded_url?: string; device?: PolicyTopicEvidenceDestinationNotWorkingDevice; last_checked_date_time?: string; dns_error_type?: PolicyTopicEvidenceDestinationNotWorkingDnsErrorType; http_error_code?: number; }; }; export declare type PolicyTopicConstraint = { country_constraint_list?: { total_targeted_countries?: number; countries?: { country_criterion?: string; }[]; }; } | { reseller_constraint?: {}; } | { certificate_missing_in_country_list?: { total_targeted_countries?: number; countries?: { country_criterion?: string; }[]; }; } | { certificate_domain_mismatch_in_country_list?: { total_targeted_countries?: number; countries?: { country_criterion?: string; }[]; }; }; export interface RealTimeBiddingSetting { opt_in?: boolean; } export interface Segments { ad_network_type?: AdNetworkType; click_type?: ClickType; conversion_action?: string; conversion_action_category?: ConversionActionCategory; conversion_action_name?: string; conversion_adjustment?: boolean; conversion_attribution_event_type?: ConversionAttributionEventType; conversion_lag_bucket?: ConversionLagBucket; conversion_or_adjustment_lag_bucket?: ConversionOrAdjustmentLagBucket; date?: string; day_of_week?: DayOfWeek; device?: Device; external_conversion_source?: ExternalConversionSource; geo_target_airport?: string; geo_target_canton?: string; geo_target_city?: string; geo_target_country?: string; geo_target_county?: string; geo_target_district?: string; geo_target_metro?: string; geo_target_most_specific_location?: string; geo_target_postal_code?: string; geo_target_province?: string; geo_target_region?: string; geo_target_state?: string; hotel_booking_window_days?: number; hotel_center_id?: number; hotel_check_in_date?: string; hotel_check_in_day_of_week?: DayOfWeek; hotel_city?: string; hotel_class?: number; hotel_country?: string; hotel_date_selection_type?: HotelDateSelectionType; hotel_length_of_stay?: number; hotel_rate_rule_id?: string; hotel_rate_type?: HotelRateType; hotel_state?: string; hour?: number; interaction_on_this_extension?: boolean; keyword?: Keyword; month?: string; month_of_year?: MonthOfYear; partner_hotel_id?: string; placeholder_type?: PlaceholderType; product_aggregator_id?: number; product_bidding_category_level1?: string; product_bidding_category_level2?: string; product_bidding_category_level3?: string; product_bidding_category_level4?: string; product_bidding_category_level5?: string; product_brand?: string; product_channel?: ProductChannel; product_channel_exclusivity?: ProductChannelExclusivity; product_condition?: ProductCondition; product_country?: string; product_custom_attribute0?: string; product_custom_attribute1?: string; product_custom_attribute2?: string; product_custom_attribute3?: string; product_custom_attribute4?: string; product_item_id?: string; product_language?: string; product_merchant_id?: number; product_store_id?: string; product_title?: string; product_type_l1?: string; product_type_l2?: string; product_type_l3?: string; product_type_l4?: string; product_type_l5?: string; quarter?: string; search_engine_results_page_type?: SearchEngineResultsPageType; search_term_match_type?: SearchTermMatchType; slot?: Slot; webpage?: string; week?: string; year?: number; } export interface Keyword { ad_group_criterion?: string; info?: KeywordInfo; } export interface BidModifierSimulationPointList { points?: BidModifierSimulationPoint[]; } export interface CpcBidSimulationPointList { points?: CpcBidSimulationPoint[]; } export interface CpvBidSimulationPointList { points?: CpvBidSimulationPoint[]; } export interface TargetCpaSimulationPointList { points?: TargetCpaSimulationPoint[]; } export interface BidModifierSimulationPoint { bid_modifier?: number; biddable_conversions?: number; biddable_conversions_value?: number; clicks?: number; cost_micros?: number; impressions?: number; top_slot_impressions?: number; parent_biddable_conversions?: number; parent_biddable_conversions_value?: number; parent_clicks?: number; parent_cost_micros?: number; parent_impressions?: number; parent_top_slot_impressions?: number; parent_required_budget_micros?: number; } export interface CpcBidSimulationPoint { cpc_bid_micros?: number; biddable_conversions?: number; biddable_conversions_value?: number; clicks?: number; cost_micros?: number; impressions?: number; top_slot_impressions?: number; } export interface CpvBidSimulationPoint { cpv_bid_micros?: number; cost_micros?: number; impressions?: number; views?: number; } export interface TargetCpaSimulationPoint { target_cpa_micros?: number; biddable_conversions?: number; biddable_conversions_value?: number; clicks?: number; cost_micros?: number; impressions?: number; top_slot_impressions?: number; } export interface TagSnippet { type?: TrackingCodeType; page_format?: TrackingCodePageFormat; global_site_tag?: string; event_snippet?: string; } export interface TargetingSetting { target_restrictions?: TargetRestriction[]; } export interface TargetRestriction { targeting_dimension?: TargetingDimension; bid_only?: boolean; } export interface TextLabel { background_color?: string; description?: string; } export interface UrlCollection { url_collection_id?: string; final_urls?: string[]; final_mobile_urls?: string[]; tracking_url_template?: string; } export interface SimilarUserListInfo { seed_user_list?: string; } export interface CrmBasedUserListInfo { app_id?: string; upload_key_type?: CustomerMatchUploadKeyType; data_source_type?: UserListCrmDataSourceType; } export interface UserListRuleInfo { rule_type?: UserListRuleType; rule_item_groups?: UserListRuleItemGroupInfo[]; } export interface UserListRuleItemGroupInfo { rule_items?: UserListRuleItemInfo[]; } export interface UserListRuleItemInfo { name?: string; number_rule_item?: UserListNumberRuleItemInfo; string_rule_item?: UserListStringRuleItemInfo; date_rule_item?: UserListDateRuleItemInfo; } export interface UserListDateRuleItemInfo { operator?: UserListDateRuleItemOperator; value?: string; offset_in_days?: number; } export interface UserListNumberRuleItemInfo { operator?: UserListNumberRuleItemOperator; value?: number; } export interface UserListStringRuleItemInfo { operator?: UserListStringRuleItemOperator; value?: string; } export interface CombinedRuleUserListInfo { left_operand?: UserListRuleInfo; right_operand?: UserListRuleInfo; rule_operator?: UserListCombinedRuleOperator; } export interface DateSpecificRuleUserListInfo { rule?: UserListRuleInfo; start_date?: string; end_date?: string; } export interface ExpressionRuleUserListInfo { rule?: UserListRuleInfo; } export interface RuleBasedUserListInfo { prepopulation_status?: UserListPrepopulationStatus; combined_rule_user_list?: CombinedRuleUserListInfo; date_specific_rule_user_list?: DateSpecificRuleUserListInfo; expression_rule_user_list?: ExpressionRuleUserListInfo; } export interface LogicalUserListInfo { rules?: UserListLogicalRuleInfo[]; } export interface UserListLogicalRuleInfo { operator?: UserListLogicalRuleOperator; rule_operands?: LogicalUserListOperandInfo[]; } export interface LogicalUserListOperandInfo { user_list?: string; } export interface BasicUserListInfo { actions?: UserListActionInfo[]; } export interface UserListActionInfo { conversion_action?: string; remarketing_action?: string; } export declare type Value = { boolean_value?: boolean; } | { int_64_value?: number; } | { float_value?: number; } | { double_value?: number; } | { string_value?: string; }; export interface PendingAccountBudgetProposal { account_budget_proposal?: string; proposal_type?: AccountBudgetProposalType; name?: string; start_date_time?: string; purchase_order_number?: string; notes?: string; creation_date_time?: string; end_date_time?: string; end_time_type?: TimeType; spending_limit_micros?: number; spending_limit_type?: SpendingLimitType; } export interface AccountBudget { resource_name?: string; id?: number; billing_setup?: string; status?: AccountBudgetStatus; name?: string; proposed_start_date_time?: string; approved_start_date_time?: string; total_adjustments_micros?: number; amount_served_micros?: number; purchase_order_number?: string; notes?: string; pending_proposal?: PendingAccountBudgetProposal; proposed_end_date_time?: string; proposed_end_time_type?: TimeType; approved_end_date_time?: string; approved_end_time_type?: TimeType; proposed_spending_limit_micros?: number; proposed_spending_limit_type?: SpendingLimitType; approved_spending_limit_micros?: number; approved_spending_limit_type?: SpendingLimitType; adjusted_spending_limit_micros?: number; adjusted_spending_limit_type?: SpendingLimitType; } export interface AccountBudgetProposal { resource_name?: string; id?: number; billing_setup?: string; account_budget?: string; proposal_type?: AccountBudgetProposalType; status?: AccountBudgetProposalStatus; proposed_name?: string; approved_start_date_time?: string; proposed_purchase_order_number?: string; proposed_notes?: string; creation_date_time?: string; approval_date_time?: string; proposed_start_date_time?: string; proposed_start_time_type?: TimeType; proposed_end_date_time?: string; proposed_end_time_type?: TimeType; approved_end_date_time?: string; approved_end_time_type?: TimeType; proposed_spending_limit_micros?: number; proposed_spending_limit_type?: SpendingLimitType; approved_spending_limit_micros?: number; approved_spending_limit_type?: SpendingLimitType; } export interface Ad { resource_name?: string; id?: number; final_urls?: string[]; final_app_urls?: FinalAppUrl[]; final_mobile_urls?: string[]; tracking_url_template?: string; url_custom_parameters?: CustomParameter[]; display_url?: string; type?: AdType; added_by_google_ads?: boolean; device_preference?: Device; url_collections?: UrlCollection[]; name?: string; system_managed_resource_source?: SystemManagedResourceSource; text_ad?: TextAdInfo; expanded_text_ad?: ExpandedTextAdInfo; call_only_ad?: CallOnlyAdInfo; expanded_dynamic_search_ad?: ExpandedDynamicSearchAdInfo; hotel_ad?: HotelAdInfo; shopping_smart_ad?: ShoppingSmartAdInfo; shopping_product_ad?: ShoppingProductAdInfo; gmail_ad?: GmailAdInfo; image_ad?: ImageAdInfo; video_ad?: VideoAdInfo; responsive_search_ad?: ResponsiveSearchAdInfo; legacy_responsive_display_ad?: LegacyResponsiveDisplayAdInfo; app_ad?: AppAdInfo; legacy_app_install_ad?: LegacyAppInstallAdInfo; responsive_display_ad?: ResponsiveDisplayAdInfo; display_upload_ad?: DisplayUploadAdInfo; app_engagement_ad?: AppEngagementAdInfo; shopping_comparison_listing_ad?: ShoppingComparisonListingAdInfo; } export interface AdGroup { resource_name?: string; id?: number; name?: string; status?: AdGroupStatus; type?: AdGroupType; ad_rotation_mode?: AdGroupAdRotationMode; base_ad_group?: string; tracking_url_template?: string; url_custom_parameters?: CustomParameter[]; campaign?: string; cpc_bid_micros?: number; cpm_bid_micros?: number; target_cpa_micros?: number; cpv_bid_micros?: number; target_cpm_micros?: number; target_roas?: number; percent_cpc_bid_micros?: number; explorer_auto_optimizer_setting?: ExplorerAutoOptimizerSetting; display_custom_bid_dimension?: TargetingDimension; final_url_suffix?: string; targeting_setting?: TargetingSetting; effective_target_cpa_micros?: number; effective_target_cpa_source?: BiddingSource; effective_target_roas?: number; effective_target_roas_source?: BiddingSource; labels?: string[]; } export interface AdGroupAd { resource_name?: string; status?: AdGroupAdStatus; ad_group?: string; ad?: Ad; policy_summary?: { policy_topic_entries?: PolicyTopicEntry[]; review_status?: PolicyReviewStatus; approval_status?: PolicyApprovalStatus; }; ad_strength?: AdStrength; } export interface AdGroupAdPolicySummary { policy_topic_entries?: PolicyTopicEntry[]; review_status?: PolicyReviewStatus; approval_status?: PolicyApprovalStatus; } export interface AdGroupAdAssetView { resource_name?: string; ad_group_ad?: string; asset?: string; field_type?: AssetFieldType; policy_summary?: { policy_topic_entries?: PolicyTopicEntry[]; review_status?: PolicyReviewStatus; approval_status?: PolicyApprovalStatus; }; performance_label?: AssetPerformanceLabel; } export interface AdGroupAdAssetPolicySummary { policy_topic_entries?: PolicyTopicEntry[]; review_status?: PolicyReviewStatus; approval_status?: PolicyApprovalStatus; } export interface AdGroupAdLabel { resource_name?: string; ad_group_ad?: string; label?: string; } export interface AdGroupAudienceView { resource_name?: string; } export interface AdGroupBidModifier { resource_name?: string; ad_group?: string; criterion_id?: number; bid_modifier?: number; base_ad_group?: string; bid_modifier_source?: BidModifierSource; hotel_date_selection_type?: HotelDateSelectionTypeInfo; hotel_advance_booking_window?: HotelAdvanceBookingWindowInfo; hotel_length_of_stay?: HotelLengthOfStayInfo; hotel_check_in_day?: HotelCheckInDayInfo; device?: DeviceInfo; preferred_content?: PreferredContentInfo; } export interface QualityInfo { quality_score?: number; creative_quality_score?: QualityScoreBucket; post_click_quality_score?: QualityScoreBucket; search_predicted_ctr?: QualityScoreBucket; } export interface PositionEstimates { first_page_cpc_micros?: number; first_position_cpc_micros?: number; top_of_page_cpc_micros?: number; estimated_add_clicks_at_first_position_cpc?: number; estimated_add_cost_at_first_position_cpc?: number; } export interface AdGroupCriterion { resource_name?: string; criterion_id?: number; status?: AdGroupCriterionStatus; quality_info?: QualityInfo; ad_group?: string; type?: CriterionType; negative?: boolean; system_serving_status?: CriterionSystemServingStatus; approval_status?: AdGroupCriterionApprovalStatus; bid_modifier?: number; cpc_bid_micros?: number; cpm_bid_micros?: number; cpv_bid_micros?: number; percent_cpc_bid_micros?: number; effective_cpc_bid_micros?: number; effective_cpm_bid_micros?: number; effective_cpv_bid_micros?: number; effective_percent_cpc_bid_micros?: number; effective_cpc_bid_source?: BiddingSource; effective_cpm_bid_source?: BiddingSource; effective_cpv_bid_source?: BiddingSource; effective_percent_cpc_bid_source?: BiddingSource; position_estimates?: PositionEstimates; final_urls?: string[]; final_mobile_urls?: string[]; final_url_suffix?: string; tracking_url_template?: string; url_custom_parameters?: CustomParameter[]; keyword?: KeywordInfo; placement?: PlacementInfo; mobile_app_category?: MobileAppCategoryInfo; mobile_application?: MobileApplicationInfo; listing_group?: ListingGroupInfo; age_range?: AgeRangeInfo; gender?: GenderInfo; income_range?: IncomeRangeInfo; parental_status?: ParentalStatusInfo; user_list?: UserListInfo; youtube_video?: YouTubeVideoInfo; youtube_channel?: YouTubeChannelInfo; topic?: TopicInfo; user_interest?: UserInterestInfo; webpage?: WebpageInfo; app_payment_model?: AppPaymentModelInfo; custom_affinity?: CustomAffinityInfo; custom_intent?: CustomIntentInfo; } export interface AdGroupCriterionLabel { resource_name?: string; ad_group_criterion?: string; label?: string; } export interface AdGroupCriterionSimulation { resource_name?: string; ad_group_id?: number; criterion_id?: number; type?: SimulationType; modification_method?: SimulationModificationMethod; start_date?: string; end_date?: string; cpc_bid_point_list?: CpcBidSimulationPointList; } export interface AdGroupExtensionSetting { resource_name?: string; extension_type?: ExtensionType; ad_group?: string; extension_feed_items?: string[]; device?: ExtensionSettingDevice; } export interface AdGroupFeed { resource_name?: string; feed?: string; ad_group?: string; placeholder_types?: PlaceholderType[]; matching_function?: MatchingFunction; status?: FeedLinkStatus; } export interface AdGroupLabel { resource_name?: string; ad_group?: string; label?: string; } export interface AdGroupSimulation { resource_name?: string; ad_group_id?: number; type?: SimulationType; modification_method?: SimulationModificationMethod; start_date?: string; end_date?: string; cpc_bid_point_list?: CpcBidSimulationPointList; cpv_bid_point_list?: CpvBidSimulationPointList; target_cpa_point_list?: TargetCpaSimulationPointList; } export interface AdParameter { resource_name?: string; ad_group_criterion?: string; parameter_index?: number; insertion_text?: string; } export interface AdScheduleView { resource_name?: string; } export interface AgeRangeView { resource_name?: string; } export interface Asset { resource_name?: string; id?: number; name?: string; type?: AssetType; youtube_video_asset?: YoutubeVideoAsset; media_bundle_asset?: MediaBundleAsset; image_asset?: ImageAsset; text_asset?: TextAsset; } export interface BiddingStrategy { resource_name?: string; id?: number; name?: string; status?: BiddingStrategyStatus; type?: BiddingStrategyType; campaign_count?: number; non_removed_campaign_count?: number; enhanced_cpc?: EnhancedCpc; page_one_promoted?: PageOnePromoted; target_cpa?: TargetCpa; target_impression_share?: TargetImpressionShare; target_outrank_share?: TargetOutrankShare; target_roas?: TargetRoas; target_spend?: TargetSpend; } export interface PaymentsAccountInfo { payments_account_id?: string; payments_account_name?: string; payments_profile_id?: string; payments_profile_name?: string; secondary_payments_profile_id?: string; } export interface BillingSetup { resource_name?: string; id?: number; status?: BillingSetupStatus; payments_account?: string; payments_account_info?: PaymentsAccountInfo; start_date_time?: string; start_time_type?: TimeType; end_date_time?: string; end_time_type?: TimeType; } export interface NetworkSettings { target_google_search?: boolean; target_search_network?: boolean; target_content_network?: boolean; target_partner_search_network?: boolean; } export interface HotelSettingInfo { hotel_center_id?: number; } export interface DynamicSearchAdsSetting { domain_name?: string; language_code?: string; use_supplied_urls_only?: boolean; feeds?: string[]; } export interface ShoppingSetting { merchant_id?: number; sales_country?: string; campaign_priority?: number; enable_local?: boolean; } export interface TrackingSetting { tracking_url?: string; } export interface GeoTargetTypeSetting { positive_geo_target_type?: PositiveGeoTargetType; negative_geo_target_type?: NegativeGeoTargetType; } export interface SelectiveOptimization { conversion_actions?: string[]; } export interface AppCampaignSetting { bidding_strategy_goal_type?: AppCampaignBiddingStrategyGoalType; app_id?: string; app_store?: AppCampaignAppStore; } export interface VanityPharma { vanity_pharma_display_url_mode?: VanityPharmaDisplayUrlMode; vanity_pharma_text?: VanityPharmaText; } export interface Campaign { resource_name?: string; id?: number; name?: string; status?: CampaignStatus; serving_status?: CampaignServingStatus; ad_serving_optimization_status?: AdServingOptimizationStatus; advertising_channel_type?: AdvertisingChannelType; advertising_channel_sub_type?: AdvertisingChannelSubType; tracking_url_template?: string; url_custom_parameters?: CustomParameter[]; real_time_bidding_setting?: RealTimeBiddingSetting; network_settings?: NetworkSettings; hotel_setting?: HotelSettingInfo; dynamic_search_ads_setting?: DynamicSearchAdsSetting; shopping_setting?: ShoppingSetting; targeting_setting?: TargetingSetting; geo_target_type_setting?: GeoTargetTypeSetting; app_campaign_setting?: AppCampaignSetting; labels?: string[]; experiment_type?: CampaignExperimentType; base_campaign?: string; campaign_budget?: string; bidding_strategy_type?: BiddingStrategyType; start_date?: string; end_date?: string; final_url_suffix?: string; frequency_caps?: FrequencyCapEntry[]; video_brand_safety_suitability?: BrandSafetySuitability; vanity_pharma?: VanityPharma; selective_optimization?: SelectiveOptimization; tracking_setting?: TrackingSetting; payment_mode?: PaymentMode; bidding_strategy?: string; commission?: Commission; manual_cpc?: ManualCpc; manual_cpm?: ManualCpm; manual_cpv?: ManualCpv; maximize_conversions?: MaximizeConversions; maximize_conversion_value?: MaximizeConversionValue; target_cpa?: TargetCpa; target_impression_share?: TargetImpressionShare; target_roas?: TargetRoas; target_spend?: TargetSpend; percent_cpc?: PercentCpc; target_cpm?: TargetCpm; } export interface CampaignAudienceView { resource_name?: string; } export interface CampaignBidModifier { resource_name?: string; campaign?: string; criterion_id?: number; bid_modifier?: number; interaction_type?: InteractionTypeInfo; } export interface CampaignBudget { resource_name?: string; id?: number; name?: string; amount_micros?: number; total_amount_micros?: number; status?: BudgetStatus; delivery_method?: BudgetDeliveryMethod; explicitly_shared?: boolean; reference_count?: number; has_recommended_budget?: boolean; recommended_budget_amount_micros?: number; period?: BudgetPeriod; recommended_budget_estimated_change_weekly_clicks?: number; recommended_budget_estimated_change_weekly_cost_micros?: number; recommended_budget_estimated_change_weekly_interactions?: number; recommended_budget_estimated_change_weekly_views?: number; type?: BudgetType; } export interface CampaignCriterion { resource_name?: string; campaign?: string; criterion_id?: number; bid_modifier?: { value?: number; }; negative?: boolean; type?: CriterionType; status?: CampaignCriterionStatus; keyword?: KeywordInfo; placement?: PlacementInfo; mobile_app_category?: MobileAppCategoryInfo; mobile_application?: MobileApplicationInfo; location?: LocationInfo; device?: DeviceInfo; ad_schedule?: AdScheduleInfo; age_range?: AgeRangeInfo; gender?: GenderInfo; income_range?: IncomeRangeInfo; parental_status?: ParentalStatusInfo; user_list?: UserListInfo; youtube_video?: YouTubeVideoInfo; youtube_channel?: YouTubeChannelInfo; proximity?: ProximityInfo; topic?: TopicInfo; listing_scope?: ListingScopeInfo; language?: LanguageInfo; ip_block?: IpBlockInfo; content_label?: ContentLabelInfo; carrier?: CarrierInfo; user_interest?: UserInterestInfo; webpage?: WebpageInfo; operating_system_version?: OperatingSystemVersionInfo; mobile_device?: MobileDeviceInfo; location_group?: LocationGroupInfo; } export interface CampaignCriterionSimulation { resource_name?: string; campaign_id?: number; criterion_id?: number; type?: SimulationType; modification_method?: SimulationModificationMethod; start_date?: string; end_date?: string; bid_modifier_point_list?: BidModifierSimulationPointList; } export interface CampaignDraft { resource_name?: string; draft_id?: number; base_campaign?: string; name?: string; draft_campaign?: string; status?: CampaignDraftStatus; has_experiment_running?: boolean; long_running_operation?: string; } export interface CampaignExperiment { resource_name?: string; id?: number; campaign_draft?: string; name?: string; description?: string; traffic_split_percent?: number; traffic_split_type?: CampaignExperimentTrafficSplitType; experiment_campaign?: string; status?: CampaignExperimentStatus; long_running_operation?: string; start_date?: string; end_date?: string; } export interface CampaignExtensionSetting { resource_name?: string; extension_type?: ExtensionType; campaign?: string; extension_feed_items?: string[]; device?: ExtensionSettingDevice; } export interface CampaignFeed { resource_name?: string; feed?: string; campaign?: string; placeholder_types?: PlaceholderType[]; matching_function?: MatchingFunction; status?: FeedLinkStatus; } export interface CampaignLabel { resource_name?: string; campaign?: string; label?: string; } export interface CampaignSharedSet { resource_name?: string; campaign?: string; shared_set?: string; status?: CampaignSharedSetStatus; } export interface CarrierConstant { resource_name?: string; id?: number; name?: string; country_code?: string; } export interface ChangeStatus { resource_name?: string; last_change_date_time?: string; resource_type?: ChangeStatusResourceType; campaign?: string; ad_group?: string; resource_status?: ChangeStatusOperation; ad_group_ad?: string; ad_group_criterion?: string; campaign_criterion?: string; feed?: string; feed_item?: string; ad_group_feed?: string; campaign_feed?: string; ad_group_bid_modifier?: string; } export interface ClickView { resource_name?: string; gclid?: string; area_of_interest?: ClickLocation; location_of_presence?: ClickLocation; page_number?: number; ad_group_ad?: string; } export interface AttributionModelSettings { attribution_model?: AttributionModel; data_driven_model_status?: DataDrivenModelStatus; } export interface ValueSettings { default_value?: number; default_currency_code?: string; always_use_default_value?: boolean; } export interface ConversionAction { resource_name?: strin