Class: Pinterest::Resources::CustomerLists

Inherits:
Base
  • Object
show all
Defined in:
lib/pinterest/resources/customer_lists.rb

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from Pinterest::Resources::Base

Instance Method Details

#create(ad_account_id:, **params) ⇒ Hash

Parameters:

  • ad_account_id (String)
  • params (Hash) —

    name, list_type, records, records_v2, is_nca

Returns:

  • (Hash) 


19
20
21
 
# File 'lib/pinterest/resources/customer_lists.rb', line 19

def create(ad_account_id:, **params)
  post("/ad_accounts/#{}/customer_lists", params)
end

#find(ad_account_id:, customer_list_id:) ⇒ Hash

Parameters:

  • ad_account_id (String)
  • customer_list_id (String)

Returns:

  • (Hash) 


26
27
28
 
# File 'lib/pinterest/resources/customer_lists.rb', line 26

def find(ad_account_id:, customer_list_id:)
  get("/ad_accounts/#{}/customer_lists/#{customer_list_id}")
end

#list(ad_account_id:, bookmark: nil, page_size: nil, order: nil, exclude_nca: nil) ⇒ Hash

Returns { “items” => […], “bookmark” => “…” }.

Parameters:

  • ad_account_id (String)
  • bookmark (String, nil) (defaults to: nil)
  • page_size (Integer, nil) (defaults to: nil)
  • order (String, nil) (defaults to: nil) —

    “ASCENDING” or “DESCENDING”

  • exclude_nca (Boolean, nil) (defaults to: nil)

Returns:

  • (Hash) —

    { “items” => […], “bookmark” => “…” }



10
11
12
13
14
 
# File 'lib/pinterest/resources/customer_lists.rb', line 10

def list(ad_account_id:, bookmark: nil, page_size: nil, order: nil, exclude_nca: nil)
  get("/ad_accounts/#{}/customer_lists",
      { bookmark: bookmark, page_size: page_size,
        order: order, exclude_nca: exclude_nca }.compact)
end

#update(ad_account_id:, customer_list_id:, **params) ⇒ Hash

Append or remove records from an existing customer list.

Parameters:

  • ad_account_id (String)
  • customer_list_id (String)
  • params (Hash) —

    operation_type (“ADD”/“REMOVE”), records or records_v2

Returns:

  • (Hash) 


35
36
37
 
# File 'lib/pinterest/resources/customer_lists.rb', line 35

def update(ad_account_id:, customer_list_id:, **params)
  patch("/ad_accounts/#{}/customer_lists/#{customer_list_id}", params)
end