CustomAudiences

広告アカウントに定義されたカスタムオーディエンスの情報をクエリします。

テーブル固有の情報

Facebook Ads のCustomAudiences は、広告を配信する対象として広告主が定義したオーディエンスを表します。

SELECT

ExternalEventSource カラムは、基となるAdPixels オブジェクトへの追加の権限が必要なため、デフォルトでは返されません。このカラムの情報を取得するには、クエリのプロジェクション（射影）に明示的に指定する必要があります。

SELECT Id, Name, ExternalEventSource FROM CustomAudiences

Note： ExternalEventSource を選択した状態でCustomAudiences を一覧表示した場合、現在認証済みのアプリが基となるAdsPixel オブジェクトへのアクセス権を持つCustomAudiences のみが返されます。

Insert

CustomAudiences を挿入する際は、少なくともName、Subtype、およびCustomerFileSource を指定する必要があります。

INSERT INTO CustomAudiences (Name, Subtype, CustomerFileSource) VALUES ('Custom Audience', 'CUSTOM', 'USER_PROVIDED_ONLY')

Note： カスタムオーディエンスにユーザーを追加するには、AddCustomAudienceUsers ストアドプロシージャを使用してください。

Update

CustomAudiences を更新する際は、WHERE 句にオブジェクトのID を指定する必要があります。

UPDATE CustomAudiences SET Name='TestCustomAudience123' WHERE ID='123abc'

Note：Facebook マーケティングAPI で更新がサポートされているフィールドは以下のみです：Name、Description、Rule、RuleAggregation、RetentionDays、CustomerFileSource、OptOutLink、EnableFetchOrCreate、UseInCampaigns、ContentType、ClaimObjective、EventSourceGroup、ProductSetId

Delete

CustomAudiences を削除する際は、オブジェクトのId を指定してください。

DELETE FROM CustomAudiences WHERE Id='123456'

Note： カスタムオーディエンスからユーザーを削除するには、DeleteCustomAudienceUsers ストアドプロシージャを使用してください。

Columns


Name	Type	ReadOnly	Description
ID [KEY]	String	True	カスタムオーディエンスのID。
Target	String	False	カスタムオーディエンスを取得するアカウント、キャンペーン、広告グループ、または広告のID。
Account_ID	String	True	カスタムオーディエンスの広告アカウントのID。
Name	String	False	カスタムオーディエンスの名前。
Description	String	False	カスタムオーディエンスの説明。
Subtype	String	False	カスタムオーディエンスのサブタイプ。有効な値は次のとおりです: CUSTOM, PRIMARY, WEBSITE, APP, OFFLINE_CONVERSION, CLAIM, MANAGED, PARTNER, VIDEO, LOOKALIKE, ENGAGEMENT, BAG_OF_ACCOUNTS, STUDY_RULE_AUDIENCE, FOX, MEASUREMENT, REGULATED_CATEGORIES_AUDIENCE, BIDDING, SUBSCRIBER_SEGMENT, EXCLUSION
TimeCreated	Datetime	True	カスタムオーディエンスの作成日時。
TimeUpdated	Datetime	True	カスタムオーディエンスの最終更新日時。
TimeContentUpdated	Datetime	True	このカスタムオーディエンスのユーザーが最後に更新された日時。顧客ファイルに基づくカスタムオーディエンスのみサポートされます。
Rule	String	False	参照元URL に適用するオーディエンスルール。
RuleAggregation	String	False	オーディエンスルールに対する集約設定。
ApproximateCountLowerBound	Integer	True	このオーディエンスのおおよその人数の下限値。
ApproximateCountUpperBound	Integer	True	このオーディエンスのおおよその人数の上限値。
PixelID	String	False	ウェブサイトカスタムオーディエンス用のイベントを収集しているピクセルのID。
RetentionDays	Integer	False	このオーディエンスにユーザーを保持する日数。1〜180 日の範囲で指定できます。未指定の場合はデフォルトで無期限になります。顧客ファイルに基づくカスタムオーディエンスのみ使用できます。
CustomerFileSource	String	False	アップロードされたファイル内の顧客情報のソース。
DataSource	String	True	カスタムオーディエンスの作成方法を示す JSON ディクショナリ。
DeliveryStatus	String	True	オーディエンスを広告で使用できるかどうかを示す JSON ディクショナリ。
ExternalEventSource	String	True	カスタムオーディエンスを生成したピクセルID を含む JSON ディクショナリ。明示的に指定した場合のみ返されます。
OperationStatus	String	True	最後の操作のステータスコードと説明を含む JSON ディクショナリ。
PermissionForActions	String	True	カスタムオーディエンスが持つ権限（文字列）と真偽値のマッピングを含む JSON ディクショナリ。
IsValueBased	Boolean	False	このオーディエンスを価値ベースの類似オーディエンスのシードとして使用するかどうか。
OptOutLink	String	False	ターゲティングを希望しないオーディエンスメンバー向けのオプトアウト URL。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるデータを詳細に制御することができます。


Name	Type	Description
EnableFetchOrCreate	Boolean	INSERT 時に true に設定すると、同一のカスタムオーディエンスが既に存在する場合にそれを取得します。重複するオーディエンスの INSERT を防止します。
UseInCampaigns	Boolean	このカスタムオーディエンスをキャンペーンで使用するかどうかを制御します。デフォルトは true です。
Prefill	Boolean	true の場合、オーディエンス作成前に記録されたウェブサイトのトラフィックを使用してオーディエンスを初期化します。false の場合、オーディエンス作成後に取得したウェブサイトのトラフィックのみが使用されます。
DatasetId	Integer	このオーディエンスに関連付けられたオフラインコンバージョンデータセットのID。
ContentType	String	TRAVEL クレーム目的のコンテンツタイプを指定します。TRAVEL クレーム目的でオーディエンスを作成する場合は必須です。有効な値は次のとおりです: AUTOMOTIVE_MODEL, DESTINATION, FLIGHT, GENERIC, HOME_LISTING, HOTEL, JOB, LOCAL_SERVICE_BUSINESS, MEDIA_TITLE, OFFLINE_PRODUCT, PRODUCT, VEHICLE, VEHICLE_OFFER
ClaimObjective	String	CLAIM サブタイプのオーディエンスの目的を指定します。有効な値は次のとおりです: AUTOMOTIVE_MODEL, COLLABORATIVE_ADS, HOME_LISTING, MEDIA_TITLE, PRODUCT, TRAVEL, VEHICLE, VEHICLE_OFFER
EventSourceGroup	Integer	TRAVEL クレーム目的を使用する場合のイベントソースグループを指定します。
ProductSetId	Integer	このオーディエンスでターゲットにするプロダクトセットのID。
OriginAudienceId	Integer	元のカスタムオーディエンスのID。元のオーディエンスは最低100 人以上の規模が必要です。

SSIS Components for Facebook Ads