Method: advertiserLandingPages.list

  • This method retrieves a list of landing pages.

  • The HTTP request uses a GET method with a specified URL containing a profile ID.

  • Path parameters include the profileId which is a string representing the user profile ID.

  • Query parameters allow filtering and sorting the list of landing pages by various criteria such as IDs, advertiser IDs, archived status, subaccount ID, search string, campaign IDs, max results, page token, sort field, and sort order.

  • The response body contains a JSON object with fields for kind, nextPageToken, and a list of landingPages.

Retrieves a list of landing pages.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{profileId}/advertiserLandingPages

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.

Query parameters

Parameters
ids[]

string (int64 format)

Select only landing pages with these IDs.
advertiserIds[]

string (int64 format)

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.
subaccountId

string (int64 format)

Select only landing pages that belong to this subaccount.
searchString

string

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"

.
campaignIds[]

string (int64 format)

Select only landing pages that are associated with these campaigns.
maxResults

integer

Maximum number of results to return.
pageToken

string

Value of the

nextPageToken

from the previous result page.
sortField

enum (SortField)

Field by which to sort the list.
sortOrder

enum (SortOrder)

Order of sorted results.

Request body

The request body must be empty.

Response body

Landing Page advertiserLandingPages.list Response

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "nextPageToken": string,
  "landingPages": [
    {
      object (LandingPage)
    }
  ]
}
Fields
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#advertiserLandingPagesListResponse"

.
nextPageToken

string

Pagination token to be used for the next list operation.
landingPages[]

object (LandingPage)

Landing page collection

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/dfatrafficking