Class: Google::Apis::AdmobV1::AdUnit

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/admob_v1/classes.rb,
lib/google/apis/admob_v1/representations.rb,
lib/google/apis/admob_v1/representations.rb

Overview

Describes an AdMob ad unit.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AdUnit

Returns a new instance of AdUnit.



74
75
76
 
# File 'lib/google/apis/admob_v1/classes.rb', line 74

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#ad_format ⇒ String

AdFormat of the ad unit. Possible values are as follows: "APP_OPEN" - App Open ad format. "BANNER" - Banner ad format. "BANNER_INTERSTITIAL" - Legacy format that can be used as either banner or interstitial. This format can no longer be created but can be targeted by mediation groups. "INTERSTITIAL" - A full screen ad. Supported ad types are "RICH_MEDIA" and "VIDEO". "NATIVE" - Native ad format. "REWARDED" - An ad that, once viewed, gets a callback verifying the view so that a reward can be given to the user. Supported ad types are " RICH_MEDIA" (interactive) and video where video can not be excluded. " REWARDED_INTERSTITIAL" - Rewarded Interstitial ad format. Only supports video ad type. See https://support.google.com/admob/answer/9884467. Corresponds to the JSON property adFormat

Returns:

  • (String) 


41
42
43
 
# File 'lib/google/apis/admob_v1/classes.rb', line 41

def ad_format
  @ad_format
end

#ad_types ⇒ Array<String>

Ad media type supported by this ad unit. Possible values as follows: " RICH_MEDIA" - Text, image, and other non-video media. "VIDEO" - Video media. Corresponds to the JSON property adTypes

Returns:

  • (Array<String>) 


47
48
49
 
# File 'lib/google/apis/admob_v1/classes.rb', line 47

def ad_types
  @ad_types
end

#ad_unit_id ⇒ String

The externally visible ID of the ad unit which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub- 9876543210987654/0123456789 Corresponds to the JSON property adUnitId

Returns:

  • (String) 


54
55
56
 
# File 'lib/google/apis/admob_v1/classes.rb', line 54

def ad_unit_id
  @ad_unit_id
end

#app_id ⇒ String

The externally visible ID of the app this ad unit is associated with. Example: ca-app-pub-9876543210987654~0123456789 Corresponds to the JSON property appId

Returns:

  • (String) 


60
61
62
 
# File 'lib/google/apis/admob_v1/classes.rb', line 60

def app_id
  @app_id
end

#display_name ⇒ String

The display name of the ad unit as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


66
67
68
 
# File 'lib/google/apis/admob_v1/classes.rb', line 66

def display_name
  @display_name
end

#name ⇒ String

Resource name for this ad unit. Format is accounts/publisher_id/adUnits/ ad_unit_id_fragment Example: accounts/pub-9876543210987654/adUnits/0123456789 Corresponds to the JSON property name

Returns:

  • (String) 


72
73
74
 
# File 'lib/google/apis/admob_v1/classes.rb', line 72

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



79
80
81
82
83
84
85
86
 
# File 'lib/google/apis/admob_v1/classes.rb', line 79

def update!(**args)
  @ad_format = args[:ad_format] if args.key?(:ad_format)
  @ad_types = args[:ad_types] if args.key?(:ad_types)
  @ad_unit_id = args[:ad_unit_id] if args.key?(:ad_unit_id)
  @app_id = args[:app_id] if args.key?(:app_id)
  @display_name = args[:display_name] if args.key?(:display_name)
  @name = args[:name] if args.key?(:name)
end