scheduled-feeds

Scheduled Feeds

These endpoints are currently available via early-access only. To apply for access, please fill out this form.

Scheduled Feeds are about configuring the file and the frequency with which Twitter ingests product data into the user's catalog. There is only one product feed supported per user.

GET product_catalogs/:product_catalog_id/scheduled_feeds¶

Retrieve details for some or all Scheduled feeds with the specified Product Catalog.

Resource URL¶

https://ads-api.x.com/12/product_catalogs/:product_catalog_id/scheduled_feeds

Example Request¶

GET https://ads-api.x.com/12/product_catalogs/1547080201384865792/scheduled_feeds

Example Response¶

{
  "request": {
    "params": {
      "product_catalog_id": "1547080201384865792"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "start_time": "01:30",
      "product_catalog_id": "1547080201384865792",
      "feed_url": "https://test212/file.csv",
      "feed_format": "CSV",
      "id": "1564821386714947589",
      "created_at": "2022-08-31T03:44:26.000Z",
      "frequency": "DAILY",
      "repeat": null,
      "updated_at": "2022-09-27T08:47:23.000Z",
      "time_zone": "America/New_York"
    }
  ]
}

POST product_catalogs/:product_catalog_id/scheduled_feeds¶

Creating a scheduled product feed. Please note that importing a scheduled feed is an additive action. This means that removing products from the feed does not delete products from the catalog.

Request Parameters¶

Name	Description
feed_url required	Host feed URL for your product file. Can be up to 8GB Type: string Example: `“https://abc.com/xyz.csv”`
feed_format required	Description of product sets. Type: enum Possible Values: `CSV` `TSV` `XML`
frequency required	Frequency for Twitter to ingest product from the feed Type: enum Possible values: `HOURLY` `DAILY` `WEEKLY`
repeat sometimes required	Time to ingest feed Type: enum When frequency = WEEKLY Possible Values: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY` When frequency = HOURLY Possible Values: `1`,`2`,`3`,`4`,`6`,`8`,`12` When frequency = DAILY repeat parameter should not be added
start_time required	Time to import a feed file for the daily scheduled feed Type: string Example: `01:30`
time_zone required	Time zone for start_time Type: string Example: `America/New_York`, `Asia/Tokyo`

Example Request¶

POST https://ads-api.x.com/12/product_catalogs/1547080201384865792/scheduled_feeds?feed_url=https://test212/file.csv&feed_format=CSV&frequency=WEEKLY&time_zone=America/New_York&repeat=SATURDAY&start_time=01:30

Example Response¶

{
  "request": {
    "params": {
      "start_time": "01:30",
      "product_catalog_id": "1547080201384865792",
      "feed_url": "https://test212/file.csv",
      "feed_format": "CSV",
      "frequency": "WEEKLY",
      "repeat": "SATURDAY",
      "time_zone": "America/New_York"
    }
  },
  "data": {
    "start_time": "01:30",
    "product_catalog_id": "1547080201384865792",
    "feed_url": "https://test212/file.csv",
    "feed_format": "CSV",
    "id": "1576851765428822016",
    "created_at": "2022-10-03T08:28:52.000Z",
    "frequency": "WEEKLY",
    "repeat": "SATURDAY",
    "updated_at": "2022-10-03T08:28:52.000Z",
    "time_zone": "America/New_York"
  }
}

PUT product_catalogs/:product_catalog_id/scheduled_feeds/:scheduled_feed_id¶

Updating an existing scheduled product feed

Request Parameters¶

Name	Description
scheduled_feed_id required	Unique ID for scheduled feed Type: string Example: `1573879351254274048`
feed_url optional	Host feed URL for your product file. Can be up to 8GB Type: string Example: `“https://abc.com/xyz.csv”`
feed_format optional	Description of product sets. Type: enum Possible Values: `CSV` `TSV` `XML`
frequency optional	Frequency for Twitter to ingest product from the feed Type: enum Possible values: `HOURLY` `DAILY` `WEEKLY`
repeat optional	Time to ingest feed Type: enum When frequency = WEEKLY Possible Values: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY` When frequency = HOURLY Possible Values: `1`,`2`,`3`,`4`,`6`,`8`,`12`
start_time optional	Time to import a feed file for the daily scheduled feed Type: string Example: `01:30`
time_zone optional	Time zone for start_time Type: string Example: `America/New_York`, `Asia/Tokyo`

Example Request¶

PUT https://ads-api.x.com/12/product_catalogs/1547080201384865792/scheduled_feeds/1577629831247720448?start_time=07:30

Example Response¶

{
  "request": {
    "params": {
      "product_catalog_id": "1547080201384865792",
      "start_time": "07:30",
      "id": "1577629831247720448"
    }
  },
  "data": {
    "start_time": "07:30",
    "product_catalog_id": "1547080201384865792",
    "feed_url": "https://test212/file.csv",
    "feed_format": "CSV",
    "id": "1577629831247720448",
    "created_at": "2022-10-05T12:00:37.000Z",
    "frequency": "WEEKLY",
    "repeat": "SATURDAY",
    "updated_at": "2022-10-05T12:03:07.000Z",
    "time_zone": "America/New_York"
  }
}

DELETE product_catalogs/:product_catalog_id/scheduled_feeds/:scheduled_feed_id¶

Deleting an existing scheduled product feed. Please note that this is a permanent deletion.

Request Parameters¶

Name Description

scheduled_feed_id
required

Unique ID for scheduled feed

Type: string

Example: 1573879351254274048

Example Request¶

DELETE https://ads-api.x.com/12/scheduled_feeds/1547080201384865792/scheduled_feeds/1576854236993708032

Example Response¶

{
  "request": {
    "params": {
      "product_catalog_id": "1547080201384865792",
      "id": "1576854236993708032"
    }
  },
  "data": {
    "start_time": "07:30",
    "product_catalog_id": "1547080201384865792",
    "feed_url": "https://test212/file.csv",
    "feed_format": "CSV",
    "id": "1576854236993708032",
    "created_at": "2022-10-03T08:38:41.000Z",
    "frequency": "DAILY",
    "repeat": null,
    "updated_at": "2022-10-03T08:50:10.000Z",
    "time_zone": "America/New_York"
  }
}