Graph API
Versi Graph API

/{app-id}/subscriptions

Dengan edge ini, Anda dapat mengonfigurasi langganan webhooks di aplikasi.

Membaca

Graph API Explorer
GET /v21.0/{app-id}/subscriptions 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(
    '/{app-id}/subscriptions',
    '{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 */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{app-id}/subscriptions",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{app-id}/subscriptions"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Izin

  • Token akses aplikasi diperlukan untuk menampilkan langganan bagi aplikasi itu.

Kolom

Nama Deskripsi Jenis

object

Menunjukkan jenis objek yang berlaku untuk langganan ini.

enum{user, page, permissions, payments}

callback_url

URL yang akan menerima permintaan POST saat pembaruan dipicu.

string

fields

Set kolom langganan dalam object ini.

string[]

active

Menunjukkan apakah langganan aktif atau tidak.

bool

Membuat

Anda dapat membuat langganan Webhooks baru dengan menggunakan edge ini:

POST /v21.0/{app-id}/subscriptions HTTP/1.1
Host: graph.facebook.com

object=page&callback_url=http%3A%2F%2Fexample.com%2Fcallback%2F&fields=about%2C+picture&include_values=true&verify_token=thisisaverifystring
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->post(
    '/{app-id}/subscriptions',
    array (
      'object' => 'page',
      'callback_url' => 'http://example.com/callback/',
      'fields' => 'about, picture',
      'include_values' => 'true',
      'verify_token' => 'thisisaverifystring',
    ),
    '{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 */
Bundle params = new Bundle();
params.putString("object", "page");
params.putString("callback_url", "http://example.com/callback/");
params.putString("fields", "about, picture");
params.putString("include_values", "true");
params.putString("verify_token", "thisisaverifystring");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{app-id}/subscriptions",
    params,
    HttpMethod.POST,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
NSDictionary *params = @{
  @"object": @"page",
  @"callback_url": @"http://example.com/callback/",
  @"fields": @"about, picture",
  @"include_values": @"true",
  @"verify_token": @"thisisaverifystring",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{app-id}/subscriptions"
                                      parameters:params
                                      HTTPMethod:@"POST"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Pembuatan permintaan POST dengan kolom callback_url, verify_token, dan object akan mengaktifkan ulang langganan.

Batasan

Izin

  • Token akses aplikasi diperlukan untuk menambahkan langganan baru bagi aplikasi itu.
  • Langganan untuk jenis objek user hanya akan valid untuk pengguna yang telah menginstal aplikasi.
  • Langganan untuk jenis objek page hanya akan valid untuk Halaman yang telah menginstal aplikasi. Anda dapat menginstal aplikasi untuk Halaman menggunakan edge /{page-id}/subscribed_apps.
  • Aplikasi yang digunakan untuk berlangganan harus disiapkan untuk menerima pembaruan Webhooks.

Kolom

Nama Deskripsi Jenis

object

Menunjukkan jenis objek yang berlaku untuk langganan ini.

enum{user, page, permissions, payments}

callback_url

URL yang akan menerima permintaan POST saat pembaruan dipicu, dan permintaan GET saat mencoba operasi penerbitan ini. Lihat panduan untuk membuat halaman URL panggilan balik.

string

fields

Berlangganan satu atau beberapa set kolom valid dalam object ini.

string[]

include_values

Menunjukkan apakah notifikasi perubahan harus menyertakan nilai-nilai baru.

bool

verify_token

String arbitrer yang dapat digunakan untuk mengonfirmasi ke server Anda bahwa permintaan tersebut valid.

string

Tanggapan

Jika URL panggilan balik Anda valid dan langganan berhasil:

{
  "success": true
}

Jika tidak, pesan kesalahan yang relevan akan ditampilkan.

Menghapus

Anda dapat menghapus semua langganan atau langganan per-objek menggunakan operasi ini:

DELETE /v21.0/{app-id}/subscriptions HTTP/1.1
Host: graph.facebook.com

object=page
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->delete(
    '/{app-id}/subscriptions',
    array (
      'object' => 'page',
    ),
    '{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 */
Bundle params = new Bundle();
params.putString("object", "page");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{app-id}/subscriptions",
    params,
    HttpMethod.DELETE,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
NSDictionary *params = @{
  @"object": @"page",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{app-id}/subscriptions"
                                      parameters:params
                                      HTTPMethod:@"DELETE"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Anda dapat menghapus kolom tertentu dari langganan Anda dengan menyertakan parameter fields.

Izin

  • Token akses aplikasi diperlukan untuk menghapus langganan bagi aplikasi itu.

Kolom

Nama Deskripsi Jenis

object

Jenis objek tertentu untuk menghapus langganan. Jika kolom opsional ini tidak disertakan, semua langganan untuk aplikasi ini akan dihapus.

enum{user, page, permissions, payments}

fields

Berlangganan satu atau beberapa set kolom valid dalam object ini.

string[]

Tanggapan

Jika berhasil:

{
  "success": true
}

Jika tidak, pesan kesalahan yang relevan akan ditampilkan.

Memperbarui

Anda dapat melakukan pembaruan pada edge ini dengan melakukan operasi terbitkan dengan nilai baru. Ini akan mengubah langganan untuk topik yang diberikan tanpa menimpa kolom yang ada.