• Home
• com.facebook.business.sdk
• facebook-java-business-sdk
• 23.0.0
• source code
• InsightsResult.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.facebook.ads.sdk.InsightsResult Maven / Gradle / Ivy

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the license found in the
 * LICENSE file in the root directory of this source tree.
 */

package com.facebook.ads.sdk;

import java.io.File;
import java.lang.reflect.Modifier;
import java.lang.reflect.Type;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.google.common.base.Function;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.common.util.concurrent.SettableFuture;
import com.google.gson.JsonObject;
import com.google.gson.JsonArray;
import com.google.gson.annotations.SerializedName;
import com.google.gson.reflect.TypeToken;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonElement;
import com.google.gson.JsonParser;

import com.facebook.ads.sdk.APIException.MalformedResponseException;

/**
 * This class is auto-generated.
 *
 * For any issues or feature requests related to this class, please let us know
 * on github and we'll fix in our codegen framework. We'll not be able to accept
 * pull request for this class.
 *
 */
public class InsightsResult extends APINode {
  @SerializedName("description")
  private String mDescription = null;
  @SerializedName("description_from_api_doc")
  private String mDescriptionFromApiDoc = null;
  @SerializedName("id")
  private String mId = null;
  @SerializedName("name")
  private String mName = null;
  @SerializedName("period")
  private String mPeriod = null;
  @SerializedName("title")
  private String mTitle = null;
  @SerializedName("values")
  private List mValues = null;
  protected static Gson gson = null;

  public InsightsResult() {
  }

  public String getId() {
    return getFieldId().toString();
  }
  public static InsightsResult loadJSON(String json, APIContext context, String header) {
    InsightsResult insightsResult = getGson().fromJson(json, InsightsResult.class);
    if (context.isDebug()) {
      JsonParser parser = new JsonParser();
      JsonElement o1 = parser.parse(json);
      JsonElement o2 = parser.parse(insightsResult.toString());
      if (o1.getAsJsonObject().get("__fb_trace_id__") != null) {
        o2.getAsJsonObject().add("__fb_trace_id__", o1.getAsJsonObject().get("__fb_trace_id__"));
      }
      if (!o1.equals(o2)) {
        context.log("[Warning] When parsing response, object is not consistent with JSON:");
        context.log("[JSON]" + o1);
        context.log("[Object]" + o2);
      }
    }
    insightsResult.context = context;
    insightsResult.rawValue = json;
    insightsResult.header = header;
    return insightsResult;
  }

  public static APINodeList parseResponse(String json, APIContext context, APIRequest request, String header) throws MalformedResponseException {
    APINodeList insightsResults = new APINodeList(request, json, header);
    JsonArray arr;
    JsonObject obj;
    JsonParser parser = new JsonParser();
    Exception exception = null;
    try{
      JsonElement result = parser.parse(json);
      if (result.isJsonArray()) {
        // First, check if it's a pure JSON Array
        arr = result.getAsJsonArray();
        for (int i = 0; i < arr.size(); i++) {
          insightsResults.add(loadJSON(arr.get(i).getAsJsonObject().toString(), context, header));
        };
        return insightsResults;
      } else if (result.isJsonObject()) {
        obj = result.getAsJsonObject();
        if (obj.has("data")) {
          if (obj.has("paging")) {
            JsonObject paging = obj.get("paging").getAsJsonObject();
            if (paging.has("cursors")) {
                JsonObject cursors = paging.get("cursors").getAsJsonObject();
                String before = cursors.has("before") ? cursors.get("before").getAsString() : null;
                String after = cursors.has("after") ? cursors.get("after").getAsString() : null;
                insightsResults.setCursors(before, after);
            }
            String previous = paging.has("previous") ? paging.get("previous").getAsString() : null;
            String next = paging.has("next") ? paging.get("next").getAsString() : null;
            insightsResults.setPaging(previous, next);
            if (context.hasAppSecret()) {
              insightsResults.setAppSecret(context.getAppSecretProof());
            }
          }
          if (obj.get("data").isJsonArray()) {
            // Second, check if it's a JSON array with "data"
            arr = obj.get("data").getAsJsonArray();
            for (int i = 0; i < arr.size(); i++) {
              insightsResults.add(loadJSON(arr.get(i).getAsJsonObject().toString(), context, header));
            };
          } else if (obj.get("data").isJsonObject()) {
            // Third, check if it's a JSON object with "data"
            obj = obj.get("data").getAsJsonObject();
            boolean isRedownload = false;
            for (String s : new String[]{"campaigns", "adsets", "ads"}) {
              if (obj.has(s)) {
                isRedownload = true;
                obj = obj.getAsJsonObject(s);
                for (Map.Entry entry : obj.entrySet()) {
                  insightsResults.add(loadJSON(entry.getValue().toString(), context, header));
                }
                break;
              }
            }
            if (!isRedownload) {
              insightsResults.add(loadJSON(obj.toString(), context, header));
            }
          }
          return insightsResults;
        } else if (obj.has("images")) {
          // Fourth, check if it's a map of image objects
          obj = obj.get("images").getAsJsonObject();
          for (Map.Entry entry : obj.entrySet()) {
              insightsResults.add(loadJSON(entry.getValue().toString(), context, header));
          }
          return insightsResults;
        } else {
          // Fifth, check if it's an array of objects indexed by id
          boolean isIdIndexedArray = true;
          for (Map.Entry entry : obj.entrySet()) {
            String key = (String) entry.getKey();
            if (key.equals("__fb_trace_id__")) {
              continue;
            }
            JsonElement value = (JsonElement) entry.getValue();
            if (
              value != null &&
              value.isJsonObject() &&
              value.getAsJsonObject().has("id") &&
              value.getAsJsonObject().get("id") != null &&
              value.getAsJsonObject().get("id").getAsString().equals(key)
            ) {
              insightsResults.add(loadJSON(value.toString(), context, header));
            } else {
              isIdIndexedArray = false;
              break;
            }
          }
          if (isIdIndexedArray) {
            return insightsResults;
          }

          // Sixth, check if it's pure JsonObject
          insightsResults.clear();
          insightsResults.add(loadJSON(json, context, header));
          return insightsResults;
        }
      }
    } catch (Exception e) {
      exception = e;
    }
    throw new MalformedResponseException(
      "Invalid response string: " + json,
      exception
    );
  }

  @Override
  public APIContext getContext() {
    return context;
  }

  @Override
  public void setContext(APIContext context) {
    this.context = context;
  }

  @Override
  public String toString() {
    return getGson().toJson(this);
  }


  public String getFieldDescription() {
    return mDescription;
  }

  public InsightsResult setFieldDescription(String value) {
    this.mDescription = value;
    return this;
  }

  public String getFieldDescriptionFromApiDoc() {
    return mDescriptionFromApiDoc;
  }

  public InsightsResult setFieldDescriptionFromApiDoc(String value) {
    this.mDescriptionFromApiDoc = value;
    return this;
  }

  public String getFieldId() {
    return mId;
  }

  public InsightsResult setFieldId(String value) {
    this.mId = value;
    return this;
  }

  public String getFieldName() {
    return mName;
  }

  public InsightsResult setFieldName(String value) {
    this.mName = value;
    return this;
  }

  public String getFieldPeriod() {
    return mPeriod;
  }

  public InsightsResult setFieldPeriod(String value) {
    this.mPeriod = value;
    return this;
  }

  public String getFieldTitle() {
    return mTitle;
  }

  public InsightsResult setFieldTitle(String value) {
    this.mTitle = value;
    return this;
  }

  public List getFieldValues() {
    return mValues;
  }

  public InsightsResult setFieldValues(List value) {
    this.mValues = value;
    return this;
  }

  public InsightsResult setFieldValues(String value) {
    Type type = new TypeToken>(){}.getType();
    this.mValues = InsightsValue.getGson().fromJson(value, type);
    return this;
  }


  public static enum EnumBreakdown {
      @SerializedName("action_type")
      VALUE_ACTION_TYPE("action_type"),
      @SerializedName("follow_type")
      VALUE_FOLLOW_TYPE("follow_type"),
      @SerializedName("story_navigation_action_type")
      VALUE_STORY_NAVIGATION_ACTION_TYPE("story_navigation_action_type"),
      @SerializedName("surface_type")
      VALUE_SURFACE_TYPE("surface_type"),
      ;

      private String value;

      private EnumBreakdown(String value) {
        this.value = value;
      }

      @Override
      public String toString() {
        return value;
      }
  }

  public static enum EnumMetric {
      @SerializedName("clips_replays_count")
      VALUE_CLIPS_REPLAYS_COUNT("clips_replays_count"),
      @SerializedName("comments")
      VALUE_COMMENTS("comments"),
      @SerializedName("content_views")
      VALUE_CONTENT_VIEWS("content_views"),
      @SerializedName("follows")
      VALUE_FOLLOWS("follows"),
      @SerializedName("ig_reels_aggregated_all_plays_count")
      VALUE_IG_REELS_AGGREGATED_ALL_PLAYS_COUNT("ig_reels_aggregated_all_plays_count"),
      @SerializedName("ig_reels_avg_watch_time")
      VALUE_IG_REELS_AVG_WATCH_TIME("ig_reels_avg_watch_time"),
      @SerializedName("ig_reels_video_view_total_time")
      VALUE_IG_REELS_VIDEO_VIEW_TOTAL_TIME("ig_reels_video_view_total_time"),
      @SerializedName("impressions")
      VALUE_IMPRESSIONS("impressions"),
      @SerializedName("likes")
      VALUE_LIKES("likes"),
      @SerializedName("navigation")
      VALUE_NAVIGATION("navigation"),
      @SerializedName("plays")
      VALUE_PLAYS("plays"),
      @SerializedName("profile_activity")
      VALUE_PROFILE_ACTIVITY("profile_activity"),
      @SerializedName("profile_visits")
      VALUE_PROFILE_VISITS("profile_visits"),
      @SerializedName("quotes")
      VALUE_QUOTES("quotes"),
      @SerializedName("reach")
      VALUE_REACH("reach"),
      @SerializedName("replies")
      VALUE_REPLIES("replies"),
      @SerializedName("reposts")
      VALUE_REPOSTS("reposts"),
      @SerializedName("saved")
      VALUE_SAVED("saved"),
      @SerializedName("shares")
      VALUE_SHARES("shares"),
      @SerializedName("thread_replies")
      VALUE_THREAD_REPLIES("thread_replies"),
      @SerializedName("thread_shares")
      VALUE_THREAD_SHARES("thread_shares"),
      @SerializedName("threads_media_clicks")
      VALUE_THREADS_MEDIA_CLICKS("threads_media_clicks"),
      @SerializedName("threads_views")
      VALUE_THREADS_VIEWS("threads_views"),
      @SerializedName("total_interactions")
      VALUE_TOTAL_INTERACTIONS("total_interactions"),
      @SerializedName("views")
      VALUE_VIEWS("views"),
      ;

      private String value;

      private EnumMetric(String value) {
        this.value = value;
      }

      @Override
      public String toString() {
        return value;
      }
  }

  public static enum EnumPeriod {
      @SerializedName("day")
      VALUE_DAY("day"),
      @SerializedName("days_28")
      VALUE_DAYS_28("days_28"),
      @SerializedName("lifetime")
      VALUE_LIFETIME("lifetime"),
      @SerializedName("month")
      VALUE_MONTH("month"),
      @SerializedName("total_over_range")
      VALUE_TOTAL_OVER_RANGE("total_over_range"),
      @SerializedName("week")
      VALUE_WEEK("week"),
      ;

      private String value;

      private EnumPeriod(String value) {
        this.value = value;
      }

      @Override
      public String toString() {
        return value;
      }
  }

  public static enum EnumDatePreset {
      @SerializedName("data_maximum")
      VALUE_DATA_MAXIMUM("data_maximum"),
      @SerializedName("last_14d")
      VALUE_LAST_14D("last_14d"),
      @SerializedName("last_28d")
      VALUE_LAST_28D("last_28d"),
      @SerializedName("last_30d")
      VALUE_LAST_30D("last_30d"),
      @SerializedName("last_3d")
      VALUE_LAST_3D("last_3d"),
      @SerializedName("last_7d")
      VALUE_LAST_7D("last_7d"),
      @SerializedName("last_90d")
      VALUE_LAST_90D("last_90d"),
      @SerializedName("last_month")
      VALUE_LAST_MONTH("last_month"),
      @SerializedName("last_quarter")
      VALUE_LAST_QUARTER("last_quarter"),
      @SerializedName("last_week_mon_sun")
      VALUE_LAST_WEEK_MON_SUN("last_week_mon_sun"),
      @SerializedName("last_week_sun_sat")
      VALUE_LAST_WEEK_SUN_SAT("last_week_sun_sat"),
      @SerializedName("last_year")
      VALUE_LAST_YEAR("last_year"),
      @SerializedName("maximum")
      VALUE_MAXIMUM("maximum"),
      @SerializedName("this_month")
      VALUE_THIS_MONTH("this_month"),
      @SerializedName("this_quarter")
      VALUE_THIS_QUARTER("this_quarter"),
      @SerializedName("this_week_mon_today")
      VALUE_THIS_WEEK_MON_TODAY("this_week_mon_today"),
      @SerializedName("this_week_sun_today")
      VALUE_THIS_WEEK_SUN_TODAY("this_week_sun_today"),
      @SerializedName("this_year")
      VALUE_THIS_YEAR("this_year"),
      @SerializedName("today")
      VALUE_TODAY("today"),
      @SerializedName("yesterday")
      VALUE_YESTERDAY("yesterday"),
      ;

      private String value;

      private EnumDatePreset(String value) {
        this.value = value;
      }

      @Override
      public String toString() {
        return value;
      }
  }

  public static enum EnumMetricType {
      @SerializedName("default")
      VALUE_DEFAULT("default"),
      @SerializedName("time_series")
      VALUE_TIME_SERIES("time_series"),
      @SerializedName("total_value")
      VALUE_TOTAL_VALUE("total_value"),
      ;

      private String value;

      private EnumMetricType(String value) {
        this.value = value;
      }

      @Override
      public String toString() {
        return value;
      }
  }

  public static enum EnumTimeframe {
      @SerializedName("last_14_days")
      VALUE_LAST_14_DAYS("last_14_days"),
      @SerializedName("last_30_days")
      VALUE_LAST_30_DAYS("last_30_days"),
      @SerializedName("last_90_days")
      VALUE_LAST_90_DAYS("last_90_days"),
      @SerializedName("prev_month")
      VALUE_PREV_MONTH("prev_month"),
      @SerializedName("this_month")
      VALUE_THIS_MONTH("this_month"),
      @SerializedName("this_week")
      VALUE_THIS_WEEK("this_week"),
      ;

      private String value;

      private EnumTimeframe(String value) {
        this.value = value;
      }

      @Override
      public String toString() {
        return value;
      }
  }


  synchronized /*package*/ static Gson getGson() {
    if (gson != null) {
      return gson;
    } else {
      gson = new GsonBuilder()
        .excludeFieldsWithModifiers(Modifier.STATIC)
        .excludeFieldsWithModifiers(Modifier.PROTECTED)
        .disableHtmlEscaping()
        .create();
    }
    return gson;
  }

  public InsightsResult copyFrom(InsightsResult instance) {
    this.mDescription = instance.mDescription;
    this.mDescriptionFromApiDoc = instance.mDescriptionFromApiDoc;
    this.mId = instance.mId;
    this.mName = instance.mName;
    this.mPeriod = instance.mPeriod;
    this.mTitle = instance.mTitle;
    this.mValues = instance.mValues;
    this.context = instance.context;
    this.rawValue = instance.rawValue;
    return this;
  }

  public static APIRequest.ResponseParser getParser() {
    return new APIRequest.ResponseParser() {
      public APINodeList parseResponse(String response, APIContext context, APIRequest request, String header) throws MalformedResponseException {
        return InsightsResult.parseResponse(response, context, request, header);
      }
    };
  }
}