// Generated by delombok at Tue Dec 10 13:42:03 UTC 2024
/*
 * Copyright (c) 2010-2024 Mark Allen, Norbert Bartels.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.restfb.types.ads;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import com.restfb.Facebook;

/**
 */
public class AdKeywordStats extends NamedAdsObject {
  private static final long serialVersionUID = 1L;
  /**
   * The number of times your ad was served. On our mobile apps an ad is counted as served the first time it's viewed.
   * On all other Facebook interfaces, an ad is served the first time it's placed in a person's News Feed or each time
   * it's placed in the right column.
   */
  @Facebook
  private Integer impressions;
  /**
   * The number of people your ad was served to.
   */
  @Facebook("unique_impressions")
  private Integer uniqueImpressions;
  /**
   * The number of people your ad was served to.
   */
  @Facebook
  private Integer reach;
  /**
   * The total number of clicks on your ad. Depending on what you're promoting, this can include Page likes, event
   * responses or app installs.
   */
  @Facebook
  private Integer clicks;
  /**
   * The total number of unique people who have clicked on your ad. For example, if 3 people click on the same ad 5
   * times, it will count as 3 unique clicks.
   */
  @Facebook("unique_clicks")
  private Integer uniqueClicks;
  /**
   * The number of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't
   * click on it. Actions include Page likes, app installs, conversions, event responses and more. For example, 2 Page
   * likes and 2 comments would be counted as 4 actions.
   */
  @Facebook("total_actions")
  private Integer totalActions;
  /**
   * The number of unique people who took an action such as liking your Page or installing your app as a result of your
   * ad. For example, if the same person likes and comments on a post, they will be counted as 1 unique person.
   */
  @Facebook("total_unique_actions")
  private Integer totalUniqueActions;
  /**
   * The number of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't
   * click on it. Actions include Page likes, app installs, conversions, event responses and more. For example, 2 Page
   * likes and 2 comments would be counted as 4 actions.
   */
  @Facebook
  private List<AdsActionStats> actions = new ArrayList<>();

  public List<AdsActionStats> getActions() {
    return Collections.unmodifiableList(actions);
  }

  public boolean addAction(AdsActionStats action) {
    return actions.add(action);
  }

  public boolean removeAction(AdsActionStats action) {
    return actions.remove(action);
  }

  /**
   * The number of unique people who took an action such as liking your Page or installing your app as a result of your
   * ad. For example, if the same person likes and comments on a post, they will be counted as 1 unique person.
   */
  @Facebook("unique_actions")
  private List<AdsActionStats> uniqueActions = new ArrayList<>();

  public List<AdsActionStats> getUniqueActions() {
    return Collections.unmodifiableList(uniqueActions);
  }

  public boolean addUniqueAction(AdsActionStats uniqueAction) {
    return uniqueActions.add(uniqueAction);
  }

  public boolean removeUniqueAction(AdsActionStats uniqueAction) {
    return uniqueActions.remove(uniqueAction);
  }

  /**
   * The total amount you've spent so far.
   */
  @Facebook
  private Double spend;
  /**
   * The number of clicks you received divided by the number of impressions.
   */
  @Facebook
  private Double ctr;
  /**
   * The number of people who clicked on your ad divided by the number of people you reached. For example, if you
   * received 20 unique clicks and your ad was served to 1,000 unique people, your unique click-through rate would be
   * 2%.
   */
  @Facebook("unique_ctr")
  private Double uniqueCtr;
  /**
   * The average cost you've paid to have 1,000 impressions on your ad.
   */
  @Facebook
  private Double cpm;
  /**
   * The average cost you've paid to have your ad served to 1,000 unique people.
   */
  @Facebook
  private Double cpp;
  /**
   * The average cost per click for these ads, calculated as the amount spent divided by the number of clicks received.
   */
  @Facebook
  private Double cpc;
  /**
   * The average you've spent on actions. For example, if you spent $20 and you got 10 Page likes, each one cost an
   * average of $2.
   */
  @Facebook("cost_per_total_action")
  private Double costPerTotalAction;
  /**
   * The average cost per unique click for these ads, calculated as the amount spent divided by the number of unique
   * clicks received.
   */
  @Facebook("cost_per_unique_click")
  private Double costPerUniqueClick;
  /**
   * The average number of times your ad was served to each person.
   */
  @Facebook
  private Double frequency;

  /**
   * The number of times your ad was served. On our mobile apps an ad is counted as served the first time it's viewed.
   * On all other Facebook interfaces, an ad is served the first time it's placed in a person's News Feed or each time
   * it's placed in the right column.
   */
  @java.lang.SuppressWarnings("all")
  public Integer getImpressions() {
    return this.impressions;
  }

  /**
   * The number of times your ad was served. On our mobile apps an ad is counted as served the first time it's viewed.
   * On all other Facebook interfaces, an ad is served the first time it's placed in a person's News Feed or each time
   * it's placed in the right column.
   */
  @java.lang.SuppressWarnings("all")
  public void setImpressions(final Integer impressions) {
    this.impressions = impressions;
  }

  /**
   * The number of people your ad was served to.
   */
  @java.lang.SuppressWarnings("all")
  public Integer getUniqueImpressions() {
    return this.uniqueImpressions;
  }

  /**
   * The number of people your ad was served to.
   */
  @java.lang.SuppressWarnings("all")
  public void setUniqueImpressions(final Integer uniqueImpressions) {
    this.uniqueImpressions = uniqueImpressions;
  }

  /**
   * The number of people your ad was served to.
   */
  @java.lang.SuppressWarnings("all")
  public Integer getReach() {
    return this.reach;
  }

  /**
   * The number of people your ad was served to.
   */
  @java.lang.SuppressWarnings("all")
  public void setReach(final Integer reach) {
    this.reach = reach;
  }

  /**
   * The total number of clicks on your ad. Depending on what you're promoting, this can include Page likes, event
   * responses or app installs.
   */
  @java.lang.SuppressWarnings("all")
  public Integer getClicks() {
    return this.clicks;
  }

  /**
   * The total number of clicks on your ad. Depending on what you're promoting, this can include Page likes, event
   * responses or app installs.
   */
  @java.lang.SuppressWarnings("all")
  public void setClicks(final Integer clicks) {
    this.clicks = clicks;
  }

  /**
   * The total number of unique people who have clicked on your ad. For example, if 3 people click on the same ad 5
   * times, it will count as 3 unique clicks.
   */
  @java.lang.SuppressWarnings("all")
  public Integer getUniqueClicks() {
    return this.uniqueClicks;
  }

  /**
   * The total number of unique people who have clicked on your ad. For example, if 3 people click on the same ad 5
   * times, it will count as 3 unique clicks.
   */
  @java.lang.SuppressWarnings("all")
  public void setUniqueClicks(final Integer uniqueClicks) {
    this.uniqueClicks = uniqueClicks;
  }

  /**
   * The number of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't
   * click on it. Actions include Page likes, app installs, conversions, event responses and more. For example, 2 Page
   * likes and 2 comments would be counted as 4 actions.
   */
  @java.lang.SuppressWarnings("all")
  public Integer getTotalActions() {
    return this.totalActions;
  }

  /**
   * The number of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't
   * click on it. Actions include Page likes, app installs, conversions, event responses and more. For example, 2 Page
   * likes and 2 comments would be counted as 4 actions.
   */
  @java.lang.SuppressWarnings("all")
  public void setTotalActions(final Integer totalActions) {
    this.totalActions = totalActions;
  }

  /**
   * The number of unique people who took an action such as liking your Page or installing your app as a result of your
   * ad. For example, if the same person likes and comments on a post, they will be counted as 1 unique person.
   */
  @java.lang.SuppressWarnings("all")
  public Integer getTotalUniqueActions() {
    return this.totalUniqueActions;
  }

  /**
   * The number of unique people who took an action such as liking your Page or installing your app as a result of your
   * ad. For example, if the same person likes and comments on a post, they will be counted as 1 unique person.
   */
  @java.lang.SuppressWarnings("all")
  public void setTotalUniqueActions(final Integer totalUniqueActions) {
    this.totalUniqueActions = totalUniqueActions;
  }

  /**
   * The total amount you've spent so far.
   */
  @java.lang.SuppressWarnings("all")
  public Double getSpend() {
    return this.spend;
  }

  /**
   * The total amount you've spent so far.
   */
  @java.lang.SuppressWarnings("all")
  public void setSpend(final Double spend) {
    this.spend = spend;
  }

  /**
   * The number of clicks you received divided by the number of impressions.
   */
  @java.lang.SuppressWarnings("all")
  public Double getCtr() {
    return this.ctr;
  }

  /**
   * The number of clicks you received divided by the number of impressions.
   */
  @java.lang.SuppressWarnings("all")
  public void setCtr(final Double ctr) {
    this.ctr = ctr;
  }

  /**
   * The number of people who clicked on your ad divided by the number of people you reached. For example, if you
   * received 20 unique clicks and your ad was served to 1,000 unique people, your unique click-through rate would be
   * 2%.
   */
  @java.lang.SuppressWarnings("all")
  public Double getUniqueCtr() {
    return this.uniqueCtr;
  }

  /**
   * The number of people who clicked on your ad divided by the number of people you reached. For example, if you
   * received 20 unique clicks and your ad was served to 1,000 unique people, your unique click-through rate would be
   * 2%.
   */
  @java.lang.SuppressWarnings("all")
  public void setUniqueCtr(final Double uniqueCtr) {
    this.uniqueCtr = uniqueCtr;
  }

  /**
   * The average cost you've paid to have 1,000 impressions on your ad.
   */
  @java.lang.SuppressWarnings("all")
  public Double getCpm() {
    return this.cpm;
  }

  /**
   * The average cost you've paid to have 1,000 impressions on your ad.
   */
  @java.lang.SuppressWarnings("all")
  public void setCpm(final Double cpm) {
    this.cpm = cpm;
  }

  /**
   * The average cost you've paid to have your ad served to 1,000 unique people.
   */
  @java.lang.SuppressWarnings("all")
  public Double getCpp() {
    return this.cpp;
  }

  /**
   * The average cost you've paid to have your ad served to 1,000 unique people.
   */
  @java.lang.SuppressWarnings("all")
  public void setCpp(final Double cpp) {
    this.cpp = cpp;
  }

  /**
   * The average cost per click for these ads, calculated as the amount spent divided by the number of clicks received.
   */
  @java.lang.SuppressWarnings("all")
  public Double getCpc() {
    return this.cpc;
  }

  /**
   * The average cost per click for these ads, calculated as the amount spent divided by the number of clicks received.
   */
  @java.lang.SuppressWarnings("all")
  public void setCpc(final Double cpc) {
    this.cpc = cpc;
  }

  /**
   * The average you've spent on actions. For example, if you spent $20 and you got 10 Page likes, each one cost an
   * average of $2.
   */
  @java.lang.SuppressWarnings("all")
  public Double getCostPerTotalAction() {
    return this.costPerTotalAction;
  }

  /**
   * The average you've spent on actions. For example, if you spent $20 and you got 10 Page likes, each one cost an
   * average of $2.
   */
  @java.lang.SuppressWarnings("all")
  public void setCostPerTotalAction(final Double costPerTotalAction) {
    this.costPerTotalAction = costPerTotalAction;
  }

  /**
   * The average cost per unique click for these ads, calculated as the amount spent divided by the number of unique
   * clicks received.
   */
  @java.lang.SuppressWarnings("all")
  public Double getCostPerUniqueClick() {
    return this.costPerUniqueClick;
  }

  /**
   * The average cost per unique click for these ads, calculated as the amount spent divided by the number of unique
   * clicks received.
   */
  @java.lang.SuppressWarnings("all")
  public void setCostPerUniqueClick(final Double costPerUniqueClick) {
    this.costPerUniqueClick = costPerUniqueClick;
  }

  /**
   * The average number of times your ad was served to each person.
   */
  @java.lang.SuppressWarnings("all")
  public Double getFrequency() {
    return this.frequency;
  }

  /**
   * The average number of times your ad was served to each person.
   */
  @java.lang.SuppressWarnings("all")
  public void setFrequency(final Double frequency) {
    this.frequency = frequency;
  }
}