jp.co.yahoo.adssearchapi.v13.model.AuditLogServiceEventSelector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ads-search-api-lib Show documentation
Yahoo! JAPAN Ads Search Ads API library for Java
The newest version!
/*
 * Yahoo!広告 検索広告 API リファレンス / Yahoo! JAPAN Ads Search Ads API Reference
 * Yahoo!広告 検索広告 APIのWebサービスについて説明します。
 Search Ads API Web Services supported in Yahoo! JAPAN Ads API.
 OpenAPI Specification
 Best Practice
 Best Practice 
 *
 * The version of the OpenAPI document: v13
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


package jp.co.yahoo.adssearchapi.v13.model;

import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.ArrayList;
import java.util.List;
import jp.co.yahoo.adssearchapi.v13.model.AuditLogServiceEventTypes;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;

/**
 * <div lang=\"ja\">AuditLogServiceEventSelectorオブジェクトは、操作履歴の取得対象を設定します。<br> このフィールドは、必須です。<br> 1~25件の指定が可能です。</div> <div lang=\"en\">AuditLogServiceEventSelector object enables the target setting of acquiring operation history.<br> This field is required.<br> 1 to 25 items can be specified.</div> 
 */
@ApiModel(description = "AuditLogServiceEventSelectorオブジェクトは、操作履歴の取得対象を設定します。
 このフィールドは、必須です。
 1~25件の指定が可能です。
 AuditLogServiceEventSelector object enables the target setting of acquiring operation history.
 This field is required.
 1 to 25 items can be specified. ")
@JsonPropertyOrder({
  AuditLogServiceEventSelector.JSON_PROPERTY_ENTITY_TYPE,
  AuditLogServiceEventSelector.JSON_PROPERTY_EVENT_TYPES
})
@JsonTypeName("AuditLogServiceEventSelector")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class AuditLogServiceEventSelector {
  public static final String JSON_PROPERTY_ENTITY_TYPE = "entityType";
  private String entityType;

  public static final String JSON_PROPERTY_EVENT_TYPES = "eventTypes";
  private List eventTypes = null;

  public AuditLogServiceEventSelector() { 
  }

  public AuditLogServiceEventSelector entityType(String entityType) {
    
    this.entityType = entityType;
    return this;
  }

   /**
   * <div lang=\"ja\">AuditLogServiceEntityTypeオブジェクトは、操作履歴に出力するエンティティの種類を表します。</div> <div lang=\"en\">AuditLogServiceEntityType object describes the type of entities to be output on the data of operation history.</div> <dl class=term>   <dt class=\"term__item\">CAMPAIGN</dt>   <dd class=\"term__desc\"><span lang=\"ja\">キャンペーンです。</span><span lang=\"en\">Campaign.</span></dd>   <dt class=\"term__item\">NEGATIVE_CAMPAIGN_CRITERION</dt>   <dd class=\"term__desc\"><span lang=\"ja\">対象外キーワードです（キャンペーン）。</span><span lang=\"en\">Negative keywords (for campaign).</span></dd>   <dt class=\"term__item\">CAMPAIGN_CRITERION</dt>   <dd class=\"term__desc\"><span lang=\"ja\">キャンペーンのターゲティング設定です。</span><span lang=\"en\">Targeting setting on campaign.</span></dd>   <dt class=\"term__item\">AD_GROUP</dt>   <dd class=\"term__desc\"><span lang=\"ja\">広告グループです。</span><span lang=\"en\">Ad group.</span></dd>   <dt class=\"term__item\">AD_GROUP_BID_MULTIPLIER</dt>   <dd class=\"term__desc\"><span lang=\"ja\">広告グループ入札価格調整率です。</span><span lang=\"en\">Bid adjustment for ad group.</span></dd>   <dt class=\"term__item\">BIDDABLE_AD_GROUP_CRITERION</dt>   <dd class=\"term__desc\"><span lang=\"ja\">入札キーワードです。</span><span lang=\"en\">Bidding keyword.</span></dd>   <dt class=\"term__item\">NEGATIVE_AD_GROUP_CRITERION</dt>   <dd class=\"term__desc\"><span lang=\"ja\">対象外キーワードです（広告グループ）。</span><span lang=\"en\">Negative keywords (for ad group).</span></dd>   <dt class=\"term__item\">AD</dt>   <dd class=\"term__desc\"><span lang=\"ja\">広告です。</span><span lang=\"en\">Ad.</span></dd>   <dt class=\"term__item\">FEED</dt>   <dd class=\"term__desc\"><span lang=\"ja\">Feedフォルダーです。</span><span lang=\"en\">Feed folder.</span></dd>   <dt class=\"term__item\">FEED_ITEM</dt>   <dd class=\"term__desc\"><span lang=\"ja\">広告表示アセットです。</span><span lang=\"en\">Ad display assets.</span></dd>   <dt class=\"term__item\">CAMPAIGN_FEED</dt>   <dd class=\"term__desc\"><span lang=\"ja\">広告表示アセットです（キャンペーン）。</span><span lang=\"en\">Ad display assets for campaign.</span></dd>   <dt class=\"term__item\">AD_GROUP_FEED</dt>   <dd class=\"term__desc\"><span lang=\"ja\">広告表示アセットです（広告グループ）。</span><span lang=\"en\">Ad display assets for ad group.</span></dd>   <dt class=\"term__item\">SS_IO</dt>   <dd class=\"term__desc\"><span lang=\"ja\">アカウントです。</span><span lang=\"en\">Account.</span></dd>   <dt class=\"term__item\">SS_CONVERSION</dt>   <dd class=\"term__desc\"><span lang=\"ja\">コンバージョントラッカー（コンバージョン測定）です。</span><span lang=\"en\">Conversion tracker for conversion tracking.</span></dd>   <dt class=\"term__item\">BIDDING_STRATEGY</dt>   <dd class=\"term__desc\"><span lang=\"ja\">自動入札設定です。</span><span lang=\"en\">Auto bidding setting.</span></dd>   <dt class=\"term__item\">NEGATIVE_CAMPAIGN_USER_LIST</dt>   <dd class=\"term__desc\"><span lang=\"ja\">対象外ターゲットリストです（キャンペーン）。</span><span lang=\"en\">Exclude target list for campaign.</span></dd>   <dt class=\"term__item\">NEGATIVE_AD_GROUP_USER_LIST</dt>   <dd class=\"term__desc\"><span lang=\"ja\">対象外ターゲットリストです（広告グループ）。</span><span lang=\"en\">Exclude target list for ad group.</span></dd>   <dt class=\"term__item\">AD_GROUP_USER_LIST</dt>   <dd class=\"term__desc\"><span lang=\"ja\">ターゲットリストです（広告グループ）。</span><span lang=\"en\">Target list for ad group.</span></dd>   <dt class=\"term__item\">TARGET_LIST</dt>   <dd class=\"term__desc\"><span lang=\"ja\">サイトリターゲテイングのターゲットリストです。</span><span lang=\"en\">Target list of Site Retargeting.</span></dd>   <dt class=\"term__item\">SHARED_SET</dt>   <dd class=\"term__desc\"><span lang=\"ja\">共有リストです。</span><span lang=\"en\">Shared list.</span></dd>   <dt class=\"term__item\">SHARED_CRITERION</dt>   <dd class=\"term__desc\"><span lang=\"ja\">共有キーワードです。</span><span lang=\"en\">Shared keywords.</span></dd>   <dt class=\"term__item\">CAMPAIGN_SHARED_SET</dt>   <dd class=\"term__desc\"><span lang=\"ja\">キャンペーン共有リストです。</span><span lang=\"en\">Shared list for campaign.</span></dd>   <dt class=\"term__item\">AD_CUSTOMIZER</dt>   <dd class=\"term__desc\"><span lang=\"ja\">アドカスタマイザーです。</span><span lang=\"en\">Ad customizer.</span></dd>   <dt class=\"term__item\">EXCLUDE_AD_CUSTOMIZER</dt>   <dd class=\"term__desc\"><span lang=\"ja\">アドカスタマイザーを除くすべての履歴です。</span><span lang=\"en\">All operation history excepting ad customizer.</span></dd>   <dt class=\"term__item\">ASSET</dt>   <dd class=\"term__desc\"><span lang=\"ja\">アセット（広告表示アセット）です。</span><span lang=\"en\">Assets (Ad display asset).</span></dd>   <dt class=\"term__item\">CAMPAIGN_ASSET</dt>   <dd class=\"term__desc\"><span lang=\"ja\">キャンペーンとアセット間の設定情報です。</span><span lang=\"en\">Configuration information between campaign and assets.</span></dd>   <dt class=\"term__item\">AD_GROUP_ASSET</dt>   <dd class=\"term__desc\"><span lang=\"ja\">広告グループとアセット間の設定情報です。</span><span lang=\"en\">Configuration information between ad group and assets.</span></dd>   <dt class=\"term__item\">ACCOUNT_CUSTOMIZER</dt>   <dd class=\"term__desc\"><span lang=\"ja\">アカウントとカスタマイザー属性間の設定情報です。</span><span lang=\"en\">Configuration information between account and customizer attributes.</span></dd>   <dt class=\"term__item\">CAMPAIGN_CUSTOMIZER</dt>   <dd class=\"term__desc\"><span lang=\"ja\">キャンペーンとカスタマイザー属性間の設定情報です。</span><span lang=\"en\">Configuration information between campaign and customizer attributes.</span></dd>   <dt class=\"term__item\">AD_GROUP_CUSTOMIZER</dt>   <dd class=\"term__desc\"><span lang=\"ja\">広告グループとカスタマイザー属性間の設定情報です。</span><span lang=\"en\">Configuration information between ad group and customizer attributes.</span></dd>   <dt class=\"term__item\">AD_GROUP_CRITERION_CUSTOMIZER</dt>   <dd class=\"term__desc\"><span lang=\"ja\">キーワードとカスタマイザー属性間の設定情報です。</span><span lang=\"en\">Configuration information between keyword and customizer attributes.</span></dd>   <dt class=\"term__item\">CUSTOMIZER_ATTRIBUTE</dt>   <dd class=\"term__desc\"><span lang=\"ja\">カスタマイザー属性です。</span><span lang=\"en\">Customizer attributes.</span></dd>   <dt class=\"term__item\">PAGE_FEED_ASSET_SET</dt>   <dd class=\"term__desc\"><span lang=\"ja\">ページフィードアセットセットです。</span><span lang=\"en\">PageFeedAssetSet.</span></dd>   <dt class=\"term__item\">PAGE_FEED_ASSET</dt>   <dd class=\"term__desc\"><span lang=\"ja\">ページフィードアセットです。</span><span lang=\"en\">PageFeedAsset.</span></dd>   <dt class=\"term__item\">BIDDING_SEASONALITY_ADJUSTMENT</dt>   <dd class=\"term__desc\"><span lang=\"ja\">自動入札のスポット調整です。</span><span lang=\"en\">Bidding Seasonality Adjustment.</span></dd>   <dt class=\"term__item\">CAMPAIGN_BUDGET</dt>   <dd class=\"term__desc\"><span lang=\"ja\">キャンペーン間の共有予算です。</span><span lang=\"en\">Shared budgets.</span></dd>   <dt class=\"term__item\">ALL</dt>   <dd class=\"term__desc\"><span lang=\"ja\">すべての履歴です。</span><span lang=\"en\">All operation history.</span></dd>   <dt class=\"term__item\">UNKNOWN</dt>   <dd class=\"term__desc\"><span lang=\"ja\">未知の値です。</span><span lang=\"en\">Unknown value.</span></dd> </dl> 
   * @return entityType
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "AuditLogServiceEntityTypeオブジェクトは、操作履歴に出力するエンティティの種類を表します。
 AuditLogServiceEntityType object describes the type of entities to be output on the data of operation history.
    CAMPAIGN
   キャンペーンです。Campaign.
   NEGATIVE_CAMPAIGN_CRITERION
   対象外キーワードです（キャンペーン）。Negative keywords (for campaign).
   CAMPAIGN_CRITERION
   キャンペーンのターゲティング設定です。Targeting setting on campaign.
   AD_GROUP
   広告グループです。Ad group.
   AD_GROUP_BID_MULTIPLIER
   広告グループ入札価格調整率です。Bid adjustment for ad group.
   BIDDABLE_AD_GROUP_CRITERION
   入札キーワードです。Bidding keyword.
   NEGATIVE_AD_GROUP_CRITERION
   対象外キーワードです（広告グループ）。Negative keywords (for ad group).
   AD
   広告です。Ad.
   FEED
   Feedフォルダーです。Feed folder.
   FEED_ITEM
   広告表示アセットです。Ad display assets.
   CAMPAIGN_FEED
   広告表示アセットです（キャンペーン）。Ad display assets for campaign.
   AD_GROUP_FEED
   広告表示アセットです（広告グループ）。Ad display assets for ad group.
   SS_IO
   アカウントです。Account.
   SS_CONVERSION
   コンバージョントラッカー（コンバージョン測定）です。Conversion tracker for conversion tracking.
   BIDDING_STRATEGY
   自動入札設定です。Auto bidding setting.
   NEGATIVE_CAMPAIGN_USER_LIST
   対象外ターゲットリストです（キャンペーン）。Exclude target list for campaign.
   NEGATIVE_AD_GROUP_USER_LIST
   対象外ターゲットリストです（広告グループ）。Exclude target list for ad group.
   AD_GROUP_USER_LIST
   ターゲットリストです（広告グループ）。Target list for ad group.
   TARGET_LIST
   サイトリターゲテイングのターゲットリストです。Target list of Site Retargeting.
   SHARED_SET
   共有リストです。Shared list.
   SHARED_CRITERION
   共有キーワードです。Shared keywords.
   CAMPAIGN_SHARED_SET
   キャンペーン共有リストです。Shared list for campaign.
   AD_CUSTOMIZER
   アドカスタマイザーです。Ad customizer.
   EXCLUDE_AD_CUSTOMIZER
   アドカスタマイザーを除くすべての履歴です。All operation history excepting ad customizer.
   ASSET
   アセット（広告表示アセット）です。Assets (Ad display asset).
   CAMPAIGN_ASSET
   キャンペーンとアセット間の設定情報です。Configuration information between campaign and assets.
   AD_GROUP_ASSET
   広告グループとアセット間の設定情報です。Configuration information between ad group and assets.
   ACCOUNT_CUSTOMIZER
   アカウントとカスタマイザー属性間の設定情報です。Configuration information between account and customizer attributes.
   CAMPAIGN_CUSTOMIZER
   キャンペーンとカスタマイザー属性間の設定情報です。Configuration information between campaign and customizer attributes.
   AD_GROUP_CUSTOMIZER
   広告グループとカスタマイザー属性間の設定情報です。Configuration information between ad group and customizer attributes.
   AD_GROUP_CRITERION_CUSTOMIZER
   キーワードとカスタマイザー属性間の設定情報です。Configuration information between keyword and customizer attributes.
   CUSTOMIZER_ATTRIBUTE
   カスタマイザー属性です。Customizer attributes.
   PAGE_FEED_ASSET_SET
   ページフィードアセットセットです。PageFeedAssetSet.
   PAGE_FEED_ASSET
   ページフィードアセットです。PageFeedAsset.
   BIDDING_SEASONALITY_ADJUSTMENT
   自動入札のスポット調整です。Bidding Seasonality Adjustment.
   CAMPAIGN_BUDGET
   キャンペーン間の共有予算です。Shared budgets.
   ALL
   すべての履歴です。All operation history.
   UNKNOWN
   未知の値です。Unknown value.
  ")
  @JsonProperty(JSON_PROPERTY_ENTITY_TYPE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getEntityType() {
    return entityType;
  }


  @JsonProperty(JSON_PROPERTY_ENTITY_TYPE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setEntityType(String entityType) {
    this.entityType = entityType;
  }


  public AuditLogServiceEventSelector eventTypes(List eventTypes) {
    
    this.eventTypes = eventTypes;
    return this;
  }

  public AuditLogServiceEventSelector addEventTypesItem(AuditLogServiceEventTypes eventTypesItem) {
    if (this.eventTypes == null) {
      this.eventTypes = new ArrayList<>();
    }
    this.eventTypes.add(eventTypesItem);
    return this;
  }

   /**
   * Get eventTypes
   * @return eventTypes
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "")
  @JsonProperty(JSON_PROPERTY_EVENT_TYPES)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getEventTypes() {
    return eventTypes;
  }


  @JsonProperty(JSON_PROPERTY_EVENT_TYPES)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setEventTypes(List eventTypes) {
    this.eventTypes = eventTypes;
  }


  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    AuditLogServiceEventSelector auditLogServiceEventSelector = (AuditLogServiceEventSelector) o;
    return Objects.equals(this.entityType, auditLogServiceEventSelector.entityType) &&
        Objects.equals(this.eventTypes, auditLogServiceEventSelector.eventTypes);
  }

  @Override
  public int hashCode() {
    return Objects.hash(entityType, eventTypes);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class AuditLogServiceEventSelector {\n");
    sb.append("    entityType: ").append(toIndentedString(entityType)).append("\n");
    sb.append("    eventTypes: ").append(toIndentedString(eventTypes)).append("\n");
    sb.append("}");
    return sb.toString();
  }

  /**
   * Convert the given object to string with each line indented by 4 spaces
   * (except the first line).
   */
  private String toIndentedString(Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }

}