カタログ

データフィードのアップロードスケジュールを設定する

このドキュメントは、フィードをアップロードしてスケジュールを設定する際の参考にご利用ください。

フィードをアップロードする

フィードをアップロードするには、catalog_managementアクセス許可が必要です。マーケティングAPI、アクセス許可をご覧ください。カタログ作成後、catalog idを使って商品フィードを作成し、スケジュールを設定します。

curl -X POST \
  -F 'name="Test Feed"' \
  -F 'schedule={
       "interval": "DAILY",
       "url": "http://www.example.com/sample_feed.tsv",
       "hour": "22"
     }' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v21.0/{product-catalog-id}/product_feeds
Open In Graph API Explorer
'use strict';
const bizSdk = require('facebook-nodejs-business-sdk');
const ProductCatalog = bizSdk.ProductCatalog;
const ProductFeed = bizSdk.ProductFeed;

const access_token = '<ACCESS_TOKEN>';
const app_secret = '<APP_SECRET>';
const app_id = '<APP_ID>';
const id = '<PRODUCT_CATALOG_ID>';
const api = bizSdk.FacebookAdsApi.init(access_token);
const showDebugingInfo = true; // Setting this to true shows more debugging info.
if (showDebugingInfo) {
  api.setDebug(true);
}

const logApiCallResult = (apiCallName, data) => {
  console.log(apiCallName);
  if (showDebugingInfo) {
    console.log('Data:' + JSON.stringify(data));
  }
};

let fields, params;
fields = [
];
params = {
  'name' : 'Test Feed',
  'schedule' : {'interval':'DAILY','url':'http://www.example.com/sample_feed.tsv','hour':'22'},
};
const product_feeds = (new ProductCatalog(id)).createProductFeed(
  fields,
  params
);
logApiCallResult('product_feeds api call complete.', product_feeds);
Open In Graph API Explorer
require __DIR__ . '/vendor/autoload.php';

use FacebookAds\Object\ProductCatalog;
use FacebookAds\Object\ProductFeed;
use FacebookAds\Api;
use FacebookAds\Logger\CurlLogger;

$access_token = '<ACCESS_TOKEN>';
$app_secret = '<APP_SECRET>';
$app_id = '<APP_ID>';
$id = '<PRODUCT_CATALOG_ID>';

$api = Api::init($app_id, $app_secret, $access_token);
$api->setLogger(new CurlLogger());

$fields = array(
);
$params = array(
  'name' => 'Test Feed',
  'schedule' => array('interval' => 'DAILY','url' => 'http://www.example.com/sample_feed.tsv','hour' => '22'),
);
echo json_encode((new ProductCatalog($id))->createProductFeed(
  $fields,
  $params
)->exportAllData(), JSON_PRETTY_PRINT);
Open In Graph API Explorer
from facebook_business.adobjects.productcatalog import ProductCatalog
from facebook_business.adobjects.productfeed import ProductFeed
from facebook_business.api import FacebookAdsApi

access_token = '<ACCESS_TOKEN>'
app_secret = '<APP_SECRET>'
app_id = '<APP_ID>'
id = '<PRODUCT_CATALOG_ID>'
FacebookAdsApi.init(access_token=access_token)

fields = [
]
params = {
  'name': 'Test Feed',
  'schedule': {'interval':'DAILY','url':'http://www.example.com/sample_feed.tsv','hour':'22'},
}
print ProductCatalog(id).create_product_feed(
  fields=fields,
  params=params,
)
Open In Graph API Explorer
import com.facebook.ads.sdk.*;
import java.io.File;
import java.util.Arrays;

public class SAMPLE_CODE_EXAMPLE {
  public static void main (String args[]) throws APIException {

    String access_token = \"<ACCESS_TOKEN>\";
    String app_secret = \"<APP_SECRET>\";
    String app_id = \"<APP_ID>\";
    String id = \"<PRODUCT_CATALOG_ID>\";
    APIContext context = new APIContext(access_token).enableDebug(true);

    new ProductCatalog(id, context).createProductFeed()
      .setName(\"Test Feed\")
      .setSchedule(\"{\\"interval\\":\\"DAILY\\",\\"url\\":\\"http://www.example.com/sample_feed.tsv\\",\\"hour\\":\\"22\\"}\")
      .execute();

  }
}
Open In Graph API Explorer
require 'facebook_ads'

access_token = '<ACCESS_TOKEN>'
app_secret = '<APP_SECRET>'
app_id = '<APP_ID>'
id = '<PRODUCT_CATALOG_ID>'

FacebookAds.configure do |config|
  config.access_token = access_token
  config.app_secret = app_secret
end

product_catalog = FacebookAds::ProductCatalog.get(id)
product_feeds = product_catalog.product_feeds.create({
    name: 'Test Feed',
    schedule: {'interval':'DAILY','url':'http://www.example.com/sample_feed.tsv','hour':'22'},
})
Open In Graph API Explorer

scheduleパラメーターを使ってフィードのアップロードスケジュールを設定できます。任意で、interval、url、hourを指定できます。さらに、day_of_week、minute、username、passwordを含めることもできます。

注: usernameとpasswordについては、HTTPとFTPに基づく基本認証がサポートされています。

例 — フィードのアップロードスケジュールを設定する

schedule: {"day_of_week":"FRIDAY","hour":17,"interval_count":1,"interval":"DAILY","minute":42,"next_scheduled_upload_time":"","password":pwd123,"status":"active","timezone":"Atlantic/Canary","url":"https://www.abc.com","username":aname}

個々のアイテムを更新する

個々のアイテムのデータをリアルタイムで更新します。更新後のフィールドをHTTP POSTに含めます。retailer_idは、フィードのアイテムIDです。これは、base64urlでエンコードされている必要があります。

https://graph.facebook.com/catalog:{CATALOG_ID}:{base64urlencode(retailer_id)}

商品、リファレンスの変更可能フィールドをご覧ください。

アイテムフィードに、APIによる個々のアイテムの更新、作成、削除を指定しないようにしてください。これらはフィードではトラッキングされないため、APIで作成したアイテムの更新や削除が妨げられる可能性があります。

データフィードを取り出すスケジュールを設定する

スケジュールが設定されたフィードにおいて、1時間に1回を超えるアップロード頻度はサポートされていません。インベントリーの更新頻度をもっと上げる必要がある場合は、直接アップロードAPIを使うことをおすすめします。

フィードの作成と管理にMetaのAPIを使う場合、作成する更新スケジュールの詳細を指定したAPIリクエストをMetaに送信する必要があります。

curl \
  -F 'name=Test Feed' \
  -F 'update_schedule={ 
    "interval": "HOURLY", 
    "url": "http:\/\/www.example.com\/sample_feed_updates.tsv",
    "hour": 22
  }' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/<API_VERSION>/<CATALOG_ID>/product_feeds

定義されたスケジュールに従って、システムからアイテムフィードが取得されます。次の2種類のスケジュールを定義できます。

  • update_schedule — アップロードにより、データフィードファイルに指定された情報によって新しいアイテムが作成されるか既存のアイテムが更新されます。
  • schedule — アップロードにより、データフィードの操作が完全にリフレッシュされます。ファイル内にないアイテムは削除され、既存のアイテムは更新され、新しいアイテムは作成されます。必要に応じて、どちらか一方のスケジュール設定を選択することも、両方のスケジュール設定を選択することもできます。

例: 頻度HOURLYのupdate_scheduleと、頻度DAILYの置換schedule。

フィードをより迅速に処理するには、データフィードファイル内の変更のあったデータのみでupdate_scheduleを設定することをおすすめします。この設定は、休日のセールの場合や、価格と在庫状況を素早く更新したい場合などに特に便利です。アイテムをフィードから削除するのではなく「在庫切れ」マークを付けることをおすすめします。そうすれば、利用可能な類似アイテムでユーザーをリターゲティングすることができます。

curl \
  -F 'name=Test Feed' \
  -F 'schedule={ 
    "interval": "DAILY", 
    "url": "http:\/\/www.example.com\/sample_feed.tsv"
  }' \
  -F 'update_schedule={ 
    "interval": "HOURLY", 
    "url": "http:\/\/www.example.com\/sample_feed_updates.tsv",
    "hour": 22
  }' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/<API_VERSION>/<CATALOG_ID>/product_feeds

応答

{ "id" : {FEED_ID} }

データフィードのリファレンス、データフィードのスケジュールリファレンスをご覧ください。

詳しくはこちら