Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesCustomAudience

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

Overview

A custom audience. This is a list of users by interest. The unique key of a custom audience consists of the following fields: name. Violating the unique key constraint produces error: CustomAudienceError.NAME_ALREADY_USED

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V23ResourcesCustomAudience

Returns a new instance of GoogleAdsSearchads360V23ResourcesCustomAudience.



27275
27276
27277
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27275

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

Instance Attribute Details

#description ⇒ String

Description of this custom audience. Corresponds to the JSON property description

Returns:

  • (String) 


27236
27237
27238
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27236

def description
  @description
end

#id ⇒ Fixnum

Output only. ID of the custom audience. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


27241
27242
27243
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27241

def id
  @id
end

#members ⇒ Array<Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesCustomAudienceMember>

List of custom audience members that this custom audience is composed of. Members can be added during CustomAudience creation. If members are presented in UPDATE operation, existing members will be overridden. Corresponds to the JSON property members

Returns:



27248
27249
27250
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27248

def members
  @members
end

#name ⇒ String

Name of the custom audience. It should be unique for all custom audiences created by a customer. This field is required for creating operations. Corresponds to the JSON property name

Returns:

  • (String) 


27254
27255
27256
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27254

def name
  @name
end

#resource_name ⇒ String

Immutable. The resource name of the custom audience. Custom audience resource names have the form: customers/customer_id/customAudiences/ custom_audience_id` Corresponds to the JSON propertyresourceName`

Returns:

  • (String) 


27261
27262
27263
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27261

def resource_name
  @resource_name
end

#status ⇒ String

Output only. Status of this custom audience. Indicates whether the custom audience is enabled or removed. Corresponds to the JSON property status

Returns:

  • (String) 


27267
27268
27269
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27267

def status
  @status
end

#type ⇒ String

Type of the custom audience. ("INTEREST" OR "PURCHASE_INTENT" is not allowed for newly created custom audience but kept for existing audiences) Corresponds to the JSON property type

Returns:

  • (String) 


27273
27274
27275
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27273

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



27280
27281
27282
27283
27284
27285
27286
27287
27288
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27280

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @id = args[:id] if args.key?(:id)
  @members = args[:members] if args.key?(:members)
  @name = args[:name] if args.key?(:name)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @status = args[:status] if args.key?(:status)
  @type = args[:type] if args.key?(:type)
end