Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesVisit

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 visit.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V23ResourcesVisit

Returns a new instance of GoogleAdsSearchads360V23ResourcesVisit.



34687
34688
34689
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34687

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

Instance Attribute Details

#ad_id ⇒ Fixnum

Output only. Ad ID. A value of 0 indicates that the ad is unattributed. Corresponds to the JSON property adId

Returns:

  • (Fixnum) 


34609
34610
34611
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34609

def ad_id
  @ad_id
end

#asset_field_type ⇒ String

Output only. Asset field type of the visit event. Corresponds to the JSON property assetFieldType

Returns:

  • (String) 


34614
34615
34616
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34614

def asset_field_type
  @asset_field_type
end

#asset_id ⇒ Fixnum

Output only. ID of the asset which was interacted with during the visit event. Corresponds to the JSON property assetId

Returns:

  • (Fixnum) 


34619
34620
34621
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34619

def asset_id
  @asset_id
end

#click_id ⇒ String

Output only. A unique string for each visit that is passed to the landing page as the click id URL parameter. Corresponds to the JSON property clickId

Returns:

  • (String) 


34625
34626
34627
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34625

def click_id
  @click_id
end

#criterion_id ⇒ Fixnum

Output only. Search Ads 360 keyword ID. A value of 0 indicates that the keyword is unattributed. Corresponds to the JSON property criterionId

Returns:

  • (Fixnum) 


34631
34632
34633
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34631

def criterion_id
  @criterion_id
end

#id ⇒ Fixnum

Output only. The ID of the visit. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


34636
34637
34638
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34636

def id
  @id
end

#merchant_id ⇒ Fixnum

Output only. The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360. Corresponds to the JSON property merchantId

Returns:

  • (Fixnum) 


34643
34644
34645
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34643

def merchant_id
  @merchant_id
end

#product_channel ⇒ String

Output only. The sales channel of the product that was clicked on: Online or Local. Corresponds to the JSON property productChannel

Returns:

  • (String) 


34649
34650
34651
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34649

def product_channel
  @product_channel
end

#product_country_code ⇒ String

Output only. The country (ISO-3166 format) registered for the inventory feed that contains the product clicked on. Corresponds to the JSON property productCountryCode

Returns:

  • (String) 


34655
34656
34657
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34655

def product_country_code
  @product_country_code
end

#product_id ⇒ String

Output only. The ID of the product clicked on. Corresponds to the JSON property productId

Returns:

  • (String) 


34660
34661
34662
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34660

def product_id
  @product_id
end

#product_language_code ⇒ String

Output only. The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product. Corresponds to the JSON property productLanguageCode

Returns:

  • (String) 


34666
34667
34668
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34666

def product_language_code
  @product_language_code
end

#product_store_id ⇒ String

Output only. The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed. Corresponds to the JSON property productStoreId

Returns:

  • (String) 


34672
34673
34674
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34672

def product_store_id
  @product_store_id
end

#resource_name ⇒ String

Output only. The resource name of the visit. Visit resource names have the form: customers/customer_id/visits/ad_group_id~criterion_id~ ds_visit_id` Corresponds to the JSON propertyresourceName`

Returns:

  • (String) 


34679
34680
34681
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34679

def resource_name
  @resource_name
end

#visit_date_time ⇒ String

Output only. The timestamp of the visit event. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Corresponds to the JSON property visitDateTime

Returns:

  • (String) 


34685
34686
34687
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34685

def visit_date_time
  @visit_date_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



34692
34693
34694
34695
34696
34697
34698
34699
34700
34701
34702
34703
34704
34705
34706
34707
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 34692

def update!(**args)
  @ad_id = args[:ad_id] if args.key?(:ad_id)
  @asset_field_type = args[:asset_field_type] if args.key?(:asset_field_type)
  @asset_id = args[:asset_id] if args.key?(:asset_id)
  @click_id = args[:click_id] if args.key?(:click_id)
  @criterion_id = args[:criterion_id] if args.key?(:criterion_id)
  @id = args[:id] if args.key?(:id)
  @merchant_id = args[:merchant_id] if args.key?(:merchant_id)
  @product_channel = args[:product_channel] if args.key?(:product_channel)
  @product_country_code = args[:product_country_code] if args.key?(:product_country_code)
  @product_id = args[:product_id] if args.key?(:product_id)
  @product_language_code = args[:product_language_code] if args.key?(:product_language_code)
  @product_store_id = args[:product_store_id] if args.key?(:product_store_id)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @visit_date_time = args[:visit_date_time] if args.key?(:visit_date_time)
end