圖形 API 版本

Ad Pixel

閱讀中

A Facebook pixel is a small piece of JavaScript code that an advertiser places on every page of their website. This piece of code provides a set of lightweight functionalities for sending user-specific events and event-specific custom data to Facebook. Advertisers can use the Facebook pixel to capture intent information about how people are using their website. A single Facebook pixel is added to all pages of a website, and is then used to create website custom audiences

範例

Graph API Explorer

GET /v21.0/{ads-pixel-id} HTTP/1.1
Host: graph.facebook.com

/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{ads-pixel-id}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */

/* make the API call */
FB.api(
    "/{ads-pixel-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{ads-pixel-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{ads-pixel-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

如果想瞭解如何使用圖形 API，請參閱我們的使用圖形 API 指南。

參數

這個端點沒有任何參數。

欄位

欄位	說明
`id` numeric string	ID of the pixel 預設
`automatic_matching_fields` list<enum>	Advanced matching fields which are enabled for automatic advanced matching
`can_proxy` bool	can_proxy
`code` string	Pixel code to be placed on the website
`config` string	The configuration to use for uploads to this dataset. Format determined by the method of upload (eg. UI or SDK)
`creation_time` datetime	Time at which the pixel was created
`creator` User	The user who created this pixel
`data_use_setting` enum	Setting to capture how pixel data should be used
`description` string	SELF_EXPLANATORY
`duplicate_entries` integer	Number of duplicate entries for this dataset
`enable_auto_assign_to_accounts` bool	Whether the dataset is auto assigned and auto tracked for all accounts that the owner business owns
`enable_automatic_matching` bool	Represents whether automatic advanced matching is enabled for the pixel for identity matching purposes
`event_stats` string	Event stats of this dataset
`event_time_max` integer	Latest entry of this dataset
`event_time_min` integer	Earliest entry of this dataset
`first_party_cookie_status` enum	First party cookie status to indicate whether first party cookies can be set for this pixel
`has_1p_pixel_event` bool	whether pixel has sent us 1p signals
`is_consolidated_container` bool	A boolean value indicating whether this signal container has unified pixel and offline conversion data set
`is_created_by_business` bool	Flag stands for if a pixel is created by business
`is_crm` bool	True if a pixel contains lead gen data source config
`is_mta_use` bool	Whether the dataset is restricted to MTA only
`is_restricted_use` bool	Whether the dataset is restricted to Lift only
`is_unavailable` bool	Whether this pixel is unavailable
`last_fired_time` datetime	Time at which the pixel was last fired
`last_upload_app` string	The app that made the most recent upload
`last_upload_app_changed_time` integer	Time when the app that made the most recent upload last changed
`match_rate_approx` int32	Approximate match rate percentage for the entries in this dataset
`matched_entries` integer	Number of matched entries of this dataset
`name` string	Name of the pixel
`owner_business` Business	ID of the business that owns this pixel or null if the pixel has not been claimed by any business yet.
`usage` OfflineConversionDataSetUsage	Usage info for the dataset
`valid_entries` integer	Number of valid entries of this dataset

關係連線

關係連線	說明
`assigned_users` Edge<AssignedUser>	assigned_users
`da_checks` Edge<DACheck>	A list of results after running Dynamic Ads checks on this pixel.
`offline_event_uploads` Edge<OfflineConversionDataSetUpload>	The offline uploads associated with this event set
`openbridge_configurations` Edge<OpenBridgeConfiguration>	Get all the openbridge configurations associated to this Pixel
`shared_agencies` Edge<Business>	Agencies or other businesses this pixel is shared with
`stats` Edge<AdsPixelStatsResult>	Stats data for this pixel

Error Codes

錯誤	說明
200	Permissions error
100	Invalid parameter
368	The action attempted has been deemed abusive or is otherwise disallowed
190	Invalid OAuth 2.0 Access Token
80004	There have been too many calls to this ad-account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting#ads-management.

建立中

You can make a POST request to adspixels edge from the following paths:

/act_{ad_account_id}/adspixels

發佈到此關係連線時，會建立 an AdsPixel 。

範例

Graph API Explorer

POST /v21.0/act_<AD_ACCOUNT_ID>/adspixels HTTP/1.1
Host: graph.facebook.com

name=My+WCA+Pixel

/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->post(
    '/act_<AD_ACCOUNT_ID>/adspixels',
    array (
      'name' => 'My WCA Pixel',
    ),
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */

/* make the API call */
FB.api(
    "/act_<AD_ACCOUNT_ID>/adspixels",
    "POST",
    {
        "name": "My WCA Pixel"
    },
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

Bundle params = new Bundle();
params.putString("name", "My WCA Pixel");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/act_<AD_ACCOUNT_ID>/adspixels",
    params,
    HttpMethod.POST,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

NSDictionary *params = @{
  @"name": @"My WCA Pixel",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/act_<AD_ACCOUNT_ID>/adspixels"
                                      parameters:params
                                      HTTPMethod:@"POST"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

curl -X POST \
  -F 'name="My WCA Pixel"' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/adspixels

如果想瞭解如何使用圖形 API，請參閱我們的使用圖形 API 指南。

參數

參數說明

參數	說明
`name` string	Name of the pixel

name

string

Name of the pixel

傳回類型

此端點支援寫入後讀取功能，並將讀取傳回類型表示為 id 的節點。

Struct {

id: numeric string,

}

Error Codes

錯誤	說明
6202	More than one pixel exist for this account
100	Invalid parameter
200	Permissions error
6200	A pixel already exists for this account
190	Invalid OAuth 2.0 Access Token
415	Two factor authentication required. User have to enter a code from SMS or TOTP code generator to pass 2fac. This could happen when accessing a 2fac-protected asset like a page that is owned by a 2fac-protected business manager.

更新中

你可以向 /{ads_pixel_id} 提出發佈要求，以更新 an AdsPixel 。

參數

參數	說明
`automatic_matching_fields` array<enum {em, fn, ln, ph, ge, zp, ct, st, country, db, external_id}>	Advanced matching fields for which automatic advanced matching should be enabled
`data_use_setting` enum {EMPTY, ADVERTISING_AND_ANALYTICS, ANALYTICS_ONLY}	Setting to capture how pixel data should be used
`enable_automatic_matching` boolean	Enable automatic advanced matching for the pixel for identity matching purposes
`first_party_cookie_status` enum {EMPTY, FIRST_PARTY_COOKIE_ENABLED, FIRST_PARTY_COOKIE_DISABLED}	First party cookie status to indicate whether first party cookies can be set for this pixel
`name` string	Name of the pixel
`server_events_business_ids` array<numeric string>	server_events_business_ids

傳回類型

此端點支援寫入後讀取功能，並將讀取你傳送 POST 的節點。

Struct {

success: bool,

}

Error Codes

錯誤	說明
190	Invalid OAuth 2.0 Access Token
100	Invalid parameter

刪除中

你無法在此端點執行此操作。