Class: Vk::API::Ads::Methods::UpdateTargetGroup

Inherits:
Schema::Method
  • Object
show all
Defined in:
lib/vk/api/ads/methods/update_target_group.rb

Overview

Edits a retarget group.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Ads::Methods::UpdateTargetGroup

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :account_id (Integer) —

    Advertising account ID.

  • :client_id (Integer) —

    'Only for advertising agencies.' ; ID of the client with the advertising account where the group will be created.;

  • :target_group_id (Integer) —

    Group ID.

  • :name (String) —

    New name of the target group — a string up to 64 characters long.

  • :domain (String) —

    Domain of the site where user accounting code will be placed.

  • :lifetime (Integer) —

    'Only for the groups that get audience from sites with user accounting code.'; Time in days when users added to a retarget group will be automatically excluded from it. ; '0' – automatic exclusion is off.




# File 'lib/vk/api/ads/methods/update_target_group.rb', line 15

Instance Method Details

#account_id ⇒ Integer

Returns Advertising account ID.

Returns:

  • (Integer) —

    Advertising account ID.



28
 
# File 'lib/vk/api/ads/methods/update_target_group.rb', line 28

attribute :account_id, API::Types::Coercible::Int

#client_id ⇒ Integer

Returns 'Only for advertising agencies.' ; ID of the client with the advertising account where the group will be created.;.

Returns:

  • (Integer) —

    'Only for advertising agencies.' ; ID of the client with the advertising account where the group will be created.;



30
 
# File 'lib/vk/api/ads/methods/update_target_group.rb', line 30

attribute :client_id, API::Types::Coercible::Int.optional.default(nil)

#domain ⇒ String

Returns Domain of the site where user accounting code will be placed.

Returns:

  • (String) —

    Domain of the site where user accounting code will be placed.



36
 
# File 'lib/vk/api/ads/methods/update_target_group.rb', line 36

attribute :domain, API::Types::Coercible::String.optional.default(nil)

#lifetime ⇒ Integer

Returns 'Only for the groups that get audience from sites with user accounting code.'; Time in days when users added to a retarget group will be automatically excluded from it. ; '0' – automatic exclusion is off.

Returns:

  • (Integer) —

    'Only for the groups that get audience from sites with user accounting code.'; Time in days when users added to a retarget group will be automatically excluded from it. ; '0' – automatic exclusion is off.



38
 
# File 'lib/vk/api/ads/methods/update_target_group.rb', line 38

attribute :lifetime, API::Types::Coercible::Int.optional.default(nil)

#name ⇒ String

Returns New name of the target group — a string up to 64 characters long.

Returns:

  • (String) —

    New name of the target group — a string up to 64 characters long.



34
 
# File 'lib/vk/api/ads/methods/update_target_group.rb', line 34

attribute :name, API::Types::Coercible::String

#target_group_id ⇒ Integer

Returns Group ID.

Returns:

  • (Integer) —

    Group ID.



32
 
# File 'lib/vk/api/ads/methods/update_target_group.rb', line 32

attribute :target_group_id, API::Types::Coercible::Int