Class: TiktokBusinessApi::Resources::Campaign

Inherits:
CrudResource show all
Defined in:
lib/tiktok_business_api/resources/campaign.rb

Overview

Campaign resource for the TikTok Business API

Constant Summary collapse

RESOURCE_NAME = 
'campaign'

Instance Attribute Summary

Attributes inherited from BaseResource

#client

Instance Method Summary collapse

Methods inherited from CrudResource

#create, #create_path, #delete, #delete_path, #id_param_name, #ids_param_name, #list_all, #list_path, #resource_name, #status_update_path, #update, #update_path, #update_status

Methods inherited from BaseResource

#_http_get, #_http_post, #api_version, #base_path, #initialize, #paginate, #resource_name

Constructor Details

This class inherits a constructor from TiktokBusinessApi::Resources::BaseResource

Instance Method Details

#get(advertiser_id:, campaign_id:) ⇒ Object 



9
10
11
 
# File 'lib/tiktok_business_api/resources/campaign.rb', line 9

def get(advertiser_id:, campaign_id:)
  list(advertiser_id: advertiser_id, filtering: {campaign_ids: [campaign_id]}).first
end

#list(advertiser_id:, filtering: {}, page_size: nil, page: nil, **other_params, &block) ⇒ Object 



13
14
15
 
# File 'lib/tiktok_business_api/resources/campaign.rb', line 13

def list(advertiser_id:, filtering: {}, page_size: nil, page: nil, **other_params, &block)
  super(filtering: filtering, page_size: page_size, page: page, **other_params.merge(advertiser_id: advertiser_id), &block)
end