lib/google_api/display_video/v1/model/first_and_third_party_audience.ex

# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.DisplayVideo.V1.Model.FirstAndThirdPartyAudience do
  @moduledoc """
  Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.

  ## Attributes

  *   `activeDisplayAudienceSize` (*type:* `String.t`, *default:* `nil`) - Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
  *   `audienceSource` (*type:* `String.t`, *default:* `nil`) - Output only. The source of the audience.
  *   `audienceType` (*type:* `String.t`, *default:* `nil`) - The type of the audience.
  *   `description` (*type:* `String.t`, *default:* `nil`) - The user-provided description of the audience. Only applicable to first party audiences.
  *   `displayAudienceSize` (*type:* `String.t`, *default:* `nil`) - Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
  *   `displayDesktopAudienceSize` (*type:* `String.t`, *default:* `nil`) - Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
  *   `displayMobileAppAudienceSize` (*type:* `String.t`, *default:* `nil`) - Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
  *   `displayMobileWebAudienceSize` (*type:* `String.t`, *default:* `nil`) - Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
  *   `displayName` (*type:* `String.t`, *default:* `nil`) - The display name of the first and third party audience.
  *   `firstAndThirdPartyAudienceId` (*type:* `String.t`, *default:* `nil`) - Output only. The unique ID of the first and third party audience. Assigned by the system.
  *   `firstAndThirdPartyAudienceType` (*type:* `String.t`, *default:* `nil`) - Whether the audience is a first or third party audience.
  *   `gmailAudienceSize` (*type:* `String.t`, *default:* `nil`) - Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
  *   `membershipDurationDays` (*type:* `String.t`, *default:* `nil`) - The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, the value of this field should be set 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
  *   `name` (*type:* `String.t`, *default:* `nil`) - Output only. The resource name of the first and third party audience.
  *   `youtubeAudienceSize` (*type:* `String.t`, *default:* `nil`) - Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :activeDisplayAudienceSize => String.t() | nil,
          :audienceSource => String.t() | nil,
          :audienceType => String.t() | nil,
          :description => String.t() | nil,
          :displayAudienceSize => String.t() | nil,
          :displayDesktopAudienceSize => String.t() | nil,
          :displayMobileAppAudienceSize => String.t() | nil,
          :displayMobileWebAudienceSize => String.t() | nil,
          :displayName => String.t() | nil,
          :firstAndThirdPartyAudienceId => String.t() | nil,
          :firstAndThirdPartyAudienceType => String.t() | nil,
          :gmailAudienceSize => String.t() | nil,
          :membershipDurationDays => String.t() | nil,
          :name => String.t() | nil,
          :youtubeAudienceSize => String.t() | nil
        }

  field(:activeDisplayAudienceSize)
  field(:audienceSource)
  field(:audienceType)
  field(:description)
  field(:displayAudienceSize)
  field(:displayDesktopAudienceSize)
  field(:displayMobileAppAudienceSize)
  field(:displayMobileWebAudienceSize)
  field(:displayName)
  field(:firstAndThirdPartyAudienceId)
  field(:firstAndThirdPartyAudienceType)
  field(:gmailAudienceSize)
  field(:membershipDurationDays)
  field(:name)
  field(:youtubeAudienceSize)
end

defimpl Poison.Decoder, for: GoogleApi.DisplayVideo.V1.Model.FirstAndThirdPartyAudience do
  def decode(value, options) do
    GoogleApi.DisplayVideo.V1.Model.FirstAndThirdPartyAudience.decode(value, options)
  end
end

defimpl Poison.Encoder, for: GoogleApi.DisplayVideo.V1.Model.FirstAndThirdPartyAudience do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end