Class: Vk::API::Ads::Methods::CreateTargetGroup

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

Overview

Creates a group to re-target ads for users who visited advertiser's site (viewed information about the product, registered, etc.).

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

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

  • :name (String) —

    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) —

    'For groups with auditory created with pixel code only.'; ; Number of days after that users will be automatically removed from the group. '0' — not to remove users.;




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

Instance Method Details

#account_id ⇒ Integer

Returns Advertising account ID.

Returns:

  • (Integer) —

    Advertising account ID.



27
 
# File 'lib/vk/api/ads/methods/create_target_group.rb', line 27

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



29
 
# File 'lib/vk/api/ads/methods/create_target_group.rb', line 29

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.



33
 
# File 'lib/vk/api/ads/methods/create_target_group.rb', line 33

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

#lifetime ⇒ Integer

Returns 'For groups with auditory created with pixel code only.'; ; Number of days after that users will be automatically removed from the group. '0' — not to remove users.;.

Returns:

  • (Integer) —

    'For groups with auditory created with pixel code only.'; ; Number of days after that users will be automatically removed from the group. '0' — not to remove users.;



35
 
# File 'lib/vk/api/ads/methods/create_target_group.rb', line 35

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

#name ⇒ String

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

Returns:

  • (String) —

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



31
 
# File 'lib/vk/api/ads/methods/create_target_group.rb', line 31

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