@pipedream/google_ads 0.7.0 → 1.0.0

package/common/constants.mjs

@@ -1,3 +1,372 @@
+export const API_VERSION = "v25";
+
+// Conversion payload fields the upload actions set and validate themselves. Includes the
+// click and call identifiers: injecting those here would bypass the exactly-one-identifier
+// check, which runs against the props before the payload is assembled.
+export const RESERVED_CONVERSION_FIELDS = [
+  "callStartDateTime",
+  "callerId",
+  "conversionAction",
+  "conversionDateTime",
+  "conversionEnvironment",
+  "conversionValue",
+  "currencyCode",
+  "gbraid",
+  "gclid",
+  "orderId",
+  "wbraid",
+];
+
+export const SHARED_SET_TYPES = [
+  {
+    label: "Negative Keywords",
+    value: "NEGATIVE_KEYWORDS",
+  },
+  {
+    label: "Negative Placements",
+    value: "NEGATIVE_PLACEMENTS",
+  },
+];
+
+export const CREATE_REMOVE_OPERATION_TYPES = [
+  {
+    label: "Create",
+    value: "create",
+  },
+  {
+    label: "Remove",
+    value: "remove",
+  },
+];
+
+export const CAMPAIGN_OPERATION_TYPES = [
+  {
+    label: "Create",
+    value: "create",
+  },
+  {
+    label: "Update",
+    value: "update",
+  },
+  {
+    label: "Remove",
+    value: "remove",
+  },
+];
+
+export const CAMPAIGN_STATUSES = [
+  "ENABLED",
+  "PAUSED",
+  "REMOVED",
+];
+
+export const ADVERTISING_CHANNEL_TYPES = [
+  {
+    label: "Search",
+    value: "SEARCH",
+  },
+  {
+    label: "Display",
+    value: "DISPLAY",
+  },
+  {
+    label: "Shopping",
+    value: "SHOPPING",
+  },
+  {
+    label: "Hotel",
+    value: "HOTEL",
+  },
+  {
+    label: "Video",
+    value: "VIDEO",
+  },
+  {
+    label: "Multi-Channel (App)",
+    value: "MULTI_CHANNEL",
+  },
+  {
+    label: "Local",
+    value: "LOCAL",
+  },
+  {
+    label: "Smart",
+    value: "SMART",
+  },
+  {
+    label: "Performance Max",
+    value: "PERFORMANCE_MAX",
+  },
+  {
+    label: "Local Services",
+    value: "LOCAL_SERVICES",
+  },
+  {
+    label: "Travel",
+    value: "TRAVEL",
+  },
+  {
+    label: "Demand Gen",
+    value: "DEMAND_GEN",
+  },
+];
+
+export const KEYWORD_MATCH_TYPES = [
+  {
+    label: "Exact",
+    value: "EXACT",
+  },
+  {
+    label: "Phrase",
+    value: "PHRASE",
+  },
+  {
+    label: "Broad",
+    value: "BROAD",
+  },
+];
+
+export const AD_GROUP_STATUSES = [
+  "ENABLED",
+  "PAUSED",
+  "REMOVED",
+];
+
+export const AD_GROUP_TYPES = [
+  {
+    label: "Search Standard",
+    value: "SEARCH_STANDARD",
+  },
+  {
+    label: "Display Standard",
+    value: "DISPLAY_STANDARD",
+  },
+  {
+    label: "Shopping Product Ads",
+    value: "SHOPPING_PRODUCT_ADS",
+  },
+  {
+    label: "Hotel Ads",
+    value: "HOTEL_ADS",
+  },
+  {
+    label: "Shopping Smart Ads",
+    value: "SHOPPING_SMART_ADS",
+  },
+  {
+    label: "Video Bumper",
+    value: "VIDEO_BUMPER",
+  },
+  {
+    label: "Video TrueView In-Stream",
+    value: "VIDEO_TRUE_VIEW_IN_STREAM",
+  },
+  {
+    label: "Video TrueView In-Display",
+    value: "VIDEO_TRUE_VIEW_IN_DISPLAY",
+  },
+  {
+    label: "Video Non-Skippable In-Stream",
+    value: "VIDEO_NON_SKIPPABLE_IN_STREAM",
+  },
+  {
+    label: "Search Dynamic Ads",
+    value: "SEARCH_DYNAMIC_ADS",
+  },
+  {
+    label: "Shopping Comparison Listing Ads",
+    value: "SHOPPING_COMPARISON_LISTING_ADS",
+  },
+  {
+    label: "Promoted Hotel Ads",
+    value: "PROMOTED_HOTEL_ADS",
+  },
+  {
+    label: "Video Responsive",
+    value: "VIDEO_RESPONSIVE",
+  },
+  {
+    label: "Video Efficient Reach",
+    value: "VIDEO_EFFICIENT_REACH",
+  },
+  {
+    label: "Smart Campaign Ads",
+    value: "SMART_CAMPAIGN_ADS",
+  },
+  {
+    label: "Travel Ads",
+    value: "TRAVEL_ADS",
+  },
+  {
+    label: "YouTube Audio",
+    value: "YOUTUBE_AUDIO",
+  },
+];
+
+export const AD_ROTATION_MODES = [
+  {
+    label: "Optimize",
+    value: "OPTIMIZE",
+  },
+  {
+    label: "Rotate Forever",
+    value: "ROTATE_FOREVER",
+  },
+];
+
+export const BUDGET_DELIVERY_METHODS = [
+  {
+    label: "Standard",
+    value: "STANDARD",
+  },
+  {
+    label: "Accelerated",
+    value: "ACCELERATED",
+  },
+];
+
+export const BUDGET_PERIODS = [
+  {
+    label: "Daily",
+    value: "DAILY",
+  },
+  {
+    label: "Custom Period",
+    value: "CUSTOM_PERIOD",
+  },
+];
+
+export const ASSET_AUTOMATION_STATUSES = [
+  {
+    label: "Opted In",
+    value: "OPTED_IN",
+  },
+  {
+    label: "Opted Out",
+    value: "OPTED_OUT",
+  },
+];
+
+// `PERCENT_CPC` is deliberately absent: v25 exposes no `bidding_strategy.percent_cpc`
+// scheme, so a portfolio strategy cannot be created with that type.
+export const PORTFOLIO_BIDDING_STRATEGY_TYPES = [
+  {
+    label: "Target CPA",
+    value: "TARGET_CPA",
+  },
+  {
+    label: "Target ROAS",
+    value: "TARGET_ROAS",
+  },
+  {
+    label: "Target Spend",
+    value: "TARGET_SPEND",
+  },
+  {
+    label: "Maximize Conversions",
+    value: "MAXIMIZE_CONVERSIONS",
+  },
+  {
+    label: "Maximize Conversion Value",
+    value: "MAXIMIZE_CONVERSION_VALUE",
+  },
+  {
+    label: "Target Impression Share",
+    value: "TARGET_IMPRESSION_SHARE",
+  },
+  {
+    label: "Enhanced CPC",
+    value: "ENHANCED_CPC",
+  },
+];
+
+export const CAMPAIGN_BIDDING_STRATEGY_TYPES = [
+  {
+    label: "Manual CPC",
+    value: "MANUAL_CPC",
+  },
+  {
+    label: "Manual CPM",
+    value: "MANUAL_CPM",
+  },
+  {
+    label: "Target CPA",
+    value: "TARGET_CPA",
+  },
+  {
+    label: "Target ROAS",
+    value: "TARGET_ROAS",
+  },
+  {
+    label: "Target Spend",
+    value: "TARGET_SPEND",
+  },
+  {
+    label: "Maximize Conversions",
+    value: "MAXIMIZE_CONVERSIONS",
+  },
+  {
+    label: "Maximize Conversion Value",
+    value: "MAXIMIZE_CONVERSION_VALUE",
+  },
+  {
+    label: "Target Impression Share",
+    value: "TARGET_IMPRESSION_SHARE",
+  },
+  {
+    label: "Percent CPC",
+    value: "PERCENT_CPC",
+  },
+];
+
+export const TARGET_IMPRESSION_SHARE_LOCATIONS = [
+  {
+    label: "Anywhere on page",
+    value: "ANYWHERE_ON_PAGE",
+  },
+  {
+    label: "Top of page",
+    value: "TOP_OF_PAGE",
+  },
+  {
+    label: "Absolute top of page",
+    value: "ABSOLUTE_TOP_OF_PAGE",
+  },
+];
+
+export const UPLOAD_CONVERSION_TYPES = [
+  {
+    label: "Click conversion (attributed to an ad click via GCLID)",
+    value: "CLICK",
+  },
+  {
+    label: "Call conversion (attributed to a phone call)",
+    value: "CALL",
+  },
+];
+
+export const CONVERSION_ENVIRONMENTS = [
+  {
+    label: "Web",
+    value: "WEB",
+  },
+  {
+    label: "App",
+    value: "APP",
+  },
+];
+
+export const EU_POLITICAL_ADVERTISING_STATUSES = [
+  {
+    label: "Does not contain EU political advertising",
+    value: "DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING",
+  },
+  {
+    label: "Contains EU political advertising",
+    value: "CONTAINS_EU_POLITICAL_ADVERTISING",
+  },
+];
+
 export const CORE_DATE_SEGMENTS = [
   "segments.date",
   "segments.week",

package/common/queries.mjs

@@ -1,3 +1,5 @@
+import { sanitizeGaqlString } from "./utils.mjs";
+
 function listCustomerClients(query) {
   const fields = [
     "client_customer",
@@ -10,7 +12,7 @@ function listCustomerClients(query) {
     .join(", ");
 
   const condition = query
-    ? `customer_client.descriptive_name LIKE '%${query}%'`
+    ? `customer_client.descriptive_name LIKE '%${sanitizeGaqlString(query)}%'`
     : "customer_client.level <= 3";
 
   return `SELECT ${fields} FROM customer_client WHERE ${condition}`;
@@ -105,7 +107,7 @@ function listResources(resource, query) {
 
   let result = `SELECT ${fieldResource}.id, ${fieldResource}.${name} FROM ${resource}`;
   if (query) {
-    result += ` WHERE ${fieldResource}.${name} LIKE '%${query}%'`;
+    result += ` WHERE ${fieldResource}.${name} LIKE '%${sanitizeGaqlString(query)}%'`;
   }
   return result;
 }

package/common/resources/ad.mjs

@@ -6,84 +6,50 @@ const fields = [
   "ad.app_ad.descriptions",
   "ad.app_ad.headlines",
   "ad.app_ad.html5_media_bundles",
-  "ad.app_ad.html5_media_bundles.asset",
   "ad.app_ad.images",
-  "ad.app_ad.images.asset",
   "ad.app_ad.mandatory_ad_text",
   "ad.app_ad.youtube_videos",
-  "ad.app_ad.youtube_videos.asset",
   "ad.app_engagement_ad.descriptions",
   "ad.app_engagement_ad.headlines",
   "ad.app_engagement_ad.images",
-  "ad.app_engagement_ad.images.asset",
   "ad.app_engagement_ad.videos",
-  "ad.app_engagement_ad.videos.asset",
   "ad.app_pre_registration_ad.descriptions",
   "ad.app_pre_registration_ad.headlines",
   "ad.app_pre_registration_ad.images",
-  "ad.app_pre_registration_ad.images.asset",
   "ad.app_pre_registration_ad.youtube_videos",
-  "ad.app_pre_registration_ad.youtube_videos.asset",
-  "ad.call_ad.business_name",
-  "ad.call_ad.call_tracked",
-  "ad.call_ad.conversion_action",
-  "ad.call_ad.conversion_reporting_state",
-  "ad.call_ad.country_code",
-  "ad.call_ad.description1",
-  "ad.call_ad.description2",
-  "ad.call_ad.disable_call_conversion",
-  "ad.call_ad.headline1",
-  "ad.call_ad.headline2",
-  "ad.call_ad.path1",
-  "ad.call_ad.path2",
-  "ad.call_ad.phone_number",
-  "ad.call_ad.phone_number_verification_url",
+  "ad.demand_gen_carousel_ad.business_name",
+  "ad.demand_gen_carousel_ad.call_to_action_text",
+  "ad.demand_gen_carousel_ad.carousel_cards",
+  "ad.demand_gen_carousel_ad.description",
+  "ad.demand_gen_carousel_ad.headline",
+  "ad.demand_gen_carousel_ad.logo_image",
+  "ad.demand_gen_multi_asset_ad.business_name",
+  "ad.demand_gen_multi_asset_ad.call_to_action_text",
+  "ad.demand_gen_multi_asset_ad.descriptions",
+  "ad.demand_gen_multi_asset_ad.headlines",
+  "ad.demand_gen_multi_asset_ad.logo_images",
+  "ad.demand_gen_multi_asset_ad.marketing_images",
+  "ad.demand_gen_multi_asset_ad.portrait_marketing_images",
+  "ad.demand_gen_multi_asset_ad.square_marketing_images",
   "ad.demand_gen_product_ad.breadcrumb1",
   "ad.demand_gen_product_ad.breadcrumb2",
   "ad.demand_gen_product_ad.business_name",
   "ad.demand_gen_product_ad.call_to_action",
-  "ad.demand_gen_product_ad.call_to_action.asset",
   "ad.demand_gen_product_ad.description",
   "ad.demand_gen_product_ad.headline",
   "ad.demand_gen_product_ad.logo_image",
-  "ad.demand_gen_product_ad.logo_image.asset",
+  "ad.demand_gen_video_responsive_ad.breadcrumb1",
+  "ad.demand_gen_video_responsive_ad.breadcrumb2",
+  "ad.demand_gen_video_responsive_ad.business_name",
+  "ad.demand_gen_video_responsive_ad.call_to_actions",
+  "ad.demand_gen_video_responsive_ad.descriptions",
+  "ad.demand_gen_video_responsive_ad.headlines",
+  "ad.demand_gen_video_responsive_ad.logo_images",
+  "ad.demand_gen_video_responsive_ad.long_headlines",
+  "ad.demand_gen_video_responsive_ad.videos",
   "ad.device_preference",
-  "ad.discovery_carousel_ad.business_name",
-  "ad.discovery_carousel_ad.call_to_action_text",
-  "ad.discovery_carousel_ad.carousel_cards",
-  "ad.discovery_carousel_ad.carousel_cards.asset",
-  "ad.discovery_carousel_ad.description",
-  "ad.discovery_carousel_ad.headline",
-  "ad.discovery_carousel_ad.logo_image",
-  "ad.discovery_carousel_ad.logo_image.asset",
-  "ad.discovery_multi_asset_ad.business_name",
-  "ad.discovery_multi_asset_ad.call_to_action_text",
-  "ad.discovery_multi_asset_ad.descriptions",
-  "ad.discovery_multi_asset_ad.headlines",
-  "ad.discovery_multi_asset_ad.lead_form_only",
-  "ad.discovery_multi_asset_ad.logo_images",
-  "ad.discovery_multi_asset_ad.logo_images.asset",
-  "ad.discovery_multi_asset_ad.marketing_images",
-  "ad.discovery_multi_asset_ad.marketing_images.asset",
-  "ad.discovery_multi_asset_ad.portrait_marketing_images",
-  "ad.discovery_multi_asset_ad.portrait_marketing_images.asset",
-  "ad.discovery_multi_asset_ad.square_marketing_images",
-  "ad.discovery_multi_asset_ad.square_marketing_images.asset",
-  "ad.discovery_video_responsive_ad.breadcrumb1",
-  "ad.discovery_video_responsive_ad.breadcrumb2",
-  "ad.discovery_video_responsive_ad.business_name",
-  "ad.discovery_video_responsive_ad.call_to_actions",
-  "ad.discovery_video_responsive_ad.call_to_actions.asset",
-  "ad.discovery_video_responsive_ad.descriptions",
-  "ad.discovery_video_responsive_ad.headlines",
-  "ad.discovery_video_responsive_ad.logo_images",
-  "ad.discovery_video_responsive_ad.logo_images.asset",
-  "ad.discovery_video_responsive_ad.long_headlines",
-  "ad.discovery_video_responsive_ad.videos",
-  "ad.discovery_video_responsive_ad.videos.asset",
   "ad.display_upload_ad.display_upload_product_type",
   "ad.display_upload_ad.media_bundle",
-  "ad.display_upload_ad.media_bundle.asset",
   "ad.display_url",
   "ad.expanded_dynamic_search_ad.description",
   "ad.expanded_dynamic_search_ad.description2",
@@ -129,13 +95,10 @@ const fields = [
   "ad.local_ad.descriptions",
   "ad.local_ad.headlines",
   "ad.local_ad.logo_images",
-  "ad.local_ad.logo_images.asset",
   "ad.local_ad.marketing_images",
-  "ad.local_ad.marketing_images.asset",
   "ad.local_ad.path1",
   "ad.local_ad.path2",
   "ad.local_ad.videos",
-  "ad.local_ad.videos.asset",
   "ad.name",
   "ad.resource_name",
   "ad.responsive_display_ad.accent_color",
@@ -148,19 +111,14 @@ const fields = [
   "ad.responsive_display_ad.format_setting",
   "ad.responsive_display_ad.headlines",
   "ad.responsive_display_ad.logo_images",
-  "ad.responsive_display_ad.logo_images.asset",
   "ad.responsive_display_ad.long_headline",
   "ad.responsive_display_ad.main_color",
   "ad.responsive_display_ad.marketing_images",
-  "ad.responsive_display_ad.marketing_images.asset",
   "ad.responsive_display_ad.price_prefix",
   "ad.responsive_display_ad.promo_text",
   "ad.responsive_display_ad.square_logo_images",
-  "ad.responsive_display_ad.square_logo_images.asset",
   "ad.responsive_display_ad.square_marketing_images",
-  "ad.responsive_display_ad.square_marketing_images.asset",
   "ad.responsive_display_ad.youtube_videos",
-  "ad.responsive_display_ad.youtube_videos.asset",
   "ad.responsive_search_ad.descriptions",
   "ad.responsive_search_ad.headlines",
   "ad.responsive_search_ad.path1",
@@ -199,12 +157,10 @@ const fields = [
   "ad.video_responsive_ad.breadcrumb2",
   "ad.video_responsive_ad.call_to_actions",
   "ad.video_responsive_ad.companion_banners",
-  "ad.video_responsive_ad.companion_banners.asset",
   "ad.video_responsive_ad.descriptions",
   "ad.video_responsive_ad.headlines",
   "ad.video_responsive_ad.long_headlines",
   "ad.video_responsive_ad.videos",
-  "ad.video_responsive_ad.videos.asset",
   "ad_group",
   "ad_strength",
   "labels",
@@ -257,7 +213,6 @@ const metrics = [
   "average_cpc",
   "average_cpe",
   "average_cpm",
-  "average_cpv",
   "average_order_value_micros",
   "average_page_views",
   "average_time_on_site",
@@ -312,8 +267,8 @@ const metrics = [
   "video_quartile_p25_rate",
   "video_quartile_p50_rate",
   "video_quartile_p75_rate",
-  "video_view_rate",
-  "video_views",
+  "video_trueview_view_rate",
+  "video_trueview_views",
   "view_through_conversions",
 ].map((f) => getOption(f, "metrics"));
 

package/common/resources/adGroup.mjs

@@ -82,7 +82,6 @@ const metrics = [
   "average_cpc",
   "average_cpe",
   "average_cpm",
-  "average_cpv",
   "average_order_value_micros",
   "average_page_views",
   "average_time_on_site",
@@ -152,8 +151,8 @@ const metrics = [
   "video_quartile_p25_rate",
   "video_quartile_p50_rate",
   "video_quartile_p75_rate",
-  "video_view_rate",
-  "video_views",
+  "video_trueview_view_rate",
+  "video_trueview_views",
   "view_through_conversions",
 ].map((f) => getOption(f, "metrics"));
 

package/common/resources/campaign.mjs

@@ -17,12 +17,12 @@ const fields = [
   "campaign_budget",
   "campaign_group",
   "commission.commission_rate_micros",
-  "discovery_campaign_settings.upgraded_targeting",
+  "contains_eu_political_advertising",
+  "demand_gen_campaign_settings.upgraded_targeting",
   "dynamic_search_ads_setting.domain_name",
-  "dynamic_search_ads_setting.feeds",
   "dynamic_search_ads_setting.language_code",
   "dynamic_search_ads_setting.use_supplied_urls_only",
-  "end_date",
+  "end_date_time",
   "excluded_parent_asset_field_types",
   "excluded_parent_asset_set_types",
   "experiment_type",
@@ -71,7 +71,7 @@ const fields = [
   "shopping_setting.feed_label",
   "shopping_setting.merchant_id",
   "shopping_setting.use_vehicle_inventory",
-  "start_date",
+  "start_date_time",
   "status",
   "target_cpa.cpc_bid_ceiling_micros",
   "target_cpa.cpc_bid_floor_micros",
@@ -91,10 +91,8 @@ const fields = [
   "tracking_url_template",
   "travel_campaign_settings.travel_account_id",
   "url_custom_parameters",
-  "url_expansion_opt_out",
   "vanity_pharma.vanity_pharma_display_url_mode",
   "vanity_pharma.vanity_pharma_text",
-  "video_brand_safety_suitability",
 ].map((f) => getOption(f, "campaign"));
 
 const segments = [
@@ -121,7 +119,7 @@ const segments = [
   "sk_ad_network_ad_event_type",
   "sk_ad_network_attribution_credit",
   "sk_ad_network_coarse_conversion_value",
-  "sk_ad_network_conversion_value",
+  "sk_ad_network_fine_conversion_value",
   "sk_ad_network_postback_sequence_index",
   "sk_ad_network_source_app.sk_ad_network_source_app_id",
   "sk_ad_network_source_domain",
@@ -170,7 +168,6 @@ const metrics = [
   "average_cpc",
   "average_cpe",
   "average_cpm",
-  "average_cpv",
   "average_impression_frequency_per_user",
   "average_order_value_micros",
   "average_page_views",
@@ -260,8 +257,8 @@ const metrics = [
   "video_quartile_p25_rate",
   "video_quartile_p50_rate",
   "video_quartile_p75_rate",
-  "video_view_rate",
-  "video_views",
+  "video_trueview_view_rate",
+  "video_trueview_views",
   "view_through_conversions",
   "view_through_conversions_from_location_asset_click_to_call",
   "view_through_conversions_from_location_asset_directions",

package/common/resources/customer.mjs

@@ -56,7 +56,7 @@ const segments = [
   "sk_ad_network_ad_event_type",
   "sk_ad_network_attribution_credit",
   "sk_ad_network_coarse_conversion_value",
-  "sk_ad_network_conversion_value",
+  "sk_ad_network_fine_conversion_value",
   "sk_ad_network_postback_sequence_index",
   "sk_ad_network_source_app.sk_ad_network_source_app_id",
   "sk_ad_network_source_domain",
@@ -98,7 +98,6 @@ const metrics = [
   "average_cpc",
   "average_cpe",
   "average_cpm",
-  "average_cpv",
   "average_order_value_micros",
   "clicks",
   "content_budget_lost_impression_share",
@@ -152,8 +151,8 @@ const metrics = [
   "value_per_all_conversions_by_conversion_date",
   "value_per_conversion",
   "value_per_conversions_by_conversion_date",
-  "video_view_rate",
-  "video_views",
+  "video_trueview_view_rate",
+  "video_trueview_views",
   "view_through_conversions",
   "view_through_conversions_from_location_asset_click_to_call",
   "view_through_conversions_from_location_asset_directions",

package/common/utils.mjs

@@ -68,6 +68,10 @@ export function getResourceOption(item, resource) {
   };
 }
 
+export function sanitizeGaqlString(value) {
+  return String(value).replace(/'/g, "''");
+}
+
 export function checkPrefix(value, prefix) {
   const checkStr = (s) => s && (s?.startsWith?.(prefix)
     ? s