@pipedream/google_ads 0.1.1 → 0.2.1

package/common/resources/campaign.mjs

@@ -0,0 +1,289 @@
+const fields = [
+  "accessible_bidding_strategy",
+  "ad_serving_optimization_status",
+  "advertising_channel_sub_type",
+  "advertising_channel_type",
+  "app_campaign_setting.app_id",
+  "app_campaign_setting.app_store",
+  "app_campaign_setting.bidding_strategy_goal_type",
+  "asset_automation_settings",
+  "audience_setting.use_audience_grouped",
+  "base_campaign",
+  "bidding_strategy",
+  "bidding_strategy_system_status",
+  "bidding_strategy_type",
+  "campaign_budget",
+  "campaign_group",
+  "commission.commission_rate_micros",
+  "discovery_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",
+  "excluded_parent_asset_field_types",
+  "excluded_parent_asset_set_types",
+  "experiment_type",
+  "final_url_suffix",
+  "frequency_caps",
+  "geo_target_type_setting.negative_geo_target_type",
+  "geo_target_type_setting.positive_geo_target_type",
+  "hotel_property_asset_set",
+  "hotel_setting.hotel_center_id",
+  "id",
+  "labels",
+  "listing_type",
+  "local_campaign_setting.location_source_type",
+  "local_services_campaign_settings.category_bids",
+  "manual_cpa",
+  "manual_cpc.enhanced_cpc_enabled",
+  "manual_cpm",
+  "manual_cpv",
+  "maximize_conversion_value.target_roas",
+  "maximize_conversions.target_cpa_micros",
+  "name",
+  "network_settings.target_content_network",
+  "network_settings.target_google_search",
+  "network_settings.target_google_tv_network",
+  "network_settings.target_partner_search_network",
+  "network_settings.target_search_network",
+  "network_settings.target_youtube",
+  "optimization_goal_setting.optimization_goal_types",
+  "optimization_score",
+  "payment_mode",
+  "percent_cpc.cpc_bid_ceiling_micros",
+  "percent_cpc.enhanced_cpc_enabled",
+  "performance_max_upgrade.performance_max_campaign",
+  "performance_max_upgrade.pre_upgrade_campaign",
+  "performance_max_upgrade.status",
+  "primary_status",
+  "primary_status_reasons",
+  "real_time_bidding_setting.opt_in",
+  "resource_name",
+  "selective_optimization.conversion_actions",
+  "serving_status",
+  "shopping_setting.advertising_partner_ids",
+  "shopping_setting.campaign_priority",
+  "shopping_setting.disable_product_feed",
+  "shopping_setting.enable_local",
+  "shopping_setting.feed_label",
+  "shopping_setting.merchant_id",
+  "shopping_setting.use_vehicle_inventory",
+  "start_date",
+  "status",
+  "target_cpa.cpc_bid_ceiling_micros",
+  "target_cpa.cpc_bid_floor_micros",
+  "target_cpa.target_cpa_micros",
+  "target_cpm.target_frequency_goal.target_count",
+  "target_cpm.target_frequency_goal.time_unit",
+  "target_impression_share.cpc_bid_ceiling_micros",
+  "target_impression_share.location",
+  "target_impression_share.location_fraction_micros",
+  "target_roas.cpc_bid_ceiling_micros",
+  "target_roas.cpc_bid_floor_micros",
+  "target_roas.target_roas",
+  "target_spend.cpc_bid_ceiling_micros",
+  "target_spend.target_spend_micros",
+  "targeting_setting.target_restrictions",
+  "tracking_setting.tracking_url",
+  "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",
+];
+
+const segments = [
+  "ad_destination_type",
+  "ad_network_type",
+  "asset_interaction_target.asset",
+  "asset_interaction_target.interaction_on_this_asset",
+  "auction_insight_domain",
+  "click_type",
+  "conversion_action",
+  "conversion_action_category",
+  "conversion_action_name",
+  "conversion_adjustment",
+  "conversion_attribution_event_type",
+  "conversion_lag_bucket",
+  "conversion_or_adjustment_lag_bucket",
+  "conversion_value_rule_primary_dimension",
+  "date",
+  "day_of_week",
+  "device",
+  "external_conversion_source",
+  "hour",
+  "month",
+  "month_of_year",
+  "new_versus_returning_customers",
+  "quarter",
+  "recommendation_type",
+  "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_postback_sequence_index",
+  "sk_ad_network_source_app.sk_ad_network_source_app_id",
+  "sk_ad_network_source_domain",
+  "sk_ad_network_source_type",
+  "sk_ad_network_user_type",
+  "slot",
+  "week",
+  "year",
+];
+
+const metrics = [
+  "absolute_top_impression_percentage",
+  "active_view_cpm",
+  "active_view_ctr",
+  "active_view_impressions",
+  "active_view_measurability",
+  "active_view_measurable_cost_micros",
+  "active_view_measurable_impressions",
+  "active_view_viewability",
+  "all_conversions",
+  "all_conversions_by_conversion_date",
+  "all_conversions_from_click_to_call",
+  "all_conversions_from_directions",
+  "all_conversions_from_interactions_rate",
+  "all_conversions_from_location_asset_click_to_call",
+  "all_conversions_from_location_asset_directions",
+  "all_conversions_from_location_asset_menu",
+  "all_conversions_from_location_asset_order",
+  "all_conversions_from_location_asset_other_engagement",
+  "all_conversions_from_location_asset_store_visits",
+  "all_conversions_from_location_asset_website",
+  "all_conversions_from_menu",
+  "all_conversions_from_order",
+  "all_conversions_from_other_engagement",
+  "all_conversions_from_store_visit",
+  "all_conversions_from_store_website",
+  "all_conversions_value",
+  "all_conversions_value_by_conversion_date",
+  "all_new_customer_lifetime_value",
+  "auction_insight_search_absolute_top_impression_percentage",
+  "auction_insight_search_impression_share",
+  "auction_insight_search_outranking_share",
+  "auction_insight_search_overlap_rate",
+  "auction_insight_search_position_above_rate",
+  "auction_insight_search_top_impression_percentage",
+  "average_cart_size",
+  "average_cost",
+  "average_cpc",
+  "average_cpe",
+  "average_cpm",
+  "average_cpv",
+  "average_impression_frequency_per_user",
+  "average_order_value_micros",
+  "average_page_views",
+  "average_target_cpa_micros",
+  "average_target_roas",
+  "average_time_on_site",
+  "bounce_rate",
+  "clicks",
+  "content_budget_lost_impression_share",
+  "content_impression_share",
+  "content_rank_lost_impression_share",
+  "conversions",
+  "conversions_by_conversion_date",
+  "conversions_from_interactions_rate",
+  "conversions_value",
+  "conversions_value_by_conversion_date",
+  "cost_micros",
+  "cost_of_goods_sold_micros",
+  "cost_per_all_conversions",
+  "cost_per_conversion",
+  "cost_per_current_model_attributed_conversion",
+  "cross_device_conversions",
+  "cross_device_conversions_value_micros",
+  "cross_sell_cost_of_goods_sold_micros",
+  "cross_sell_gross_profit_micros",
+  "cross_sell_revenue_micros",
+  "cross_sell_units_sold",
+  "ctr",
+  "current_model_attributed_conversions",
+  "current_model_attributed_conversions_from_interactions_rate",
+  "current_model_attributed_conversions_from_interactions_value_per_interaction",
+  "current_model_attributed_conversions_value",
+  "current_model_attributed_conversions_value_per_cost",
+  "eligible_impressions_from_location_asset_store_reach",
+  "engagement_rate",
+  "engagements",
+  "gmail_forwards",
+  "gmail_saves",
+  "gmail_secondary_clicks",
+  "gross_profit_margin",
+  "gross_profit_micros",
+  "impressions",
+  "interaction_event_types",
+  "interaction_rate",
+  "interactions",
+  "invalid_click_rate",
+  "invalid_clicks",
+  "lead_cost_of_goods_sold_micros",
+  "lead_gross_profit_micros",
+  "lead_revenue_micros",
+  "lead_units_sold",
+  "new_customer_lifetime_value",
+  "optimization_score_uplift",
+  "optimization_score_url",
+  "orders",
+  "percent_new_visitors",
+  "phone_calls",
+  "phone_impressions",
+  "phone_through_rate",
+  "publisher_organic_clicks",
+  "publisher_purchased_clicks",
+  "publisher_unknown_clicks",
+  "relative_ctr",
+  "revenue_micros",
+  "search_absolute_top_impression_share",
+  "search_budget_lost_absolute_top_impression_share",
+  "search_budget_lost_impression_share",
+  "search_budget_lost_top_impression_share",
+  "search_click_share",
+  "search_exact_match_impression_share",
+  "search_impression_share",
+  "search_rank_lost_absolute_top_impression_share",
+  "search_rank_lost_impression_share",
+  "search_rank_lost_top_impression_share",
+  "search_top_impression_share",
+  "sk_ad_network_installs",
+  "sk_ad_network_total_conversions",
+  "top_impression_percentage",
+  "unique_users",
+  "units_sold",
+  "value_per_all_conversions",
+  "value_per_all_conversions_by_conversion_date",
+  "value_per_conversion",
+  "value_per_conversions_by_conversion_date",
+  "value_per_current_model_attributed_conversion",
+  "video_quartile_p100_rate",
+  "video_quartile_p25_rate",
+  "video_quartile_p50_rate",
+  "video_quartile_p75_rate",
+  "video_view_rate",
+  "video_views",
+  "view_through_conversions",
+  "view_through_conversions_from_location_asset_click_to_call",
+  "view_through_conversions_from_location_asset_directions",
+  "view_through_conversions_from_location_asset_menu",
+  "view_through_conversions_from_location_asset_order",
+  "view_through_conversions_from_location_asset_other_engagement",
+  "view_through_conversions_from_location_asset_store_visits",
+  "view_through_conversions_from_location_asset_website",
+];
+
+const resourceOption = {
+  label: "Campaign",
+  value: "campaign",
+};
+
+export const campaign = {
+  fields,
+  segments,
+  metrics,
+  resourceOption,
+};

package/common/resources/customer.mjs

@@ -0,0 +1,181 @@
+const fields = [
+  "auto_tagging_enabled",
+  "call_reporting_setting.call_conversion_action",
+  "call_reporting_setting.call_conversion_reporting_enabled",
+  "call_reporting_setting.call_reporting_enabled",
+  "conversion_tracking_setting.accepted_customer_data_terms",
+  "conversion_tracking_setting.conversion_tracking_id",
+  "conversion_tracking_setting.conversion_tracking_status",
+  "conversion_tracking_setting.cross_account_conversion_tracking_id",
+  "conversion_tracking_setting.enhanced_conversions_for_leads_enabled",
+  "conversion_tracking_setting.google_ads_conversion_customer",
+  "currency_code",
+  "customer_agreement_setting.accepted_lead_form_terms",
+  "descriptive_name",
+  "final_url_suffix",
+  "has_partners_badge",
+  "id",
+  "image_asset_auto_migration_done",
+  "image_asset_auto_migration_done_date_time",
+  "local_services_settings.granular_insurance_statuses",
+  "local_services_settings.granular_license_statuses",
+  "location_asset_auto_migration_done",
+  "location_asset_auto_migration_done_date_time",
+  "manager",
+  "optimization_score",
+  "optimization_score_weight",
+  "pay_per_conversion_eligibility_failure_reasons",
+  "remarketing_setting.google_global_site_tag",
+  "resource_name",
+  "status",
+  "test_account",
+  "time_zone",
+  "tracking_url_template",
+  "video_brand_safety_suitability",
+];
+
+const segments = [
+  "ad_network_type",
+  "auction_insight_domain",
+  "click_type",
+  "conversion_action",
+  "conversion_action_category",
+  "conversion_action_name",
+  "conversion_adjustment",
+  "conversion_lag_bucket",
+  "conversion_or_adjustment_lag_bucket",
+  "conversion_value_rule_primary_dimension",
+  "date",
+  "day_of_week",
+  "device",
+  "external_conversion_source",
+  "hour",
+  "month",
+  "month_of_year",
+  "new_versus_returning_customers",
+  "quarter",
+  "recommendation_type",
+  "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_postback_sequence_index",
+  "sk_ad_network_source_app.sk_ad_network_source_app_id",
+  "sk_ad_network_source_domain",
+  "sk_ad_network_source_type",
+  "sk_ad_network_user_type",
+  "slot",
+  "week",
+  "year",
+];
+
+const metrics = [
+  "absolute_top_impression_percentage",
+  "active_view_cpm",
+  "active_view_ctr",
+  "active_view_impressions",
+  "active_view_measurability",
+  "active_view_measurable_cost_micros",
+  "active_view_measurable_impressions",
+  "active_view_viewability",
+  "all_conversions",
+  "all_conversions_by_conversion_date",
+  "all_conversions_from_interactions_rate",
+  "all_conversions_from_location_asset_click_to_call",
+  "all_conversions_from_location_asset_directions",
+  "all_conversions_from_location_asset_menu",
+  "all_conversions_from_location_asset_order",
+  "all_conversions_from_location_asset_other_engagement",
+  "all_conversions_from_location_asset_store_visits",
+  "all_conversions_from_location_asset_website",
+  "all_conversions_value",
+  "all_conversions_value_by_conversion_date",
+  "all_new_customer_lifetime_value",
+  "auction_insight_search_absolute_top_impression_percentage",
+  "auction_insight_search_impression_share",
+  "auction_insight_search_outranking_share",
+  "auction_insight_search_overlap_rate",
+  "auction_insight_search_position_above_rate",
+  "auction_insight_search_top_impression_percentage",
+  "average_cart_size",
+  "average_cost",
+  "average_cpc",
+  "average_cpe",
+  "average_cpm",
+  "average_cpv",
+  "average_order_value_micros",
+  "clicks",
+  "content_budget_lost_impression_share",
+  "content_impression_share",
+  "content_rank_lost_impression_share",
+  "conversions",
+  "conversions_by_conversion_date",
+  "conversions_from_interactions_rate",
+  "conversions_value",
+  "conversions_value_by_conversion_date",
+  "cost_micros",
+  "cost_of_goods_sold_micros",
+  "cost_per_all_conversions",
+  "cost_per_conversion",
+  "cross_device_conversions",
+  "cross_device_conversions_value_micros",
+  "cross_sell_cost_of_goods_sold_micros",
+  "cross_sell_gross_profit_micros",
+  "cross_sell_revenue_micros",
+  "cross_sell_units_sold",
+  "ctr",
+  "eligible_impressions_from_location_asset_store_reach",
+  "engagement_rate",
+  "engagements",
+  "gross_profit_margin",
+  "gross_profit_micros",
+  "impressions",
+  "interaction_event_types",
+  "interaction_rate",
+  "interactions",
+  "invalid_click_rate",
+  "invalid_clicks",
+  "lead_cost_of_goods_sold_micros",
+  "lead_gross_profit_micros",
+  "lead_revenue_micros",
+  "lead_units_sold",
+  "new_customer_lifetime_value",
+  "optimization_score_uplift",
+  "optimization_score_url",
+  "orders",
+  "revenue_micros",
+  "search_budget_lost_impression_share",
+  "search_exact_match_impression_share",
+  "search_impression_share",
+  "search_rank_lost_impression_share",
+  "sk_ad_network_installs",
+  "sk_ad_network_total_conversions",
+  "top_impression_percentage",
+  "units_sold",
+  "value_per_all_conversions",
+  "value_per_all_conversions_by_conversion_date",
+  "value_per_conversion",
+  "value_per_conversions_by_conversion_date",
+  "video_view_rate",
+  "video_views",
+  "view_through_conversions",
+  "view_through_conversions_from_location_asset_click_to_call",
+  "view_through_conversions_from_location_asset_directions",
+  "view_through_conversions_from_location_asset_menu",
+  "view_through_conversions_from_location_asset_order",
+  "view_through_conversions_from_location_asset_other_engagement",
+  "view_through_conversions_from_location_asset_store_visits",
+  "view_through_conversions_from_location_asset_website",
+];
+
+const resourceOption = {
+  label: "Customer",
+  value: "customer",
+};
+
+export const customer = {
+  fields,
+  segments,
+  metrics,
+  resourceOption,
+};

package/common/utils.mjs

@@ -0,0 +1,32 @@
+import { ConfigurationError } from "@pipedream/platform";
+
+export function parseObject(value = {}) {
+  return Object.fromEntries(Object.entries(value).map(([
+    key,
+    value,
+  ]) => {
+    try {
+      return [
+        key,
+        JSON.parse(value),
+      ];
+    } catch (err) {
+      return [
+        key,
+        value,
+      ];
+    }
+  }));
+}
+
+export function parseStringObject(value = "{}") {
+  try {
+    return typeof value === "string"
+      ? JSON.parse(value)
+      : value;
+  } catch (err) {
+    throw new ConfigurationError(`Error parsing JSON value \`${value}\`
+\\
+**${err.toString()}**`);
+  }
+}