Class: Google::Apis::PartnersV2::Lead

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

Overview

A lead resource that represents an advertiser contact for a Company. These are usually generated via Google Partner Search (the advertiser portal).

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Lead

Returns a new instance of Lead



1204
1205
1206
# File 'generated/google/apis/partners_v2/classes.rb', line 1204

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

Instance Attribute Details

#adwords_customer_idFixnum

The AdWords Customer ID of the lead. Corresponds to the JSON property adwordsCustomerId

Returns:

  • (Fixnum)


1129
1130
1131
# File 'generated/google/apis/partners_v2/classes.rb', line 1129

def adwords_customer_id
  @adwords_customer_id
end

#commentsString

Comments lead source gave. Corresponds to the JSON property comments

Returns:

  • (String)


1134
1135
1136
# File 'generated/google/apis/partners_v2/classes.rb', line 1134

def comments
  @comments
end

#create_timeString

Timestamp of when this lead was created. Corresponds to the JSON property createTime

Returns:

  • (String)


1139
1140
1141
# File 'generated/google/apis/partners_v2/classes.rb', line 1139

def create_time
  @create_time
end

#emailString

Email address of lead source. Corresponds to the JSON property email

Returns:

  • (String)


1144
1145
1146
# File 'generated/google/apis/partners_v2/classes.rb', line 1144

def email
  @email
end

#family_nameString

Last name of lead source. Corresponds to the JSON property familyName

Returns:

  • (String)


1149
1150
1151
# File 'generated/google/apis/partners_v2/classes.rb', line 1149

def family_name
  @family_name
end

#given_nameString

First name of lead source. Corresponds to the JSON property givenName

Returns:

  • (String)


1154
1155
1156
# File 'generated/google/apis/partners_v2/classes.rb', line 1154

def given_name
  @given_name
end

#gps_motivationsArray<String>

List of reasons for using Google Partner Search and creating a lead. Corresponds to the JSON property gpsMotivations

Returns:

  • (Array<String>)


1159
1160
1161
# File 'generated/google/apis/partners_v2/classes.rb', line 1159

def gps_motivations
  @gps_motivations
end

#idString

ID of the lead. Corresponds to the JSON property id

Returns:

  • (String)


1164
1165
1166
# File 'generated/google/apis/partners_v2/classes.rb', line 1164

def id
  @id
end

#language_codeString

Language code of the lead's language preference, as defined by BCP 47 (IETF BCP 47, "Tags for Identifying Languages"). Corresponds to the JSON property languageCode

Returns:

  • (String)


1171
1172
1173
# File 'generated/google/apis/partners_v2/classes.rb', line 1171

def language_code
  @language_code
end

#marketing_opt_inBoolean Also known as: marketing_opt_in?

Whether or not the lead signed up for marketing emails Corresponds to the JSON property marketingOptIn

Returns:

  • (Boolean)


1176
1177
1178
# File 'generated/google/apis/partners_v2/classes.rb', line 1176

def marketing_opt_in
  @marketing_opt_in
end

#min_monthly_budgetGoogle::Apis::PartnersV2::Money

Represents an amount of money with its currency type. Corresponds to the JSON property minMonthlyBudget



1182
1183
1184
# File 'generated/google/apis/partners_v2/classes.rb', line 1182

def min_monthly_budget
  @min_monthly_budget
end

#phone_numberString

Phone number of lead source. Corresponds to the JSON property phoneNumber

Returns:

  • (String)


1187
1188
1189
# File 'generated/google/apis/partners_v2/classes.rb', line 1187

def phone_number
  @phone_number
end

#stateString

The lead's state in relation to the company. Corresponds to the JSON property state

Returns:

  • (String)


1192
1193
1194
# File 'generated/google/apis/partners_v2/classes.rb', line 1192

def state
  @state
end

#typeString

Type of lead. Corresponds to the JSON property type

Returns:

  • (String)


1197
1198
1199
# File 'generated/google/apis/partners_v2/classes.rb', line 1197

def type
  @type
end

#website_urlString

Website URL of lead source. Corresponds to the JSON property websiteUrl

Returns:

  • (String)


1202
1203
1204
# File 'generated/google/apis/partners_v2/classes.rb', line 1202

def website_url
  @website_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
# File 'generated/google/apis/partners_v2/classes.rb', line 1209

def update!(**args)
  @adwords_customer_id = args[:adwords_customer_id] if args.key?(:adwords_customer_id)
  @comments = args[:comments] if args.key?(:comments)
  @create_time = args[:create_time] if args.key?(:create_time)
  @email = args[:email] if args.key?(:email)
  @family_name = args[:family_name] if args.key?(:family_name)
  @given_name = args[:given_name] if args.key?(:given_name)
  @gps_motivations = args[:gps_motivations] if args.key?(:gps_motivations)
  @id = args[:id] if args.key?(:id)
  @language_code = args[:language_code] if args.key?(:language_code)
  @marketing_opt_in = args[:marketing_opt_in] if args.key?(:marketing_opt_in)
  @min_monthly_budget = args[:min_monthly_budget] if args.key?(:min_monthly_budget)
  @phone_number = args[:phone_number] if args.key?(:phone_number)
  @state = args[:state] if args.key?(:state)
  @type = args[:type] if args.key?(:type)
  @website_url = args[:website_url] if args.key?(:website_url)
end