DCM/DFA Reporting And Trafficking API . landingPages

Instance Methods

delete(profileId, campaignId, id)

Deletes an existing campaign landing page.

get(profileId, campaignId, id)

Gets one campaign landing page by ID.

insert(profileId, campaignId, body)

Inserts a new landing page for the specified campaign.

list(profileId, campaignId)

Retrieves the list of landing pages for the specified campaign.

patch(profileId, campaignId, id, body)

Updates an existing campaign landing page. This method supports patch semantics.

update(profileId, campaignId, body)

Updates an existing campaign landing page.

Method Details

delete(profileId, campaignId, id)
Deletes an existing campaign landing page.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  id: string, Landing page ID. (required)
get(profileId, campaignId, id)
Gets one campaign landing page by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  id: string, Landing page ID. (required)

Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
insert(profileId, campaignId, body)
Inserts a new landing page for the specified campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
    "url": "A String", # URL of this landing page. This is a required field.
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
list(profileId, campaignId)
Retrieves the list of landing pages for the specified campaign.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)

Returns:
  An object of the form:

    { # Landing Page List Response
    "kind": "dfareporting#landingPagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPagesListResponse".
    "landingPages": [ # Landing page collection
      { # Contains information about where a user's browser is taken after the user clicks an ad.
          "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
          "url": "A String", # URL of this landing page. This is a required field.
          "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
          "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
          "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
        },
    ],
  }
patch(profileId, campaignId, id, body)
Updates an existing campaign landing page. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  id: string, Landing page ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
    "url": "A String", # URL of this landing page. This is a required field.
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }
update(profileId, campaignId, body)
Updates an existing campaign landing page.

Args:
  profileId: string, User profile ID associated with this request. (required)
  campaignId: string, Landing page campaign ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Contains information about where a user's browser is taken after the user clicks an ad.
    "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
    "url": "A String", # URL of this landing page. This is a required field.
    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
    "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
  }


Returns:
  An object of the form:

    { # Contains information about where a user's browser is taken after the user clicks an ad.
      "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
      "url": "A String", # URL of this landing page. This is a required field.
      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
      "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
    }