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

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ AccountsCustomBatchRequestEntry

Returns a new instance of AccountsCustomBatchRequestEntry.


882
883
884
# File 'generated/google/apis/content_v2_1/classes.rb', line 882

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

Instance Attribute Details

#accountGoogle::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


824
825
826
# File 'generated/google/apis/content_v2_1/classes.rb', line 824

def 
  @account
end

#account_idFixnum

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

Returns:

  • (Fixnum)

829
830
831
# File 'generated/google/apis/content_v2_1/classes.rb', line 829

def 
  @account_id
end

#batch_idFixnum

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

Returns:

  • (Fixnum)

834
835
836
# File 'generated/google/apis/content_v2_1/classes.rb', line 834

def batch_id
  @batch_id
end

#forceBoolean 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)

840
841
842
# File 'generated/google/apis/content_v2_1/classes.rb', line 840

def force
  @force
end

#label_idsArray<Fixnum>

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

Returns:

  • (Array<Fixnum>)

846
847
848
# File 'generated/google/apis/content_v2_1/classes.rb', line 846

def label_ids
  @label_ids
end

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


851
852
853
# File 'generated/google/apis/content_v2_1/classes.rb', line 851

def link_request
  @link_request
end

#merchant_idFixnum

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

Returns:

  • (Fixnum)

856
857
858
# File 'generated/google/apis/content_v2_1/classes.rb', line 856

def merchant_id
  @merchant_id
end

#method_propString

The method of the batch entry. Acceptable values are:

  • "claimWebsite"
  • "delete"
  • "get"
  • "insert"
  • "link"
  • "update" Corresponds to the JSON property method

Returns:

  • (String)

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

def method_prop
  @method_prop
end

#overwriteBoolean 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)

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

def overwrite
  @overwrite
end

#viewString

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

Returns:

  • (String)

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

def view
  @view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


887
888
889
890
891
892
893
894
895
896
897
898
# File 'generated/google/apis/content_v2_1/classes.rb', line 887

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