--- title: "GET /userprofiles/{userprofilesId}/campaigns" method: GET path: "/userprofiles/{userprofilesId}/campaigns" tags: ["campaigns"] --- # GET /userprofiles/{userprofilesId}/campaigns `GET /userprofiles/{userprofilesId}/campaigns` ## Request - Base URL: `https://dfareporting.googleapis.com/dfareporting/v5` - URL: `https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{userprofilesId}/campaigns` - Auth: OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/dfatrafficking` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/dfatrafficking` - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieves a list of campaigns, possibly filtered. This method supports paging. ## Path parameters - `userprofilesId` string, required ## Query parameters - `advertiserGroupIds` string[] - `advertiserIds` string[] - `archived` boolean - `atLeastOneOptimizationActivity` boolean - `excludedIds` string[] - `ids` string[] - `maxResults` integer - `overriddenEventTagId` string, int64 - `pageToken` string - `searchString` string - `sortField` 'ID' | 'NAME' - `sortOrder` 'ASCENDING' | 'DESCENDING' - `subaccountId` string, int64 ## Response `200` Successful response - CampaignsListResponse: Campaign List Response - `campaigns` Campaign[]: Campaign collection. - `accountId` string, int64: Account ID of this campaign. This is a read-only field that can be left blank. - `adBlockingConfiguration` AdBlockingConfiguration: Campaign ad blocking settings. - `enabled` boolean: Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. - `additionalCreativeOptimizationConfigurations` CreativeOptimizationConfiguration[]: Additional creative optimization configurations for the campaign. - `id` string, int64: ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. - `name` string: Name of this creative optimization config. This is a required field and must be less than 129 characters long. - `optimizationActivitys` OptimizationActivity[]: List of optimization activities associated with this configuration. - `floodlightActivityId` string, int64: Floodlight activity ID of this optimization activity. This is a required field. - `floodlightActivityIdDimensionValue` DimensionValue: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `weight` integer: Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. - `optimizationModel` 'CLICK' | 'POST_CLICK' | 'POST_IMPRESSION' | 'POST_CLICK_AND_IMPRESSION' | 'VIDEO_COMPLETION': Optimization model for this configuration. - `advertiserGroupId` string, int64: Advertiser group ID of the associated advertiser. - `advertiserId` string, int64: Advertiser ID of this campaign. This is a required field. - `advertiserIdDimensionValue` DimensionValue: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `archived` boolean: Whether this campaign has been archived. - `audienceSegmentGroups` AudienceSegmentGroup[]: Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. - `audienceSegments` AudienceSegment[]: Audience segments assigned to this group. The number of segments must be between 2 and 100. - `allocation` integer: Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. - `id` string, int64: ID of this audience segment. This is a read-only, auto-generated field. - `name` string: Name of this audience segment. This is a required field and must be less than 65 characters long. - `id` string, int64: ID of this audience segment group. This is a read-only, auto-generated field. - `name` string: Name of this audience segment group. This is a required field and must be less than 65 characters long. - `billingInvoiceCode` string: Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. - `clickThroughUrlSuffixProperties` ClickThroughUrlSuffixProperties: Click Through URL Suffix settings. - `clickThroughUrlSuffix` string: Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. - `overrideInheritedSuffix` boolean: Whether this entity should override the inherited click-through URL suffix with its own defined value. - `comment` string: Arbitrary comments about this campaign. Must be less than 256 characters long. - `createInfo` LastModifiedInfo: Modification timestamp. - `time` string, int64: Timestamp of the last change in milliseconds since epoch. - `creativeGroupIds` string[]: List of creative group IDs that are assigned to the campaign. - `creativeOptimizationConfiguration` CreativeOptimizationConfiguration: Creative optimization settings. - `id` string, int64: ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. - `name` string: Name of this creative optimization config. This is a required field and must be less than 129 characters long. - `optimizationActivitys` OptimizationActivity[]: List of optimization activities associated with this configuration. - `floodlightActivityId` string, int64: Floodlight activity ID of this optimization activity. This is a required field. - `floodlightActivityIdDimensionValue` DimensionValue: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `weight` integer: Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. - `optimizationModel` 'CLICK' | 'POST_CLICK' | 'POST_IMPRESSION' | 'POST_CLICK_AND_IMPRESSION' | 'VIDEO_COMPLETION': Optimization model for this configuration. - `defaultClickThroughEventTagProperties` DefaultClickThroughEventTagProperties: Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. - `defaultClickThroughEventTagId` string, int64: ID of the click-through event tag to apply to all ads in this entity's scope. - `overrideInheritedEventTag` boolean: Whether this entity should override the inherited default click-through event tag with its own defined value. - `defaultLandingPageId` string, int64: The default landing page ID for this campaign. - `endDate` string, date - `euPoliticalAdsDeclaration` 'CONTAINS_EU_POLITICAL_ADS' | 'DOES_NOT_CONTAIN_EU_POLITICAL_ADS': Optional. Whether the campaign has EU political ads. Campaign Manager 360 doesn't allow campaigns with EU political ads to serve in the EU. They can still serve in other regions. - `eventTagOverrides` EventTagOverride[]: Overrides that can be used to activate or deactivate advertiser event tags. - `enabled` boolean: Whether this override is enabled. - `id` string, int64: ID of this event tag override. This is a read-only, auto-generated field. - `externalId` string: External ID for this campaign. - `id` string, int64: ID of this campaign. This is a read-only auto-generated field. - `idDimensionValue` DimensionValue: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". - `lastModifiedInfo` LastModifiedInfo: Modification timestamp. - `time` string, int64: Timestamp of the last change in milliseconds since epoch. - `measurementPartnerLink` MeasurementPartnerCampaignLink - `linkStatus` 'MEASUREMENT_PARTNER_UNLINKED' | 'MEASUREMENT_PARTNER_LINKED' | 'MEASUREMENT_PARTNER_LINK_PENDING' | 'MEASUREMENT_PARTNER_LINK_FAILURE' | 'MEASUREMENT_PARTNER_LINK_OPT_OUT' | 'MEASUREMENT_PARTNER_LINK_OPT_OUT_PENDING' | 'MEASUREMENT_PARTNER_LINK_WRAPPING_PENDING' | 'MEASUREMENT_PARTNER_MODE_CHANGE_PENDING' | 'MEASUREMENT_PARTNER_UNLINK_PENDING': . - `measurementPartner` 'NONE' | 'INTEGRAL_AD_SCIENCE' | 'DOUBLE_VERIFY': Measurement partner used for tag wrapping. - `partnerCampaignId` string: Partner campaign ID needed for establishing linking with Measurement partner. - `name` string: Name of this campaign. This is a required field and must be less than 512 characters long and unique among campaigns of the same advertiser. - `startDate` string, date - `subaccountId` string, int64: Subaccount ID of this campaign. This is a read-only field that can be left blank. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse". - `nextPageToken` string: Pagination token to be used for the next list operation. --- [API](https://skmtc.dev/google/apis/dfareporting.md) - [All operations](https://skmtc.dev/google/apis/dfareporting/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/dfareporting/revisions/be73a9a450de?raw)