フィールド マッピング

表のマッピングを使用して、ディスプレイ＆ビデオ 360 API のカスタマー マッチ オーディエンス管理メソッドとフィールドを、Data Manager API の同等のメソッドとフィールドにマッピングします。

認証

Data Manager API では、ディスプレイ＆ビデオ 360 API とは異なるスコープの認証情報が必要です。API アクセスを設定するの手順に沿って、Data Manager API スコープを含む新しい認証情報を生成します。

メソッド マッピング

次の表に、ディスプレイ＆ビデオ 360 API メソッドと、同等の Data Manager API メソッドのマッピングを示します。

Display & Video 360 API メソッド Data Manager API メソッド メモ
firstPartyAndPartnerAudiences.get userLists.get Data Manager API で取得できるのは、カスタマー マッチ オーディエンスのみです。
firstPartyAndPartnerAudiences.list userLists.list Data Manager API は、カスタマー マッチ オーディエンスのみを返します。
firstPartyAndPartnerAudiences.create userLists.create ユーザーデータは、Data Manager API の後続のリクエストでアップロードする必要があります。
同等のものはありません userLists.delete Display & Video 360 API では使用できません。
firstPartyAndPartnerAudiences.patch userLists.patch
firstPartyAndPartnerAudiences.editCustomerMatchMembers audienceMembers.ingest カスタマー マッチ オーディエンスのメンバーを追加および削除するには、別々の Data Manager API メソッドを使用します。
firstPartyAndPartnerAudiences.editCustomerMatchMembers audienceMembers.remove カスタマー マッチ オーディエンスのメンバーを追加および削除するには、別々の Data Manager API メソッドを使用します。

リクエスト マッピング

次の表に、ディスプレイ＆ビデオ 360 API メソッドのリクエスト フィールドと、Data Manager API の同等のフィールドのマッピングを示します。

userLists.get

firstPartyAndPartnerAudiences.get（ディスプレイ＆ビデオ 360 API） userLists.get（Data Manager API） メモ
  • advertiserId
  • partnerId
  • firstPartyAndPartnerAudienceId
 name UserList 名には、親広告主またはパートナーの ID とオーディエンス ID の両方が含まれます。詳細については、リソース名をご覧ください。

userLists.list

firstPartyAndPartnerAudiences.list（ディスプレイ＆ビデオ 360 API） userLists.list（Data Manager API） メモ
  • advertiserId
  • partnerId
 parent parent には、親広告主またはパートナーの ID が含まれます。
pageSize pageSize Data Manager API の最大ページサイズは 1000 です。
pageToken pageToken
filter filter
orderBy 同等のものはありません

userLists.create

firstPartyAndPartnerAudiences.create（ディスプレイ＆ビデオ 360 API） userLists.create（Data Manager API） メモ
  • advertiserId
  • partnerId
 parent parent には、新しいオーディエンスの親広告主またはパートナーの ID が含まれます。
同等のものはありません validateOnly
FirstPartyAndPartnerAudience リクエストの本文 UserList リクエストの本文 リクエスト本文のマッピングについては、UserList をご覧ください。

userLists.update

firstPartyAndPartnerAudiences.patch（ディスプレイ＆ビデオ 360 API） userLists.patch（Data Manager API） メモ
  • advertiserId
  • firstPartyAndPartnerAudienceId
 userList.name パラメータ 更新する UserList のリソース名。
updateMask updateMask このフィールドは Data Manager API で推奨されていますが、必須ではありません。空のままにすると、含まれるすべてのフィールドが完全に置き換えられます。
同等のものはありません validateOnly
FirstPartyAndPartnerAudience リクエストの本文 UserList リクエストの本文 リクエスト本文のマッピングについては、UserList をご覧ください。

audienceMembers.ingest

firstPartyAndPartnerAudiences.editCustomerMatchMembers（ディスプレイ＆ビデオ 360 API） audienceMembers.ingest（Data Manager API） メモ
  • advertiserId
  • firstPartyAndPartnerAudienceId
 destinations 詳細については、宛先を構成するをご覧ください。
addedContactInfoList.contactInfos audienceMembers 個々のユーザー識別子は、AudienceMember オブジェクト内の compositeData.userData フィールドで設定できます。詳しくは、ユーザー識別子をご覧ください。
addedContactInfoList.consent consent 同意は個々の AudienceMember オブジェクトで設定することもできます。
addedMobileDeviceIdList.mobileDeviceIds audienceMembers 個々のモバイル デバイス ID は、AudienceMember オブジェクト内の mobileData フィールドに設定されます。
addedMobileDeviceIdList.consent consent 同意は個々の AudienceMember オブジェクトで設定することもできます。
同等のものはありません validateOnly
同等のものはありません encoding 必須。UserIdentifier 値に使用される Encoding に設定します。
同等のものはありません encryptionInfo リクエストに暗号化された値が含まれているかどうかを設定します。詳しくは、暗号化をご覧ください。
同等のものはありません termsOfService 必須。ユーザーがカスタマー マッチの利用規約に同意または拒否したことを示すように設定します。

audienceMembers.remove

firstPartyAndPartnerAudiences.editCustomerMatchMembers（ディスプレイ＆ビデオ 360 API） audienceMembers.remove（Data Manager API） メモ
  • advertiserId
  • firstPartyAndPartnerAudienceId
 destinations
removedContactInfoList.contactInfos audienceMembers 個々のユーザー識別子は、AudienceMember オブジェクト内の compositeData.userData フィールドで設定できます。詳しくは、ユーザー識別子をご覧ください。
removedMobileDeviceIdList.mobileDeviceIds audienceMembers 個々のモバイル デバイス ID は、AudienceMember オブジェクト内の mobileData フィールドに設定されます。
同等のものはありません validateOnly
同等のものはありません encoding 必須。UserIdentifier 値に使用される Encoding に設定します。
同等のものはありません encryptionInfo リクエストに暗号化された値が含まれているかどうかを設定します。詳しくは、暗号化をご覧ください。

オブジェクト フィールドのマッピング

以下に、Display & Video 360 API オブジェクトから Data Manager API の同等のオブジェクトへのマッピングを示します。

UserList

FirstPartyAndPartnerAudience（ディスプレイ＆ビデオ 360 API） UserList（Data Manager API） メモ
name name 別のリソース名形式を使用します。詳細については、リソース名をご覧ください。
firstPartyAndPartnerAudienceId id
同等のものはありません readOnly
displayName displayName
description description
同等のものはありません membershipStatus
同等のものはありません integrationCode
membershipDurationDays membershipDuration
同等のものはありません closingReason
同等のものはありません accessReason
同等のものはありません accountAccessStatus
displayAudienceSize sizeInfo.displayNetworkMembersCount
同等のものはありません sizeInfo.searchNetworkMembersCount
同等のものはありません targetNetworkInfo
同等のものはありません ingestedUserListInfo
firstPartyAndPartnerAudienceType 同等のものはありません
audienceType 同等のものはありません
audienceSource 同等のものはありません
activeDisplayAudienceSize 同等のものはありません
youtubeAudienceSize 同等のものはありません
gmailAudienceSize 同等のものはありません
displayMobileAppAudienceSize 同等のものはありません
displayMobileWebAudienceSize 同等のものはありません
displayDesktopAudienceSize 同等のものはありません
appId ingestedUserListInfo.mobileIdInfo.appId
contactInfoList audienceMembers メソッド Data Manager API で、audienceMembers の ingest メソッドと remove メソッドを使用して、メンバーを追加および削除します。
mobileDeviceIdList audienceMembers メソッド Data Manager API で、audienceMembers の ingest メソッドと remove メソッドを使用して、メンバーを追加および削除します。

リソース名

Data Manager API では、ディスプレイ＆ビデオ 360 API とは異なるリソース名形式が使用されます。

対象となるのは、

ディスプレイ＆ビデオ 360 API では、UserList リソース名にはオーディエンス ID のみを含む形式が使用されます。

firstAndThirdPartyAudiences/{first_and_third_party_audience_id}

Data Manager API

Data Manager API では、UserList リソース名に、オーディエンス ID と、オーディエンスを所有するパートナーまたは広告主の AccountType とアカウント ID を含む形式が使用されます。

accountTypes/{accountType}/accounts/{account}/userLists/{userList}

ユーザー識別情報

userData は引き続きサポートされますが、今後の改善に備えて、compositeData を使用することをおすすめします。詳しくは、複合データをご覧ください。

ContactInfo（ディスプレイ＆ビデオ 360 API） CompositeData（Data Manager API） メモ
hashedEmails userData.userIdentifiers.emailAddress 書式設定とハッシュ化されたメールアドレスに設定します。ハッシュ化されたメールアドレスを暗号化することもできます。複数の UserIdentifier オブジェクトを使用することで、複数のメールアドレスを 1 人のユーザーに照合できます。
hashedPhoneNumbers userData.userIdentifiers.phoneNumber 形式設定とハッシュ化された電話番号に設定します。ハッシュ化された電話番号を暗号化することもできます。複数の UserIdentifier オブジェクトを使用すると、複数の電話番号を使用して 1 人のユーザーを照合できます。
hashedFirstName userData.userIdentifiers.address.givenName フォーマットされハッシュ化された名に設定します。ハッシュ化された姓を暗号化することもできます。
hashedLastName userData.userIdentifiers.address.familyName フォーマットされてハッシュ化されたファミリー名に設定します。ハッシュ化されたファミリー名を暗号化することもできます。
countryCode userData.userIdentifiers.address.regionCode
zipCodes userData.userIdentifiers.address.postalCode 複数の UserIdentifier オブジェクトを使用すると、複数の郵便番号を使用して 1 人のユーザーを照合できます。

宛先

対象となるのは、 Destination（Data Manager API） メモ
ディスプレイ＆ビデオ 360 ユーザーにアクセス権が付与されている広告主またはパートナーの ID。 loginAccount この設定が必要になるのは、ディスプレイ＆ビデオ 360 パートナー アクセス シナリオのみです。このシナリオでは、オーディエンスは広告主の配下にありますが、アクセスするディスプレイ＆ビデオ 360 ユーザーには広告主の親パートナーへのアクセス権が付与されています。それ以外の場合は、設定しないままにできます。
オーディエンスの親広告主またはパートナーの ID。 operatingAccount
firstPartyAndPartnerAudienceId productDestinationId
同等のものはありません reference
前へ
アップグレードの手順