List
|
|||||
|
|
||||
Retrieves a list of landing pages
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns
Input
This building block consumes 11 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
advertiserIds |
INTEGER |
Select only landing pages that belong to these advertisers |
archived |
BOOLEAN |
Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages |
campaignIds |
INTEGER |
Select only landing pages that are associated with these campaigns |
ids |
INTEGER |
Select only landing pages with these IDs |
maxResults |
INTEGER |
Maximum number of results to return |
pageToken |
STRING |
Value of the nextPageToken from the previous result page |
searchString |
STRING |
Allows searching for landing pages by name or ID. Wildcards () are allowed. For example, "landingpage2017" 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" |
sortField |
ENUMERATION |
Field by which to sort the list |
sortOrder |
ENUMERATION |
Order of sorted results |
subaccountId |
INTEGER |
Select only landing pages that belong to this subaccount |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
advertiserIds INTEGER Select only landing pages that belong to these advertisers |
|
archived BOOLEAN Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages |
|
campaignIds INTEGER Select only landing pages that are associated with these campaigns |
|
ids INTEGER Select only landing pages with these IDs |
|
maxResults INTEGER Maximum number of results to return |
|
pageToken STRING Value of the nextPageToken from the previous result page |
|
searchString STRING Allows searching for landing pages by name or ID. Wildcards () are allowed. For example, "landingpage2017" 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" |
|
sortField ENUMERATION Field by which to sort the list |
|
sortOrder ENUMERATION Order of sorted results |
|
subaccountId INTEGER Select only landing pages that belong to this subaccount |
Output
This building block provides 15 output parameters
| Name | Format | Description |
|---|---|---|
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse" |
landingPages[] |
OBJECT |
Contains information about where a user's browser is taken after the user clicks an ad |
landingPages[].advertiserId |
INTEGER |
Advertiser ID of this landing page. This is a required field |
landingPages[].archived |
BOOLEAN |
Whether this landing page has been archived |
landingPages[].deepLinks[] |
OBJECT |
Contains information about a landing page deep link |
landingPages[].deepLinks[].appUrl |
STRING |
The URL of the mobile app being linked to |
landingPages[].deepLinks[].fallbackUrl |
STRING |
The fallback URL. This URL will be served to users who do not have the mobile app installed |
landingPages[].deepLinks[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink" |
landingPages[].deepLinks[].mobileApp |
OBJECT |
Contains information about a mobile app. Used as a landing page deep link |
landingPages[].deepLinks[].remarketingListIds[] |
INTEGER |
|
landingPages[].id |
INTEGER |
ID of this landing page. This is a read-only, auto-generated field |
landingPages[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage" |
landingPages[].name |
STRING |
Name of this landing page. This is a required field. It must be less than 256 characters long |
landingPages[].url |
STRING |
URL of this landing page. This is a required field |
nextPageToken |
STRING |
Pagination token to be used for the next list operation |
= Parameter name
= Format
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse" |
|
landingPages[] OBJECT Contains information about where a user's browser is taken after the user clicks an ad |
|
landingPages[].advertiserId INTEGER Advertiser ID of this landing page. This is a required field |
|
landingPages[].archived BOOLEAN Whether this landing page has been archived |
|
landingPages[].deepLinks[] OBJECT Contains information about a landing page deep link |
|
landingPages[].deepLinks[].appUrl STRING The URL of the mobile app being linked to |
|
landingPages[].deepLinks[].fallbackUrl STRING The fallback URL. This URL will be served to users who do not have the mobile app installed |
|
landingPages[].deepLinks[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink" |
|
landingPages[].deepLinks[].mobileApp OBJECT Contains information about a mobile app. Used as a landing page deep link |
|
landingPages[].deepLinks[].remarketingListIds[] INTEGER |
|
landingPages[].id INTEGER ID of this landing page. This is a read-only, auto-generated field |
|
landingPages[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage" |
|
landingPages[].name STRING Name of this landing page. This is a required field. It must be less than 256 characters long |
|
landingPages[].url STRING URL of this landing page. This is a required field |
|
nextPageToken STRING Pagination token to be used for the next list operation |