You are hereby granted a non-exclusive, worldwide, royalty-free license to use, copy, modify, + * and distribute this software in source code or binary form for use in connection with the web + * services and APIs provided by Facebook. + * + *
As with any software that integrates with the Facebook platform, your use of this software is + * subject to the Facebook Developer Principles and Policies [http://developers.facebook.com/policy/]. + * This copyright notice shall be included in all copies or substantial portions of the software. + * + *
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ + +package com.facebook.ads.sdk.serverside; + +/** + * Used to specify which messaging channel was used. + * See https://developers.facebook.com/docs/marketing-api/conversions-api/business-messaging + */ +public enum MessagingChannel { + + /** + * Conversation happened on Instagram Direct. + */ + instagram, + + /** + * Conversation happened on Messenger. + */ + messenger, + + /** + * Conversation happened on WhatsApp. + */ + whatsapp, +} diff --git a/src/main/java/com/facebook/ads/sdk/serverside/UserData.java b/src/main/java/com/facebook/ads/sdk/serverside/UserData.java index 63d43b70..c0d861a1 100644 --- a/src/main/java/com/facebook/ads/sdk/serverside/UserData.java +++ b/src/main/java/com/facebook/ads/sdk/serverside/UserData.java @@ -131,6 +131,12 @@ public class UserData { @SerializedName(ServerSideApiConstants.ANONYMOUS_ID) private String anonId = null; + @SerializedName(ServerSideApiConstants.CTWA_CLID) + private String ctwaClid = null; + + @SerializedName(ServerSideApiConstants.PAGE_ID) + private String pageId = null; + /** * Default Constructor. */ @@ -166,12 +172,14 @@ public UserData() { * @param doby Date of birth year * @param madid Mobile Advertiser ID * @param anonId ID of a person who has installed the app anonymously + * @param ctwaClid ID of a conversation that was started on WhatsApp + * @param pageId ID of the page that the ad is associated with */ public UserData(String email, String phone, GenderEnum gender, String dateOfBirth, String lastName, String firstName, String city, String state, String zipcode, String countryCode, String externalId, String clientIpAddress, String clientUserAgent, String fbc, String fbp, String subscriptionId, String fbLoginId, String leadId, - String f5first, String f5last, String fi, String dobd, String dobm, String doby, String madid, String anonId) { + String f5first, String f5last, String fi, String dobd, String dobm, String doby, String madid, String anonId, String ctwaClid, String pageId) { this.emails = Arrays.asList(email); this.phones = Arrays.asList(phone); this.genders = Arrays.asList(gender); @@ -1395,6 +1403,64 @@ public void setAnonId(String anonId) { this.anonId = anonId; } + /** + * Get the ctwaClid of the conversation that was started on WhatsApp + * + * @param ctwaClid the anonymous id + * @return UserData + */ + public UserData ctwaClid(String ctwaClid) { + setCtwaClid(ctwaClid); + return this; + } + + /** + * ctwaClid of the conversation that was started on WhatsApp + * + * @return ctwaClid + */ + public String getCtwaClid() { + return this.ctwaClid; + } + + /** + * Set the ctwaClid of the conversation that was started on WhatsApp + * + * @param ctwaClid the anonymous Id + */ + public void setCtwaClid(String ctwaClid) { + this.ctwaClid = ctwaClid; + } + + /** + * Get the ID of the page that the ad is associated with + * + * @param pageId + * @return UserData + */ + public UserData pageId(String pageId) { + setPageId(pageId); + return this; + } + + /** + * ID of the page that the ad is associated with + * + * @return pageId + */ + public String getPageId() { + return this.pageId; + } + + /** + * Set the ID of the page that the ad is associated with + * + * @param pageId + */ + public void setPageId(String pageId) { + this.pageId = pageId; + } + @Override public boolean equals(Object o) { if (this == o) { @@ -1429,7 +1495,9 @@ public boolean equals(Object o) { && Objects.equals(this.dobm, userData.dobm) && Objects.equals(this.doby, userData.doby) && Objects.equals(this.madid, userData.madid) - && Objects.equals(this.anonId, userData.anonId); + && Objects.equals(this.anonId, userData.anonId) + && Objects.equals(this.ctwaClid, userData.ctwaClid) + && Objects.equals(this.pageId, userData.pageId); } @Override @@ -1460,7 +1528,9 @@ public int hashCode() { dobm, doby, madid, - anonId); + anonId, + ctwaClid, + pageId); } @Override @@ -1494,6 +1564,8 @@ public String toString() { sb.append(" doby: ").append(toIndentedString(doby)).append("\n"); sb.append(" madid: ").append(toIndentedString(madid)).append("\n"); sb.append(" anonId: ").append(toIndentedString(anonId)).append("\n"); + sb.append(" ctwaClid: ").append(toIndentedString(ctwaClid)).append("\n"); + sb.append(" pageId: ").append(toIndentedString(pageId)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/com/facebook/ads/utils/ServerSideApiConstants.java b/src/main/java/com/facebook/ads/utils/ServerSideApiConstants.java index ca4dc521..bda6bbed 100644 --- a/src/main/java/com/facebook/ads/utils/ServerSideApiConstants.java +++ b/src/main/java/com/facebook/ads/utils/ServerSideApiConstants.java @@ -72,4 +72,8 @@ public class ServerSideApiConstants { public static final String MOBILE_ADVERTISER_ID = "madid"; public static final String ANONYMOUS_ID = "anon_id"; + + public static final String CTWA_CLID = "ctwa_clid"; + + public static final String PAGE_ID = "page_id"; }