0

List products by product group

by
Published Dec 20, 2024

Get a list of product pins for a given Catalogs Product Group Id owned by the "operation user_account". - By default, the "operation user_account" is the token user_account. Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager. Learn more

Script pinterest Verified

The script

Submitted by hugo697 Bun
Verified 536 days ago
1
//native
2
type Pinterest = {
3
  token: string;
4
};
5
/**
6
 * List products by product group
7
 * Get a list of product pins for a given Catalogs Product Group Id owned by the "operation user_account".
8
- By default, the "operation user_account" is the token user_account.
9

10
Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager.
11

12
Learn more
13
 */
14
export async function main(
15
  auth: Pinterest,
16
  product_group_id: string,
17
  bookmark: string | undefined,
18
  page_size: string | undefined,
19
  ad_account_id: string | undefined,
20
  pin_metrics: string | undefined,
21
) {
22
  const url = new URL(
23
    `https://api.pinterest.com/v5/catalogs/product_groups/${product_group_id}/products`,
24
  );
25
  for (const [k, v] of [
26
    ["bookmark", bookmark],
27
    ["page_size", page_size],
28
    ["ad_account_id", ad_account_id],
29
    ["pin_metrics", pin_metrics],
30
  ]) {
31
    if (v !== undefined && v !== "" && k !== undefined) {
32
      url.searchParams.append(k, v);
33
    }
34
  }
35
  const response = await fetch(url, {
36
    method: "GET",
37
    headers: {
38
      Authorization: "Bearer " + auth.token,
39
    },
40
    body: undefined,
41
  });
42
  if (!response.ok) {
43
    const text = await response.text();
44
    throw new Error(`${response.status} ${text}`);
45
  }
46
  return await response.json();
47
}
48