Class: Google::Apis::ContentV2_1::AccountsCustomBatchRequestEntry

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

Overview

A batch entry encoding a single non-batch accounts request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AccountsCustomBatchRequestEntry

Returns a new instance of AccountsCustomBatchRequestEntry.



905
906
907
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 905

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

Instance Attribute Details

#account ⇒ Google::Apis::ContentV2_1::Account

Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role. Corresponds to the JSON property account

Returns:



853
854
855
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 853

def 
  @account
end

#account_id ⇒ Fixnum

The ID of the targeted account. Only defined if the method is not insert. Corresponds to the JSON property accountId

Returns:

  • (Fixnum) 


858
859
860
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 858

def 
  @account_id
end

#batch_id ⇒ Fixnum

An entry ID, unique within the batch request. Corresponds to the JSON property batchId

Returns:

  • (Fixnum) 


863
864
865
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 863

def batch_id
  @batch_id
end

#force ⇒ Boolean Also known as: force?

Whether the account should be deleted if the account has offers. Only applicable if the method is delete. Corresponds to the JSON property force

Returns:

  • (Boolean) 


869
870
871
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 869

def force
  @force
end

#label_ids ⇒ Array<Fixnum>

Label IDs for the 'updatelabels' request. Corresponds to the JSON property labelIds

Returns:

  • (Array<Fixnum>) 


875
876
877
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 875

def label_ids
  @label_ids
end

#link_request ⇒ Google::Apis::ContentV2_1::AccountsCustomBatchRequestEntryLinkRequest

Details about the link request. Corresponds to the JSON property linkRequest

Returns:



880
881
882
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 880

def link_request
  @link_request
end

#merchant_id ⇒ Fixnum

The ID of the managing account. Corresponds to the JSON property merchantId

Returns:

  • (Fixnum) 


885
886
887
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 885

def merchant_id
  @merchant_id
end

#method_prop ⇒ String

The method of the batch entry. Acceptable values are: - "claimWebsite" - " delete" - "get" - "insert" - "link" - "update" Corresponds to the JSON property method

Returns:

  • (String) 


891
892
893
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 891

def method_prop
  @method_prop
end

#overwrite ⇒ Boolean Also known as: overwrite?

Only applicable if the method is claimwebsite. Indicates whether or not to take the claim from another account in case there is a conflict. Corresponds to the JSON property overwrite

Returns:

  • (Boolean) 


897
898
899
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 897

def overwrite
  @overwrite
end

#view ⇒ String

Controls which fields are visible. Only applicable if the method is 'get'. Corresponds to the JSON property view

Returns:

  • (String) 


903
904
905
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 903

def view
  @view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



910
911
912
913
914
915
916
917
918
919
920
921
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 910

def update!(**args)
  @account = args[:account] if args.key?(:account)
  @account_id = args[:account_id] if args.key?(:account_id)
  @batch_id = args[:batch_id] if args.key?(:batch_id)
  @force = args[:force] if args.key?(:force)
  @label_ids = args[:label_ids] if args.key?(:label_ids)
  @link_request = args[:link_request] if args.key?(:link_request)
  @merchant_id = args[:merchant_id] if args.key?(:merchant_id)
  @method_prop = args[:method_prop] if args.key?(:method_prop)
  @overwrite = args[:overwrite] if args.key?(:overwrite)
  @view = args[:view] if args.key?(:view)
end