Ad Exchange Buyer API II . accounts . creatives . dealAssociations

add(accountId, creativeId, body=None, x__xgafv=None)

Associate an existing deal with a creative.

Args:
  accountId: string, The account the creative belongs to. (required)
  creativeId: string, The ID of the creative associated with the deal. (required)
  body: object, The request body.
    The object takes the form of:

{ # A request for associating a deal and a creative.
  "association": { # The association between a creative and a deal. # The association between a creative and a deal that should be added.
    "accountId": "A String", # The account the creative belongs to.
    "creativeId": "A String", # The ID of the creative associated with the deal.
    "dealsId": "A String", # The externalDealId for the deal associated with the creative.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

close()

Close httplib2 connections.

list(accountId, creativeId, pageSize=None, pageToken=None, query=None, x__xgafv=None)

List all creative-deal associations.

Args:
  accountId: string, The account to list the associations from. Specify "-" to list all creatives the current user has access to. (required)
  creativeId: string, The creative ID to list the associations from. Specify "-" to list all creatives under the above account. (required)
  pageSize: integer, Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method.
  query: string, An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsId=*deals_id_string* - dealsStatus:{approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked} Example: 'dealsId=12345 AND dealsStatus:disapproved'
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A response for listing creative and deal associations
  "associations": [ # The list of associations.
    { # The association between a creative and a deal.
      "accountId": "A String", # The account the creative belongs to.
      "creativeId": "A String", # The ID of the creative associated with the deal.
      "dealsId": "A String", # The externalDealId for the deal associated with the creative.
    },
  ],
  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListDealAssociationsRequest.page_token field in the subsequent call to 'ListDealAssociation' method to retrieve the next page of results.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

remove(accountId, creativeId, body=None, x__xgafv=None)

Remove the association between a deal and a creative.

Args:
  accountId: string, The account the creative belongs to. (required)
  creativeId: string, The ID of the creative associated with the deal. (required)
  body: object, The request body.
    The object takes the form of:

{ # A request for removing the association between a deal and a creative.
  "association": { # The association between a creative and a deal. # The association between a creative and a deal that should be removed.
    "accountId": "A String", # The account the creative belongs to.
    "creativeId": "A String", # The ID of the creative associated with the deal.
    "dealsId": "A String", # The externalDealId for the deal associated with the creative.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}