Facebook App Events Reference

Android

Standard Events

イベント名:AppEventsConstantsの値 パラメーター 説明

レベル達成: EVENT_NAME_ACHIEVED_LEVEL

LEVEL

アプリ、ビジネス、または組織内で定義されている特定のレベルに達成したときに発生します。

Activate App: EVENT_NAME_ACTIVATED_APP

アプリが起動したときに発生します。

アプリ内広告のクリック: EVENT_NAME_AD_CLICK

AD_TYPE

アプリ内のサードパーティープラットフォームからの広告がクリックされたときに発生します。

アプリ内広告インプレッション: EVENT_NAME_AD_IMPRESSION

AD_TYPE

サードパーティープラットフォームからの広告がアプリ画面上に表示されたときに発生します。

支払い情報の追加: EVENT_NAME_ADDED_PAYMENT_INFO

SUCCESS

チェックアウト処理時に顧客の支払い情報が追加されたときに発生します。

カートに追加: EVENT_NAME_ADDED_TO_CART

valueToSum:追加されたアイテムの価格

CONTENT_TYPECONTENT_IDまたはCONTENT、およびCURRENCY

ショッピングカートまたは買い物かごにアイテムが追加されたときに発生します。たとえば、ウェブサイトの[カートに追加]ボタンをクリックした場合など。

ウィッシュリストに追加: EVENT_NAME_ADDED_TO_WISHLIST

valueToSum:追加されたアイテムの価格

CONTENT_TYPECONTENT_IDまたはCONTENT、およびCURRENCY

ウィッシュリストにアイテムが追加されたときに発生します。たとえば、ウェブサイトの[ウィッシュリストに追加]ボタンをクリックした場合など。

登録完了: EVENT_NAME_COMPLETED_REGISTRATION

REGISTRATION_METHOD

ビジネスが提供するサービスに対して顧客が情報を提供したときに発生します。たとえば、メール購読に登録した場合など。

チュートリアルの完了: EVENT_NAME_COMPLETED_TUTORIAL

SUCCESS、およびCONTENT_IDまたはCONTENT

アプリ上のチュートリアルを完了したときに発生します。

連絡先: EVENT_NAME_CONTACT

電話またはSMS、メール、チャット、または顧客とビジネスの間で使用するその他の連絡手段。

製品のカスタマイズ: EVENT_NAME_CUSTOMIZE_PRODUCT

ビジネスが所有する構成ツールやその他のアプリケーションを使用して製品がカスタマイズされたときに発生します。

寄付: EVENT_NAME_DONATE

組織のため、または目的のために寄付されたときに発生します。

位置情報の発見: EVENT_NAME_FIND_LOCATION

利用者が訪問する目的でウェブかアプリ経由であなたの位置情報の1つを見つけたときに発生します。たとえば、お客が製品を検索していて、あなたの実際の店舗のいずれかで見つけた場合など。

チェックアウト開始: EVENT_NAME_INITIATED_CHECKOUT

valueToSum:カート内のアイテムの合計額

CONTENT_TYPECONTENT_IDまたはCONTENTNUM_ITEMSPAYMENT_INFO_AVAILABLE、およびCURRENCY

チェックアウトプロセスを開始したときに発生します。

購入: EVENT_NAME_PURCHASED

valueToSum:購入の価格

NUM_ITEMSCONTENT_TYPECONTENT_IDまたはCONTENT、およびCURRENCY

購入が完了したときに発生します。通常は、注文や購入確認を受け取ったとき、または取引を受け付けたときに指定されます。

評価: EVENT_NAME_RATED

valueToSum:付けられた評価

CONTENT_TYPECONTENT_IDまたはCONTENT、およびMAX_RATING_VALUE

アプリ、ビジネス、または組織内の何らかのものに対する評価。たとえば、レストランレビューアプリ内のレストランの評価。

スケジュール: EVENT_NAME_SCHEDULE

指定したいずれかの場所の訪問の予約。

検索: EVENT_NAME_SEARCHED

CONTENT_TYPESEARCH_STRINGSUCCESS

ウェブサイト、アプリ、またはその他のプロパティで実行した検索。たとえば商品の検索や旅行先の検索など。

クレジット利用: EVENT_NAME_SPENT_CREDITS

valueToSum:クレジット利用合計額

CONTENT_TYPE、およびCONTENT_IDまたはCONTENT

ビジネスやアプリケーションに固有のもの(たとえばアプリ内通貨など)に対する利用者のクレジット利用の取引が完了したときに発生します。

トライアル開始: EVENT_NAME_START_TRIAL

valueToSum:購読の価格

ORDER_IDCURRENCY

提供している製品やサービスの無料トライアルを利用者が開始したときに発生します。

申し込みの送信: EVENT_NAME_SUBMIT_APPLICATION

クレジットカード、教育プログラム、または仕事など、提供する製品、サービスまたはプログラムに利用者が申し込む場合に発生します。

購読: EVENT_NAME_SUBSCRIBE

valueToSum:購読の価格

ORDER_IDCURRENCY

提供している製品やサービスの有料サブスクリプションの開始時に発生します。

アチーブメントアンロック: EVENT_NAME_UNLOCKED_ACHIEVEMENT

DESCRIPTION

アプリ、ビジネス、または組織内の、リワードを提供する特定のアクティビティまたはアクションの完了時に発生します。たとえば、友達の照会やプロフィールの入力など。

コンテンツビュー: EVENT_NAME_VIEWED_CONTENT

閲覧されたアイテムの価格(該当する場合)

CONTENT_TYPECONTENT_IDまたはCONTENT、およびCURRENCY

商品ページ、ランディングページ、記事など、関心のあるコンテンツページの訪問時に発生します。閲覧したページに関する情報はFacebookに渡され、ダイナミック広告に使用されます。

Standard Event Parameters

AppEventConstants::EVENT_PARAM_* Possible Values Description

Ad Type:
EVENT_PARAM_AD_TYPE

string

Type of ad: banner, interstitial, rewarded_video, native

Content ID:

EVENT_PARAM_CONTENT_ID

string

International Article Number (EAN) when applicable, or other product or content identifier

Content:

EVENT_PARAM_CONTENT

string

A list of JSON object that contains the International Article Number (EAN) when applicable, or other product or content identifier(s) as well as additional information about the products. id and quantity are the available fields. e.g. "[{\"id\": \"1234\", \"quantity\": 2}, {\"id\": \"5678\", \"quantity\": 1}]"

Content Type:

EVENT_PARAM_CONTENT_TYPE

string

'product' or 'product_group'

Currency:

EVENT_PARAM_CURRENCY

string

ISO 4217 code, e.g., "EUR", "USD", "JPY"

Description:

EVENT_PARAM_DESCRIPTION

string

A string description

Level:

EVENT_PARAM_LEVEL

string

Level of a game

Max. Rating Value:

EVENT_PARAM_MAX_RATING_VALUE

int

Upper bounds of a rating scale, for example 5 on a 5 star scale

Number of Items:

EVENT_PARAM_NUM_ITEMS

int

Number of items

Order ID:

EVENT_PARAM_ORDER_ID

string

The unique ID for all events within a subscription

Payment Info Available:

EVENT_PARAM_PAYMENT_INFO_AVAILABLE

1 or 0

1 for yes, 0 for no

Registration Method:

EVENT_PARAM_REGISTRATION_METHOD

string

Facebook, Email, Twitter, etc.

Search String:

EVENT_PARAM_SEARCH_STRING

string

The text string that was searched for

Success:

EVENT_PARAM_SUCCESS

1 or 0

1 for yes, 0 for no

iOS

iOS 14のApp Store Connect

アプリが収集してFacebookに送信するイベントによっては、App Store Connect質問表でそのようなデータタイプを公開するよう求められる場合があります。アプリのプライバシーポリシーでこの点が反映されていることを確認するのは、開発者の責任です。公開する必要があるデータタイプの詳細については、Apple App Storeでのプライバシーに関する詳細情報の記事をご覧ください。

Standard Events

Event Name: FBSDKAppEventName Parameters Description

Achieve Level: FBSDKAppEventNameAchievedLevel

Level

The achievement of specific levels you define within your application, business or organization.

Activate App: FBSDKAppEventNameActivatedApp

The launch of your app.

In-App Ad Click: FBSDKAppEventNameAdClick

AdType

An ad from a third-party platform is clicked within your app.

In-App Ad Impression: FBSDKAppEventNameAdImpression

AdType

An ad from a third-party platform appears on-screen within your app.

Add Payment Info: FBSDKAppEventNameAddedPaymentInfo

Success

The addition of customer payment information during a checkout process.

Add to Cart: FBSDKAppEventNameAddedToCart

valueToSum: Price of item added

ContentType, ContentID or Content, and Currency

The addition of an item to a shopping cart or basket. For example, clicking an Add to Cart button on a website.

Add to Wishlist: FBSDKAppEventNameAddedToWishlist

valueToSum: Price of item added

ContentType, ContentID or Content, and Currency

The addition of items to a wishlist. For example, clicking an Add to Wishlist button on a website.

Complete Registration: FBSDKAppEventNameCompletedRegistration

RegistrationMethod

A submission of information by a customer in exchange for a service provided by your business. For example, sign up for an email subscription.

Complete Tutorial: FBSDKAppEventNameCompletedTutorial

Success, and ContentID or Content

A completion of a tutorial on your app.

Contact: FBSDKAppEventNameContact

A telephone or SMS, email, chat or other type of contact between a customer and your business.

Customize Product: FBSDKAppEventNameCustomizeProduct

The customization of products through a configuration tool or other application your business owns.

Donate: FBSDKAppEventNameDonate

The donation of funds to your organization or cause.

Find Location: FBSDKAppEventNameFindLocation

When a person finds one of your locations via web or app, with an intention to visit. For example, searching for a product and finding it at one of your local stores.

Initiate Checkout: FBSDKAppEventNameInitiatedCheckout

valueToSum: Total price of items in cart

ContentType, ContentID or Content, NumItems, PaymentInfoAvailable, and Currency

The start of a checkout process.

Purchase: FBSDKAppEventNamePurchased

Use the logPurchase method instead.

valueToSum: Purchase price

NumItems, ContentType, ContentID or Content, and Currency

The completion of a purchase, usually signified by receiving order or purchase confirmation or a transaction receipt.

Rate: FBSDKAppEventNameRated

valueToSum: Rating given

ContentType, ContentID or Content, and MaxRatingValue

A rating of something within your app, business or organization. For example, rates a restaurant within a restaurant review app

Schedule: FBventNameSchedule

The booking of an appointment to visit one of your locations.

Search: FBSDKAppEventNameSearched

ContentType, SearchString, and Success

A search performed on your website, app or other property, such as product searches, travel searches, etc.

Spent Credits: FBSDKAppEventNameSpentCredits

valueToSum: Total value of credits spent

ContentType, and ContentID or Content

The completion of a transaction where people spend credits specific to your business or application, such as in-app currency.

Start Trial: FBSDKAppEventNameStartTrial

valueToSum: Total value of credits spent

OrderID

and

Currency

The start of a free trial of a product or service you offer, such as a trial subscription.

Schedule

See App Events Schema

Submit Application: FBSDKAppEventNameSubmitApplication

The submission of an application for a product, service or program you offer, such as a credit card, educational program or job.

Subscribe

See App Events Schema

Subscription: FBSDKAppEventNameSubscription

valueToSum: Price of Subscription

OrderID

and

Currency

The start of a paid subscription for a product or service you offer.

Unlock Achievement: FBSDKAppEventNameUnlockedAchievement

Description

The completion of specific activities or actions you want to reward within your application, business or organization. For example, refer a friend, complete your profile, etc.

View Content: FBSDKAppEventNameViewedContent

valueToSum: Price of item viewed (if applicable)

ContentType, ContentID or Content, and Currency

A visit to a content page you care about, such as a product page, landing page or article. Information about the page viewed can be passed to Facebook for use in Advantage+ catalog ads.

Standard Event Parameters

Parameter: FBSDKAppEventParameterName Possible Values Description

Ad Type:

FBSDKAppEventParameterNameAdType

string

Type of ad: banner, interstitial, reward_video, native

Content:

FBSDKAppEventParameterNameContent

string

A list of JSON object that contains the International Article Number (EAN) when applicable, or other product or content identifiers and additional information about the products. id and quantity are the available fields. e.g. "[{\"id\": \"1234\", \"quantity\": 2}, {\"id\": \"5678\", \"quantity\": 1}]"

Content ID:

FBSDKAppEventParameterNameContentID

string

International Article Number (EAN) when applicable, or other product or content identifier

Content Type:

FBSDKAppEventParameterNameContentType

string

product or product_group

Currency:

FBSDKAppEventParameterNameCurrency

string

ISO 4217 code, for example, EUR, USD, JPY

Description:

FBSDKAppEventParameterNameDescription

string

A string description

Level:

FBSDKAppEventParameterNameLevel

string

Level of a player

Max. Rating Value:

FBSDKAppEventParameterNameMaxRatingValue

int

Upper bounds of a rating scale, for example 5 on a 5 star scale

Number of Items:

FBSDKAppEventParameterNameNumItems

int

Number of items

Order ID:

FBSDKAppEventParameterNameOrderID

string

The unique ID for all events within a subscription

Payment Info Available:

FBSDKAppEventParameterNamePaymentInfoAvailable

1 or 0

1 for yes, 0 for no

Registration Method:

FBSDKAppEventParameterNameRegistrationMethod

string

Facebook, Email, Twitter, etc.

Search String:

FBSDKAppEventParameterNameSearchString

string

The string that was searched for

Success:

FBSDKAppEventParameterNameSuccess

1 or 0

1 for yes, 0 for no

Web

Standard Events

イベント名:AppEventsConstantsの値 パラメーター 説明

レベル達成: EVENT_NAME_ACHIEVED_LEVEL

LEVEL

アプリ、ビジネス、または組織内で定義されている特定のレベルに達成したときに発生します。

Activate App: EVENT_NAME_ACTIVATED_APP

アプリが起動したときに発生します。

アプリ内広告のクリック: EVENT_NAME_AD_CLICK

AD_TYPE

アプリ内のサードパーティープラットフォームからの広告がクリックされたときに発生します。

アプリ内広告インプレッション: EVENT_NAME_AD_IMPRESSION

AD_TYPE

サードパーティープラットフォームからの広告がアプリ画面上に表示されたときに発生します。

支払い情報の追加: EVENT_NAME_ADDED_PAYMENT_INFO

SUCCESS

チェックアウト処理時に顧客の支払い情報が追加されたときに発生します。

カートに追加: EVENT_NAME_ADDED_TO_CART

valueToSum:追加されたアイテムの価格

CONTENT_TYPECONTENT_IDまたはCONTENT、およびCURRENCY

ショッピングカートまたは買い物かごにアイテムが追加されたときに発生します。たとえば、ウェブサイトの[カートに追加]ボタンをクリックした場合など。

ウィッシュリストに追加: EVENT_NAME_ADDED_TO_WISHLIST

valueToSum:追加されたアイテムの価格

CONTENT_TYPECONTENT_IDまたはCONTENT、およびCURRENCY

ウィッシュリストにアイテムが追加されたときに発生します。たとえば、ウェブサイトの[ウィッシュリストに追加]ボタンをクリックした場合など。

登録完了: EVENT_NAME_COMPLETED_REGISTRATION

REGISTRATION_METHOD

ビジネスが提供するサービスに対して顧客が情報を提供したときに発生します。たとえば、メール購読に登録した場合など。

チュートリアルの完了: EVENT_NAME_COMPLETED_TUTORIAL

SUCCESS、およびCONTENT_IDまたはCONTENT

アプリ上のチュートリアルを完了したときに発生します。

連絡先: EVENT_NAME_CONTACT

電話またはSMS、メール、チャット、または顧客とビジネスの間で使用するその他の連絡手段。

製品のカスタマイズ: EVENT_NAME_CUSTOMIZE_PRODUCT

ビジネスが所有する構成ツールやその他のアプリケーションを使用して製品がカスタマイズされたときに発生します。

寄付: EVENT_NAME_DONATE

組織のため、または目的のために寄付されたときに発生します。

位置情報の発見: EVENT_NAME_FIND_LOCATION

利用者が訪問する目的でウェブかアプリ経由であなたの位置情報の1つを見つけたときに発生します。たとえば、お客が製品を検索していて、あなたの実際の店舗のいずれかで見つけた場合など。

チェックアウト開始: EVENT_NAME_INITIATED_CHECKOUT

valueToSum:カート内のアイテムの合計額

CONTENT_TYPECONTENT_IDまたはCONTENTNUM_ITEMSPAYMENT_INFO_AVAILABLE、およびCURRENCY

チェックアウトプロセスを開始したときに発生します。

購入: EVENT_NAME_PURCHASED

valueToSum:購入の価格

NUM_ITEMSCONTENT_TYPECONTENT_IDまたはCONTENT、およびCURRENCY

購入が完了したときに発生します。通常は、注文や購入確認を受け取ったとき、または取引を受け付けたときに指定されます。

評価: EVENT_NAME_RATED

valueToSum:付けられた評価

CONTENT_TYPECONTENT_IDまたはCONTENT、およびMAX_RATING_VALUE

アプリ、ビジネス、または組織内の何らかのものに対する評価。たとえば、レストランレビューアプリ内のレストランの評価。

スケジュール: EVENT_NAME_SCHEDULE

指定したいずれかの場所の訪問の予約。

検索: EVENT_NAME_SEARCHED

CONTENT_TYPESEARCH_STRINGSUCCESS

ウェブサイト、アプリ、またはその他のプロパティで実行した検索。たとえば商品の検索や旅行先の検索など。

クレジット利用: EVENT_NAME_SPENT_CREDITS

valueToSum:クレジット利用合計額

CONTENT_TYPE、およびCONTENT_IDまたはCONTENT

ビジネスやアプリケーションに固有のもの(たとえばアプリ内通貨など)に対する利用者のクレジット利用の取引が完了したときに発生します。

トライアル開始: EVENT_NAME_START_TRIAL

valueToSum:購読の価格

ORDER_IDCURRENCY

提供している製品やサービスの無料トライアルを利用者が開始したときに発生します。

申し込みの送信: EVENT_NAME_SUBMIT_APPLICATION

クレジットカード、教育プログラム、または仕事など、提供する製品、サービスまたはプログラムに利用者が申し込む場合に発生します。

購読: EVENT_NAME_SUBSCRIBE

valueToSum:購読の価格

ORDER_IDCURRENCY

提供している製品やサービスの有料サブスクリプションの開始時に発生します。

アチーブメントアンロック: EVENT_NAME_UNLOCKED_ACHIEVEMENT

DESCRIPTION

アプリ、ビジネス、または組織内の、リワードを提供する特定のアクティビティまたはアクションの完了時に発生します。たとえば、友達の照会やプロフィールの入力など。

コンテンツビュー: EVENT_NAME_VIEWED_CONTENT

閲覧されたアイテムの価格(該当する場合)

CONTENT_TYPECONTENT_IDまたはCONTENT、およびCURRENCY

商品ページ、ランディングページ、記事など、関心のあるコンテンツページの訪問時に発生します。閲覧したページに関する情報はFacebookに渡され、ダイナミック広告に使用されます。

Standard Event Parameters

AppEventConstants::EVENT_PARAM_* Possible Values Description

Ad Type:

EVENT_PARAM_AD_TYPE

string

Type of ad: banner, interstitial, rewarded_video, native

Content:

EVENT_PARAM_CONTENT

string

A list of JSON object that contains the International Article Number (EAN) when applicable, or other product or content identifier(s) as well as additional information about the products. id, quantity, and item_price are the available fields. e.g. "[{\"id\": \"1234\", \"quantity\": 2, \"item_price\": 5.99}, {\"id\": \"5678\", \"quantity\": 1, \"item_price\": 9.99}]"

Content ID:

EVENT_PARAM_CONTENT_ID

string

International Article Number (EAN) when applicable, or other product or content identifier

Content Type:

EVENT_PARAM_CONTENT_TYPE

string

'product' or 'product_group'

Currency:

EVENT_PARAM_CURRENCY

string

ISO 4217 code, e.g., "EUR", "USD", "JPY"

Description:

EVENT_PARAM_DESCRIPTION

string

A string description

Level:

EVENT_PARAM_LEVEL

string

Level of a game

Max. Rating Value:

EVENT_PARAM_MAX_RATING_VALUE

int

Upper bounds of a rating scale, for example 5 on a 5 star scale

Number of Items:

EVENT_PARAM_NUM_ITEMS

int

Number of items

Order ID:

EVENT_PARAM_ORDER_ID

string

The unique ID for all events within a subscription

Payment Info Available:

EVENT_PARAM_PAYMENT_INFO_AVAILABLE

1 or 0

1 for yes, 0 for no

Registration Method:

EVENT_PARAM_REGISTRATION_METHOD

string

Facebook, Email, Twitter, etc.

Search String:

EVENT_PARAM_SEARCH_STRING

string

The text string that was searched for

Success:

EVENT_PARAM_SUCCESS

1 or 0

1 for yes, 0 for no