Google Git
Sign in
android/platform/external/python/google-api-python-client/cc94ec86e652769e9d3d5cb6d6491efb8d76dd21/./googleapiclient/discovery_cache/documents/dfareporting.v3.4.json
blob: 4bc1152d6422e8208a558f1535d06ca8b45d35f4 [file]
{
"revision": "20201102",
"name": "dfareporting",
"batchPath": "batch",
"protocol": "rest",
"discoveryVersion": "v1",
"version": "v3.4",
"rootUrl": "https://dfareporting.googleapis.com/",
"ownerDomain": "google.com",
"description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/dfatrafficking": {
"description": "View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns"
},
"https://www.googleapis.com/auth/ddmconversions": {
"description": "Manage DoubleClick Digital Marketing conversions"
},
"https://www.googleapis.com/auth/dfareporting": {
"description": "View and manage DoubleClick for Advertisers reports"
}
}
}
},
"baseUrl": "https://dfareporting.googleapis.com/dfareporting/v3.4/",
"canonicalName": "Dfareporting",
"documentationLink": "https://developers.google.com/doubleclick-advertisers/",
"ownerName": "Google",
"schemas": {
"Dimension": {
"properties": {
"name": {
"type": "string",
"description": "The dimension name, e.g. dfa:advertiser"
},
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#dimension."
}
},
"id": "Dimension",
"description": "Represents a dimension.",
"type": "object"
},
"TargetingTemplatesListResponse": {
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetingTemplatesListResponse\".",
"type": "string"
},
"targetingTemplates": {
"description": "Targeting template collection.",
"items": {
"$ref": "TargetingTemplate"
},
"type": "array"
},
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
}
},
"description": "Targeting Template List Response",
"id": "TargetingTemplatesListResponse"
},
"SiteSettings": {
"id": "SiteSettings",
"properties": {
"adBlockingOptOut": {
"type": "boolean",
"description": "Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect."
},
"videoActiveViewOptOutTemplate": {
"type": "boolean",
"description": "Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement."
},
"tagSetting": {
"$ref": "TagSetting",
"description": "Configuration settings for dynamic and image floodlight tags."
},
"disableNewCookie": {
"type": "boolean",
"description": "Whether new cookies are disabled for this site."
},
"vpaidAdapterChoiceTemplate": {
"description": "Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.",
"enum": [
"DEFAULT",
"FLASH",
"HTML5",
"BOTH"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"activeViewOptOut": {
"type": "boolean",
"description": "Whether active view creatives are disabled for this site."
}
},
"type": "object",
"description": "Site Settings"
},
"SubaccountsListResponse": {
"id": "SubaccountsListResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccountsListResponse\".",
"type": "string"
},
"subaccounts": {
"description": "Subaccount collection.",
"items": {
"$ref": "Subaccount"
},
"type": "array"
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to be used for the next list operation."
}
},
"description": "Subaccount List Response",
"type": "object"
},
"TagSetting": {
"id": "TagSetting",
"properties": {
"keywordOption": {
"description": "Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.",
"enumDescriptions": [
"",
"",
""
],
"enum": [
"PLACEHOLDER_WITH_LIST_OF_KEYWORDS",
"IGNORE",
"GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD"
],
"type": "string"
},
"additionalKeyValues": {
"type": "string",
"description": "Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field."
},
"includeClickThroughUrls": {
"type": "boolean",
"description": "Whether static landing page URLs should be included in the tags. This setting applies only to placements."
},
"includeClickTracking": {
"type": "boolean",
"description": "Whether click-tracking string should be included in the tags."
}
},
"description": "Tag Settings",
"type": "object"
},
"TagData": {
"properties": {
"clickTag": {
"type": "string",
"description": "Tag string to record a click."
},
"creativeId": {
"format": "int64",
"description": "Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.",
"type": "string"
},
"format": {
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"description": "TagData tag format of this tag.",
"type": "string",
"enum": [
"PLACEMENT_TAG_STANDARD",
"PLACEMENT_TAG_IFRAME_JAVASCRIPT",
"PLACEMENT_TAG_IFRAME_ILAYER",
"PLACEMENT_TAG_INTERNAL_REDIRECT",
"PLACEMENT_TAG_JAVASCRIPT",
"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
"PLACEMENT_TAG_CLICK_COMMANDS",
"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
"PLACEMENT_TAG_TRACKING",
"PLACEMENT_TAG_TRACKING_IFRAME",
"PLACEMENT_TAG_TRACKING_JAVASCRIPT",
"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
"PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
"PLACEMENT_TAG_JAVASCRIPT_LEGACY",
"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
]
},
"impressionTag": {
"description": "Tag string for serving an ad.",
"type": "string"
},
"adId": {
"type": "string",
"description": "Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.",
"format": "int64"
}
},
"type": "object",
"description": "Placement Tag Data",
"id": "TagData"
},
"AdvertisersListResponse": {
"id": "AdvertisersListResponse",
"type": "object",
"description": "Advertiser List Response",
"properties": {
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
},
"advertisers": {
"items": {
"$ref": "Advertiser"
},
"description": "Advertiser collection.",
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertisersListResponse\".",
"type": "string"
}
}
},
"ConversionsBatchInsertResponse": {
"description": "Insert Conversions Response.",
"properties": {
"hasFailures": {
"description": "Indicates that some or all conversions failed to insert.",
"type": "boolean"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertResponse\".",
"type": "string"
},
"status": {
"type": "array",
"description": "The insert status of each conversion. Statuses are returned in the same order that conversions are inserted.",
"items": {
"$ref": "ConversionStatus"
}
}
},
"type": "object",
"id": "ConversionsBatchInsertResponse"
},
"DirectorySite": {
"description": "DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.",
"properties": {
"settings": {
"description": "Directory site settings.",
"$ref": "DirectorySiteSettings"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySite\".",
"type": "string"
},
"interstitialTagFormats": {
"items": {
"enum": [
"IFRAME_JAVASCRIPT_INTERSTITIAL",
"INTERNAL_REDIRECT_INTERSTITIAL",
"JAVASCRIPT_INTERSTITIAL"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"type": "array",
"description": "Tag types for interstitial placements. Acceptable values are: - \"IFRAME_JAVASCRIPT_INTERSTITIAL\" - \"INTERNAL_REDIRECT_INTERSTITIAL\" - \"JAVASCRIPT_INTERSTITIAL\" "
},
"id": {
"format": "int64",
"description": "ID of this directory site. This is a read-only, auto-generated field.",
"type": "string"
},
"url": {
"description": "URL of this directory site.",
"type": "string"
},
"idDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of this directory site. This is a read-only, auto-generated field."
},
"name": {
"type": "string",
"description": "Name of this directory site."
},
"inpageTagFormats": {
"items": {
"type": "string",
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"STANDARD",
"IFRAME_JAVASCRIPT_INPAGE",
"INTERNAL_REDIRECT_INPAGE",
"JAVASCRIPT_INPAGE"
]
},
"type": "array",
"description": "Tag types for regular placements. Acceptable values are: - \"STANDARD\" - \"IFRAME_JAVASCRIPT_INPAGE\" - \"INTERNAL_REDIRECT_INPAGE\" - \"JAVASCRIPT_INPAGE\" "
}
},
"type": "object",
"id": "DirectorySite"
},
"ClickThroughUrl": {
"description": "Click-through URL",
"id": "ClickThroughUrl",
"properties": {
"computedClickThroughUrl": {
"description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. ",
"type": "string"
},
"defaultLandingPage": {
"description": "Whether the campaign default landing page is used.",
"type": "boolean"
},
"customClickThroughUrl": {
"description": "Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.",
"type": "string"
},
"landingPageId": {
"description": "ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.",
"type": "string",
"format": "int64"
}
},
"type": "object"
},
"EventTagsListResponse": {
"id": "EventTagsListResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTagsListResponse\".",
"type": "string"
},
"eventTags": {
"description": "Event tag collection.",
"type": "array",
"items": {
"$ref": "EventTag"
}
}
},
"type": "object",
"description": "Event Tag List Response"
},
"ListPopulationRule": {
"id": "ListPopulationRule",
"type": "object",
"properties": {
"listPopulationClauses": {
"description": "Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.",
"items": {
"$ref": "ListPopulationClause"
},
"type": "array"
},
"floodlightActivityName": {
"type": "string",
"description": "Name of floodlight activity associated with this rule. This is a read-only, auto-generated field."
},
"floodlightActivityId": {
"description": "Floodlight activity ID associated with this rule. This field can be left blank.",
"format": "int64",
"type": "string"
}
},
"description": "Remarketing List Population Rule."
},
"CustomEventsBatchInsertRequest": {
"description": "Insert Custom Events Request.",
"id": "CustomEventsBatchInsertRequest",
"properties": {
"customEvents": {
"description": "The set of custom events to insert.",
"type": "array",
"items": {
"$ref": "CustomEvent"
}
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventsBatchInsertRequest\".",
"type": "string"
}
},
"type": "object"
},
"PlacementStrategy": {
"properties": {
"id": {
"format": "int64",
"description": "ID of this placement strategy. This is a read-only, auto-generated field.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategy\".",
"type": "string"
},
"name": {
"description": "Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.",
"type": "string"
},
"accountId": {
"type": "string",
"format": "int64",
"description": "Account ID of this placement strategy.This is a read-only field that can be left blank."
}
},
"id": "PlacementStrategy",
"description": "Contains properties of a placement strategy.",
"type": "object"
},
"AdvertiserLandingPagesListResponse": {
"id": "AdvertiserLandingPagesListResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserLandingPagesListResponse\".",
"type": "string"
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to be used for the next list operation."
},
"landingPages": {
"description": "Landing page collection",
"items": {
"$ref": "LandingPage"
},
"type": "array"
}
},
"description": "Landing Page List Response",
"type": "object"
},
"ContentCategoriesListResponse": {
"id": "ContentCategoriesListResponse",
"description": "Content Category List Response",
"properties": {
"contentCategories": {
"description": "Content category collection.",
"type": "array",
"items": {
"$ref": "ContentCategory"
}
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategoriesListResponse\".",
"type": "string"
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to be used for the next list operation."
}
},
"type": "object"
},
"TranscodeSetting": {
"type": "object",
"properties": {
"enabledVideoFormats": {
"items": {
"format": "int32",
"type": "integer"
},
"type": "array",
"description": "Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#transcodeSetting\".",
"type": "string"
}
},
"description": "Transcode Settings",
"id": "TranscodeSetting"
},
"OrderDocument": {
"type": "object",
"properties": {
"signed": {
"description": "Whether this order document has been signed.",
"type": "boolean"
},
"type": {
"description": "Type of this order document",
"type": "string",
"enum": [
"PLANNING_ORDER_TYPE_INSERTION_ORDER",
"PLANNING_ORDER_TYPE_CHANGE_ORDER"
],
"enumDescriptions": [
"",
""
]
},
"orderId": {
"format": "int64",
"type": "string",
"description": "ID of the order from which this order document is created."
},
"advertiserId": {
"format": "int64",
"type": "string",
"description": "Advertiser ID of this order document."
},
"createdInfo": {
"$ref": "LastModifiedInfo",
"description": "Information about the creation of this order document."
},
"cancelled": {
"type": "boolean",
"description": "Whether this order document is cancelled."
},
"subaccountId": {
"format": "int64",
"description": "Subaccount ID of this order document.",
"type": "string"
},
"accountId": {
"type": "string",
"description": "Account ID of this order document.",
"format": "int64"
},
"approvedByUserProfileIds": {
"description": "IDs of users who have approved this order document.",
"items": {
"type": "string",
"format": "int64"
},
"type": "array"
},
"projectId": {
"type": "string",
"description": "Project ID of this order document.",
"format": "int64"
},
"id": {
"format": "int64",
"description": "ID of this order document.",
"type": "string"
},
"lastSentTime": {
"format": "date-time",
"type": "string"
},
"effectiveDate": {
"format": "date",
"type": "string"
},
"title": {
"type": "string",
"description": "Title of this order document."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocument\"."
},
"lastSentRecipients": {
"items": {
"type": "string"
},
"description": "List of email addresses that received the last sent document.",
"type": "array"
},
"amendedOrderDocumentId": {
"description": "The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.",
"format": "int64",
"type": "string"
}
},
"id": "OrderDocument",
"description": "Contains properties of a Planning order document."
},
"OrdersListResponse": {
"description": "Order List Response",
"type": "object",
"properties": {
"orders": {
"description": "Order collection.",
"items": {
"$ref": "Order"
},
"type": "array"
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to be used for the next list operation."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ordersListResponse\"."
}
},
"id": "OrdersListResponse"
},
"PlacementGroupsListResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroupsListResponse\".",
"type": "string"
},
"placementGroups": {
"type": "array",
"items": {
"$ref": "PlacementGroup"
},
"description": "Placement group collection."
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to be used for the next list operation."
}
},
"type": "object",
"id": "PlacementGroupsListResponse",
"description": "Placement Group List Response"
},
"DirectorySiteSettings": {
"id": "DirectorySiteSettings",
"description": "Directory Site Settings",
"properties": {
"instreamVideoPlacementAccepted": {
"description": "Whether this site accepts in-stream video ads.",
"type": "boolean"
},
"dfpSettings": {
"description": "Directory site Ad Manager settings.",
"$ref": "DfpSettings"
},
"interstitialPlacementAccepted": {
"description": "Whether this site accepts interstitial ads.",
"type": "boolean"
},
"activeViewOptOut": {
"type": "boolean",
"description": "Whether this directory site has disabled active view creatives."
}
},
"type": "object"
},
"UserRole": {
"id": "UserRole",
"description": "Contains properties of auser role, which is used to manage user access.",
"type": "object",
"properties": {
"permissions": {
"items": {
"$ref": "UserRolePermission"
},
"description": "List of permissions associated with this user role.",
"type": "array"
},
"defaultUserRole": {
"type": "boolean",
"description": "Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRole\".",
"type": "string"
},
"name": {
"description": "Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.",
"type": "string"
},
"accountId": {
"type": "string",
"format": "int64",
"description": "Account ID of this user role. This is a read-only field that can be left blank."
},
"parentUserRoleId": {
"format": "int64",
"description": "ID of the user role that this user role is based on or copied from. This is a required field.",
"type": "string"
},
"subaccountId": {
"description": "Subaccount ID of this user role. This is a read-only field that can be left blank.",
"type": "string",
"format": "int64"
},
"id": {
"type": "string",
"description": "ID of this user role. This is a read-only, auto-generated field.",
"format": "int64"
}
}
},
"CustomEventClickAnnotation": {
"properties": {
"gclid": {
"description": "The Google click ID. Use this field to annotate the click associated with the gclid.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventClickAnnotation\"."
}
},
"id": "CustomEventClickAnnotation",
"description": "Annotate a click event.",
"type": "object"
},
"CountriesListResponse": {
"properties": {
"countries": {
"items": {
"$ref": "Country"
},
"description": "Country collection.",
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#countriesListResponse\".",
"type": "string"
}
},
"description": "Country List Response",
"type": "object",
"id": "CountriesListResponse"
},
"Size": {
"type": "object",
"description": "Represents the dimensions of ads, placements, creatives, or creative assets.",
"id": "Size",
"properties": {
"iab": {
"type": "boolean",
"description": "IAB standard size. This is a read-only, auto-generated field."
},
"id": {
"description": "ID of this size. This is a read-only, auto-generated field.",
"format": "int64",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#size\".",
"type": "string"
},
"height": {
"format": "int32",
"description": "Height of this size. Acceptable values are 0 to 32767, inclusive.",
"type": "integer"
},
"width": {
"format": "int32",
"description": "Width of this size. Acceptable values are 0 to 32767, inclusive.",
"type": "integer"
}
}
},
"TagSettings": {
"description": "Dynamic and Image Tag Settings.",
"properties": {
"dynamicTagEnabled": {
"description": "Whether dynamic floodlight tags are enabled.",
"type": "boolean"
},
"imageTagEnabled": {
"type": "boolean",
"description": "Whether image tags are enabled."
}
},
"id": "TagSettings",
"type": "object"
},
"PostalCodesListResponse": {
"properties": {
"postalCodes": {
"description": "Postal code collection.",
"type": "array",
"items": {
"$ref": "PostalCode"
}
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCodesListResponse\".",
"type": "string"
}
},
"id": "PostalCodesListResponse",
"type": "object",
"description": "Postal Code List Response"
},
"CampaignsListResponse": {
"description": "Campaign List Response",
"properties": {
"nextPageToken": {
"type": "string",
"description": "Pagination token to be used for the next list operation."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignsListResponse\"."
},
"campaigns": {
"items": {
"$ref": "Campaign"
},
"type": "array",
"description": "Campaign collection."
}
},
"id": "CampaignsListResponse",
"type": "object"
},
"UserRolePermissionGroup": {
"description": "Represents a grouping of related user role permissions.",
"properties": {
"name": {
"type": "string",
"description": "Name of this user role permission group."
},
"id": {
"description": "ID of this user role permission.",
"format": "int64",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroup\".",
"type": "string"
}
},
"id": "UserRolePermissionGroup",
"type": "object"
},
"PostalCode": {
"id": "PostalCode",
"properties": {
"id": {
"type": "string",
"description": "ID of this postal code."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCode\".",
"type": "string"
},
"countryDartId": {
"description": "DART ID of the country to which this postal code belongs.",
"type": "string",
"format": "int64"
},
"countryCode": {
"description": "Country code of the country to which this postal code belongs.",
"type": "string"
},
"code": {
"type": "string",
"description": "Postal code. This is equivalent to the id field."
}
},
"type": "object",
"description": "Contains information about a postal code that can be targeted by ads."
},
"RichMediaExitOverride": {
"id": "RichMediaExitOverride",
"description": "Rich Media Exit Override.",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether to use the clickThroughUrl. If false, the creative-level exit will be used."
},
"clickThroughUrl": {
"$ref": "ClickThroughUrl",
"description": "Click-through URL of this rich media exit override. Applicable if the enabled field is set to true."
},
"exitId": {
"format": "int64",
"type": "string",
"description": "ID for the override to refer to a specific exit in the creative."
}
}
},
"ChangeLogsListResponse": {
"properties": {
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
},
"changeLogs": {
"type": "array",
"items": {
"$ref": "ChangeLog"
},
"description": "Change log collection."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLogsListResponse\"."
}
},
"id": "ChangeLogsListResponse",
"type": "object",
"description": "Change Log List Response"
},
"PlacementsGenerateTagsResponse": {
"properties": {
"placementTags": {
"type": "array",
"items": {
"$ref": "PlacementTag"
},
"description": "Set of generated tags for the specified placements."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsGenerateTagsResponse\"."
}
},
"id": "PlacementsGenerateTagsResponse",
"description": "Placement GenerateTags Response",
"type": "object"
},
"AccountUserProfilesListResponse": {
"properties": {
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfilesListResponse\"."
},
"accountUserProfiles": {
"description": "Account user profile collection.",
"type": "array",
"items": {
"$ref": "AccountUserProfile"
}
}
},
"type": "object",
"id": "AccountUserProfilesListResponse",
"description": "Account User Profile List Response"
},
"Advertiser": {
"properties": {
"advertiserGroupId": {
"description": "ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.",
"type": "string",
"format": "int64"
},
"idDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of this advertiser. This is a read-only, auto-generated field."
},
"floodlightConfigurationId": {
"format": "int64",
"description": "Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. ",
"type": "string"
},
"name": {
"description": "Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiser\".",
"type": "string"
},
"defaultClickThroughEventTagId": {
"format": "int64",
"type": "string",
"description": "ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns."
},
"clickThroughUrlSuffix": {
"description": "Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.",
"type": "string"
},
"status": {
"description": "Status of this advertiser.",
"enumDescriptions": [
"",
""
],
"enum": [
"APPROVED",
"ON_HOLD"
],
"type": "string"
},
"defaultEmail": {
"description": "Default email address used in sender field for tag emails.",
"type": "string"
},
"accountId": {
"format": "int64",
"type": "string",
"description": "Account ID of this advertiser.This is a read-only field that can be left blank."
},
"originalFloodlightConfigurationId": {
"type": "string",
"format": "int64",
"description": "Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement."
},
"suspended": {
"type": "boolean",
"description": "Suspension status of this advertiser."
},
"subaccountId": {
"description": "Subaccount ID of this advertiser.This is a read-only field that can be left blank.",
"format": "int64",
"type": "string"
},
"floodlightConfigurationIdDimensionValue": {
"description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"id": {
"description": "ID of this advertiser. This is a read-only, auto-generated field.",
"type": "string",
"format": "int64"
}
},
"description": "Contains properties of a Campaign Manager advertiser.",
"type": "object",
"id": "Advertiser"
},
"AudienceSegment": {
"type": "object",
"properties": {
"id": {
"format": "int64",
"type": "string",
"description": "ID of this audience segment. This is a read-only, auto-generated field."
},
"allocation": {
"type": "integer",
"format": "int32",
"description": "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."
},
"name": {
"type": "string",
"description": "Name of this audience segment. This is a required field and must be less than 65 characters long."
}
},
"description": "Audience Segment.",
"id": "AudienceSegment"
},
"LanguageTargeting": {
"description": "Language Targeting.",
"type": "object",
"properties": {
"languages": {
"items": {
"$ref": "Language"
},
"type": "array",
"description": "Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated."
}
},
"id": "LanguageTargeting"
},
"BrowsersListResponse": {
"description": "Browser List Response",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browsersListResponse\"."
},
"browsers": {
"type": "array",
"items": {
"$ref": "Browser"
},
"description": "Browser collection."
}
},
"type": "object",
"id": "BrowsersListResponse"
},
"UserProfileList": {
"id": "UserProfileList",
"properties": {
"items": {
"description": "The user profiles returned in this response.",
"type": "array",
"items": {
"$ref": "UserProfile"
}
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userProfileList\".",
"type": "string"
}
},
"type": "object",
"description": "Represents the list of user profiles."
},
"OperatingSystemsListResponse": {
"description": "Operating System List Response",
"id": "OperatingSystemsListResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemsListResponse\".",
"type": "string"
},
"operatingSystems": {
"items": {
"$ref": "OperatingSystem"
},
"description": "Operating system collection.",
"type": "array"
}
},
"type": "object"
},
"SiteVideoSettings": {
"properties": {
"obaEnabled": {
"description": "Whether OBA icons are enabled for this placement.",
"type": "boolean"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteVideoSettings\"."
},
"orientation": {
"enumDescriptions": [
"",
"",
""
],
"description": "Orientation of a site template used for video. This will act as default for new placements created under this site.",
"enum": [
"ANY",
"LANDSCAPE",
"PORTRAIT"
],
"type": "string"
},
"obaSettings": {
"description": "Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.",
"$ref": "ObaIcon"
},
"companionSettings": {
"$ref": "SiteCompanionSetting",
"description": "Settings for the companion creatives of video creatives served to this site."
},
"skippableSettings": {
"description": "Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.",
"$ref": "SiteSkippableSetting"
},
"transcodeSettings": {
"description": "Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.",
"$ref": "SiteTranscodeSetting"
}
},
"type": "object",
"id": "SiteVideoSettings",
"description": "Video Settings"
},
"ChangeLog": {
"properties": {
"id": {
"format": "int64",
"description": "ID of this change log.",
"type": "string"
},
"oldValue": {
"type": "string",
"description": "Old value of the object field."
},
"userProfileId": {
"description": "ID of the user who modified the object.",
"format": "int64",
"type": "string"
},
"userProfileName": {
"description": "User profile name of the user who modified the object.",
"type": "string"
},
"objectId": {
"format": "int64",
"description": "ID of the object of this change log. The object could be a campaign, placement, ad, or other type.",
"type": "string"
},
"accountId": {
"format": "int64",
"type": "string",
"description": "Account ID of the modified object."
},
"action": {
"description": "Action which caused the change.",
"type": "string"
},
"newValue": {
"type": "string",
"description": "New value of the object field."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLog\".",
"type": "string"
},
"subaccountId": {
"format": "int64",
"type": "string",
"description": "Subaccount ID of the modified object."
},
"fieldName": {
"description": "Field name of the object which changed.",
"type": "string"
},
"changeTime": {
"format": "date-time",
"type": "string"
},
"transactionId": {
"description": "Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.",
"format": "int64",
"type": "string"
},
"objectType": {
"type": "string",
"description": "Object type of the change log."
}
},
"description": "Describes a change that a user has made to a resource.",
"id": "ChangeLog",
"type": "object"
},
"SitesListResponse": {
"id": "SitesListResponse",
"type": "object",
"description": "Site List Response",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sitesListResponse\".",
"type": "string"
},
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
},
"sites": {
"items": {
"$ref": "Site"
},
"description": "Site collection.",
"type": "array"
}
}
},
"CustomEventStatus": {
"description": "The original custom event that was inserted and whether there were any errors.",
"id": "CustomEventStatus",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventStatus\"."
},
"errors": {
"items": {
"$ref": "CustomEventError"
},
"type": "array",
"description": "A list of errors related to this custom event."
},
"customEvent": {
"$ref": "CustomEvent",
"description": "The original custom event that was inserted."
}
}
},
"CreativeAssetSelection": {
"type": "object",
"id": "CreativeAssetSelection",
"description": "Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives.",
"properties": {
"defaultAssetId": {
"format": "int64",
"type": "string",
"description": "A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field."
},
"rules": {
"description": "Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.",
"items": {
"$ref": "Rule"
},
"type": "array"
}
}
},
"CustomViewabilityMetric": {
"id": "CustomViewabilityMetric",
"type": "object",
"description": "Custom Viewability Metric",
"properties": {
"configuration": {
"$ref": "CustomViewabilityMetricConfiguration",
"description": "Configuration of the custom viewability metric."
},
"id": {
"type": "string",
"format": "int64",
"description": "ID of the custom viewability metric."
},
"name": {
"type": "string",
"description": "Name of the custom viewability metric."
}
}
},
"ThirdPartyAuthenticationToken": {
"description": "Third Party Authentication Token",
"id": "ThirdPartyAuthenticationToken",
"properties": {
"name": {
"description": "Name of the third-party authentication token.",
"type": "string"
},
"value": {
"description": "Value of the third-party authentication token. This is a read-only, auto-generated field.",
"type": "string"
}
},
"type": "object"
},
"ReportCompatibleFields": {
"properties": {
"dimensionFilters": {
"type": "array",
"description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
"items": {
"$ref": "Dimension"
}
},
"dimensions": {
"type": "array",
"items": {
"$ref": "Dimension"
},
"description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report."
},
"pivotedActivityMetrics": {
"type": "array",
"items": {
"$ref": "Metric"
},
"description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report."
},
"kind": {
"description": "The kind of resource this is, in this case dfareporting#reportCompatibleFields.",
"type": "string"
},
"metrics": {
"items": {
"$ref": "Metric"
},
"description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
"type": "array"
}
},
"description": "Represents fields that are compatible to be selected for a report of type \"STANDARD\".",
"id": "ReportCompatibleFields",
"type": "object"
},
"PlatformType": {
"type": "object",
"id": "PlatformType",
"description": "Contains information about a platform type that can be targeted by ads.",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformType\".",
"type": "string"
},
"id": {
"type": "string",
"format": "int64",
"description": "ID of this platform type."
},
"name": {
"description": "Name of this platform type.",
"type": "string"
}
}
},
"DeepLink": {
"id": "DeepLink",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#deepLink\"."
},
"remarketingListIds": {
"items": {
"type": "string",
"format": "int64"
},
"description": "Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.",
"type": "array"
},
"fallbackUrl": {
"description": "The fallback URL. This URL will be served to users who do not have the mobile app installed.",
"type": "string"
},
"appUrl": {
"type": "string",
"description": "The URL of the mobile app being linked to."
},
"mobileApp": {
"$ref": "MobileApp",
"description": "The mobile app targeted by this deep link."
}
},
"description": "Contains information about a landing page deep link.",
"type": "object"
},
"CreativeRotation": {
"description": "Creative Rotation.",
"type": "object",
"id": "CreativeRotation",
"properties": {
"creativeAssignments": {
"type": "array",
"items": {
"$ref": "CreativeAssignment"
},
"description": "Creative assignments in this creative rotation."
},
"creativeOptimizationConfigurationId": {
"type": "string",
"format": "int64",
"description": "Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad."
},
"weightCalculationStrategy": {
"type": "string",
"enum": [
"WEIGHT_STRATEGY_EQUAL",
"WEIGHT_STRATEGY_CUSTOM",
"WEIGHT_STRATEGY_HIGHEST_CTR",
"WEIGHT_STRATEGY_OPTIMIZED"
],
"enumDescriptions": [
"",
"",
"",
""
],
"description": "Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM."
},
"type": {
"enumDescriptions": [
"",
""
],
"description": "Type of creative rotation. Can be used to specify whether to use sequential or random rotation.",
"type": "string",
"enum": [
"CREATIVE_ROTATION_TYPE_SEQUENTIAL",
"CREATIVE_ROTATION_TYPE_RANDOM"
]
}
}
},
"GeoTargeting": {
"type": "object",
"properties": {
"excludeCountries": {
"type": "boolean",
"description": "Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad."
},
"metros": {
"description": "Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.",
"items": {
"$ref": "Metro"
},
"type": "array"
},
"countries": {
"description": "Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.",
"items": {
"$ref": "Country"
},
"type": "array"
},
"regions": {
"items": {
"$ref": "Region"
},
"type": "array",
"description": "Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region."
},
"postalCodes": {
"type": "array",
"description": "Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.",
"items": {
"$ref": "PostalCode"
}
},
"cities": {
"type": "array",
"description": "Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.",
"items": {
"$ref": "City"
}
}
},
"id": "GeoTargeting",
"description": "Geographical Targeting."
},
"CampaignCreativeAssociationsListResponse": {
"type": "object",
"id": "CampaignCreativeAssociationsListResponse",
"description": "Campaign Creative Association List Response",
"properties": {
"campaignCreativeAssociations": {
"type": "array",
"items": {
"$ref": "CampaignCreativeAssociation"
},
"description": "Campaign creative association collection"
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to be used for the next list operation."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociationsListResponse\".",
"type": "string"
}
}
},
"AdSlot": {
"description": "Ad Slot",
"properties": {
"height": {
"description": "Height of this ad slot.",
"format": "int64",
"type": "string"
},
"width": {
"format": "int64",
"type": "string",
"description": "Width of this ad slot."
},
"comment": {
"type": "string",
"description": "Comment for this ad slot."
},
"linkedPlacementId": {
"format": "int64",
"description": "ID of the placement from an external platform that is linked to this ad slot.",
"type": "string"
},
"primary": {
"type": "boolean",
"description": "Primary ad slot of a roadblock inventory item."
},
"paymentSourceType": {
"enumDescriptions": [
"",
""
],
"description": "Payment source type of this ad slot.",
"enum": [
"PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID",
"PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID"
],
"type": "string"
},
"name": {
"description": "Name of this ad slot.",
"type": "string"
},
"compatibility": {
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"description": "Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
"enum": [
"DISPLAY",
"DISPLAY_INTERSTITIAL",
"APP",
"APP_INTERSTITIAL",
"IN_STREAM_VIDEO",
"IN_STREAM_AUDIO"
],
"type": "string"
}
},
"type": "object",
"id": "AdSlot"
},
"AdsListResponse": {
"description": "Ad List Response",
"type": "object",
"id": "AdsListResponse",
"properties": {
"ads": {
"items": {
"$ref": "Ad"
},
"description": "Ad collection.",
"type": "array"
},
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#adsListResponse\"."
}
}
},
"DayPartTargeting": {
"type": "object",
"description": "Day Part Targeting.",
"properties": {
"userLocalTime": {
"type": "boolean",
"description": "Whether or not to use the user's local time. If false, the America/New York time zone applies."
},
"daysOfWeek": {
"items": {
"type": "string",
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
]
},
"type": "array",
"description": "Days of the week when the ad will serve. Acceptable values are: - \"SUNDAY\" - \"MONDAY\" - \"TUESDAY\" - \"WEDNESDAY\" - \"THURSDAY\" - \"FRIDAY\" - \"SATURDAY\" "
},
"hoursOfDay": {
"description": "Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
}
},
"id": "DayPartTargeting"
},
"MetrosListResponse": {
"properties": {
"metros": {
"items": {
"$ref": "Metro"
},
"type": "array",
"description": "Metro collection."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metrosListResponse\"."
}
},
"description": "Metro List Response",
"type": "object",
"id": "MetrosListResponse"
},
"OperatingSystemVersionsListResponse": {
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersionsListResponse\".",
"type": "string"
},
"operatingSystemVersions": {
"items": {
"$ref": "OperatingSystemVersion"
},
"type": "array",
"description": "Operating system version collection."
}
},
"id": "OperatingSystemVersionsListResponse",
"description": "Operating System Version List Response"
},
"AccountPermissionGroup": {
"id": "AccountPermissionGroup",
"description": "AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.",
"properties": {
"id": {
"format": "int64",
"description": "ID of this account permission group.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroup\"."
},
"name": {
"type": "string",
"description": "Name of this account permission group."
}
},
"type": "object"
},
"ObaIcon": {
"properties": {
"xPosition": {
"description": "OBA icon x coordinate position. Accepted values are left or right.",
"type": "string"
},
"size": {
"description": "OBA icon size.",
"$ref": "Size"
},
"resourceUrl": {
"description": "OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more",
"type": "string"
},
"iconClickTrackingUrl": {
"type": "string",
"description": "URL to track click when an OBA icon is clicked."
},
"iconClickThroughUrl": {
"type": "string",
"description": "URL to redirect to when an OBA icon is clicked."
},
"iconViewTrackingUrl": {
"description": "URL to track view when an OBA icon is clicked.",
"type": "string"
},
"yPosition": {
"type": "string",
"description": "OBA icon y coordinate position. Accepted values are top or bottom."
},
"program": {
"type": "string",
"description": "Identifies the industry initiative that the icon supports. For example, AdChoices."
}
},
"id": "ObaIcon",
"type": "object",
"description": "Online Behavioral Advertiser icon."
},
"CompanionSetting": {
"properties": {
"companionsDisabled": {
"type": "boolean",
"description": "Whether companions are disabled for this placement."
},
"enabledSizes": {
"items": {
"$ref": "Size"
},
"description": "Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.",
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#companionSetting\".",
"type": "string"
},
"imageOnly": {
"type": "boolean",
"description": "Whether to serve only static images as companions."
}
},
"description": "Companion Settings",
"id": "CompanionSetting",
"type": "object"
},
"UserRolesListResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolesListResponse\".",
"type": "string"
},
"userRoles": {
"type": "array",
"description": "User role collection.",
"items": {
"$ref": "UserRole"
}
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to be used for the next list operation."
}
},
"type": "object",
"description": "User Role List Response",
"id": "UserRolesListResponse"
},
"CreativeFieldAssignment": {
"type": "object",
"description": "Creative Field Assignment.",
"id": "CreativeFieldAssignment",
"properties": {
"creativeFieldId": {
"format": "int64",
"description": "ID of the creative field.",
"type": "string"
},
"creativeFieldValueId": {
"type": "string",
"format": "int64",
"description": "ID of the creative field value."
}
}
},
"OmnitureSettings": {
"id": "OmnitureSettings",
"description": "Omniture Integration Settings.",
"type": "object",
"properties": {
"omnitureIntegrationEnabled": {
"description": "Whether Omniture integration is enabled. This property can be enabled only when the \"Advanced Ad Serving\" account setting is enabled.",
"type": "boolean"
},
"omnitureCostDataEnabled": {
"description": "Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.",
"type": "boolean"
}
}
},
"CreativeAsset": {
"type": "object",
"id": "CreativeAsset",
"properties": {
"artworkType": {
"type": "string",
"enumDescriptions": [
"",
"",
"",
""
],
"description": "Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
"enum": [
"ARTWORK_TYPE_FLASH",
"ARTWORK_TYPE_HTML5",
"ARTWORK_TYPE_MIXED",
"ARTWORK_TYPE_IMAGE"
]
},
"progressiveServingUrl": {
"type": "string",
"description": "Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
},
"pushdownDuration": {
"description": "Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.",
"type": "number",
"format": "float"
},
"idDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the asset. This is a read-only, auto-generated field."
},
"mediaDuration": {
"type": "number",
"format": "float",
"description": "Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID."
},
"backupImageExit": {
"$ref": "CreativeCustomEvent",
"description": "Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA."
},
"zIndex": {
"type": "integer",
"description": "zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.",
"format": "int32"
},
"size": {
"description": "Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"$ref": "Size"
},
"frameRate": {
"format": "float",
"type": "number",
"description": "Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
},
"bitRate": {
"description": "Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
"type": "integer",
"format": "int32"
},
"orientation": {
"type": "string",
"description": "Orientation of video asset. This is a read-only, auto-generated field.",
"enum": [
"LANDSCAPE",
"PORTRAIT",
"SQUARE"
],
"enumDescriptions": [
"",
"",
""
]
},
"childAssetType": {
"type": "string",
"description": "Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.",
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"CHILD_ASSET_TYPE_FLASH",
"CHILD_ASSET_TYPE_VIDEO",
"CHILD_ASSET_TYPE_IMAGE",
"CHILD_ASSET_TYPE_DATA"
]
},
"assetIdentifier": {
"$ref": "CreativeAssetId",
"description": "Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT."
},
"collapsedSize": {
"description": "Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.",
"$ref": "Size"
},
"positionLeftUnit": {
"enumDescriptions": [
"",
"",
""
],
"enum": [
"OFFSET_UNIT_PIXEL",
"OFFSET_UNIT_PERCENT",
"OFFSET_UNIT_PIXEL_FROM_CENTER"
],
"description": "Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
"type": "string"
},
"originalBackup": {
"type": "boolean",
"description": "Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA."
},
"verticallyLocked": {
"description": "Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
"type": "boolean"
},
"windowMode": {
"description": "Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.",
"type": "string",
"enumDescriptions": [
"",
"",
""
],
"enum": [
"OPAQUE",
"WINDOW",
"TRANSPARENT"
]
},
"durationType": {
"type": "string",
"enumDescriptions": [
"",
"",
""
],
"description": "Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.",
"enum": [
"ASSET_DURATION_TYPE_AUTO",
"ASSET_DURATION_TYPE_NONE",
"ASSET_DURATION_TYPE_CUSTOM"
]
},
"actionScript3": {
"description": "Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"type": "boolean"
},
"zipFilename": {
"description": "File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
"type": "string"
},
"duration": {
"type": "integer",
"format": "int32",
"description": "Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1."
},
"horizontallyLocked": {
"description": "Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
"type": "boolean"
},
"expandedDimension": {
"description": "Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
"$ref": "Size"
},
"displayType": {
"enum": [
"ASSET_DISPLAY_TYPE_INPAGE",
"ASSET_DISPLAY_TYPE_FLOATING",
"ASSET_DISPLAY_TYPE_OVERLAY",
"ASSET_DISPLAY_TYPE_EXPANDING",
"ASSET_DISPLAY_TYPE_FLASH_IN_FLASH",
"ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING",
"ASSET_DISPLAY_TYPE_PEEL_DOWN",
"ASSET_DISPLAY_TYPE_VPAID_LINEAR",
"ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR",
"ASSET_DISPLAY_TYPE_BACKDROP"
],
"description": "Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"detectedFeatures": {
"items": {
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"enum": [
"CSS_FONT_FACE",
"CSS_BACKGROUND_SIZE",
"CSS_BORDER_IMAGE",
"CSS_BORDER_RADIUS",
"CSS_BOX_SHADOW",
"CSS_FLEX_BOX",
"CSS_HSLA",
"CSS_MULTIPLE_BGS",
"CSS_OPACITY",
"CSS_RGBA",
"CSS_TEXT_SHADOW",
"CSS_ANIMATIONS",
"CSS_COLUMNS",
"CSS_GENERATED_CONTENT",
"CSS_GRADIENTS",
"CSS_REFLECTIONS",
"CSS_TRANSFORMS",
"CSS_TRANSFORMS3D",
"CSS_TRANSITIONS",
"APPLICATION_CACHE",
"CANVAS",
"CANVAS_TEXT",
"DRAG_AND_DROP",
"HASH_CHANGE",
"HISTORY",
"AUDIO",
"VIDEO",
"INDEXED_DB",
"INPUT_ATTR_AUTOCOMPLETE",
"INPUT_ATTR_AUTOFOCUS",
"INPUT_ATTR_LIST",
"INPUT_ATTR_PLACEHOLDER",
"INPUT_ATTR_MAX",
"INPUT_ATTR_MIN",
"INPUT_ATTR_MULTIPLE",
"INPUT_ATTR_PATTERN",
"INPUT_ATTR_REQUIRED",
"INPUT_ATTR_STEP",
"INPUT_TYPE_SEARCH",
"INPUT_TYPE_TEL",
"INPUT_TYPE_URL",
"INPUT_TYPE_EMAIL",
"INPUT_TYPE_DATETIME",
"INPUT_TYPE_DATE",
"INPUT_TYPE_MONTH",
"INPUT_TYPE_WEEK",
"INPUT_TYPE_TIME",
"INPUT_TYPE_DATETIME_LOCAL",
"INPUT_TYPE_NUMBER",
"INPUT_TYPE_RANGE",
"INPUT_TYPE_COLOR",
"LOCAL_STORAGE",
"POST_MESSAGE",
"SESSION_STORAGE",
"WEB_SOCKETS",
"WEB_SQL_DATABASE",
"WEB_WORKERS",
"GEO_LOCATION",
"INLINE_SVG",
"SMIL",
"SVG_HREF",
"SVG_CLIP_PATHS",
"TOUCH",
"WEBGL",
"SVG_FILTERS",
"SVG_FE_IMAGE"
],
"type": "string"
},
"type": "array",
"description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE."
},
"zipFilesize": {
"description": "Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
"type": "string"
},
"audioBitRate": {
"format": "int32",
"description": "Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
"type": "integer"
},
"startTimeType": {
"enumDescriptions": [
"",
""
],
"enum": [
"ASSET_START_TIME_TYPE_NONE",
"ASSET_START_TIME_TYPE_CUSTOM"
],
"description": "Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.",
"type": "string"
},
"mimeType": {
"type": "string",
"description": "Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID."
},
"fileSize": {
"format": "int64",
"type": "string",
"description": "File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT."
},
"role": {
"description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. ",
"enum": [
"PRIMARY",
"BACKUP_IMAGE",
"ADDITIONAL_IMAGE",
"ADDITIONAL_FLASH",
"PARENT_VIDEO",
"TRANSCODED_VIDEO",
"OTHER",
"ALTERNATE_VIDEO",
"PARENT_AUDIO",
"TRANSCODED_AUDIO"
],
"type": "string",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"sslCompliant": {
"description": "Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
"type": "boolean"
},
"position": {
"description": "Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.",
"$ref": "OffsetPosition"
},
"politeLoad": {
"type": "boolean",
"description": "Whether this asset is used as a polite load asset."
},
"positionTopUnit": {
"enumDescriptions": [
"",
"",
""
],
"type": "string",
"description": "Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.",
"enum": [
"OFFSET_UNIT_PIXEL",
"OFFSET_UNIT_PERCENT",
"OFFSET_UNIT_PIXEL_FROM_CENTER"
]
},
"audioSampleRate": {
"description": "Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.",
"type": "integer",
"format": "int32"
},
"hideFlashObjects": {
"description": "Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.",
"type": "boolean"
},
"streamingServingUrl": {
"type": "string",
"description": "Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
},
"flashVersion": {
"format": "int32",
"description": "Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"type": "integer"
},
"pushdown": {
"description": "Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.",
"type": "boolean"
},
"transparency": {
"type": "boolean",
"description": "Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets."
},
"customStartTimeValue": {
"description": "Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.",
"format": "int32",
"type": "integer"
},
"hideSelectionBoxes": {
"type": "boolean",
"description": "Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA."
},
"alignment": {
"type": "string",
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"ALIGNMENT_TOP",
"ALIGNMENT_RIGHT",
"ALIGNMENT_BOTTOM",
"ALIGNMENT_LEFT"
],
"description": "Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL ."
},
"companionCreativeIds": {
"items": {
"format": "int64",
"type": "string"
},
"type": "array",
"description": "List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true."
},
"additionalSizes": {
"items": {
"$ref": "Size"
},
"description": "Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.",
"type": "array"
},
"offset": {
"description": "Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.",
"$ref": "OffsetPosition"
},
"active": {
"type": "boolean",
"description": "Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID."
},
"id": {
"format": "int64",
"description": "Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
"type": "string"
}
},
"description": "Creative Asset."
},
"FileList": {
"description": "List of files for a report.",
"type": "object",
"properties": {
"items": {
"items": {
"$ref": "File"
},
"description": "The files returned in this response.",
"type": "array"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#fileList\"."
},
"nextPageToken": {
"type": "string",
"description": "Continuation token used to page through files. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
}
},
"id": "FileList"
},
"CreativeGroup": {
"description": "Contains properties of a creative group.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of this creative group. This is a read-only, auto-generated field.",
"format": "int64"
},
"advertiserIdDimensionValue": {
"description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"accountId": {
"description": "Account ID of this creative group. This is a read-only field that can be left blank.",
"format": "int64",
"type": "string"
},
"groupNumber": {
"type": "integer",
"description": "Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.",
"format": "int32"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroup\"."
},
"name": {
"description": "Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.",
"type": "string"
},
"advertiserId": {
"type": "string",
"format": "int64",
"description": "Advertiser ID of this creative group. This is a required field on insertion."
},
"subaccountId": {
"format": "int64",
"description": "Subaccount ID of this creative group. This is a read-only field that can be left blank.",
"type": "string"
}
},
"id": "CreativeGroup"
},
"LastModifiedInfo": {
"id": "LastModifiedInfo",
"type": "object",
"description": "Modification timestamp.",
"properties": {
"time": {
"type": "string",
"format": "int64",
"description": "Timestamp of the last change in milliseconds since epoch."
}
}
},
"CustomEventImpressionAnnotation": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventImpressionAnnotation\"."
},
"pathImpressionId": {
"type": "string",
"description": "The path impression ID. Use this field to annotate the impression associated with the pathImpressionId."
}
},
"id": "CustomEventImpressionAnnotation",
"description": "Annotate an impression.",
"type": "object"
},
"AdvertiserGroup": {
"type": "object",
"description": "Groups advertisers together so that reports can be generated for the entire group at once.",
"id": "AdvertiserGroup",
"properties": {
"id": {
"type": "string",
"description": "ID of this advertiser group. This is a read-only, auto-generated field.",
"format": "int64"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroup\"."
},
"name": {
"description": "Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.",
"type": "string"
},
"accountId": {
"type": "string",
"format": "int64",
"description": "Account ID of this advertiser group. This is a read-only field that can be left blank."
}
}
},
"FloodlightConfigurationsListResponse": {
"id": "FloodlightConfigurationsListResponse",
"type": "object",
"properties": {
"floodlightConfigurations": {
"type": "array",
"items": {
"$ref": "FloodlightConfiguration"
},
"description": "Floodlight configuration collection."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfigurationsListResponse\"."
}
},
"description": "Floodlight Configuration List Response"
},
"AdvertiserGroupsListResponse": {
"id": "AdvertiserGroupsListResponse",
"description": "Advertiser Group List Response",
"type": "object",
"properties": {
"advertiserGroups": {
"type": "array",
"items": {
"$ref": "AdvertiserGroup"
},
"description": "Advertiser group collection."
},
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroupsListResponse\"."
}
}
},
"RemarketingListsListResponse": {
"type": "object",
"properties": {
"remarketingLists": {
"type": "array",
"description": "Remarketing list collection.",
"items": {
"$ref": "RemarketingList"
}
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListsListResponse\"."
},
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
}
},
"id": "RemarketingListsListResponse",
"description": "Remarketing list response"
},
"DirectorySitesListResponse": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySitesListResponse\"."
},
"directorySites": {
"type": "array",
"items": {
"$ref": "DirectorySite"
},
"description": "Directory site collection."
},
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
}
},
"type": "object",
"description": "Directory Site List Response",
"id": "DirectorySitesListResponse"
},
"ListPopulationClause": {
"type": "object",
"description": "A group clause made up of list population terms representing constraints joined by ORs.",
"properties": {
"terms": {
"type": "array",
"description": "Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.",
"items": {
"$ref": "ListPopulationTerm"
}
}
},
"id": "ListPopulationClause"
},
"Report": {
"properties": {
"ownerProfileId": {
"annotations": {
"required": [
"dfareporting.reports.update"
]
},
"type": "string",
"format": "int64",
"description": "The user profile id of the owner of this report."
},
"kind": {
"description": "The kind of resource this is, in this case dfareporting#report.",
"type": "string"
},
"accountId": {
"description": "The account ID to which this report belongs.",
"annotations": {
"required": [
"dfareporting.reports.update"
]
},
"type": "string",
"format": "int64"
},
"type": {
"annotations": {
"required": [
"dfareporting.reports.insert",
"dfareporting.reports.update"
]
},
"description": "The type of the report.",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
],
"type": "string",
"enum": [
"STANDARD",
"REACH",
"PATH_TO_CONVERSION",
"CROSS_DIMENSION_REACH",
"FLOODLIGHT",
"PATH",
"PATH_ATTRIBUTION"
]
},
"criteria": {
"description": "The report criteria for a report of type \"STANDARD\".",
"properties": {
"dimensions": {
"items": {
"$ref": "SortedDimension"
},
"type": "array",
"description": "The list of standard dimensions the report should include."
},
"activities": {
"$ref": "Activities",
"description": "Activity group."
},
"dateRange": {
"$ref": "DateRange",
"description": "The date range for which this report should be run."
},
"metricNames": {
"items": {
"type": "string"
},
"type": "array",
"description": "The list of names of metrics the report should include."
},
"dimensionFilters": {
"type": "array",
"description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
"items": {
"$ref": "DimensionValue"
}
},
"customRichMediaEvents": {
"description": "Custom Rich Media Events group.",
"$ref": "CustomRichMediaEvents"
}
},
"type": "object"
},
"subAccountId": {
"description": "The subaccount ID to which this report belongs if applicable.",
"type": "string",
"format": "int64"
},
"reachCriteria": {
"type": "object",
"properties": {
"metricNames": {
"items": {
"type": "string"
},
"description": "The list of names of metrics the report should include.",
"type": "array"
},
"dimensionFilters": {
"description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
"type": "array",
"items": {
"$ref": "DimensionValue"
}
},
"reachByFrequencyMetricNames": {
"items": {
"type": "string"
},
"type": "array",
"description": "The list of names of Reach By Frequency metrics the report should include."
},
"dateRange": {
"$ref": "DateRange",
"description": "The date range this report should be run for."
},
"dimensions": {
"type": "array",
"description": "The list of dimensions the report should include.",
"items": {
"$ref": "SortedDimension"
}
},
"activities": {
"description": "Activity group.",
"$ref": "Activities"
},
"enableAllDimensionCombinations": {
"description": "Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.",
"type": "boolean"
},
"customRichMediaEvents": {
"description": "Custom Rich Media Events group.",
"$ref": "CustomRichMediaEvents"
}
},
"description": "The report criteria for a report of type \"REACH\"."
},
"schedule": {
"properties": {
"every": {
"type": "integer",
"format": "int32",
"description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\"."
},
"repeats": {
"annotations": {
"required": [
"dfareporting.reports.insert",
"dfareporting.reports.update"
]
},
"type": "string",
"description": "The interval for which the report is repeated. Note: - \"DAILY\" also requires field \"every\" to be set. - \"WEEKLY\" also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. - \"MONTHLY\" also requires fields \"every\" and \"runsOnDayOfMonth\" to be set. "
},
"runsOnDayOfMonth": {
"enum": [
"DAY_OF_MONTH",
"WEEK_OF_MONTH"
],
"enumDescriptions": [
"",
""
],
"description": "Enum to define for \"MONTHLY\" scheduled reports whether reports should be repeated on the same day of the month as \"startDate\" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Monday of the month.",
"type": "string"
},
"repeatsOnWeekDays": {
"description": "List of week days \"WEEKLY\" on which scheduled reports should run.",
"type": "array",
"items": {
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
],
"type": "string",
"enum": [
"SUNDAY",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY"
]
}
},
"active": {
"annotations": {
"required": [
"dfareporting.reports.insert",
"dfareporting.reports.update"
]
},
"type": "boolean",
"description": "Whether the schedule is active or not. Must be set to either true or false."
},
"startDate": {
"type": "string",
"format": "date"
},
"expirationDate": {
"format": "date",
"type": "string"
}
},
"description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".",
"type": "object"
},
"floodlightCriteria": {
"properties": {
"metricNames": {
"description": "The list of names of metrics the report should include.",
"items": {
"type": "string"
},
"type": "array"
},
"dimensionFilters": {
"description": "The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
"type": "array",
"items": {
"$ref": "DimensionValue"
}
},
"dateRange": {
"$ref": "DateRange",
"description": "The date range this report should be run for."
},
"customRichMediaEvents": {
"type": "array",
"description": "The list of custom rich media events to include.",
"items": {
"$ref": "DimensionValue"
}
},
"reportProperties": {
"properties": {
"includeAttributedIPConversions": {
"type": "boolean",
"description": "Include conversions that have no cookie, but do have an exposure path."
},
"includeUnattributedCookieConversions": {
"description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.",
"type": "boolean"
},
"includeUnattributedIPConversions": {
"description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.",
"type": "boolean"
}
},
"type": "object",
"description": "The properties of the report."
},
"dimensions": {
"items": {
"$ref": "SortedDimension"
},
"description": "The list of dimensions the report should include.",
"type": "array"
},
"floodlightConfigId": {
"$ref": "DimensionValue",
"description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
}
},
"type": "object",
"description": "The report criteria for a report of type \"FLOODLIGHT\"."
},
"pathCriteria": {
"type": "object",
"description": "The report criteria for a report of type \"PATH\".",
"properties": {
"floodlightConfigId": {
"$ref": "DimensionValue",
"description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
},
"dateRange": {
"$ref": "DateRange",
"description": "The date range this report should be run for."
},
"activityFilters": {
"description": "The list of 'dfa:activity' values to filter on.",
"items": {
"$ref": "DimensionValue"
},
"type": "array"
},
"dimensions": {
"type": "array",
"items": {
"$ref": "SortedDimension"
},
"description": "The list of dimensions the report should include."
},
"customChannelGrouping": {
"$ref": "ChannelGrouping",
"description": "Channel Grouping."
},
"pathFilters": {
"type": "array",
"items": {
"$ref": "PathFilter"
},
"description": "Path Filters."
},
"metricNames": {
"description": "The list of names of metrics the report should include.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"etag": {
"description": "The eTag of this response for caching purposes.",
"type": "string"
},
"pathToConversionCriteria": {
"type": "object",
"properties": {
"perInteractionDimensions": {
"type": "array",
"description": "The list of per interaction dimensions the report should include.",
"items": {
"$ref": "SortedDimension"
}
},
"customFloodlightVariables": {
"items": {
"$ref": "SortedDimension"
},
"description": "The list of custom floodlight variables the report should include.",
"type": "array"
},
"conversionDimensions": {
"type": "array",
"items": {
"$ref": "SortedDimension"
},
"description": "The list of conversion dimensions the report should include."
},
"floodlightConfigId": {
"description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.",
"$ref": "DimensionValue"
},
"dateRange": {
"$ref": "DateRange",
"description": "The date range this report should be run for."
},
"activityFilters": {
"type": "array",
"description": "The list of 'dfa:activity' values to filter on.",
"items": {
"$ref": "DimensionValue"
}
},
"customRichMediaEvents": {
"items": {
"$ref": "DimensionValue"
},
"description": "The list of custom rich media events to include.",
"type": "array"
},
"reportProperties": {
"description": "The properties of the report.",
"properties": {
"maximumImpressionInteractions": {
"description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
"format": "int32",
"type": "integer"
},
"pivotOnInteractionPath": {
"type": "boolean",
"description": "Enable pivoting on interaction path."
},
"impressionsLookbackWindow": {
"format": "int32",
"description": "DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
"type": "integer"
},
"includeUnattributedIPConversions": {
"description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.",
"type": "boolean"
},
"maximumClickInteractions": {
"format": "int32",
"type": "integer",
"description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report."
},
"includeUnattributedCookieConversions": {
"description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.",
"type": "boolean"
},
"maximumInteractionGap": {
"description": "The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.",
"format": "int32",
"type": "integer"
},
"clicksLookbackWindow": {
"format": "int32",
"description": "DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
"type": "integer"
},
"includeAttributedIPConversions": {
"type": "boolean",
"description": "Deprecated: has no effect."
}
},
"type": "object"
},
"metricNames": {
"items": {
"type": "string"
},
"description": "The list of names of metrics the report should include.",
"type": "array"
}
},
"description": "The report criteria for a report of type \"PATH_TO_CONVERSION\"."
},
"fileName": {
"type": "string",
"description": "The filename used when generating report files for this report."
},
"name": {
"annotations": {
"required": [
"dfareporting.reports.insert",
"dfareporting.reports.update"
]
},
"type": "string",
"description": "The name of the report."
},
"delivery": {
"description": "The report's email delivery settings.",
"properties": {
"message": {
"type": "string",
"description": "The message to be sent with each email."
},
"recipients": {
"type": "array",
"items": {
"$ref": "Recipient"
},
"description": "The list of recipients to which to email the report."
},
"emailOwnerDeliveryType": {
"description": "The type of delivery for the owner to receive, if enabled.",
"enum": [
"LINK",
"ATTACHMENT"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"emailOwner": {
"description": "Whether the report should be emailed to the report owner.",
"type": "boolean"
}
},
"type": "object"
},
"lastModifiedTime": {
"type": "string",
"annotations": {
"required": [
"dfareporting.reports.update"
]
},
"format": "uint64",
"description": "The timestamp (in milliseconds since epoch) of when this report was last modified."
},
"pathAttributionCriteria": {
"type": "object",
"description": "The report criteria for a report of type \"PATH_ATTRIBUTION\".",
"properties": {
"floodlightConfigId": {
"$ref": "DimensionValue",
"description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
},
"dateRange": {
"$ref": "DateRange",
"description": "The date range this report should be run for."
},
"pathFilters": {
"items": {
"$ref": "PathFilter"
},
"description": "Path Filters.",
"type": "array"
},
"customChannelGrouping": {
"$ref": "ChannelGrouping",
"description": "Channel Grouping."
},
"metricNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of names of metrics the report should include."
},
"activityFilters": {
"items": {
"$ref": "DimensionValue"
},
"description": "The list of 'dfa:activity' values to filter on.",
"type": "array"
},
"dimensions": {
"type": "array",
"description": "The list of dimensions the report should include.",
"items": {
"$ref": "SortedDimension"
}
}
}
},
"crossDimensionReachCriteria": {
"properties": {
"dimension": {
"type": "string",
"description": "The dimension option.",
"enum": [
"ADVERTISER",
"CAMPAIGN",
"SITE_BY_ADVERTISER",
"SITE_BY_CAMPAIGN"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"breakdown": {
"description": "The list of dimensions the report should include.",
"items": {
"$ref": "SortedDimension"
},
"type": "array"
},
"dateRange": {
"description": "The date range this report should be run for.",
"$ref": "DateRange"
},
"metricNames": {
"items": {
"type": "string"
},
"type": "array",
"description": "The list of names of metrics the report should include."
},
"overlapMetricNames": {
"type": "array",
"description": "The list of names of overlap metrics the report should include.",
"items": {
"type": "string"
}
},
"pivoted": {
"description": "Whether the report is pivoted or not. Defaults to true.",
"type": "boolean"
},
"dimensionFilters": {
"type": "array",
"description": "The list of filters on which dimensions are filtered.",
"items": {
"$ref": "DimensionValue"
}
}
},
"description": "The report criteria for a report of type \"CROSS_DIMENSION_REACH\".",
"type": "object"
},
"format": {
"type": "string",
"description": "The output format of the report. If not specified, default format is \"CSV\". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. \"CSV\" will then be the fallback format.",
"enum": [
"CSV",
"EXCEL"
],
"enumDescriptions": [
"",
""
]
},
"id": {
"type": "string",
"description": "The unique ID identifying this report resource.",
"format": "int64",
"annotations": {
"required": [
"dfareporting.reports.update"
]
}
}
},
"description": "Represents a Report resource.",
"id": "Report",
"type": "object"
},
"Ad": {
"id": "Ad",
"description": "Contains properties of a Campaign Manager ad.",
"type": "object",
"properties": {
"sslRequired": {
"type": "boolean",
"description": "Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated."
},
"type": {
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string",
"description": "Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).",
"enum": [
"AD_SERVING_STANDARD_AD",
"AD_SERVING_DEFAULT_AD",
"AD_SERVING_CLICK_TRACKER",
"AD_SERVING_TRACKING",
"AD_SERVING_BRAND_SAFE_AD"
]
},
"technologyTargeting": {
"description": "Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.",
"$ref": "TechnologyTargeting"
},
"accountId": {
"format": "int64",
"type": "string",
"description": "Account ID of this ad. This is a read-only field that can be left blank."
},
"geoTargeting": {
"$ref": "GeoTargeting",
"description": "Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ad\".",
"type": "string"
},
"size": {
"description": "Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.",
"$ref": "Size"
},
"sslCompliant": {
"type": "boolean",
"description": "Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated."
},
"campaignIdDimensionValue": {
"description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"creativeGroupAssignments": {
"description": "Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.",
"items": {
"$ref": "CreativeGroupAssignment"
},
"type": "array"
},
"compatibility": {
"enum": [
"DISPLAY",
"DISPLAY_INTERSTITIAL",
"APP",
"APP_INTERSTITIAL",
"IN_STREAM_VIDEO",
"IN_STREAM_AUDIO"
],
"type": "string",
"description": "Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.",
"enumDescriptions": [
"",
"",
"",
"",
"",
""
]
},
"audienceSegmentId": {
"format": "int64",
"description": "Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.",
"type": "string"
},
"clickThroughUrlSuffixProperties": {
"description": "Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.",
"$ref": "ClickThroughUrlSuffixProperties"
},
"subaccountId": {
"description": "Subaccount ID of this ad. This is a read-only field that can be left blank.",
"format": "int64",
"type": "string"
},
"archived": {
"type": "boolean",
"description": "Whether this ad is archived. When true, active must be false."
},
"lastModifiedInfo": {
"description": "Information about the most recent modification of this ad. This is a read-only field.",
"$ref": "LastModifiedInfo"
},
"name": {
"type": "string",
"description": "Name of this ad. This is a required field and must be less than 256 characters long."
},
"placementAssignments": {
"items": {
"$ref": "PlacementAssignment"
},
"description": "Placement assignments for this ad.",
"type": "array"
},
"defaultClickThroughEventTagProperties": {
"$ref": "DefaultClickThroughEventTagProperties",
"description": "Default click-through event tag properties for this ad."
},
"comments": {
"description": "Comments for this ad.",
"type": "string"
},
"advertiserIdDimensionValue": {
"description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"deliverySchedule": {
"description": "Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.",
"$ref": "DeliverySchedule"
},
"creativeRotation": {
"$ref": "CreativeRotation",
"description": "Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment ."
},
"remarketingListExpression": {
"$ref": "ListTargetingExpression",
"description": "Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
},
"campaignId": {
"type": "string",
"description": "Campaign ID of this ad. This is a required field on insertion.",
"format": "int64"
},
"active": {
"type": "boolean",
"description": "Whether this ad is active. When true, archived must be false."
},
"idDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of this ad. This is a read-only, auto-generated field."
},
"createInfo": {
"description": "Information about the creation of this ad. This is a read-only field.",
"$ref": "LastModifiedInfo"
},
"dayPartTargeting": {
"$ref": "DayPartTargeting",
"description": "Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD."
},
"languageTargeting": {
"description": "Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.",
"$ref": "LanguageTargeting"
},
"id": {
"type": "string",
"description": "ID of this ad. This is a read-only, auto-generated field.",
"format": "int64"
},
"dynamicClickTracker": {
"type": "boolean",
"description": "Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert."
},
"advertiserId": {
"type": "string",
"format": "int64",
"description": "Advertiser ID of this ad. This is a required field on insertion."
},
"eventTagOverrides": {
"items": {
"$ref": "EventTagOverride"
},
"description": "Event tag overrides for this ad.",
"type": "array"
},
"keyValueTargetingExpression": {
"description": "Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.",
"$ref": "KeyValueTargetingExpression"
},
"clickThroughUrl": {
"$ref": "ClickThroughUrl",
"description": "Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER."
},
"endTime": {
"type": "string",
"format": "date-time"
},
"targetingTemplateId": {
"format": "int64",
"type": "string",
"description": "Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD."
},
"startTime": {
"type": "string",
"format": "date-time"
}
}
},
"DynamicTargetingKey": {
"description": "Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.",
"type": "object",
"properties": {
"objectId": {
"description": "ID of the object of this dynamic targeting key. This is a required field.",
"format": "int64",
"type": "string"
},
"objectType": {
"enum": [
"OBJECT_ADVERTISER",
"OBJECT_AD",
"OBJECT_CREATIVE",
"OBJECT_PLACEMENT"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string",
"description": "Type of the object of this dynamic targeting key. This is a required field."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKey\"."
},
"name": {
"description": "Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.",
"type": "string"
}
},
"id": "DynamicTargetingKey"
},
"InventoryItemsListResponse": {
"id": "InventoryItemsListResponse",
"description": "Inventory item List Response",
"type": "object",
"properties": {
"inventoryItems": {
"description": "Inventory item collection",
"type": "array",
"items": {
"$ref": "InventoryItem"
}
},
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItemsListResponse\".",
"type": "string"
}
}
},
"PlacementStrategiesListResponse": {
"type": "object",
"id": "PlacementStrategiesListResponse",
"properties": {
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
},
"placementStrategies": {
"items": {
"$ref": "PlacementStrategy"
},
"description": "Placement strategy collection.",
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategiesListResponse\".",
"type": "string"
}
},
"description": "Placement Strategy List Response"
},
"Site": {
"type": "object",
"description": "Contains properties of a site.",
"id": "Site",
"properties": {
"approved": {
"description": "Whether this site is approved.",
"type": "boolean"
},
"accountId": {
"description": "Account ID of this site. This is a read-only field that can be left blank.",
"format": "int64",
"type": "string"
},
"subaccountId": {
"type": "string",
"description": "Subaccount ID of this site. This is a read-only field that can be left blank.",
"format": "int64"
},
"siteContacts": {
"items": {
"$ref": "SiteContact"
},
"type": "array",
"description": "Site contacts."
},
"name": {
"type": "string",
"description": "Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account."
},
"siteSettings": {
"description": "Site-wide settings.",
"$ref": "SiteSettings"
},
"directorySiteIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#site\"."
},
"idDimensionValue": {
"description": "Dimension value for the ID of this site. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"directorySiteId": {
"description": "Directory site associated with this site. This is a required field that is read-only after insertion.",
"format": "int64",
"type": "string"
},
"keyName": {
"description": "Key name of this site. This is a read-only, auto-generated field.",
"type": "string"
},
"videoSettings": {
"$ref": "SiteVideoSettings",
"description": "Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement."
},
"id": {
"format": "int64",
"description": "ID of this site. This is a read-only, auto-generated field.",
"type": "string"
}
}
},
"ChannelGrouping": {
"description": "Represents a DfaReporting channel grouping.",
"type": "object",
"id": "ChannelGrouping",
"properties": {
"fallbackName": {
"description": "ChannelGrouping fallback name.",
"type": "string"
},
"rules": {
"type": "array",
"items": {
"$ref": "ChannelGroupingRule"
},
"description": "The rules contained within this channel grouping."
},
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#channelGrouping."
},
"name": {
"description": "ChannelGrouping name.",
"type": "string"
}
}
},
"CampaignCreativeAssociation": {
"properties": {
"creativeId": {
"type": "string",
"format": "int64",
"description": "ID of the creative associated with the campaign. This is a required field."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociation\".",
"type": "string"
}
},
"type": "object",
"id": "CampaignCreativeAssociation",
"description": "Identifies a creative which has been associated with a given campaign."
},
"PathReportCompatibleFields": {
"type": "object",
"description": "Represents fields that are compatible to be selected for a report of type \"PATH\".",
"id": "PathReportCompatibleFields",
"properties": {
"channelGroupings": {
"type": "array",
"items": {
"$ref": "Dimension"
},
"description": "Dimensions which are compatible to be selected in the \"channelGroupings\" section of the report."
},
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#pathReportCompatibleFields."
},
"metrics": {
"type": "array",
"items": {
"$ref": "Metric"
},
"description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report."
},
"pathFilters": {
"items": {
"$ref": "Dimension"
},
"description": "Dimensions which are compatible to be selected in the \"pathFilters\" section of the report.",
"type": "array"
},
"dimensions": {
"items": {
"$ref": "Dimension"
},
"description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
"type": "array"
}
}
},
"DimensionValue": {
"properties": {
"value": {
"description": "The value of the dimension.",
"type": "string"
},
"etag": {
"description": "The eTag of this response for caching purposes.",
"type": "string"
},
"matchType": {
"enum": [
"EXACT",
"BEGINS_WITH",
"CONTAINS",
"WILDCARD_EXPRESSION"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string",
"description": "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."
},
"id": {
"type": "string",
"description": "The ID associated with the value if available."
},
"dimensionName": {
"type": "string",
"description": "The name of the dimension."
},
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#dimensionValue."
}
},
"description": "Represents a DimensionValue resource.",
"type": "object",
"id": "DimensionValue"
},
"DV3Ids": {
"id": "DV3Ids",
"type": "object",
"description": "DV360 IDs related to the custom event.",
"properties": {
"dvSiteId": {
"type": "string",
"description": "Site ID for DV360.",
"format": "int64"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dV3Ids\".",
"type": "string"
},
"dvInsertionOrderId": {
"format": "int64",
"description": "Insertion Order ID for DV360.",
"type": "string"
},
"dvLineItemId": {
"type": "string",
"description": "Line Item ID for DV360.",
"format": "int64"
},
"dvCampaignId": {
"format": "int64",
"description": "Campaign ID for DV360.",
"type": "string"
},
"dvCreativeId": {
"format": "int64",
"type": "string",
"description": "Creative ID for DV360."
}
}
},
"CreativeCustomEvent": {
"id": "CreativeCustomEvent",
"properties": {
"advertiserCustomEventId": {
"type": "string",
"format": "int64",
"description": "Unique ID of this event used by Reporting and Data Transfer. This is a read-only field."
},
"artworkType": {
"type": "string",
"description": "Artwork type used by the creative.This is a read-only field.",
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"ARTWORK_TYPE_FLASH",
"ARTWORK_TYPE_HTML5",
"ARTWORK_TYPE_MIXED",
"ARTWORK_TYPE_IMAGE"
]
},
"advertiserCustomEventType": {
"description": "Type of the event. This is a read-only field.",
"type": "string",
"enumDescriptions": [
"",
"",
""
],
"enum": [
"ADVERTISER_EVENT_TIMER",
"ADVERTISER_EVENT_EXIT",
"ADVERTISER_EVENT_COUNTER"
]
},
"popupWindowProperties": {
"description": "Properties for rich media popup windows. This field is used only for exit events.",
"$ref": "PopupWindowProperties"
},
"targetType": {
"enum": [
"TARGET_BLANK",
"TARGET_TOP",
"TARGET_SELF",
"TARGET_PARENT",
"TARGET_POPUP"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"description": "Target type used by the event.",
"type": "string"
},
"videoReportingId": {
"description": "Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.",
"type": "string"
},
"id": {
"type": "string",
"format": "int64",
"description": "ID of this event. This is a required field and should not be modified after insertion."
},
"advertiserCustomEventName": {
"description": "User-entered name for the event.",
"type": "string"
},
"exitClickThroughUrl": {
"description": "Exit click-through URL for the event. This field is used only for exit events.",
"$ref": "CreativeClickThroughUrl"
},
"artworkLabel": {
"description": "Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.",
"type": "string"
}
},
"description": "Creative Custom Event.",
"type": "object"
},
"File": {
"properties": {
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#file\".",
"type": "string"
},
"fileName": {
"type": "string",
"description": "The filename of the file."
},
"dateRange": {
"description": "The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.",
"$ref": "DateRange"
},
"reportId": {
"type": "string",
"format": "int64",
"description": "The ID of the report this file was generated from."
},
"lastModifiedTime": {
"type": "string",
"description": "The timestamp in milliseconds since epoch when this file was last modified.",
"format": "int64"
},
"id": {
"format": "int64",
"description": "The unique ID of this report file.",
"type": "string"
},
"urls": {
"type": "object",
"description": "The URLs where the completed report file can be downloaded.",
"properties": {
"browserUrl": {
"description": "The URL for downloading the report data through a browser.",
"type": "string"
},
"apiUrl": {
"description": "The URL for downloading the report data through the API.",
"type": "string"
}
}
},
"status": {
"type": "string",
"enumDescriptions": [
"",
"",
"",
""
],
"description": "The status of the report file.",
"enum": [
"PROCESSING",
"REPORT_AVAILABLE",
"FAILED",
"CANCELLED"
]
},
"format": {
"type": "string",
"enum": [
"CSV",
"EXCEL"
],
"description": "The output format of the report. Only available once the file is available.",
"enumDescriptions": [
"",
""
]
}
},
"type": "object",
"description": "Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is \"REPORT_AVAILABLE\".",
"id": "File"
},
"AccountPermissionGroupsListResponse": {
"description": "Account Permission Group List Response",
"type": "object",
"id": "AccountPermissionGroupsListResponse",
"properties": {
"accountPermissionGroups": {
"description": "Account permission group collection.",
"type": "array",
"items": {
"$ref": "AccountPermissionGroup"
}
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroupsListResponse\".",
"type": "string"
}
}
},
"ChannelGroupingRule": {
"description": "Represents a DfaReporting channel grouping rule.",
"properties": {
"name": {
"description": "Rule name.",
"type": "string"
},
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#channelGroupingRule."
},
"disjunctiveMatchStatements": {
"description": "The disjunctive match statements contained within this rule.",
"items": {
"$ref": "DisjunctiveMatchStatement"
},
"type": "array"
}
},
"type": "object",
"id": "ChannelGroupingRule"
},
"TechnologyTargeting": {
"properties": {
"connectionTypes": {
"items": {
"$ref": "ConnectionType"
},
"description": "Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.",
"type": "array"
},
"operatingSystems": {
"items": {
"$ref": "OperatingSystem"
},
"description": "Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.",
"type": "array"
},
"operatingSystemVersions": {
"type": "array",
"items": {
"$ref": "OperatingSystemVersion"
},
"description": "Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems."
},
"mobileCarriers": {
"items": {
"$ref": "MobileCarrier"
},
"type": "array",
"description": "Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes."
},
"platformTypes": {
"type": "array",
"description": "Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.",
"items": {
"$ref": "PlatformType"
}
},
"browsers": {
"description": "Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.",
"items": {
"$ref": "Browser"
},
"type": "array"
}
},
"description": "Technology Targeting.",
"type": "object",
"id": "TechnologyTargeting"
},
"MobileCarriersListResponse": {
"id": "MobileCarriersListResponse",
"properties": {
"mobileCarriers": {
"items": {
"$ref": "MobileCarrier"
},
"type": "array",
"description": "Mobile carrier collection."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarriersListResponse\"."
}
},
"description": "Mobile Carrier List Response",
"type": "object"
},
"CreativeAssetMetadata": {
"properties": {
"richMedia": {
"type": "boolean",
"description": "True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field."
},
"idDimensionValue": {
"description": "Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"clickTags": {
"type": "array",
"description": "List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.",
"items": {
"$ref": "ClickTag"
}
},
"exitCustomEvents": {
"type": "array",
"items": {
"$ref": "CreativeCustomEvent"
},
"description": "List of exit events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset."
},
"warnedValidationRules": {
"items": {
"enum": [
"CLICK_TAG_NON_TOP_LEVEL",
"CLICK_TAG_MISSING",
"CLICK_TAG_MORE_THAN_ONE",
"CLICK_TAG_INVALID",
"ORPHANED_ASSET",
"PRIMARY_HTML_MISSING",
"EXTERNAL_FILE_REFERENCED",
"MRAID_REFERENCED",
"ADMOB_REFERENCED",
"FILE_TYPE_INVALID",
"ZIP_INVALID",
"LINKED_FILE_NOT_FOUND",
"MAX_FLASH_VERSION_11",
"NOT_SSL_COMPLIANT",
"FILE_DETAIL_EMPTY",
"ASSET_INVALID",
"GWD_PROPERTIES_INVALID",
"ENABLER_UNSUPPORTED_METHOD_DCM",
"ASSET_FORMAT_UNSUPPORTED_DCM",
"COMPONENT_UNSUPPORTED_DCM",
"HTML5_FEATURE_UNSUPPORTED",
"CLICK_TAG_IN_GWD",
"CLICK_TAG_HARD_CODED",
"SVG_INVALID"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"type": "array",
"description": "Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - \"ADMOB_REFERENCED\" - \"ASSET_FORMAT_UNSUPPORTED_DCM\" - \"ASSET_INVALID\" - \"CLICK_TAG_HARD_CODED\" - \"CLICK_TAG_INVALID\" - \"CLICK_TAG_IN_GWD\" - \"CLICK_TAG_MISSING\" - \"CLICK_TAG_MORE_THAN_ONE\" - \"CLICK_TAG_NON_TOP_LEVEL\" - \"COMPONENT_UNSUPPORTED_DCM\" - \"ENABLER_UNSUPPORTED_METHOD_DCM\" - \"EXTERNAL_FILE_REFERENCED\" - \"FILE_DETAIL_EMPTY\" - \"FILE_TYPE_INVALID\" - \"GWD_PROPERTIES_INVALID\" - \"HTML5_FEATURE_UNSUPPORTED\" - \"LINKED_FILE_NOT_FOUND\" - \"MAX_FLASH_VERSION_11\" - \"MRAID_REFERENCED\" - \"NOT_SSL_COMPLIANT\" - \"ORPHANED_ASSET\" - \"PRIMARY_HTML_MISSING\" - \"SVG_INVALID\" - \"ZIP_INVALID\" "
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeAssetMetadata\"."
},
"id": {
"format": "int64",
"type": "string",
"description": "Numeric ID of the asset. This is a read-only, auto-generated field."
},
"detectedFeatures": {
"items": {
"enum": [
"CSS_FONT_FACE",
"CSS_BACKGROUND_SIZE",
"CSS_BORDER_IMAGE",
"CSS_BORDER_RADIUS",
"CSS_BOX_SHADOW",
"CSS_FLEX_BOX",
"CSS_HSLA",
"CSS_MULTIPLE_BGS",
"CSS_OPACITY",
"CSS_RGBA",
"CSS_TEXT_SHADOW",
"CSS_ANIMATIONS",
"CSS_COLUMNS",
"CSS_GENERATED_CONTENT",
"CSS_GRADIENTS",
"CSS_REFLECTIONS",
"CSS_TRANSFORMS",
"CSS_TRANSFORMS3D",
"CSS_TRANSITIONS",
"APPLICATION_CACHE",
"CANVAS",
"CANVAS_TEXT",
"DRAG_AND_DROP",
"HASH_CHANGE",
"HISTORY",
"AUDIO",
"VIDEO",
"INDEXED_DB",
"INPUT_ATTR_AUTOCOMPLETE",
"INPUT_ATTR_AUTOFOCUS",
"INPUT_ATTR_LIST",
"INPUT_ATTR_PLACEHOLDER",
"INPUT_ATTR_MAX",
"INPUT_ATTR_MIN",
"INPUT_ATTR_MULTIPLE",
"INPUT_ATTR_PATTERN",
"INPUT_ATTR_REQUIRED",
"INPUT_ATTR_STEP",
"INPUT_TYPE_SEARCH",
"INPUT_TYPE_TEL",
"INPUT_TYPE_URL",
"INPUT_TYPE_EMAIL",
"INPUT_TYPE_DATETIME",
"INPUT_TYPE_DATE",
"INPUT_TYPE_MONTH",
"INPUT_TYPE_WEEK",
"INPUT_TYPE_TIME",
"INPUT_TYPE_DATETIME_LOCAL",
"INPUT_TYPE_NUMBER",
"INPUT_TYPE_RANGE",
"INPUT_TYPE_COLOR",
"LOCAL_STORAGE",
"POST_MESSAGE",
"SESSION_STORAGE",
"WEB_SOCKETS",
"WEB_SQL_DATABASE",
"WEB_WORKERS",
"GEO_LOCATION",
"INLINE_SVG",
"SMIL",
"SVG_HREF",
"SVG_CLIP_PATHS",
"TOUCH",
"WEBGL",
"SVG_FILTERS",
"SVG_FE_IMAGE"
],
"type": "string",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"type": "array",
"description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field."
},
"counterCustomEvents": {
"type": "array",
"description": "List of counter events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.",
"items": {
"$ref": "CreativeCustomEvent"
}
},
"timerCustomEvents": {
"description": "List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.",
"type": "array",
"items": {
"$ref": "CreativeCustomEvent"
}
},
"assetIdentifier": {
"description": "ID of the creative asset. This is a required field.",
"$ref": "CreativeAssetId"
}
},
"type": "object",
"id": "CreativeAssetMetadata",
"description": "CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative."
},
"Account": {
"properties": {
"currencyId": {
"type": "string",
"format": "int64",
"description": "ID of currency associated with this account. This is a required field. Acceptable values are: - \"1\" for USD - \"2\" for GBP - \"3\" for ESP - \"4\" for SEK - \"5\" for CAD - \"6\" for JPY - \"7\" for DEM - \"8\" for AUD - \"9\" for FRF - \"10\" for ITL - \"11\" for DKK - \"12\" for NOK - \"13\" for FIM - \"14\" for ZAR - \"15\" for IEP - \"16\" for NLG - \"17\" for EUR - \"18\" for KRW - \"19\" for TWD - \"20\" for SGD - \"21\" for CNY - \"22\" for HKD - \"23\" for NZD - \"24\" for MYR - \"25\" for BRL - \"26\" for PTE - \"28\" for CLP - \"29\" for TRY - \"30\" for ARS - \"31\" for PEN - \"32\" for ILS - \"33\" for CHF - \"34\" for VEF - \"35\" for COP - \"36\" for GTQ - \"37\" for PLN - \"39\" for INR - \"40\" for THB - \"41\" for IDR - \"42\" for CZK - \"43\" for RON - \"44\" for HUF - \"45\" for RUB - \"46\" for AED - \"47\" for BGN - \"48\" for HRK - \"49\" for MXN - \"50\" for NGN - \"51\" for EGP "
},
"countryId": {
"format": "int64",
"description": "ID of the country associated with this account.",
"type": "string"
},
"maximumImageSize": {
"type": "string",
"description": "Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.",
"format": "int64"
},
"defaultCreativeSizeId": {
"format": "int64",
"description": "Default placement dimensions for this account.",
"type": "string"
},
"accountProfile": {
"enum": [
"ACCOUNT_PROFILE_BASIC",
"ACCOUNT_PROFILE_STANDARD"
],
"description": "Profile for this account. This is a read-only field that can be left blank.",
"enumDescriptions": [
"",
""
],
"type": "string"
},
"shareReportsWithTwitter": {
"description": "Share Path to Conversion reports with Twitter.",
"type": "boolean"
},
"active": {
"description": "Whether this account is active.",
"type": "boolean"
},
"nielsenOcrEnabled": {
"type": "boolean",
"description": "Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default."
},
"id": {
"type": "string",
"description": "ID of this account. This is a read-only, auto-generated field.",
"format": "int64"
},
"description": {
"description": "Description of this account.",
"type": "string"
},
"activeViewOptOut": {
"type": "boolean",
"description": "Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#account\"."
},
"locale": {
"description": "Locale of this account. Acceptable values are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) ",
"type": "string"
},
"name": {
"type": "string",
"description": "Name of this account. This is a required field, and must be less than 128 characters long and be globally unique."
},
"accountPermissionIds": {
"description": "Account permissions assigned to this account.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"availablePermissionIds": {
"items": {
"type": "string",
"format": "int64"
},
"description": "User role permissions available to the user roles of this account.",
"type": "array"
},
"activeAdsLimitTier": {
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
""
],
"enum": [
"ACTIVE_ADS_TIER_40K",
"ACTIVE_ADS_TIER_75K",
"ACTIVE_ADS_TIER_100K",
"ACTIVE_ADS_TIER_200K",
"ACTIVE_ADS_TIER_300K",
"ACTIVE_ADS_TIER_500K",
"ACTIVE_ADS_TIER_750K",
"ACTIVE_ADS_TIER_1M"
],
"type": "string",
"description": "Maximum number of active ads allowed for this account."
},
"teaserSizeLimit": {
"format": "int64",
"description": "File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.",
"type": "string"
},
"reportsConfiguration": {
"$ref": "ReportsConfiguration",
"description": "Reporting configuration of this account."
}
},
"id": "Account",
"description": "Contains properties of a Campaign Manager account.",
"type": "object"
},
"PlacementGroup": {
"description": "Contains properties of a package or roadblock.",
"properties": {
"advertiserId": {
"format": "int64",
"description": "Advertiser ID of this placement group. This is a required field on insertion.",
"type": "string"
},
"comment": {
"type": "string",
"description": "Comments for this placement group."
},
"id": {
"type": "string",
"description": "ID of this placement group. This is a read-only, auto-generated field.",
"format": "int64"
},
"lastModifiedInfo": {
"description": "Information about the most recent modification of this placement group. This is a read-only field.",
"$ref": "LastModifiedInfo"
},
"advertiserIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
},
"campaignIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
},
"primaryPlacementId": {
"type": "string",
"description": "ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.",
"format": "int64"
},
"name": {
"description": "Name of this placement group. This is a required field and must be less than 256 characters long.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroup\"."
},
"siteId": {
"type": "string",
"description": "Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
"format": "int64"
},
"createInfo": {
"description": "Information about the creation of this placement group. This is a read-only field.",
"$ref": "LastModifiedInfo"
},
"idDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of this placement group. This is a read-only, auto-generated field."
},
"accountId": {
"format": "int64",
"description": "Account ID of this placement group. This is a read-only field that can be left blank.",
"type": "string"
},
"childPlacementIds": {
"items": {
"type": "string",
"format": "int64"
},
"description": "IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.",
"type": "array"
},
"siteIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
},
"archived": {
"description": "Whether this placement group is archived.",
"type": "boolean"
},
"contentCategoryId": {
"description": "ID of the content category assigned to this placement group.",
"format": "int64",
"type": "string"
},
"placementStrategyId": {
"description": "ID of the placement strategy assigned to this placement group.",
"type": "string",
"format": "int64"
},
"directorySiteIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
},
"subaccountId": {
"description": "Subaccount ID of this placement group. This is a read-only field that can be left blank.",
"type": "string",
"format": "int64"
},
"externalId": {
"description": "External ID for this placement.",
"type": "string"
},
"directorySiteId": {
"type": "string",
"format": "int64",
"description": "Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion."
},
"campaignId": {
"type": "string",
"format": "int64",
"description": "Campaign ID of this placement group. This field is required on insertion."
},
"placementGroupType": {
"enumDescriptions": [
"",
""
],
"type": "string",
"enum": [
"PLACEMENT_PACKAGE",
"PLACEMENT_ROADBLOCK"
],
"description": "Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion."
},
"primaryPlacementIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the primary placement. This is a read-only, auto-generated field."
},
"pricingSchedule": {
"$ref": "PricingSchedule",
"description": "Pricing schedule of this placement group. This field is required on insertion."
}
},
"type": "object",
"id": "PlacementGroup"
},
"PricingSchedulePricingPeriod": {
"properties": {
"pricingComment": {
"type": "string",
"description": "Comments for this pricing period."
},
"startDate": {
"format": "date",
"type": "string"
},
"rateOrCostNanos": {
"description": "Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.",
"type": "string",
"format": "int64"
},
"endDate": {
"type": "string",
"format": "date"
},
"units": {
"format": "int64",
"type": "string",
"description": "Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive."
}
},
"type": "object",
"description": "Pricing Period",
"id": "PricingSchedulePricingPeriod"
},
"ContentCategory": {
"description": "Organizes placements according to the contents of their associated webpages.",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account."
},
"accountId": {
"format": "int64",
"type": "string",
"description": "Account ID of this content category. This is a read-only field that can be left blank."
},
"id": {
"description": "ID of this content category. This is a read-only, auto-generated field.",
"format": "int64",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategory\".",
"type": "string"
}
},
"id": "ContentCategory"
},
"ClickTag": {
"type": "object",
"properties": {
"name": {
"description": "Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.",
"type": "string"
},
"eventName": {
"type": "string",
"description": "Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE."
},
"clickThroughUrl": {
"description": "Parameter value for the specified click tag. This field contains a click-through url.",
"$ref": "CreativeClickThroughUrl"
}
},
"id": "ClickTag",
"description": "Creative Click Tag."
},
"ReportsConfiguration": {
"description": "Reporting Configuration",
"id": "ReportsConfiguration",
"type": "object",
"properties": {
"reportGenerationTimeZoneId": {
"description": "Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - \"1\" for \"America/New_York\" - \"2\" for \"Europe/London\" - \"3\" for \"Europe/Paris\" - \"4\" for \"Africa/Johannesburg\" - \"5\" for \"Asia/Jerusalem\" - \"6\" for \"Asia/Shanghai\" - \"7\" for \"Asia/Hong_Kong\" - \"8\" for \"Asia/Tokyo\" - \"9\" for \"Australia/Sydney\" - \"10\" for \"Asia/Dubai\" - \"11\" for \"America/Los_Angeles\" - \"12\" for \"Pacific/Auckland\" - \"13\" for \"America/Sao_Paulo\" - \"16\" for \"America/Asuncion\" - \"17\" for \"America/Chicago\" - \"18\" for \"America/Denver\" - \"19\" for \"America/St_Johns\" - \"20\" for \"Asia/Dhaka\" - \"21\" for \"Asia/Jakarta\" - \"22\" for \"Asia/Kabul\" - \"23\" for \"Asia/Karachi\" - \"24\" for \"Asia/Calcutta\" - \"25\" for \"Asia/Pyongyang\" - \"26\" for \"Asia/Rangoon\" - \"27\" for \"Atlantic/Cape_Verde\" - \"28\" for \"Atlantic/South_Georgia\" - \"29\" for \"Australia/Adelaide\" - \"30\" for \"Australia/Lord_Howe\" - \"31\" for \"Europe/Moscow\" - \"32\" for \"Pacific/Kiritimati\" - \"35\" for \"Pacific/Norfolk\" - \"36\" for \"Pacific/Tongatapu\" ",
"format": "int64",
"type": "string"
},
"exposureToConversionEnabled": {
"description": "Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.",
"type": "boolean"
},
"lookbackConfiguration": {
"description": "Default lookback windows for new advertisers in this account.",
"$ref": "LookbackConfiguration"
}
}
},
"FloodlightActivitiesListResponse": {
"id": "FloodlightActivitiesListResponse",
"properties": {
"floodlightActivities": {
"type": "array",
"description": "Floodlight activity collection.",
"items": {
"$ref": "FloodlightActivity"
}
},
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesListResponse\"."
}
},
"description": "Floodlight Activity List Response",
"type": "object"
},
"UniversalAdId": {
"properties": {
"value": {
"description": "ID value for this creative. Only alphanumeric characters and the following symbols are valid: \"_/\\-\". Maximum length is 64 characters. Read only when registry is DCM.",
"type": "string"
},
"registry": {
"type": "string",
"description": "Registry used for the Ad ID value.",
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"OTHER",
"AD_ID_OFFICIAL",
"CLEARCAST",
"DCM"
]
}
},
"id": "UniversalAdId",
"description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID.",
"type": "object"
},
"OffsetPosition": {
"description": "Offset Position.",
"properties": {
"top": {
"description": "Offset distance from top side of an asset or a window.",
"type": "integer",
"format": "int32"
},
"left": {
"format": "int32",
"description": "Offset distance from left side of an asset or a window.",
"type": "integer"
}
},
"type": "object",
"id": "OffsetPosition"
},
"SiteSkippableSetting": {
"id": "SiteSkippableSetting",
"description": "Skippable Settings",
"type": "object",
"properties": {
"skippable": {
"type": "boolean",
"description": "Whether the user can skip creatives served to this site. This will act as default for new placements created under this site."
},
"progressOffset": {
"description": "Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.",
"$ref": "VideoOffset"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteSkippableSetting\".",
"type": "string"
},
"skipOffset": {
"description": "Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.",
"$ref": "VideoOffset"
}
}
},
"ReportList": {
"description": "Represents the list of reports.",
"type": "object",
"id": "ReportList",
"properties": {
"nextPageToken": {
"type": "string",
"description": "Continuation token used to page through reports. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
},
"items": {
"type": "array",
"items": {
"$ref": "Report"
},
"description": "The reports returned in this response."
},
"etag": {
"type": "string",
"description": "The eTag of this response for caching purposes."
},
"kind": {
"description": "The kind of list this is, in this case dfareporting#reportList.",
"type": "string"
}
}
},
"Metro": {
"type": "object",
"description": "Contains information about a metro region that can be targeted by ads.",
"id": "Metro",
"properties": {
"name": {
"type": "string",
"description": "Name of this metro region."
},
"dartId": {
"description": "DART ID of this metro region.",
"format": "int64",
"type": "string"
},
"dmaId": {
"type": "string",
"description": "DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.",
"format": "int64"
},
"metroCode": {
"type": "string",
"description": "Metro code of this metro region. This is equivalent to dma_id."
},
"countryDartId": {
"description": "DART ID of the country to which this metro region belongs.",
"type": "string",
"format": "int64"
},
"countryCode": {
"type": "string",
"description": "Country code of the country to which this metro region belongs."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metro\"."
}
}
},
"UserRolePermissionsListResponse": {
"properties": {
"userRolePermissions": {
"items": {
"$ref": "UserRolePermission"
},
"type": "array",
"description": "User role permission collection."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionsListResponse\"."
}
},
"id": "UserRolePermissionsListResponse",
"description": "User Role Permission List Response",
"type": "object"
},
"CrossDimensionReachReportCompatibleFields": {
"properties": {
"kind": {
"description": "The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.",
"type": "string"
},
"breakdown": {
"items": {
"$ref": "Dimension"
},
"description": "Dimensions which are compatible to be selected in the \"breakdown\" section of the report.",
"type": "array"
},
"overlapMetrics": {
"items": {
"$ref": "Metric"
},
"type": "array",
"description": "Metrics which are compatible to be selected in the \"overlapMetricNames\" section of the report."
},
"metrics": {
"type": "array",
"items": {
"$ref": "Metric"
},
"description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report."
},
"dimensionFilters": {
"description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
"type": "array",
"items": {
"$ref": "Dimension"
}
}
},
"description": "Represents fields that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\".",
"id": "CrossDimensionReachReportCompatibleFields",
"type": "object"
},
"Browser": {
"description": "Contains information about a browser that can be targeted by ads.",
"properties": {
"dartId": {
"type": "string",
"description": "DART ID of this browser. This is the ID used when generating reports.",
"format": "int64"
},
"majorVersion": {
"description": "Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.",
"type": "string"
},
"name": {
"type": "string",
"description": "Name of this browser."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browser\"."
},
"minorVersion": {
"type": "string",
"description": "Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is."
},
"browserVersionId": {
"format": "int64",
"type": "string",
"description": "ID referring to this grouping of browser and version numbers. This is the ID used for targeting."
}
},
"type": "object",
"id": "Browser"
},
"FloodlightActivityDynamicTag": {
"type": "object",
"properties": {
"tag": {
"description": "Tag code.",
"type": "string"
},
"name": {
"type": "string",
"description": "Name of this tag."
},
"id": {
"type": "string",
"description": "ID of this dynamic tag. This is a read-only, auto-generated field.",
"format": "int64"
}
},
"id": "FloodlightActivityDynamicTag",
"description": "Dynamic Tag"
},
"CreativeAssetId": {
"properties": {
"name": {
"description": "Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: \".-_ \". Spaces are allowed.",
"type": "string"
},
"type": {
"type": "string",
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"enum": [
"IMAGE",
"FLASH",
"VIDEO",
"HTML",
"HTML_IMAGE",
"AUDIO"
],
"description": "Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE."
}
},
"type": "object",
"description": "Creative Asset ID.",
"id": "CreativeAssetId"
},
"ConversionStatus": {
"description": "The original conversion that was inserted or updated and whether there were any errors.",
"properties": {
"conversion": {
"description": "The original conversion that was inserted or updated.",
"$ref": "Conversion"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionStatus\".",
"type": "string"
},
"errors": {
"description": "A list of errors related to this conversion.",
"type": "array",
"items": {
"$ref": "ConversionError"
}
}
},
"id": "ConversionStatus",
"type": "object"
},
"KeyValueTargetingExpression": {
"properties": {
"expression": {
"type": "string",
"description": "Keyword expression being targeted by the ad."
}
},
"type": "object",
"description": "Key Value Targeting Expression.",
"id": "KeyValueTargetingExpression"
},
"FloodlightConfiguration": {
"properties": {
"analyticsDataSharingEnabled": {
"description": "Whether advertiser data is shared with Google Analytics.",
"type": "boolean"
},
"lookbackConfiguration": {
"$ref": "LookbackConfiguration",
"description": "Lookback window settings for this floodlight configuration."
},
"userDefinedVariableConfigurations": {
"description": "List of user defined variables enabled for this configuration.",
"type": "array",
"items": {
"$ref": "UserDefinedVariableConfiguration"
}
},
"naturalSearchConversionAttributionOption": {
"type": "string",
"enumDescriptions": [
"",
"",
""
],
"description": "Types of attribution options for natural search conversions.",
"enum": [
"EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
"INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
"INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION"
]
},
"exposureToConversionEnabled": {
"description": "Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.",
"type": "boolean"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfiguration\"."
},
"tagSettings": {
"description": "Configuration settings for dynamic and image floodlight tags.",
"$ref": "TagSettings"
},
"advertiserIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
},
"customViewabilityMetric": {
"description": "Custom Viewability metric for the floodlight configuration.",
"$ref": "CustomViewabilityMetric"
},
"inAppAttributionTrackingEnabled": {
"description": "Whether in-app attribution tracking is enabled.",
"type": "boolean"
},
"idDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field."
},
"thirdPartyAuthenticationTokens": {
"items": {
"$ref": "ThirdPartyAuthenticationToken"
},
"description": "List of third-party authentication tokens enabled for this configuration.",
"type": "array"
},
"subaccountId": {
"type": "string",
"description": "Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.",
"format": "int64"
},
"firstDayOfWeek": {
"description": "Day that will be counted as the first day of the week in reports. This is a required field.",
"type": "string",
"enumDescriptions": [
"",
""
],
"enum": [
"MONDAY",
"SUNDAY"
]
},
"omnitureSettings": {
"$ref": "OmnitureSettings",
"description": "Settings for Campaign Manager Omniture integration."
},
"accountId": {
"type": "string",
"format": "int64",
"description": "Account ID of this floodlight configuration. This is a read-only field that can be left blank."
},
"advertiserId": {
"format": "int64",
"description": "Advertiser ID of the parent advertiser of this floodlight configuration.",
"type": "string"
},
"id": {
"description": "ID of this floodlight configuration. This is a read-only, auto-generated field.",
"type": "string",
"format": "int64"
}
},
"id": "FloodlightConfiguration",
"description": "Contains properties of a Floodlight configuration.",
"type": "object"
},
"UserRolePermissionGroupsListResponse": {
"type": "object",
"description": "User Role Permission Group List Response",
"id": "UserRolePermissionGroupsListResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroupsListResponse\"."
},
"userRolePermissionGroups": {
"items": {
"$ref": "UserRolePermissionGroup"
},
"description": "User role permission group collection.",
"type": "array"
}
}
},
"EventTagOverride": {
"description": "Event tag override information.",
"properties": {
"enabled": {
"description": "Whether this override is enabled.",
"type": "boolean"
},
"id": {
"description": "ID of this event tag override. This is a read-only, auto-generated field.",
"format": "int64",
"type": "string"
}
},
"type": "object",
"id": "EventTagOverride"
},
"LookbackConfiguration": {
"id": "LookbackConfiguration",
"type": "object",
"description": "Lookback configuration settings.",
"properties": {
"clickDuration": {
"format": "int32",
"type": "integer",
"description": "Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive."
},
"postImpressionActivitiesDuration": {
"type": "integer",
"format": "int32",
"description": "Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive."
}
}
},
"SortedDimension": {
"id": "SortedDimension",
"description": "Represents a sorted dimension.",
"properties": {
"sortOrder": {
"enumDescriptions": [
"",
""
],
"description": "An optional sort order for the dimension column.",
"type": "string",
"enum": [
"ASCENDING",
"DESCENDING"
]
},
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#sortedDimension."
},
"name": {
"type": "string",
"description": "The name of the dimension."
}
},
"type": "object"
},
"OperatingSystem": {
"description": "Contains information about an operating system that can be targeted by ads.",
"id": "OperatingSystem",
"type": "object",
"properties": {
"desktop": {
"type": "boolean",
"description": "Whether this operating system is for desktop."
},
"name": {
"type": "string",
"description": "Name of this operating system."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystem\"."
},
"dartId": {
"type": "string",
"format": "int64",
"description": "DART ID of this operating system. This is the ID used for targeting."
},
"mobile": {
"description": "Whether this operating system is for mobile.",
"type": "boolean"
}
}
},
"CustomFloodlightVariable": {
"type": "object",
"id": "CustomFloodlightVariable",
"properties": {
"type": {
"type": "string",
"description": "The type of custom floodlight variable to supply a value for. These map to the \"u[1-20]=\" in the tags.",
"enum": [
"U1",
"U2",
"U3",
"U4",
"U5",
"U6",
"U7",
"U8",
"U9",
"U10",
"U11",
"U12",
"U13",
"U14",
"U15",
"U16",
"U17",
"U18",
"U19",
"U20",
"U21",
"U22",
"U23",
"U24",
"U25",
"U26",
"U27",
"U28",
"U29",
"U30",
"U31",
"U32",
"U33",
"U34",
"U35",
"U36",
"U37",
"U38",
"U39",
"U40",
"U41",
"U42",
"U43",
"U44",
"U45",
"U46",
"U47",
"U48",
"U49",
"U50",
"U51",
"U52",
"U53",
"U54",
"U55",
"U56",
"U57",
"U58",
"U59",
"U60",
"U61",
"U62",
"U63",
"U64",
"U65",
"U66",
"U67",
"U68",
"U69",
"U70",
"U71",
"U72",
"U73",
"U74",
"U75",
"U76",
"U77",
"U78",
"U79",
"U80",
"U81",
"U82",
"U83",
"U84",
"U85",
"U86",
"U87",
"U88",
"U89",
"U90",
"U91",
"U92",
"U93",
"U94",
"U95",
"U96",
"U97",
"U98",
"U99",
"U100"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customFloodlightVariable\".",
"type": "string"
},
"value": {
"type": "string",
"description": "The value of the custom floodlight variable. The length of string must not exceed 50 characters."
}
},
"description": "A custom floodlight variable."
},
"AccountsListResponse": {
"description": "Account List Response",
"properties": {
"accounts": {
"description": "Account collection.",
"type": "array",
"items": {
"$ref": "Account"
}
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to be used for the next list operation."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountsListResponse\"."
}
},
"id": "AccountsListResponse",
"type": "object"
},
"AccountPermission": {
"description": "AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermission\".",
"type": "string"
},
"accountProfiles": {
"type": "array",
"description": "Account profiles associated with this account permission. Possible values are: - \"ACCOUNT_PROFILE_BASIC\" - \"ACCOUNT_PROFILE_STANDARD\" ",
"items": {
"enum": [
"ACCOUNT_PROFILE_BASIC",
"ACCOUNT_PROFILE_STANDARD"
],
"type": "string",
"enumDescriptions": [
"",
""
]
}
},
"level": {
"description": "Administrative level required to enable this account permission.",
"enumDescriptions": [
"",
""
],
"type": "string",
"enum": [
"USER",
"ADMINISTRATOR"
]
},
"id": {
"format": "int64",
"type": "string",
"description": "ID of this account permission."
},
"name": {
"type": "string",
"description": "Name of this account permission."
},
"permissionGroupId": {
"type": "string",
"description": "Permission group of this account permission.",
"format": "int64"
}
},
"type": "object",
"id": "AccountPermission"
},
"FloodlightReportCompatibleFields": {
"description": "Represents fields that are compatible to be selected for a report of type \"FlOODLIGHT\".",
"properties": {
"kind": {
"description": "The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.",
"type": "string"
},
"dimensions": {
"type": "array",
"description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
"items": {
"$ref": "Dimension"
}
},
"metrics": {
"items": {
"$ref": "Metric"
},
"type": "array",
"description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report."
},
"dimensionFilters": {
"description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
"type": "array",
"items": {
"$ref": "Dimension"
}
}
},
"id": "FloodlightReportCompatibleFields",
"type": "object"
},
"CreativeClickThroughUrl": {
"id": "CreativeClickThroughUrl",
"properties": {
"computedClickThroughUrl": {
"description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. ",
"type": "string"
},
"customClickThroughUrl": {
"description": "Custom click-through URL. Applicable if the landingPageId field is left unset.",
"type": "string"
},
"landingPageId": {
"format": "int64",
"description": "ID of the landing page for the click-through URL.",
"type": "string"
}
},
"type": "object",
"description": "Click-through URL"
},
"CustomEvent": {
"id": "CustomEvent",
"properties": {
"annotateImpressionEvent": {
"description": "Annotate an impression. This field is mutually exclusive with insertEvent and annotateClickEvent. This or insertEvent and annotateClickEvent is a required field.",
"$ref": "CustomEventImpressionAnnotation"
},
"floodlightConfigurationId": {
"type": "string",
"description": "Floodlight configuration ID of the advertiser the event is linked to. This is a required field.",
"format": "int64"
},
"customVariables": {
"description": "Custom variables associated with the event.",
"items": {
"$ref": "CustomVariable"
},
"type": "array"
},
"insertEvent": {
"$ref": "CustomEventInsert",
"description": "Insert custom event. This field is mutually exclusive with annotateClickEvent and annotateImpressionEvent. This or annotateClickEvent and annotateImpressionEvent is a required field."
},
"annotateClickEvent": {
"$ref": "CustomEventClickAnnotation",
"description": "Annotate a click event. This field is mutually exclusive with insertEvent and annotateImpressionEvent. This or insertEvent and annotateImpressionEvent is a required field."
},
"timestampMicros": {
"description": "The timestamp of this custom event, in Unix epoch micros. This is a required field.",
"format": "int64",
"type": "string"
},
"ordinal": {
"type": "string",
"description": "The ordinal of this custom event. This is a required field."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEvent\".",
"type": "string"
},
"eventType": {
"type": "string",
"enumDescriptions": [
"",
"",
""
],
"enum": [
"UNKNOWN",
"INSERT",
"ANNOTATE"
],
"description": "The type of event. If INSERT, the fields in insertEvent need to be populated. If ANNOTATE, the fields in either annotateClickEvent or annotateImpressionEvent need to be populated."
}
},
"type": "object",
"description": "Experimental feature (no support provided) A custom event represents a third party impression, a third party click, an annotation on a first party impression, or an annotation on a first party click."
},
"CompanionClickThroughOverride": {
"id": "CompanionClickThroughOverride",
"properties": {
"clickThroughUrl": {
"description": "Click-through URL of this companion click-through override.",
"$ref": "ClickThroughUrl"
},
"creativeId": {
"description": "ID of the creative for this companion click-through override.",
"type": "string",
"format": "int64"
}
},
"description": "Companion Click-through override.",
"type": "object"
},
"CampaignManagerIds": {
"type": "object",
"id": "CampaignManagerIds",
"properties": {
"placementId": {
"description": "Placement ID for Campaign Manager.",
"type": "string",
"format": "int64"
},
"campaignId": {
"description": "Campaign ID for Campaign Manager.",
"type": "string",
"format": "int64"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignManagerIds\"."
},
"adId": {
"description": "Ad ID for Campaign Manager.",
"format": "int64",
"type": "string"
},
"creativeId": {
"type": "string",
"description": "Creative ID for Campaign Manager.",
"format": "int64"
},
"siteId": {
"format": "int64",
"type": "string",
"description": "Site ID for Campaign Manager."
}
},
"description": "Campaign Manager IDs related to the custom event."
},
"CustomViewabilityMetricConfiguration": {
"id": "CustomViewabilityMetricConfiguration",
"type": "object",
"description": "The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric.",
"properties": {
"timeMillis": {
"type": "integer",
"format": "int32",
"description": "The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used."
},
"timePercent": {
"description": "The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.",
"format": "int32",
"type": "integer"
},
"viewabilityPercent": {
"type": "integer",
"format": "int32",
"description": "The percentage of video that must be on screen for the Custom Viewability Metric to count an impression."
},
"audible": {
"description": "Whether the video must be audible to count an impression.",
"type": "boolean"
}
}
},
"MobileApp": {
"id": "MobileApp",
"type": "object",
"description": "Contains information about a mobile app. Used as a landing page deep link.",
"properties": {
"directory": {
"enum": [
"UNKNOWN",
"APPLE_APP_STORE",
"GOOGLE_PLAY_STORE"
],
"description": "Mobile app directory.",
"type": "string",
"enumDescriptions": [
"",
"",
""
]
},
"publisherName": {
"type": "string",
"description": "Publisher name."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileApp\".",
"type": "string"
},
"id": {
"type": "string",
"description": "ID of this mobile app."
},
"title": {
"description": "Title of this mobile app.",
"type": "string"
}
}
},
"CreativeOptimizationConfiguration": {
"type": "object",
"properties": {
"optimizationActivitys": {
"description": "List of optimization activities associated with this configuration.",
"items": {
"$ref": "OptimizationActivity"
},
"type": "array"
},
"id": {
"format": "int64",
"description": "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.",
"type": "string"
},
"name": {
"type": "string",
"description": "Name of this creative optimization config. This is a required field and must be less than 129 characters long."
},
"optimizationModel": {
"type": "string",
"enum": [
"CLICK",
"POST_CLICK",
"POST_IMPRESSION",
"POST_CLICK_AND_IMPRESSION",
"VIDEO_COMPLETION"
],
"description": "Optimization model for this configuration.",
"enumDescriptions": [
"",
"",
"",
"",
""
]
}
},
"id": "CreativeOptimizationConfiguration",
"description": "Creative optimization settings."
},
"OrderContact": {
"id": "OrderContact",
"properties": {
"contactName": {
"type": "string",
"description": "Name of this contact."
},
"signatureUserProfileId": {
"type": "string",
"description": "ID of the user profile containing the signature that will be embedded into order documents.",
"format": "int64"
},
"contactTitle": {
"type": "string",
"description": "Title of this contact."
},
"contactInfo": {
"type": "string",
"description": "Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID."
},
"contactType": {
"enumDescriptions": [
"",
"",
""
],
"enum": [
"PLANNING_ORDER_CONTACT_BUYER_CONTACT",
"PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT",
"PLANNING_ORDER_CONTACT_SELLER_CONTACT"
],
"description": "Type of this contact.",
"type": "string"
}
},
"type": "object",
"description": "Contact of an order."
},
"ProjectsListResponse": {
"type": "object",
"id": "ProjectsListResponse",
"description": "Project List Response",
"properties": {
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#projectsListResponse\"."
},
"projects": {
"type": "array",
"items": {
"$ref": "Project"
},
"description": "Project collection."
}
}
},
"FloodlightActivityPublisherDynamicTag": {
"properties": {
"directorySiteId": {
"format": "int64",
"type": "string",
"description": "Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated."
},
"clickThrough": {
"type": "boolean",
"description": "Whether this tag is applicable only for click-throughs."
},
"dynamicTag": {
"$ref": "FloodlightActivityDynamicTag",
"description": "Dynamic floodlight tag."
},
"viewThrough": {
"description": "Whether this tag is applicable only for view-throughs.",
"type": "boolean"
},
"siteId": {
"type": "string",
"format": "int64",
"description": "Site ID of this dynamic tag."
},
"siteIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
}
},
"id": "FloodlightActivityPublisherDynamicTag",
"description": "Publisher Dynamic Tag",
"type": "object"
},
"DisjunctiveMatchStatement": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement."
},
"eventFilters": {
"items": {
"$ref": "EventFilter"
},
"description": "The event filters contained within this disjunctive match statement.",
"type": "array"
}
},
"id": "DisjunctiveMatchStatement",
"description": "Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements."
},
"DimensionFilter": {
"properties": {
"value": {
"description": "The value of the dimension to filter.",
"type": "string"
},
"dimensionName": {
"type": "string",
"description": "The name of the dimension to filter."
},
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#dimensionFilter."
}
},
"id": "DimensionFilter",
"type": "object",
"description": "Represents a dimension filter."
},
"FrequencyCap": {
"description": "Frequency Cap.",
"id": "FrequencyCap",
"type": "object",
"properties": {
"impressions": {
"description": "Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.",
"type": "string",
"format": "int64"
},
"duration": {
"format": "int64",
"type": "string",
"description": "Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive."
}
}
},
"Activities": {
"type": "object",
"properties": {
"metricNames": {
"description": "List of names of floodlight activity metrics.",
"items": {
"type": "string"
},
"type": "array"
},
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#activities."
},
"filters": {
"type": "array",
"items": {
"$ref": "DimensionValue"
},
"description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\"."
}
},
"description": "Represents an activity group.",
"id": "Activities"
},
"DimensionValueRequest": {
"properties": {
"kind": {
"description": "The kind of request this is, in this case dfareporting#dimensionValueRequest .",
"type": "string"
},
"dimensionName": {
"description": "The name of the dimension for which values should be requested.",
"annotations": {
"required": [
"dfareporting.dimensionValues.query"
]
},
"type": "string"
},
"startDate": {
"type": "string",
"format": "date"
},
"filters": {
"items": {
"$ref": "DimensionFilter"
},
"type": "array",
"description": "The list of filters by which to filter values. The filters are ANDed."
},
"endDate": {
"type": "string",
"format": "date"
}
},
"id": "DimensionValueRequest",
"type": "object",
"description": "Represents a DimensionValuesRequest."
},
"OrderDocumentsListResponse": {
"id": "OrderDocumentsListResponse",
"description": "Order document List Response",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocumentsListResponse\"."
},
"orderDocuments": {
"type": "array",
"description": "Order document collection",
"items": {
"$ref": "OrderDocument"
}
},
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
}
},
"type": "object"
},
"ObjectFilter": {
"description": "Object Filter.",
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#objectFilter\".",
"type": "string"
},
"objectIds": {
"description": "Applicable when status is ASSIGNED. The user has access to objects with these object IDs.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"status": {
"enumDescriptions": [
"",
"",
""
],
"enum": [
"NONE",
"ASSIGNED",
"ALL"
],
"type": "string",
"description": "Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list."
}
},
"id": "ObjectFilter"
},
"MobileAppsListResponse": {
"description": "Mobile app List Response",
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileAppsListResponse\".",
"type": "string"
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to be used for the next list operation."
},
"mobileApps": {
"items": {
"$ref": "MobileApp"
},
"description": "Mobile apps collection.",
"type": "array"
}
},
"id": "MobileAppsListResponse"
},
"DateRange": {
"id": "DateRange",
"description": "Represents a date range.",
"properties": {
"relativeDateRange": {
"description": "The date range relative to the date of when the report is run.",
"type": "string",
"enum": [
"TODAY",
"YESTERDAY",
"WEEK_TO_DATE",
"MONTH_TO_DATE",
"QUARTER_TO_DATE",
"YEAR_TO_DATE",
"PREVIOUS_WEEK",
"PREVIOUS_MONTH",
"PREVIOUS_QUARTER",
"PREVIOUS_YEAR",
"LAST_7_DAYS",
"LAST_30_DAYS",
"LAST_90_DAYS",
"LAST_365_DAYS",
"LAST_24_MONTHS",
"LAST_14_DAYS",
"LAST_60_DAYS"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#dateRange."
},
"endDate": {
"type": "string",
"format": "date"
},
"startDate": {
"type": "string",
"format": "date"
}
},
"type": "object"
},
"DefaultClickThroughEventTagProperties": {
"id": "DefaultClickThroughEventTagProperties",
"description": "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.",
"type": "object",
"properties": {
"defaultClickThroughEventTagId": {
"format": "int64",
"description": "ID of the click-through event tag to apply to all ads in this entity's scope.",
"type": "string"
},
"overrideInheritedEventTag": {
"type": "boolean",
"description": "Whether this entity should override the inherited default click-through event tag with its own defined value."
}
}
},
"ConversionsBatchUpdateResponse": {
"description": "Update Conversions Response.",
"id": "ConversionsBatchUpdateResponse",
"type": "object",
"properties": {
"hasFailures": {
"type": "boolean",
"description": "Indicates that some or all conversions failed to update."
},
"status": {
"type": "array",
"items": {
"$ref": "ConversionStatus"
},
"description": "The update status of each conversion. Statuses are returned in the same order that conversions are updated."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchUpdateResponse\".",
"type": "string"
}
}
},
"Project": {
"type": "object",
"properties": {
"overview": {
"description": "Overview of this project.",
"type": "string"
},
"endDate": {
"type": "string",
"format": "date"
},
"id": {
"description": "ID of this project. This is a read-only, auto-generated field.",
"type": "string",
"format": "int64"
},
"audienceGender": {
"type": "string",
"description": "Audience gender of this project.",
"enum": [
"PLANNING_AUDIENCE_GENDER_MALE",
"PLANNING_AUDIENCE_GENDER_FEMALE"
],
"enumDescriptions": [
"",
""
]
},
"clientBillingCode": {
"type": "string",
"description": "Client billing code of this project."
},
"targetCpaNanos": {
"description": "CPA that the advertiser is targeting.",
"format": "int64",
"type": "string"
},
"targetConversions": {
"type": "string",
"format": "int64",
"description": "Number of conversions that the advertiser is targeting."
},
"startDate": {
"format": "date",
"type": "string"
},
"budget": {
"format": "int64",
"description": "Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.",
"type": "string"
},
"targetImpressions": {
"description": "Number of impressions that the advertiser is targeting.",
"type": "string",
"format": "int64"
},
"targetCpmNanos": {
"format": "int64",
"type": "string",
"description": "CPM that the advertiser is targeting."
},
"advertiserId": {
"description": "Advertiser ID of this project.",
"format": "int64",
"type": "string"
},
"targetCpmActiveViewNanos": {
"description": "vCPM from Active View that the advertiser is targeting.",
"format": "int64",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#project\".",
"type": "string"
},
"audienceAgeGroup": {
"enum": [
"PLANNING_AUDIENCE_AGE_18_24",
"PLANNING_AUDIENCE_AGE_25_34",
"PLANNING_AUDIENCE_AGE_35_44",
"PLANNING_AUDIENCE_AGE_45_54",
"PLANNING_AUDIENCE_AGE_55_64",
"PLANNING_AUDIENCE_AGE_65_OR_MORE",
"PLANNING_AUDIENCE_AGE_UNKNOWN"
],
"type": "string",
"description": "Audience age group of this project.",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
]
},
"name": {
"type": "string",
"description": "Name of this project."
},
"clientName": {
"type": "string",
"description": "Name of the project client."
},
"accountId": {
"type": "string",
"description": "Account ID of this project.",
"format": "int64"
},
"lastModifiedInfo": {
"$ref": "LastModifiedInfo",
"description": "Information about the most recent modification of this project."
},
"subaccountId": {
"description": "Subaccount ID of this project.",
"type": "string",
"format": "int64"
},
"targetCpcNanos": {
"description": "CPC that the advertiser is targeting.",
"format": "int64",
"type": "string"
},
"targetClicks": {
"type": "string",
"description": "Number of clicks that the advertiser is targeting.",
"format": "int64"
}
},
"description": "Contains properties of a Planning project.",
"id": "Project"
},
"Region": {
"description": "Contains information about a region that can be targeted by ads.",
"id": "Region",
"properties": {
"name": {
"description": "Name of this region.",
"type": "string"
},
"countryCode": {
"type": "string",
"description": "Country code of the country to which this region belongs."
},
"regionCode": {
"description": "Region code.",
"type": "string"
},
"dartId": {
"format": "int64",
"description": "DART ID of this region.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#region\"."
},
"countryDartId": {
"type": "string",
"description": "DART ID of the country to which this region belongs.",
"format": "int64"
}
},
"type": "object"
},
"EncryptionInfo": {
"description": "A description of how user IDs are encrypted.",
"type": "object",
"id": "EncryptionInfo",
"properties": {
"encryptionEntityId": {
"description": "The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.",
"format": "int64",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#encryptionInfo\".",
"type": "string"
},
"encryptionEntityType": {
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
],
"type": "string",
"description": "The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.",
"enum": [
"ENCRYPTION_ENTITY_TYPE_UNKNOWN",
"DCM_ACCOUNT",
"DCM_ADVERTISER",
"DBM_PARTNER",
"DBM_ADVERTISER",
"ADWORDS_CUSTOMER",
"DFP_NETWORK_CODE"
]
},
"encryptionSource": {
"type": "string",
"enumDescriptions": [
"",
"",
""
],
"description": "Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.",
"enum": [
"ENCRYPTION_SCOPE_UNKNOWN",
"AD_SERVING",
"DATA_TRANSFER"
]
}
}
},
"RemarketingList": {
"properties": {
"listSize": {
"description": "Number of users currently in the list. This is a read-only field.",
"type": "string",
"format": "int64"
},
"subaccountId": {
"format": "int64",
"type": "string",
"description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests."
},
"description": {
"description": "Remarketing list description.",
"type": "string"
},
"id": {
"description": "Remarketing list ID. This is a read-only, auto-generated field.",
"format": "int64",
"type": "string"
},
"active": {
"type": "boolean",
"description": "Whether this remarketing list is active."
},
"listSource": {
"type": "string",
"enum": [
"REMARKETING_LIST_SOURCE_OTHER",
"REMARKETING_LIST_SOURCE_ADX",
"REMARKETING_LIST_SOURCE_DFP",
"REMARKETING_LIST_SOURCE_XFP",
"REMARKETING_LIST_SOURCE_DFA",
"REMARKETING_LIST_SOURCE_GA",
"REMARKETING_LIST_SOURCE_YOUTUBE",
"REMARKETING_LIST_SOURCE_DBM",
"REMARKETING_LIST_SOURCE_GPLUS",
"REMARKETING_LIST_SOURCE_DMP",
"REMARKETING_LIST_SOURCE_PLAY_STORE"
],
"description": "Product from which this remarketing list was originated.",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingList\"."
},
"listPopulationRule": {
"description": "Rule used to populate the remarketing list with users.",
"$ref": "ListPopulationRule"
},
"name": {
"type": "string",
"description": "Name of the remarketing list. This is a required field. Must be no greater than 128 characters long."
},
"advertiserId": {
"format": "int64",
"type": "string",
"description": "Dimension value for the advertiser ID that owns this remarketing list. This is a required field."
},
"accountId": {
"description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
"type": "string",
"format": "int64"
},
"advertiserIdDimensionValue": {
"description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"lifeSpan": {
"format": "int64",
"type": "string",
"description": "Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive."
}
},
"type": "object",
"description": "Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.",
"id": "RemarketingList"
},
"CreativeFieldValue": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValue\".",
"type": "string"
},
"id": {
"format": "int64",
"description": "ID of this creative field value. This is a read-only, auto-generated field.",
"type": "string"
},
"value": {
"description": "Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.",
"type": "string"
}
},
"id": "CreativeFieldValue",
"description": "Contains properties of a creative field value.",
"type": "object"
},
"CreativeAssignment": {
"type": "object",
"properties": {
"sequence": {
"description": "Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.",
"type": "integer",
"format": "int32"
},
"companionCreativeOverrides": {
"items": {
"$ref": "CompanionClickThroughOverride"
},
"description": "Companion creative overrides for this creative assignment. Applicable to video ads.",
"type": "array"
},
"richMediaExitOverrides": {
"description": "Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR ",
"type": "array",
"items": {
"$ref": "RichMediaExitOverride"
}
},
"clickThroughUrl": {
"description": "Click-through URL of the creative assignment.",
"$ref": "ClickThroughUrl"
},
"creativeIdDimensionValue": {
"description": "Dimension value for the ID of the creative. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"startTime": {
"format": "date-time",
"type": "string"
},
"endTime": {
"format": "date-time",
"type": "string"
},
"weight": {
"description": "Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.",
"type": "integer",
"format": "int32"
},
"sslCompliant": {
"description": "Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.",
"type": "boolean"
},
"applyEventTags": {
"description": "Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.",
"type": "boolean"
},
"creativeId": {
"format": "int64",
"description": "ID of the creative to be assigned. This is a required field.",
"type": "string"
},
"active": {
"type": "boolean",
"description": "Whether this creative assignment is active. When true, the creative will be included in the ad's rotation."
},
"creativeGroupAssignments": {
"type": "array",
"items": {
"$ref": "CreativeGroupAssignment"
},
"description": "Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments."
}
},
"id": "CreativeAssignment",
"description": "Creative Assignment."
},
"EventTag": {
"description": "Contains properties of an event tag.",
"type": "object",
"id": "EventTag",
"properties": {
"subaccountId": {
"format": "int64",
"description": "Subaccount ID of this event tag. This is a read-only field that can be left blank.",
"type": "string"
},
"sslCompliant": {
"type": "boolean",
"description": "Whether this tag is SSL-compliant or not. This is a read-only field."
},
"campaignIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
},
"name": {
"type": "string",
"description": "Name of this event tag. This is a required field and must be less than 256 characters long."
},
"urlEscapeLevels": {
"description": "Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.",
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int64",
"description": "Account ID of this event tag. This is a read-only field that can be left blank.",
"type": "string"
},
"excludeFromAdxRequests": {
"description": "Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.",
"type": "boolean"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTag\".",
"type": "string"
},
"advertiserIdDimensionValue": {
"description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"enabledByDefault": {
"type": "boolean",
"description": "Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads."
},
"status": {
"type": "string",
"description": "Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.",
"enumDescriptions": [
"",
""
],
"enum": [
"ENABLED",
"DISABLED"
]
},
"advertiserId": {
"format": "int64",
"description": "Advertiser ID of this event tag. This field or the campaignId field is required on insertion.",
"type": "string"
},
"siteIds": {
"items": {
"format": "int64",
"type": "string"
},
"description": "Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.",
"type": "array"
},
"siteFilterType": {
"description": "Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.",
"enumDescriptions": [
"",
""
],
"enum": [
"WHITELIST",
"BLACKLIST"
],
"type": "string"
},
"url": {
"type": "string",
"description": "Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion."
},
"type": {
"description": "Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.",
"enum": [
"IMPRESSION_IMAGE_EVENT_TAG",
"IMPRESSION_JAVASCRIPT_EVENT_TAG",
"CLICK_THROUGH_EVENT_TAG"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"campaignId": {
"format": "int64",
"description": "Campaign ID of this event tag. This field or the advertiserId field is required on insertion.",
"type": "string"
},
"id": {
"format": "int64",
"type": "string",
"description": "ID of this event tag. This is a read-only, auto-generated field."
}
}
},
"ConversionError": {
"id": "ConversionError",
"type": "object",
"description": "The error code and description for a conversion that failed to insert or update.",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionError\".",
"type": "string"
},
"code": {
"enumDescriptions": [
"",
"",
"",
""
],
"description": "The error code.",
"enum": [
"INVALID_ARGUMENT",
"INTERNAL",
"PERMISSION_DENIED",
"NOT_FOUND"
],
"type": "string"
},
"message": {
"type": "string",
"description": "A description of the error."
}
}
},
"DfpSettings": {
"type": "object",
"id": "DfpSettings",
"description": "Google Ad Manager Settings",
"properties": {
"publisherPortalOnly": {
"description": "Whether this directory site is available only via Publisher Portal.",
"type": "boolean"
},
"programmaticPlacementAccepted": {
"type": "boolean",
"description": "Whether this directory site accepts programmatic placements."
},
"dfpNetworkName": {
"type": "string",
"description": "Ad Manager network name for this directory site."
},
"pubPaidPlacementAccepted": {
"description": "Whether this directory site accepts publisher-paid tags.",
"type": "boolean"
},
"dfpNetworkCode": {
"description": "Ad Manager network code for this directory site.",
"type": "string"
}
}
},
"OptimizationActivity": {
"type": "object",
"id": "OptimizationActivity",
"properties": {
"weight": {
"format": "int32",
"description": "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.",
"type": "integer"
},
"floodlightActivityIdDimensionValue": {
"description": "Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"floodlightActivityId": {
"type": "string",
"format": "int64",
"description": "Floodlight activity ID of this optimization activity. This is a required field."
}
},
"description": "Creative optimization activity."
},
"SiteContact": {
"properties": {
"address": {
"type": "string",
"description": "Address of this site contact."
},
"lastName": {
"description": "Last name of this site contact.",
"type": "string"
},
"phone": {
"description": "Primary phone number of this site contact.",
"type": "string"
},
"title": {
"description": "Title or designation of this site contact.",
"type": "string"
},
"email": {
"description": "Email address of this site contact. This is a required field.",
"type": "string"
},
"id": {
"type": "string",
"format": "int64",
"description": "ID of this site contact. This is a read-only, auto-generated field."
},
"firstName": {
"type": "string",
"description": "First name of this site contact."
},
"contactType": {
"enumDescriptions": [
"",
""
],
"enum": [
"SALES_PERSON",
"TRAFFICKER"
],
"description": "Site contact type.",
"type": "string"
}
},
"type": "object",
"id": "SiteContact",
"description": "Site Contact"
},
"City": {
"type": "object",
"description": "Contains information about a city that can be targeted by ads.",
"properties": {
"metroDmaId": {
"type": "string",
"format": "int64",
"description": "ID of the metro region (DMA) to which this city belongs."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#city\"."
},
"dartId": {
"format": "int64",
"type": "string",
"description": "DART ID of this city. This is the ID used for targeting and generating reports."
},
"regionCode": {
"type": "string",
"description": "Region code of the region to which this city belongs."
},
"name": {
"description": "Name of this city.",
"type": "string"
},
"metroCode": {
"type": "string",
"description": "Metro region code of the metro region (DMA) to which this city belongs."
},
"countryCode": {
"type": "string",
"description": "Country code of the country to which this city belongs."
},
"regionDartId": {
"format": "int64",
"description": "DART ID of the region to which this city belongs.",
"type": "string"
},
"countryDartId": {
"type": "string",
"format": "int64",
"description": "DART ID of the country to which this city belongs."
}
},
"id": "City"
},
"Conversion": {
"id": "Conversion",
"description": "A Conversion represents when a user successfully performs a desired action after seeing an ad.",
"properties": {
"floodlightConfigurationId": {
"type": "string",
"description": "Floodlight Configuration ID of this conversion. This is a required field.",
"format": "int64"
},
"encryptedUserId": {
"type": "string",
"description": "The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid and dclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid is a required field."
},
"matchId": {
"type": "string",
"description": "The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid is a required field."
},
"timestampMicros": {
"format": "int64",
"type": "string",
"description": "The timestamp of conversion, in Unix epoch micros. This is a required field."
},
"ordinal": {
"type": "string",
"description": "The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field."
},
"mobileDeviceId": {
"description": "The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid is a required field.",
"type": "string"
},
"limitAdTracking": {
"type": "boolean",
"description": "Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing."
},
"dclid": {
"description": "The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field.",
"type": "string"
},
"floodlightActivityId": {
"type": "string",
"format": "int64",
"description": "Floodlight Activity ID of this conversion. This is a required field."
},
"encryptedUserIdCandidates": {
"items": {
"type": "string"
},
"description": "A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid and dclid. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid is a required field.",
"type": "array"
},
"childDirectedTreatment": {
"type": "boolean",
"description": "Whether this particular request may come from a user under the age of 13, under COPPA compliance."
},
"nonPersonalizedAd": {
"description": "Whether the conversion was for a non personalized ad.",
"type": "boolean"
},
"quantity": {
"type": "string",
"description": "The quantity of the conversion.",
"format": "int64"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversion\".",
"type": "string"
},
"value": {
"type": "number",
"format": "double",
"description": "The value of the conversion."
},
"treatmentForUnderage": {
"description": "Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).",
"type": "boolean"
},
"customVariables": {
"description": "Custom floodlight variables.",
"type": "array",
"items": {
"$ref": "CustomFloodlightVariable"
}
},
"gclid": {
"description": "The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid is a required field.",
"type": "string"
}
},
"type": "object"
},
"PlacementsListResponse": {
"id": "PlacementsListResponse",
"type": "object",
"description": "Placement List Response",
"properties": {
"nextPageToken": {
"type": "string",
"description": "Pagination token to be used for the next list operation."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsListResponse\"."
},
"placements": {
"description": "Placement collection.",
"type": "array",
"items": {
"$ref": "Placement"
}
}
}
},
"DimensionValueList": {
"description": "Represents the list of DimensionValue resources.",
"properties": {
"etag": {
"description": "The eTag of this response for caching purposes.",
"type": "string"
},
"nextPageToken": {
"description": "Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.",
"type": "string"
},
"items": {
"description": "The dimension values returned in this response.",
"type": "array",
"items": {
"$ref": "DimensionValue"
}
},
"kind": {
"description": "The kind of list this is, in this case dfareporting#dimensionValueList.",
"type": "string"
}
},
"type": "object",
"id": "DimensionValueList"
},
"PlacementAssignment": {
"type": "object",
"description": "Placement Assignment.",
"properties": {
"placementIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the placement. This is a read-only, auto-generated field."
},
"sslRequired": {
"description": "Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.",
"type": "boolean"
},
"active": {
"description": "Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.",
"type": "boolean"
},
"placementId": {
"type": "string",
"format": "int64",
"description": "ID of the placement to be assigned. This is a required field."
}
},
"id": "PlacementAssignment"
},
"RemarketingListShare": {
"id": "RemarketingListShare",
"description": "Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.",
"type": "object",
"properties": {
"sharedAdvertiserIds": {
"items": {
"type": "string",
"format": "int64"
},
"description": "Advertisers that the remarketing list is shared with.",
"type": "array"
},
"sharedAccountIds": {
"type": "array",
"description": "Accounts that the remarketing list is shared with.",
"items": {
"format": "int64",
"type": "string"
}
},
"remarketingListId": {
"description": "Remarketing list ID. This is a read-only, auto-generated field.",
"format": "int64",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListShare\".",
"type": "string"
}
}
},
"Metric": {
"type": "object",
"properties": {
"name": {
"description": "The metric name, e.g. dfa:impressions",
"type": "string"
},
"kind": {
"description": "The kind of resource this is, in this case dfareporting#metric.",
"type": "string"
}
},
"id": "Metric",
"description": "Represents a metric."
},
"FloodlightActivityGroupsListResponse": {
"id": "FloodlightActivityGroupsListResponse",
"type": "object",
"description": "Floodlight Activity Group List Response",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroupsListResponse\".",
"type": "string"
},
"floodlightActivityGroups": {
"type": "array",
"description": "Floodlight activity group collection.",
"items": {
"$ref": "FloodlightActivityGroup"
}
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to be used for the next list operation."
}
}
},
"VideoFormat": {
"properties": {
"fileType": {
"enumDescriptions": [
"",
"",
"",
"",
""
],
"enum": [
"FLV",
"THREEGPP",
"MP4",
"WEBM",
"M3U8"
],
"description": "File type of the video format.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoFormat\".",
"type": "string"
},
"id": {
"type": "integer",
"description": "ID of the video format.",
"format": "int32"
},
"resolution": {
"description": "The resolution of this video format.",
"$ref": "Size"
},
"targetBitRate": {
"description": "The target bit rate of this video format.",
"format": "int32",
"type": "integer"
}
},
"description": "Contains information about supported video formats.",
"id": "VideoFormat",
"type": "object"
},
"Order": {
"id": "Order",
"properties": {
"planningTermId": {
"description": "ID of the terms and conditions template used in this order.",
"type": "string",
"format": "int64"
},
"siteId": {
"items": {
"format": "int64",
"type": "string"
},
"description": "Site IDs this order is associated with.",
"type": "array"
},
"buyerOrganizationName": {
"type": "string",
"description": "Name of the buyer organization."
},
"advertiserId": {
"description": "Advertiser ID of this order.",
"format": "int64",
"type": "string"
},
"comments": {
"type": "string",
"description": "Comments in this order."
},
"notes": {
"type": "string",
"description": "Notes of this order."
},
"projectId": {
"format": "int64",
"description": "Project ID of this order.",
"type": "string"
},
"siteNames": {
"description": "Free-form site names this order is associated with.",
"type": "array",
"items": {
"type": "string"
}
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#order\"."
},
"lastModifiedInfo": {
"description": "Information about the most recent modification of this order.",
"$ref": "LastModifiedInfo"
},
"approverUserProfileIds": {
"description": "IDs for users that have to approve documents created for this order.",
"type": "array",
"items": {
"format": "int64",
"type": "string"
}
},
"buyerInvoiceId": {
"type": "string",
"description": "Buyer invoice ID associated with this order."
},
"subaccountId": {
"description": "Subaccount ID of this order.",
"format": "int64",
"type": "string"
},
"id": {
"description": "ID of this order. This is a read-only, auto-generated field.",
"format": "int64",
"type": "string"
},
"sellerOrganizationName": {
"type": "string",
"description": "Name of the seller organization."
},
"sellerOrderId": {
"type": "string",
"description": "Seller order ID associated with this order."
},
"accountId": {
"type": "string",
"description": "Account ID of this order.",
"format": "int64"
},
"contacts": {
"type": "array",
"description": "Contacts for this order.",
"items": {
"$ref": "OrderContact"
}
},
"name": {
"description": "Name of this order.",
"type": "string"
},
"termsAndConditions": {
"type": "string",
"description": "Terms and conditions of this order."
}
},
"description": "Describes properties of a Planning order.",
"type": "object"
},
"SiteTranscodeSetting": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteTranscodeSetting\"."
},
"enabledVideoFormats": {
"items": {
"format": "int32",
"type": "integer"
},
"type": "array",
"description": "Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats."
}
},
"description": "Transcode Settings",
"id": "SiteTranscodeSetting",
"type": "object"
},
"Country": {
"description": "Contains information about a country that can be targeted by ads.",
"type": "object",
"id": "Country",
"properties": {
"sslEnabled": {
"type": "boolean",
"description": "Whether ad serving supports secure servers in this country."
},
"name": {
"type": "string",
"description": "Name of this country."
},
"countryCode": {
"type": "string",
"description": "Country code."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#country\".",
"type": "string"
},
"dartId": {
"type": "string",
"format": "int64",
"description": "DART ID of this country. This is the ID used for targeting and generating reports."
}
}
},
"PlacementTag": {
"id": "PlacementTag",
"properties": {
"placementId": {
"format": "int64",
"description": "Placement ID",
"type": "string"
},
"tagDatas": {
"description": "Tags generated for this placement.",
"type": "array",
"items": {
"$ref": "TagData"
}
}
},
"type": "object",
"description": "Placement Tag"
},
"ReachReportCompatibleFields": {
"id": "ReachReportCompatibleFields",
"properties": {
"metrics": {
"description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
"items": {
"$ref": "Metric"
},
"type": "array"
},
"dimensions": {
"description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
"items": {
"$ref": "Dimension"
},
"type": "array"
},
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#reachReportCompatibleFields."
},
"dimensionFilters": {
"description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
"type": "array",
"items": {
"$ref": "Dimension"
}
},
"reachByFrequencyMetrics": {
"items": {
"$ref": "Metric"
},
"description": "Metrics which are compatible to be selected in the \"reachByFrequencyMetricNames\" section of the report.",
"type": "array"
},
"pivotedActivityMetrics": {
"items": {
"$ref": "Metric"
},
"type": "array",
"description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report."
}
},
"type": "object",
"description": "Represents fields that are compatible to be selected for a report of type \"REACH\"."
},
"CustomEventError": {
"description": "The error code and description for a custom event that failed to insert.",
"id": "CustomEventError",
"properties": {
"code": {
"enum": [
"UNKNOWN",
"INVALID_ARGUMENT",
"INTERNAL",
"PERMISSION_DENIED",
"NOT_FOUND"
],
"type": "string",
"enumDescriptions": [
"",
"",
"",
"",
""
],
"description": "The error code."
},
"message": {
"type": "string",
"description": "A description of the error."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventError\".",
"type": "string"
}
},
"type": "object"
},
"ConnectionType": {
"id": "ConnectionType",
"properties": {
"id": {
"description": "ID of this connection type.",
"type": "string",
"format": "int64"
},
"name": {
"description": "Name of this connection type.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionType\"."
}
},
"type": "object",
"description": "Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users."
},
"CreativeField": {
"type": "object",
"id": "CreativeField",
"properties": {
"advertiserIdDimensionValue": {
"description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"name": {
"description": "Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.",
"type": "string"
},
"accountId": {
"description": "Account ID of this creative field. This is a read-only field that can be left blank.",
"format": "int64",
"type": "string"
},
"subaccountId": {
"description": "Subaccount ID of this creative field. This is a read-only field that can be left blank.",
"type": "string",
"format": "int64"
},
"advertiserId": {
"type": "string",
"format": "int64",
"description": "Advertiser ID of this creative field. This is a required field on insertion."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeField\".",
"type": "string"
},
"id": {
"description": "ID of this creative field. This is a read-only, auto-generated field.",
"type": "string",
"format": "int64"
}
},
"description": "Contains properties of a creative field."
},
"TargetableRemarketingList": {
"properties": {
"subaccountId": {
"type": "string",
"format": "int64",
"description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests."
},
"listSize": {
"description": "Number of users currently in the list. This is a read-only field.",
"format": "int64",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingList\"."
},
"name": {
"description": "Name of the targetable remarketing list. Is no greater than 128 characters long.",
"type": "string"
},
"active": {
"description": "Whether this targetable remarketing list is active.",
"type": "boolean"
},
"accountId": {
"type": "string",
"format": "int64",
"description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests."
},
"id": {
"format": "int64",
"description": "Targetable remarketing list ID.",
"type": "string"
},
"listSource": {
"enum": [
"REMARKETING_LIST_SOURCE_OTHER",
"REMARKETING_LIST_SOURCE_ADX",
"REMARKETING_LIST_SOURCE_DFP",
"REMARKETING_LIST_SOURCE_XFP",
"REMARKETING_LIST_SOURCE_DFA",
"REMARKETING_LIST_SOURCE_GA",
"REMARKETING_LIST_SOURCE_YOUTUBE",
"REMARKETING_LIST_SOURCE_DBM",
"REMARKETING_LIST_SOURCE_GPLUS",
"REMARKETING_LIST_SOURCE_DMP",
"REMARKETING_LIST_SOURCE_PLAY_STORE"
],
"description": "Product from which this targetable remarketing list was originated.",
"type": "string",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"description": {
"type": "string",
"description": "Targetable remarketing list description."
},
"advertiserIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the advertiser."
},
"lifeSpan": {
"description": "Number of days that a user should remain in the targetable remarketing list without an impression.",
"type": "string",
"format": "int64"
},
"advertiserId": {
"description": "Dimension value for the advertiser ID that owns this targetable remarketing list.",
"type": "string",
"format": "int64"
}
},
"id": "TargetableRemarketingList",
"description": "Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.",
"type": "object"
},
"Rule": {
"properties": {
"assetId": {
"format": "int64",
"type": "string",
"description": "A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field."
},
"targetingTemplateId": {
"format": "int64",
"description": "A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.",
"type": "string"
},
"name": {
"description": "A user-friendly name for this rule. This is a required field.",
"type": "string"
}
},
"type": "object",
"description": "A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.",
"id": "Rule"
},
"Pricing": {
"id": "Pricing",
"description": "Pricing Information",
"type": "object",
"properties": {
"groupType": {
"enumDescriptions": [
"",
""
],
"enum": [
"PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE",
"PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK"
],
"description": "Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.",
"type": "string"
},
"flights": {
"type": "array",
"description": "Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.",
"items": {
"$ref": "Flight"
}
},
"pricingType": {
"description": "Pricing type of this inventory item.",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string",
"enum": [
"PLANNING_PLACEMENT_PRICING_TYPE_IMPRESSIONS",
"PLANNING_PLACEMENT_PRICING_TYPE_CPM",
"PLANNING_PLACEMENT_PRICING_TYPE_CLICKS",
"PLANNING_PLACEMENT_PRICING_TYPE_CPC",
"PLANNING_PLACEMENT_PRICING_TYPE_CPA",
"PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
"PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_CLICKS",
"PLANNING_PLACEMENT_PRICING_TYPE_CPM_ACTIVEVIEW"
]
},
"capCostType": {
"type": "string",
"enum": [
"PLANNING_PLACEMENT_CAP_COST_TYPE_NONE",
"PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY",
"PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE"
],
"description": "Cap cost type of this inventory item.",
"enumDescriptions": [
"",
"",
""
]
},
"endDate": {
"format": "date",
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
}
}
},
"FloodlightActivityGroup": {
"description": "Contains properties of a Floodlight activity group.",
"properties": {
"idDimensionValue": {
"description": "Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"name": {
"description": "Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroup\".",
"type": "string"
},
"advertiserIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
},
"tagString": {
"description": "Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.",
"type": "string"
},
"id": {
"format": "int64",
"type": "string",
"description": "ID of this floodlight activity group. This is a read-only, auto-generated field."
},
"accountId": {
"format": "int64",
"description": "Account ID of this floodlight activity group. This is a read-only field that can be left blank.",
"type": "string"
},
"advertiserId": {
"description": "Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.",
"format": "int64",
"type": "string"
},
"floodlightConfigurationId": {
"type": "string",
"format": "int64",
"description": "Floodlight configuration ID of this floodlight activity group. This is a required field."
},
"floodlightConfigurationIdDimensionValue": {
"description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"type": {
"type": "string",
"enumDescriptions": [
"",
""
],
"enum": [
"COUNTER",
"SALE"
],
"description": "Type of the floodlight activity group. This is a required field that is read-only after insertion."
},
"subaccountId": {
"description": "Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.",
"type": "string",
"format": "int64"
}
},
"id": "FloodlightActivityGroup",
"type": "object"
},
"Creative": {
"id": "Creative",
"description": "Contains properties of a Creative.",
"type": "object",
"properties": {
"exitCustomEvents": {
"description": "List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"type": "array",
"items": {
"$ref": "CreativeCustomEvent"
}
},
"creativeAssets": {
"type": "array",
"items": {
"$ref": "CreativeAsset"
},
"description": "Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT"
},
"companionCreatives": {
"type": "array",
"description": "List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.",
"items": {
"type": "string",
"format": "int64"
}
},
"skipOffset": {
"description": "Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO.",
"$ref": "VideoOffset"
},
"overrideCss": {
"type": "string",
"description": "Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA."
},
"renderingId": {
"format": "int64",
"type": "string",
"description": "ID of current rendering version. This is a read-only field. Applicable to all creative types."
},
"adParameters": {
"description": "Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.",
"type": "string"
},
"backupImageClickThroughUrl": {
"description": "Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.",
"$ref": "CreativeClickThroughUrl"
},
"id": {
"description": "ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.",
"type": "string",
"format": "int64"
},
"type": {
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"enum": [
"IMAGE",
"DISPLAY_REDIRECT",
"CUSTOM_DISPLAY",
"INTERNAL_REDIRECT",
"CUSTOM_DISPLAY_INTERSTITIAL",
"INTERSTITIAL_INTERNAL_REDIRECT",
"TRACKING_TEXT",
"RICH_MEDIA_DISPLAY_BANNER",
"RICH_MEDIA_INPAGE_FLOATING",
"RICH_MEDIA_IM_EXPAND",
"RICH_MEDIA_DISPLAY_EXPANDING",
"RICH_MEDIA_DISPLAY_INTERSTITIAL",
"RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL",
"RICH_MEDIA_MOBILE_IN_APP",
"FLASH_INPAGE",
"INSTREAM_VIDEO",
"VPAID_LINEAR_VIDEO",
"VPAID_NON_LINEAR_VIDEO",
"INSTREAM_VIDEO_REDIRECT",
"RICH_MEDIA_PEEL_DOWN",
"HTML5_BANNER",
"DISPLAY",
"DISPLAY_IMAGE_GALLERY",
"BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
"INSTREAM_AUDIO"
],
"type": "string",
"description": "Type of this creative. This is a required field. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types."
},
"commercialId": {
"type": "string",
"description": "Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives."
},
"size": {
"description": "Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.",
"$ref": "Size"
},
"mediaDuration": {
"type": "number",
"description": "Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.",
"format": "float"
},
"sslCompliant": {
"type": "boolean",
"description": "Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types."
},
"autoAdvanceImages": {
"description": "Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.",
"type": "boolean"
},
"subaccountId": {
"format": "int64",
"description": "Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
"type": "string"
},
"advertiserId": {
"type": "string",
"format": "int64",
"description": "Advertiser ID of this creative. This is a required field. Applicable to all creative types."
},
"convertFlashToHtml5": {
"description": "Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"type": "boolean"
},
"progressOffset": {
"description": "Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO.",
"$ref": "VideoOffset"
},
"requiredFlashPluginVersion": {
"description": "The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
"type": "string"
},
"artworkType": {
"type": "string",
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"ARTWORK_TYPE_FLASH",
"ARTWORK_TYPE_HTML5",
"ARTWORK_TYPE_MIXED",
"ARTWORK_TYPE_IMAGE"
],
"description": "Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID."
},
"requiredFlashVersion": {
"format": "int32",
"description": "The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"type": "integer"
},
"compatibility": {
"items": {
"type": "string",
"enum": [
"DISPLAY",
"DISPLAY_INTERSTITIAL",
"APP",
"APP_INTERSTITIAL",
"IN_STREAM_VIDEO",
"IN_STREAM_AUDIO"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
]
},
"type": "array",
"description": "Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - \"APP\" - \"APP_INTERSTITIAL\" - \"IN_STREAM_VIDEO\" - \"IN_STREAM_AUDIO\" - \"DISPLAY\" - \"DISPLAY_INTERSTITIAL\" "
},
"accountId": {
"type": "string",
"description": "Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
"format": "int64"
},
"sslOverride": {
"description": "Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.",
"type": "boolean"
},
"skippable": {
"type": "boolean",
"description": "Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creative\"."
},
"thirdPartyRichMediaImpressionsUrl": {
"type": "string",
"description": "Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA."
},
"active": {
"type": "boolean",
"description": "Whether the creative is active. Applicable to all creative types."
},
"backupImageTargetWindow": {
"description": "Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"$ref": "TargetWindow"
},
"creativeAssetSelection": {
"$ref": "CreativeAssetSelection",
"description": "Required if dynamicAssetSelection is true."
},
"backgroundColor": {
"description": "The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.",
"type": "string"
},
"authoringSource": {
"description": "Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.",
"enum": [
"CREATIVE_AUTHORING_SOURCE_DCM",
"CREATIVE_AUTHORING_SOURCE_DBM",
"CREATIVE_AUTHORING_SOURCE_STUDIO",
"CREATIVE_AUTHORING_SOURCE_GWD"
],
"type": "string",
"enumDescriptions": [
"",
"",
"",
""
]
},
"timerCustomEvents": {
"description": "List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.",
"items": {
"$ref": "CreativeCustomEvent"
},
"type": "array"
},
"archived": {
"description": "Whether the creative is archived. Applicable to all creative types.",
"type": "boolean"
},
"redirectUrl": {
"type": "string",
"description": "URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT"
},
"thirdPartyBackupImageImpressionsUrl": {
"description": "Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.",
"type": "string"
},
"studioTraffickedCreativeId": {
"format": "int64",
"type": "string",
"description": "Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID."
},
"counterCustomEvents": {
"items": {
"$ref": "CreativeCustomEvent"
},
"description": "List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.",
"type": "array"
},
"allowScriptAccess": {
"description": "Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.",
"type": "boolean"
},
"adTagKeys": {
"description": "Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
"type": "array",
"items": {
"type": "string"
}
},
"idDimensionValue": {
"description": "Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.",
"$ref": "DimensionValue"
},
"studioCreativeId": {
"format": "int64",
"type": "string",
"description": "Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID."
},
"obaIcon": {
"$ref": "ObaIcon",
"description": "Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all INSTREAM_VIDEO."
},
"fsCommand": {
"$ref": "FsCommand",
"description": "OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE."
},
"name": {
"type": "string",
"description": "Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types."
},
"lastModifiedInfo": {
"description": "Creative last modification information. This is a read-only field. Applicable to all creative types.",
"$ref": "LastModifiedInfo"
},
"dynamicAssetSelection": {
"type": "boolean",
"description": "Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives."
},
"customKeyValues": {
"items": {
"type": "string"
},
"description": "Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
"type": "array"
},
"latestTraffickedCreativeId": {
"description": "Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
"type": "string",
"format": "int64"
},
"studioAdvertiserId": {
"type": "string",
"description": "Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
"format": "int64"
},
"backupImageFeatures": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CSS_FONT_FACE",
"CSS_BACKGROUND_SIZE",
"CSS_BORDER_IMAGE",
"CSS_BORDER_RADIUS",
"CSS_BOX_SHADOW",
"CSS_FLEX_BOX",
"CSS_HSLA",
"CSS_MULTIPLE_BGS",
"CSS_OPACITY",
"CSS_RGBA",
"CSS_TEXT_SHADOW",
"CSS_ANIMATIONS",
"CSS_COLUMNS",
"CSS_GENERATED_CONTENT",
"CSS_GRADIENTS",
"CSS_REFLECTIONS",
"CSS_TRANSFORMS",
"CSS_TRANSFORMS3D",
"CSS_TRANSITIONS",
"APPLICATION_CACHE",
"CANVAS",
"CANVAS_TEXT",
"DRAG_AND_DROP",
"HASH_CHANGE",
"HISTORY",
"AUDIO",
"VIDEO",
"INDEXED_DB",
"INPUT_ATTR_AUTOCOMPLETE",
"INPUT_ATTR_AUTOFOCUS",
"INPUT_ATTR_LIST",
"INPUT_ATTR_PLACEHOLDER",
"INPUT_ATTR_MAX",
"INPUT_ATTR_MIN",
"INPUT_ATTR_MULTIPLE",
"INPUT_ATTR_PATTERN",
"INPUT_ATTR_REQUIRED",
"INPUT_ATTR_STEP",
"INPUT_TYPE_SEARCH",
"INPUT_TYPE_TEL",
"INPUT_TYPE_URL",
"INPUT_TYPE_EMAIL",
"INPUT_TYPE_DATETIME",
"INPUT_TYPE_DATE",
"INPUT_TYPE_MONTH",
"INPUT_TYPE_WEEK",
"INPUT_TYPE_TIME",
"INPUT_TYPE_DATETIME_LOCAL",
"INPUT_TYPE_NUMBER",
"INPUT_TYPE_RANGE",
"INPUT_TYPE_COLOR",
"LOCAL_STORAGE",
"POST_MESSAGE",
"SESSION_STORAGE",
"WEB_SOCKETS",
"WEB_SQL_DATABASE",
"WEB_WORKERS",
"GEO_LOCATION",
"INLINE_SVG",
"SMIL",
"SVG_HREF",
"SVG_CLIP_PATHS",
"TOUCH",
"WEBGL",
"SVG_FILTERS",
"SVG_FE_IMAGE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE."
},
"mediaDescription": {
"description": "Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.",
"type": "string"
},
"additionalSizes": {
"items": {
"$ref": "Size"
},
"description": "Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.",
"type": "array"
},
"totalFileSize": {
"format": "int64",
"type": "string",
"description": "Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID."
},
"thirdPartyUrls": {
"description": "Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.",
"items": {
"$ref": "ThirdPartyTrackingUrl"
},
"type": "array"
},
"htmlCodeLocked": {
"description": "Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.",
"type": "boolean"
},
"renderingIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types."
},
"version": {
"format": "int32",
"type": "integer",
"description": "The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types."
},
"universalAdId": {
"$ref": "UniversalAdId",
"description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID."
},
"htmlCode": {
"type": "string",
"description": "HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA."
},
"backupImageReportingLabel": {
"description": "Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.",
"type": "string"
},
"authoringTool": {
"enum": [
"NINJA",
"SWIFFY"
],
"enumDescriptions": [
"",
""
],
"description": "Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
"type": "string"
},
"clickTags": {
"type": "array",
"description": "Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"items": {
"$ref": "ClickTag"
}
},
"creativeFieldAssignments": {
"type": "array",
"items": {
"$ref": "CreativeFieldAssignment"
},
"description": "Creative field assignments for this creative. Applicable to all creative types."
}
}
},
"PlatformTypesListResponse": {
"id": "PlatformTypesListResponse",
"description": "Platform Type List Response",
"properties": {
"platformTypes": {
"items": {
"$ref": "PlatformType"
},
"type": "array",
"description": "Platform type collection."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformTypesListResponse\".",
"type": "string"
}
},
"type": "object"
},
"DynamicTargetingKeysListResponse": {
"description": "Dynamic Targeting Key List Response",
"id": "DynamicTargetingKeysListResponse",
"properties": {
"dynamicTargetingKeys": {
"type": "array",
"description": "Dynamic targeting key collection.",
"items": {
"$ref": "DynamicTargetingKey"
}
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKeysListResponse\"."
}
},
"type": "object"
},
"AccountActiveAdSummary": {
"id": "AccountActiveAdSummary",
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountActiveAdSummary\".",
"type": "string"
},
"activeAdsLimitTier": {
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
""
],
"enum": [
"ACTIVE_ADS_TIER_40K",
"ACTIVE_ADS_TIER_75K",
"ACTIVE_ADS_TIER_100K",
"ACTIVE_ADS_TIER_200K",
"ACTIVE_ADS_TIER_300K",
"ACTIVE_ADS_TIER_500K",
"ACTIVE_ADS_TIER_750K",
"ACTIVE_ADS_TIER_1M"
],
"type": "string",
"description": "Maximum number of active ads allowed for the account."
},
"activeAds": {
"description": "Ads that have been activated for the account",
"type": "string",
"format": "int64"
},
"accountId": {
"description": "ID of the account.",
"format": "int64",
"type": "string"
},
"availableAds": {
"type": "string",
"format": "int64",
"description": "Ads that can be activated for the account."
}
},
"description": "Gets a summary of active ads in an account."
},
"ConversionsBatchUpdateRequest": {
"id": "ConversionsBatchUpdateRequest",
"description": "Update Conversions Request.",
"type": "object",
"properties": {
"conversions": {
"type": "array",
"items": {
"$ref": "Conversion"
},
"description": "The set of conversions to update."
},
"encryptionInfo": {
"description": "Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used.",
"$ref": "EncryptionInfo"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchUpdateRequest\".",
"type": "string"
}
}
},
"Placement": {
"description": "Contains properties of a placement.",
"id": "Placement",
"properties": {
"adBlockingOptOut": {
"type": "boolean",
"description": "Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect."
},
"placementGroupId": {
"format": "int64",
"type": "string",
"description": "ID of this placement's group, if applicable."
},
"sslRequired": {
"type": "boolean",
"description": "Whether creatives assigned to this placement must be SSL-compliant."
},
"contentCategoryId": {
"description": "ID of the content category assigned to this placement.",
"type": "string",
"format": "int64"
},
"primary": {
"description": "Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.",
"type": "boolean"
},
"advertiserId": {
"description": "Advertiser ID of this placement. This field can be left blank.",
"format": "int64",
"type": "string"
},
"accountId": {
"type": "string",
"description": "Account ID of this placement. This field can be left blank.",
"format": "int64"
},
"campaignIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
},
"subaccountId": {
"type": "string",
"description": "Subaccount ID of this placement. This field can be left blank.",
"format": "int64"
},
"tagFormats": {
"description": "Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - \"PLACEMENT_TAG_STANDARD\" - \"PLACEMENT_TAG_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_IFRAME_ILAYER\" - \"PLACEMENT_TAG_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_JAVASCRIPT\" - \"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT\" - \"PLACEMENT_TAG_CLICK_COMMANDS\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3\" - \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4\" - \"PLACEMENT_TAG_TRACKING\" - \"PLACEMENT_TAG_TRACKING_IFRAME\" - \"PLACEMENT_TAG_TRACKING_JAVASCRIPT\" ",
"items": {
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"enum": [
"PLACEMENT_TAG_STANDARD",
"PLACEMENT_TAG_IFRAME_JAVASCRIPT",
"PLACEMENT_TAG_IFRAME_ILAYER",
"PLACEMENT_TAG_INTERNAL_REDIRECT",
"PLACEMENT_TAG_JAVASCRIPT",
"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
"PLACEMENT_TAG_CLICK_COMMANDS",
"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
"PLACEMENT_TAG_TRACKING",
"PLACEMENT_TAG_TRACKING_IFRAME",
"PLACEMENT_TAG_TRACKING_JAVASCRIPT",
"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
"PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
"PLACEMENT_TAG_JAVASCRIPT_LEGACY",
"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
],
"type": "string"
},
"type": "array"
},
"publisherUpdateInfo": {
"$ref": "LastModifiedInfo",
"description": "Information about the last publisher update. This is a read-only field."
},
"placementStrategyId": {
"type": "string",
"description": "ID of the placement strategy assigned to this placement.",
"format": "int64"
},
"directorySiteId": {
"type": "string",
"format": "int64",
"description": "Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion."
},
"keyName": {
"type": "string",
"description": "Key name of this placement. This is a read-only, auto-generated field."
},
"directorySiteIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
},
"name": {
"type": "string",
"description": "Name of this placement.This is a required field and must be less than or equal to 256 characters long."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placement\"."
},
"siteIdDimensionValue": {
"description": "Dimension value for the ID of the site. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"lastModifiedInfo": {
"$ref": "LastModifiedInfo",
"description": "Information about the most recent modification of this placement. This is a read-only field."
},
"videoSettings": {
"description": "A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.",
"$ref": "VideoSettings"
},
"advertiserIdDimensionValue": {
"description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"size": {
"description": "Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.",
"$ref": "Size"
},
"createInfo": {
"description": "Information about the creation of this placement. This is a read-only field.",
"$ref": "LastModifiedInfo"
},
"videoActiveViewOptOut": {
"description": "Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.",
"type": "boolean"
},
"pricingSchedule": {
"$ref": "PricingSchedule",
"description": "Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType."
},
"id": {
"description": "ID of this placement. This is a read-only, auto-generated field.",
"type": "string",
"format": "int64"
},
"campaignId": {
"type": "string",
"format": "int64",
"description": "Campaign ID of this placement. This field is a required field on insertion."
},
"status": {
"type": "string",
"enum": [
"PENDING_REVIEW",
"PAYMENT_ACCEPTED",
"PAYMENT_REJECTED",
"ACKNOWLEDGE_REJECTION",
"ACKNOWLEDGE_ACCEPTANCE",
"DRAFT"
],
"description": "Third-party placement status.",
"enumDescriptions": [
"",
"",
"",
"",
"",
""
]
},
"siteId": {
"format": "int64",
"type": "string",
"description": "Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion."
},
"comment": {
"type": "string",
"description": "Comments for this placement."
},
"vpaidAdapterChoice": {
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string",
"enum": [
"DEFAULT",
"FLASH",
"HTML5",
"BOTH"
],
"description": "VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH."
},
"idDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of this placement. This is a read-only, auto-generated field."
},
"lookbackConfiguration": {
"$ref": "LookbackConfiguration",
"description": "Lookback window settings for this placement."
},
"tagSetting": {
"description": "Tag settings for this placement.",
"$ref": "TagSetting"
},
"archived": {
"description": "Whether this placement is archived.",
"type": "boolean"
},
"paymentApproved": {
"description": "Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.",
"type": "boolean"
},
"paymentSource": {
"enum": [
"PLACEMENT_AGENCY_PAID",
"PLACEMENT_PUBLISHER_PAID"
],
"type": "string",
"enumDescriptions": [
"",
""
],
"description": "Payment source for this placement. This is a required field that is read-only after insertion."
},
"externalId": {
"type": "string",
"description": "External ID for this placement."
},
"placementGroupIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the placement group. This is a read-only, auto-generated field."
},
"compatibility": {
"type": "string",
"description": "Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.",
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"enum": [
"DISPLAY",
"DISPLAY_INTERSTITIAL",
"APP",
"APP_INTERSTITIAL",
"IN_STREAM_VIDEO",
"IN_STREAM_AUDIO"
]
},
"additionalSizes": {
"items": {
"$ref": "Size"
},
"description": "Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.",
"type": "array"
}
},
"type": "object"
},
"PricingSchedule": {
"properties": {
"testingStartDate": {
"format": "date",
"type": "string"
},
"flighted": {
"type": "boolean",
"description": "Whether this placement is flighted. If true, pricing periods will be computed automatically."
},
"pricingPeriods": {
"description": "Pricing periods for this placement.",
"type": "array",
"items": {
"$ref": "PricingSchedulePricingPeriod"
}
},
"capCostOption": {
"enum": [
"CAP_COST_NONE",
"CAP_COST_MONTHLY",
"CAP_COST_CUMULATIVE"
],
"type": "string",
"description": "Placement cap cost option.",
"enumDescriptions": [
"",
"",
""
]
},
"endDate": {
"type": "string",
"format": "date"
},
"floodlightActivityId": {
"type": "string",
"description": "Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.",
"format": "int64"
},
"startDate": {
"type": "string",
"format": "date"
},
"pricingType": {
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"type": "string",
"description": "Placement pricing type. This field is required on insertion.",
"enum": [
"PRICING_TYPE_CPM",
"PRICING_TYPE_CPC",
"PRICING_TYPE_CPA",
"PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
"PRICING_TYPE_FLAT_RATE_CLICKS",
"PRICING_TYPE_CPM_ACTIVEVIEW"
]
}
},
"id": "PricingSchedule",
"description": "Pricing Schedule",
"type": "object"
},
"CitiesListResponse": {
"type": "object",
"description": "City List Response",
"properties": {
"cities": {
"type": "array",
"items": {
"$ref": "City"
},
"description": "City collection."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#citiesListResponse\".",
"type": "string"
}
},
"id": "CitiesListResponse"
},
"SiteCompanionSetting": {
"id": "SiteCompanionSetting",
"properties": {
"companionsDisabled": {
"description": "Whether companions are disabled for this site template.",
"type": "boolean"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#siteCompanionSetting\".",
"type": "string"
},
"imageOnly": {
"type": "boolean",
"description": "Whether to serve only static images as companions."
},
"enabledSizes": {
"items": {
"$ref": "Size"
},
"description": "Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.",
"type": "array"
}
},
"type": "object",
"description": "Companion Settings"
},
"CreativeFieldValuesListResponse": {
"id": "CreativeFieldValuesListResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValuesListResponse\"."
},
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
},
"creativeFieldValues": {
"items": {
"$ref": "CreativeFieldValue"
},
"type": "array",
"description": "Creative field value collection."
}
},
"type": "object",
"description": "Creative Field Value List Response"
},
"LandingPage": {
"properties": {
"url": {
"description": "URL of this landing page. This is a required field.",
"type": "string"
},
"deepLinks": {
"type": "array",
"description": "Links that will direct the user to a mobile app, if installed.",
"items": {
"$ref": "DeepLink"
}
},
"id": {
"description": "ID of this landing page. This is a read-only, auto-generated field.",
"type": "string",
"format": "int64"
},
"name": {
"description": "Name of this landing page. This is a required field. It must be less than 256 characters long.",
"type": "string"
},
"archived": {
"type": "boolean",
"description": "Whether this landing page has been archived."
},
"advertiserId": {
"format": "int64",
"type": "string",
"description": "Advertiser ID of this landing page. This is a required field."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPage\".",
"type": "string"
}
},
"description": "Contains information about where a user's browser is taken after the user clicks an ad.",
"id": "LandingPage",
"type": "object"
},
"CreativesListResponse": {
"description": "Creative List Response",
"type": "object",
"id": "CreativesListResponse",
"properties": {
"creatives": {
"type": "array",
"description": "Creative collection.",
"items": {
"$ref": "Creative"
}
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativesListResponse\".",
"type": "string"
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to be used for the next list operation."
}
}
},
"VideoOffset": {
"type": "object",
"id": "VideoOffset",
"properties": {
"offsetPercentage": {
"format": "int32",
"description": "Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.",
"type": "integer"
},
"offsetSeconds": {
"format": "int32",
"type": "integer",
"description": "Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive."
}
},
"description": "Video Offset"
},
"SkippableSetting": {
"type": "object",
"properties": {
"skipOffset": {
"$ref": "VideoOffset",
"description": "Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#skippableSetting\".",
"type": "string"
},
"skippable": {
"type": "boolean",
"description": "Whether the user can skip creatives served to this placement."
},
"progressOffset": {
"description": "Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.",
"$ref": "VideoOffset"
}
},
"description": "Skippable Settings",
"id": "SkippableSetting"
},
"ListTargetingExpression": {
"type": "object",
"properties": {
"expression": {
"type": "string",
"description": "Expression describing which lists are being targeted by the ad."
}
},
"id": "ListTargetingExpression",
"description": "Remarketing List Targeting Expression."
},
"VideoFormatsListResponse": {
"id": "VideoFormatsListResponse",
"type": "object",
"properties": {
"videoFormats": {
"items": {
"$ref": "VideoFormat"
},
"type": "array",
"description": "Video format collection."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoFormatsListResponse\"."
}
},
"description": "Video Format List Response"
},
"SizesListResponse": {
"id": "SizesListResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sizesListResponse\".",
"type": "string"
},
"sizes": {
"items": {
"$ref": "Size"
},
"type": "array",
"description": "Size collection."
}
},
"description": "Size List Response",
"type": "object"
},
"PopupWindowProperties": {
"description": "Popup Window Properties.",
"type": "object",
"properties": {
"showToolBar": {
"type": "boolean",
"description": "Whether to display the browser tool bar."
},
"showStatusBar": {
"description": "Whether to display the browser status bar.",
"type": "boolean"
},
"positionType": {
"enum": [
"CENTER",
"COORDINATES"
],
"description": "Popup window position either centered or at specific coordinate.",
"enumDescriptions": [
"",
""
],
"type": "string"
},
"showScrollBar": {
"description": "Whether to display the browser scroll bar.",
"type": "boolean"
},
"dimension": {
"description": "Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID",
"$ref": "Size"
},
"showAddressBar": {
"type": "boolean",
"description": "Whether to display the browser address bar."
},
"title": {
"type": "string",
"description": "Title of popup window."
},
"offset": {
"$ref": "OffsetPosition",
"description": "Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES."
},
"showMenuBar": {
"type": "boolean",
"description": "Whether to display the browser menu bar."
}
},
"id": "PopupWindowProperties"
},
"CustomVariable": {
"id": "CustomVariable",
"properties": {
"index": {
"type": "string",
"format": "int64",
"description": "The index of the custom variable."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customVariable\".",
"type": "string"
},
"value": {
"description": "The value of the custom variable. The length of string must not exceed 50 characters.",
"type": "string"
}
},
"type": "object",
"description": "Custom variable."
},
"ConnectionTypesListResponse": {
"id": "ConnectionTypesListResponse",
"type": "object",
"description": "Connection Type List Response",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionTypesListResponse\"."
},
"connectionTypes": {
"description": "Collection of connection types such as broadband and mobile.",
"type": "array",
"items": {
"$ref": "ConnectionType"
}
}
}
},
"RegionsListResponse": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#regionsListResponse\"."
},
"regions": {
"items": {
"$ref": "Region"
},
"description": "Region collection.",
"type": "array"
}
},
"type": "object",
"description": "Region List Response",
"id": "RegionsListResponse"
},
"Flight": {
"type": "object",
"description": "Flight",
"properties": {
"startDate": {
"format": "date",
"type": "string"
},
"units": {
"description": "Units of this flight.",
"type": "string",
"format": "int64"
},
"endDate": {
"type": "string",
"format": "date"
},
"rateOrCost": {
"type": "string",
"description": "Rate or cost of this flight.",
"format": "int64"
}
},
"id": "Flight"
},
"FsCommand": {
"id": "FsCommand",
"properties": {
"windowWidth": {
"type": "integer",
"description": "Width of the window.",
"format": "int32"
},
"top": {
"format": "int32",
"description": "Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
"type": "integer"
},
"windowHeight": {
"description": "Height of the window.",
"format": "int32",
"type": "integer"
},
"positionOption": {
"enum": [
"CENTERED",
"DISTANCE_FROM_TOP_LEFT_CORNER"
],
"enumDescriptions": [
"",
""
],
"type": "string",
"description": "Position in the browser where the window will open."
},
"left": {
"description": "Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
"format": "int32",
"type": "integer"
}
},
"description": "FsCommand.",
"type": "object"
},
"CreativeGroupsListResponse": {
"properties": {
"creativeGroups": {
"type": "array",
"items": {
"$ref": "CreativeGroup"
},
"description": "Creative group collection."
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to be used for the next list operation."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroupsListResponse\".",
"type": "string"
}
},
"type": "object",
"description": "Creative Group List Response",
"id": "CreativeGroupsListResponse"
},
"UserRolePermission": {
"type": "object",
"id": "UserRolePermission",
"description": "Contains properties of a user role permission.",
"properties": {
"permissionGroupId": {
"format": "int64",
"description": "ID of the permission group that this user role permission belongs to.",
"type": "string"
},
"availability": {
"type": "string",
"description": "Levels of availability for a user role permission.",
"enumDescriptions": [
"",
"",
"",
"",
""
],
"enum": [
"NOT_AVAILABLE_BY_DEFAULT",
"ACCOUNT_BY_DEFAULT",
"SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT",
"ACCOUNT_ALWAYS",
"SUBACCOUNT_AND_ACCOUNT_ALWAYS"
]
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermission\"."
},
"name": {
"description": "Name of this user role permission.",
"type": "string"
},
"id": {
"format": "int64",
"description": "ID of this user role permission.",
"type": "string"
}
}
},
"Campaign": {
"description": "Contains properties of a Campaign Manager campaign.",
"properties": {
"id": {
"description": "ID of this campaign. This is a read-only auto-generated field.",
"type": "string",
"format": "int64"
},
"billingInvoiceCode": {
"type": "string",
"description": "Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign."
},
"advertiserId": {
"description": "Advertiser ID of this campaign. This is a required field.",
"type": "string",
"format": "int64"
},
"additionalCreativeOptimizationConfigurations": {
"items": {
"$ref": "CreativeOptimizationConfiguration"
},
"type": "array",
"description": "Additional creative optimization configurations for the campaign."
},
"advertiserIdDimensionValue": {
"description": "Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"defaultClickThroughEventTagProperties": {
"$ref": "DefaultClickThroughEventTagProperties",
"description": "Click-through event tag ID override properties for this campaign."
},
"createInfo": {
"description": "Information about the creation of this campaign. This is a read-only field.",
"$ref": "LastModifiedInfo"
},
"externalId": {
"type": "string",
"description": "External ID for this campaign."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaign\".",
"type": "string"
},
"clickThroughUrlSuffixProperties": {
"description": "Click-through URL suffix override properties for this campaign.",
"$ref": "ClickThroughUrlSuffixProperties"
},
"name": {
"type": "string",
"description": "Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser."
},
"startDate": {
"format": "date",
"type": "string"
},
"eventTagOverrides": {
"description": "Overrides that can be used to activate or deactivate advertiser event tags.",
"items": {
"$ref": "EventTagOverride"
},
"type": "array"
},
"lastModifiedInfo": {
"description": "Information about the most recent modification of this campaign. This is a read-only field.",
"$ref": "LastModifiedInfo"
},
"endDate": {
"type": "string",
"format": "date"
},
"nielsenOcrEnabled": {
"description": "Whether Nielsen reports are enabled for this campaign.",
"type": "boolean"
},
"advertiserGroupId": {
"format": "int64",
"type": "string",
"description": "Advertiser group ID of the associated advertiser."
},
"traffickerEmails": {
"description": "Campaign trafficker contact emails.",
"items": {
"type": "string"
},
"type": "array"
},
"adBlockingConfiguration": {
"$ref": "AdBlockingConfiguration",
"description": "Ad blocking settings for this campaign."
},
"accountId": {
"description": "Account ID of this campaign. This is a read-only field that can be left blank.",
"type": "string",
"format": "int64"
},
"defaultLandingPageId": {
"type": "string",
"description": "The default landing page ID for this campaign.",
"format": "int64"
},
"comment": {
"type": "string",
"description": "Arbitrary comments about this campaign. Must be less than 256 characters long."
},
"archived": {
"type": "boolean",
"description": "Whether this campaign has been archived."
},
"idDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of this campaign. This is a read-only, auto-generated field."
},
"creativeGroupIds": {
"type": "array",
"items": {
"format": "int64",
"type": "string"
},
"description": "List of creative group IDs that are assigned to the campaign."
},
"audienceSegmentGroups": {
"description": "Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.",
"items": {
"$ref": "AudienceSegmentGroup"
},
"type": "array"
},
"creativeOptimizationConfiguration": {
"description": "Creative optimization configuration for the campaign.",
"$ref": "CreativeOptimizationConfiguration"
},
"subaccountId": {
"description": "Subaccount ID of this campaign. This is a read-only field that can be left blank.",
"type": "string",
"format": "int64"
}
},
"id": "Campaign",
"type": "object"
},
"ListPopulationTerm": {
"type": "object",
"id": "ListPopulationTerm",
"properties": {
"variableFriendlyName": {
"description": "Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.",
"type": "string"
},
"contains": {
"description": "Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.",
"type": "boolean"
},
"type": {
"enum": [
"CUSTOM_VARIABLE_TERM",
"LIST_MEMBERSHIP_TERM",
"REFERRER_TERM"
],
"description": "List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.",
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"variableName": {
"type": "string",
"description": "Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM."
},
"value": {
"description": "Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
"type": "string"
},
"remarketingListId": {
"description": "ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.",
"type": "string",
"format": "int64"
},
"operator": {
"type": "string",
"description": "Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
"enum": [
"NUM_EQUALS",
"NUM_LESS_THAN",
"NUM_LESS_THAN_EQUAL",
"NUM_GREATER_THAN",
"NUM_GREATER_THAN_EQUAL",
"STRING_EQUALS",
"STRING_CONTAINS"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
]
},
"negation": {
"type": "boolean",
"description": "Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM."
}
},
"description": "Remarketing List Population Rule Term."
},
"DeliverySchedule": {
"description": "Delivery Schedule.",
"id": "DeliverySchedule",
"properties": {
"priority": {
"description": "Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.",
"type": "string",
"enum": [
"AD_PRIORITY_01",
"AD_PRIORITY_02",
"AD_PRIORITY_03",
"AD_PRIORITY_04",
"AD_PRIORITY_05",
"AD_PRIORITY_06",
"AD_PRIORITY_07",
"AD_PRIORITY_08",
"AD_PRIORITY_09",
"AD_PRIORITY_10",
"AD_PRIORITY_11",
"AD_PRIORITY_12",
"AD_PRIORITY_13",
"AD_PRIORITY_14",
"AD_PRIORITY_15",
"AD_PRIORITY_16"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"frequencyCap": {
"description": "Limit on the number of times an individual user can be served the ad within a specified period of time.",
"$ref": "FrequencyCap"
},
"impressionRatio": {
"format": "int64",
"description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.",
"type": "string"
},
"hardCutoff": {
"type": "boolean",
"description": "Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals."
}
},
"type": "object"
},
"Subaccount": {
"type": "object",
"properties": {
"availablePermissionIds": {
"items": {
"type": "string",
"format": "int64"
},
"description": "IDs of the available user role permissions for this subaccount.",
"type": "array"
},
"id": {
"format": "int64",
"description": "ID of this subaccount. This is a read-only, auto-generated field.",
"type": "string"
},
"name": {
"type": "string",
"description": "Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account."
},
"accountId": {
"description": "ID of the account that contains this subaccount. This is a read-only field that can be left blank.",
"type": "string",
"format": "int64"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccount\".",
"type": "string"
}
},
"id": "Subaccount",
"description": "Contains properties of a Campaign Manager subaccount."
},
"ClickThroughUrlSuffixProperties": {
"description": "Click Through URL Suffix settings.",
"properties": {
"clickThroughUrlSuffix": {
"description": "Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.",
"type": "string"
},
"overrideInheritedSuffix": {
"description": "Whether this entity should override the inherited click-through URL suffix with its own defined value.",
"type": "boolean"
}
},
"type": "object",
"id": "ClickThroughUrlSuffixProperties"
},
"AccountPermissionsListResponse": {
"id": "AccountPermissionsListResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionsListResponse\".",
"type": "string"
},
"accountPermissions": {
"type": "array",
"items": {
"$ref": "AccountPermission"
},
"description": "Account permission collection."
}
},
"description": "Account Permission List Response",
"type": "object"
},
"CreativeGroupAssignment": {
"type": "object",
"id": "CreativeGroupAssignment",
"description": "Creative Group Assignment.",
"properties": {
"creativeGroupNumber": {
"enum": [
"CREATIVE_GROUP_ONE",
"CREATIVE_GROUP_TWO"
],
"enumDescriptions": [
"",
""
],
"type": "string",
"description": "Creative group number of the creative group assignment."
},
"creativeGroupId": {
"description": "ID of the creative group to be assigned.",
"type": "string",
"format": "int64"
}
}
},
"ThirdPartyTrackingUrl": {
"description": "Third-party Tracking URL.",
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL for the specified third-party URL type."
},
"thirdPartyUrlType": {
"description": "Third-party URL type for in-stream video and in-stream audio creatives.",
"type": "string",
"enum": [
"IMPRESSION",
"CLICK_TRACKING",
"VIDEO_START",
"VIDEO_FIRST_QUARTILE",
"VIDEO_MIDPOINT",
"VIDEO_THIRD_QUARTILE",
"VIDEO_COMPLETE",
"VIDEO_MUTE",
"VIDEO_PAUSE",
"VIDEO_REWIND",
"VIDEO_FULLSCREEN",
"VIDEO_STOP",
"VIDEO_CUSTOM",
"SURVEY",
"RICH_MEDIA_IMPRESSION",
"RICH_MEDIA_RM_IMPRESSION",
"RICH_MEDIA_BACKUP_IMPRESSION",
"VIDEO_SKIP",
"VIDEO_PROGRESS"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
}
},
"id": "ThirdPartyTrackingUrl"
},
"TargetingTemplate": {
"properties": {
"languageTargeting": {
"description": "Language targeting criteria.",
"$ref": "LanguageTargeting"
},
"technologyTargeting": {
"description": "Technology platform targeting criteria.",
"$ref": "TechnologyTargeting"
},
"id": {
"type": "string",
"format": "int64",
"description": "ID of this targeting template. This is a read-only, auto-generated field."
},
"listTargetingExpression": {
"description": "Remarketing list targeting criteria.",
"$ref": "ListTargetingExpression"
},
"accountId": {
"description": "Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.",
"type": "string",
"format": "int64"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetingTemplate\".",
"type": "string"
},
"geoTargeting": {
"description": "Geographical targeting criteria.",
"$ref": "GeoTargeting"
},
"advertiserIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
},
"advertiserId": {
"type": "string",
"description": "Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.",
"format": "int64"
},
"name": {
"type": "string",
"description": "Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser."
},
"dayPartTargeting": {
"$ref": "DayPartTargeting",
"description": "Time and day targeting criteria."
},
"subaccountId": {
"type": "string",
"format": "int64",
"description": "Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert."
},
"keyValueTargetingExpression": {
"description": "Key-value targeting criteria.",
"$ref": "KeyValueTargetingExpression"
}
},
"id": "TargetingTemplate",
"type": "object",
"description": "Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads."
},
"PathToConversionReportCompatibleFields": {
"id": "PathToConversionReportCompatibleFields",
"description": "Represents fields that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\".",
"type": "object",
"properties": {
"perInteractionDimensions": {
"type": "array",
"items": {
"$ref": "Dimension"
},
"description": "Per-interaction dimensions which are compatible to be selected in the \"perInteractionDimensions\" section of the report."
},
"metrics": {
"type": "array",
"description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
"items": {
"$ref": "Metric"
}
},
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields."
},
"customFloodlightVariables": {
"type": "array",
"description": "Custom floodlight variables which are compatible to be selected in the \"customFloodlightVariables\" section of the report.",
"items": {
"$ref": "Dimension"
}
},
"conversionDimensions": {
"type": "array",
"description": "Conversion dimensions which are compatible to be selected in the \"conversionDimensions\" section of the report.",
"items": {
"$ref": "Dimension"
}
}
}
},
"InventoryItem": {
"id": "InventoryItem",
"description": "Represents a buy from the Planning inventory store.",
"properties": {
"negotiationChannelId": {
"format": "int64",
"type": "string",
"description": "Negotiation channel ID of this inventory item."
},
"type": {
"type": "string",
"enum": [
"PLANNING_PLACEMENT_TYPE_REGULAR",
"PLANNING_PLACEMENT_TYPE_CREDIT"
],
"description": "Type of inventory item.",
"enumDescriptions": [
"",
""
]
},
"orderId": {
"type": "string",
"format": "int64",
"description": "Order ID of this inventory item."
},
"adSlots": {
"type": "array",
"items": {
"$ref": "AdSlot"
},
"description": "Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group."
},
"accountId": {
"format": "int64",
"description": "Account ID of this inventory item.",
"type": "string"
},
"estimatedConversionRate": {
"format": "int64",
"type": "string",
"description": "Estimated conversion rate of this inventory item."
},
"estimatedClickThroughRate": {
"description": "Estimated click-through rate of this inventory item.",
"format": "int64",
"type": "string"
},
"rfpId": {
"description": "RFP ID of this inventory item.",
"type": "string",
"format": "int64"
},
"inPlan": {
"description": "Whether this inventory item is in plan.",
"type": "boolean"
},
"projectId": {
"type": "string",
"format": "int64",
"description": "Project ID of this inventory item."
},
"contentCategoryId": {
"format": "int64",
"type": "string",
"description": "Content category ID of this inventory item."
},
"subaccountId": {
"type": "string",
"format": "int64",
"description": "Subaccount ID of this inventory item."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItem\".",
"type": "string"
},
"lastModifiedInfo": {
"description": "Information about the most recent modification of this inventory item.",
"$ref": "LastModifiedInfo"
},
"pricing": {
"description": "Pricing of this inventory item.",
"$ref": "Pricing"
},
"siteId": {
"description": "ID of the site this inventory item is associated with.",
"type": "string",
"format": "int64"
},
"id": {
"type": "string",
"format": "int64",
"description": "ID of this inventory item."
},
"placementStrategyId": {
"format": "int64",
"description": "Placement strategy ID of this inventory item.",
"type": "string"
},
"name": {
"type": "string",
"description": "Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots."
},
"advertiserId": {
"format": "int64",
"type": "string",
"description": "Advertiser ID of this inventory item."
}
},
"type": "object"
},
"OperatingSystemVersion": {
"properties": {
"minorVersion": {
"type": "string",
"description": "Minor version (number after the first dot) of this operating system version."
},
"majorVersion": {
"type": "string",
"description": "Major version (leftmost number) of this operating system version."
},
"name": {
"description": "Name of this operating system version.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersion\"."
},
"operatingSystem": {
"$ref": "OperatingSystem",
"description": "Operating system of this operating system version."
},
"id": {
"type": "string",
"description": "ID of this operating system version.",
"format": "int64"
}
},
"id": "OperatingSystemVersion",
"type": "object",
"description": "Contains information about a particular version of an operating system that can be targeted by ads."
},
"Language": {
"properties": {
"name": {
"type": "string",
"description": "Name of this language."
},
"languageCode": {
"description": "Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are \"en\" for English or \"zh_CN\" for Simplified Chinese.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#language\"."
},
"id": {
"description": "Language ID of this language. This is the ID used for targeting and generating reports.",
"format": "int64",
"type": "string"
}
},
"type": "object",
"description": "Contains information about a language that can be targeted by ads.",
"id": "Language"
},
"EventFilter": {
"properties": {
"dimensionFilter": {
"description": "The dimension filter contained within this EventFilter.",
"$ref": "PathReportDimensionValue"
},
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#eventFilter."
}
},
"type": "object",
"id": "EventFilter",
"description": "Represents a DfaReporting event filter."
},
"CustomEventsBatchInsertResponse": {
"id": "CustomEventsBatchInsertResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventsBatchInsertResponse\".",
"type": "string"
},
"hasFailures": {
"type": "boolean",
"description": "Indicates that some or all custom events failed to insert."
},
"status": {
"description": "The insert status of each custom event. Statuses are returned in the same order that conversions are inserted.",
"items": {
"$ref": "CustomEventStatus"
},
"type": "array"
}
},
"type": "object",
"description": "Insert Custom Events Response."
},
"UserProfile": {
"type": "object",
"id": "UserProfile",
"description": "A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profile_id needs to be specified in other API requests. ",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userProfile\"."
},
"userName": {
"description": "The user name.",
"type": "string"
},
"profileId": {
"description": "The unique ID of the user profile.",
"type": "string",
"format": "int64"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"subAccountId": {
"type": "string",
"format": "int64",
"description": "The sub account ID this profile belongs to if applicable."
},
"subAccountName": {
"type": "string",
"description": "The sub account name this profile belongs to if applicable."
},
"accountId": {
"description": "The account ID to which this profile belongs.",
"format": "int64",
"type": "string"
},
"accountName": {
"type": "string",
"description": "The account name this profile belongs to."
}
}
},
"Recipient": {
"description": "Represents a recipient.",
"properties": {
"deliveryType": {
"enum": [
"LINK",
"ATTACHMENT"
],
"enumDescriptions": [
"",
""
],
"type": "string",
"annotations": {
"required": [
"dfareporting.reports.insert",
"dfareporting.reports.update"
]
},
"description": "The delivery type for the recipient."
},
"email": {
"type": "string",
"annotations": {
"required": [
"dfareporting.reports.insert",
"dfareporting.reports.update"
]
},
"description": "The email address of the recipient."
},
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#recipient."
}
},
"type": "object",
"id": "Recipient"
},
"CustomRichMediaEvents": {
"type": "object",
"id": "CustomRichMediaEvents",
"description": "Represents a Custom Rich Media Events group.",
"properties": {
"kind": {
"description": "The kind of resource this is, in this case dfareporting#customRichMediaEvents.",
"type": "string"
},
"filteredEventIds": {
"type": "array",
"items": {
"$ref": "DimensionValue"
},
"description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName."
}
}
},
"FloodlightActivity": {
"properties": {
"tagFormat": {
"description": "Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.",
"enumDescriptions": [
"",
""
],
"enum": [
"HTML",
"XHTML"
],
"type": "string"
},
"status": {
"type": "string",
"description": "The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.",
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"ACTIVE",
"ARCHIVED_AND_DISABLED",
"ARCHIVED",
"DISABLED_POLICY"
]
},
"idDimensionValue": {
"description": "Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"name": {
"type": "string",
"description": "Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes."
},
"secure": {
"description": "Whether this tag should use SSL.",
"type": "boolean"
},
"id": {
"type": "string",
"format": "int64",
"description": "ID of this floodlight activity. This is a read-only, auto-generated field."
},
"accountId": {
"type": "string",
"description": "Account ID of this floodlight activity. This is a read-only field that can be left blank.",
"format": "int64"
},
"countingMethod": {
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string",
"description": "Counting method for conversions for this floodlight activity. This is a required field.",
"enum": [
"STANDARD_COUNTING",
"UNIQUE_COUNTING",
"SESSION_COUNTING",
"TRANSACTIONS_COUNTING",
"ITEMS_SOLD_COUNTING"
]
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivity\"."
},
"expectedUrl": {
"description": "URL where this tag will be deployed. If specified, must be less than 256 characters long.",
"type": "string"
},
"attributionEnabled": {
"type": "boolean",
"description": "Whether the activity is enabled for attribution."
},
"notes": {
"description": "General notes or implementation instructions for the tag.",
"type": "string"
},
"floodlightConfigurationIdDimensionValue": {
"description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.",
"$ref": "DimensionValue"
},
"floodlightConfigurationId": {
"description": "Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.",
"type": "string",
"format": "int64"
},
"advertiserIdDimensionValue": {
"$ref": "DimensionValue",
"description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
},
"publisherTags": {
"description": "Publisher dynamic floodlight tags.",
"items": {
"$ref": "FloodlightActivityPublisherDynamicTag"
},
"type": "array"
},
"floodlightTagType": {
"enumDescriptions": [
"",
"",
""
],
"description": "The type of Floodlight tag this activity will generate. This is a required field.",
"enum": [
"IFRAME",
"IMAGE",
"GLOBAL_SITE_TAG"
],
"type": "string"
},
"advertiserId": {
"format": "int64",
"type": "string",
"description": "Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser."
},
"tagString": {
"type": "string",
"description": "Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion."
},
"floodlightActivityGroupName": {
"description": "Name of the associated floodlight activity group. This is a read-only field.",
"type": "string"
},
"userDefinedVariableTypes": {
"description": "List of the user-defined variables used by this conversion tag. These map to the \"u[1-100]=\" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. ",
"type": "array",
"items": {
"type": "string",
"enum": [
"U1",
"U2",
"U3",
"U4",
"U5",
"U6",
"U7",
"U8",
"U9",
"U10",
"U11",
"U12",
"U13",
"U14",
"U15",
"U16",
"U17",
"U18",
"U19",
"U20",
"U21",
"U22",
"U23",
"U24",
"U25",
"U26",
"U27",
"U28",
"U29",
"U30",
"U31",
"U32",
"U33",
"U34",
"U35",
"U36",
"U37",
"U38",
"U39",
"U40",
"U41",
"U42",
"U43",
"U44",
"U45",
"U46",
"U47",
"U48",
"U49",
"U50",
"U51",
"U52",
"U53",
"U54",
"U55",
"U56",
"U57",
"U58",
"U59",
"U60",
"U61",
"U62",
"U63",
"U64",
"U65",
"U66",
"U67",
"U68",
"U69",
"U70",
"U71",
"U72",
"U73",
"U74",
"U75",
"U76",
"U77",
"U78",
"U79",
"U80",
"U81",
"U82",
"U83",
"U84",
"U85",
"U86",
"U87",
"U88",
"U89",
"U90",
"U91",
"U92",
"U93",
"U94",
"U95",
"U96",
"U97",
"U98",
"U99",
"U100"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
}
},
"sslRequired": {
"type": "boolean",
"description": "Whether this floodlight activity must be SSL-compliant."
},
"floodlightActivityGroupType": {
"enumDescriptions": [
"",
""
],
"enum": [
"COUNTER",
"SALE"
],
"description": "Type of the associated floodlight activity group. This is a read-only field.",
"type": "string"
},
"cacheBustingType": {
"enum": [
"JAVASCRIPT",
"ACTIVE_SERVER_PAGE",
"JSP",
"PHP",
"COLD_FUSION"
],
"description": "Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.",
"type": "string",
"enumDescriptions": [
"",
"",
"",
"",
""
]
},
"floodlightActivityGroupId": {
"type": "string",
"format": "int64",
"description": "Floodlight activity group ID of this floodlight activity. This is a required field."
},
"defaultTags": {
"type": "array",
"items": {
"$ref": "FloodlightActivityDynamicTag"
},
"description": "Dynamic floodlight tags."
},
"subaccountId": {
"description": "Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.",
"format": "int64",
"type": "string"
},
"floodlightActivityGroupTagString": {
"description": "Tag string of the associated floodlight activity group. This is a read-only field.",
"type": "string"
},
"sslCompliant": {
"description": "Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.",
"type": "boolean"
}
},
"description": "Contains properties of a Floodlight activity.",
"type": "object",
"id": "FloodlightActivity"
},
"TargetableRemarketingListsListResponse": {
"type": "object",
"description": "Targetable remarketing list response",
"id": "TargetableRemarketingListsListResponse",
"properties": {
"targetableRemarketingLists": {
"description": "Targetable remarketing list collection.",
"type": "array",
"items": {
"$ref": "TargetableRemarketingList"
}
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to be used for the next list operation."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingListsListResponse\".",
"type": "string"
}
}
},
"AccountUserProfile": {
"id": "AccountUserProfile",
"description": "AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfile\"."
},
"id": {
"type": "string",
"format": "int64",
"description": "ID of the user profile. This is a read-only, auto-generated field."
},
"userRoleId": {
"format": "int64",
"description": "User role ID of the user profile. This is a required field.",
"type": "string"
},
"active": {
"type": "boolean",
"description": "Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable."
},
"traffickerType": {
"enum": [
"INTERNAL_NON_TRAFFICKER",
"INTERNAL_TRAFFICKER",
"EXTERNAL_TRAFFICKER"
],
"type": "string",
"enumDescriptions": [
"",
"",
""
],
"description": "Trafficker type of this user profile. This is a read-only field."
},
"userRoleFilter": {
"description": "Filter that describes which user roles are visible to the user profile.",
"$ref": "ObjectFilter"
},
"locale": {
"description": "Locale of the user profile. This is a required field. Acceptable values are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) ",
"type": "string"
},
"advertiserFilter": {
"description": "Filter that describes which advertisers are visible to the user profile.",
"$ref": "ObjectFilter"
},
"subaccountId": {
"format": "int64",
"type": "string",
"description": "Subaccount ID of the user profile. This is a read-only field that can be left blank."
},
"siteFilter": {
"$ref": "ObjectFilter",
"description": "Filter that describes which sites are visible to the user profile."
},
"userAccessType": {
"enum": [
"NORMAL_USER",
"SUPER_USER",
"INTERNAL_ADMINISTRATOR",
"READ_ONLY_SUPER_USER"
],
"enumDescriptions": [
"",
"",
"",
""
],
"description": "User type of the user profile. This is a read-only field that can be left blank.",
"type": "string"
},
"email": {
"type": "string",
"description": "Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion."
},
"accountId": {
"description": "Account ID of the user profile. This is a read-only field that can be left blank.",
"type": "string",
"format": "int64"
},
"name": {
"type": "string",
"description": "Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: \"&;\u003c\u003e\"#%,\"."
},
"campaignFilter": {
"description": "Filter that describes which campaigns are visible to the user profile.",
"$ref": "ObjectFilter"
},
"comments": {
"description": "Comments for this user profile.",
"type": "string"
}
}
},
"ConversionsBatchInsertRequest": {
"description": "Insert Conversions Request.",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertRequest\"."
},
"encryptionInfo": {
"description": "Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used.",
"$ref": "EncryptionInfo"
},
"conversions": {
"items": {
"$ref": "Conversion"
},
"description": "The set of conversions to insert.",
"type": "array"
}
},
"id": "ConversionsBatchInsertRequest"
},
"MobileCarrier": {
"id": "MobileCarrier",
"type": "object",
"description": "Contains information about a mobile carrier that can be targeted by ads.",
"properties": {
"id": {
"description": "ID of this mobile carrier.",
"type": "string",
"format": "int64"
},
"countryCode": {
"description": "Country code of the country to which this mobile carrier belongs.",
"type": "string"
},
"countryDartId": {
"type": "string",
"description": "DART ID of the country to which this mobile carrier belongs.",
"format": "int64"
},
"name": {
"type": "string",
"description": "Name of this mobile carrier."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarrier\".",
"type": "string"
}
}
},
"TargetWindow": {
"description": "Target Window.",
"id": "TargetWindow",
"properties": {
"customHtml": {
"description": "User-entered value.",
"type": "string"
},
"targetWindowOption": {
"description": "Type of browser window for which the backup image of the flash creative can be displayed.",
"type": "string",
"enum": [
"NEW_WINDOW",
"CURRENT_WINDOW",
"CUSTOM"
],
"enumDescriptions": [
"",
"",
""
]
}
},
"type": "object"
},
"FloodlightActivitiesGenerateTagResponse": {
"id": "FloodlightActivitiesGenerateTagResponse",
"description": "Floodlight Activity GenerateTag Response",
"type": "object",
"properties": {
"globalSiteTagGlobalSnippet": {
"type": "string",
"description": "The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more."
},
"floodlightActivityTag": {
"description": "Generated tag for this Floodlight activity. For global site tags, this is the event snippet.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesGenerateTagResponse\"."
}
}
},
"CreativeFieldsListResponse": {
"type": "object",
"description": "Creative Field List Response",
"id": "CreativeFieldsListResponse",
"properties": {
"creativeFields": {
"type": "array",
"description": "Creative field collection.",
"items": {
"$ref": "CreativeField"
}
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldsListResponse\"."
},
"nextPageToken": {
"description": "Pagination token to be used for the next list operation.",
"type": "string"
}
}
},
"PathReportDimensionValue": {
"description": "Represents a PathReportDimensionValue resource.",
"type": "object",
"id": "PathReportDimensionValue",
"properties": {
"ids": {
"description": "The possible ID's associated with the value if available.",
"type": "array",
"items": {
"type": "string"
}
},
"dimensionName": {
"description": "The name of the dimension.",
"type": "string"
},
"matchType": {
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"EXACT",
"BEGINS_WITH",
"CONTAINS",
"WILDCARD_EXPRESSION"
],
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#pathReportDimensionValue."
},
"values": {
"type": "array",
"description": "The possible values of the dimension.",
"items": {
"type": "string"
}
}
}
},
"VideoSettings": {
"type": "object",
"description": "Video Settings",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#videoSettings\".",
"type": "string"
},
"obaEnabled": {
"type": "boolean",
"description": "Whether OBA icons are enabled for this placement."
},
"skippableSettings": {
"description": "Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.",
"$ref": "SkippableSetting"
},
"companionSettings": {
"$ref": "CompanionSetting",
"description": "Settings for the companion creatives of video creatives served to this placement."
},
"orientation": {
"enum": [
"ANY",
"LANDSCAPE",
"PORTRAIT"
],
"enumDescriptions": [
"",
"",
""
],
"description": "Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.",
"type": "string"
},
"transcodeSettings": {
"description": "Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.",
"$ref": "TranscodeSetting"
},
"obaSettings": {
"$ref": "ObaIcon",
"description": "Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden."
}
},
"id": "VideoSettings"
},
"PathFilter": {
"description": "Represents a DfaReporting path filter.",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of resource this is, in this case dfareporting#pathFilter."
},
"eventFilters": {
"items": {
"$ref": "EventFilter"
},
"description": "Event filters in path report.",
"type": "array"
},
"pathMatchPosition": {
"description": "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.",
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string",
"enum": [
"PATH_MATCH_POSITION_UNSPECIFIED",
"ANY",
"FIRST",
"LAST"
]
}
},
"id": "PathFilter"
},
"AudienceSegmentGroup": {
"properties": {
"id": {
"format": "int64",
"type": "string",
"description": "ID of this audience segment group. This is a read-only, auto-generated field."
},
"name": {
"type": "string",
"description": "Name of this audience segment group. This is a required field and must be less than 65 characters long."
},
"audienceSegments": {
"items": {
"$ref": "AudienceSegment"
},
"description": "Audience segments assigned to this group. The number of segments must be between 2 and 100.",
"type": "array"
}
},
"type": "object",
"description": "Audience Segment Group.",
"id": "AudienceSegmentGroup"
},
"AdBlockingConfiguration": {
"properties": {
"creativeBundleId": {
"description": "ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used.",
"format": "int64",
"type": "string"
},
"overrideClickThroughUrl": {
"description": "Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured.",
"type": "boolean"
},
"clickThroughUrl": {
"description": "Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.",
"type": "string"
},
"enabled": {
"type": "boolean",
"description": "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."
}
},
"id": "AdBlockingConfiguration",
"description": "Campaign ad blocking settings.",
"type": "object"
},
"LanguagesListResponse": {
"properties": {
"languages": {
"items": {
"$ref": "Language"
},
"description": "Language collection.",
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#languagesListResponse\".",
"type": "string"
}
},
"id": "LanguagesListResponse",
"description": "Language List Response",
"type": "object"
},
"CompatibleFields": {
"properties": {
"kind": {
"description": "The kind of resource this is, in this case dfareporting#compatibleFields.",
"type": "string"
},
"pathAttributionReportCompatibleFields": {
"$ref": "PathReportCompatibleFields",
"description": "Contains items that are compatible to be selected for a report of type \"PATH_ATTRIBUTION\"."
},
"reportCompatibleFields": {
"$ref": "ReportCompatibleFields",
"description": "Contains items that are compatible to be selected for a report of type \"STANDARD\"."
},
"pathToConversionReportCompatibleFields": {
"description": "Contains items that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\".",
"$ref": "PathToConversionReportCompatibleFields"
},
"crossDimensionReachReportCompatibleFields": {
"$ref": "CrossDimensionReachReportCompatibleFields",
"description": "Contains items that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\"."
},
"reachReportCompatibleFields": {
"description": "Contains items that are compatible to be selected for a report of type \"REACH\".",
"$ref": "ReachReportCompatibleFields"
},
"floodlightReportCompatibleFields": {
"$ref": "FloodlightReportCompatibleFields",
"description": "Contains items that are compatible to be selected for a report of type \"FLOODLIGHT\"."
},
"pathReportCompatibleFields": {
"description": "Contains items that are compatible to be selected for a report of type \"PATH\".",
"$ref": "PathReportCompatibleFields"
}
},
"description": "Represents a response to the queryCompatibleFields method.",
"id": "CompatibleFields",
"type": "object"
},
"CustomEventInsert": {
"type": "object",
"description": "Custom event to be inserted.",
"properties": {
"matchId": {
"type": "string",
"description": "The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with mobileDeviceId, and at least one of the two fields is required."
},
"insertEventType": {
"type": "string",
"enum": [
"UNKNOWN",
"IMPRESSION",
"CLICK"
],
"description": "The type of event to insert.",
"enumDescriptions": [
"",
"",
""
]
},
"mobileDeviceId": {
"type": "string",
"description": "The mobile device ID. This field is mutually exclusive with matchId, and at least one of the two fields is required."
},
"cmDimensions": {
"$ref": "CampaignManagerIds",
"description": "Campaign Manager dimensions associated with the event."
},
"dv3Dimensions": {
"description": "DV360 dimensions associated with the event.",
"$ref": "DV3Ids"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customEventInsert\".",
"type": "string"
}
},
"id": "CustomEventInsert"
},
"UserDefinedVariableConfiguration": {
"properties": {
"variableType": {
"type": "string",
"description": "Variable name in the tag. This is a required field.",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"enum": [
"U1",
"U2",
"U3",
"U4",
"U5",
"U6",
"U7",
"U8",
"U9",
"U10",
"U11",
"U12",
"U13",
"U14",
"U15",
"U16",
"U17",
"U18",
"U19",
"U20",
"U21",
"U22",
"U23",
"U24",
"U25",
"U26",
"U27",
"U28",
"U29",
"U30",
"U31",
"U32",
"U33",
"U34",
"U35",
"U36",
"U37",
"U38",
"U39",
"U40",
"U41",
"U42",
"U43",
"U44",
"U45",
"U46",
"U47",
"U48",
"U49",
"U50",
"U51",
"U52",
"U53",
"U54",
"U55",
"U56",
"U57",
"U58",
"U59",
"U60",
"U61",
"U62",
"U63",
"U64",
"U65",
"U66",
"U67",
"U68",
"U69",
"U70",
"U71",
"U72",
"U73",
"U74",
"U75",
"U76",
"U77",
"U78",
"U79",
"U80",
"U81",
"U82",
"U83",
"U84",
"U85",
"U86",
"U87",
"U88",
"U89",
"U90",
"U91",
"U92",
"U93",
"U94",
"U95",
"U96",
"U97",
"U98",
"U99",
"U100"
]
},
"reportName": {
"type": "string",
"description": "User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: \"\"\u003c\u003e\"."
},
"dataType": {
"enumDescriptions": [
"",
""
],
"type": "string",
"enum": [
"STRING",
"NUMBER"
],
"description": "Data type for the variable. This is a required field."
}
},
"type": "object",
"description": "User Defined Variable configuration.",
"id": "UserDefinedVariableConfiguration"
}
},
"title": "Campaign Manager 360 API",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://dfareporting.mtls.googleapis.com/",
"servicePath": "dfareporting/v3.4/",
"id": "dfareporting:v3.4",
"basePath": "/dfareporting/v3.4/",
"resources": {
"campaigns": {
"methods": {
"patch": {
"request": {
"$ref": "Campaign"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId",
"id"
],
"response": {
"$ref": "Campaign"
},
"httpMethod": "PATCH",
"description": "Updates an existing campaign. This method supports patch semantics.",
"id": "dfareporting.campaigns.patch",
"flatPath": "userprofiles/{profileId}/campaigns",
"parameters": {
"profileId": {
"required": true,
"description": "User profile ID associated with this request.",
"location": "path",
"format": "int64",
"type": "string"
},
"id": {
"location": "query",
"required": true,
"format": "int64",
"description": "Campaign ID.",
"type": "string"
}
},
"path": "userprofiles/{profileId}/campaigns"
},
"update": {
"request": {
"$ref": "Campaign"
},
"response": {
"$ref": "Campaign"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/campaigns",
"description": "Updates an existing campaign.",
"httpMethod": "PUT",
"parameters": {
"profileId": {
"type": "string",
"format": "int64",
"description": "User profile ID associated with this request.",
"location": "path",
"required": true
}
},
"flatPath": "userprofiles/{profileId}/campaigns",
"id": "dfareporting.campaigns.update",
"parameterOrder": [
"profileId"
]
},
"get": {
"path": "userprofiles/{profileId}/campaigns/{id}",
"flatPath": "userprofiles/{profileId}/campaigns/{id}",
"httpMethod": "GET",
"description": "Gets one campaign by ID.",
"id": "dfareporting.campaigns.get",
"parameters": {
"profileId": {
"type": "string",
"required": true,
"location": "path",
"description": "User profile ID associated with this request.",
"format": "int64"
},
"id": {
"required": true,
"description": "Campaign ID.",
"type": "string",
"location": "path",
"format": "int64"
}
},
"response": {
"$ref": "Campaign"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId",
"id"
]
},
"insert": {
"flatPath": "userprofiles/{profileId}/campaigns",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Inserts a new campaign.",
"httpMethod": "POST",
"response": {
"$ref": "Campaign"
},
"path": "userprofiles/{profileId}/campaigns",
"request": {
"$ref": "Campaign"
},
"id": "dfareporting.campaigns.insert",
"parameters": {
"profileId": {
"location": "path",
"format": "int64",
"type": "string",
"description": "User profile ID associated with this request.",
"required": true
}
},
"parameterOrder": [
"profileId"
]
},
"list": {
"response": {
"$ref": "CampaignsListResponse"
},
"flatPath": "userprofiles/{profileId}/campaigns",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "GET",
"parameterOrder": [
"profileId"
],
"description": "Retrieves a list of campaigns, possibly filtered. This method supports paging.",
"parameters": {
"advertiserGroupIds": {
"description": "Select only campaigns whose advertisers belong to these advertiser groups.",
"format": "int64",
"location": "query",
"type": "string",
"repeated": true
},
"profileId": {
"required": true,
"location": "path",
"type": "string",
"format": "int64",
"description": "User profile ID associated with this request."
},
"ids": {
"format": "int64",
"type": "string",
"location": "query",
"repeated": true,
"description": "Select only campaigns with these IDs."
},
"overriddenEventTagId": {
"location": "query",
"type": "string",
"format": "int64",
"description": "Select only campaigns that have overridden this event tag ID."
},
"subaccountId": {
"type": "string",
"format": "int64",
"location": "query",
"description": "Select only campaigns that belong to this subaccount."
},
"sortField": {
"default": "ID",
"enumDescriptions": [
"",
""
],
"description": "Field by which to sort the list.",
"type": "string",
"location": "query",
"enum": [
"ID",
"NAME"
]
},
"searchString": {
"location": "query",
"description": "Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, \"campaign*2015\" will return campaigns with names like \"campaign June 2015\", \"campaign April 2015\", or simply \"campaign 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"campaign\" will match campaigns with name \"my campaign\", \"campaign 2015\", or simply \"campaign\".",
"type": "string"
},
"pageToken": {
"type": "string",
"description": "Value of the nextPageToken from the previous result page.",
"location": "query"
},
"advertiserIds": {
"format": "int64",
"repeated": true,
"description": "Select only campaigns that belong to these advertisers.",
"location": "query",
"type": "string"
},
"archived": {
"description": "Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.",
"type": "boolean",
"location": "query"
},
"sortOrder": {
"default": "ASCENDING",
"description": "Order of sorted results.",
"enumDescriptions": [
"",
""
],
"type": "string",
"location": "query",
"enum": [
"ASCENDING",
"DESCENDING"
]
},
"maxResults": {
"default": "1000",
"location": "query",
"maximum": "1000",
"format": "int32",
"description": "Maximum number of results to return.",
"type": "integer",
"minimum": "0"
},
"excludedIds": {
"type": "string",
"description": "Exclude campaigns with these IDs.",
"format": "int64",
"repeated": true,
"location": "query"
},
"atLeastOneOptimizationActivity": {
"type": "boolean",
"description": "Select only campaigns that have at least one optimization activity.",
"location": "query"
}
},
"path": "userprofiles/{profileId}/campaigns",
"id": "dfareporting.campaigns.list"
}
}
},
"orders": {
"methods": {
"get": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Gets one order by ID.",
"flatPath": "userprofiles/{profileId}/projects/{projectId}/orders/{id}",
"parameterOrder": [
"profileId",
"projectId",
"id"
],
"response": {
"$ref": "Order"
},
"parameters": {
"id": {
"description": "Order ID.",
"required": true,
"type": "string",
"location": "path",
"format": "int64"
},
"profileId": {
"location": "path",
"format": "int64",
"description": "User profile ID associated with this request.",
"type": "string",
"required": true
},
"projectId": {
"location": "path",
"required": true,
"description": "Project ID for orders.",
"type": "string",
"format": "int64"
}
},
"id": "dfareporting.orders.get",
"httpMethod": "GET",
"path": "userprofiles/{profileId}/projects/{projectId}/orders/{id}"
},
"list": {
"description": "Retrieves a list of orders, possibly filtered. This method supports paging.",
"id": "dfareporting.orders.list",
"path": "userprofiles/{profileId}/projects/{projectId}/orders",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/projects/{projectId}/orders",
"parameters": {
"sortOrder": {
"default": "ASCENDING",
"enumDescriptions": [
"",
""
],
"enum": [
"ASCENDING",
"DESCENDING"
],
"location": "query",
"type": "string",
"description": "Order of sorted results."
},
"sortField": {
"type": "string",
"location": "query",
"enum": [
"ID",
"NAME"
],
"description": "Field by which to sort the list.",
"default": "ID",
"enumDescriptions": [
"",
""
]
},
"maxResults": {
"description": "Maximum number of results to return.",
"location": "query",
"default": "1000",
"maximum": "1000",
"format": "int32",
"minimum": "0",
"type": "integer"
},
"searchString": {
"location": "query",
"type": "string",
"description": "Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, \"order*2015\" will return orders with names like \"order June 2015\", \"order April 2015\", or simply \"order 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"order\" will match orders with name \"my order\", \"order 2015\", or simply \"order\"."
},
"ids": {
"repeated": true,
"location": "query",
"format": "int64",
"description": "Select only orders with these IDs.",
"type": "string"
},
"profileId": {
"location": "path",
"type": "string",
"required": true,
"format": "int64",
"description": "User profile ID associated with this request."
},
"projectId": {
"location": "path",
"required": true,
"format": "int64",
"description": "Project ID for orders.",
"type": "string"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "Value of the nextPageToken from the previous result page."
},
"siteId": {
"location": "query",
"type": "string",
"format": "int64",
"repeated": true,
"description": "Select only orders that are associated with these site IDs."
}
},
"parameterOrder": [
"profileId",
"projectId"
],
"response": {
"$ref": "OrdersListResponse"
},
"httpMethod": "GET"
}
}
},
"floodlightActivityGroups": {
"methods": {
"insert": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"format": "int64",
"type": "string",
"required": true,
"location": "path",
"description": "User profile ID associated with this request."
}
},
"parameterOrder": [
"profileId"
],
"path": "userprofiles/{profileId}/floodlightActivityGroups",
"flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
"description": "Inserts a new floodlight activity group.",
"id": "dfareporting.floodlightActivityGroups.insert",
"request": {
"$ref": "FloodlightActivityGroup"
},
"response": {
"$ref": "FloodlightActivityGroup"
},
"httpMethod": "POST"
},
"update": {
"id": "dfareporting.floodlightActivityGroups.update",
"flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
"response": {
"$ref": "FloodlightActivityGroup"
},
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"location": "path",
"description": "User profile ID associated with this request.",
"format": "int64",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/floodlightActivityGroups",
"description": "Updates an existing floodlight activity group.",
"httpMethod": "PUT",
"request": {
"$ref": "FloodlightActivityGroup"
}
},
"list": {
"flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
"response": {
"$ref": "FloodlightActivityGroupsListResponse"
},
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/floodlightActivityGroups",
"description": "Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.",
"id": "dfareporting.floodlightActivityGroups.list",
"parameters": {
"searchString": {
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivitygroup*2015\" will return objects with names like \"floodlightactivitygroup June 2015\", \"floodlightactivitygroup April 2015\", or simply \"floodlightactivitygroup 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivitygroup\" will match objects with name \"my floodlightactivitygroup activity\", \"floodlightactivitygroup 2015\", or simply \"floodlightactivitygroup\".",
"location": "query",
"type": "string"
},
"profileId": {
"format": "int64",
"type": "string",
"description": "User profile ID associated with this request.",
"required": true,
"location": "path"
},
"advertiserId": {
"location": "query",
"description": "Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
"type": "string",
"format": "int64"
},
"sortField": {
"enumDescriptions": [
"",
""
],
"default": "ID",
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
],
"location": "query",
"type": "string"
},
"floodlightConfigurationId": {
"description": "Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.",
"type": "string",
"location": "query",
"format": "int64"
},
"pageToken": {
"type": "string",
"description": "Value of the nextPageToken from the previous result page.",
"location": "query"
},
"ids": {
"location": "query",
"format": "int64",
"description": "Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
"type": "string",
"repeated": true
},
"sortOrder": {
"enumDescriptions": [
"",
""
],
"location": "query",
"default": "ASCENDING",
"type": "string",
"enum": [
"ASCENDING",
"DESCENDING"
],
"description": "Order of sorted results."
},
"maxResults": {
"minimum": "0",
"maximum": "1000",
"type": "integer",
"location": "query",
"format": "int32",
"description": "Maximum number of results to return.",
"default": "1000"
},
"type": {
"location": "query",
"description": "Select only floodlight activity groups with the specified floodlight activity group type.",
"enum": [
"COUNTER",
"SALE"
],
"type": "string",
"enumDescriptions": [
"",
""
]
}
},
"parameterOrder": [
"profileId"
]
},
"patch": {
"flatPath": "userprofiles/{profileId}/floodlightActivityGroups",
"description": "Updates an existing floodlight activity group. This method supports patch semantics.",
"parameterOrder": [
"profileId",
"id"
],
"response": {
"$ref": "FloodlightActivityGroup"
},
"parameters": {
"profileId": {
"required": true,
"type": "string",
"format": "int64",
"description": "User profile ID associated with this request.",
"location": "path"
},
"id": {
"description": "FloodlightActivityGroup ID.",
"location": "query",
"format": "int64",
"required": true,
"type": "string"
}
},
"httpMethod": "PATCH",
"request": {
"$ref": "FloodlightActivityGroup"
},
"id": "dfareporting.floodlightActivityGroups.patch",
"path": "userprofiles/{profileId}/floodlightActivityGroups",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"get": {
"description": "Gets one floodlight activity group by ID.",
"parameterOrder": [
"profileId",
"id"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"id": {
"type": "string",
"format": "int64",
"description": "Floodlight activity Group ID.",
"required": true,
"location": "path"
},
"profileId": {
"location": "path",
"required": true,
"format": "int64",
"description": "User profile ID associated with this request.",
"type": "string"
}
},
"httpMethod": "GET",
"response": {
"$ref": "FloodlightActivityGroup"
},
"flatPath": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
"path": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
"id": "dfareporting.floodlightActivityGroups.get"
}
}
},
"targetableRemarketingLists": {
"methods": {
"get": {
"description": "Gets one remarketing list by ID.",
"parameters": {
"id": {
"format": "int64",
"required": true,
"description": "Remarketing list ID.",
"type": "string",
"location": "path"
},
"profileId": {
"required": true,
"type": "string",
"format": "int64",
"location": "path",
"description": "User profile ID associated with this request."
}
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/targetableRemarketingLists/{id}",
"parameterOrder": [
"profileId",
"id"
],
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/targetableRemarketingLists/{id}",
"id": "dfareporting.targetableRemarketingLists.get",
"response": {
"$ref": "TargetableRemarketingList"
}
},
"list": {
"response": {
"$ref": "TargetableRemarketingListsListResponse"
},
"flatPath": "userprofiles/{profileId}/targetableRemarketingLists",
"path": "userprofiles/{profileId}/targetableRemarketingLists",
"httpMethod": "GET",
"parameters": {
"pageToken": {
"location": "query",
"description": "Value of the nextPageToken from the previous result page.",
"type": "string"
},
"maxResults": {
"type": "integer",
"default": "1000",
"maximum": "1000",
"description": "Maximum number of results to return.",
"minimum": "0",
"format": "int32",
"location": "query"
},
"sortOrder": {
"default": "ASCENDING",
"description": "Order of sorted results.",
"type": "string",
"enum": [
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"",
""
],
"location": "query"
},
"name": {
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
"location": "query",
"type": "string"
},
"advertiserId": {
"description": "Select only targetable remarketing lists targetable by these advertisers.",
"type": "string",
"format": "int64",
"required": true,
"location": "query"
},
"profileId": {
"required": true,
"format": "int64",
"location": "path",
"type": "string",
"description": "User profile ID associated with this request."
},
"sortField": {
"description": "Field by which to sort the list.",
"default": "ID",
"enum": [
"ID",
"NAME"
],
"type": "string",
"enumDescriptions": [
"",
""
],
"location": "query"
},
"active": {
"type": "boolean",
"location": "query",
"description": "Select only active or only inactive targetable remarketing lists."
}
},
"id": "dfareporting.targetableRemarketingLists.list",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.",
"parameterOrder": [
"profileId",
"advertiserId"
]
}
}
},
"conversions": {
"methods": {
"batchupdate": {
"response": {
"$ref": "ConversionsBatchUpdateResponse"
},
"parameterOrder": [
"profileId"
],
"request": {
"$ref": "ConversionsBatchUpdateRequest"
},
"parameters": {
"profileId": {
"format": "int64",
"type": "string",
"location": "path",
"required": true,
"description": "User profile ID associated with this request."
}
},
"scopes": [
"https://www.googleapis.com/auth/ddmconversions"
],
"description": "Updates existing conversions.",
"httpMethod": "POST",
"path": "userprofiles/{profileId}/conversions/batchupdate",
"flatPath": "userprofiles/{profileId}/conversions/batchupdate",
"id": "dfareporting.conversions.batchupdate"
},
"batchinsert": {
"description": "Inserts conversions.",
"scopes": [
"https://www.googleapis.com/auth/ddmconversions"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"required": true,
"type": "string",
"format": "int64",
"location": "path"
}
},
"flatPath": "userprofiles/{profileId}/conversions/batchinsert",
"id": "dfareporting.conversions.batchinsert",
"httpMethod": "POST",
"response": {
"$ref": "ConversionsBatchInsertResponse"
},
"path": "userprofiles/{profileId}/conversions/batchinsert",
"parameterOrder": [
"profileId"
],
"request": {
"$ref": "ConversionsBatchInsertRequest"
}
}
}
},
"subaccounts": {
"methods": {
"patch": {
"parameters": {
"id": {
"required": true,
"format": "int64",
"type": "string",
"location": "query",
"description": "Subaccount ID."
},
"profileId": {
"format": "int64",
"type": "string",
"description": "User profile ID associated with this request.",
"location": "path",
"required": true
}
},
"description": "Updates an existing subaccount. This method supports patch semantics.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "Subaccount"
},
"id": "dfareporting.subaccounts.patch",
"parameterOrder": [
"profileId",
"id"
],
"path": "userprofiles/{profileId}/subaccounts",
"flatPath": "userprofiles/{profileId}/subaccounts",
"httpMethod": "PATCH",
"request": {
"$ref": "Subaccount"
}
},
"update": {
"description": "Updates an existing subaccount.",
"response": {
"$ref": "Subaccount"
},
"parameterOrder": [
"profileId"
],
"id": "dfareporting.subaccounts.update",
"flatPath": "userprofiles/{profileId}/subaccounts",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"required": true,
"type": "string",
"location": "path",
"format": "int64"
}
},
"request": {
"$ref": "Subaccount"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/subaccounts",
"httpMethod": "PUT"
},
"list": {
"path": "userprofiles/{profileId}/subaccounts",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"format": "int64",
"location": "path",
"required": true,
"description": "User profile ID associated with this request.",
"type": "string"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"type": "string",
"location": "query"
},
"sortOrder": {
"type": "string",
"enumDescriptions": [
"",
""
],
"enum": [
"ASCENDING",
"DESCENDING"
],
"location": "query",
"default": "ASCENDING",
"description": "Order of sorted results."
},
"searchString": {
"type": "string",
"location": "query",
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"subaccount*2015\" will return objects with names like \"subaccount June 2015\", \"subaccount April 2015\", or simply \"subaccount 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"subaccount\" will match objects with name \"my subaccount\", \"subaccount 2015\", or simply \"subaccount\" ."
},
"maxResults": {
"location": "query",
"minimum": "0",
"default": "1000",
"format": "int32",
"maximum": "1000",
"type": "integer",
"description": "Maximum number of results to return."
},
"ids": {
"type": "string",
"description": "Select only subaccounts with these IDs.",
"location": "query",
"repeated": true,
"format": "int64"
},
"sortField": {
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
],
"location": "query",
"type": "string",
"default": "ID",
"enumDescriptions": [
"",
""
]
}
},
"flatPath": "userprofiles/{profileId}/subaccounts",
"httpMethod": "GET",
"response": {
"$ref": "SubaccountsListResponse"
},
"id": "dfareporting.subaccounts.list",
"description": "Gets a list of subaccounts, possibly filtered. This method supports paging."
},
"get": {
"flatPath": "userprofiles/{profileId}/subaccounts/{id}",
"parameters": {
"profileId": {
"type": "string",
"location": "path",
"description": "User profile ID associated with this request.",
"format": "int64",
"required": true
},
"id": {
"format": "int64",
"description": "Subaccount ID.",
"location": "path",
"required": true,
"type": "string"
}
},
"response": {
"$ref": "Subaccount"
},
"parameterOrder": [
"profileId",
"id"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Gets one subaccount by ID.",
"path": "userprofiles/{profileId}/subaccounts/{id}",
"id": "dfareporting.subaccounts.get"
},
"insert": {
"path": "userprofiles/{profileId}/subaccounts",
"parameterOrder": [
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.subaccounts.insert",
"response": {
"$ref": "Subaccount"
},
"httpMethod": "POST",
"request": {
"$ref": "Subaccount"
},
"parameters": {
"profileId": {
"format": "int64",
"type": "string",
"required": true,
"description": "User profile ID associated with this request.",
"location": "path"
}
},
"flatPath": "userprofiles/{profileId}/subaccounts",
"description": "Inserts a new subaccount."
}
}
},
"countries": {
"methods": {
"list": {
"parameters": {
"profileId": {
"required": true,
"description": "User profile ID associated with this request.",
"location": "path",
"format": "int64",
"type": "string"
}
},
"flatPath": "userprofiles/{profileId}/countries",
"id": "dfareporting.countries.list",
"httpMethod": "GET",
"description": "Retrieves a list of countries.",
"response": {
"$ref": "CountriesListResponse"
},
"parameterOrder": [
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/countries"
},
"get": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Gets one country by ID.",
"path": "userprofiles/{profileId}/countries/{dartId}",
"httpMethod": "GET",
"id": "dfareporting.countries.get",
"flatPath": "userprofiles/{profileId}/countries/{dartId}",
"parameterOrder": [
"profileId",
"dartId"
],
"parameters": {
"profileId": {
"location": "path",
"format": "int64",
"required": true,
"type": "string",
"description": "User profile ID associated with this request."
},
"dartId": {
"type": "string",
"required": true,
"format": "int64",
"description": "Country DART ID.",
"location": "path"
}
},
"response": {
"$ref": "Country"
}
}
}
},
"remarketingListShares": {
"methods": {
"get": {
"flatPath": "userprofiles/{profileId}/remarketingListShares/{remarketingListId}",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "GET",
"parameters": {
"profileId": {
"type": "string",
"location": "path",
"required": true,
"format": "int64",
"description": "User profile ID associated with this request."
},
"remarketingListId": {
"required": true,
"format": "int64",
"description": "Remarketing list ID.",
"type": "string",
"location": "path"
}
},
"response": {
"$ref": "RemarketingListShare"
},
"path": "userprofiles/{profileId}/remarketingListShares/{remarketingListId}",
"description": "Gets one remarketing list share by remarketing list ID.",
"parameterOrder": [
"profileId",
"remarketingListId"
],
"id": "dfareporting.remarketingListShares.get"
},
"patch": {
"description": "Updates an existing remarketing list share. This method supports patch semantics.",
"request": {
"$ref": "RemarketingListShare"
},
"id": "dfareporting.remarketingListShares.patch",
"flatPath": "userprofiles/{profileId}/remarketingListShares",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "PATCH",
"response": {
"$ref": "RemarketingListShare"
},
"path": "userprofiles/{profileId}/remarketingListShares",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"required": true,
"location": "query",
"description": "RemarketingList ID.",
"format": "int64",
"type": "string"
},
"profileId": {
"required": true,
"location": "path",
"type": "string",
"description": "User profile ID associated with this request.",
"format": "int64"
}
}
},
"update": {
"response": {
"$ref": "RemarketingListShare"
},
"flatPath": "userprofiles/{profileId}/remarketingListShares",
"request": {
"$ref": "RemarketingListShare"
},
"path": "userprofiles/{profileId}/remarketingListShares",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.remarketingListShares.update",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"type": "string",
"location": "path",
"required": true,
"format": "int64"
}
},
"httpMethod": "PUT",
"parameterOrder": [
"profileId"
],
"description": "Updates an existing remarketing list share."
}
}
},
"floodlightConfigurations": {
"methods": {
"update": {
"response": {
"$ref": "FloodlightConfiguration"
},
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"type": "string",
"required": true,
"location": "path",
"format": "int64"
}
},
"description": "Updates an existing floodlight configuration.",
"id": "dfareporting.floodlightConfigurations.update",
"parameterOrder": [
"profileId"
],
"path": "userprofiles/{profileId}/floodlightConfigurations",
"request": {
"$ref": "FloodlightConfiguration"
},
"httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/floodlightConfigurations"
},
"get": {
"httpMethod": "GET",
"response": {
"$ref": "FloodlightConfiguration"
},
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"location": "path",
"type": "string",
"format": "int64",
"required": true
},
"id": {
"required": true,
"format": "int64",
"location": "path",
"description": "Floodlight configuration ID.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.floodlightConfigurations.get",
"description": "Gets one floodlight configuration by ID.",
"flatPath": "userprofiles/{profileId}/floodlightConfigurations/{id}",
"path": "userprofiles/{profileId}/floodlightConfigurations/{id}",
"parameterOrder": [
"profileId",
"id"
]
},
"patch": {
"httpMethod": "PATCH",
"request": {
"$ref": "FloodlightConfiguration"
},
"response": {
"$ref": "FloodlightConfiguration"
},
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"profileId": {
"format": "int64",
"description": "User profile ID associated with this request.",
"location": "path",
"required": true,
"type": "string"
},
"id": {
"type": "string",
"description": "FloodlightConfiguration ID.",
"format": "int64",
"location": "query",
"required": true
}
},
"path": "userprofiles/{profileId}/floodlightConfigurations",
"id": "dfareporting.floodlightConfigurations.patch",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/floodlightConfigurations",
"description": "Updates an existing floodlight configuration. This method supports patch semantics."
},
"list": {
"description": "Retrieves a list of floodlight configurations, possibly filtered.",
"parameterOrder": [
"profileId"
],
"path": "userprofiles/{profileId}/floodlightConfigurations",
"httpMethod": "GET",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"location": "path",
"type": "string",
"required": true,
"format": "int64"
},
"ids": {
"format": "int64",
"type": "string",
"repeated": true,
"location": "query",
"description": "Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned."
}
},
"id": "dfareporting.floodlightConfigurations.list",
"response": {
"$ref": "FloodlightConfigurationsListResponse"
},
"flatPath": "userprofiles/{profileId}/floodlightConfigurations",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"userRolePermissions": {
"methods": {
"get": {
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/userRolePermissions/{id}",
"parameters": {
"id": {
"description": "User role permission ID.",
"type": "string",
"location": "path",
"required": true,
"format": "int64"
},
"profileId": {
"required": true,
"format": "int64",
"description": "User profile ID associated with this request.",
"type": "string",
"location": "path"
}
},
"description": "Gets one user role permission by ID.",
"path": "userprofiles/{profileId}/userRolePermissions/{id}",
"id": "dfareporting.userRolePermissions.get",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "UserRolePermission"
},
"parameterOrder": [
"profileId",
"id"
]
},
"list": {
"parameterOrder": [
"profileId"
],
"httpMethod": "GET",
"path": "userprofiles/{profileId}/userRolePermissions",
"parameters": {
"ids": {
"format": "int64",
"location": "query",
"type": "string",
"repeated": true,
"description": "Select only user role permissions with these IDs."
},
"profileId": {
"location": "path",
"format": "int64",
"type": "string",
"description": "User profile ID associated with this request.",
"required": true
}
},
"id": "dfareporting.userRolePermissions.list",
"flatPath": "userprofiles/{profileId}/userRolePermissions",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "UserRolePermissionsListResponse"
},
"description": "Gets a list of user role permissions, possibly filtered."
}
}
},
"placements": {
"methods": {
"insert": {
"description": "Inserts a new placement.",
"request": {
"$ref": "Placement"
},
"httpMethod": "POST",
"path": "userprofiles/{profileId}/placements",
"flatPath": "userprofiles/{profileId}/placements",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.placements.insert",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"type": "string",
"location": "path",
"format": "int64",
"description": "User profile ID associated with this request.",
"required": true
}
},
"response": {
"$ref": "Placement"
}
},
"list": {
"flatPath": "userprofiles/{profileId}/placements",
"httpMethod": "GET",
"parameters": {
"minEndDate": {
"type": "string",
"description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".",
"location": "query"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"type": "string",
"location": "query"
},
"contentCategoryIds": {
"repeated": true,
"description": "Select only placements that are associated with these content categories.",
"type": "string",
"format": "int64",
"location": "query"
},
"sizeIds": {
"location": "query",
"repeated": true,
"format": "int64",
"description": "Select only placements that are associated with these sizes.",
"type": "string"
},
"campaignIds": {
"location": "query",
"repeated": true,
"description": "Select only placements that belong to these campaigns.",
"format": "int64",
"type": "string"
},
"placementStrategyIds": {
"repeated": true,
"description": "Select only placements that are associated with these placement strategies.",
"format": "int64",
"location": "query",
"type": "string"
},
"maxStartDate": {
"description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".",
"type": "string",
"location": "query"
},
"archived": {
"location": "query",
"type": "boolean",
"description": "Select only archived placements. Don't set this field to select both archived and non-archived placements."
},
"compatibilities": {
"location": "query",
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"description": "Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
"type": "string",
"enum": [
"DISPLAY",
"DISPLAY_INTERSTITIAL",
"APP",
"APP_INTERSTITIAL",
"IN_STREAM_VIDEO",
"IN_STREAM_AUDIO"
],
"repeated": true
},
"profileId": {
"type": "string",
"description": "User profile ID associated with this request.",
"required": true,
"location": "path",
"format": "int64"
},
"sortOrder": {
"type": "string",
"enumDescriptions": [
"",
""
],
"description": "Order of sorted results.",
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
],
"location": "query"
},
"siteIds": {
"repeated": true,
"format": "int64",
"description": "Select only placements that are associated with these sites.",
"location": "query",
"type": "string"
},
"minStartDate": {
"description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".",
"location": "query",
"type": "string"
},
"maxResults": {
"type": "integer",
"default": "1000",
"description": "Maximum number of results to return.",
"format": "int32",
"minimum": "0",
"maximum": "1000",
"location": "query"
},
"pricingTypes": {
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"repeated": true,
"type": "string",
"enum": [
"PRICING_TYPE_CPM",
"PRICING_TYPE_CPC",
"PRICING_TYPE_CPA",
"PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
"PRICING_TYPE_FLAT_RATE_CLICKS",
"PRICING_TYPE_CPM_ACTIVEVIEW"
],
"description": "Select only placements with these pricing types.",
"location": "query"
},
"directorySiteIds": {
"format": "int64",
"type": "string",
"location": "query",
"description": "Select only placements that are associated with these directory sites.",
"repeated": true
},
"maxEndDate": {
"location": "query",
"description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".",
"type": "string"
},
"groupIds": {
"repeated": true,
"description": "Select only placements that belong to these placement groups.",
"type": "string",
"format": "int64",
"location": "query"
},
"searchString": {
"type": "string",
"location": "query",
"description": "Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placements with names like \"placement June 2015\", \"placement May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placement\" will match placements with name \"my placement\", \"placement 2015\", or simply \"placement\" ."
},
"advertiserIds": {
"description": "Select only placements that belong to these advertisers.",
"repeated": true,
"format": "int64",
"location": "query",
"type": "string"
},
"ids": {
"location": "query",
"repeated": true,
"type": "string",
"description": "Select only placements with these IDs.",
"format": "int64"
},
"paymentSource": {
"location": "query",
"description": "Select only placements with this payment source.",
"enumDescriptions": [
"",
""
],
"enum": [
"PLACEMENT_AGENCY_PAID",
"PLACEMENT_PUBLISHER_PAID"
],
"type": "string"
},
"sortField": {
"enum": [
"ID",
"NAME"
],
"enumDescriptions": [
"",
""
],
"type": "string",
"default": "ID",
"location": "query",
"description": "Field by which to sort the list."
}
},
"response": {
"$ref": "PlacementsListResponse"
},
"parameterOrder": [
"profileId"
],
"path": "userprofiles/{profileId}/placements",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Retrieves a list of placements, possibly filtered. This method supports paging.",
"id": "dfareporting.placements.list"
},
"update": {
"request": {
"$ref": "Placement"
},
"httpMethod": "PUT",
"id": "dfareporting.placements.update",
"parameters": {
"profileId": {
"format": "int64",
"description": "User profile ID associated with this request.",
"type": "string",
"location": "path",
"required": true
}
},
"flatPath": "userprofiles/{profileId}/placements",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId"
],
"response": {
"$ref": "Placement"
},
"path": "userprofiles/{profileId}/placements",
"description": "Updates an existing placement."
},
"get": {
"id": "dfareporting.placements.get",
"response": {
"$ref": "Placement"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Gets one placement by ID.",
"parameterOrder": [
"profileId",
"id"
],
"flatPath": "userprofiles/{profileId}/placements/{id}",
"path": "userprofiles/{profileId}/placements/{id}",
"parameters": {
"id": {
"required": true,
"format": "int64",
"description": "Placement ID.",
"location": "path",
"type": "string"
},
"profileId": {
"type": "string",
"description": "User profile ID associated with this request.",
"format": "int64",
"required": true,
"location": "path"
}
},
"httpMethod": "GET"
},
"generatetags": {
"flatPath": "userprofiles/{profileId}/placements/generatetags",
"id": "dfareporting.placements.generatetags",
"httpMethod": "POST",
"description": "Generates tags for a placement.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/placements/generatetags",
"response": {
"$ref": "PlacementsGenerateTagsResponse"
},
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"required": true,
"format": "int64",
"location": "path",
"type": "string",
"description": "User profile ID associated with this request."
},
"campaignId": {
"location": "query",
"format": "int64",
"description": "Generate placements belonging to this campaign. This is a required field.",
"type": "string"
},
"tagFormats": {
"type": "string",
"location": "query",
"description": "Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.",
"repeated": true,
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"enum": [
"PLACEMENT_TAG_STANDARD",
"PLACEMENT_TAG_IFRAME_JAVASCRIPT",
"PLACEMENT_TAG_IFRAME_ILAYER",
"PLACEMENT_TAG_INTERNAL_REDIRECT",
"PLACEMENT_TAG_JAVASCRIPT",
"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
"PLACEMENT_TAG_CLICK_COMMANDS",
"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
"PLACEMENT_TAG_TRACKING",
"PLACEMENT_TAG_TRACKING_IFRAME",
"PLACEMENT_TAG_TRACKING_JAVASCRIPT",
"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
"PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
"PLACEMENT_TAG_JAVASCRIPT_LEGACY",
"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
]
},
"placementIds": {
"format": "int64",
"repeated": true,
"type": "string",
"location": "query",
"description": "Generate tags for these placements."
}
}
},
"patch": {
"parameters": {
"profileId": {
"format": "int64",
"description": "User profile ID associated with this request.",
"location": "path",
"type": "string",
"required": true
},
"id": {
"description": "Placement ID.",
"location": "query",
"type": "string",
"required": true,
"format": "int64"
}
},
"description": "Updates an existing placement. This method supports patch semantics.",
"flatPath": "userprofiles/{profileId}/placements",
"path": "userprofiles/{profileId}/placements",
"httpMethod": "PATCH",
"id": "dfareporting.placements.patch",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"request": {
"$ref": "Placement"
},
"response": {
"$ref": "Placement"
},
"parameterOrder": [
"profileId",
"id"
]
}
}
},
"sizes": {
"methods": {
"insert": {
"response": {
"$ref": "Size"
},
"path": "userprofiles/{profileId}/sizes",
"flatPath": "userprofiles/{profileId}/sizes",
"id": "dfareporting.sizes.insert",
"httpMethod": "POST",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"type": "string",
"format": "int64",
"location": "path",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId"
],
"request": {
"$ref": "Size"
},
"description": "Inserts a new size."
},
"list": {
"description": "Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.",
"path": "userprofiles/{profileId}/sizes",
"parameterOrder": [
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"ids": {
"location": "query",
"format": "int64",
"repeated": true,
"description": "Select only sizes with these IDs.",
"type": "string"
},
"width": {
"type": "integer",
"minimum": "0",
"format": "int32",
"maximum": "32767",
"location": "query",
"description": "Select only sizes with this width."
},
"height": {
"description": "Select only sizes with this height.",
"format": "int32",
"location": "query",
"type": "integer",
"maximum": "32767",
"minimum": "0"
},
"iabStandard": {
"type": "boolean",
"location": "query",
"description": "Select only IAB standard sizes."
},
"profileId": {
"location": "path",
"required": true,
"type": "string",
"description": "User profile ID associated with this request.",
"format": "int64"
}
},
"httpMethod": "GET",
"id": "dfareporting.sizes.list",
"flatPath": "userprofiles/{profileId}/sizes",
"response": {
"$ref": "SizesListResponse"
}
},
"get": {
"description": "Gets one size by ID.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/sizes/{id}",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"location": "path",
"required": true,
"format": "int64",
"type": "string"
},
"id": {
"location": "path",
"description": "Size ID.",
"required": true,
"type": "string",
"format": "int64"
}
},
"parameterOrder": [
"profileId",
"id"
],
"path": "userprofiles/{profileId}/sizes/{id}",
"response": {
"$ref": "Size"
},
"httpMethod": "GET",
"id": "dfareporting.sizes.get"
}
}
},
"metros": {
"methods": {
"list": {
"httpMethod": "GET",
"id": "dfareporting.metros.list",
"path": "userprofiles/{profileId}/metros",
"description": "Retrieves a list of metros.",
"flatPath": "userprofiles/{profileId}/metros",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId"
],
"response": {
"$ref": "MetrosListResponse"
},
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"location": "path",
"required": true,
"format": "int64",
"type": "string"
}
}
}
}
},
"cities": {
"methods": {
"list": {
"parameterOrder": [
"profileId"
],
"parameters": {
"regionDartIds": {
"repeated": true,
"format": "int64",
"type": "string",
"description": "Select only cities from these regions.",
"location": "query"
},
"dartIds": {
"format": "int64",
"description": "Select only cities with these DART IDs.",
"repeated": true,
"location": "query",
"type": "string"
},
"namePrefix": {
"type": "string",
"description": "Select only cities with names starting with this prefix.",
"location": "query"
},
"countryDartIds": {
"repeated": true,
"type": "string",
"description": "Select only cities from these countries.",
"location": "query",
"format": "int64"
},
"profileId": {
"format": "int64",
"location": "path",
"description": "User profile ID associated with this request.",
"type": "string",
"required": true
}
},
"response": {
"$ref": "CitiesListResponse"
},
"httpMethod": "GET",
"path": "userprofiles/{profileId}/cities",
"flatPath": "userprofiles/{profileId}/cities",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.cities.list",
"description": "Retrieves a list of cities, possibly filtered."
}
}
},
"platformTypes": {
"methods": {
"list": {
"parameterOrder": [
"profileId"
],
"path": "userprofiles/{profileId}/platformTypes",
"parameters": {
"profileId": {
"format": "int64",
"type": "string",
"required": true,
"location": "path",
"description": "User profile ID associated with this request."
}
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/platformTypes",
"response": {
"$ref": "PlatformTypesListResponse"
},
"id": "dfareporting.platformTypes.list",
"description": "Retrieves a list of platform types."
},
"get": {
"id": "dfareporting.platformTypes.get",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"required": true,
"format": "int64",
"location": "path",
"type": "string"
},
"id": {
"description": "Platform type ID.",
"type": "string",
"required": true,
"format": "int64",
"location": "path"
}
},
"response": {
"$ref": "PlatformType"
},
"flatPath": "userprofiles/{profileId}/platformTypes/{id}",
"path": "userprofiles/{profileId}/platformTypes/{id}",
"parameterOrder": [
"profileId",
"id"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Gets one platform type by ID."
}
}
},
"accountPermissions": {
"methods": {
"get": {
"parameterOrder": [
"profileId",
"id"
],
"response": {
"$ref": "AccountPermission"
},
"description": "Gets one account permission by ID.",
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/accountPermissions/{id}",
"path": "userprofiles/{profileId}/accountPermissions/{id}",
"id": "dfareporting.accountPermissions.get",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"required": true,
"type": "string",
"location": "path",
"format": "int64"
},
"id": {
"location": "path",
"type": "string",
"required": true,
"description": "Account permission ID.",
"format": "int64"
}
}
},
"list": {
"description": "Retrieves the list of account permissions.",
"path": "userprofiles/{profileId}/accountPermissions",
"parameters": {
"profileId": {
"required": true,
"format": "int64",
"location": "path",
"description": "User profile ID associated with this request.",
"type": "string"
}
},
"id": "dfareporting.accountPermissions.list",
"flatPath": "userprofiles/{profileId}/accountPermissions",
"response": {
"$ref": "AccountPermissionsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId"
],
"httpMethod": "GET"
}
}
},
"languages": {
"methods": {
"list": {
"description": "Retrieves a list of languages.",
"id": "dfareporting.languages.list",
"parameterOrder": [
"profileId"
],
"response": {
"$ref": "LanguagesListResponse"
},
"flatPath": "userprofiles/{profileId}/languages",
"httpMethod": "GET",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"type": "string",
"required": true,
"location": "path",
"format": "int64"
}
},
"path": "userprofiles/{profileId}/languages",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"postalCodes": {
"methods": {
"get": {
"parameters": {
"profileId": {
"required": true,
"type": "string",
"format": "int64",
"location": "path",
"description": "User profile ID associated with this request."
},
"code": {
"required": true,
"type": "string",
"location": "path",
"description": "Postal code ID."
}
},
"parameterOrder": [
"profileId",
"code"
],
"flatPath": "userprofiles/{profileId}/postalCodes/{code}",
"path": "userprofiles/{profileId}/postalCodes/{code}",
"id": "dfareporting.postalCodes.get",
"response": {
"$ref": "PostalCode"
},
"description": "Gets one postal code by ID.",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves a list of postal codes.",
"path": "userprofiles/{profileId}/postalCodes",
"id": "dfareporting.postalCodes.list",
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/postalCodes",
"response": {
"$ref": "PostalCodesListResponse"
},
"parameterOrder": [
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"location": "path",
"format": "int64",
"type": "string",
"required": true,
"description": "User profile ID associated with this request."
}
}
}
}
},
"mobileApps": {
"methods": {
"get": {
"httpMethod": "GET",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"location": "path",
"format": "int64",
"required": true,
"type": "string"
},
"id": {
"required": true,
"type": "string",
"description": "Mobile app ID.",
"location": "path"
}
},
"path": "userprofiles/{profileId}/mobileApps/{id}",
"flatPath": "userprofiles/{profileId}/mobileApps/{id}",
"response": {
"$ref": "MobileApp"
},
"id": "dfareporting.mobileApps.get",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Gets one mobile app by ID.",
"parameterOrder": [
"profileId",
"id"
]
},
"list": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Retrieves list of available mobile apps.",
"parameterOrder": [
"profileId"
],
"path": "userprofiles/{profileId}/mobileApps",
"flatPath": "userprofiles/{profileId}/mobileApps",
"httpMethod": "GET",
"response": {
"$ref": "MobileAppsListResponse"
},
"id": "dfareporting.mobileApps.list",
"parameters": {
"ids": {
"location": "query",
"type": "string",
"description": "Select only apps with these IDs.",
"repeated": true
},
"maxResults": {
"maximum": "1000",
"format": "int32",
"type": "integer",
"default": "1000",
"minimum": "0",
"description": "Maximum number of results to return.",
"location": "query"
},
"directories": {
"type": "string",
"enumDescriptions": [
"",
"",
""
],
"description": "Select only apps from these directories.",
"location": "query",
"enum": [
"UNKNOWN",
"APPLE_APP_STORE",
"GOOGLE_PLAY_STORE"
],
"repeated": true
},
"profileId": {
"description": "User profile ID associated with this request.",
"required": true,
"format": "int64",
"location": "path",
"type": "string"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "Value of the nextPageToken from the previous result page."
},
"searchString": {
"location": "query",
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"app*2015\" will return objects with names like \"app Jan 2018\", \"app Jan 2018\", or simply \"app 2018\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"app\" will match objects with name \"my app\", \"app 2018\", or simply \"app\".",
"type": "string"
}
}
}
}
},
"userRolePermissionGroups": {
"methods": {
"get": {
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/userRolePermissionGroups/{id}",
"id": "dfareporting.userRolePermissionGroups.get",
"response": {
"$ref": "UserRolePermissionGroup"
},
"parameters": {
"profileId": {
"format": "int64",
"description": "User profile ID associated with this request.",
"type": "string",
"required": true,
"location": "path"
},
"id": {
"description": "User role permission group ID.",
"required": true,
"location": "path",
"format": "int64",
"type": "string"
}
},
"parameterOrder": [
"profileId",
"id"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Gets one user role permission group by ID.",
"path": "userprofiles/{profileId}/userRolePermissionGroups/{id}"
},
"list": {
"parameters": {
"profileId": {
"location": "path",
"format": "int64",
"required": true,
"type": "string",
"description": "User profile ID associated with this request."
}
},
"response": {
"$ref": "UserRolePermissionGroupsListResponse"
},
"httpMethod": "GET",
"path": "userprofiles/{profileId}/userRolePermissionGroups",
"parameterOrder": [
"profileId"
],
"id": "dfareporting.userRolePermissionGroups.list",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Gets a list of all supported user role permission groups.",
"flatPath": "userprofiles/{profileId}/userRolePermissionGroups"
}
}
},
"mobileCarriers": {
"methods": {
"list": {
"id": "dfareporting.mobileCarriers.list",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"format": "int64",
"description": "User profile ID associated with this request.",
"location": "path",
"required": true,
"type": "string"
}
},
"parameterOrder": [
"profileId"
],
"flatPath": "userprofiles/{profileId}/mobileCarriers",
"description": "Retrieves a list of mobile carriers.",
"httpMethod": "GET",
"response": {
"$ref": "MobileCarriersListResponse"
},
"path": "userprofiles/{profileId}/mobileCarriers"
},
"get": {
"flatPath": "userprofiles/{profileId}/mobileCarriers/{id}",
"path": "userprofiles/{profileId}/mobileCarriers/{id}",
"description": "Gets one mobile carrier by ID.",
"response": {
"$ref": "MobileCarrier"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId",
"id"
],
"httpMethod": "GET",
"id": "dfareporting.mobileCarriers.get",
"parameters": {
"id": {
"required": true,
"type": "string",
"description": "Mobile carrier ID.",
"location": "path",
"format": "int64"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
}
}
}
},
"advertisers": {
"methods": {
"get": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "Advertiser"
},
"id": "dfareporting.advertisers.get",
"parameterOrder": [
"profileId",
"id"
],
"flatPath": "userprofiles/{profileId}/advertisers/{id}",
"httpMethod": "GET",
"description": "Gets one advertiser by ID.",
"parameters": {
"id": {
"required": true,
"location": "path",
"type": "string",
"format": "int64",
"description": "Advertiser ID."
},
"profileId": {
"description": "User profile ID associated with this request.",
"type": "string",
"format": "int64",
"location": "path",
"required": true
}
},
"path": "userprofiles/{profileId}/advertisers/{id}"
},
"patch": {
"response": {
"$ref": "Advertiser"
},
"flatPath": "userprofiles/{profileId}/advertisers",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"location": "path",
"description": "User profile ID associated with this request.",
"type": "string",
"required": true,
"format": "int64"
},
"id": {
"required": true,
"type": "string",
"description": "Advertiser ID.",
"format": "int64",
"location": "query"
}
},
"request": {
"$ref": "Advertiser"
},
"parameterOrder": [
"profileId",
"id"
],
"id": "dfareporting.advertisers.patch",
"path": "userprofiles/{profileId}/advertisers",
"description": "Updates an existing advertiser. This method supports patch semantics.",
"httpMethod": "PATCH"
},
"update": {
"description": "Updates an existing advertiser.",
"request": {
"$ref": "Advertiser"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"format": "int64",
"type": "string",
"location": "path",
"description": "User profile ID associated with this request.",
"required": true
}
},
"id": "dfareporting.advertisers.update",
"path": "userprofiles/{profileId}/advertisers",
"httpMethod": "PUT",
"flatPath": "userprofiles/{profileId}/advertisers",
"response": {
"$ref": "Advertiser"
},
"parameterOrder": [
"profileId"
]
},
"insert": {
"request": {
"$ref": "Advertiser"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/advertisers",
"parameterOrder": [
"profileId"
],
"response": {
"$ref": "Advertiser"
},
"flatPath": "userprofiles/{profileId}/advertisers",
"parameters": {
"profileId": {
"format": "int64",
"location": "path",
"description": "User profile ID associated with this request.",
"required": true,
"type": "string"
}
},
"id": "dfareporting.advertisers.insert",
"httpMethod": "POST",
"description": "Inserts a new advertiser."
},
"list": {
"parameterOrder": [
"profileId"
],
"httpMethod": "GET",
"parameters": {
"onlyParent": {
"type": "boolean",
"location": "query",
"description": "Select only advertisers which use another advertiser's floodlight configuration."
},
"advertiserGroupIds": {
"format": "int64",
"repeated": true,
"location": "query",
"description": "Select only advertisers with these advertiser group IDs.",
"type": "string"
},
"status": {
"type": "string",
"location": "query",
"enumDescriptions": [
"",
""
],
"description": "Select only advertisers with the specified status.",
"enum": [
"APPROVED",
"ON_HOLD"
]
},
"floodlightConfigurationIds": {
"description": "Select only advertisers with these floodlight configuration IDs.",
"repeated": true,
"format": "int64",
"type": "string",
"location": "query"
},
"sortOrder": {
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"description": "Order of sorted results.",
"type": "string"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "Value of the nextPageToken from the previous result page."
},
"ids": {
"location": "query",
"format": "int64",
"repeated": true,
"description": "Select only advertisers with these IDs.",
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"location": "path",
"format": "int64",
"type": "string",
"required": true
},
"includeAdvertisersWithoutGroupsOnly": {
"location": "query",
"type": "boolean",
"description": "Select only advertisers which do not belong to any advertiser group."
},
"sortField": {
"default": "ID",
"enumDescriptions": [
"",
""
],
"type": "string",
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
],
"location": "query"
},
"searchString": {
"type": "string",
"location": "query",
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser June 2015\", \"advertiser April 2015\", or simply \"advertiser 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertiser\" will match objects with name \"my advertiser\", \"advertiser 2015\", or simply \"advertiser\" ."
},
"maxResults": {
"type": "integer",
"location": "query",
"minimum": "0",
"format": "int32",
"maximum": "1000",
"default": "1000",
"description": "Maximum number of results to return."
},
"subaccountId": {
"type": "string",
"description": "Select only advertisers with these subaccount IDs.",
"location": "query",
"format": "int64"
}
},
"id": "dfareporting.advertisers.list",
"description": "Retrieves a list of advertisers, possibly filtered. This method supports paging.",
"path": "userprofiles/{profileId}/advertisers",
"flatPath": "userprofiles/{profileId}/advertisers",
"response": {
"$ref": "AdvertisersListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"regions": {
"methods": {
"list": {
"description": "Retrieves a list of regions.",
"httpMethod": "GET",
"id": "dfareporting.regions.list",
"path": "userprofiles/{profileId}/regions",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/regions",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"format": "int64",
"description": "User profile ID associated with this request.",
"location": "path",
"required": true,
"type": "string"
}
},
"response": {
"$ref": "RegionsListResponse"
}
}
}
},
"accountActiveAdSummaries": {
"methods": {
"get": {
"description": "Gets the account's active ad summary by account ID.",
"parameterOrder": [
"profileId",
"summaryAccountId"
],
"flatPath": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
"httpMethod": "GET",
"parameters": {
"summaryAccountId": {
"location": "path",
"description": "Account ID.",
"format": "int64",
"required": true,
"type": "string"
},
"profileId": {
"type": "string",
"required": true,
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
"response": {
"$ref": "AccountActiveAdSummary"
},
"id": "dfareporting.accountActiveAdSummaries.get"
}
}
},
"operatingSystemVersions": {
"methods": {
"list": {
"path": "userprofiles/{profileId}/operatingSystemVersions",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Retrieves a list of operating system versions.",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"format": "int64",
"description": "User profile ID associated with this request.",
"required": true,
"type": "string",
"location": "path"
}
},
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/operatingSystemVersions",
"id": "dfareporting.operatingSystemVersions.list",
"response": {
"$ref": "OperatingSystemVersionsListResponse"
}
},
"get": {
"response": {
"$ref": "OperatingSystemVersion"
},
"description": "Gets one operating system version by ID.",
"parameterOrder": [
"profileId",
"id"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/operatingSystemVersions/{id}",
"id": "dfareporting.operatingSystemVersions.get",
"httpMethod": "GET",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"required": true,
"type": "string",
"format": "int64",
"location": "path"
},
"id": {
"required": true,
"location": "path",
"format": "int64",
"type": "string",
"description": "Operating system version ID."
}
},
"flatPath": "userprofiles/{profileId}/operatingSystemVersions/{id}"
}
}
},
"customEvents": {
"methods": {
"batchinsert": {
"parameterOrder": [
"profileId"
],
"response": {
"$ref": "CustomEventsBatchInsertResponse"
},
"request": {
"$ref": "CustomEventsBatchInsertRequest"
},
"scopes": [
"https://www.googleapis.com/auth/ddmconversions"
],
"description": "Inserts custom events.",
"id": "dfareporting.customEvents.batchinsert",
"flatPath": "userprofiles/{profileId}/customEvents/batchinsert",
"parameters": {
"profileId": {
"format": "int64",
"required": true,
"location": "path",
"type": "string",
"description": "User profile ID associated with this request."
}
},
"httpMethod": "POST",
"path": "userprofiles/{profileId}/customEvents/batchinsert"
}
}
},
"userProfiles": {
"methods": {
"get": {
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/ddmconversions",
"https://www.googleapis.com/auth/dfareporting",
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.userProfiles.get",
"parameters": {
"profileId": {
"description": "The user profile ID.",
"required": true,
"location": "path",
"type": "string",
"format": "int64"
}
},
"response": {
"$ref": "UserProfile"
},
"parameterOrder": [
"profileId"
],
"path": "userprofiles/{profileId}",
"description": "Gets one user profile by ID.",
"flatPath": "userprofiles/{profileId}"
},
"list": {
"parameterOrder": [],
"response": {
"$ref": "UserProfileList"
},
"id": "dfareporting.userProfiles.list",
"httpMethod": "GET",
"parameters": {},
"flatPath": "userprofiles",
"scopes": [
"https://www.googleapis.com/auth/ddmconversions",
"https://www.googleapis.com/auth/dfareporting",
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles",
"description": "Retrieves list of user profiles for a user."
}
}
},
"placementGroups": {
"methods": {
"list": {
"path": "userprofiles/{profileId}/placementGroups",
"flatPath": "userprofiles/{profileId}/placementGroups",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "PlacementGroupsListResponse"
},
"httpMethod": "GET",
"parameterOrder": [
"profileId"
],
"id": "dfareporting.placementGroups.list",
"parameters": {
"minEndDate": {
"type": "string",
"description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".",
"location": "query"
},
"maxStartDate": {
"type": "string",
"location": "query",
"description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\"."
},
"archived": {
"location": "query",
"type": "boolean",
"description": "Select only archived placements. Don't set this field to select both archived and non-archived placements."
},
"sortField": {
"location": "query",
"enumDescriptions": [
"",
""
],
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
],
"default": "ID",
"type": "string"
},
"contentCategoryIds": {
"format": "int64",
"location": "query",
"description": "Select only placement groups that are associated with these content categories.",
"type": "string",
"repeated": true
},
"searchString": {
"location": "query",
"type": "string",
"description": "Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placement groups with names like \"placement group June 2015\", \"placement group May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementgroup\" will match placement groups with name \"my placementgroup\", \"placementgroup 2015\", or simply \"placementgroup\"."
},
"maxResults": {
"description": "Maximum number of results to return.",
"format": "int32",
"default": "800",
"minimum": "0",
"type": "integer",
"maximum": "800",
"location": "query"
},
"advertiserIds": {
"description": "Select only placement groups that belong to these advertisers.",
"format": "int64",
"location": "query",
"type": "string",
"repeated": true
},
"campaignIds": {
"description": "Select only placement groups that belong to these campaigns.",
"type": "string",
"location": "query",
"repeated": true,
"format": "int64"
},
"maxEndDate": {
"type": "string",
"location": "query",
"description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\"."
},
"placementStrategyIds": {
"description": "Select only placement groups that are associated with these placement strategies.",
"location": "query",
"format": "int64",
"type": "string",
"repeated": true
},
"pageToken": {
"type": "string",
"description": "Value of the nextPageToken from the previous result page.",
"location": "query"
},
"profileId": {
"required": true,
"format": "int64",
"location": "path",
"type": "string",
"description": "User profile ID associated with this request."
},
"placementGroupType": {
"type": "string",
"location": "query",
"description": "Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.",
"enumDescriptions": [
"",
""
],
"enum": [
"PLACEMENT_PACKAGE",
"PLACEMENT_ROADBLOCK"
]
},
"siteIds": {
"location": "query",
"description": "Select only placement groups that are associated with these sites.",
"type": "string",
"repeated": true,
"format": "int64"
},
"minStartDate": {
"type": "string",
"location": "query",
"description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\"."
},
"ids": {
"format": "int64",
"location": "query",
"type": "string",
"repeated": true,
"description": "Select only placement groups with these IDs."
},
"pricingTypes": {
"repeated": true,
"description": "Select only placement groups with these pricing types.",
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"enum": [
"PRICING_TYPE_CPM",
"PRICING_TYPE_CPC",
"PRICING_TYPE_CPA",
"PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
"PRICING_TYPE_FLAT_RATE_CLICKS",
"PRICING_TYPE_CPM_ACTIVEVIEW"
],
"type": "string",
"location": "query"
},
"directorySiteIds": {
"description": "Select only placement groups that are associated with these directory sites.",
"repeated": true,
"type": "string",
"location": "query",
"format": "int64"
},
"sortOrder": {
"enumDescriptions": [
"",
""
],
"location": "query",
"description": "Order of sorted results.",
"type": "string",
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
]
}
},
"description": "Retrieves a list of placement groups, possibly filtered. This method supports paging."
},
"update": {
"parameters": {
"profileId": {
"location": "path",
"description": "User profile ID associated with this request.",
"format": "int64",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"request": {
"$ref": "PlacementGroup"
},
"response": {
"$ref": "PlacementGroup"
},
"parameterOrder": [
"profileId"
],
"path": "userprofiles/{profileId}/placementGroups",
"flatPath": "userprofiles/{profileId}/placementGroups",
"id": "dfareporting.placementGroups.update",
"httpMethod": "PUT",
"description": "Updates an existing placement group."
},
"get": {
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"location": "path",
"type": "string",
"required": true,
"format": "int64"
},
"id": {
"format": "int64",
"required": true,
"description": "Placement group ID.",
"location": "path",
"type": "string"
}
},
"path": "userprofiles/{profileId}/placementGroups/{id}",
"description": "Gets one placement group by ID.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "GET",
"id": "dfareporting.placementGroups.get",
"response": {
"$ref": "PlacementGroup"
},
"flatPath": "userprofiles/{profileId}/placementGroups/{id}"
},
"patch": {
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"type": "string",
"required": true,
"format": "int64",
"location": "path"
},
"id": {
"type": "string",
"location": "query",
"required": true,
"description": "PlacementGroup ID.",
"format": "int64"
}
},
"request": {
"$ref": "PlacementGroup"
},
"response": {
"$ref": "PlacementGroup"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId",
"id"
],
"path": "userprofiles/{profileId}/placementGroups",
"id": "dfareporting.placementGroups.patch",
"flatPath": "userprofiles/{profileId}/placementGroups",
"description": "Updates an existing placement group. This method supports patch semantics.",
"httpMethod": "PATCH"
},
"insert": {
"id": "dfareporting.placementGroups.insert",
"path": "userprofiles/{profileId}/placementGroups",
"response": {
"$ref": "PlacementGroup"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/placementGroups",
"description": "Inserts a new placement group.",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"required": true,
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"type": "string"
}
},
"request": {
"$ref": "PlacementGroup"
},
"httpMethod": "POST"
}
}
},
"videoFormats": {
"methods": {
"get": {
"id": "dfareporting.videoFormats.get",
"response": {
"$ref": "VideoFormat"
},
"path": "userprofiles/{profileId}/videoFormats/{id}",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"location": "path",
"format": "int32",
"required": true,
"description": "Video format ID.",
"type": "integer"
},
"profileId": {
"location": "path",
"format": "int64",
"type": "string",
"description": "User profile ID associated with this request.",
"required": true
}
},
"description": "Gets one video format by ID.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/videoFormats/{id}"
},
"list": {
"response": {
"$ref": "VideoFormatsListResponse"
},
"flatPath": "userprofiles/{profileId}/videoFormats",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"type": "string",
"location": "path",
"format": "int64",
"required": true,
"description": "User profile ID associated with this request."
}
},
"parameterOrder": [
"profileId"
],
"path": "userprofiles/{profileId}/videoFormats",
"httpMethod": "GET",
"description": "Lists available video formats.",
"id": "dfareporting.videoFormats.list"
}
}
},
"accountUserProfiles": {
"methods": {
"insert": {
"response": {
"$ref": "AccountUserProfile"
},
"path": "userprofiles/{profileId}/accountUserProfiles",
"parameterOrder": [
"profileId"
],
"id": "dfareporting.accountUserProfiles.insert",
"flatPath": "userprofiles/{profileId}/accountUserProfiles",
"request": {
"$ref": "AccountUserProfile"
},
"parameters": {
"profileId": {
"type": "string",
"description": "User profile ID associated with this request.",
"required": true,
"format": "int64",
"location": "path"
}
},
"description": "Inserts a new account user profile.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "POST"
},
"get": {
"httpMethod": "GET",
"id": "dfareporting.accountUserProfiles.get",
"description": "Gets one account user profile by ID.",
"response": {
"$ref": "AccountUserProfile"
},
"flatPath": "userprofiles/{profileId}/accountUserProfiles/{id}",
"path": "userprofiles/{profileId}/accountUserProfiles/{id}",
"parameters": {
"profileId": {
"format": "int64",
"required": true,
"description": "User profile ID associated with this request.",
"location": "path",
"type": "string"
},
"id": {
"location": "path",
"required": true,
"format": "int64",
"type": "string",
"description": "User profile ID."
}
},
"parameterOrder": [
"profileId",
"id"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"patch": {
"description": "Updates an existing account user profile. This method supports patch semantics.",
"path": "userprofiles/{profileId}/accountUserProfiles",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "AccountUserProfile ID.",
"type": "string",
"location": "query",
"format": "int64",
"required": true
},
"profileId": {
"location": "path",
"type": "string",
"description": "User profile ID associated with this request.",
"format": "int64",
"required": true
}
},
"request": {
"$ref": "AccountUserProfile"
},
"id": "dfareporting.accountUserProfiles.patch",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/accountUserProfiles",
"httpMethod": "PATCH",
"response": {
"$ref": "AccountUserProfile"
}
},
"update": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "AccountUserProfile"
},
"id": "dfareporting.accountUserProfiles.update",
"description": "Updates an existing account user profile.",
"flatPath": "userprofiles/{profileId}/accountUserProfiles",
"httpMethod": "PUT",
"request": {
"$ref": "AccountUserProfile"
},
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"type": "string",
"required": true,
"location": "path",
"description": "User profile ID associated with this request.",
"format": "int64"
}
},
"path": "userprofiles/{profileId}/accountUserProfiles"
},
"list": {
"path": "userprofiles/{profileId}/accountUserProfiles",
"parameters": {
"userRoleId": {
"type": "string",
"description": "Select only user profiles with the specified user role ID.",
"location": "query",
"format": "int64"
},
"searchString": {
"description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"user profile*2015\" will return objects with names like \"user profile June 2015\", \"user profile April 2015\", or simply \"user profile 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"user profile\" will match objects with name \"my user profile\", \"user profile 2015\", or simply \"user profile\".",
"type": "string",
"location": "query"
},
"active": {
"type": "boolean",
"location": "query",
"description": "Select only active user profiles."
},
"sortOrder": {
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string",
"description": "Order of sorted results.",
"default": "ASCENDING",
"location": "query",
"enumDescriptions": [
"",
""
]
},
"sortField": {
"location": "query",
"type": "string",
"default": "ID",
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
],
"enumDescriptions": [
"",
""
]
},
"profileId": {
"location": "path",
"type": "string",
"required": true,
"format": "int64",
"description": "User profile ID associated with this request."
},
"maxResults": {
"location": "query",
"format": "int32",
"default": "1000",
"type": "integer",
"minimum": "0",
"maximum": "1000",
"description": "Maximum number of results to return."
},
"subaccountId": {
"description": "Select only user profiles with the specified subaccount ID.",
"location": "query",
"type": "string",
"format": "int64"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"location": "query",
"type": "string"
},
"ids": {
"format": "int64",
"type": "string",
"location": "query",
"description": "Select only user profiles with these IDs.",
"repeated": true
}
},
"parameterOrder": [
"profileId"
],
"description": "Retrieves a list of account user profiles, possibly filtered. This method supports paging.",
"response": {
"$ref": "AccountUserProfilesListResponse"
},
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.accountUserProfiles.list",
"flatPath": "userprofiles/{profileId}/accountUserProfiles"
}
}
},
"browsers": {
"methods": {
"list": {
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/browsers",
"parameters": {
"profileId": {
"location": "path",
"description": "User profile ID associated with this request.",
"required": true,
"type": "string",
"format": "int64"
}
},
"description": "Retrieves a list of browsers.",
"response": {
"$ref": "BrowsersListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/browsers",
"parameterOrder": [
"profileId"
],
"id": "dfareporting.browsers.list"
}
}
},
"inventoryItems": {
"methods": {
"list": {
"flatPath": "userprofiles/{profileId}/projects/{projectId}/inventoryItems",
"parameterOrder": [
"profileId",
"projectId"
],
"response": {
"$ref": "InventoryItemsListResponse"
},
"id": "dfareporting.inventoryItems.list",
"parameters": {
"maxResults": {
"maximum": "1000",
"description": "Maximum number of results to return.",
"default": "1000",
"type": "integer",
"format": "int32",
"minimum": "0",
"location": "query"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "Value of the nextPageToken from the previous result page."
},
"inPlan": {
"description": "Select only inventory items that are in plan.",
"location": "query",
"type": "boolean"
},
"sortOrder": {
"description": "Order of sorted results.",
"default": "ASCENDING",
"type": "string",
"enumDescriptions": [
"",
""
],
"location": "query",
"enum": [
"ASCENDING",
"DESCENDING"
]
},
"projectId": {
"description": "Project ID for order documents.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"ids": {
"description": "Select only inventory items with these IDs.",
"type": "string",
"repeated": true,
"format": "int64",
"location": "query"
},
"type": {
"location": "query",
"description": "Select only inventory items with this type.",
"enumDescriptions": [
"",
""
],
"enum": [
"PLANNING_PLACEMENT_TYPE_REGULAR",
"PLANNING_PLACEMENT_TYPE_CREDIT"
],
"type": "string"
},
"sortField": {
"description": "Field by which to sort the list.",
"location": "query",
"default": "ID",
"type": "string",
"enum": [
"ID",
"NAME"
],
"enumDescriptions": [
"",
""
]
},
"siteId": {
"repeated": true,
"format": "int64",
"location": "query",
"type": "string",
"description": "Select only inventory items that are associated with these sites."
},
"orderId": {
"description": "Select only inventory items that belong to specified orders.",
"repeated": true,
"location": "query",
"format": "int64",
"type": "string"
},
"profileId": {
"format": "int64",
"location": "path",
"type": "string",
"description": "User profile ID associated with this request.",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems",
"description": "Retrieves a list of inventory items, possibly filtered. This method supports paging.",
"httpMethod": "GET"
},
"get": {
"id": "dfareporting.inventoryItems.get",
"response": {
"$ref": "InventoryItem"
},
"httpMethod": "GET",
"parameters": {
"projectId": {
"description": "Project ID for order documents.",
"format": "int64",
"location": "path",
"type": "string",
"required": true
},
"id": {
"format": "int64",
"location": "path",
"type": "string",
"description": "Inventory item ID.",
"required": true
},
"profileId": {
"description": "User profile ID associated with this request.",
"type": "string",
"required": true,
"location": "path",
"format": "int64"
}
},
"parameterOrder": [
"profileId",
"projectId",
"id"
],
"flatPath": "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}",
"description": "Gets one inventory item by ID.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}"
}
}
},
"files": {
"methods": {
"get": {
"path": "reports/{reportId}/files/{fileId}",
"description": "Retrieves a report file by its report ID and file ID. This method supports media download.",
"id": "dfareporting.files.get",
"response": {
"$ref": "File"
},
"parameterOrder": [
"reportId",
"fileId"
],
"scopes": [
"https://www.googleapis.com/auth/dfareporting"
],
"supportsMediaDownload": true,
"parameters": {
"reportId": {
"required": true,
"location": "path",
"format": "int64",
"type": "string",
"description": "The ID of the report."
},
"fileId": {
"format": "int64",
"location": "path",
"type": "string",
"required": true,
"description": "The ID of the report file."
}
},
"flatPath": "reports/{reportId}/files/{fileId}",
"httpMethod": "GET"
},
"list": {
"parameterOrder": [
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/dfareporting"
],
"response": {
"$ref": "FileList"
},
"flatPath": "userprofiles/{profileId}/files",
"id": "dfareporting.files.list",
"parameters": {
"sortOrder": {
"default": "DESCENDING",
"location": "query",
"type": "string",
"enumDescriptions": [
"Ascending order.",
"Descending order."
],
"enum": [
"ASCENDING",
"DESCENDING"
],
"description": "Order of sorted results."
},
"pageToken": {
"type": "string",
"location": "query",
"description": "The value of the nextToken from the previous result page."
},
"scope": {
"enumDescriptions": [
"All files in account.",
"My files.",
"Files shared with me."
],
"location": "query",
"description": "The scope that defines which results are returned.",
"type": "string",
"enum": [
"ALL",
"MINE",
"SHARED_WITH_ME"
],
"default": "MINE"
},
"maxResults": {
"default": "10",
"description": "Maximum number of results to return.",
"maximum": "10",
"minimum": "0",
"type": "integer",
"format": "int32",
"location": "query"
},
"profileId": {
"required": true,
"format": "int64",
"description": "The Campaign Manager 360 user profile ID.",
"location": "path",
"type": "string"
},
"sortField": {
"enum": [
"ID",
"LAST_MODIFIED_TIME"
],
"location": "query",
"enumDescriptions": [
"Sort by file ID.",
"Sort by 'lastmodifiedAt' field."
],
"type": "string",
"description": "The field by which to sort the list.",
"default": "LAST_MODIFIED_TIME"
}
},
"description": "Lists files for a user profile.",
"httpMethod": "GET",
"path": "userprofiles/{profileId}/files"
}
}
},
"eventTags": {
"methods": {
"list": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "GET",
"path": "userprofiles/{profileId}/eventTags",
"id": "dfareporting.eventTags.list",
"parameters": {
"searchString": {
"type": "string",
"location": "query",
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"eventtag*2015\" will return objects with names like \"eventtag June 2015\", \"eventtag April 2015\", or simply \"eventtag 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"eventtag\" will match objects with name \"my eventtag\", \"eventtag 2015\", or simply \"eventtag\"."
},
"campaignId": {
"location": "query",
"description": "Select only event tags that belong to this campaign.",
"format": "int64",
"type": "string"
},
"sortOrder": {
"default": "ASCENDING",
"location": "query",
"enumDescriptions": [
"",
""
],
"description": "Order of sorted results.",
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string"
},
"adId": {
"format": "int64",
"location": "query",
"type": "string",
"description": "Select only event tags that belong to this ad."
},
"ids": {
"type": "string",
"description": "Select only event tags with these IDs.",
"location": "query",
"repeated": true,
"format": "int64"
},
"definitionsOnly": {
"location": "query",
"type": "boolean",
"description": "Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags."
},
"sortField": {
"default": "ID",
"enum": [
"ID",
"NAME"
],
"description": "Field by which to sort the list.",
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
},
"profileId": {
"format": "int64",
"type": "string",
"required": true,
"description": "User profile ID associated with this request.",
"location": "path"
},
"eventTagTypes": {
"enum": [
"IMPRESSION_IMAGE_EVENT_TAG",
"IMPRESSION_JAVASCRIPT_EVENT_TAG",
"CLICK_THROUGH_EVENT_TAG"
],
"location": "query",
"description": "Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.",
"type": "string",
"repeated": true,
"enumDescriptions": [
"",
"",
""
]
},
"advertiserId": {
"type": "string",
"location": "query",
"description": "Select only event tags that belong to this advertiser.",
"format": "int64"
},
"enabled": {
"location": "query",
"description": "Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.",
"type": "boolean"
}
},
"description": "Retrieves a list of event tags, possibly filtered.",
"response": {
"$ref": "EventTagsListResponse"
},
"parameterOrder": [
"profileId"
],
"flatPath": "userprofiles/{profileId}/eventTags"
},
"get": {
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/eventTags/{id}",
"id": "dfareporting.eventTags.get",
"path": "userprofiles/{profileId}/eventTags/{id}",
"parameters": {
"profileId": {
"required": true,
"format": "int64",
"description": "User profile ID associated with this request.",
"location": "path",
"type": "string"
},
"id": {
"location": "path",
"required": true,
"type": "string",
"description": "Event tag ID.",
"format": "int64"
}
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "EventTag"
},
"description": "Gets one event tag by ID.",
"parameterOrder": [
"profileId",
"id"
]
},
"patch": {
"id": "dfareporting.eventTags.patch",
"request": {
"$ref": "EventTag"
},
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/eventTags",
"description": "Updates an existing event tag. This method supports patch semantics.",
"path": "userprofiles/{profileId}/eventTags",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"location": "path",
"required": true,
"format": "int64",
"type": "string"
},
"id": {
"required": true,
"location": "query",
"description": "EventTag ID.",
"type": "string",
"format": "int64"
}
},
"response": {
"$ref": "EventTag"
},
"parameterOrder": [
"profileId",
"id"
]
},
"delete": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId",
"id"
],
"path": "userprofiles/{profileId}/eventTags/{id}",
"description": "Deletes an existing event tag.",
"httpMethod": "DELETE",
"parameters": {
"id": {
"required": true,
"location": "path",
"type": "string",
"format": "int64",
"description": "Event tag ID."
},
"profileId": {
"location": "path",
"description": "User profile ID associated with this request.",
"type": "string",
"format": "int64",
"required": true
}
},
"id": "dfareporting.eventTags.delete",
"flatPath": "userprofiles/{profileId}/eventTags/{id}"
},
"update": {
"parameterOrder": [
"profileId"
],
"flatPath": "userprofiles/{profileId}/eventTags",
"request": {
"$ref": "EventTag"
},
"httpMethod": "PUT",
"id": "dfareporting.eventTags.update",
"parameters": {
"profileId": {
"location": "path",
"type": "string",
"description": "User profile ID associated with this request.",
"format": "int64",
"required": true
}
},
"description": "Updates an existing event tag.",
"response": {
"$ref": "EventTag"
},
"path": "userprofiles/{profileId}/eventTags",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"insert": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "EventTag"
},
"httpMethod": "POST",
"id": "dfareporting.eventTags.insert",
"parameters": {
"profileId": {
"type": "string",
"description": "User profile ID associated with this request.",
"location": "path",
"required": true,
"format": "int64"
}
},
"description": "Inserts a new event tag.",
"request": {
"$ref": "EventTag"
},
"parameterOrder": [
"profileId"
],
"flatPath": "userprofiles/{profileId}/eventTags",
"path": "userprofiles/{profileId}/eventTags"
}
}
},
"orderDocuments": {
"methods": {
"get": {
"id": "dfareporting.orderDocuments.get",
"response": {
"$ref": "OrderDocument"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Gets one order document by ID.",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"type": "string",
"location": "path",
"required": true,
"format": "int64"
},
"id": {
"required": true,
"format": "int64",
"location": "path",
"description": "Order document ID.",
"type": "string"
},
"projectId": {
"format": "int64",
"description": "Project ID for order documents.",
"required": true,
"type": "string",
"location": "path"
}
},
"parameterOrder": [
"profileId",
"projectId",
"id"
],
"flatPath": "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}",
"path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}",
"httpMethod": "GET"
},
"list": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/projects/{projectId}/orderDocuments",
"response": {
"$ref": "OrderDocumentsListResponse"
},
"id": "dfareporting.orderDocuments.list",
"description": "Retrieves a list of order documents, possibly filtered. This method supports paging.",
"parameterOrder": [
"profileId",
"projectId"
],
"httpMethod": "GET",
"parameters": {
"searchString": {
"location": "query",
"description": "Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, \"orderdocument*2015\" will return order documents with names like \"orderdocument June 2015\", \"orderdocument April 2015\", or simply \"orderdocument 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"orderdocument\" will match order documents with name \"my orderdocument\", \"orderdocument 2015\", or simply \"orderdocument\".",
"type": "string"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"location": "query",
"type": "string"
},
"ids": {
"location": "query",
"repeated": true,
"format": "int64",
"type": "string",
"description": "Select only order documents with these IDs."
},
"profileId": {
"description": "User profile ID associated with this request.",
"location": "path",
"required": true,
"type": "string",
"format": "int64"
},
"sortField": {
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
],
"type": "string",
"default": "ID",
"enumDescriptions": [
"",
""
],
"location": "query"
},
"orderId": {
"type": "string",
"description": "Select only order documents for specified orders.",
"format": "int64",
"location": "query",
"repeated": true
},
"projectId": {
"description": "Project ID for order documents.",
"required": true,
"type": "string",
"format": "int64",
"location": "path"
},
"siteId": {
"format": "int64",
"type": "string",
"location": "query",
"description": "Select only order documents that are associated with these sites.",
"repeated": true
},
"maxResults": {
"default": "1000",
"minimum": "0",
"format": "int32",
"location": "query",
"description": "Maximum number of results to return.",
"maximum": "1000",
"type": "integer"
},
"sortOrder": {
"type": "string",
"description": "Order of sorted results.",
"enumDescriptions": [
"",
""
],
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
],
"location": "query"
},
"approved": {
"type": "boolean",
"description": "Select only order documents that have been approved by at least one user.",
"location": "query"
}
},
"path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments"
}
}
},
"dynamicTargetingKeys": {
"methods": {
"insert": {
"parameters": {
"profileId": {
"required": true,
"location": "path",
"type": "string",
"format": "int64",
"description": "User profile ID associated with this request."
}
},
"description": "Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.",
"request": {
"$ref": "DynamicTargetingKey"
},
"flatPath": "userprofiles/{profileId}/dynamicTargetingKeys",
"path": "userprofiles/{profileId}/dynamicTargetingKeys",
"parameterOrder": [
"profileId"
],
"id": "dfareporting.dynamicTargetingKeys.insert",
"httpMethod": "POST",
"response": {
"$ref": "DynamicTargetingKey"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves a list of dynamic targeting keys.",
"path": "userprofiles/{profileId}/dynamicTargetingKeys",
"parameterOrder": [
"profileId"
],
"response": {
"$ref": "DynamicTargetingKeysListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/dynamicTargetingKeys",
"id": "dfareporting.dynamicTargetingKeys.list",
"parameters": {
"names": {
"description": "Select only dynamic targeting keys exactly matching these names.",
"repeated": true,
"location": "query",
"type": "string"
},
"objectType": {
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"OBJECT_ADVERTISER",
"OBJECT_AD",
"OBJECT_CREATIVE",
"OBJECT_PLACEMENT"
],
"location": "query",
"description": "Select only dynamic targeting keys with this object type.",
"type": "string"
},
"objectId": {
"format": "int64",
"description": "Select only dynamic targeting keys with this object ID.",
"type": "string",
"location": "query"
},
"advertiserId": {
"format": "int64",
"type": "string",
"description": "Select only dynamic targeting keys whose object has this advertiser ID.",
"location": "query"
},
"profileId": {
"description": "User profile ID associated with this request.",
"required": true,
"location": "path",
"format": "int64",
"type": "string"
}
},
"httpMethod": "GET"
},
"delete": {
"id": "dfareporting.dynamicTargetingKeys.delete",
"description": "Deletes an existing dynamic targeting key.",
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"required": true,
"location": "path",
"type": "string",
"description": "User profile ID associated with this request.",
"format": "int64"
},
"objectType": {
"description": "Type of the object of this dynamic targeting key. This is a required field.",
"required": true,
"location": "query",
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"OBJECT_ADVERTISER",
"OBJECT_AD",
"OBJECT_CREATIVE",
"OBJECT_PLACEMENT"
],
"type": "string"
},
"objectId": {
"format": "int64",
"description": "ID of the object of this dynamic targeting key. This is a required field.",
"required": true,
"type": "string",
"location": "path"
},
"name": {
"description": "Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.",
"required": true,
"type": "string",
"location": "query"
}
},
"flatPath": "userprofiles/{profileId}/dynamicTargetingKeys/{objectId}",
"path": "userprofiles/{profileId}/dynamicTargetingKeys/{objectId}",
"parameterOrder": [
"profileId",
"objectId",
"name",
"objectType"
]
}
}
},
"userRoles": {
"methods": {
"get": {
"response": {
"$ref": "UserRole"
},
"parameterOrder": [
"profileId",
"id"
],
"id": "dfareporting.userRoles.get",
"httpMethod": "GET",
"path": "userprofiles/{profileId}/userRoles/{id}",
"flatPath": "userprofiles/{profileId}/userRoles/{id}",
"description": "Gets one user role by ID.",
"parameters": {
"id": {
"description": "User role ID.",
"format": "int64",
"location": "path",
"type": "string",
"required": true
},
"profileId": {
"required": true,
"format": "int64",
"location": "path",
"type": "string",
"description": "User profile ID associated with this request."
}
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"patch": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "PATCH",
"flatPath": "userprofiles/{profileId}/userRoles",
"description": "Updates an existing user role. This method supports patch semantics.",
"path": "userprofiles/{profileId}/userRoles",
"response": {
"$ref": "UserRole"
},
"id": "dfareporting.userRoles.patch",
"request": {
"$ref": "UserRole"
},
"parameters": {
"id": {
"description": "UserRole ID.",
"required": true,
"location": "query",
"format": "int64",
"type": "string"
},
"profileId": {
"location": "path",
"type": "string",
"format": "int64",
"description": "User profile ID associated with this request.",
"required": true
}
},
"parameterOrder": [
"profileId",
"id"
]
},
"insert": {
"response": {
"$ref": "UserRole"
},
"id": "dfareporting.userRoles.insert",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"type": "string",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"profileId"
],
"httpMethod": "POST",
"path": "userprofiles/{profileId}/userRoles",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Inserts a new user role.",
"request": {
"$ref": "UserRole"
},
"flatPath": "userprofiles/{profileId}/userRoles"
},
"list": {
"response": {
"$ref": "UserRolesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "GET",
"path": "userprofiles/{profileId}/userRoles",
"flatPath": "userprofiles/{profileId}/userRoles",
"parameters": {
"sortField": {
"enum": [
"ID",
"NAME"
],
"enumDescriptions": [
"",
""
],
"description": "Field by which to sort the list.",
"default": "ID",
"type": "string",
"location": "query"
},
"sortOrder": {
"enumDescriptions": [
"",
""
],
"description": "Order of sorted results.",
"type": "string",
"location": "query",
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
]
},
"profileId": {
"type": "string",
"format": "int64",
"required": true,
"description": "User profile ID associated with this request.",
"location": "path"
},
"accountUserRoleOnly": {
"type": "boolean",
"location": "query",
"description": "Select only account level user roles not associated with any specific subaccount."
},
"ids": {
"description": "Select only user roles with the specified IDs.",
"repeated": true,
"format": "int64",
"type": "string",
"location": "query"
},
"subaccountId": {
"format": "int64",
"description": "Select only user roles that belong to this subaccount.",
"location": "query",
"type": "string"
},
"pageToken": {
"type": "string",
"description": "Value of the nextPageToken from the previous result page.",
"location": "query"
},
"maxResults": {
"location": "query",
"format": "int32",
"description": "Maximum number of results to return.",
"default": "1000",
"maximum": "1000",
"type": "integer",
"minimum": "0"
},
"searchString": {
"type": "string",
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"userrole*2015\" will return objects with names like \"userrole June 2015\", \"userrole April 2015\", or simply \"userrole 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"userrole\" will match objects with name \"my userrole\", \"userrole 2015\", or simply \"userrole\".",
"location": "query"
}
},
"id": "dfareporting.userRoles.list",
"parameterOrder": [
"profileId"
],
"description": "Retrieves a list of user roles, possibly filtered. This method supports paging."
},
"delete": {
"flatPath": "userprofiles/{profileId}/userRoles/{id}",
"id": "dfareporting.userRoles.delete",
"httpMethod": "DELETE",
"path": "userprofiles/{profileId}/userRoles/{id}",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"format": "int64",
"required": true,
"location": "path",
"type": "string",
"description": "User role ID."
},
"profileId": {
"description": "User profile ID associated with this request.",
"required": true,
"format": "int64",
"type": "string",
"location": "path"
}
},
"description": "Deletes an existing user role.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"update": {
"response": {
"$ref": "UserRole"
},
"path": "userprofiles/{profileId}/userRoles",
"parameterOrder": [
"profileId"
],
"request": {
"$ref": "UserRole"
},
"description": "Updates an existing user role.",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"location": "path",
"required": true,
"format": "int64",
"type": "string"
}
},
"id": "dfareporting.userRoles.update",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "PUT",
"flatPath": "userprofiles/{profileId}/userRoles"
}
}
},
"ads": {
"methods": {
"patch": {
"id": "dfareporting.ads.patch",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "PATCH",
"request": {
"$ref": "Ad"
},
"parameterOrder": [
"profileId",
"id"
],
"response": {
"$ref": "Ad"
},
"flatPath": "userprofiles/{profileId}/ads",
"path": "userprofiles/{profileId}/ads",
"description": "Updates an existing ad. This method supports patch semantics.",
"parameters": {
"profileId": {
"location": "path",
"description": "User profile ID associated with this request.",
"type": "string",
"required": true,
"format": "int64"
},
"id": {
"type": "string",
"format": "int64",
"location": "query",
"required": true,
"description": "Ad ID."
}
}
},
"update": {
"path": "userprofiles/{profileId}/ads",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "PUT",
"flatPath": "userprofiles/{profileId}/ads",
"description": "Updates an existing ad.",
"parameters": {
"profileId": {
"location": "path",
"description": "User profile ID associated with this request.",
"format": "int64",
"type": "string",
"required": true
}
},
"id": "dfareporting.ads.update",
"response": {
"$ref": "Ad"
},
"parameterOrder": [
"profileId"
],
"request": {
"$ref": "Ad"
}
},
"list": {
"parameterOrder": [
"profileId"
],
"description": "Retrieves a list of ads, possibly filtered. This method supports paging.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"type": "string",
"required": true,
"location": "path",
"description": "User profile ID associated with this request.",
"format": "int64"
},
"sslRequired": {
"type": "boolean",
"location": "query",
"description": "Select only ads that require SSL."
},
"overriddenEventTagId": {
"format": "int64",
"type": "string",
"location": "query",
"description": "Select only ads with this event tag override ID."
},
"type": {
"description": "Select only ads with these types.",
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string",
"repeated": true,
"location": "query",
"enum": [
"AD_SERVING_STANDARD_AD",
"AD_SERVING_DEFAULT_AD",
"AD_SERVING_CLICK_TRACKER",
"AD_SERVING_TRACKING",
"AD_SERVING_BRAND_SAFE_AD"
]
},
"sslCompliant": {
"description": "Select only ads that are SSL-compliant.",
"type": "boolean",
"location": "query"
},
"creativeIds": {
"repeated": true,
"description": "Select only ads with these creative IDs assigned.",
"format": "int64",
"location": "query",
"type": "string"
},
"compatibility": {
"type": "string",
"enum": [
"DISPLAY",
"DISPLAY_INTERSTITIAL",
"APP",
"APP_INTERSTITIAL",
"IN_STREAM_VIDEO",
"IN_STREAM_AUDIO"
],
"description": "Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.",
"location": "query",
"enumDescriptions": [
"",
"",
"",
"",
"",
""
]
},
"audienceSegmentIds": {
"format": "int64",
"repeated": true,
"type": "string",
"location": "query",
"description": "Select only ads with these audience segment IDs."
},
"ids": {
"repeated": true,
"format": "int64",
"location": "query",
"description": "Select only ads with these IDs.",
"type": "string"
},
"searchString": {
"type": "string",
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"ad*2015\" will return objects with names like \"ad June 2015\", \"ad April 2015\", or simply \"ad 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"ad\" will match objects with name \"my ad\", \"ad 2015\", or simply \"ad\".",
"location": "query"
},
"dynamicClickTracker": {
"description": "Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.",
"type": "boolean",
"location": "query"
},
"sizeIds": {
"repeated": true,
"type": "string",
"description": "Select only ads with these size IDs.",
"location": "query",
"format": "int64"
},
"sortOrder": {
"location": "query",
"type": "string",
"enumDescriptions": [
"",
""
],
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
],
"description": "Order of sorted results."
},
"creativeOptimizationConfigurationIds": {
"description": "Select only ads with these creative optimization configuration IDs.",
"location": "query",
"repeated": true,
"type": "string",
"format": "int64"
},
"remarketingListIds": {
"format": "int64",
"repeated": true,
"location": "query",
"type": "string",
"description": "Select only ads whose list targeting expression use these remarketing list IDs."
},
"campaignIds": {
"format": "int64",
"description": "Select only ads with these campaign IDs.",
"location": "query",
"repeated": true,
"type": "string"
},
"maxResults": {
"type": "integer",
"maximum": "1000",
"description": "Maximum number of results to return.",
"minimum": "0",
"default": "1000",
"location": "query",
"format": "int32"
},
"active": {
"type": "boolean",
"location": "query",
"description": "Select only active ads."
},
"sortField": {
"enumDescriptions": [
"",
""
],
"default": "ID",
"location": "query",
"enum": [
"ID",
"NAME"
],
"description": "Field by which to sort the list.",
"type": "string"
},
"placementIds": {
"description": "Select only ads with these placement IDs assigned.",
"repeated": true,
"location": "query",
"type": "string",
"format": "int64"
},
"landingPageIds": {
"description": "Select only ads with these landing page IDs.",
"location": "query",
"repeated": true,
"format": "int64",
"type": "string"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"location": "query",
"type": "string"
},
"advertiserId": {
"location": "query",
"format": "int64",
"description": "Select only ads with this advertiser ID.",
"type": "string"
},
"archived": {
"description": "Select only archived ads.",
"location": "query",
"type": "boolean"
}
},
"httpMethod": "GET",
"id": "dfareporting.ads.list",
"response": {
"$ref": "AdsListResponse"
},
"path": "userprofiles/{profileId}/ads",
"flatPath": "userprofiles/{profileId}/ads"
},
"insert": {
"parameters": {
"profileId": {
"location": "path",
"type": "string",
"required": true,
"description": "User profile ID associated with this request.",
"format": "int64"
}
},
"httpMethod": "POST",
"request": {
"$ref": "Ad"
},
"parameterOrder": [
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "Ad"
},
"description": "Inserts a new ad.",
"id": "dfareporting.ads.insert",
"path": "userprofiles/{profileId}/ads",
"flatPath": "userprofiles/{profileId}/ads"
},
"get": {
"response": {
"$ref": "Ad"
},
"httpMethod": "GET",
"id": "dfareporting.ads.get",
"description": "Gets one ad by ID.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/ads/{id}",
"path": "userprofiles/{profileId}/ads/{id}",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"type": "string",
"location": "path",
"description": "Ad ID.",
"required": true,
"format": "int64"
},
"profileId": {
"format": "int64",
"location": "path",
"description": "User profile ID associated with this request.",
"required": true,
"type": "string"
}
}
}
}
},
"creativeFieldValues": {
"methods": {
"update": {
"httpMethod": "PUT",
"path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
"flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
"response": {
"$ref": "CreativeFieldValue"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Updates an existing creative field value.",
"parameters": {
"profileId": {
"required": true,
"format": "int64",
"location": "path",
"type": "string",
"description": "User profile ID associated with this request."
},
"creativeFieldId": {
"required": true,
"location": "path",
"type": "string",
"description": "Creative field ID for this creative field value.",
"format": "int64"
}
},
"parameterOrder": [
"profileId",
"creativeFieldId"
],
"request": {
"$ref": "CreativeFieldValue"
},
"id": "dfareporting.creativeFieldValues.update"
},
"patch": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"request": {
"$ref": "CreativeFieldValue"
},
"description": "Updates an existing creative field value. This method supports patch semantics.",
"path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
"parameters": {
"creativeFieldId": {
"required": true,
"description": "CreativeField ID.",
"type": "string",
"format": "int64",
"location": "path"
},
"profileId": {
"description": "User profile ID associated with this request.",
"location": "path",
"type": "string",
"format": "int64",
"required": true
},
"id": {
"format": "int64",
"type": "string",
"required": true,
"location": "query",
"description": "CreativeFieldValue ID."
}
},
"parameterOrder": [
"profileId",
"creativeFieldId",
"id"
],
"httpMethod": "PATCH",
"flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
"id": "dfareporting.creativeFieldValues.patch",
"response": {
"$ref": "CreativeFieldValue"
}
},
"insert": {
"id": "dfareporting.creativeFieldValues.insert",
"parameters": {
"creativeFieldId": {
"format": "int64",
"required": true,
"type": "string",
"location": "path",
"description": "Creative field ID for this creative field value."
},
"profileId": {
"type": "string",
"required": true,
"location": "path",
"description": "User profile ID associated with this request.",
"format": "int64"
}
},
"httpMethod": "POST",
"description": "Inserts a new creative field value.",
"path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
"flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
"parameterOrder": [
"profileId",
"creativeFieldId"
],
"request": {
"$ref": "CreativeFieldValue"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "CreativeFieldValue"
}
},
"get": {
"response": {
"$ref": "CreativeFieldValue"
},
"id": "dfareporting.creativeFieldValues.get",
"path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId",
"creativeFieldId",
"id"
],
"parameters": {
"id": {
"description": "Creative Field Value ID",
"required": true,
"location": "path",
"format": "int64",
"type": "string"
},
"creativeFieldId": {
"location": "path",
"format": "int64",
"type": "string",
"required": true,
"description": "Creative field ID for this creative field value."
},
"profileId": {
"description": "User profile ID associated with this request.",
"required": true,
"format": "int64",
"type": "string",
"location": "path"
}
},
"description": "Gets one creative field value by ID."
},
"delete": {
"flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
"description": "Deletes an existing creative field value.",
"path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
"parameterOrder": [
"profileId",
"creativeFieldId",
"id"
],
"parameters": {
"id": {
"description": "Creative Field Value ID",
"required": true,
"format": "int64",
"type": "string",
"location": "path"
},
"creativeFieldId": {
"type": "string",
"format": "int64",
"required": true,
"description": "Creative field ID for this creative field value.",
"location": "path"
},
"profileId": {
"type": "string",
"description": "User profile ID associated with this request.",
"required": true,
"format": "int64",
"location": "path"
}
},
"id": "dfareporting.creativeFieldValues.delete",
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"id": "dfareporting.creativeFieldValues.list",
"description": "Retrieves a list of creative field values, possibly filtered. This method supports paging.",
"flatPath": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
"httpMethod": "GET",
"path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
"parameters": {
"searchString": {
"description": "Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.",
"location": "query",
"type": "string"
},
"ids": {
"format": "int64",
"location": "query",
"description": "Select only creative field values with these IDs.",
"repeated": true,
"type": "string"
},
"sortOrder": {
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string",
"description": "Order of sorted results.",
"location": "query",
"enumDescriptions": [
"",
""
],
"default": "ASCENDING"
},
"profileId": {
"type": "string",
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true
},
"sortField": {
"default": "ID",
"type": "string",
"enumDescriptions": [
"",
""
],
"location": "query",
"enum": [
"ID",
"VALUE"
],
"description": "Field by which to sort the list."
},
"maxResults": {
"maximum": "1000",
"default": "1000",
"description": "Maximum number of results to return.",
"type": "integer",
"format": "int32",
"location": "query",
"minimum": "0"
},
"creativeFieldId": {
"required": true,
"type": "string",
"format": "int64",
"location": "path",
"description": "Creative field ID for this creative field value."
},
"pageToken": {
"location": "query",
"type": "string",
"description": "Value of the nextPageToken from the previous result page."
}
},
"parameterOrder": [
"profileId",
"creativeFieldId"
],
"response": {
"$ref": "CreativeFieldValuesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"creativeFields": {
"methods": {
"patch": {
"request": {
"$ref": "CreativeField"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.creativeFields.patch",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"location": "path",
"format": "int64",
"required": true,
"type": "string"
},
"id": {
"description": "CreativeField ID.",
"format": "int64",
"required": true,
"type": "string",
"location": "query"
}
},
"path": "userprofiles/{profileId}/creativeFields",
"response": {
"$ref": "CreativeField"
},
"httpMethod": "PATCH",
"description": "Updates an existing creative field. This method supports patch semantics.",
"flatPath": "userprofiles/{profileId}/creativeFields",
"parameterOrder": [
"profileId",
"id"
]
},
"get": {
"id": "dfareporting.creativeFields.get",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "CreativeField"
},
"parameters": {
"id": {
"format": "int64",
"description": "Creative Field ID",
"location": "path",
"type": "string",
"required": true
},
"profileId": {
"type": "string",
"description": "User profile ID associated with this request.",
"location": "path",
"required": true,
"format": "int64"
}
},
"path": "userprofiles/{profileId}/creativeFields/{id}",
"description": "Gets one creative field by ID.",
"parameterOrder": [
"profileId",
"id"
],
"flatPath": "userprofiles/{profileId}/creativeFields/{id}",
"httpMethod": "GET"
},
"insert": {
"request": {
"$ref": "CreativeField"
},
"parameterOrder": [
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"type": "string",
"required": true,
"location": "path",
"format": "int64"
}
},
"response": {
"$ref": "CreativeField"
},
"httpMethod": "POST",
"flatPath": "userprofiles/{profileId}/creativeFields",
"description": "Inserts a new creative field.",
"id": "dfareporting.creativeFields.insert",
"path": "userprofiles/{profileId}/creativeFields"
},
"list": {
"id": "dfareporting.creativeFields.list",
"flatPath": "userprofiles/{profileId}/creativeFields",
"response": {
"$ref": "CreativeFieldsListResponse"
},
"path": "userprofiles/{profileId}/creativeFields",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId"
],
"description": "Retrieves a list of creative fields, possibly filtered. This method supports paging.",
"httpMethod": "GET",
"parameters": {
"advertiserIds": {
"repeated": true,
"format": "int64",
"location": "query",
"description": "Select only creative fields that belong to these advertisers.",
"type": "string"
},
"maxResults": {
"description": "Maximum number of results to return.",
"maximum": "1000",
"format": "int32",
"default": "1000",
"location": "query",
"type": "integer",
"minimum": "0"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "Value of the nextPageToken from the previous result page."
},
"profileId": {
"location": "path",
"description": "User profile ID associated with this request.",
"format": "int64",
"required": true,
"type": "string"
},
"searchString": {
"location": "query",
"type": "string",
"description": "Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, \"creativefield*2015\" will return creative fields with names like \"creativefield June 2015\", \"creativefield April 2015\", or simply \"creativefield 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativefield\" will match creative fields with the name \"my creativefield\", \"creativefield 2015\", or simply \"creativefield\"."
},
"sortOrder": {
"description": "Order of sorted results.",
"type": "string",
"enumDescriptions": [
"",
""
],
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
],
"location": "query"
},
"ids": {
"description": "Select only creative fields with these IDs.",
"type": "string",
"location": "query",
"repeated": true,
"format": "int64"
},
"sortField": {
"type": "string",
"location": "query",
"default": "ID",
"enumDescriptions": [
"",
""
],
"enum": [
"ID",
"NAME"
],
"description": "Field by which to sort the list."
}
}
},
"update": {
"parameterOrder": [
"profileId"
],
"description": "Updates an existing creative field.",
"response": {
"$ref": "CreativeField"
},
"path": "userprofiles/{profileId}/creativeFields",
"parameters": {
"profileId": {
"type": "string",
"location": "path",
"required": true,
"format": "int64",
"description": "User profile ID associated with this request."
}
},
"request": {
"$ref": "CreativeField"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.creativeFields.update",
"httpMethod": "PUT",
"flatPath": "userprofiles/{profileId}/creativeFields"
},
"delete": {
"parameterOrder": [
"profileId",
"id"
],
"id": "dfareporting.creativeFields.delete",
"description": "Deletes an existing creative field.",
"parameters": {
"id": {
"format": "int64",
"description": "Creative Field ID",
"location": "path",
"type": "string",
"required": true
},
"profileId": {
"format": "int64",
"required": true,
"location": "path",
"type": "string",
"description": "User profile ID associated with this request."
}
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/creativeFields/{id}",
"path": "userprofiles/{profileId}/creativeFields/{id}",
"httpMethod": "DELETE"
}
}
},
"advertiserGroups": {
"methods": {
"delete": {
"path": "userprofiles/{profileId}/advertiserGroups/{id}",
"description": "Deletes an existing advertiser group.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.advertiserGroups.delete",
"httpMethod": "DELETE",
"flatPath": "userprofiles/{profileId}/advertiserGroups/{id}",
"parameters": {
"profileId": {
"location": "path",
"description": "User profile ID associated with this request.",
"required": true,
"type": "string",
"format": "int64"
},
"id": {
"location": "path",
"description": "Advertiser group ID.",
"type": "string",
"required": true,
"format": "int64"
}
},
"parameterOrder": [
"profileId",
"id"
]
},
"update": {
"httpMethod": "PUT",
"description": "Updates an existing advertiser group.",
"path": "userprofiles/{profileId}/advertiserGroups",
"parameterOrder": [
"profileId"
],
"request": {
"$ref": "AdvertiserGroup"
},
"flatPath": "userprofiles/{profileId}/advertiserGroups",
"parameters": {
"profileId": {
"location": "path",
"description": "User profile ID associated with this request.",
"type": "string",
"required": true,
"format": "int64"
}
},
"response": {
"$ref": "AdvertiserGroup"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.advertiserGroups.update"
},
"patch": {
"parameters": {
"profileId": {
"type": "string",
"location": "path",
"description": "User profile ID associated with this request.",
"format": "int64",
"required": true
},
"id": {
"required": true,
"format": "int64",
"description": "AdvertiserGroup ID.",
"location": "query",
"type": "string"
}
},
"description": "Updates an existing advertiser group. This method supports patch semantics.",
"flatPath": "userprofiles/{profileId}/advertiserGroups",
"httpMethod": "PATCH",
"id": "dfareporting.advertiserGroups.patch",
"parameterOrder": [
"profileId",
"id"
],
"path": "userprofiles/{profileId}/advertiserGroups",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"request": {
"$ref": "AdvertiserGroup"
},
"response": {
"$ref": "AdvertiserGroup"
}
},
"list": {
"parameters": {
"maxResults": {
"description": "Maximum number of results to return.",
"location": "query",
"minimum": "0",
"default": "1000",
"type": "integer",
"format": "int32",
"maximum": "1000"
},
"pageToken": {
"location": "query",
"description": "Value of the nextPageToken from the previous result page.",
"type": "string"
},
"sortField": {
"enumDescriptions": [
"",
""
],
"enum": [
"ID",
"NAME"
],
"default": "ID",
"type": "string",
"location": "query",
"description": "Field by which to sort the list."
},
"searchString": {
"location": "query",
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser group June 2015\", \"advertiser group April 2015\", or simply \"advertiser group 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertisergroup\" will match objects with name \"my advertisergroup\", \"advertisergroup 2015\", or simply \"advertisergroup\".",
"type": "string"
},
"sortOrder": {
"location": "query",
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string",
"enumDescriptions": [
"",
""
],
"default": "ASCENDING",
"description": "Order of sorted results."
},
"ids": {
"description": "Select only advertiser groups with these IDs.",
"type": "string",
"location": "query",
"repeated": true,
"format": "int64"
},
"profileId": {
"description": "User profile ID associated with this request.",
"required": true,
"format": "int64",
"location": "path",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId"
],
"id": "dfareporting.advertiserGroups.list",
"flatPath": "userprofiles/{profileId}/advertiserGroups",
"response": {
"$ref": "AdvertiserGroupsListResponse"
},
"httpMethod": "GET",
"description": "Retrieves a list of advertiser groups, possibly filtered. This method supports paging.",
"path": "userprofiles/{profileId}/advertiserGroups"
},
"insert": {
"path": "userprofiles/{profileId}/advertiserGroups",
"parameterOrder": [
"profileId"
],
"flatPath": "userprofiles/{profileId}/advertiserGroups",
"httpMethod": "POST",
"parameters": {
"profileId": {
"location": "path",
"format": "int64",
"description": "User profile ID associated with this request.",
"type": "string",
"required": true
}
},
"description": "Inserts a new advertiser group.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.advertiserGroups.insert",
"response": {
"$ref": "AdvertiserGroup"
},
"request": {
"$ref": "AdvertiserGroup"
}
},
"get": {
"httpMethod": "GET",
"description": "Gets one advertiser group by ID.",
"id": "dfareporting.advertiserGroups.get",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/advertiserGroups/{id}",
"parameters": {
"id": {
"type": "string",
"required": true,
"format": "int64",
"description": "Advertiser group ID.",
"location": "path"
},
"profileId": {
"type": "string",
"format": "int64",
"required": true,
"description": "User profile ID associated with this request.",
"location": "path"
}
},
"response": {
"$ref": "AdvertiserGroup"
},
"flatPath": "userprofiles/{profileId}/advertiserGroups/{id}",
"parameterOrder": [
"profileId",
"id"
]
}
}
},
"creatives": {
"methods": {
"update": {
"description": "Updates an existing creative.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "Creative"
},
"request": {
"$ref": "Creative"
},
"httpMethod": "PUT",
"path": "userprofiles/{profileId}/creatives",
"parameters": {
"profileId": {
"required": true,
"description": "User profile ID associated with this request.",
"location": "path",
"type": "string",
"format": "int64"
}
},
"flatPath": "userprofiles/{profileId}/creatives",
"id": "dfareporting.creatives.update",
"parameterOrder": [
"profileId"
]
},
"insert": {
"path": "userprofiles/{profileId}/creatives",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId"
],
"response": {
"$ref": "Creative"
},
"parameters": {
"profileId": {
"location": "path",
"description": "User profile ID associated with this request.",
"type": "string",
"format": "int64",
"required": true
}
},
"id": "dfareporting.creatives.insert",
"description": "Inserts a new creative.",
"flatPath": "userprofiles/{profileId}/creatives",
"request": {
"$ref": "Creative"
}
},
"list": {
"path": "userprofiles/{profileId}/creatives",
"parameterOrder": [
"profileId"
],
"description": "Retrieves a list of creatives, possibly filtered. This method supports paging.",
"flatPath": "userprofiles/{profileId}/creatives",
"id": "dfareporting.creatives.list",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"sortOrder": {
"type": "string",
"default": "ASCENDING",
"enumDescriptions": [
"",
""
],
"description": "Order of sorted results.",
"enum": [
"ASCENDING",
"DESCENDING"
],
"location": "query"
},
"sortField": {
"enum": [
"ID",
"NAME"
],
"default": "ID",
"type": "string",
"description": "Field by which to sort the list.",
"enumDescriptions": [
"",
""
],
"location": "query"
},
"archived": {
"type": "boolean",
"description": "Select only archived creatives. Leave blank to select archived and unarchived creatives.",
"location": "query"
},
"renderingIds": {
"repeated": true,
"format": "int64",
"description": "Select only creatives with these rendering IDs.",
"location": "query",
"type": "string"
},
"studioCreativeId": {
"description": "Select only creatives corresponding to this Studio creative ID.",
"type": "string",
"format": "int64",
"location": "query"
},
"creativeFieldIds": {
"repeated": true,
"type": "string",
"description": "Select only creatives with these creative field IDs.",
"format": "int64",
"location": "query"
},
"searchString": {
"type": "string",
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"creative*2015\" will return objects with names like \"creative June 2015\", \"creative April 2015\", or simply \"creative 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"creative\" will match objects with name \"my creative\", \"creative 2015\", or simply \"creative\".",
"location": "query"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "Value of the nextPageToken from the previous result page."
},
"sizeIds": {
"format": "int64",
"description": "Select only creatives with these size IDs.",
"repeated": true,
"location": "query",
"type": "string"
},
"profileId": {
"type": "string",
"location": "path",
"required": true,
"description": "User profile ID associated with this request.",
"format": "int64"
},
"maxResults": {
"description": "Maximum number of results to return.",
"location": "query",
"default": "1000",
"format": "int32",
"maximum": "1000",
"minimum": "0",
"type": "integer"
},
"active": {
"description": "Select only active creatives. Leave blank to select active and inactive creatives.",
"type": "boolean",
"location": "query"
},
"types": {
"enum": [
"IMAGE",
"DISPLAY_REDIRECT",
"CUSTOM_DISPLAY",
"INTERNAL_REDIRECT",
"CUSTOM_DISPLAY_INTERSTITIAL",
"INTERSTITIAL_INTERNAL_REDIRECT",
"TRACKING_TEXT",
"RICH_MEDIA_DISPLAY_BANNER",
"RICH_MEDIA_INPAGE_FLOATING",
"RICH_MEDIA_IM_EXPAND",
"RICH_MEDIA_DISPLAY_EXPANDING",
"RICH_MEDIA_DISPLAY_INTERSTITIAL",
"RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL",
"RICH_MEDIA_MOBILE_IN_APP",
"FLASH_INPAGE",
"INSTREAM_VIDEO",
"VPAID_LINEAR_VIDEO",
"VPAID_NON_LINEAR_VIDEO",
"INSTREAM_VIDEO_REDIRECT",
"RICH_MEDIA_PEEL_DOWN",
"HTML5_BANNER",
"DISPLAY",
"DISPLAY_IMAGE_GALLERY",
"BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
"INSTREAM_AUDIO"
],
"description": "Select only creatives with these creative types.",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"repeated": true,
"type": "string",
"location": "query"
},
"campaignId": {
"location": "query",
"description": "Select only creatives with this campaign ID.",
"type": "string",
"format": "int64"
},
"companionCreativeIds": {
"description": "Select only in-stream video creatives with these companion IDs.",
"repeated": true,
"location": "query",
"type": "string",
"format": "int64"
},
"advertiserId": {
"format": "int64",
"type": "string",
"description": "Select only creatives with this advertiser ID.",
"location": "query"
},
"ids": {
"description": "Select only creatives with these IDs.",
"type": "string",
"format": "int64",
"repeated": true,
"location": "query"
}
},
"httpMethod": "GET",
"response": {
"$ref": "CreativesListResponse"
}
},
"patch": {
"parameterOrder": [
"profileId",
"id"
],
"httpMethod": "PATCH",
"parameters": {
"id": {
"location": "query",
"type": "string",
"format": "int64",
"required": true,
"description": "Creative ID."
},
"profileId": {
"location": "path",
"required": true,
"type": "string",
"description": "User profile ID associated with this request.",
"format": "int64"
}
},
"description": "Updates an existing creative. This method supports patch semantics.",
"path": "userprofiles/{profileId}/creatives",
"response": {
"$ref": "Creative"
},
"flatPath": "userprofiles/{profileId}/creatives",
"id": "dfareporting.creatives.patch",
"request": {
"$ref": "Creative"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"get": {
"parameters": {
"profileId": {
"location": "path",
"format": "int64",
"required": true,
"description": "User profile ID associated with this request.",
"type": "string"
},
"id": {
"description": "Creative ID.",
"required": true,
"format": "int64",
"type": "string",
"location": "path"
}
},
"parameterOrder": [
"profileId",
"id"
],
"description": "Gets one creative by ID.",
"response": {
"$ref": "Creative"
},
"path": "userprofiles/{profileId}/creatives/{id}",
"id": "dfareporting.creatives.get",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/creatives/{id}",
"httpMethod": "GET"
}
}
},
"remarketingLists": {
"methods": {
"update": {
"request": {
"$ref": "RemarketingList"
},
"httpMethod": "PUT",
"flatPath": "userprofiles/{profileId}/remarketingLists",
"path": "userprofiles/{profileId}/remarketingLists",
"description": "Updates an existing remarketing list.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "RemarketingList"
},
"id": "dfareporting.remarketingLists.update",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"required": true,
"location": "path",
"type": "string",
"format": "int64",
"description": "User profile ID associated with this request."
}
}
},
"list": {
"parameterOrder": [
"profileId",
"advertiserId"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Retrieves a list of remarketing lists, possibly filtered. This method supports paging.",
"parameters": {
"floodlightActivityId": {
"type": "string",
"format": "int64",
"description": "Select only remarketing lists that have this floodlight activity ID.",
"location": "query"
},
"profileId": {
"type": "string",
"required": true,
"format": "int64",
"description": "User profile ID associated with this request.",
"location": "path"
},
"advertiserId": {
"required": true,
"type": "string",
"description": "Select only remarketing lists owned by this advertiser.",
"location": "query",
"format": "int64"
},
"sortField": {
"default": "ID",
"type": "string",
"enumDescriptions": [
"",
""
],
"description": "Field by which to sort the list.",
"location": "query",
"enum": [
"ID",
"NAME"
]
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"location": "query",
"type": "string"
},
"sortOrder": {
"enum": [
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"",
""
],
"description": "Order of sorted results.",
"location": "query",
"default": "ASCENDING",
"type": "string"
},
"maxResults": {
"minimum": "0",
"description": "Maximum number of results to return.",
"default": "1000",
"type": "integer",
"location": "query",
"maximum": "1000",
"format": "int32"
},
"active": {
"location": "query",
"type": "boolean",
"description": "Select only active or only inactive remarketing lists."
},
"name": {
"type": "string",
"location": "query",
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\"."
}
},
"flatPath": "userprofiles/{profileId}/remarketingLists",
"response": {
"$ref": "RemarketingListsListResponse"
},
"httpMethod": "GET",
"id": "dfareporting.remarketingLists.list",
"path": "userprofiles/{profileId}/remarketingLists"
},
"insert": {
"parameterOrder": [
"profileId"
],
"id": "dfareporting.remarketingLists.insert",
"description": "Inserts a new remarketing list.",
"response": {
"$ref": "RemarketingList"
},
"httpMethod": "POST",
"path": "userprofiles/{profileId}/remarketingLists",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"required": true,
"format": "int64",
"location": "path",
"type": "string",
"description": "User profile ID associated with this request."
}
},
"request": {
"$ref": "RemarketingList"
},
"flatPath": "userprofiles/{profileId}/remarketingLists"
},
"patch": {
"flatPath": "userprofiles/{profileId}/remarketingLists",
"parameterOrder": [
"profileId",
"id"
],
"httpMethod": "PATCH",
"description": "Updates an existing remarketing list. This method supports patch semantics.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"request": {
"$ref": "RemarketingList"
},
"id": "dfareporting.remarketingLists.patch",
"path": "userprofiles/{profileId}/remarketingLists",
"parameters": {
"id": {
"description": "RemarketingList ID.",
"location": "query",
"format": "int64",
"type": "string",
"required": true
},
"profileId": {
"format": "int64",
"location": "path",
"type": "string",
"description": "User profile ID associated with this request.",
"required": true
}
},
"response": {
"$ref": "RemarketingList"
}
},
"get": {
"httpMethod": "GET",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"required": true,
"type": "string",
"description": "Remarketing list ID.",
"format": "int64",
"location": "path"
},
"profileId": {
"required": true,
"location": "path",
"description": "User profile ID associated with this request.",
"format": "int64",
"type": "string"
}
},
"flatPath": "userprofiles/{profileId}/remarketingLists/{id}",
"id": "dfareporting.remarketingLists.get",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "RemarketingList"
},
"path": "userprofiles/{profileId}/remarketingLists/{id}",
"description": "Gets one remarketing list by ID."
}
}
},
"floodlightActivities": {
"methods": {
"generatetag": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Generates a tag for a floodlight activity.",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"required": true,
"location": "path",
"type": "string"
},
"floodlightActivityId": {
"type": "string",
"description": "Floodlight activity ID for which we want to generate a tag.",
"location": "query",
"format": "int64"
}
},
"parameterOrder": [
"profileId"
],
"path": "userprofiles/{profileId}/floodlightActivities/generatetag",
"httpMethod": "POST",
"response": {
"$ref": "FloodlightActivitiesGenerateTagResponse"
},
"id": "dfareporting.floodlightActivities.generatetag",
"flatPath": "userprofiles/{profileId}/floodlightActivities/generatetag"
},
"list": {
"parameters": {
"floodlightActivityGroupIds": {
"description": "Select only floodlight activities with the specified floodlight activity group IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"advertiserId": {
"format": "int64",
"type": "string",
"description": "Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
"location": "query"
},
"profileId": {
"format": "int64",
"location": "path",
"type": "string",
"description": "User profile ID associated with this request.",
"required": true
},
"searchString": {
"location": "query",
"type": "string",
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivity*2015\" will return objects with names like \"floodlightactivity June 2015\", \"floodlightactivity April 2015\", or simply \"floodlightactivity 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivity\" will match objects with name \"my floodlightactivity activity\", \"floodlightactivity 2015\", or simply \"floodlightactivity\"."
},
"floodlightConfigurationId": {
"description": "Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
"type": "string",
"location": "query",
"format": "int64"
},
"floodlightActivityGroupType": {
"enum": [
"COUNTER",
"SALE"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string",
"description": "Select only floodlight activities with the specified floodlight activity group type."
},
"floodlightActivityGroupTagString": {
"type": "string",
"description": "Select only floodlight activities with the specified floodlight activity group tag string.",
"location": "query"
},
"maxResults": {
"minimum": "0",
"location": "query",
"format": "int32",
"default": "1000",
"maximum": "1000",
"description": "Maximum number of results to return.",
"type": "integer"
},
"sortOrder": {
"enum": [
"ASCENDING",
"DESCENDING"
],
"location": "query",
"type": "string",
"description": "Order of sorted results.",
"enumDescriptions": [
"",
""
],
"default": "ASCENDING"
},
"tagString": {
"location": "query",
"type": "string",
"description": "Select only floodlight activities with the specified tag string."
},
"floodlightActivityGroupName": {
"location": "query",
"description": "Select only floodlight activities with the specified floodlight activity group name.",
"type": "string"
},
"sortField": {
"default": "ID",
"enumDescriptions": [
"",
""
],
"type": "string",
"location": "query",
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
]
},
"ids": {
"repeated": true,
"location": "query",
"type": "string",
"format": "int64",
"description": "Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result."
},
"pageToken": {
"type": "string",
"location": "query",
"description": "Value of the nextPageToken from the previous result page."
}
},
"path": "userprofiles/{profileId}/floodlightActivities",
"httpMethod": "GET",
"description": "Retrieves a list of floodlight activities, possibly filtered. This method supports paging.",
"response": {
"$ref": "FloodlightActivitiesListResponse"
},
"parameterOrder": [
"profileId"
],
"flatPath": "userprofiles/{profileId}/floodlightActivities",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.floodlightActivities.list"
},
"update": {
"description": "Updates an existing floodlight activity.",
"parameterOrder": [
"profileId"
],
"response": {
"$ref": "FloodlightActivity"
},
"path": "userprofiles/{profileId}/floodlightActivities",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "PUT",
"id": "dfareporting.floodlightActivities.update",
"flatPath": "userprofiles/{profileId}/floodlightActivities",
"parameters": {
"profileId": {
"type": "string",
"location": "path",
"format": "int64",
"required": true,
"description": "User profile ID associated with this request."
}
},
"request": {
"$ref": "FloodlightActivity"
}
},
"delete": {
"flatPath": "userprofiles/{profileId}/floodlightActivities/{id}",
"description": "Deletes an existing floodlight activity.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId",
"id"
],
"path": "userprofiles/{profileId}/floodlightActivities/{id}",
"parameters": {
"profileId": {
"format": "int64",
"description": "User profile ID associated with this request.",
"type": "string",
"location": "path",
"required": true
},
"id": {
"description": "Floodlight activity ID.",
"type": "string",
"format": "int64",
"location": "path",
"required": true
}
},
"httpMethod": "DELETE",
"id": "dfareporting.floodlightActivities.delete"
},
"insert": {
"path": "userprofiles/{profileId}/floodlightActivities",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.floodlightActivities.insert",
"request": {
"$ref": "FloodlightActivity"
},
"description": "Inserts a new floodlight activity.",
"response": {
"$ref": "FloodlightActivity"
},
"parameterOrder": [
"profileId"
],
"flatPath": "userprofiles/{profileId}/floodlightActivities",
"httpMethod": "POST",
"parameters": {
"profileId": {
"format": "int64",
"type": "string",
"description": "User profile ID associated with this request.",
"required": true,
"location": "path"
}
}
},
"get": {
"id": "dfareporting.floodlightActivities.get",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"required": true,
"type": "string",
"format": "int64",
"description": "Floodlight activity ID.",
"location": "path"
},
"profileId": {
"description": "User profile ID associated with this request.",
"type": "string",
"location": "path",
"format": "int64",
"required": true
}
},
"httpMethod": "GET",
"response": {
"$ref": "FloodlightActivity"
},
"path": "userprofiles/{profileId}/floodlightActivities/{id}",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Gets one floodlight activity by ID.",
"flatPath": "userprofiles/{profileId}/floodlightActivities/{id}"
},
"patch": {
"id": "dfareporting.floodlightActivities.patch",
"path": "userprofiles/{profileId}/floodlightActivities",
"request": {
"$ref": "FloodlightActivity"
},
"flatPath": "userprofiles/{profileId}/floodlightActivities",
"description": "Updates an existing floodlight activity. This method supports patch semantics.",
"httpMethod": "PATCH",
"parameterOrder": [
"profileId",
"id"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "FloodlightActivity"
},
"parameters": {
"id": {
"description": "FloodlightActivity ID.",
"format": "int64",
"type": "string",
"required": true,
"location": "query"
},
"profileId": {
"type": "string",
"description": "User profile ID associated with this request.",
"required": true,
"location": "path",
"format": "int64"
}
}
}
}
},
"accountPermissionGroups": {
"methods": {
"get": {
"response": {
"$ref": "AccountPermissionGroup"
},
"parameters": {
"profileId": {
"required": true,
"location": "path",
"format": "int64",
"type": "string",
"description": "User profile ID associated with this request."
},
"id": {
"required": true,
"description": "Account permission group ID.",
"format": "int64",
"type": "string",
"location": "path"
}
},
"httpMethod": "GET",
"description": "Gets one account permission group by ID.",
"id": "dfareporting.accountPermissionGroups.get",
"flatPath": "userprofiles/{profileId}/accountPermissionGroups/{id}",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId",
"id"
],
"path": "userprofiles/{profileId}/accountPermissionGroups/{id}"
},
"list": {
"httpMethod": "GET",
"parameters": {
"profileId": {
"type": "string",
"location": "path",
"description": "User profile ID associated with this request.",
"required": true,
"format": "int64"
}
},
"path": "userprofiles/{profileId}/accountPermissionGroups",
"flatPath": "userprofiles/{profileId}/accountPermissionGroups",
"id": "dfareporting.accountPermissionGroups.list",
"description": "Retrieves the list of account permission groups.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId"
],
"response": {
"$ref": "AccountPermissionGroupsListResponse"
}
}
}
},
"sites": {
"methods": {
"patch": {
"parameters": {
"profileId": {
"format": "int64",
"location": "path",
"type": "string",
"required": true,
"description": "User profile ID associated with this request."
},
"id": {
"type": "string",
"description": "Site ID.",
"format": "int64",
"location": "query",
"required": true
}
},
"flatPath": "userprofiles/{profileId}/sites",
"response": {
"$ref": "Site"
},
"parameterOrder": [
"profileId",
"id"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "PATCH",
"description": "Updates an existing site. This method supports patch semantics.",
"request": {
"$ref": "Site"
},
"path": "userprofiles/{profileId}/sites",
"id": "dfareporting.sites.patch"
},
"list": {
"parameterOrder": [
"profileId"
],
"httpMethod": "GET",
"description": "Retrieves a list of sites, possibly filtered. This method supports paging.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "SitesListResponse"
},
"flatPath": "userprofiles/{profileId}/sites",
"path": "userprofiles/{profileId}/sites",
"id": "dfareporting.sites.list",
"parameters": {
"subaccountId": {
"type": "string",
"description": "Select only sites with this subaccount ID.",
"format": "int64",
"location": "query"
},
"approved": {
"type": "boolean",
"description": "Select only approved sites.",
"location": "query"
},
"sortField": {
"description": "Field by which to sort the list.",
"type": "string",
"enumDescriptions": [
"",
""
],
"location": "query",
"default": "ID",
"enum": [
"ID",
"NAME"
]
},
"acceptsInStreamVideoPlacements": {
"type": "boolean",
"location": "query",
"description": "This search filter is no longer supported and will have no effect on the results returned."
},
"acceptsPublisherPaidPlacements": {
"type": "boolean",
"location": "query",
"description": "Select only sites that accept publisher paid placements."
},
"ids": {
"repeated": true,
"type": "string",
"location": "query",
"format": "int64",
"description": "Select only sites with these IDs."
},
"acceptsInterstitialPlacements": {
"location": "query",
"description": "This search filter is no longer supported and will have no effect on the results returned.",
"type": "boolean"
},
"searchString": {
"description": "Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, \"site*2015\" will return objects with names like \"site June 2015\", \"site April 2015\", or simply \"site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"site\" will match objects with name \"my site\", \"site 2015\", or simply \"site\".",
"type": "string",
"location": "query"
},
"directorySiteIds": {
"format": "int64",
"description": "Select only sites with these directory site IDs.",
"type": "string",
"location": "query",
"repeated": true
},
"campaignIds": {
"description": "Select only sites with these campaign IDs.",
"location": "query",
"format": "int64",
"repeated": true,
"type": "string"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "Value of the nextPageToken from the previous result page."
},
"sortOrder": {
"location": "query",
"enum": [
"ASCENDING",
"DESCENDING"
],
"default": "ASCENDING",
"description": "Order of sorted results.",
"type": "string",
"enumDescriptions": [
"",
""
]
},
"adWordsSite": {
"description": "Select only AdWords sites.",
"location": "query",
"type": "boolean"
},
"unmappedSite": {
"description": "Select only sites that have not been mapped to a directory site.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"format": "int32",
"default": "1000",
"description": "Maximum number of results to return.",
"maximum": "1000",
"type": "integer",
"minimum": "0",
"location": "query"
},
"profileId": {
"type": "string",
"description": "User profile ID associated with this request.",
"required": true,
"format": "int64",
"location": "path"
}
}
},
"update": {
"response": {
"$ref": "Site"
},
"path": "userprofiles/{profileId}/sites",
"flatPath": "userprofiles/{profileId}/sites",
"request": {
"$ref": "Site"
},
"description": "Updates an existing site.",
"httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId"
],
"id": "dfareporting.sites.update",
"parameters": {
"profileId": {
"required": true,
"location": "path",
"type": "string",
"format": "int64",
"description": "User profile ID associated with this request."
}
}
},
"get": {
"parameters": {
"profileId": {
"format": "int64",
"description": "User profile ID associated with this request.",
"type": "string",
"location": "path",
"required": true
},
"id": {
"location": "path",
"required": true,
"type": "string",
"format": "int64",
"description": "Site ID."
}
},
"parameterOrder": [
"profileId",
"id"
],
"id": "dfareporting.sites.get",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "GET",
"path": "userprofiles/{profileId}/sites/{id}",
"response": {
"$ref": "Site"
},
"description": "Gets one site by ID.",
"flatPath": "userprofiles/{profileId}/sites/{id}"
},
"insert": {
"parameterOrder": [
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "POST",
"path": "userprofiles/{profileId}/sites",
"description": "Inserts a new site.",
"response": {
"$ref": "Site"
},
"parameters": {
"profileId": {
"type": "string",
"location": "path",
"format": "int64",
"required": true,
"description": "User profile ID associated with this request."
}
},
"request": {
"$ref": "Site"
},
"flatPath": "userprofiles/{profileId}/sites",
"id": "dfareporting.sites.insert"
}
}
},
"targetingTemplates": {
"methods": {
"update": {
"description": "Updates an existing targeting template.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/targetingTemplates",
"path": "userprofiles/{profileId}/targetingTemplates",
"request": {
"$ref": "TargetingTemplate"
},
"httpMethod": "PUT",
"response": {
"$ref": "TargetingTemplate"
},
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"required": true,
"format": "int64",
"description": "User profile ID associated with this request.",
"type": "string",
"location": "path"
}
},
"id": "dfareporting.targetingTemplates.update"
},
"insert": {
"response": {
"$ref": "TargetingTemplate"
},
"path": "userprofiles/{profileId}/targetingTemplates",
"parameters": {
"profileId": {
"location": "path",
"format": "int64",
"required": true,
"description": "User profile ID associated with this request.",
"type": "string"
}
},
"id": "dfareporting.targetingTemplates.insert",
"description": "Inserts a new targeting template.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"request": {
"$ref": "TargetingTemplate"
},
"parameterOrder": [
"profileId"
],
"flatPath": "userprofiles/{profileId}/targetingTemplates",
"httpMethod": "POST"
},
"patch": {
"description": "Updates an existing targeting template. This method supports patch semantics.",
"flatPath": "userprofiles/{profileId}/targetingTemplates",
"parameters": {
"id": {
"type": "string",
"format": "int64",
"required": true,
"description": "TargetingTemplate ID.",
"location": "query"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"required": true,
"location": "path",
"type": "string"
}
},
"response": {
"$ref": "TargetingTemplate"
},
"id": "dfareporting.targetingTemplates.patch",
"parameterOrder": [
"profileId",
"id"
],
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"request": {
"$ref": "TargetingTemplate"
},
"path": "userprofiles/{profileId}/targetingTemplates"
},
"list": {
"flatPath": "userprofiles/{profileId}/targetingTemplates",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "TargetingTemplatesListResponse"
},
"path": "userprofiles/{profileId}/targetingTemplates",
"parameterOrder": [
"profileId"
],
"httpMethod": "GET",
"description": "Retrieves a list of targeting templates, optionally filtered. This method supports paging.",
"id": "dfareporting.targetingTemplates.list",
"parameters": {
"searchString": {
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"template*2015\" will return objects with names like \"template June 2015\", \"template April 2015\", or simply \"template 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"template\" will match objects with name \"my template\", \"template 2015\", or simply \"template\".",
"location": "query",
"type": "string"
},
"sortOrder": {
"description": "Order of sorted results.",
"type": "string",
"location": "query",
"enum": [
"ASCENDING",
"DESCENDING"
],
"default": "ASCENDING",
"enumDescriptions": [
"",
""
]
},
"pageToken": {
"type": "string",
"description": "Value of the nextPageToken from the previous result page.",
"location": "query"
},
"sortField": {
"default": "ID",
"enumDescriptions": [
"",
""
],
"enum": [
"ID",
"NAME"
],
"description": "Field by which to sort the list.",
"type": "string",
"location": "query"
},
"advertiserId": {
"format": "int64",
"description": "Select only targeting templates with this advertiser ID.",
"location": "query",
"type": "string"
},
"ids": {
"location": "query",
"type": "string",
"description": "Select only targeting templates with these IDs.",
"format": "int64",
"repeated": true
},
"maxResults": {
"minimum": "0",
"description": "Maximum number of results to return.",
"maximum": "1000",
"format": "int32",
"location": "query",
"type": "integer",
"default": "1000"
},
"profileId": {
"location": "path",
"format": "int64",
"description": "User profile ID associated with this request.",
"required": true,
"type": "string"
}
}
},
"get": {
"flatPath": "userprofiles/{profileId}/targetingTemplates/{id}",
"httpMethod": "GET",
"parameterOrder": [
"profileId",
"id"
],
"response": {
"$ref": "TargetingTemplate"
},
"id": "dfareporting.targetingTemplates.get",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"type": "string",
"description": "User profile ID associated with this request.",
"location": "path",
"format": "int64",
"required": true
},
"id": {
"required": true,
"type": "string",
"format": "int64",
"location": "path",
"description": "Targeting template ID."
}
},
"path": "userprofiles/{profileId}/targetingTemplates/{id}",
"description": "Gets one targeting template by ID."
}
}
},
"creativeAssets": {
"methods": {
"insert": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "POST",
"supportsMediaUpload": true,
"id": "dfareporting.creativeAssets.insert",
"mediaUpload": {
"protocols": {
"simple": {
"path": "/upload/dfareporting/v3.4/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
"multipart": true
}
},
"accept": [
"*/*"
],
"maxSize": "1073741824"
},
"description": "Inserts a new creative asset.",
"parameterOrder": [
"profileId",
"advertiserId"
],
"path": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
"flatPath": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
"request": {
"$ref": "CreativeAssetMetadata"
},
"response": {
"$ref": "CreativeAssetMetadata"
},
"parameters": {
"advertiserId": {
"required": true,
"type": "string",
"format": "int64",
"description": "Advertiser ID of this creative. This is a required field.",
"location": "path"
},
"profileId": {
"required": true,
"location": "path",
"description": "User profile ID associated with this request.",
"format": "int64",
"type": "string"
}
}
}
}
},
"accounts": {
"methods": {
"get": {
"id": "dfareporting.accounts.get",
"parameters": {
"id": {
"location": "path",
"type": "string",
"required": true,
"format": "int64",
"description": "Account ID."
},
"profileId": {
"required": true,
"format": "int64",
"description": "User profile ID associated with this request.",
"type": "string",
"location": "path"
}
},
"description": "Gets one account by ID.",
"path": "userprofiles/{profileId}/accounts/{id}",
"response": {
"$ref": "Account"
},
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId",
"id"
],
"flatPath": "userprofiles/{profileId}/accounts/{id}"
},
"list": {
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Retrieves the list of accounts, possibly filtered. This method supports paging.",
"response": {
"$ref": "AccountsListResponse"
},
"parameterOrder": [
"profileId"
],
"parameters": {
"ids": {
"location": "query",
"type": "string",
"repeated": true,
"description": "Select only accounts with these IDs.",
"format": "int64"
},
"searchString": {
"type": "string",
"location": "query",
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"account*2015\" will return objects with names like \"account June 2015\", \"account April 2015\", or simply \"account 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"account\" will match objects with name \"my account\", \"account 2015\", or simply \"account\"."
},
"sortField": {
"location": "query",
"description": "Field by which to sort the list.",
"enumDescriptions": [
"",
""
],
"type": "string",
"enum": [
"ID",
"NAME"
],
"default": "ID"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "Value of the nextPageToken from the previous result page."
},
"maxResults": {
"description": "Maximum number of results to return.",
"default": "1000",
"minimum": "0",
"location": "query",
"maximum": "1000",
"type": "integer",
"format": "int32"
},
"profileId": {
"type": "string",
"description": "User profile ID associated with this request.",
"location": "path",
"format": "int64",
"required": true
},
"active": {
"location": "query",
"description": "Select only active accounts. Don't set this field to select both active and non-active accounts.",
"type": "boolean"
},
"sortOrder": {
"enumDescriptions": [
"",
""
],
"description": "Order of sorted results.",
"location": "query",
"enum": [
"ASCENDING",
"DESCENDING"
],
"default": "ASCENDING",
"type": "string"
}
},
"path": "userprofiles/{profileId}/accounts",
"id": "dfareporting.accounts.list",
"flatPath": "userprofiles/{profileId}/accounts"
},
"patch": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"id": {
"description": "Account ID.",
"type": "string",
"location": "query",
"format": "int64",
"required": true
},
"profileId": {
"required": true,
"format": "int64",
"location": "path",
"type": "string",
"description": "User profile ID associated with this request."
}
},
"response": {
"$ref": "Account"
},
"request": {
"$ref": "Account"
},
"parameterOrder": [
"profileId",
"id"
],
"flatPath": "userprofiles/{profileId}/accounts",
"path": "userprofiles/{profileId}/accounts",
"description": "Updates an existing account. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "dfareporting.accounts.patch"
},
"update": {
"path": "userprofiles/{profileId}/accounts",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "Account"
},
"flatPath": "userprofiles/{profileId}/accounts",
"description": "Updates an existing account.",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"required": true,
"description": "User profile ID associated with this request.",
"location": "path",
"format": "int64",
"type": "string"
}
},
"httpMethod": "PUT",
"id": "dfareporting.accounts.update",
"request": {
"$ref": "Account"
}
}
}
},
"connectionTypes": {
"methods": {
"get": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.connectionTypes.get",
"response": {
"$ref": "ConnectionType"
},
"description": "Gets one connection type by ID.",
"parameters": {
"id": {
"location": "path",
"type": "string",
"format": "int64",
"description": "Connection type ID.",
"required": true
},
"profileId": {
"description": "User profile ID associated with this request.",
"type": "string",
"format": "int64",
"location": "path",
"required": true
}
},
"flatPath": "userprofiles/{profileId}/connectionTypes/{id}",
"path": "userprofiles/{profileId}/connectionTypes/{id}",
"httpMethod": "GET",
"parameterOrder": [
"profileId",
"id"
]
},
"list": {
"path": "userprofiles/{profileId}/connectionTypes",
"id": "dfareporting.connectionTypes.list",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"type": "string",
"format": "int64",
"location": "path",
"required": true
}
},
"response": {
"$ref": "ConnectionTypesListResponse"
},
"parameterOrder": [
"profileId"
],
"flatPath": "userprofiles/{profileId}/connectionTypes",
"description": "Retrieves a list of connection types."
}
}
},
"reports": {
"resources": {
"compatibleFields": {
"methods": {
"query": {
"response": {
"$ref": "CompatibleFields"
},
"scopes": [
"https://www.googleapis.com/auth/dfareporting"
],
"parameters": {
"profileId": {
"type": "string",
"location": "path",
"description": "The Campaign Manager 360 user profile ID.",
"format": "int64",
"required": true
}
},
"httpMethod": "POST",
"request": {
"$ref": "Report"
},
"flatPath": "userprofiles/{profileId}/reports/compatiblefields/query",
"description": "Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.",
"path": "userprofiles/{profileId}/reports/compatiblefields/query",
"parameterOrder": [
"profileId"
],
"id": "dfareporting.reports.compatibleFields.query"
}
}
},
"files": {
"methods": {
"list": {
"parameters": {
"pageToken": {
"type": "string",
"description": "The value of the nextToken from the previous result page.",
"location": "query"
},
"profileId": {
"format": "int64",
"description": "The Campaign Manager 360 user profile ID.",
"location": "path",
"type": "string",
"required": true
},
"maxResults": {
"type": "integer",
"maximum": "10",
"description": "Maximum number of results to return.",
"minimum": "0",
"default": "10",
"location": "query",
"format": "int32"
},
"sortOrder": {
"default": "DESCENDING",
"location": "query",
"enumDescriptions": [
"",
""
],
"description": "Order of sorted results.",
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string"
},
"reportId": {
"required": true,
"format": "int64",
"description": "The ID of the parent report.",
"type": "string",
"location": "path"
},
"sortField": {
"enum": [
"ID",
"LAST_MODIFIED_TIME"
],
"location": "query",
"type": "string",
"description": "The field by which to sort the list.",
"enumDescriptions": [
"",
""
],
"default": "LAST_MODIFIED_TIME"
}
},
"id": "dfareporting.reports.files.list",
"description": "Lists files for a report.",
"parameterOrder": [
"profileId",
"reportId"
],
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/reports/{reportId}/files",
"response": {
"$ref": "FileList"
},
"scopes": [
"https://www.googleapis.com/auth/dfareporting"
],
"path": "userprofiles/{profileId}/reports/{reportId}/files"
},
"get": {
"supportsMediaDownload": true,
"scopes": [
"https://www.googleapis.com/auth/dfareporting"
],
"parameterOrder": [
"profileId",
"reportId",
"fileId"
],
"id": "dfareporting.reports.files.get",
"description": "Retrieves a report file by its report ID and file ID. This method supports media download.",
"parameters": {
"fileId": {
"location": "path",
"description": "The ID of the report file.",
"required": true,
"format": "int64",
"type": "string"
},
"reportId": {
"type": "string",
"location": "path",
"format": "int64",
"description": "The ID of the report.",
"required": true
},
"profileId": {
"location": "path",
"type": "string",
"format": "int64",
"description": "The Campaign Manager 360 user profile ID.",
"required": true
}
},
"flatPath": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
"httpMethod": "GET",
"response": {
"$ref": "File"
},
"path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}"
}
}
}
},
"methods": {
"list": {
"parameterOrder": [
"profileId"
],
"httpMethod": "GET",
"description": "Retrieves list of reports.",
"scopes": [
"https://www.googleapis.com/auth/dfareporting"
],
"flatPath": "userprofiles/{profileId}/reports",
"response": {
"$ref": "ReportList"
},
"path": "userprofiles/{profileId}/reports",
"id": "dfareporting.reports.list",
"parameters": {
"maxResults": {
"minimum": "0",
"default": "10",
"maximum": "10",
"location": "query",
"type": "integer",
"format": "int32",
"description": "Maximum number of results to return."
},
"sortField": {
"enum": [
"ID",
"LAST_MODIFIED_TIME",
"NAME"
],
"type": "string",
"description": "The field by which to sort the list.",
"location": "query",
"default": "LAST_MODIFIED_TIME",
"enumDescriptions": [
"Sort by report ID.",
"Sort by 'lastModifiedTime' field.",
"Sort by name of reports."
]
},
"profileId": {
"format": "int64",
"required": true,
"type": "string",
"description": "The Campaign Manager 360 user profile ID.",
"location": "path"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "The value of the nextToken from the previous result page."
},
"scope": {
"type": "string",
"location": "query",
"enum": [
"ALL",
"MINE"
],
"enumDescriptions": [
"All reports in account.",
"My reports."
],
"description": "The scope that defines which results are returned.",
"default": "MINE"
},
"sortOrder": {
"enum": [
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"Ascending order.",
"Descending order."
],
"description": "Order of sorted results.",
"type": "string",
"location": "query",
"default": "DESCENDING"
}
}
},
"run": {
"scopes": [
"https://www.googleapis.com/auth/dfareporting"
],
"description": "Runs a report.",
"path": "userprofiles/{profileId}/reports/{reportId}/run",
"parameterOrder": [
"profileId",
"reportId"
],
"flatPath": "userprofiles/{profileId}/reports/{reportId}/run",
"httpMethod": "POST",
"parameters": {
"reportId": {
"description": "The ID of the report.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"location": "path",
"format": "int64",
"description": "The Campaign Manager 360 user profile ID.",
"required": true,
"type": "string"
},
"synchronous": {
"location": "query",
"type": "boolean",
"description": "If set and true, tries to run the report synchronously.",
"default": "false"
}
},
"id": "dfareporting.reports.run",
"response": {
"$ref": "File"
}
},
"get": {
"response": {
"$ref": "Report"
},
"parameters": {
"profileId": {
"type": "string",
"description": "The Campaign Manager 360 user profile ID.",
"location": "path",
"required": true,
"format": "int64"
},
"reportId": {
"format": "int64",
"description": "The ID of the report.",
"type": "string",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"profileId",
"reportId"
],
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/reports/{reportId}",
"id": "dfareporting.reports.get",
"scopes": [
"https://www.googleapis.com/auth/dfareporting"
],
"path": "userprofiles/{profileId}/reports/{reportId}",
"description": "Retrieves a report by its ID."
},
"insert": {
"flatPath": "userprofiles/{profileId}/reports",
"httpMethod": "POST",
"id": "dfareporting.reports.insert",
"response": {
"$ref": "Report"
},
"description": "Creates a report.",
"request": {
"$ref": "Report"
},
"path": "userprofiles/{profileId}/reports",
"parameters": {
"profileId": {
"type": "string",
"description": "The Campaign Manager 360 user profile ID.",
"location": "path",
"format": "int64",
"required": true
}
},
"parameterOrder": [
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/dfareporting"
]
},
"update": {
"id": "dfareporting.reports.update",
"description": "Updates a report.",
"scopes": [
"https://www.googleapis.com/auth/dfareporting"
],
"request": {
"$ref": "Report"
},
"response": {
"$ref": "Report"
},
"flatPath": "userprofiles/{profileId}/reports/{reportId}",
"parameters": {
"reportId": {
"description": "The ID of the report.",
"required": true,
"location": "path",
"format": "int64",
"type": "string"
},
"profileId": {
"required": true,
"location": "path",
"format": "int64",
"type": "string",
"description": "The Campaign Manager 360 user profile ID."
}
},
"parameterOrder": [
"profileId",
"reportId"
],
"httpMethod": "PUT",
"path": "userprofiles/{profileId}/reports/{reportId}"
},
"patch": {
"id": "dfareporting.reports.patch",
"scopes": [
"https://www.googleapis.com/auth/dfareporting"
],
"path": "userprofiles/{profileId}/reports/{reportId}",
"flatPath": "userprofiles/{profileId}/reports/{reportId}",
"parameters": {
"profileId": {
"format": "int64",
"description": "The DFA user profile ID.",
"required": true,
"location": "path",
"type": "string"
},
"reportId": {
"type": "string",
"description": "The ID of the report.",
"format": "int64",
"required": true,
"location": "path"
}
},
"httpMethod": "PATCH",
"request": {
"$ref": "Report"
},
"description": "Updates an existing report. This method supports patch semantics.",
"parameterOrder": [
"profileId",
"reportId"
],
"response": {
"$ref": "Report"
}
},
"delete": {
"flatPath": "userprofiles/{profileId}/reports/{reportId}",
"path": "userprofiles/{profileId}/reports/{reportId}",
"httpMethod": "DELETE",
"description": "Deletes a report by its ID.",
"scopes": [
"https://www.googleapis.com/auth/dfareporting"
],
"id": "dfareporting.reports.delete",
"parameters": {
"reportId": {
"description": "The ID of the report.",
"location": "path",
"required": true,
"type": "string",
"format": "int64"
},
"profileId": {
"description": "The Campaign Manager 360 user profile ID.",
"required": true,
"location": "path",
"format": "int64",
"type": "string"
}
},
"parameterOrder": [
"profileId",
"reportId"
]
}
}
},
"directorySites": {
"methods": {
"insert": {
"parameters": {
"profileId": {
"format": "int64",
"description": "User profile ID associated with this request.",
"type": "string",
"location": "path",
"required": true
}
},
"flatPath": "userprofiles/{profileId}/directorySites",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.directorySites.insert",
"httpMethod": "POST",
"path": "userprofiles/{profileId}/directorySites",
"parameterOrder": [
"profileId"
],
"response": {
"$ref": "DirectorySite"
},
"description": "Inserts a new directory site.",
"request": {
"$ref": "DirectorySite"
}
},
"get": {
"id": "dfareporting.directorySites.get",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"required": true,
"format": "int64",
"type": "string",
"location": "path"
},
"id": {
"description": "Directory site ID.",
"required": true,
"location": "path",
"type": "string",
"format": "int64"
}
},
"httpMethod": "GET",
"description": "Gets one directory site by ID.",
"response": {
"$ref": "DirectorySite"
},
"parameterOrder": [
"profileId",
"id"
],
"flatPath": "userprofiles/{profileId}/directorySites/{id}",
"path": "userprofiles/{profileId}/directorySites/{id}"
},
"list": {
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/directorySites",
"description": "Retrieves a list of directory sites, possibly filtered. This method supports paging.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/directorySites",
"parameters": {
"dfpNetworkCode": {
"description": "Select only directory sites with this Ad Manager network code.",
"type": "string",
"location": "query"
},
"ids": {
"type": "string",
"format": "int64",
"location": "query",
"description": "Select only directory sites with these IDs.",
"repeated": true
},
"profileId": {
"location": "path",
"format": "int64",
"description": "User profile ID associated with this request.",
"required": true,
"type": "string"
},
"active": {
"type": "boolean",
"description": "Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.",
"location": "query"
},
"searchString": {
"type": "string",
"location": "query",
"description": "Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, \"directory site*2015\" will return objects with names like \"directory site June 2015\", \"directory site April 2015\", or simply \"directory site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site\" will match objects with name \"my directory site\", \"directory site 2015\" or simply, \"directory site\"."
},
"sortField": {
"enumDescriptions": [
"",
""
],
"type": "string",
"location": "query",
"default": "ID",
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
]
},
"maxResults": {
"maximum": "1000",
"description": "Maximum number of results to return.",
"type": "integer",
"location": "query",
"format": "int32",
"default": "1000",
"minimum": "0"
},
"acceptsPublisherPaidPlacements": {
"location": "query",
"description": "Select only directory sites that accept publisher paid placements. This field can be left blank.",
"type": "boolean"
},
"acceptsInStreamVideoPlacements": {
"description": "This search filter is no longer supported and will have no effect on the results returned.",
"type": "boolean",
"location": "query"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"type": "string",
"location": "query"
},
"sortOrder": {
"location": "query",
"description": "Order of sorted results.",
"default": "ASCENDING",
"type": "string",
"enum": [
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"",
""
]
},
"acceptsInterstitialPlacements": {
"type": "boolean",
"location": "query",
"description": "This search filter is no longer supported and will have no effect on the results returned."
}
},
"response": {
"$ref": "DirectorySitesListResponse"
},
"parameterOrder": [
"profileId"
],
"id": "dfareporting.directorySites.list"
}
}
},
"advertiserLandingPages": {
"methods": {
"list": {
"response": {
"$ref": "AdvertiserLandingPagesListResponse"
},
"id": "dfareporting.advertiserLandingPages.list",
"httpMethod": "GET",
"description": "Retrieves a list of landing pages.",
"parameterOrder": [
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"location": "path",
"required": true,
"type": "string",
"description": "User profile ID associated with this request.",
"format": "int64"
},
"searchString": {
"type": "string",
"location": "query",
"description": "Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, \"landingpage*2017\" will return landing pages with names like \"landingpage July 2017\", \"landingpage March 2017\", or simply \"landingpage 2017\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"landingpage\" will match campaigns with name \"my landingpage\", \"landingpage 2015\", or simply \"landingpage\"."
},
"sortOrder": {
"enum": [
"ASCENDING",
"DESCENDING"
],
"description": "Order of sorted results.",
"default": "ASCENDING",
"type": "string",
"enumDescriptions": [
"",
""
],
"location": "query"
},
"maxResults": {
"maximum": "1000",
"format": "int32",
"minimum": "0",
"default": "1000",
"type": "integer",
"description": "Maximum number of results to return.",
"location": "query"
},
"archived": {
"type": "boolean",
"location": "query",
"description": "Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages."
},
"ids": {
"type": "string",
"format": "int64",
"location": "query",
"description": "Select only landing pages with these IDs.",
"repeated": true
},
"pageToken": {
"type": "string",
"location": "query",
"description": "Value of the nextPageToken from the previous result page."
},
"subaccountId": {
"description": "Select only landing pages that belong to this subaccount.",
"format": "int64",
"location": "query",
"type": "string"
},
"sortField": {
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string",
"default": "ID"
},
"advertiserIds": {
"repeated": true,
"location": "query",
"format": "int64",
"type": "string",
"description": "Select only landing pages that belong to these advertisers."
},
"campaignIds": {
"type": "string",
"repeated": true,
"location": "query",
"format": "int64",
"description": "Select only landing pages that are associated with these campaigns."
}
},
"flatPath": "userprofiles/{profileId}/advertiserLandingPages",
"path": "userprofiles/{profileId}/advertiserLandingPages"
},
"update": {
"response": {
"$ref": "LandingPage"
},
"description": "Updates an existing landing page.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/advertiserLandingPages",
"flatPath": "userprofiles/{profileId}/advertiserLandingPages",
"parameters": {
"profileId": {
"type": "string",
"description": "User profile ID associated with this request.",
"required": true,
"location": "path",
"format": "int64"
}
},
"parameterOrder": [
"profileId"
],
"request": {
"$ref": "LandingPage"
},
"id": "dfareporting.advertiserLandingPages.update",
"httpMethod": "PUT"
},
"insert": {
"response": {
"$ref": "LandingPage"
},
"description": "Inserts a new landing page.",
"httpMethod": "POST",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"request": {
"$ref": "LandingPage"
},
"parameterOrder": [
"profileId"
],
"id": "dfareporting.advertiserLandingPages.insert",
"path": "userprofiles/{profileId}/advertiserLandingPages",
"flatPath": "userprofiles/{profileId}/advertiserLandingPages"
},
"patch": {
"description": "Updates an existing advertiser landing page. This method supports patch semantics.",
"request": {
"$ref": "LandingPage"
},
"flatPath": "userprofiles/{profileId}/advertiserLandingPages",
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId",
"id"
],
"path": "userprofiles/{profileId}/advertiserLandingPages",
"id": "dfareporting.advertiserLandingPages.patch",
"response": {
"$ref": "LandingPage"
},
"parameters": {
"profileId": {
"type": "string",
"format": "int64",
"required": true,
"description": "User profile ID associated with this request.",
"location": "path"
},
"id": {
"location": "query",
"type": "string",
"format": "int64",
"description": "LandingPage ID.",
"required": true
}
}
},
"get": {
"path": "userprofiles/{profileId}/advertiserLandingPages/{id}",
"httpMethod": "GET",
"id": "dfareporting.advertiserLandingPages.get",
"response": {
"$ref": "LandingPage"
},
"description": "Gets one landing page by ID.",
"flatPath": "userprofiles/{profileId}/advertiserLandingPages/{id}",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"id": {
"location": "path",
"required": true,
"type": "string",
"description": "Landing page ID.",
"format": "int64"
},
"profileId": {
"type": "string",
"description": "User profile ID associated with this request.",
"location": "path",
"required": true,
"format": "int64"
}
},
"parameterOrder": [
"profileId",
"id"
]
}
}
},
"contentCategories": {
"methods": {
"list": {
"response": {
"$ref": "ContentCategoriesListResponse"
},
"id": "dfareporting.contentCategories.list",
"parameterOrder": [
"profileId"
],
"flatPath": "userprofiles/{profileId}/contentCategories",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "GET",
"parameters": {
"pageToken": {
"location": "query",
"description": "Value of the nextPageToken from the previous result page.",
"type": "string"
},
"searchString": {
"type": "string",
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"contentcategory*2015\" will return objects with names like \"contentcategory June 2015\", \"contentcategory April 2015\", or simply \"contentcategory 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"contentcategory\" will match objects with name \"my contentcategory\", \"contentcategory 2015\", or simply \"contentcategory\".",
"location": "query"
},
"profileId": {
"type": "string",
"location": "path",
"format": "int64",
"description": "User profile ID associated with this request.",
"required": true
},
"ids": {
"repeated": true,
"description": "Select only content categories with these IDs.",
"location": "query",
"format": "int64",
"type": "string"
},
"maxResults": {
"description": "Maximum number of results to return.",
"location": "query",
"maximum": "1000",
"minimum": "0",
"format": "int32",
"default": "1000",
"type": "integer"
},
"sortOrder": {
"type": "string",
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
],
"location": "query",
"enumDescriptions": [
"",
""
],
"description": "Order of sorted results."
},
"sortField": {
"enumDescriptions": [
"",
""
],
"description": "Field by which to sort the list.",
"type": "string",
"default": "ID",
"enum": [
"ID",
"NAME"
],
"location": "query"
}
},
"description": "Retrieves a list of content categories, possibly filtered. This method supports paging.",
"path": "userprofiles/{profileId}/contentCategories"
},
"delete": {
"id": "dfareporting.contentCategories.delete",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/contentCategories/{id}",
"httpMethod": "DELETE",
"parameters": {
"profileId": {
"type": "string",
"required": true,
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path"
},
"id": {
"location": "path",
"format": "int64",
"description": "Content category ID.",
"type": "string",
"required": true
}
},
"description": "Deletes an existing content category.",
"path": "userprofiles/{profileId}/contentCategories/{id}",
"parameterOrder": [
"profileId",
"id"
]
},
"update": {
"httpMethod": "PUT",
"id": "dfareporting.contentCategories.update",
"path": "userprofiles/{profileId}/contentCategories",
"parameters": {
"profileId": {
"location": "path",
"required": true,
"format": "int64",
"description": "User profile ID associated with this request.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "ContentCategory"
},
"flatPath": "userprofiles/{profileId}/contentCategories",
"parameterOrder": [
"profileId"
],
"request": {
"$ref": "ContentCategory"
},
"description": "Updates an existing content category."
},
"insert": {
"flatPath": "userprofiles/{profileId}/contentCategories",
"description": "Inserts a new content category.",
"request": {
"$ref": "ContentCategory"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "ContentCategory"
},
"parameterOrder": [
"profileId"
],
"httpMethod": "POST",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"required": true,
"format": "int64",
"type": "string",
"location": "path"
}
},
"path": "userprofiles/{profileId}/contentCategories",
"id": "dfareporting.contentCategories.insert"
},
"get": {
"httpMethod": "GET",
"response": {
"$ref": "ContentCategory"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/contentCategories/{id}",
"parameters": {
"profileId": {
"location": "path",
"format": "int64",
"type": "string",
"required": true,
"description": "User profile ID associated with this request."
},
"id": {
"location": "path",
"type": "string",
"description": "Content category ID.",
"format": "int64",
"required": true
}
},
"description": "Gets one content category by ID.",
"id": "dfareporting.contentCategories.get",
"parameterOrder": [
"profileId",
"id"
],
"path": "userprofiles/{profileId}/contentCategories/{id}"
},
"patch": {
"id": "dfareporting.contentCategories.patch",
"path": "userprofiles/{profileId}/contentCategories",
"httpMethod": "PATCH",
"flatPath": "userprofiles/{profileId}/contentCategories",
"response": {
"$ref": "ContentCategory"
},
"parameterOrder": [
"profileId",
"id"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"id": {
"description": "ContentCategory ID.",
"required": true,
"type": "string",
"format": "int64",
"location": "query"
},
"profileId": {
"format": "int64",
"location": "path",
"description": "User profile ID associated with this request.",
"required": true,
"type": "string"
}
},
"description": "Updates an existing content category. This method supports patch semantics.",
"request": {
"$ref": "ContentCategory"
}
}
}
},
"placementStrategies": {
"methods": {
"list": {
"description": "Retrieves a list of placement strategies, possibly filtered. This method supports paging.",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.placementStrategies.list",
"path": "userprofiles/{profileId}/placementStrategies",
"parameters": {
"pageToken": {
"type": "string",
"location": "query",
"description": "Value of the nextPageToken from the previous result page."
},
"searchString": {
"location": "query",
"type": "string",
"description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"placementstrategy*2015\" will return objects with names like \"placementstrategy June 2015\", \"placementstrategy April 2015\", or simply \"placementstrategy 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementstrategy\" will match objects with name \"my placementstrategy\", \"placementstrategy 2015\", or simply \"placementstrategy\"."
},
"sortField": {
"description": "Field by which to sort the list.",
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string",
"enum": [
"ID",
"NAME"
],
"default": "ID"
},
"sortOrder": {
"enum": [
"ASCENDING",
"DESCENDING"
],
"default": "ASCENDING",
"type": "string",
"enumDescriptions": [
"",
""
],
"location": "query",
"description": "Order of sorted results."
},
"ids": {
"type": "string",
"description": "Select only placement strategies with these IDs.",
"location": "query",
"format": "int64",
"repeated": true
},
"maxResults": {
"maximum": "1000",
"format": "int32",
"type": "integer",
"location": "query",
"minimum": "0",
"default": "1000",
"description": "Maximum number of results to return."
},
"profileId": {
"type": "string",
"location": "path",
"description": "User profile ID associated with this request.",
"required": true,
"format": "int64"
}
},
"response": {
"$ref": "PlacementStrategiesListResponse"
},
"parameterOrder": [
"profileId"
],
"flatPath": "userprofiles/{profileId}/placementStrategies"
},
"delete": {
"path": "userprofiles/{profileId}/placementStrategies/{id}",
"flatPath": "userprofiles/{profileId}/placementStrategies/{id}",
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameters": {
"profileId": {
"location": "path",
"required": true,
"type": "string",
"description": "User profile ID associated with this request.",
"format": "int64"
},
"id": {
"format": "int64",
"location": "path",
"description": "Placement strategy ID.",
"type": "string",
"required": true
}
},
"description": "Deletes an existing placement strategy.",
"id": "dfareporting.placementStrategies.delete",
"parameterOrder": [
"profileId",
"id"
]
},
"patch": {
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"type": "string",
"location": "query",
"description": "PlacementStrategy ID.",
"format": "int64",
"required": true
},
"profileId": {
"location": "path",
"type": "string",
"description": "User profile ID associated with this request.",
"required": true,
"format": "int64"
}
},
"description": "Updates an existing placement strategy. This method supports patch semantics.",
"path": "userprofiles/{profileId}/placementStrategies",
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "PlacementStrategy"
},
"flatPath": "userprofiles/{profileId}/placementStrategies",
"request": {
"$ref": "PlacementStrategy"
},
"id": "dfareporting.placementStrategies.patch"
},
"get": {
"parameters": {
"profileId": {
"required": true,
"format": "int64",
"location": "path",
"type": "string",
"description": "User profile ID associated with this request."
},
"id": {
"location": "path",
"format": "int64",
"required": true,
"description": "Placement strategy ID.",
"type": "string"
}
},
"path": "userprofiles/{profileId}/placementStrategies/{id}",
"httpMethod": "GET",
"response": {
"$ref": "PlacementStrategy"
},
"flatPath": "userprofiles/{profileId}/placementStrategies/{id}",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId",
"id"
],
"id": "dfareporting.placementStrategies.get",
"description": "Gets one placement strategy by ID."
},
"update": {
"parameterOrder": [
"profileId"
],
"id": "dfareporting.placementStrategies.update",
"request": {
"$ref": "PlacementStrategy"
},
"httpMethod": "PUT",
"path": "userprofiles/{profileId}/placementStrategies",
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"location": "path",
"format": "int64",
"type": "string",
"required": true
}
},
"response": {
"$ref": "PlacementStrategy"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/placementStrategies",
"description": "Updates an existing placement strategy."
},
"insert": {
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"type": "string",
"location": "path",
"format": "int64",
"required": true
}
},
"request": {
"$ref": "PlacementStrategy"
},
"description": "Inserts a new placement strategy.",
"path": "userprofiles/{profileId}/placementStrategies",
"flatPath": "userprofiles/{profileId}/placementStrategies",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "PlacementStrategy"
},
"id": "dfareporting.placementStrategies.insert",
"parameterOrder": [
"profileId"
],
"httpMethod": "POST"
}
}
},
"projects": {
"methods": {
"get": {
"id": "dfareporting.projects.get",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/projects/{id}",
"response": {
"$ref": "Project"
},
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"type": "string",
"location": "path",
"format": "int64",
"required": true
},
"id": {
"location": "path",
"format": "int64",
"type": "string",
"description": "Project ID.",
"required": true
}
},
"description": "Gets one project by ID.",
"path": "userprofiles/{profileId}/projects/{id}",
"httpMethod": "GET",
"parameterOrder": [
"profileId",
"id"
]
},
"list": {
"parameterOrder": [
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/projects",
"path": "userprofiles/{profileId}/projects",
"parameters": {
"searchString": {
"location": "query",
"description": "Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, \"project*2015\" will return projects with names like \"project June 2015\", \"project April 2015\", or simply \"project 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"project\" will match projects with name \"my project\", \"project 2015\", or simply \"project\".",
"type": "string"
},
"sortOrder": {
"location": "query",
"enumDescriptions": [
"",
""
],
"type": "string",
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
],
"description": "Order of sorted results."
},
"maxResults": {
"location": "query",
"type": "integer",
"maximum": "1000",
"minimum": "0",
"default": "1000",
"format": "int32",
"description": "Maximum number of results to return."
},
"advertiserIds": {
"repeated": true,
"type": "string",
"location": "query",
"description": "Select only projects with these advertiser IDs.",
"format": "int64"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "Value of the nextPageToken from the previous result page."
},
"sortField": {
"type": "string",
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
],
"enumDescriptions": [
"",
""
],
"default": "ID",
"location": "query"
},
"ids": {
"description": "Select only projects with these IDs.",
"repeated": true,
"type": "string",
"format": "int64",
"location": "query"
},
"profileId": {
"location": "path",
"type": "string",
"required": true,
"format": "int64",
"description": "User profile ID associated with this request."
}
},
"httpMethod": "GET",
"response": {
"$ref": "ProjectsListResponse"
},
"description": "Retrieves a list of projects, possibly filtered. This method supports paging .",
"id": "dfareporting.projects.list"
}
}
},
"creativeGroups": {
"methods": {
"patch": {
"request": {
"$ref": "CreativeGroup"
},
"description": "Updates an existing creative group. This method supports patch semantics.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"path": "userprofiles/{profileId}/creativeGroups",
"parameterOrder": [
"profileId",
"id"
],
"id": "dfareporting.creativeGroups.patch",
"flatPath": "userprofiles/{profileId}/creativeGroups",
"httpMethod": "PATCH",
"response": {
"$ref": "CreativeGroup"
},
"parameters": {
"profileId": {
"type": "string",
"required": true,
"location": "path",
"description": "User profile ID associated with this request.",
"format": "int64"
},
"id": {
"location": "query",
"description": "CreativeGroup ID.",
"required": true,
"type": "string",
"format": "int64"
}
}
},
"update": {
"id": "dfareporting.creativeGroups.update",
"httpMethod": "PUT",
"path": "userprofiles/{profileId}/creativeGroups",
"flatPath": "userprofiles/{profileId}/creativeGroups",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"description": "Updates an existing creative group.",
"response": {
"$ref": "CreativeGroup"
},
"request": {
"$ref": "CreativeGroup"
},
"parameters": {
"profileId": {
"type": "string",
"required": true,
"location": "path",
"format": "int64",
"description": "User profile ID associated with this request."
}
},
"parameterOrder": [
"profileId"
]
},
"insert": {
"flatPath": "userprofiles/{profileId}/creativeGroups",
"response": {
"$ref": "CreativeGroup"
},
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"type": "string",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"profileId"
],
"path": "userprofiles/{profileId}/creativeGroups",
"request": {
"$ref": "CreativeGroup"
},
"id": "dfareporting.creativeGroups.insert",
"description": "Inserts a new creative group.",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "POST"
},
"get": {
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/creativeGroups/{id}",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"response": {
"$ref": "CreativeGroup"
},
"parameterOrder": [
"profileId",
"id"
],
"id": "dfareporting.creativeGroups.get",
"parameters": {
"profileId": {
"format": "int64",
"type": "string",
"required": true,
"location": "path",
"description": "User profile ID associated with this request."
},
"id": {
"format": "int64",
"required": true,
"description": "Creative group ID.",
"location": "path",
"type": "string"
}
},
"path": "userprofiles/{profileId}/creativeGroups/{id}",
"description": "Gets one creative group by ID."
},
"list": {
"response": {
"$ref": "CreativeGroupsListResponse"
},
"path": "userprofiles/{profileId}/creativeGroups",
"httpMethod": "GET",
"parameters": {
"sortField": {
"enum": [
"ID",
"NAME"
],
"default": "ID",
"description": "Field by which to sort the list.",
"location": "query",
"enumDescriptions": [
"",
""
],
"type": "string"
},
"advertiserIds": {
"description": "Select only creative groups that belong to these advertisers.",
"repeated": true,
"location": "query",
"type": "string",
"format": "int64"
},
"ids": {
"format": "int64",
"description": "Select only creative groups with these IDs.",
"location": "query",
"type": "string",
"repeated": true
},
"profileId": {
"description": "User profile ID associated with this request.",
"type": "string",
"required": true,
"location": "path",
"format": "int64"
},
"searchString": {
"description": "Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, \"creativegroup*2015\" will return creative groups with names like \"creativegroup June 2015\", \"creativegroup April 2015\", or simply \"creativegroup 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativegroup\" will match creative groups with the name \"my creativegroup\", \"creativegroup 2015\", or simply \"creativegroup\".",
"location": "query",
"type": "string"
},
"groupNumber": {
"format": "int32",
"type": "integer",
"location": "query",
"description": "Select only creative groups that belong to this subgroup.",
"minimum": "1",
"maximum": "2"
},
"maxResults": {
"maximum": "1000",
"description": "Maximum number of results to return.",
"minimum": "0",
"default": "1000",
"type": "integer",
"format": "int32",
"location": "query"
},
"sortOrder": {
"default": "ASCENDING",
"type": "string",
"enumDescriptions": [
"",
""
],
"enum": [
"ASCENDING",
"DESCENDING"
],
"location": "query",
"description": "Order of sorted results."
},
"pageToken": {
"type": "string",
"description": "Value of the nextPageToken from the previous result page.",
"location": "query"
}
},
"description": "Retrieves a list of creative groups, possibly filtered. This method supports paging.",
"parameterOrder": [
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/creativeGroups",
"id": "dfareporting.creativeGroups.list"
}
}
},
"changeLogs": {
"methods": {
"get": {
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"httpMethod": "GET",
"id": "dfareporting.changeLogs.get",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"profileId": {
"required": true,
"location": "path",
"format": "int64",
"description": "User profile ID associated with this request.",
"type": "string"
},
"id": {
"location": "path",
"description": "Change log ID.",
"required": true,
"format": "int64",
"type": "string"
}
},
"flatPath": "userprofiles/{profileId}/changeLogs/{id}",
"description": "Gets one change log by ID.",
"response": {
"$ref": "ChangeLog"
},
"path": "userprofiles/{profileId}/changeLogs/{id}"
},
"list": {
"response": {
"$ref": "ChangeLogsListResponse"
},
"id": "dfareporting.changeLogs.list",
"parameters": {
"action": {
"description": "Select only change logs with the specified action.",
"enum": [
"ACTION_CREATE",
"ACTION_UPDATE",
"ACTION_DELETE",
"ACTION_ENABLE",
"ACTION_DISABLE",
"ACTION_ADD",
"ACTION_REMOVE",
"ACTION_MARK_AS_DEFAULT",
"ACTION_ASSOCIATE",
"ACTION_ASSIGN",
"ACTION_UNASSIGN",
"ACTION_SEND",
"ACTION_LINK",
"ACTION_UNLINK",
"ACTION_PUSH",
"ACTION_EMAIL_TAGS",
"ACTION_SHARE"
],
"type": "string",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"location": "query"
},
"profileId": {
"required": true,
"format": "int64",
"description": "User profile ID associated with this request.",
"location": "path",
"type": "string"
},
"maxChangeTime": {
"type": "string",
"location": "query",
"description": "Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset."
},
"objectType": {
"location": "query",
"enum": [
"OBJECT_ADVERTISER",
"OBJECT_FLOODLIGHT_CONFIGURATION",
"OBJECT_AD",
"OBJECT_FLOODLIGHT_ACTVITY",
"OBJECT_CAMPAIGN",
"OBJECT_FLOODLIGHT_ACTIVITY_GROUP",
"OBJECT_CREATIVE",
"OBJECT_PLACEMENT",
"OBJECT_DFA_SITE",
"OBJECT_USER_ROLE",
"OBJECT_USER_PROFILE",
"OBJECT_ADVERTISER_GROUP",
"OBJECT_ACCOUNT",
"OBJECT_SUBACCOUNT",
"OBJECT_RICHMEDIA_CREATIVE",
"OBJECT_INSTREAM_CREATIVE",
"OBJECT_MEDIA_ORDER",
"OBJECT_CONTENT_CATEGORY",
"OBJECT_PLACEMENT_STRATEGY",
"OBJECT_SD_SITE",
"OBJECT_SIZE",
"OBJECT_CREATIVE_GROUP",
"OBJECT_CREATIVE_ASSET",
"OBJECT_USER_PROFILE_FILTER",
"OBJECT_LANDING_PAGE",
"OBJECT_CREATIVE_FIELD",
"OBJECT_REMARKETING_LIST",
"OBJECT_PROVIDED_LIST_CLIENT",
"OBJECT_EVENT_TAG",
"OBJECT_CREATIVE_BUNDLE",
"OBJECT_BILLING_ACCOUNT_GROUP",
"OBJECT_BILLING_FEATURE",
"OBJECT_RATE_CARD",
"OBJECT_ACCOUNT_BILLING_FEATURE",
"OBJECT_BILLING_MINIMUM_FEE",
"OBJECT_BILLING_PROFILE",
"OBJECT_PLAYSTORE_LINK",
"OBJECT_TARGETING_TEMPLATE",
"OBJECT_SEARCH_LIFT_STUDY",
"OBJECT_FLOODLIGHT_DV360_LINK"
],
"type": "string",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"description": "Select only change logs with the specified object type."
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"location": "query",
"type": "string"
},
"searchString": {
"location": "query",
"description": "Select only change logs whose object ID, user name, old or new values match the search string.",
"type": "string"
},
"userProfileIds": {
"repeated": true,
"location": "query",
"format": "int64",
"description": "Select only change logs with these user profile IDs.",
"type": "string"
},
"minChangeTime": {
"location": "query",
"description": "Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
"type": "string"
},
"ids": {
"type": "string",
"location": "query",
"repeated": true,
"format": "int64",
"description": "Select only change logs with these IDs."
},
"maxResults": {
"default": "1000",
"location": "query",
"maximum": "1000",
"type": "integer",
"description": "Maximum number of results to return.",
"minimum": "0",
"format": "int32"
},
"objectIds": {
"type": "string",
"format": "int64",
"location": "query",
"description": "Select only change logs with these object IDs.",
"repeated": true
}
},
"httpMethod": "GET",
"path": "userprofiles/{profileId}/changeLogs",
"parameterOrder": [
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"flatPath": "userprofiles/{profileId}/changeLogs",
"description": "Retrieves a list of change logs. This method supports paging."
}
}
},
"campaignCreativeAssociations": {
"methods": {
"list": {
"httpMethod": "GET",
"flatPath": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
"id": "dfareporting.campaignCreativeAssociations.list",
"description": "Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.",
"path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
"parameters": {
"pageToken": {
"type": "string",
"description": "Value of the nextPageToken from the previous result page.",
"location": "query"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"required": true,
"location": "path",
"type": "string"
},
"campaignId": {
"description": "Campaign ID in this association.",
"format": "int64",
"location": "path",
"type": "string",
"required": true
},
"sortOrder": {
"description": "Order of sorted results.",
"default": "ASCENDING",
"location": "query",
"type": "string",
"enumDescriptions": [
"",
""
],
"enum": [
"ASCENDING",
"DESCENDING"
]
},
"maxResults": {
"default": "1000",
"maximum": "1000",
"location": "query",
"type": "integer",
"format": "int32",
"minimum": "0",
"description": "Maximum number of results to return."
}
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"parameterOrder": [
"profileId",
"campaignId"
],
"response": {
"$ref": "CampaignCreativeAssociationsListResponse"
}
},
"insert": {
"flatPath": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
"response": {
"$ref": "CampaignCreativeAssociation"
},
"parameters": {
"campaignId": {
"type": "string",
"format": "int64",
"location": "path",
"description": "Campaign ID in this association.",
"required": true
},
"profileId": {
"location": "path",
"description": "User profile ID associated with this request.",
"format": "int64",
"required": true,
"type": "string"
}
},
"id": "dfareporting.campaignCreativeAssociations.insert",
"parameterOrder": [
"profileId",
"campaignId"
],
"description": "Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.",
"path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"request": {
"$ref": "CampaignCreativeAssociation"
}
}
}
},
"operatingSystems": {
"methods": {
"list": {
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"id": "dfareporting.operatingSystems.list",
"parameters": {
"profileId": {
"format": "int64",
"description": "User profile ID associated with this request.",
"location": "path",
"type": "string",
"required": true
}
},
"description": "Retrieves a list of operating systems.",
"path": "userprofiles/{profileId}/operatingSystems",
"response": {
"$ref": "OperatingSystemsListResponse"
},
"flatPath": "userprofiles/{profileId}/operatingSystems",
"parameterOrder": [
"profileId"
]
},
"get": {
"parameters": {
"dartId": {
"format": "int64",
"location": "path",
"type": "string",
"required": true,
"description": "Operating system DART ID."
},
"profileId": {
"type": "string",
"location": "path",
"format": "int64",
"description": "User profile ID associated with this request.",
"required": true
}
},
"description": "Gets one operating system by DART ID.",
"path": "userprofiles/{profileId}/operatingSystems/{dartId}",
"parameterOrder": [
"profileId",
"dartId"
],
"id": "dfareporting.operatingSystems.get",
"httpMethod": "GET",
"response": {
"$ref": "OperatingSystem"
},
"flatPath": "userprofiles/{profileId}/operatingSystems/{dartId}",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"dimensionValues": {
"methods": {
"query": {
"description": "Retrieves list of report dimension values for a list of filters.",
"request": {
"$ref": "DimensionValueRequest"
},
"parameters": {
"profileId": {
"location": "path",
"description": "The Campaign Manager 360 user profile ID.",
"type": "string",
"format": "int64",
"required": true
},
"pageToken": {
"type": "string",
"location": "query",
"description": "The value of the nextToken from the previous result page."
},
"maxResults": {
"default": "100",
"type": "integer",
"maximum": "100",
"description": "Maximum number of results to return.",
"format": "int32",
"minimum": "0",
"location": "query"
}
},
"flatPath": "userprofiles/{profileId}/dimensionvalues/query",
"id": "dfareporting.dimensionValues.query",
"httpMethod": "POST",
"parameterOrder": [
"profileId"
],
"scopes": [
"https://www.googleapis.com/auth/dfareporting"
],
"response": {
"$ref": "DimensionValueList"
},
"path": "userprofiles/{profileId}/dimensionvalues/query"
}
}
}
},
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"parameters": {
"$.xgafv": {
"type": "string",
"description": "V1 error format.",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"enum": [
"1",
"2"
],
"location": "query"
},
"quotaUser": {
"type": "string",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query"
},
"oauth_token": {
"location": "query",
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"access_token": {
"description": "OAuth access token.",
"type": "string",
"location": "query"
},
"callback": {
"type": "string",
"description": "JSONP",
"location": "query"
},
"key": {
"location": "query",
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"upload_protocol": {
"location": "query",
"type": "string",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"fields": {
"location": "query",
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query"
},
"alt": {
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"default": "json",
"description": "Data format for response.",
"type": "string"
}
}
}