embulk-input-facebook_ads_insights 0.1.0

data/src/main/java/org/embulk/input/facebook_ads_insights/FacebookAdsInsightsColumnVisitor.java

@@ -0,0 +1,123 @@
+package org.embulk.input.facebook_ads_insights;
+
+import com.facebook.ads.sdk.AdsInsights;
+import com.google.gson.JsonElement;
+import org.embulk.spi.Column;
+import org.embulk.spi.ColumnConfig;
+import org.embulk.spi.ColumnVisitor;
+import org.embulk.spi.PageBuilder;
+import org.embulk.spi.json.JsonParser;
+import org.embulk.spi.time.Timestamp;
+import org.embulk.spi.time.TimestampParser;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.List;
+import java.util.Objects;
+
+public class FacebookAdsInsightsColumnVisitor implements ColumnVisitor
+{
+    private static final String DEFAULT_TIMESTAMP_PATTERN = "%Y-%m-%dT%H:%M:%S.%L%z";
+    private final Logger logger =  LoggerFactory.getLogger(FacebookAdsInsightsColumnVisitor.class);
+
+    private final AdsInsightsAccessor accessor;
+    private final PageBuilder pageBuilder;
+    private final PluginTask pluginTask;
+
+    public FacebookAdsInsightsColumnVisitor(final AdsInsights insights, final PageBuilder pageBuilder, final PluginTask pluginTask)
+    {
+        this.accessor = new AdsInsightsAccessor(insights);
+        this.pageBuilder = pageBuilder;
+        this.pluginTask = pluginTask;
+    }
+
+    @Override
+    public void stringColumn(Column column)
+    {
+        try {
+            String data = accessor.get(column.getName());
+            if (Objects.isNull(data)) {
+                pageBuilder.setNull(column);
+            }
+            else {
+                pageBuilder.setString(column, data);
+            }
+        }
+        catch (Exception e) {
+            pageBuilder.setNull(column);
+        }
+    }
+    @Override
+    public void booleanColumn(Column column)
+    {
+        try {
+            String data = accessor.get(column.getName());
+            pageBuilder.setBoolean(column, Boolean.parseBoolean(data));
+        }
+        catch (Exception e) {
+            pageBuilder.setNull(column);
+        }
+    }
+    @Override
+    public void longColumn(Column column)
+    {
+        try {
+            String data = accessor.get(column.getName());
+            pageBuilder.setLong(column, Long.parseLong(data));
+        }
+        catch (Exception e) {
+            pageBuilder.setNull(column);
+        }
+    }
+    @Override
+    public void doubleColumn(Column column)
+    {
+        try {
+            String data = accessor.get(column.getName());
+            pageBuilder.setDouble(column, Double.parseDouble(data));
+        }
+        catch (Exception e) {
+            pageBuilder.setNull(column);
+        }
+    }
+    @Override
+    public void timestampColumn(Column column)
+    {
+        try {
+            List<ColumnConfig> columnConfigs = pluginTask.getFields().getColumns();
+            String pattern = DEFAULT_TIMESTAMP_PATTERN;
+            for (ColumnConfig config : columnConfigs) {
+                if (config.getName().equals(column.getName())
+                        && config.getConfigSource() != null
+                        && config.getConfigSource().getObjectNode() != null
+                        && config.getConfigSource().getObjectNode().get("format") != null
+                        && config.getConfigSource().getObjectNode().get("format").isTextual()) {
+                    pattern = config.getConfigSource().getObjectNode().get("format").asText();
+                    break;
+                }
+            }
+            TimestampParser parser = TimestampParser.of(pattern, "UTC");
+            Timestamp result = parser.parse(column.getName());
+            pageBuilder.setTimestamp(column, result);
+        }
+        catch (Exception e) {
+            pageBuilder.setNull(column);
+        }
+    }
+    @Override
+    public void jsonColumn(Column column)
+    {
+        try {
+            JsonElement data = new com.google.gson.JsonParser().parse(accessor.get(column.getName()));
+            if (data.isJsonNull() || data.isJsonPrimitive()) {
+                pageBuilder.setNull(column);
+            }
+            else {
+                pageBuilder.setJson(column, new JsonParser().parse(data.toString()));
+            }
+        }
+        catch (Exception e) {
+            pageBuilder.setNull(column);
+        }
+    }
+}

data/src/main/java/org/embulk/input/facebook_ads_insights/FacebookAdsInsightsInputPlugin.java

@@ -0,0 +1,79 @@
+package org.embulk.input.facebook_ads_insights;
+
+import com.facebook.ads.sdk.APIException;
+import com.facebook.ads.sdk.AdsInsights;
+import org.embulk.config.ConfigDiff;
+import org.embulk.config.ConfigSource;
+import org.embulk.config.TaskReport;
+import org.embulk.config.TaskSource;
+import org.embulk.exec.ExecutionInterruptedException;
+import org.embulk.spi.Exec;
+import org.embulk.spi.InputPlugin;
+import org.embulk.spi.PageBuilder;
+import org.embulk.spi.PageOutput;
+import org.embulk.spi.Schema;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.List;
+
+public class FacebookAdsInsightsInputPlugin
+        implements InputPlugin
+{
+    private final Logger logger =  LoggerFactory.getLogger(FacebookAdsInsightsInputPlugin.class);
+
+    @Override
+    public ConfigDiff transaction(ConfigSource config,
+            InputPlugin.Control control)
+    {
+        PluginTask task = config.loadConfig(PluginTask.class);
+        Schema schema = task.getFields().toSchema();
+        return resume(task.dump(), schema, 1, control);
+    }
+
+    @Override
+    public ConfigDiff resume(TaskSource taskSource,
+            Schema schema, int taskCount,
+            InputPlugin.Control control)
+    {
+        control.run(taskSource, schema, taskCount);
+        return Exec.newConfigDiff();
+    }
+
+    @Override
+    public void cleanup(TaskSource taskSource,
+            Schema schema, int taskCount,
+            List<TaskReport> successTaskReports)
+    {
+    }
+
+    @Override
+    public TaskReport run(TaskSource taskSource,
+            Schema schema, int taskIndex,
+            PageOutput output)
+    {
+        PluginTask task = taskSource.loadTask(PluginTask.class);
+        try {
+            try (PageBuilder pageBuilder = new PageBuilder(Exec.getBufferAllocator(), schema, output)) {
+                Client client = new Client(task);
+                List<AdsInsights> insights = client.getInsights();
+                for (AdsInsights insight : insights) {
+                    schema.visitColumns(new FacebookAdsInsightsColumnVisitor(insight, pageBuilder, task));
+                    pageBuilder.addRecord();
+                }
+                pageBuilder.finish();
+            }
+        }
+        catch (APIException | InterruptedException e) {
+            logger.error(e.getMessage(), e);
+            throw new ExecutionInterruptedException(e);
+        }
+        return Exec.newTaskReport();
+    }
+
+    @Override
+    public ConfigDiff guess(ConfigSource config)
+    {
+        return Exec.newConfigDiff();
+    }
+}

data/src/main/java/org/embulk/input/facebook_ads_insights/PluginTask.java

@@ -0,0 +1,80 @@
+package org.embulk.input.facebook_ads_insights;
+
+import org.embulk.config.Config;
+import org.embulk.config.ConfigDefault;
+import org.embulk.config.Task;
+import org.embulk.input.facebook_ads_insights.model.ActionAttributionWindow;
+import org.embulk.input.facebook_ads_insights.model.ActionBreakdown;
+import org.embulk.input.facebook_ads_insights.model.ActionReportTime;
+import org.embulk.input.facebook_ads_insights.model.Breakdown;
+import org.embulk.input.facebook_ads_insights.model.DatePreset;
+import org.embulk.input.facebook_ads_insights.model.Level;
+import org.embulk.input.facebook_ads_insights.model.ObjectType;
+import org.embulk.spi.SchemaConfig;
+import org.embulk.spi.unit.ToStringMap;
+
+import java.util.List;
+import java.util.Optional;
+
+public interface PluginTask extends Task
+{
+    @Config("access_token")
+    public String getAccessToken();
+
+    @Config("object_type")
+    public ObjectType getObjectType();
+
+    @Config("object_id")
+    public String getObjectId();
+
+    @Config("fields")
+    public SchemaConfig getFields();
+
+    @Config("action_attribution_windows")
+    @ConfigDefault("null")
+    public Optional<List<ActionAttributionWindow>> getActionAttributionWindows();
+
+    @Config("action_breakdowns")
+    @ConfigDefault("null")
+    public Optional<List<ActionBreakdown>> getActionBreakdowns();
+
+    @Config("action_report_time")
+    @ConfigDefault("null")
+    public Optional<ActionReportTime> getActionReportTime();
+
+    @Config("breakdowns")
+    @ConfigDefault("null")
+    public Optional<List<Breakdown>> getBreakdowns();
+
+    @Config("date_preset")
+    @ConfigDefault("null")
+    public Optional<DatePreset> getDatePreset();
+
+    @Config("filtering")
+    @ConfigDefault("null")
+    public Optional<List<ToStringMap>> getFiltering();
+
+    @Config("level")
+    @ConfigDefault("null")
+    public Optional<Level> getLevel();
+
+    @Config("product_id_limit")
+    @ConfigDefault("null")
+    public Optional<Long> getProductIdLimit();
+
+    @Config("sort")
+    @ConfigDefault("null")
+    public Optional<List<String>> getSort();
+
+    @Config("time_increment")
+    @ConfigDefault("null")
+    public Optional<String> getTimeIncrement();
+
+    @Config("time_ranges")
+    @ConfigDefault("null")
+    public Optional<List<ToStringMap>> getTimeRanges();
+
+    @Config("use_account_attribution_setting")
+    @ConfigDefault("null")
+    public Optional<Boolean> getUseAccountAttributionSetting();
+}

data/src/main/java/org/embulk/input/facebook_ads_insights/Util.java

@@ -0,0 +1,18 @@
+package org.embulk.input.facebook_ads_insights;
+
+import com.google.gson.Gson;
+import org.embulk.spi.unit.ToStringMap;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class Util
+{
+    private Util() {}
+
+    public static String stringifyToStringMaps(List<ToStringMap> value)
+    {
+        Gson gson = new Gson();
+        return "[" + value.stream().map(gson::toJson).collect(Collectors.joining(",")) + "]";
+    }
+}

data/src/main/java/org/embulk/input/facebook_ads_insights/model/ActionAttributionWindow.java

@@ -0,0 +1,43 @@
+package org.embulk.input.facebook_ads_insights.model;
+
+import com.facebook.ads.sdk.AdsInsights;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+import org.embulk.config.ConfigException;
+
+public class ActionAttributionWindow
+{
+    private final AdsInsights.EnumActionAttributionWindows enumActionAttributionWindows;
+
+    private ActionAttributionWindow(final AdsInsights.EnumActionAttributionWindows enumActionAttributionWindows)
+    {
+        this.enumActionAttributionWindows = enumActionAttributionWindows;
+    }
+
+    @JsonValue
+    @Override
+    public String toString()
+    {
+        return this.enumActionAttributionWindows.toString();
+    }
+
+    @JsonCreator
+    public static ActionAttributionWindow fromString(final String value)
+    {
+        switch (value) {
+            case "1d_click": return new ActionAttributionWindow(AdsInsights.EnumActionAttributionWindows.VALUE_1D_CLICK);
+            case "1d_view": return new ActionAttributionWindow(AdsInsights.EnumActionAttributionWindows.VALUE_1D_VIEW);
+            case "7d_click": return new ActionAttributionWindow(AdsInsights.EnumActionAttributionWindows.VALUE_7D_CLICK);
+            case "7d_view": return new ActionAttributionWindow(AdsInsights.EnumActionAttributionWindows.VALUE_7D_VIEW);
+            case "28d_click": return new ActionAttributionWindow(AdsInsights.EnumActionAttributionWindows.VALUE_28D_CLICK);
+            case "28d_view": return new ActionAttributionWindow(AdsInsights.EnumActionAttributionWindows.VALUE_28D_VIEW);
+            case "default": return new ActionAttributionWindow(AdsInsights.EnumActionAttributionWindows.VALUE_DEFAULT);
+            default: throw new ConfigException(String.format("Unknown ActionAttributionWindow value '%s'", value));
+        }
+    }
+
+    public AdsInsights.EnumActionAttributionWindows getEnum()
+    {
+        return this.enumActionAttributionWindows;
+    }
+}

data/src/main/java/org/embulk/input/facebook_ads_insights/model/ActionBreakdown.java

@@ -0,0 +1,47 @@
+package org.embulk.input.facebook_ads_insights.model;
+
+import com.facebook.ads.sdk.AdsInsights;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+import org.embulk.config.ConfigException;
+
+public class ActionBreakdown
+{
+    private final AdsInsights.EnumActionBreakdowns enumActionBreakdowns;
+
+    private ActionBreakdown(final AdsInsights.EnumActionBreakdowns enumActionBreakdowns)
+    {
+        this.enumActionBreakdowns = enumActionBreakdowns;
+    }
+
+    @JsonValue
+    @Override
+    public String toString()
+    {
+        return this.enumActionBreakdowns.toString();
+    }
+
+    @JsonCreator
+    public static ActionBreakdown fromString(final String value)
+    {
+        switch (value) {
+            case "action_converted_product_id": return new ActionBreakdown(AdsInsights.EnumActionBreakdowns.VALUE_ACTION_CONVERTED_PRODUCT_ID);
+            case "action_device": return new ActionBreakdown(AdsInsights.EnumActionBreakdowns.VALUE_ACTION_DEVICE);
+            case "action_canvas_component_name": return new ActionBreakdown(AdsInsights.EnumActionBreakdowns.VALUE_ACTION_CANVAS_COMPONENT_NAME);
+            case "action_carousel_card_id": return new ActionBreakdown(AdsInsights.EnumActionBreakdowns.VALUE_ACTION_CAROUSEL_CARD_ID);
+            case "action_carousel_card_name": return new ActionBreakdown(AdsInsights.EnumActionBreakdowns.VALUE_ACTION_CAROUSEL_CARD_NAME);
+            case "action_destination": return new ActionBreakdown(AdsInsights.EnumActionBreakdowns.VALUE_ACTION_DESTINATION);
+            case "action_reaction": return new ActionBreakdown(AdsInsights.EnumActionBreakdowns.VALUE_ACTION_REACTION);
+            case "action_target_id": return new ActionBreakdown(AdsInsights.EnumActionBreakdowns.VALUE_ACTION_TARGET_ID);
+            case "action_type": return new ActionBreakdown(AdsInsights.EnumActionBreakdowns.VALUE_ACTION_TYPE);
+            case "action_video_sound": return new ActionBreakdown(AdsInsights.EnumActionBreakdowns.VALUE_ACTION_VIDEO_SOUND);
+            case "action_video_type": return new ActionBreakdown(AdsInsights.EnumActionBreakdowns.VALUE_ACTION_VIDEO_TYPE);
+            default: throw new ConfigException(String.format("Unknown ActionBreakdown value '%s'", value));
+        }
+    }
+
+    public AdsInsights.EnumActionBreakdowns getEnum()
+    {
+        return this.enumActionBreakdowns;
+    }
+}

data/src/main/java/org/embulk/input/facebook_ads_insights/model/ActionReportTime.java

@@ -0,0 +1,38 @@
+package org.embulk.input.facebook_ads_insights.model;
+
+import com.facebook.ads.sdk.AdsInsights;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+import org.embulk.config.ConfigException;
+
+public class ActionReportTime
+{
+    private final AdsInsights.EnumActionReportTime enumActionReportTime;
+
+    private ActionReportTime(final AdsInsights.EnumActionReportTime enumActionReportTime)
+    {
+        this.enumActionReportTime = enumActionReportTime;
+    }
+
+    @JsonValue
+    @Override
+    public String toString()
+    {
+        return this.enumActionReportTime.toString();
+    }
+
+    @JsonCreator
+    public static ActionReportTime fromString(final String value)
+    {
+        switch (value) {
+            case "conversion": return new ActionReportTime(AdsInsights.EnumActionReportTime.VALUE_CONVERSION);
+            case "impression": return new ActionReportTime(AdsInsights.EnumActionReportTime.VALUE_IMPRESSION);
+            default: throw new ConfigException(String.format("Unknown ActionReportTime value '%s'", value));
+        }
+    }
+
+    public AdsInsights.EnumActionReportTime getEnum()
+    {
+        return this.enumActionReportTime;
+    }
+}

data/src/main/java/org/embulk/input/facebook_ads_insights/model/Breakdown.java

@@ -0,0 +1,69 @@
+package org.embulk.input.facebook_ads_insights.model;
+
+import com.facebook.ads.sdk.AdsInsights;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+import org.embulk.config.ConfigException;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+public class Breakdown
+{
+    public static final List<String> NAMES = new ArrayList<>(Arrays.asList(
+            "ad_format_asset", "age", "body_asset", "call_to_action_asset", "country",
+            "description_asset", "gender", "image_asset", "impression_device", "link_url_asset",
+            "product_id", "region", "title_asset", "video_asset", "dma", "frequency_value",
+            "hourly_stats_aggregated_by_advertiser_time_zone", "hourly_stats_aggregated_by_audience_time_zone",
+            "place_page_id", "publisher_platform", "platform_position", "device_platform"
+    ));
+    private final AdsInsights.EnumBreakdowns enumBreakdowns;
+
+    private Breakdown(final AdsInsights.EnumBreakdowns enumBreakdowns)
+    {
+        this.enumBreakdowns = enumBreakdowns;
+    }
+
+    @JsonValue
+    @Override
+    public String toString()
+    {
+        return this.enumBreakdowns.toString();
+    }
+
+    @JsonCreator
+    public static Breakdown fromString(final String value)
+    {
+        switch (value) {
+            case "ad_format_asset": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_AD_FORMAT_ASSET);
+            case "age": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_AGE);
+            case "body_asset": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_BODY_ASSET);
+            case "call_to_action_asset": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_CALL_TO_ACTION_ASSET);
+            case "country": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_COUNTRY);
+            case "description_asset": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_DESCRIPTION_ASSET);
+            case "gender": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_GENDER);
+            case "image_asset": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_IMAGE_ASSET);
+            case "impression_device": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_IMPRESSION_DEVICE);
+            case "link_url_asset": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_LINK_URL_ASSET);
+            case "product_id": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_PRODUCT_ID);
+            case "region": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_REGION);
+            case "title_asset": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_TITLE_ASSET);
+            case "video_asset": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_VIDEO_ASSET);
+            case "dma": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_DMA);
+            case "frequency_value": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_FREQUENCY_VALUE);
+            case "hourly_stats_aggregated_by_advertiser_time_zone": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_HOURLY_STATS_AGGREGATED_BY_ADVERTISER_TIME_ZONE);
+            case "hourly_stats_aggregated_by_audience_time_zone": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_HOURLY_STATS_AGGREGATED_BY_AUDIENCE_TIME_ZONE);
+            case "place_page_id": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_PLACE_PAGE_ID);
+            case "publisher_platform": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_PUBLISHER_PLATFORM);
+            case "platform_position": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_PLATFORM_POSITION);
+            case "device_platform": return new Breakdown(AdsInsights.EnumBreakdowns.VALUE_DEVICE_PLATFORM);
+            default: throw new ConfigException(String.format("Unknown Breakdown value '%s'", value));
+        }
+    }
+
+    public AdsInsights.EnumBreakdowns getEnum()
+    {
+        return this.enumBreakdowns;
+    }
+}