Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13177414729.5 KB
firstPartyAndPartnerAudiences

Updates an existing FirstPartyAndPartnerAudience. Only supported for the following audience_type: * CUSTOMER_MATCH_CONTACT_INFO * CUSTOMER_MATCH_DEVICE_ID

patch/v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}

Path parameters

firstPartyAndPartnerAudienceIdstring required

Identifier. The unique ID of the first party and partner audience. Assigned by the system.

Query parameters

advertiserIdstring

Required. The ID of the owner advertiser of the updated FirstPartyAndPartnerAudience.

updateMaskstring

Required. The mask to control which fields to update. Updates are only supported for the following fields: * displayName * description * membershipDurationDays

Request body

activeDisplayAudienceSizestring int64

Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.

firstPartyAndPartnerAudienceIdstring int64

Identifier. The unique ID of the first party and partner audience. Assigned by the system.

gmailAudienceSizestring int64

Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.

appIdstring

Optional. The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type CUSTOMER_MATCH_DEVICE_ID

displayMobileAppAudienceSizestring int64

Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.

descriptionstring

Optional. The user-provided description of the audience. Only applicable to first party audiences.

namestring

Output only. The resource name of the first party and partner audience.

displayAudienceSizestring int64

Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.

displayMobileWebAudienceSizestring int64

Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.

audienceType'AUDIENCE_TYPE_UNSPECIFIED' | 'CUSTOMER_MATCH_CONTACT_INFO' | 'CUSTOMER_MATCH_DEVICE_ID' | 'CUSTOMER_MATCH_USER_ID' | 'ACTIVITY_BASED' | 'FREQUENCY_CAP' | 'TAG_BASED' | 'YOUTUBE_USERS' | 'THIRD_PARTY' | 'COMMERCE' | 'LINEAR' | 'AGENCY'

Immutable. The type of the audience.

displayDesktopAudienceSizestring int64

Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.

firstPartyAndPartnerAudienceType'FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED' | 'TYPE_FIRST_PARTY' | 'TYPE_PARTNER'

Output only. Whether the audience is a first party and partner audience.

youtubeAudienceSizestring int64

Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.

audienceSource'AUDIENCE_SOURCE_UNSPECIFIED' | 'DISPLAY_VIDEO_360' | 'CAMPAIGN_MANAGER' | 'AD_MANAGER' | 'SEARCH_ADS_360' | 'YOUTUBE' | 'ADS_DATA_HUB'

Output only. The source of the audience.

membershipDurationDaysstring int64

Optional. The duration in days that an entry remains in the audience after the qualifying event. The set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * CUSTOMER_MATCH_CONTACT_INFO * CUSTOMER_MATCH_DEVICE_ID

displayNamestring

Optional. The display name of the first party and partner audience.

Response

Successful response